Installation and Operating Instructions for the FluidX ... · 9 Creating a New Profile 36 9.1 Auto...
Transcript of Installation and Operating Instructions for the FluidX ... · 9 Creating a New Profile 36 9.1 Auto...
Installation and Operating Instructions for the FluidX IntelliCode™ Software
Part Number 281945 Rev. B
Brooks Automation, Inc.
Information provided within this document is subject to change without notice, and although believed to be
accurate, Brooks Automation, Inc. assumes no responsibility for any errors, omissions, or inaccuracies.
ABF™, AcuLigner™, Advan Tag™, Align™, AquaTran™, AutoTeach™, ATR™, AXM™, Basic Blue™,
BioStore™, BiSymmetrik™, CenterSmart™, Cool Solutions™, Crate to Operate™, CrossingConnect™,
Cryotiger™, DARTS™, Enerta™, e-RMA™, e-Spares™, e-Volution™, Falcon™, FastRegen™, FIXLOAD™,
FrogLeg™,FrostX2™, Independent Twin Linear Exchange™, InCooler™, InLigner™, Interface™, Isoport™,
ITLX™, Jet™, Jet Engine™, LEAP™, LowProfile™, M2 Nano™, PASIV™, PowerPak™,
PerformanceBlue™, Plate Auditor™, PowerPak™, PowerTools™, QuadraFly™, Radius™, Radient™,
Radient Express™, RapidThaw™, Reliance™, Reliance ATR™, RetroEase™, SCARA™, SmartPM™,
SPOTLevel™, Sprint™, Synetics™, The New Pathway to Productivity™, Time Optimized Trajectory™,
Time Optimal Trajectory™, Time Optimized Path™, TopCooler™, TopLigner™, Tube Auditor™, Ultimate
Blue™, VAC-407™, VacuTran™, VersaPort™, and WaferEngine™ are trademarks of Brooks Automation,
Inc.
AcuTran®, AquaTrap®, Asyst®, the Cool Solutions logo, Crossing Automation®, Cryodyne®, Cryo-Torr®,
Fusion®, GOLDLink®, Guardian®, GUTS®, Helix®, Leapfrog®, MagnaTran®, MapTrak®, Marathon®,
Marathon 2®, Marathon Express®, On-Board®, Polycold®, Razor®, REMP®, Spartan®, TrueBlue®,
TurboPlus®, Vision®, Xpeel®, XTape®, Zaris®, the Brooks logo, and the Brooks Life Science Systems logo
are registered U.S. trademarks of Brooks Automation, Inc.
All other trademarks are properties of their respective owners.
© 2018 Brooks Automation, Inc. All rights reserved. The information included in this manual is proprietary
information of Brooks Automation, Inc. and is provided for the use of Brooks customers only and cannot be
used for distribution, reproduction, or sale without the express written permission of Brooks Automation, Inc.
Copyright © 2018, Brooks Automation, Inc.
For Technical Support:
Corporate Headquarters
15 Elizabeth Drive
Chelmsford, MA 01824 U.S.A.
Location GUTStionntact Number Website
North America +1-800-FOR-GUTS (1-800-367-4887) +1 978-262-2900
www.brooks.com
Europe +49-1804-CALL-GUTS (+49-1804-2255-4887) http://www.brooks.com/
Japan +81-45-477-5980 http://jp.brooks.com/
China +86-21-5131-7066 http://cn.brooks.com/
Taiwan +886-3-5525225 http://tw.brooks.com/
Korea +82-31-288-2500 http://kr.brooks.com/
Singapore +65-6464-1481 http://www.brooks.com/
Contact Technical Publications directly: [email protected]
This technology is subject to United States export Administration Regulations and authorized to the
destination only; diversion contrary to U.S. law is prohibited.
Original manual printed in English. Printed in the U.S.A.
Accelerating Innovation
Brooks Locations Worldwide:
Brooks Automation Inc.
46702 Bayside Parkway
Fremont,CA 94538
Tel: +1-510-661-5000
Fax: +1-510-661-5166
Life Sciences
BioStorage Technologies
2910 Fortune Circle West, Suite E
Indianapolis, IN 46241
Tel: +1 317-268-5500
Fax: +1 317-390-1868
Brooks Automation, Inc.
9601 Dessau Road, Suite 301
Austin, TX 78754
Tel: +1 512-912-2840
Toll-Free: +1 800-367-4887
Brooks Automation, Inc.
AIM Servicios Administrativos S de RL de CV
Carretera Huinalá km 2.8
Parque Industrial Las Américas
66640 Apodaca, NL Mexico
Tel: +52 81 8863-6363
Brooks Automation (Germany) GmbH
Ernst-Ruska-Ring 11
07745 Jena, Germany
Tel: +49 3641 4821 100
Fax: +49 3641 4821 4100
Brooks Automation (Germany) GmbH
im Wiesengrund 17
78315 Radolfzell, Germany
Tel: +49-7732-9409-0
Fax: +49-7732-9409-200
Brooks Automation (Germany) GmbH
Karl-Marx-Strasse 23
D-01109 Dresden, Germany
Tel: +49 351 885 930
Fax: +49 351 885 9322
Life Sciences
BioStorage Technologies GmbH
Im Leuschnerpark 1B
64347 Griesheim, Germany
Tel: +49 6155 898 1011
Brooks Automation (Israel) Ltd.
Mevo Yerach 5
Kiryat-Gat 82000
Israel
Tel: +972 8672 2988
Fax: +972 8672 2966
Life Sciences
Brooks Automation AG
Bernstrasse 134
CH-3613 Steffisburg
Switzerland
Tel: +41 (0) 31 770 70 70
Life Sciences
Northbank, Irlam
Manchester M44 5AY
United Kingdom
Tel: +44 (0) 161 777 2000
Fax: +44 (0) 161 777 2002
Brooks Technology (Shanghai) Limited
2nd Floor, No. 72, 887 Zuchongzhi Road
Zhangjiang Hi-Tech Park
Pudong, Shanghai
China 201203
Tel: +86-21-5131-7070
Fax: +86-21-5131-7068
Brooks Japan K.K. HEADQUARTERS
Nisso Bldg. No 16, 9F
3-8-8 ShinYokohama, Kohoku-ku
Yokohama, Kanagawa 222-0033
Tel: +81-45-477-5570
Fax: +81-45-477-5571
Brooks Japan K.K.
YOKOHAMA TECHNICAL CENTER
852-1 Kawamuko-cho, Tsuzuki-ku
Yokohama, Kanagawa 224-0044
Tel: +81-45-477-5250
Fax: +81-45-470-6800
Brooks Japan K.K.
YOKKAICHI SERVICE CENTER
Hikari Shokai Yokkaichi Bldg.
2-26 Shinshinmachi
Yokkaichi, Mie 510-0094
Tel: +81-59-359-5611
Fax: +81-59-353-1419
Brooks Japan K.K.
KUMAMOTO SERVICE OFFICE
202 Mirai Office II
312-1 Tatsudamachi Yuge
Tatsuda, Kumamoto 861-8002
Tel: +81-96-327-9720
Fax: +81-96-327-9721
Brooks CCS Japan K.K.
CONTAMINATION CONTROL SOLUTIONS
Nisso Bldg. No 16, 9F
3-8-8 ShinYokohama, Kohoku-ku
Yokohama, Kanagawa 222-0033
Tel: +81-45-477-5570
Fax: +81-45-477-5571
Brooks Automation Korea, Inc.
#35 Giheungdanji-Ro 121Beon-Gil
Giheung-Gu, Yongin-Si
Gyeonggi-Do, 17086
Korea
Tel : +82-31-288-2500
Fax: +82-31-287-2111
Brooks Automation (S) Pte Ltd
51-18-C1 Menara BHL,
57 Jalan Ahmad Shah,
10050, Penang,
Malaysia
Tel: +60 4 3701012
Fax: +60 4 3701015
Brooks Automation (Singapore) Pte Ltd
Blk 5008 Ang Mo Kio Avenue 5
#05-08, Techplace II
Singapore 569874
Tel: +65-6836-3168
Fax: +65-6836-3177
Brooks Automation Ltd.
TAIWAN HEADQUARTERS
5F-5, No.32, Tai-Yuen Street
Chu-Pei City
Hsinchu County 302, Taiwan, R.O.C.
Tel: +886-3-552 5258
Fax (G&A): +886-3-552 5255
Fax (Sales): +886-3-552 5200
Brooks Automation Ltd.
TAINAN OFFICE
3F., No.11, Nanke 3rd Rd., Xinshi Dist.
Tainan Science Park
Tainan City 74147, Taiwan (R.O.C.)
TEL: +886-6-505-0268
FAX: +886-6-505-522
Brooks Automation, Inc. 15 Elizabeth Drive Chelmsford, MA 01824-2400 Tel: +1 978-262-2400
Fax: +1 978-262-2500
www.brooks.com
Revision History
Part Number: 281945
Instal lat ion and Operat ing Ins t ruct ions for the FluidX Intel l iCode™
Software
Revision ECO Number Date Explanation of Changes
Revision A 95874 8/30/2017 Initial completion of the manual.
Revision B EC102004 2/26/2018 Updated document for Brooks Branding. Updated document to approved Brooks Template.
Table of Contents
1 Introduction 9
2 Installation 10
3 Activation 13
4 Deactivation 16
5 Managing License 17
5.1 Select Add License 18
5.2 Updating User Details 19
6 Getting Started 21
7 Exporting Files 24
7.1 Export to Text 25
7.1.1 Naming Data with Keyboard Wedge 26
7.1.2 Naming Data with Manual Filename 27
7.1.3 Legacy Rack Enabled 28
7.1.4 Saving Data 29
7.2 Export to Document 29
7.3 Export to PDF 30
7.4 Export to DB 32
7.5 Export to Image 33
7.6 Export to Audit 34
8 Selecting an Instrument 35
9 Creating a New Profile 36
9.1 Auto Detect a New Profile 36
9.2 Manually Enter a New Profile 37
9.3 Create a New AcoustiX Profile for Perception HD AcoustiX users p/n 20-4003 39
9.4 Selecting FluidX 2d Rack ID with Orientation 40
9.5 Setting up a Linear Barcode Reader 43
9.6 Create a Single Tube Profile 45
9.6.1 Perception and Perception HD Reader 45
9.6.2 Impression reader 46
9.7 Adjusting the Settings 46
9.8 Selecting SBS Rack Barcode 47
9.9 Common Errors 48
9.9.1 No Tube 48
9.9.2 2d ID Cannot Be Decoded 48
10 Features 50
10.1 Tool bar 50
10.1.1 Profile 50
10.1.2 Help 51
10.1.3 Instrument 51
10.1.4 Virtual Imager 52
10.1.5 Export Options 52
10.1.6 Rack and Tube Arrangements 52
11 Decode Process 53
11.1 Parameters 53
11.2 Crop 55
11.3 Image Process 56
11.4 Validate 56
11.5 No Tube 56
11.5.1 No Tube/ No Read Configuration 57
11.6 Decoder 57
12 Command Line Options 58
12.1 Getting Started 58
12.2 System Commands 60
12.3 IntelliCode Commands 61
12.4 Instrument Commands 61
12.5 Instrument Profile Commands 62
12.6 Profile Exporter Commands 62
13 Remote Access 62
13.1 IntelliCode Software Version 8.1.1.842 (R) and later 63
13.2 IntelliCode Software Versions before 8.1.1.842 (R) 63
13.2.1 Legacy interface 63
13.2.2 Xtr96 legacy interface 65
13.2.3 Winsock interface 65
13.2.4 WebService Interface 67
14 Appendix: Date Value Format 68
99 Of 70
Introduction
Intellicode™ is designed to have no or very little user input. It’s pre-configured for use with 96, 48 and 24 format racks. The built-in generator will customize the export file so that it is compatible with almost any LIMS or Database system.
Alternatively, it is possible to use the auto-generate function to create a file in standard export format. Design a Word or PDF template with your logo, add images and customize the format. IntelliCode™ can automatically use this template to create beautifully presented reports ready for your internal and external customers. Profiles and export files can be shared between users on a single PC, and also across a network, to reduce set-up time.
IntelliCode™ will keep an audit trail of all the decoding performed. To recreate any export files, change the format, or make a backup copy, simply set the date range required and IntelliCode™ will generate the export files as required using our unique audit trail.
IntelliCode™ can be remotely controlled using a console or TCIP Winsock, and is also compatible for use in systems where FreezerPro has been previously integrated.
There is also a built-in database connector for secure transfer of scanned tube data to your corporate SQL database.
IntelliCode™ is able to discriminate between a tube with a barcode that cannot be decoded and a rack position with no sample present using the “no tube” function. With this feature on, it will not attempt to decode empty tube position, keeping vital data files “clean” of wasted data, leading to faster rack reading.
IntelliCode™ can perform both 2D and 1D rack decoding. A manual input option is available, this is particularly useful when the scanner is unable to read the barcode (e.g. if rack is placed incorrectly or no barcode present) or if an independent linear barcode reader is to be used. IntelliCode™ can use either the 1D or 2D barcode as a rack identifier, and the 2d rack ID can be (is also) used for Auto-rack Orientation.
IntelliCode™ can take as little as 3.1ms to decode a tube! With true Multi-Core optimization, IntelliCode™ has been designed for use with modern PCs. This parallel processing enables a rack of 96 2D bar-coded tubes to be decoded in less than 300ms.
Finally, we use a license key to activate the software rather than a dongle, so there are no wasted USB ports.
1010 Of 70
1 Installation
Do not connect a reader device until installation is complete.
Ensure the user installing the software has full admin rights (Read, Write and Modify) to the
registry.
Close all other applications during the installation process.
Step Image Action
1.
Figure 1
Open the IntelliCode™ folder on the Fluidx software USB stick. Run application as administrator.
2.
Figure 2
Follow the on screen instructions. Select “Next” at the Welcome screen to start the install process.
3.
Figure 3
Verify the Install path and select “Next”. The installation will proceed.
1111 Of 70
Step Image Action
4.
Figure 4
Select which hardware needs to be installed.
5.
Figure 5
Verify the Install Details and select “Install”. The install will proceed.
6.
Figure 6
The installation will proceed through various steps. This may take a few moments.
1212 Of 70
Step Image Action
7.
Figure 7
Read the release note information before selecting Next.
IntelliCode™ has now been successfully installed on the PC.
To open the software, double-click the shortcut on the desktop.
Figure 8
1313 Of 70
2 Activation
Account information can be found on the ID label inside your reader box, as shown below:
Figure 9
Step Image Action
1.
Figure 10
From the Tool bar, select “Help” then “Activation”.
2.
Figure 11
Go to the “Account” tab and enter your Username and Password. Select Apply.
1414 Of 70
Step Image Action
3.
Figure 12
Enter the serial number of the unit (which can be found on the bottom of the reader). The software can be used for 30 days without activation, however after 30 days the software will become locked. Activation can be performed at any time after installation.
There are two options to activate the software; the information above must be entered before
proceeding to the next stage.
1. Activate online, internet connection required.
Step Image Action
1.
Figure 13
Select “Activate Online”.
2.
Figure 14
Activation is complete.
1515 Of 70
2. Create Email and Enter Code:
Step Image Action
1.
Figure 15
Select the Create Email button. This automatically creates an email with the necessary information to send to Brooks Service Team-. Please note that due to high level of traffic, we aim to respond to these emails within 48 hours. Once the activation code is received from the Service Team, follow step C below.
2.
Figure 16
Enter the Serial Number and Activation Code into the fields on the activate screen.
3.
Figure 17
Select “Activate using code”
4.
Activation is now complete.
1616 Of 70
3 Deactivation
Unless additional licenses are purchased the software can only be activated on one PC at any one
time. If the license needs to be migrated to a different PC, this can be achieved by deactivating
and transferring the license.
This can be managed via the Activation screen.
If the software is needed in a new location, then once the install has taken place, go to Section 4:
Managing License.
Step Image Action
1.
Figure 18
Figure 19
Select the Deactivate Online Now button. OR Press the Deactivate Offline Now button
2.
Figure 20
Select OK.
3.
Figure 21
Select OK.
1717 Of 70
4 Managing License
Licenses can be controlled via the on-line activation centre, this may be more useful in the instance when there are additional licenses assigned to one scanner, or multiple scanners are installed on site.
Step Image Action
1.
Figure 22
Access can be gained by selecting the “Manage licenses 24/7” or going to www.fluidxactivation.co.uk
2.
Figure 23
Enter the Username and Password. Contact [email protected] if you do not remember the user name and password If the PC is not shared and in a safe location, “Remember me” can be selected.
3.
See Figure 24 on page 18.
Select the order number by pressing the key icon. An additional box will appear below with activation information regarding the order.
4.
See Figure 24 on page 18.
For a new activation, select the red Plus sign and enter the Site and Mid code from
the IntelliCode™ activation screen. The Note field can be used for internal use, for example which computer holds the licence, or department.
1818 Of 70
Figure 24
4.1 Select Add License Selecting the Email icon option generates a pre-populated email which can be sent to the user, IT department, manager etc. as a record of activation. The default email is [email protected]. Details should be updated when the software is activated. The activation code can also be located in the body of text. This can be used for “Activate using code” if the other activation methods are not available.
1919 Of 70
Figure 25
4.2 Updating User Details Once the software has been activated, the user details need to be updated.
Step Image Action
1.
Figure 26
2.
See Figure 27 on page 20.
Edit all user information. This information can be used if the password is lost and when activating using email.
2020 Of 70
Figure 27
2121 Of 70
5 Getting Started
IntelliCode™ is designed to have no or very little user configuration.
There are three default profiles for FluidX consumables, and others can easily be set up using the
Wizard option.
Step Image Action
1.
Figure 28
Open the IntelliCode™ software by double-
clicking the shortcut on the desktop.
2.
Figure 29
Select an instrument.
See section 8: Selecting an Instrument
Place a rack on the reader and select which
profile matches the manufacturer and
configuration of the rack.
If the manufacturer or configuration is not
known, select the profile that best
represents what you have (i.e. Fluidx_96 if
it is a 96-format SBS rack).
The rack must be placed with the A1 /1
position corresponding to the indicated
position on the top of the instrument if
marked.
3.
Figure 30
Select “GO”
The grid box positions will turn green when
all the tubes are decoded.
2222 Of 70
Step Image Action
4.
Figure 31
The number of successful, failed, and no
tube output is reported at the top of the grid
with the decode time.
5.
Figure 32
Select a single cell to see more detailed
information of the code.
2323 Of 70
Step Image Action
6.
Figure 33
Figure 34
Select the “1d_rackid_1” for more detailed
information of the linear barcode if one
installed, or the data matrix 2D rack ID.
7.
Below the grid table is the destination
directory for the exported data.
8.
Figure 35
Right clicking on the “Export” line gives the
following options:
1. Open Containing Folder: Opens the
Export destination folder.
2. Open With Associated Application:
Open the Export data file.
9.
Figure 36
In the event a tube cannot be read as
shown in Figure 36, go to Section 8.9.1:
Common Errors – No Tube.
2424 Of 70
6 Exporting Files
IntelliCode™ allows the user to Export the data in 6 ways: Text, Document, PDF, DB (Database),
Image, or Audit. To access these options, see below.
Step Image Action
1.
Figure 37
Double-click a profile to access the “Export”
options.
2.
Figure 38
The editing screen in Figure 38 will appear.
3.
Figure 39
Select “Export options” from the list on the
left. The screen in Figure 39 will appear.
2525 Of 70
6.1 Export to Text Double click an exporter from the list, create, or copy an exporter to open the “Text Export”
window.
Figure 41
The export file can be given a custom name by typing in the space by “Name” at the top; this will
help identify the exporter among other exporters you may have setup.
Once the exporter has been named, the “Auto Create” button can be selected to generate a
standard format for the rack type.
The export information can be customised by copying and pasting the selection from Evaluators to
the Edit column.
The evaluators from the edit column can also be used in the filename box to designate the name of
the file that will be used. The file type can also be chosen by changing the extension on the end of
the filename. For example, changing the extension to .txt will result in the exported file being a .txt
file.
Step Image Action
4.
Figure 40
In “Export Options”, you are able to choose
to Delete, Create New, Copy, or Edit an
Exporter.
2626 Of 70
6.1.1 Naming Data with Keyboard Wedge
Step Image Action
1.
Figure 42
Select the “Use Keyboard Wedge” at the
bottom of the “Edit” column to see the “Line
Interval”. If used with a profile for racks of
tubes, the time interval between lines of
data can be set. This allows you to output
each tube barcode with a unique time
stamp.
2.
Save and exit the “Close Edit Mode”.
Select Go.
3.
Figure 43
The screen in Figure 43 will appear. Select
OK and open the destination application.
4.
Figure 44
Place the cursor in the correct location for
the data.
The information from the scan and decode
will be imported into the open application.
2727 Of 70
6.1.2 Naming Data with Manual Filename
Step Image Action
1.
Figure 45
Select the “Manual filename” at the bottom
of the “Edit” column.
2.
Save and Exit this screen. On the next
screen, select “GO”.
3.
Figure 46
A path and filename box will appear. See
Figure 46.
4.
Name the file as you want. You can also
use a Date Evaluator $(time) to alter the
output by simply changing the expression of
the string.
Example:
Name $(time: H,m,s,yyy,M,D).txt
This will give the time in Hours (H) 24 hour
mode, minutes (m), seconds (s), year
(yyyy), month (M) and day number (D)
Please note the space after the colon.
For complete list of all the evaluator please
refer to the Appendix at the end of this
manual
2828 Of 70
6.1.3 Legacy Rack Enabled
Exports the data in the same configuration as the rack.
Figure 47
The export information can also be customised into a standard plate layout by copying and pasting
the required Evaluator from the Evaluators column to the Edit column. Use a comma between
evaluators in the Edit column to put values in adjacent columns (see Figure 48), or use a carriage
return to place the data in the next row. The Preview column will show how the output will look.
Figure 48
2929 Of 70
6.1.4 Saving Data
Path: Destination path for the data, selecting the “….” option allows the user to browse the
directory.
Default path = %appdata%\fluidx\Intellicode\Reports
Filename(under Edit column): Sets the name of the file when saved
Filename(under Preview column): Example of how the file name will look when exported.
6.2 Export to Document To create a Microsoft Word document select Document from the Export Options and check the
Enable box.
Step Image Action
1.
Figure 49
Templates have been pre-configured and are stored at C:\ProgramData\fluidX\IntelliCode\profiles\Perception To delete, edit or create a new document select the option from the Icons to the right.
2.
Figure 50
It is important to make sure you have written a file extension to the Export path, for example .txt or .doc
3.
Figure 51
Select “Test” for an example of the output, or select “OK” to save and migrate to the Export page.
3030 Of 70
6.3 Export to PDF To create a PDF document, select PDF from the Export Options and check the Enable box.
Step Image Action
4.
Figure 52
IntelliCode™ Word Export Example.
Step Image Action
1.
Figure 53
To delete, edit, or create a new PDF exporter, select the option from the Icons to the right.
3131 Of 70
Step Image Action
2.
Figure 54
Complete the “Exporter Name” and “Export Path”. The “Export Filename” can be completed using evaluators if required. In addition unique customisation of your report is available using the following options: Footer text: Your company name could be inserted here for example Logo: Your company logo can be easily added to the PDF exporter by selecting the location of a .bmp /.Jpeg / .Png file. Logo Text: Allows additional information to be included if required. Export Code Image: checking this option will include images of each of the codes on the .PDF report
3.
Figure 55
Select OK to save the exporter.
4.
Figure 56
Example PDF export.
3232 Of 70
6.4 Export to DB Database allows data transfer with ODBC (Open DataBase Connectivity).
Step Image Action
1.
Figure 57
From the Export Options, select “database” and select “New DB Exporter”.
2.
Figure 58
The screen in Figure 58 will appear.
3.
Figure 59
Next, you will need to choose the
connection type you intend to use.
Navigate to the DSN dropdown and select
the connection type.
3333 Of 70
6.5 Export to Image The Image feature allows you to download a .Bmp or .Jpeg image of the rack
Step Image Action
4.
Figure 60
Using either copy and paste, or “Auto”
move the Evaluators to the Edit column.
Use a comma between evaluators in the
Edit column to put values in adjacent
columns, or use a carriage return to place
the data in the next row. The Preview
column will show how the output will look.
Select “Save”
5.
Figure 61
Process is complete.
Step Image Action
1.
Figure 62
To delete, edit, or create a new “Image Exporter”, select the option from the Icons to the right.
3434 Of 70
6.6 Export to Audit The audit features allows you to restore data from previous scans.
This can be useful when a previously scanned rack data is accidently deleted and you need to
recover it, or if you need to keep a duplicate of all previously scanned rack data.
To use the Audit feature, enter a start date and end date, then select the Audit button. The
software will run through all the scans taken between these two dates and export the data using
your current export settings.
Figure 64
Step Image Action
2.
Figure 63
Complete the “Exporter Name”, and “Export Path”. The “Export Filename” can be completed using evaluators if required. Select either Jpeg or Bmp, and click OK to save the exporter.
3535 Of 70
7 Selecting an Instrument
IntelliCode™ is compatible with all FluidX SBS rack readers.
Various readers can be chosen from a list of instruments. If the text is greyed out or not showing,
the device has not been installed, not installed correctly, or not plugged into the PC.
Step Image Action
1.
Figure 65
Go to “Instruments” and select the
Instrument you need.
Making a selection of the instrument will
show an icon of the device to the left.
Virtual Instrument: This option can be used in the instance when an integrator or prospect purchaser would like to try the software. Select the refresh icon to display the available devices, select reader device, and press “Select”.
3636 Of 70
8 Creating a New Profile
8.1 Auto Detect a New Profile The new version of IntelliCode™ allows for automatic profile detection.
Step Image Action
1.
Figure 66
Go to “Profile” and select “Detect”
2.
Figure 67
Select or deselect the features you want to
look for in the profile (i.e. linear barcode or
linear barcode with 2D rack ID) in the
“Profile Creator”.
Once you are happy with the profile, select “Find” and the Profile Creator will begin finding the optimal settings to detect the tube & rack type currently on the reader.
Once the profile is detected, IntelliCode™ has a few options for exporters and profile naming. A csv exporter is enabled by default. You can then add a suitable profile name.
3.
Select “Create profile” to create this profile
and add it to the profile list.
3737 Of 70
8.2 Manually Enter a New Profile
Step Image Action
1.
Figure 68
Go to “Profile” and select “New”.
2.
Figure 69
On the next screen, use the mouse to drag the desired “SBS Sample Rack” over the rack image. Use the mouse to change the size of the image, or to move the image around the page.
3.
Figure 70
Refine the Region of Interest (ROI). This
improves decode time and optimises
decoding for difficult to read codes.
ROI Size: The size of the area around the code image. ROI Scale: The spacing between the squares of the grid. D: Returns the setting to factory default. Bin Icon: Deletes the settings.
4.
Figure 71
Select “Decode”
3838 Of 70
Step Image Action
5.
Figure 72
The name of the rack is created and saved
by going to the Details tab.
6.
Figure 73
To save the new profile, go to “Profile” and
“Save”
7.
Figure 74
The file will be saved in the default folder:
C:\ProgramData\fluidX\IntelliCode\profiles\V
irtual Instrument.
Once the file is saved, go to “Profile”, then
“Close Edit Mode”.
3939 Of 70
8.3 Create a New AcoustiX Profile for Perception HD AcoustiX users p/n 20-
4003 The Labcyte Echo® Qualified AcoustiX tubes utilize a unique 2D4 code that features additional
redundancy.
For Perception HD AcoustiX users, an AcoustiX tube profile will appear as default and therefore it
will not be necessary to create your own profile.
For non-Perception HD AcoustiX users, this feature is not enabled.
In the unfortunate situation where the AcoustiX profile is deleted, the automatic detect feature
enables the user to set up a new AcoustiX profile.
Please refer to Section 9: Creating a New Profile (Auto Detect A New Profile)
Step Image Action
8.
Figure 75
The new profile will be added to the list on
the main screen.
9.
Figure 76
To select the profile, select the box next to
the required profile.
Multiple profiles can be selected and
IntelliCode™ will determine the rack profile
(96, 48 or 24), automatically decode each
tube and save your data.
4040 Of 70
8.4 Selecting FluidX 2d Rack ID with Orientation
Step Image Action
1.
Figure 77
Drag and drop the FluidX 2D Rack ID onto
the grid of the rack and you will see 2
boxes.
2.
Figure 78
The solid box (circled in green) should be
placed over the rack ID when a rack is
placed with the correct standard orientation
(A1 rack position aligned with the indicator
on the instrument).
As you move this solid box, the other hollow
box (circled in red) will move automatically
and mirror its position.
If you place the rack on the instrument
rotated 180 degrees, the hollow box (in red)
should provide a successful read
automatically in the orientated position.
4141 Of 70
Step Image Action
3.
Figure 79
Figure 80
Selecting the ROI (Region Of Interest) of an
individual tube code will generate a Decode
Report.
See Figure 80 for an example of the
Decode Report.
4242 Of 70
Step Image Action
4.
Figure 81
Figure 82
If the image has been orientated, the switch
icon will be shown above the image of rack
5.
Figure 83
In the event that the 2d_rack_1.ID cannot
be read, a dialogue box will appear so the
value can be manually entered.
4343 Of 70
8.5 Setting up a Linear Barcode Reader
Step Image Action
1.
Figure 84
When an external Linear Barcode Reader
(LBR) is being used on the settings screen,
the Barcode Imager Icon will be present
under Rack Imager.
Selection of this Icon will make an image
from the LBR appear.
2.
Figure 85
Expand the Rack ID section, and use the
mouse to drag SBS rack Barcode over the
image of the linear barcode on the rack.
3.
Figure 86
Make sure there is a clear white area on
both side of the code.
4.
Figure 87
Adjustment of the size of ROI can be made
by altering the “Capture Quality”.
Selecting “Realtime Video” enables live
video from the camera.
The focus can be altered by rotating the
camera lens on the LBR.
Move the camera on the fixing bracket to
attain a better image of the barcode.
On the back of the camera is a dial for
adjusting the light contrast.
5.
Figure 88
Figure 89
Select “Decode” to the right of the screen
and the ROI will turn green on a successful
decode.
4444 Of 70
Figure 90
Figure 91
The image at the bottom will appear with
the text “Decode Success” and decode
time.
6.
Figure 92
Selecting the image will open a new screen
with the Rack ID and code type.
Check the code type for the linear code.
The majority of codes are Code39,
Code128, or Interleaved.
If the code is not decoding, select different
code types.
Try changing the “Threshold” to “Adaptive”.
Increase the “Timeout” to allow the software
more time to decode.
Change the Code pattern from “Any” to
“White”.
Adjust the “Speed”.
In the export screen entering
$(barcode.1d_rackid_optical_1.ID) to edit
field will add the Rack to the file export.
This can also be added to the file at the
bottom of the export page so the rack ID is
an identifier for the file name.
4545 Of 70
8.6 Create a Single Tube Profile
8.6.1 Perception and Perception HD Reader
Step Image Action
1.
Figure 93
Place the cover with the single tube opening
on the reader.
Go to Profile and select New.
Expand the dropdown list for “Single Tube”
and drag the “2d Code” option over the
circle shown in the image.
2.
Figure 94
Hold a tube in the opening and select
“Scan” to gain a new image.
Select Decode.
The ROI around the tube will turn green and
decoded tube image will appear at the
bottom right.
If the is not decoded adjust the Parameters
under the Decode Process.
Steps to create an export can be found in
Section 6: Exporting Files
Save the settings and “Close Edit Mode”.
3.
Figure 95
The option for the single tube can now be
selected from the main page.
4646 Of 70
8.6.2 Impression reader
Follow the steps above, but use the single tube aperture on the Impression to scanner to align the ROI.
8.7 Adjusting the Settings
Double-click the profile to adjust any settings. This will navigate to the editing page.
To adjust the rack or orientation settings, select the “rack” tab.
To adjust the 2d ID, select the “2d_rackid_1” tab.
Figure 97
Step Image Action
4.
Figure 96
Select “GO”.
4747 Of 70
8.8 Selecting SBS Rack Barcode
Step Image Action
1.
Figure 98
Figure 99
Drag the option for SBS Rack Barcode over
the linear barcode.
2.
Figure 100
Select 1d_rackid_.
3.
Figure 101
The majority of linear barcodes will CODE39, CODE128, or INTERLEAVED25. ”Histogram” must be checked for 1d rack id. Adjustment of the Decode Parameters may be necessary for non-standard codes.
4.
Figure 102
Clicking on the decode image shows a
dialogue box with a detailed Decode
Report.
4848 Of 70
8.9 Common Errors
8.9.1 No Tube
If tubes are not being read, the decode process should be checked.
To determine the parameters of a code click on a green cell in the grid under the Decode Process List and
compare the parameters to a code that has not been read.
Cell Number, Width and Height and Foreground colour are the most common things to change.
Check the code is within the ROI and is clear, not damaged, and free from frost or debris on the glass.
Figure 103
8.9.2 2d ID Cannot Be Decoded
Step Image Action
1.
Figure 104
Check that the parameters are correct, and that the area is properly aligned and sized. Ensure the ID was dropped on the world
before relocating over the rack id.
2.
Figure 105
8.9.3 Check the quality of the code.
8.9.4 For assistance, the image can be
exported and sent to
assessment.
4949 Of 70
3.
Figure 106
Select profile, then Export
4.
Figure 107
Create a File name for the information, and
select Save.
5.
Figure 108
Ensure the “Include instrument images” box
is checked. Select OK.
Default location for the saved files is
C:\Users\USERNAME\AppData\Roaming\fl
uidx\IntelliCode
Send the .XTBAG file to
6.
Figure 109
Alternatively, you can use the Exception
Report.
You can use this option to create a package
file featuring all crashes and logs.
Please send this file to
5050 Of 70
9 Features
9.1 Tool bar
9.1.1 Profile
Image Definitions
Figure 110
1. New: Creates new rack configuration
2. Edit: Changes can be made to a current
configuration
3. Save: saves axtpro file
4. Export: Profiles can be exported as a file
for use on other computers or for support
5. Import: Profiles can be imported from a file
6. Wizard: Creates a new rack profile using a
number of preset options
7. Detect: Creates a new rack profile of the
tubes on the reader using an automatic
decoding algorithm
8. Test: Performs a decode so the
configuration can be checked before
closing the edit mode.
9. Close Edit Mode: Saves and closes
settings and returns to main page
10. Exit: Closes the software
5151 Of 70
9.1.2 Help
Image Definitions
Figure 111
1. About: Licensing, manufacturer and software information
2. Show Log: Transcript of software activity. For problems encountered with
IntelliCode™, this should be copied and
pasted, and sent to [email protected]
3. Activation: Information on IntelliCode™ activate and account settings. See Section 2: Activation
4. Installation Integrity: Checks that
Intellicode™ has been installed correctly with
the right permissions 5. Exception Report: Package to send to
FluidX-Support if an error occurs 6. Configure: Can change CPU or language
settings
9.1.3 Instrument
Shows installed devices
Step Image Action
1.
Figure 112
If the device is currently plugged in and
detected by the PC, it will appear on the
screen.
2.
Figure 113
Select the unit on the right and press
“Select”. If your unit is not listed, press the
“Refresh” button.
5252 Of 70
9.1.4 Virtual Imager
Allows IntelliCode™ to work without any hardware. Software can be used for evaluation with a
virtual instrument.
9.1.5 Export Options
Allows the user to export the reported values of the codes to various formats such as text file and
excel. See Section 6: Exporting files.
9.1.6 Rack and Tube Arrangements
Image Definitions
Figure 116
1. Orientation: Used to auto-orient the rack.
2. Rack ID: A selection can be made if the FluidX
2d rack is used or the 1d linear rack ID to record
the rack number.
3. SBS Sample Rack: Different rack formats which
can be selected.
4. Single tube: Opportunity to configure the option
of decoding a single tube
Step Image Action
1.
Figure 114
Select the “Virtual Imager” icon.
2.
Figure 115
A box will appear to the right of the screen.
Pressing “Grab Image”, scroll through the
images until the correct format is shown the
screen.
When ”Cycle Images” is selected, the
images will scroll on the main page once
the profiles are complete.
5353 Of 70
10 Decode Process
10.1 Parameters
Figure 117
Image Definitions
Figure 118
1. Threshold: Creates a binary image for the decoder.
There are a number of methods which achieve this.
2. Adaptive: Used in situations where the lighting
across the image may be uneven and/or the image
to decode occupies smaller region of the ROI.
3. Histogram: Best used in even lighting situations
and/or the majority of the ROI contains the image to
decode
4. Range: Uses a brute force method. Can cause a
delay in decoding.
Checking this option will lock down the decoder to
use the dimensions of the first successful decode. If
a rack is guaranteed to contain codes of the same
dimensions then checking this option can cause a
decrease in overall decode time.
Note for racks with mixed code dimension, leave
this option unchecked.
5454 Of 70
Image Definitions
Figure 119
1. Dimensions: Information regarding the code to find.
The set value to the right is the last recorded pixel
value.
2. Width: The size range for the code width (in dots)
3. Height: The size range for the code height (in dots)
4. Cell Size: The size range for a code dot (in pixels).
The value to the right is a successful value found by
the decoder. The minimum and maximum values
should be set to be integers above and below the
set value.
5. Optimise Cell Dimensions: With this option
unchecked, the decode process uses the same
dimensions for each decode attempt.
Figure 120
1. Code Pattern: Contains information regarding the
code matrix pattern.
2. White: Check this option if the code is white on
black. Uncheck for black on white.
3. Any: Check this option if the code can be either
black on white or white on black. For racks
containing mixed code patterns, ensure this option
is checked.
4. Presearch: This should be used when there is a
small code within a large ROI area
5. Check Finder: A validation step to prevent code
within code detection.
Figure 121
1. Speed: Reducing the speed uses more aggressive
algorithms when deciphering a code. Decreasing
the speed makes the decoding more robust at the
cost of time.
2. Cascade: When checked, each decode attempt will
start using the “Decode Method” selected. Retries
with successively slower methods will occur until a
successful decode has been achieved.
3. Time out: The maximum time (in milliseconds)
allowed for each decode attempt.
5555 Of 70
10.2 Crop Cropping extracts the image which will be used for the decode attempt.
Figure 122
Image Definitions
Figure 123
1. Nudge: Offsets the extraction region by a number of pixels. Use when code positions can vary or if codes can fall slightly outside of the ROI.
2. Offset: +/- Maximum offset of region extraction.
3. Step: Iterates from –Offset to +Offset in these
steps. Smaller values cam increase decode time
Figure 124
1. Rotate: Rotates the images by the number of
increments set.
Figure 125
1. Re-size: Scales the cropped image. If codes are very small this can improve decode success.
2. Factor: Resizes the image by this factor. 3. Method: The scaling method. 4. Bicubic( slowest):
http://en.wikipedia.org/wiki/Bicubic_interpolation 5. N-N ( fastest): http://en.wikipedia.org/wiki/Nearest-
neighbor_interpolation 6. Bilinear:
http://en.wikipedia.org/wiki/Bilinear_interpolation
.
5656 Of 70
10.3 Image Process Pre-process the image before attempting decode. This can increase the decode success for damaged, badly marked or lower quality codes.
Image processing works as a stack. Each method is applied to the image from top to bottom.
Image Definitions
Figure 126
1. GausianSharpen: Sharpens the image. Can improve decode success with over-marked codes
2. HistogramEQ: Creates a higher contrast image. Can improve decode success with codes with have little contrast.
3. Dilate: Attempts to increase the code marking. Can improve decode success with damaged or poorly marked codes.
4. Erode: Attempts to decrease the code marking. Can improve decode success with over-marked codes.
5. AdaptiveSmooth and BilateralSmooth: Smoothing algorithms. Attempts to remove image noise.
10.4 Validate Enabling the Validator expands various code output options.
This stops codes being read inside codes, and allows only codes with letters or numbers.
Figure 127
10.5 No Tube One of the key features of IntelliCode™ software is distinguishing between tubes that cannot be
decoded and empty spaces in the rack in both instances signalling it with different output: ”No
Tube” or ”No Read”
When ”No Tube” option is enabled, the parameters will need to be adjusted as different tubes need
slightly different parameters due to manufacturer type, camera focus and lighting conditions.
A series of sample lines at varying angles are taken across the cell image and checked for
compliance with a set of rules defining a likely matrix code. If the criteria are met the analysis
finishes and a matrix code is deemed to be present.
The samples lines should be increased or decreased so they cross the image of the code.
5757 Of 70
10.5.1 No Tube/ No Read Configuration
After performing the initial Scan and Decode, select one of the tubes that decoded correctly on the
full rack image. A closer image of the tube will appear on right of the screen with a table that
includes the tube parameters (Transition, Area); lines highlighted in red means the parameters
detected by the reader are out of the pre-set range. To fix this, read the steps below.
1. Select a few of decoded and non-decoded tubes, the “Transition” and “Area” values are
quite similar between various tubes, but different than empty/no-tube spots.
2. Adjust the values for the Transitions and Area so the values in the table are no longer red.
3. After adjusting parameters, select Decode to check if the new setting works. It is possible
that a red No-Read is in a place where there should be yellow No-Tube. This can be
triggered by ambient light, or the IntelliCode™ settings. Prevent ambient light interfering
with the scan, and make sure that the lid is on the rack.
4. Try another Scan/Decode and the rotate the rack around on the reader to make sure it is
not a singled-out instance
5. Check ROI alignment on the full-rack image and make sure that each code is not
positioned too close the edge
6. Check “Transition” and “Area” parameters. They need to be broad enough to decode the
tube, but close enough together so a “No Tube” is not recognised with the parameters.
Transitions: A transition occurs when the pixel value crosses the mean. A minimum and
maximum value for the number of transitions on a sample line is required.
Area: The modular area under the binaries for each sample line must fall between a minimum and
maximum value to indicate that a matrix code may be present. The reported “Transitions” and
“Area” can be filtered numerically ascending or descending by selecting the Transition or Area
white box. The set value for each should allow the range to cover the min and max for each
variable.
Noise: Non-matrix code images often have many transitional lines scattered close to the mean
(noise). These should be filtered out using the ‘Noise Level’ value, defined as a percentage of the
range of pixel values in the sample.
Margin: The width of a strip of pixels to be discarded around the edge of each cell image and is
applied at decoding time. This should be set so the lines cross over the code and not the whole
tube base.
10.6 Decoder Option to select different decode methods.
Figure 128
The default settings in the Mil column will have Primary and Active checked, and the default
settings in the CodeSpy column will only have Active checked.
5858 Of 70
11 Command Line Options
Command shell control: IntelliCode™ can be controlled via command shell. Execute IntelliCode
with –c on the command line for the command shell interface.
11.1 Getting Started Intellicode –c
The following command shell will appear.
Figure 129
Command Explanation Example
–c
Execute command shell.
Intellicode –c
-i
IntelliCode will run and select
the Perception™ instrument.
Intellicode –i Perception
-p
Enable profile(s)
1. IntelliCode will run and
ensure 96well profile is
selected. If the profile does
not exist it will be ignored.
2. IntelliCode will run and
ensure that the profiles
96well and 48well are
selected.
3. IntelliCode will run and
select the Impression™
Instrument. The Profiles
96well and 48well are
selected.
1. –p 96well
2. –p 96well –p 48well
3. Intellicode-I Impression –p
96well –p 48well
The command shell has an auto complete feature. Hitting tab will attempt to auto complete a
command.
5959 Of 70
To test, and for a list of system, commands, type ‘sys’ and hit the ‘Tab’ key.
Figure 130
Once a command is complete, hitting the ‘Tab’ key again will provide information about the
command. See Figure 131.
Figure 131
6060 Of 70
11.2 System Commands
Command Explanation Example
Sys.List
Lists all available
commands.
Sys.List(v)
A verbose list of all
available commands.
Sys.Exit
Exit the command shell
Sys.Run
Executes a command list.
You can place many
commands within a file and
execute them as a batch of
commands. This can help in
situations where you may
have a list of commands
that are used often.
1. Sys.run (<command list filename>)
2. This commandlist would scan a 96 well
profile using the Perception™
instrument:
Intellicode.Instrument.use( Perception )
Intellicode.Instrument.Profile.load(96.xtprof)
Intellicode.Instrument.Profile.scan
Sys. Remote
Allows remote control via
network.
1. Use legacy interface.
Legacy support for
xtr96.
2. Use winsock interface.
3. Use webservice
interface.
1. sys.Remote (legacy, <port>)
2. sys.Remote (winsock, <port>)
3. sys.Remote (webservice, <port>)
Sys. WaitTime
Waits for some time
Sys. WaitTime (<time>)
6161 Of 70
11.3 IntelliCode™ Commands The IntelliCode™ commands control the IntelliCode™ application directly. The command set is
accessed from the IntelliCode™ command scope.
Intellicode<tab>
Figure 132
11.4 Instrument Commands An instrument needs to be selected before a profile can be loaded. Instrument selection and
enumeration are as follows.
Command Explanation Example
Intellicode.Instrument.list
Lists available instruments.
Intellicode.Instrument.use
Sets an instrument to use.
Note: Instrument names are
case sensitive.
Intellicode.Instrument.use (<instrument
name>)
6262 Of 70
11.5 Instrument Profile Commands Once an instrument has been selected you can load a profile for scanning.
Command Explanation Example
Intellicode.Instrument.Profile<tab>
Lists all profile
commands
Figure 133
Intellicode.Instrument.Profile.list
Lists available profiles.
Intellicode.Instrument.Profile.load
Loads a profile. Note:
Profile names are case
sensitive.
Intellicode.Instrument.Profile. load (<profile
name>)
Intellicode.Instrument.Profile.scan
Issues a scan using the
loaded profile. This is the
equivalent of hitting ‘GO’
from the instrument
control screen. The
profile is scanned and
any active exports are
executed.
11.6 Profile Exporter Commands Once results are available. An exporter can be manually invoked.
Command Explanation Example
Intellicode.Instrument.Profile.Expor
ter.list
Lists available profile text
exporters.
Intellicode.Instrument.Profile.Expor
ter.getResults
Returns the results. Output
can be xml or formatted by
current profile exporter.
1. output as xml
2. output is formatted by
profile exporter
1. Intellicode.Instrument.Profile.Exporter.g
etResults (<exporter name>)
2. Intellicode.Instrument.Profile.Exporter.g
etResults <exporter name>
12 Remote Access
6363 Of 70
12.1 IntelliCode™ Software Version 8.1.1.842 (R) and later IntelliCode™ software version 8.1.1.842 (R) onwards is equipped with UI for establishing the
remote connection.
12.2 IntelliCode™ Software Versions before 8.1.1.842 (R) Any version below 8.1.1.842 (R) requires the IntelliCode™ to connect by using command shell
interface.
Figure 137
12.2.1 Legacy interface
Support for legacy xtr96 interface is possible by using the Remote( legacy ) option. The instrument and
profile need to be set beforehand. A text exporter will need to be set in the profile which exports in an
appropriate format.
Step Image Action
1.
Figure 134
From the main screen select Preference
and Remote
2.
Figure 135
This window will appear. Set the connection type (Winsock or Winsock Legacy for supporting XTR-96 interface) and port press Go.
3.
Figure 136
The software will now be listening for incoming commands.
6464 Of 70
The following example assumes the use of the Perception™ reader and a profile named 96.xtprof.
Step Image Action
1.
Figure 138
Type in the following 3 commands into the command line using the <tab> key after each line. Intellicode.Instrument.use( Perception) Intellicode.Instrument.Profile.load(96.xtprof) Sys.Remote( legacy) This will enable the xtr96 legacy remote control interface. Control is then enabled via a terminal
program.
2.
Figure 139
See Figure 139 for examples.
6565 Of 70
12.2.2 Xtr96 legacy interface
Command Explanation Example
?
List of supported xtr96
commands.
See Figure 139 for examples.
get
Scans the current profile
and outputs the results. The
results output are formatted
by the current profile
exporter.
See Figure 139 for examples.
read
Scans the current profile.
See Figure 139 for examples.
Rack
As ‘read’ but also sends
‘OK’ on completion.
See Figure 139 for examples.
Set tube =
Loads a profile. The
parameter is the profile
name. Available profiles
can be listed with ‘?’
See Figure 139 for examples.
12.2.3 Winsock interface
The winsock interface allows remote access to the command shell. Commands are issued remotely using the same command format as the command shell.
Step Image Action
1.
Figure 140
sys.Remote( winsock ) enables the
winsock interface.
6666 Of 70
2.
Figure 141
Access to the IntelliCode™ shell through a
terminal program.
Note: Replies to commands are wrapped
within an acknowledge and success/fail
message prefixes.
Information during the operation of the
command is prefixed with ”msg:”
On completion, the command is prefixed by
status ”success:” or ”fail:”
3.
Figure 142
Example of winsock command failure. An
invalid instrument is selected.
4.
Figure 143
Example of winsock scan command with
warning. Profile has a manual input item
which failed.
6767 Of 70
12.2.4 WebService Interface
Step Image Action
1.
Figure 144
Use “Winsock” as the connection type
and press “go”
2.
Figure 145
Execute the webservice
This will allow the customer to connect via HTML for 3rd party suppliers using web services as an interface.
6868 Of 70
13 Appendix: Date Value Format
Format
specifier Description Examples
"d" The day of the month, from 1 through 31.
More information: The "d" Custom Format Specifier.
2009-06-01T13:45:30 -> 1
2009-06-15T13:45:30 -> 15
"dd" The day of the month, from 01 through 31.
More information: The "dd" Custom Format Specifier.
2009-06-01T13:45:30 -> 01
2009-06-15T13:45:30 -> 15
"ddd" The abbreviated name of the day of the week.
More information: The "ddd" Custom Format Specifier.
2009-06-15T13:45:30 -> Mon (en-US)
2009-06-15T13:45:30 -> Пн (ru-RU)
2009-06-15T13:45:30 -> lun. (fr-FR)
"dddd" The full name of the day of the week.
More information: The "dddd" Custom Format Specifier.
2009-06-15T13:45:30 -> Monday (en-US)
2009-06-15T13:45:30 -> понедельник (ru-RU)
2009-06-15T13:45:30 -> lundi (fr-FR)
"f" The tenths of a second in a date and time value.
More information: The "f" Custom Format Specifier.
2009-06-15T13:45:30.6170000 -> 6
2009-06-15T13:45:30.05 -> 0
"ff" The hundredths of a second in a date and time value.
More information: The "ff" Custom Format Specifier.
2009-06-15T13:45:30.6170000 -> 61
2009-06-15T13:45:30.0050000 -> 00
"fff" The milliseconds in a date and time value.
More information: The "fff" Custom Format Specifier.
6/15/2009 13:45:30.617 -> 617
6/15/2009 13:45:30.0005 -> 000
"ffff" The ten thousandths of a second in a date and time
value.
More information: The "ffff" Custom Format Specifier.
2009-06-15T13:45:30.6175000 -> 6175
2009-06-15T13:45:30.0000500 -> 0000
"fffff" The hundred thousandths of a second in a date and time
value.
More information: The "fffff" Custom Format Specifier.
2009-06-15T13:45:30.6175400 -> 61754
6/15/2009 13:45:30.000005 -> 00000
"ffffff" The millionths of a second in a date and time value.
More information: The "ffffff" Custom Format Specifier.
2009-06-15T13:45:30.6175420 -> 617542
2009-06-15T13:45:30.0000005 -> 000000
"fffffff" The ten millionths of a second in a date and time value.
More information: The "fffffff" Custom Format Specifier.
2009-06-15T13:45:30.6175425 -> 6175425
2009-06-15T13:45:30.0001150 -> 0001150
"F" If non-zero, the tenths of a second in a date and time
value.
More information: The "F" Custom Format Specifier.
2009-06-15T13:45:30.6170000 -> 6
2009-06-15T13:45:30.0500000 -> (no output)
"FF" If non-zero, the hundredths of a second in a date and
time value.
More information: The "FF" Custom Format Specifier.
2009-06-15T13:45:30.6170000 -> 61
2009-06-15T13:45:30.0050000 -> (no output)
"FFF" If non-zero, the milliseconds in a date and time value.
More information: The "FFF" Custom Format Specifier.
2009-06-15T13:45:30.6170000 -> 617
2009-06-15T13:45:30.0005000 -> (no output)
"FFFF" If non-zero, the ten thousandths of a second in a date
and time value.
More information: The "FFFF" Custom Format Specifier.
2009-06-15T13:45:30.5275000 -> 5275
2009-06-15T13:45:30.0000500 -> (no output)
"FFFFF" If non-zero, the hundred thousandths of a second in a
date and time value.
More information: The "FFFFF" Custom Format
Specifier.
2009-06-15T13:45:30.6175400 -> 61754
2009-06-15T13:45:30.0000050 -> (no output)
6969 Of 70
"FFFFFF" If non-zero, the millionths of a second in a date and time
value.
More information: The "FFFFFF" Custom Format
Specifier.
2009-06-15T13:45:30.6175420 -> 617542
2009-06-15T13:45:30.0000005 -> (no output)
"FFFFFFF" If non-zero, the ten millionths of a second in a date and
time value.
More information: The "FFFFFFF" Custom Format
Specifier.
2009-06-15T13:45:30.6175425 -> 6175425
2009-06-15T13:45:30.0001150 -> 000115
"g", "gg" The period or era.
More information: The "g" or "gg" Custom Format
Specifier.
2009-06-15T13:45:30.6170000 -> A.D.
"h" The hour, using a 12-hour clock from 1 to 12.
More information: The "h" Custom Format Specifier.
2009-06-15T01:45:30 -> 1
2009-06-15T13:45:30 -> 1
"hh" The hour, using a 12-hour clock from 01 to 12.
More information: The "hh" Custom Format Specifier.
2009-06-15T01:45:30 -> 01
2009-06-15T13:45:30 -> 01
"H" The hour, using a 24-hour clock from 0 to 23.
More information: The "H" Custom Format Specifier.
2009-06-15T01:45:30 -> 1
2009-06-15T13:45:30 -> 13
"HH" The hour, using a 24-hour clock from 00 to 23.
More information: The "HH" Custom Format Specifier.
2009-06-15T01:45:30 -> 01
2009-06-15T13:45:30 -> 13
"K" Time zone information.
More information: The "K" Custom Format Specifier.
With DateTime values:
2009-06-15T13:45:30, Kind Unspecified ->
2009-06-15T13:45:30, Kind Utc -> Z
2009-06-15T13:45:30, Kind Local -> -07:00 (depends on local computer
settings)
With DateTimeOffset values:
2009-06-15T01:45:30-07:00 --> -07:00
2009-06-15T08:45:30+00:00 --> +00:00
"m" The minute, from 0 through 59.
More information: The "m" Custom Format Specifier.
2009-06-15T01:09:30 -> 9
2009-06-15T13:29:30 -> 29
"mm" The minute, from 00 through 59.
More information: The "mm" Custom Format Specifier.
2009-06-15T01:09:30 -> 09
2009-06-15T01:45:30 -> 45
"M" The month, from 1 through 12.
More information: The "M" Custom Format Specifier.
2009-06-15T13:45:30 -> 6
"MM" The month, from 01 through 12.
More information: The "MM" Custom Format Specifier.
2009-06-15T13:45:30 -> 06
"MMM" The abbreviated name of the month.
More information: The "MMM" Custom Format Specifier.
2009-06-15T13:45:30 -> Jun (en-US)
2009-06-15T13:45:30 -> juin (fr-FR)
2009-06-15T13:45:30 -> Jun (zu-ZA)
"MMMM" The full name of the month.
More information: The "MMMM" Custom Format
Specifier.
2009-06-15T13:45:30 -> June (en-US)
2009-06-15T13:45:30 -> juni (da-DK)
2009-06-15T13:45:30 -> uJuni (zu-ZA)
"s" The second, from 0 through 59.
More information: The "s" Custom Format Specifier.
2009-06-15T13:45:09 -> 9
"ss" The second, from 00 through 59.
More information: The "ss" Custom Format Specifier.
2009-06-15T13:45:09 -> 09
"t" The first character of the AM/PM designator.
More information: The "t" Custom Format Specifier.
2009-06-15T13:45:30 -> P (en-US)
2009-06-15T13:45:30 -> 午 (ja-JP)
2009-06-15T13:45:30 -> (fr-FR)
7070 Of 70
"tt" The AM/PM designator.
More information: The "tt" Custom Format Specifier.
2009-06-15T13:45:30 -> PM (en-US)
2009-06-15T13:45:30 -> 午後 (ja-JP)
2009-06-15T13:45:30 -> (fr-FR)
"y" The year, from 0 to 99.
More information: The "y" Custom Format Specifier.
0001-01-01T00:00:00 -> 1
0900-01-01T00:00:00 -> 0
1900-01-01T00:00:00 -> 0
2009-06-15T13:45:30 -> 9
2019-06-15T13:45:30 -> 19
"yy" The year, from 00 to 99.
More information: The "yy" Custom Format Specifier.
0001-01-01T00:00:00 -> 01
0900-01-01T00:00:00 -> 00
1900-01-01T00:00:00 -> 00
2019-06-15T13:45:30 -> 19
"yyy" The year, with a minimum of three digits.
More information: The "yyy" Custom Format Specifier.
0001-01-01T00:00:00 -> 001
0900-01-01T00:00:00 -> 900
1900-01-01T00:00:00 -> 1900
2009-06-15T13:45:30 -> 2009
"yyyy" The year as a four-digit number.
More information: The "yyyy" Custom Format Specifier.
0001-01-01T00:00:00 -> 0001
0900-01-01T00:00:00 -> 0900
1900-01-01T00:00:00 -> 1900
2009-06-15T13:45:30 -> 2009
"yyyyy" The year as a five-digit number.
More information: The "yyyyy" Custom Format Specifier.
0001-01-01T00:00:00 -> 00001
2009-06-15T13:45:30 -> 02009
"z" Hours offset from UTC, with no leading zeros.
More information: The "z" Custom Format Specifier.
2009-06-15T13:45:30-07:00 -> -7
"zz" Hours offset from UTC, with a leading zero for a single-
digit value.
More information: The "zz" Custom Format Specifier.
2009-06-15T13:45:30-07:00 -> -07
"zzz" Hours and minutes offset from UTC.
More information: The "zzz" Custom Format Specifier.
2009-06-15T13:45:30-07:00 -> -07:00
":" The time separator.
More information: The ":" Custom Format Specifier.
2009-06-15T13:45:30 -> : (en-US)
2009-06-15T13:45:30 -> . (it-IT)
2009-06-15T13:45:30 -> : (ja-JP)
"/" The date separator.
More Information: The "/" Custom Format Specifier.
2009-06-15T13:45:30 -> / (en-US)
2009-06-15T13:45:30 -> - (ar-DZ)
2009-06-15T13:45:30 -> . (tr-TR)
"string"
'string'
Literal string delimiter. 2009-06-15T13:45:30 ("arr:" h:m t) -> arr: 1:45 P
2009-06-15T13:45:30 ('arr:' h:m t) -> arr: 1:45 P
% Defines the following character as a custom format
specifier.
More information:Using Single Custom Format
Specifiers.
2009-06-15T13:45:30 (%h) -> 1
\ The escape character. 2009-06-15T13:45:30 (h \h) -> 1 h
Any other
character
The character is copied to the result string unchanged.
More information: Using the Escape Character.
2009-06-15T01:45:30 (arr hh:mm t) -> arr 01:45 A