Operating Instructions

SartoCollectData Transfer and Integration

98646-002-93

License and Warranty Agreement

In no event shall Sartorius AG or itssuppliers or its resellers or its licensorsbe liable to you or any other person for any indirect, special, incidental, or consequential damages of any kindincluding, without limitation, damagesfor loss of profits or of data, arising out of this Agreement or use of thesoftware. In no event will Sartorius AGbe liable for (a) any damages in excessof the amount Sartorius AG or its suppliers or resellers received from youfor a license to the software, even ifSartorius AG has been advised of thepossibility of such damages andnotwithstanding the failure of essentialpurpose of any remedy, or (b) for anyclaim by any third party.

22

SSaarrttooCCoolllleecctt IInnssttaallllaattiioonn AAggrreeeemmeennttThis product is licensed for use by Sartorius AG and its licensors and islicensed for use according to the num-ber of computer installation and/orinstrument/device connection licensespurchased, or in special cases, condi-tions agreed to under a separate agree-ment may apply. By continuing withthis installation you are acknowledgingthat you and/or your organization arein possession of and are in compliancewith the license agreement you havewith Sartorius AG with respect to thisproduct.

Sartorius AG warrants this productagainst defects in materials and work-manship for a period of 90 days fromthe original date of purchase. In theevent that this product is defective inmaterials or workmanship, your soleremedy shall be the replacement of thisproduct. This is the only warranty ofany kind, expressed or implied, includ-ing, but not limited to, the implied warranties of merchantability and fitness for a particular purpose that ismade by Sartorius AG for this product.

CopyrightSartoCollect and this manual are copyright-protected by Labtronics Inc.with all rights reserved. No part of thissoftware or manual may be copied, inwhole or in part, without written con-sent from Labtronics Inc., except tomake a backup copy for normal use.

Windows® is a registered trademark ofMicrosoft® Corporation.

EULA (End User License Agreement)Sartorius AG grants you a non-exclusivelicense to use SartoCollect from a singlemachine with each license purchasedand to copy it for a backup in supportof your use of the program.

The SartoCollect software (“Software”)is defined as the installed SartoCollectprogram and all its system files and/orany utility or service program or toolincluded with the SartoCollect installa-tion media. The Software is licensed forsingle machine installation.

Each machine, including Thin Clients,that will run the Software represents a single license of the Software.

Single machine installation definition: A single machine installation is definedas any computer or electronic devicethat has the Software installed locally oris used to access the Software through a remote terminal client.

WarrantySartorius AG warrants this productagainst defects in materials and work-manship for a period of 90 days fromthe original date of purchase. In the

event that this product is defective inmaterials or workmanship, your soleremedy shall be the replacement of thisproduct. This is the only warranty ofany kind, expressed or implied, includ-ing, but not limited to, the implied warranties of merchantability and fitness for a particular purpose that ismade by Sartorius AG for this product.

Under no circumstances shall Sartorius AG or its licensors or its suppliers or resellers be liable for anyindirect, special, incidental or conse-quential damages of any kind including,without limitation, damages or loss ofprofits or data arising out of the use of,or inability to use, this product. Sartorius AG and its licensors shall notbe liable for (a) any damages in excessof the amount Sartorius AG receivedfrom you for a license to the software,even if Sartorius AG has been advised of the possibility of such damages andnotwithstanding the failure of essentialpurpose of any remedy or (b) for anythird party claims or costs incurredthrough third party claims of infringe-ment of any copyright, patent trade-mark or other intellectual propertyrights unless Sartorius AG and/or itslicensors are found guilty of such acts.

Changes may be made periodically tothe information herein. These changeswill be incorporated in the new editionsof this publication. The information fur-nished herein is believed to be accurateand reliable. However, Sartorius AG shallnot assume any responsibility for theuse of this information.

3

Contents

6 Chapter 16 Introduction6 The SartoCollect Software7 SartoCollectlight

7 Technical Support8 The SartoCollect User Manual8 Terminology9 Conventions of the Manual

10 General Procedures10 The OK and Cancel Buttons10 Deletion Confirmation10 On-Line Help10 Exiting from SartoCollect10 Changing the Preferences10 Last Minute Changes

11 Installation11 Contents of the SartoCollect Package11 Hardware Requirements11 Software Requirements11 Options for Configuring the Hardware

and Software12 Installing the SartoCollect Software13 Installing the “Remote RS232-to-

TCP/IP Service“ Software13 Registering the Software13 Activation Key

15 Chapter 215 Quick Start-Just the Basics16 Terminology Review16 Changing Method Connections“ Port

Settings17 Quick-Start – Creating a Basic Method19 The Demonstration Methods20 The Method Setup21 The Template Setup21 The Instrument Setup23 RS232 Setup24 The Operation Setup27 Running a Method27 Opening a New Workbook27 Sending Commands

28 Place Data28 Closing the Method

29 Chapter 329 Configure Your Own Method29 Defining the Preferences30 Copy Method30 Defining a New Method30 Specifying a Method Name30 Specifying the Interface Type31 Defining an Excel® Destination32 Selecting a Sheet Destination32 Defining a File Destination32 Defining a Wedge Destination33 Connecting to Internet Explorer33 Advanced Control34 Setting Up an Instrument34 Specifying an Instrument Description35 Selecting an Instrument Type and

Name35 Specifying the COM Port Information35 RS232 Collector37 Transaction Logging37 Testing the Communications 39 Protocol39 Data Filter40 Discard Data40 Opening the COM Port40 Adjusting Operation Checkboxes41 Timed Interval Data Collection42 Operation Hotkey42 Reporting Result Data44 Adding Time, Date or Counter Macros45 Saving the Instrument Setup45 Testing the Instrument Setup45 Saving the Method Setup45 Post to Sartorius

46 Importing/Exporting46 Exporting a Method47 Importing a Method48 Exporting an Instrument48 Importing an Instrument

44

50 Chapter 450 Running a Method

Changing Method Connections’ PortSettings

50 Opening a Method 50 Opening an Existing Destination51 Opening another Destination51 Excel® Interface - Sending Commands51 Using One Instrument52 Using Multiple Instruments53 Place Data53 Turning Off the Instrument53 Saving the Workbook54 File Interface - Sending Commands54 Using One Instrument54 Using Multiple Instruments55 Monitor View55 Closing the Method55 Wedge Interface – Sending Commands56 Using One Instrument56 Using Multiple Instruments56 Closing the Method56 Hotkey – Sending Commands

57 Chapter 557 Configuring a New Instrument57 Introduction57 Importing a Device File58 Instrument Manager59 Adding a New Instrument60 Communicating with the Instrument61 S232 Collector Setup63 RS232-TCP/IP Collector Setup64 TCP/IP Collector Setup65 Connecting the TCP/IP Collector

to an E-Box65 Protocol66 Operation Setup67 Command67 Response68 Test Operation69 Macro Setup70 Test Macro

72 Chapter 672 The Simple Parser72 Parser Types72 Parser Syntax73 The Parser Selector73 The Parser Orientation73 The Parser New Line73 Designing a Simple Parser73 Using the Numbers Parser74 Using the Position Parser Type75 Using the Delimiter Parser Type77 Advance Options for the Simple Parser77 Affecting the Data Block

79 Chapter 779 Advanced Control – Sax Basic® Editor79 Summary79 Function Type80 Accessing the Advanced Control

Function Setup 80 Allowing Script Debugging80 Using the Template Script File 80 Template Script File82 ActiveX Automation Members82 Inter Collect Library82 LABTRONICSCOMMINSTR Library83 Affecting a Method’s Instrument

Interfaces and Data

84 Appendix A84 ASCII Numbers

85 Appendix B85 Troubleshooting

86 Appendix C86 RS232 Cable Specifications86 Instrument / Device Cable Requirements86 Standard RS232 Pin Configurations

(DTE Relative)87 RS232 DB25 to DB9 pin converter87 RS232 Null Modem Cables 87 RS232 Cable Length

88 Index 5

Chapter 1Introduction

The SartoCollect SoftwareSartoCollect is ideal for laboratories,field work, plant monitoring and production environments where aneasy-to-use yet extremely powerful data acquisition and control system isrequired to automate existing instru-mentation, devices and the applicationprocedures they’re used with.

SartoCollect is used around the Worldby thousands of companies in almostevery industry and discipline that per-forms testing and analyses with digitalinstruments or devices such as balances,scales, pH, ISE, EC, DO meters., spec-trophotometers, force gauges, calipersand micrometers, POC vital sign moni-tors, POS cash registers, PBX phone sys-tems, hardness testers, scanners, refrac-tometers, density meters, plate readers,thermometers, hygrometers, barometers,shakers, stirrers and many more.

SartoCollect is designed provide quickand accurate collecting, data processingand reporting functionality from instru-ments or devices with an RS232 serialcommunications port or Ethernet deviceservers via TCP/IP and supports bothhigh-speed asynchronous data acquisi-tion as well as bi-directional synchro-nous communications. From simpledata interfacing to automating proce-dures that include multiple instrumentsand User controls, SartoCollect includesthe tools to automate and enhancethese applications.

SartoCollect provides you with hundredsof different instrument and device con-figurations pre-set within its interfacedriver library and provides access to Sar-tocollect on-line User Base library ofinterface drivers. By simply adding theseinstrument interfaces to a processingprocedure (“Method”) and contributingcommunication parameters, you areable to collect data directly to Excel®,Files or emulate the keyboard wedge(“Wedge”) to transfer data to any openWindows® application without having to program operations.

SartoCollect also offers independence as well as simplicity. If the instrumentsor devices in the current database arenot compatible or available for yourparticular collecting process, visit Sarto-collect User Base Library on-line or see“Configuring a New Instrument” inorder to reconfigure the OperationSetup and define new instruments.These are called user-defined instru-ments. You are able to modify all thesettings of these instruments in order togain maximum flexibility.

66

SartoCollect is able to connect and con-trol multiple instruments or devices atone time and supports Windows® COMport numbers COM1 through COM255.Standard RS232 COM ports can belocated on the motherboard or on anadd-on board. The software is alsocapable of connecting devices over anetwork via TCP/IP communications.The software will work with multi-portboards configured to work under youroperating system. SartoCollect is a multi-tasking system that enables you to run many methods as well as allowsyou to work simultaneously with otherapplications, including separate Excel®worksheets.

SartoCollect works by extracting (pars-ing) only the data required from anyInstrument or Device and reports theparsed data directly to Excel®, disk filesor to directly to the cursor location inany open window. SartoCollect alsooffers many additional preprogrammedautomation capabilities to meet a broadarray of different interfacing scenarios.Features such as auto-starting methods,controlling interface commands on atimed basis, Date and Time stamping,and incorporating advanced controlVBA script macros within an interfacemethod for customized functionality.

SartoCollectlight

SartoCollectlight is a scaled down versionof the SartoCollect software that hassome of the more advanced interfacingautomation capabilities disabled. Sarto-Collectlight is intended for users that onlyrequire a simple “Wedge” interface totransfer data. to the cursor location inany open Windows® application. Thismanual will reference all features of theSartoCollect software. The followingfeatures of SartoCollect are disabled inthe “light” version are noted here onlyas well as through most of this manual;“File | Preferences” to change the activemethod directory, “File | Open”, “Excel”and “File” interface types, “Auto-StartMethod” setting, “Advanced Control”SAX Basic script editor, “Timed Collec-tion” Operation Setting processor,“Autostart” Operation setting, Hotkeyoperation setting, and Minimize to trayoptions.

Technical SupportShould you require any assistance to setup your new interfaces or automationroutines please contact us for technicalsupport or our professional servicesavailable to deliver a turn-key system.

Sartorius Technical Supportsartocollect@sartorius.com

7

The SartoCollect User Manual

It is assumed that you understand the general Windows® operating systemas well as the specific use and operationof Excel®. This manual is intended forboth SartoCollect and SartoCollectlight

users and is currently available in theEnglish language only.

TerminologyA Method is a complete set of instruc-tions for a particular type of interfacingprocedure. It defines all the instrumentsor devices that are to be interfaced withat run-time within the same Method,their operation commands and operationsettings such as timed data collection,the Excel® worksheet template, File destination or Wedge destination, andthe COM port settings. The starting celldestination for the first data receivedfrom each instrument or device if send-ing directly to Excel®, a file delimiterwhen sending directly to a File, or cursormovements if sending to the “Wedge”are also defined within the Method’sinstrument interface setup. A Method is applied to a workbook or destinationprior to collecting data.

An Instrument refers to any externaldevice other than the computer. It retrieves data and places it at a specificlocation on the worksheet, to a file orcursor location. It is assumed that youknow the theory and principles of theinstruments or devices being used andtheir resultant data. Note that the termsDevice and Instrument are used inter-changeably within the Instrument Manager (see “Configuring a NewInstrument,”Chapter 5). The DeviceLibrary, however, refers to an Sartoriusinstrument database.

Operations allow the user to interactwith the instrument or device. The operation sends a Command Stringto the instrument in order to promptthe instrument for a suitable response.A blank Command String within anoperation is typically used to receivedata without sending a prompt to theinstrument. The operation retrieves theresponse in order to organize the databefore reporting to the destinationspecified in the Method.

8

Conventions of the ManualThe following conventions are usedthroughout the manual:

§ The word “press” refers to a keyboardresponse, where a specific key or multiple keys are required to be pressed.

§ The word “type” refers to a keyboardresponse, where a name, description ordirectory is required.

§ The word “click” refers to a mouseresponse.

§ Dialog buttons are referenced in “BoldItalic” print.

§ Menu selections are referenced in bold print, with the hot key characterunderlined (Alt key + underlined letter).For example, when selecting from themenu, the manual will instruct you to “Pull down the File menu and selectOpen”. To do this you would click onthe File menu option, and then selectthe Open option from the sub-menu,which appears when you select File.

§ Proper names used in the program are denoted by a leading capital letter.For example: “Instrument Manager”and “Parser Setup”.

§ Dialog boxes are shown for your reference. The default values of the program are stated, but examples arealso included for demonstration pur-poses. Therefore the dialog boxes beingdescribed may not contain the exactsame information as the Figures.

§ Special keyboard keys such as Shift, Alt, Ctrl, ESCape, Tab, INSert, DELete,etc. will be enclosed in triangular brack-ets. For example: <INSert> <DELete><TAB> <SHIFT> <ALT> <ENTER> etc.

§ Two keys in a row without a space such as <CTRL><INSert> means pressand hold down the <CTRL> key whilepressing the <INSert> key.

§ Computer input such as file names are specified within double quotes inthe manual. Do not include the quota-tion marks when entering the input. For example, if “a:\setup” were includedin the manual to explain how to enter a file name, you would not enter thequotation marks.

9

General Procedures

The OK and Cancel ButtonsMany of the dialog boxes used in theprogram contain both an “OK” buttonand a “Cancel” button. Selecting the“OK” button will accept any input youprovided in the dialog box and thenclose the box. Selecting the “Cancel”button will also close the dialog box butinstead, ignore any input you provided.

Deletion ConfirmationMany of the setup dialog boxes used inthe program contain a “Delete” button.Selecting an item and then clicking onthe “Delete” button will cause a [Confir-mation] dialog box to appear. Click onthe “Yes” button to confirm the deletecommand or click on the “No” buttonto ignore the delete command.

On-Line HelpThe On-Line Help is a Windows® Helpfile that allows you to choose subjectsrelevant to the program available inEnglish only. When you choose Helpfrom the menu bar, the Help windowwill open on the screen. To further helpsimplify software configuration, mostsetup windows throughout the programinclude “Help” buttons that go to thespecific area of the Help file relevant tothat part of the program.

Exiting from SartoCollectTo exit SartoCollect, pull down the Filemenu and select Exit.

Changing the PreferencesIn order to change the location of theSartoCollect data directory:

1. Pull down the File menu and selectPreferences.

2. A [Preferences] dialog box will appear.3. In the Data Directory Location text

box, specify the destination of the SartoCollect data directory.

4. Click on the “OK” button to change the location of the SartoCollect datadirectory to the selected destination.

To disregard the changes, click on the“Cancel” button. Both will cause the“main screen” to return.

Last Minute ChangesFrom time to time, improvements aremade to both the software and themanual. The latest changes will beexplained in a README file that will beinstalled with the program. To view thisinformation:

1. Double-click on the “README” ques-tion-mark icon that was installed in thesame Program Group as SartoCollect.

2. The readme.hlp file will be displayed ina standard Windows®-based on-linehelp format, allowing you to jump tovarious topics.

3. To exit the README, simply pull downthe File menu and select Exit.

If such a file exists, you may review theREADME file at any time, although it isa good idea to read it before installingthe program.

10

Installation

Contents of the SartoCollect Package– One SartoCollect 1.0 Installation CD– One SartoCollect 1.0 User Manual

Hardware Requirements§ A PC with a Pentium II 300 MHz or

higher processor.

§ 256 MB of RAM for the XP operatingsystem.

§ 512 MB of RAM for the Windows Vistaoperating system.

§ Available hard-disk space, typical installation: 15 MB maximum.

§ CD-ROM drive or equivalent

§ VGA or higher resolution monitor;Super VGA recommended.

§ Microsoft® Mouse, Microsoft® IntelliMouse, or compatible pointingdevice.

§ COM1 / COM2 etc. ports to supportRS232 communications (the minimumis one available COM port).

§ Network connectivity if using TCP/IPcollectors.

Software RequirementsSartoCollect requires your computer tohave the following:

§ Windows XP® Professional SP2 or Windows Vista® Business operating systems

§ Microsoft® Excel 2000®,Excel 2003® orExcel 2007® if using the direct to Excel®interface option.

Check your disks to verify you have thecorrect versions of the operating systemand application.

Options for Configuring the Hardwareand SoftwareRS232 serial connection – communica-tion between the instrument and SartoCollect is achieved by connectingthe RS232 communications port (COMport) on your SartoCollect computerdirectly to the instruments RS232 port.

Note: It is important to have the correct RS232 serial cable required forthe instrument that is being connected.Some instruments or devices will notinterface to a computer (host) through a standard (“straight-through”) serialcable. Refer to Appendix C for moredetails on RS232 communications.

Serial to TCP/IP device server converterbox – connects to an RS232 outputwith a TCP/IP network and is able totranslate to and from specific datapackets of serial data.

Serial to Ethernet converter box – connects an RS232 instrument to a net-work and creates a virtual COM port forthe converter box on the SartoCollectcomputer. This interface works in thesame manner as the “RS232 serial con-nection” described above but is a COMport created over the network instead oflocally on the computer itself.

11

Remote RS232 TCP/IP Collector Soft-ware – with the aid of a Collector mod-ule included as part of the SartoCollectpackage, it is capable of gatheringinformation from an instrument con-nected to the serial port of a remote PC.The Remote RS232 TCP/IP Collectormodule must be installed on the PC thatthe instrument is connected to. As partof the SartoCollect Instrument Manager,an RS232-TCP/IP Collector is built in.Once activated, the collector connectsto the Remote RS232-TCP/IP Collectorsoftware, which opens the COM port.The SartoCollect Application is nowcapable of sending data to and receivingdata from the remote serial port via theTCP/IP connection.

USB Connection – Most USB interfacesrequire a software driver to work withthe hardware. If the instrument ordevice has a USB interface and comeswith a software driver that creates astandard Windows™ COM port for theconnection, SartoCollect will work withthis interface in the same manner as if it were a standard RS232 serial con-nection. In this case however, no specialcable is required.

Wireless Connection – Various hardwareoptions are available to convert aninstruments RS232 output to communi-cate with the SartoCollect computer in awireless fashion. For example, Bluetoothconverters can create a wireless cablebetween the RS232 port of the deviceand the COM port of the computer. Serial-to-Ethernet converters can beused to connect the RS232 port of thedevice to a wireless access point orwireless router.

Contact Sartorius for more details on the hardware and software configurationoptions available to meet your specificrequirements.

Installing the SartoCollect SoftwareSartoCollect comes with an automatedsetup program and can be installed in English, French, German, Spanish,Italian, Japanese or Russian Editions.The setup program must be run fromwithin, Windows XP® or Windows Vista®.

1. First have your Windows® operating sys-tem running and log on as a user withWindows® Administrator rights.

2. Insert the SartoCollect CD into the CDROM drive of your computer.

3. The install CD is configured to auto-startthe setup routine. If the setup does notbegin automatically, you can manuallystart it by double-clicking on the“setup.exe” file in the root directory ofthe CD.

4. Click on the language preferred in theSartoCollect Installation Menu.

5. The setup program will establish the location of the data directory. All Sarto-Collect configuration files will be storedhere; Methods will be located in a subdirectory below the data directory usingthe Method Description as its directoryname and workbooks will be stored inthe Method directory as a default. If you wish to change the default loca-tion for the data directory, simply enterthe appropriate information here. Thesetup program will create the necessarydirectories and copy the files over.

12

6. Double-click on the SartoCollect iconon the Windows® Desktop to start theprogram. You will see the main windowfor SartoCollect.

Installing the “Remote RS232-to-TCP/IP Service” Software

Note: this software utility does not needto be installed on the same computer asthe SartoCollect software. The RemoteRS232-TCP/IP Collector program allowsRS232 devices to be connected to acomputer COM port and converted to aTCP/IP server port that can then beconnected to a SartoCollect softwareinstallation located elsewhere on thesame network.

1. Follow the same steps 1 to 3 detailed in“Installing the Software” above on theremote computer or laptop that will beconnected with the instrument ordevice.

2. Click on the “Remote RS232-to-TCP/IPSoftwareservice” to install.

Registering the SoftwareEach new installation of the softwarerequires its own registration. You mayinstall SartoCollect from the originalmaster disks or from copies of thesemaster disks. Once installed, the pro-gram is fully functional for 30 days andwill run as a single “Trial” instrumentlicense; registration of the installationwith Sartorius AG is required for furtheruse and/or in order to increase thenumber of instrument licenses availableto this installation. The initial registra-tion must be done within 30 days ofinstalling the program.

When you first start SartoCollect youwill notice a “Register SartoCollect” message indicating that this installationis either a trial version of the product or needs to be registered.

To use the program within the first 30 days, simply click the “Cancel” but-ton and you will be taken to a fullyfunctional program.

! Important: The SartoCollect Activationkey must be entered by a user withWindows® Administrator rights. On Windows Vista®, the SartoCollectapplication must also be opened usingthe “Run as Administrator” feature ofVista® in order to run the applicationunder the Adminstrator account. To dothis, right-click on the SartoCollect iconand select “Run as administrator”.

Activation KeyContact Sartorius AG to obtain the Acti-vation Key for this installation quotingthe 12 digit “CD Key” located on the CDlabel and the 16 digit “RegistrationCode” displayed in [Register SartoCollect]dialog box which can be accessedthrough the main menu option Register | SartoCollect.

The Activation Key for your SartoCollectinstallation will be automatically e-mailed to the e-mail address enteredin this web page form.

13

Figure 1.1 Register SartoCollect window

Before registering the product, pleaseensure that the installation of this prod-uct does not exceed the current licens-ing agreement with Sartorius AG.

Should you require technical support,you will be required to provide the serialnumber. This can be retrieved from the[About] dialog box. Pull down the Helpmenu and select About and the SerialNumber of this installation will be displayed in the Title bar of the [About]window if it has been Registered.

To re-register, change the number oflicenses or convert from SartoCollectlight

to the full SartoCollect version whileusing the program, select the Registermenu option and select “SartoCollectlight”or “SartoCollect” depending on the version of the software or licenses purchased. This will also cause the [Register SartoCollect] or [Register SartoCollectlight] dialog box to appear.

14

Chapter 2Quick Start-Just the Basics

The purpose of this chapter is to intro-duce you to the SartoCollect environ-ment. This chapter will teach you the basic components of SartoCollect in order for you to begin collecting,processing and reporting data as soonas possible. Comprehensive details ofthe SartoCollect software are providedin Chapters 3, 4, 5, 6 and 7 as well asseveral Appendices for your reference.

!Before plugging an RS232 Serial cablefrom an instrument or device into thecomputer COM port, verify the cablepin-out requirements match those spec-ified in the operating manual for thatinstrument or device. Some instrumentsand devices do not support the standardpin-out configuration and using anincorrect cable could damage theinstrument or device.

You should first be familiar with yourWindows® operating system, and youshould know how to use the mouse topull down menus as well as selectoptions. More importantly, the instru-ment or device should already be connected to a COM port on the backof your computer or ethernet port withthe proper cable required for that connection, and you should be able toprovide the communication parametersspecific to each instrument or device.

If you have not yet installed SartoCol-lect onto your computer, go back to theInstallation section now and follow therequired steps. Once you have installedSartoCollect onto your computer, youare ready to start the program. Start SartoCollect from Windows® bydouble-clicking on the SartoCollecticon.

Upon entering the program you will seethe SartoCollect “main screen” that liststhe active Method list as shown in Figure 2.1.

Figure 2.1: SartoCollect main screen

15

Terminology ReviewA Method is a complete set of instruc-tions for a particular type of interfacingprocedure. It defines the instruments,the Destination file or application, the cell destination, delimiter or cursormovement when data is received, andthe COM port or TCP/IP settings. A Method applies a set of interfaces and instructions prior to collecting data.

For more advanced application auto-mations, such as creating User Promptwindows, or combining different instru-ment operations together to name justa few, SartoCollect includes a SAX Basicscript editor which can apply VBAmacros within a Method’s instrumentinterfaces and automated control overtheir operation commands.

An Instrument refers to any externaldevice other than the computer. Itretrieves data and places it at a specificlocation in the destination defined. It isassumed that you know the theory andprinciples of the laboratory instrumentsbeing used and their resultant data

Operations allow the user to interactwith the instrument. The operation sends a Command Stringto the instrument in order to promptthe instrument for a suitable response.The operation retrieves the response inorder to organize the data.

Changing Method Connections’ PortSettings The Port Setup for an Instrument/Device interface contained within exist-ing Methods can be changed throughthe “Edit | Method Connections” menuoption instead of accessing the full[Method Setup].

Click once on the Method Name thatrequires Port Setup change. Then mainmenu option “Edit | Method Connec-tions” or right-click on th mouse buttonto open the [Method Connections] dialog. Select the Instrument/Devicename from the list then “Edit” buttonto change either its Collector type or“Setup” the communication port for theCollector.

Refer to Chapter 5 for details on the“RS232 Collector”, “RS232-to-TCP Collector” or “TCP/IP Collector” Setup.

After completing the Collector Setup,click on the “OK” button in the [MethodConnections] dialog to save the changesand return to the main screen. The“Cancel” button will close the [MethodConnections] dialog without saving thechanges.

16

Quick-Start – Creating a Basic MethodThis feature is not available in SartoCollect light. Visit www.sartorius-mechatronics.com/sartocollect fordetails on the full version upgrade.

Follow these steps to create a basicinterface Method. Comprehensivedetails on setting up Methods andInstruments with screenshots of thesetup process are defined in Chapters 3through 7.

From the SartoCollect “main screen”:1. Pull down the Edit menu and select

New Method....

In the [Method Setup] Dialog2. Give the Method a unique name in the

“Method Name” field provided.

3. Select a “Wedge”, “File” or “Excel”interface type depending on where theresults need to be sent.“Wedge” will send received data toactive cursor location, “File” sends adisk file (ASCII format) on the computeror network and “Excel” creates a directinterface to Microsoft® Excel®.

4. Select “Destination” button, browse tothe File or Application to be connectedwith. Select that file or application andchoose the “Open” button. For a“Wedge” interface, enter the Applica-tion File used to open the Data Destina-tion (e.g Excel.exe) then enter the DataDestination (e.g. Workbook.xls). Note:To specify a Web address simply enterthe URL web address in the Data Desti-nation line instead of an actual file afterspecifying “IExplore.exe” as the Appli-

cation File.5. Click on the “Add” button in the

“Instruments/Devices” list box sectionto add the first instrument or deviceconnection to this Method.

On the [Connections] Dialog6. Give the instrument a name in the

“Description” field provided.

7. Using the pull-down menus, select theinstrument/device “Type” and “Name” (if your instrument or device is not con-tained within the Sartorius InstrumentLibrary, select the “Instrument Manag-er” button and refer to Chapter 5 –Configuring a New Instrument, beforeproceeding further)

8. Define the communication parametersthrough the “Port Setup” button. ForRS232 communications, select the“RS232 Collector” and then the “Setup”button if connecting to a Windows®COM port. The settings defined heremust exactly match the port settings ofthe instrument’s RS232 port which areusually defined within the instrument’soperating manual or can be displayedthrough a menu option of the instru-ment.

Selecting the “Test” button in the[RS232 Collector] dialog can test thecommunications with the instrument ordevice.

The “TCP/IP Collector” and “RS232 toTCP/IP Collector” are described in Chapter 5.

17

9. Each Operation that is loaded afterselecting the instrument “Type” and“Name” will default to an Operation Setting that uses SartoCollect’s “Asyn-chronous” processor. Refer to Chapter 3– Configure Your Own Method, Opera-tion Settings section for details onchanging this to a “Timed Collection”processor if required.

10.Once the Operation Settings aredefined, the “Results” section for eachOperation that returns data will need tobe filled out. Define either the “StartingCell”, “Delimiter” or “Cursor Movement”displayed in the “Results” section foreach Operation that has a “ResultName” that is to be reported. First selectthe Operation in the “pull-down” menuof the Operation Setup section and thendefine the “Starting Cell”, “Delimiter” or“Cursor Movement” to the right of eachnamed value down the “Result Name”column.

Excel® Interface Type

Starting Cell format for a “Result Name”example: “=B3” or “=Sheet1!B3” (with-out quotations). Will send the first valuereceived to “B3” in the Excel® sheet andthen move down the “B” column aftereach reading is received. (Note that thisinterface type makes a direct connec-tion with the Excel® COM object is notaffected by use of the keyboard ormouse during run-time data collection)

File Interface Type

Delimiter format for the “Result Name”values can be any character or combina-tion of characters. Example:“tilda+pipe+tilda” would be entered as:“~|~“ (without quotations) in theDelimiter column to the right of the“Result Name”. The Delimiter enteredwill be placed between this value andthe next value in the “Result Name” listat run-time. Use the arrows on the rightside to change the order of the datathat will be reported.

Results Setup Example:Result Name DelimiterInstrumentData ~|~[Time] ~|~StaticText

At Run-time an instrument reading of15.234 is received and will be written tothe defined “Destination” file as;

15.234~|~12:35:52~|~StaticText

Wedge Interface Type

18

Cursor Movement format for a “ResultName” are defined by writing out thedesired movement required after eachresult is reported between “<” and “>”symbols. Keystrokes may also be com-bined within the same “Cursor Move-ment” cell.

Cursor Movement keystrokes supportedby SartoCollect:

<Enter> , <Tab> , <Down> , <Up> ,<Home> , <End> , <Right> , <Left>

Result Name Cursor MovementInstrumentData <Tab>[Time] <Right>StaticText <Enter><Home>

At run-time, the instrument reading is sent to wherever the cursor is located.SartoCollect then “Tab’s to the nextfield and enters the “Time” stamp,moves right and enters the “StaticText”.SartoCollect then automatically executes an <Enter> and <Home> keystroke combination.

11. After defining the instrument Connec-tion to the Destination, select the“OK” button

On the [Method Setup] Dialog 12. To add another instrument or device

connection to this Method, select the“Add” button and repeat steps 6–11above, otherwise, select the “OK” or“Finish” button to Save and Exit fromthe Method Setup and return to theSartoCollect main screen.

On the SartoCollect Main ScreenDouble-click on the new Methodname that was just created or select itand choose the menu options “File |Open New…” to start this Method.

The Demonstration MethodsIn order to become familiar with thecollecting process, Sartorius has sup-plied a number of DemonstrationMethods that use Excel® as the desti-nation for result data.

Use the demonstration Method to helpyou become familiar with the basicSartoCollect components or modifyand incorporate directly into yourdaily operations.

19

The Method SetupThis feature is not available in Sarto-Collect light. Visit www.sartorius-mechatronics.com/sartocollect fordetails on the full version upgrade.

Modifying one of the DemonstrationMethods.

Note: All Demonstration Methods aresetup to use Microsoft® Excel® filetemplates and SartoCollect’s direct to“Excel” object interface. If Microsoft®Excel® is not available on your com-puter the demonstration Methods willneed to be modified to use a Wedge orFile interface type and the OperationResults re-defined to use a “Delimiter”if sending to a “File” or “Cursor Move-ment” if connecting via the “Wedge”interface type instead of the “StartingCell” that is defined within thedemonstration methods.

From the SartoCollect “main screen”:1. Click on a demonstration Method of

interest to select this as the one to bemodified.

2. Pull down the Edit menu and selectMethod.

3. A [Method Setup] dialog box similar tothe example in Figure 2.2 will appear.

Figure 2.2: Method Setup, Start Setup Tab.

The [Method Setup] dialog box is where the details of the collecting andautomation processes are specified. The setup process begins on the[Method Setup] dialog.

The “Wedge”, “File” or “Excel” interfacetypes for the instrument data is globalto the Method. One cannot specify a Wedge interface for one instrumentand directly to Excel® type for anotherinstrument within the same Method. If different destinations were requiredwithin the same Method, this wouldneed to be set up in the “Advanced Control” SAX Basic script editor ordefine separate Methods for the different destinations.

If you do not have Excel® installed onyour computer, select either the“Wedge” or “File” interface options anddefine a new “Destination” File or Win-dows® application for the interface.

20

The “Auto-Start” check box will auto-matically launch this Method uponopening SartoCollect. Toggle this onwith a check mark to apply the “Auto-Start” to this Method. The Excel® inter-face template or “Wedge” destinationfile or application will be automaticallyopened as well upon this Method starting.

“Advanced Control” is a SAX Basic scripteditor that allows for VBA scripts to beembedded as a program layer global tothe entire Method for full automationcontrol over the instrument interfacesand their operations. The “AdvancedControl” feature is an optional tool usedfor adding a variety of new functionsand capabilities to the core SartoCollectprogram and is detailed in Chapter 7.

The Template SetupIf using the Excel® interface option, click on the “Template Setup” button.This will automatically open Excel® andthe default template file, “MethodTem-plate.xls” set for this Method. Thedefault template of the demonstrationMethod may contain static text, formu-las, macros and graphs. Each time anew worksheet is run for a Method, the template spreadsheet will be openedto acquire any data gathered.

The Template SetupIf using the Excel® interface option, click on the “Template Setup” button.This will automatically open Excel® andthe default template file, “MethodTem-plate.xls” set for this Method. Thedefault template of the demonstrationMethod may contain static text, formu-las, macros and graphs. Each time anew worksheet is run for a Method, the

template spreadsheet will be opened toacquire any data gathered.

The Instrument SetupThe Instruments/Devices list box dis-plays the instruments that are connect-ed by the Method. The [Connections]dialog can be accessed through theInstruments/Devices list box.

1. Click on the first Description name inthe Instruments/Devices list box. Thenclick on the “Edit” or “Next” button.

2. A [Connections] dialog similar to theexample in Figure 2.3 will appear andthe settings for that instrument ordevice connection are displayed.

Figure 2.3: Connections Tab

21

The [Connections] dialog is where theCOM port or TCP/IP port and operationinformation is specified for the instru-ment interface.

If you have your instrument connected,you can adjust the “Instrument / DeviceSelection” using the pull down menu’sto match the Instrument /Device “Type”and manufacturer and model “Name” ifit is available in SartoCollect’s Instru-ment Library.

If you do not have an instrument that isavailable in the Instrument Library, pro-ceed with the demonstration Method;however, you will not be able to gatherdata. Refer to Chapter 5 for details onconfiguring a New Instrument usingSartoCollect’s Instrument Manager.

The Instrument SetupThe Instruments/Devices list box dis-plays the instruments that are connect-ed by the Method. The [Connections]dialog can be accessed through theInstruments/Devices list box.

1. Click on the first Description name inthe Instruments/Devices list box. Thenclick on the “Edit” or “Next” button.

2. A [Connections] dialog similar to theexample in Figure 2.3 will appear andthe settings for that instrument ordevice connection are displayed.

Figure 2.3: Connections Tab

The [Connections] dialog is where theCOM port or TCP/IP port and operationinformation is specified for the instru-ment interface.

If you have your instrument connected,you can adjust the “Instrument / DeviceSelection” using the pull down menu’sto match the Instrument /Device “Type”and manufacturer and model “Name” ifit is available in SartoCollect’s Instru-ment Library.

If you do not have an instrument that is available in the Instrument Library,proceed with the demonstration Method;however, you will not be able to gatherdata. Refer to Chapter 5 for details onconfiguring a New Instrument usingSartoCollect’s Instrument Manager.

22

To specify the COM Port Information of the instrument or device, click on the“Port Setup” button. A [CommunicationsSetup] dialog box similar to the exampleshown in Figure 2.4 will appear allowingyou select the RS232 Collector, TCP/IPCollector, or RS232-to-TCP/IP Collector.After selecting the appropriate Collectortype you can adjust the communicationparameters to match your instrumentsettings by clicking on the “Setup” button.

Figure 2.4: Communications Setup

RS232 SetupSimply change the parameters listed inFigure 2.5, [RS232 Collector] window, tomatch those of your instrument ordevice which can typically be found inthe operating manual or by entering thedigital menu display of the instrumentand browsing though its settings.

Figure 2.5: RS232 Collector

A filter can also be applied to incomingdata should any output from the instru-ment need to be altered. The setup isaccessed by clicking on the “Filter” tabdisplayed in the Collector Setup asshown in Figure 2.6.

Figure 2.6: RS232 Collector Filter Setup

Erroneous data output can be discardedcompletely and ignored by the softwareby using the Discard Data Containingoption. This will search the completestring of data and if the text that wasentered through the “Add…” buttonsetup is found at run-time the softwarewill delete that data string and be readyfor the next reading.

Figure 2.7: RS232 Collector: Discard Data Setup

23

“TCP/IP Collector Setup” and “RS232 toTCP/IP Collector Setup” are described inChapter 5.

The Operation SetupThe Operation section of the [Connec-tions] dialog is where the Run Timedetails of the operations are specified.Once the Instrument/Device Type andName are selected, all of the instrumentspecific settings in the Operation Setupsection of the [Connections] dialog areautomatically filled with the settingscontained in the Sartorius InstrumentLibrary.

For more information regarding the settings in the Operation Setup, see“Adjusting the Operation Checkboxes”,Chapter 3.

In the Arguments section of the Operation Setup, the Parameter Nameand Value list box are disabled. If anargument needs to be specified at runtime (inserting a value from Excel® intothe Command String before sending itto the instrument or device), here iswhere the cell location is defined. Also note, the Arguments option onlyworks with the “Excel” interface optionselected for a Method.

In the Results section of the OperationSetup the destination of the collecteddata is indicated. If the Method inter-face uses the “Excel” option, the “ViewTemplate” button will be available inorder to take note of the desired datadestinations. Select the “View Tem-plate” button to open the template filethen close the file. This will cause the [Connections] dialog to return.

Beside the predefined Result Name is the Starting Cell list box is where arelative or absolute cell is referenced. If you decide to use a relative cell refer-ence (e.g. =B3), SartoCollect automati-cally addresses the information in acolumnar fashion, automatically addingdata down the column specified startingat the row specified. When collectingdata, SartoCollect identifies the nextempty cell in the Starting Cell columnand inputs the data accordingly. Sarto-Collect can also send collected data todifferent worksheets by specifying theStarting Cell to be equal to the “sheetname”!“cell value” (e.g. =Sheet1!B3) orabsolute cell locations using the dollarsign “$” symbol between the Columnaddress and Row address (example“=B$3”).

To add a Date or Time or Counterstamp to the values received simplyenter the name of stamp required insquare brackets in the first empty row inthe Result Name column and set theStarting Cell for each.

Example: In row 2 enter under theResult Name: [Time] and Starting Cell:=D3.The date macro is: [Date], the countermacro is: [Counter], Time with millisec-onds is [Time.ms], and milliseconds is[Milliseconds].

If the “Wedge” or “File” interfaceoptions were selected, the OperationResults section displays either “CursorMovement” or “Delimiter” for therespective interface types. Supported“Cursor Movement” keystroke formatsand File types are further defined inChapter 3.

24

Figure 2.8: Connections Tabdialog

To specify automatic retrieval of read-ings based on a timed interval, selectthe Operation in the pull-down menuthat contains the Command String forretrieving the instrument data. Next,select the checkbox to the left side ofthe “Settings” button directly below theOperation selected in the Operationpull-down menu to toggle it on andclick on the “Settings” button to displaythe [Operation Settings] dialog box asshown in Figure 2.9.

Figure 2.9: Operation Settings

Select the “Timed Collection” in theProcessor pull-down menu then click onthe “Setup” button to set the desiredtime interval. See Figure 2.10.

Figure 2.10: Continuous Reading Setup

25

Figure 2.11: Finish Setup Tab

26

Note that in some demonstration Meth-ods, the same physical instrument isdefined within the Method multipletimes. This can be used in cases whereone set of readings needs to be sent toone column and another set of readingssent to a different column. Also, takenote that the “Start on Method Open”setting is unchecked. This settingdescribes the state of the communica-tion port when the Method is opened.Since two instruments cannot occupy

the same COM port at the same time,one of the ports must be opened manu-ally after closing the other when it isrequired.

Click on the “OK” button to exit the[Connections] setup and return to the[Method Setup] dialog shown in Figure 2.11. Click on the “OK” button to Save andexit the Method Setup.

Running a Method

Opening a New WorkbookIn order to run a new workbook for thedemonstration Method:

1. Click on the demonstration Methodfrom the SartoCollect “main screen” toselect this as the Method to open.

2. Pull down the File menu and selectOpen New.

Or, Double-click on the Method Namein the main window Method List.

This will automatically open Excel®default template file and attach the SartoCollect floating toolbar objectdirectly the Excel® template (See Figure 2.12).

If the Method was altered to send to the “Wedge”, starting the Method willautomatically open the Wedge Destina-tion file or application that was definedwithin the Method Setup and the float-ing toolbar will appear over the Sarto-Collect main screen. The File interfacedestination is not opened but a view ofthe data being reported to the Destina-tion File can be seen through theinstruments Monitor window.

Figure 2.12: Multiple Instrument DemoWorksheet Template prior to collecting data

Sending CommandsOnce the demonstration Method’sworkbook is opened and the instrumentis turned on, you can begin to collectdata. Predefined operations determinedfrom the Operation Setup are located asa sub menu in the toolbar. This toolbarfloats above the workbook, and theInstrument Description is used as thetoolbar button name (See Figure 2.13).By clicking on the arrow above theInstrument Description, you can selectthe Start operation to open the commu-nication port if this did not auto-startwith the “Start on Method Open”instrument/device setting. Now that thecommunication port is opened, you canclick on the tool button to view a list of the active operation commands avail-able. Click on the operation associatedwith collecting data to start this opera-tion. Viewing the Operation List again,the operation that was selected shouldnow appear with a “Stop” to the left ofthe operation name indicating that thisoperation is running. Selecting thisagain will stop the operation.

Most instrument or device operations in the Sartorius Instrument Library con-tain the necessary Command String toretrieve data from that instrument ordevice. Any Instrument Library Opera-tion named “Unidirectional” does notcontain a Command String and isintended to listen to the COM port forany incoming data if it is being “Print-ed” or “Sent” from the instrument ordevice to the computer by some othermeans such as selecting a Print or Sendkey on the instrument itself or using afoot-pedal to send the data.

27

Figure 2.13: SartoCollect’s Excel® Workbook toolbar

Place Data“Place Data” is a toolbar feature avail-able to the “Excel” interface option ofthe Method. Instrument data can besent to any Row within in the Excel®workbook by using the Place Data fea-ture but data will continue to be placedin the same Column address defined forthat Operations Starting Cell. With PlaceData turned ON and clicking on a newCell in a different Row, the next readingreceived by SartoCollect will be sent tothat new Row location.

The Place Data feature can be startedfrom the workbook toolbar by clickingon the green triangle. See Figure 2.14.

Figure 2.14: Place Data is OFF

When Place Data is active a red circlewill be displayed. Clicking on the redcircle will “stop” the Place Data featureand readings will again be entereddown the column in sequential order.

Note: Place Data can remain turned ON;but, if any Cell in the Workbook isselected and a reading from the instru-ment is sent, the software will send theresult to that new Row location.

Closing the MethodOnce the collecting session is complete;

1. Click on the instrument tool bar button.

2. Then click on the Close operation to turn off the interface with the instru-ment and automatically close the communication port.

3. Save the Excel® workbook, File or Appli-cation using its standard save optionsavailable.

4. Exit Excel®, the Destination File orApplication as usual.

This will cause the SartoCollect “mainscreen” to return.

For more information regarding any of these topics, see “Configuring yourown Method”, Chapter 3 and “Running a Method”, Chapter 4 as a reference.

28

Chapter 3Configure Your Own Method

If you have not yet installed SartoCollectonto your computer, go back to theInstallation section now and follow therequired steps. Once you have installedSartoCollect onto your computer, youare ready to start the program.

Start SartoCollect from Windows® bydouble-clicking on the SartoCollect icon.

Upon entering the program you will seethe main SartoCollect screen, shown inFigure 3.1.

Figure 3.1: SartoCollect “main screen”

A Method is a complete set of instruc-tions for a particular type of test, analysis procedure or interfacing routine.In order to configure a Method, youmust define the instruments, the Desti-nation and either a Starting Cell destina-tion, Delimiter or Cursor Movement forthe collected data of each Operation thatreceives results. The Method also definesthe COM port or TCP/IP settings for eachinstrument and each connection mustexactly match those of your instrumentor device settings.

Defining the PreferencesThis feature is not available in SartoCol-lect light. Visit www.sartorius-mechatronics.com/sartocollect fordetails on the full version upgrade.

The active data directory for SartoCol-lect’s list of Methods can be modifiedafter installation by selecting the menuoption “File | Preferences”. To changethe directory, select the browse button“…” to the right of “Data directory loca-tion” and select a new folder path in the“Browse for folder” dialog. Selecting“OK” will set this folder as the newlocation for storing the Methods.

Show text on toolbar buttons – Willshow the text associated with the mainscreen toolbar button when checked.

Open minimized – Will automaticallyminimize the SartoCollect main screenwhen toggled on with a checkmark.

Minimize to tray – Will minimize theSartoCollect main screen to the taskbartray icons when toggled on with acheckmark.

29

Copy MethodThis feature is not available in SartoCol-lect light.

1. From the SartoCollect main screen,select the Method to copy.

2. Pull down the Edit menu and selectCopy Method to open the Copy Methodwindow.

3. Enter the new “Method Name”.4. Click “OK”.

Defining a New Method This feature is not available in SartoCol-lect light.

1. From the SartoCollect “main screen”,pull down the Edit menu and selectNew Method.

2. A [Method Setup] dialog window similarto the example shown in Figure 3.2 willappear.

Figure 3.2: Method Setup

When creating a Method, you mustcomplete the [Method Setup] dialogwindow.

Specifying a Method NameType in the Method Name of the newMethod in the field provided. The nameof the Method must be unique so thatyou will be able to consistently identifyeach Method when using SartoCollect.

The “Auto-Start Method” option willautomatically launch this Method uponopening the SartoCollect software. Clickon the checkbox to the left “Auto-StartMethod” to activate this feature.

The “Minimize toolbar to tray” optionwill allow CollectSartoCollect’s “Wedge”or “File” toolbar to be minimized toWindows® taskbar tray icons. If anyInstrument in the Method has an Oper-ation set to “Autostart”, the toolbar willautomatically minimize to the taskbartray when that Method is launched.

Specifying the Interface TypeThe type of interface dictates how SartoCollect will add instrument data to a defined Destination. Only one typemay be chosen per Method Setup. The type of interface to choose dependson where the collected data needs to besent to. For example, the “Excel” optionwould be the best one for connectingan instrument directly to Excel®. The “File” option would be best for connecting an instrument to a file onthe computer or local area network suchas a text file or .csv file. The “Wedge”option can be used for transferring data to the cursor location in any openwindow such as an Internet Explorer®Web Client application or a databaseapplication’s entry form.

30

“Wedge”: Check to send instrument dataautomatically to the cursor location inany open Windows® application by emu-lating the keyboard.

“File”: Check to send instrument datadirectly to a disk file located anywhereon the computer or network.

“Excel”: Check to send instrument datadirectly to Excel® without requiring theuse of the keyboard wedge.

Only the Excel® Destination will allow a user to define a Default Sheet name oraccess the “Template Setup.

Defining an Excel® DestinationThe Excel® interface type creates a directconnection between the instruments andthe Excel® workbook without using thecursor. This allows users to continueworking with the keyboard and mouse inother applications without interferingwith the incoming instrument data. Thisinterface type also allows SartoCollect toconnect and control multiple instru-ments and operations at the same time.

With the “Excel” option checked, select the “Template Setup” button. If no Excel® file was defined as the Des-tination, selecting the “Template Setup”button will automatically open a blankExcel® workbook. You can add statictext, formulas and Macros to the Excel®workbook. Saving the changes in Excel®before closing will apply this as theMethod’s new Excel® Template. Eachtime a new worksheet is run for theMethod, the original template spread-sheet will be opened to acquire any datagathered.

In order not to destroy the templatespreadsheet when saving a new workbook,use the Save As command. The work-book name and location is up to you.

Applying an Outside Excel® (.xls) work-book as the Method Template.In order to apply a previously configuredExcel® workbook as the default templatein a Method:

1. Click on the “Destination” button. 2. The cursor will be flashing in the File

Name text box. Type in the name of thepreviously configured workbook orbrowse the file system to locate the file.(See Figure 3.3) Click on the configuredworkbook.

3. To automatically copy the selected tem-plate, click on the “Open” button. Clickon the “Cancel” button to close the dia-log box without copying the template.

The copied template will be renamed“MethodTemplate.xls” and placed in thatMethod’s directory as the default tem-plate.

Figure 3.3: Locate the template

31

Selecting a Sheet DestinationIf the “Excel” interface type is selected,click on the Default Sheet text box. Inorder to specify the sheet destinationfor the collected data, type in the sheetname. If the Default Sheet name is leftblank, note that the currently selectedworksheet in the template will act as thedestination worksheet for all collecteddata unless the Operations “ResultName” Starting Cell is directed to differ-ent sheets in the workbook.

Select “Open” when finished.

File types supported: Any file formatthat supports ASCII text data such as aNotepad *.txt or *.csv file.

Defining a File DestinationThe “File” interface will connect theinstrument data and any other userdefined data to the file selected as thedestination.

With the “File” option checked, click on the “Destination” button to open theFile Destination dialog box. Create aNew File or browse to a folder locationselect an existing file to append theinstrument data to. New Files can typi-cally be added to a folder location bybrowsing to that location, right clickingin the dialog box list window andselecting “New | Text Document”.

Defining a Wedge DestinationWith the “Wedge” option checked, clickon the “Destination” button to open the[Wedge Destination] dialog as shown inFigure 3.4.

Figure 3.4: Wedge Destination dialog

In the “Application File” text box, type in the location and name of Windows®application executable or select the “…”browse button to open the [ApplicationFile] dialog and search for the executable(.EXE) file. Select the executable filerequired for the destination data fileand then click on the “Open” button toreturn this file name and location to the [Wedge Destination] window. Select the “Cancel” button in [Applica-tion File] dialog to close without apply-ing a selection. This will return you tothe [Wedge Destination] dialog.

Next, define the “Data Destination” if necessary, to be opened when thisMethod is run. This must be a file typethat is typically opened by the definedApplication file. For example, the Appli-cation file “WinWord.exe” typicallyopens a Data File like “MSWord.doc”.

32

In the “Data Destination” text box, typein the location and name of File or selectthe “…” browse button to open the [DataDestination] dialog and search for thefile. Select the file required for the desti-nation data file and then click on the“Open” button to return this file nameand location to the [Wedge Destination]window. Select the “Cancel” button in[Data Destination] dialog to close with-out applying a selection. This will returnyou to the [Wedge Destination] dialog.

Leaving the “Data Destination” text boxblank, SartoCollect will launch the .EXEas a new file.

Entering only a Windows Caption or partial Windows Capation (typically theWindow title bar name) in the Data Destination text box will send data tothat specific Window.

Leaving both undefined, SartoCollectwill send the data to whichever Windowhas control of the active cursor locationat run-time.

Connecting to Internet ExplorerFrom the [Wedge Destination] dialogbox enter or browse to the InternetExplorer

®application file. This is

typically found in the root directory:\Program Files\Internet Explorer\IEX-PLORE.EXE

Next, in the “Data Destination” section,enter the complete web site URL addressto use in the Address line of InternetExplorer

®. Do not use the Browse “…”

button unless you want to connect to anoff-line page that was saved previouslyto a file.

The format for the URL address in the“Data Destination” section must include“http://” preceding the site address. For example, http://www.Sartorius.com/SartoCollectcol.htm, would be the correct “Data Destination” format.

Advanced ControlThe “Advanced Control” option allowsVBA macro scripts written in the SAXBasic language to be incorporated aslayer within a Method enabling Sarto-Collect to add virtually any function,feature or procedure that is not inherentto the program. This option is intendedfor users that have some VB or VBAprogramming knowledge.

A script, if necessary or desired forenhanced automation, should be creat-ed after the basic settings of theMethod are completed. For example,create and save the Method with theinstrument interfaces and operation set-tings needed first. The Method can bemodified at any time to add additionalfunctionality through the “AdvancedControl” option and depending on whatfunctions or parameters are being calledby the script at run-time, their namesand settings would need to be known inorder to create the script.

33

Select the check-box to the left of the“Advanced Control” button to activatethis feature. Clicking on the “AdvancedControl” button will open the[Advanced Control Setup] dialog box asshown in Figure 3.5. Enter a name forthe script then select the “Edit Script”button to open the SAX Basic Editor tocreate or modify an existing script. Savethe script using the “Save” options inthe SAX Basic Editor. Closing SAX Basicwill return you to the [Advanced Con-trol Setup] dialog. To debug the scriptduring a run-time scenario, place break-points within the code then a check-mark beside the “Allow run-timedebugging” option to toggle this on.

Figure 3.5: Advanced Control Setup

Click on the “OK” button to apply thechanges.

Contact Sartorius SartoCollect supportdepartment for details on our Profes-sional services available to write customapplication scripts if help is required.

SartoCollect’s SAX Basic Editor isdetailed in Chapter 7 and the SAX BasicEditor Help options.

Setting Up an InstrumentThis feature is not available in SartoCol-lect light.

1. Click on the “Add” button from the[Method Setup] dialog.

2. A [Connections] dialog similar to theexample in Figure 3.6 will appear.

Figure 3.6: Connections Tab

When adding an instrument to aMethod, you must complete the [Con-nections] dialog tab.

Specifying an Instrument DescriptionA cursor will be flashing in the Descrip-tion text box. Type in a description ofthe instrument to be added. Thedescription of the instrument must beunique so that you will be able to con-sistently identify the instrument whenusing SartoCollect. The Descriptionname entered here will be displayed as a button on the SartoCollect floatingcontrol toolbar at run-time.

34

Selecting an Instrument Type andNameBy clicking on the arrow to the right of the Type and Name text box you canview a list of instrument types andnames that are available in the SartoriusInstrument Library. Select an instrument“Type” by clicking on an item from thelist. The instrument “Type” is requiredin order to retrieve a list of correspon-ding instrument “Name’s.” Then selectan item from the “Name” list.

Once the instrument type and name are selected, many of the instrumentspecific settings in the Operation Setupsection of the [Connections] dialog areautomatically assigned.

Defining the Instrument Number FormatThe Instrument may output a numberformat different from the Windows®Regional Settings Number Format. In the Number Format drop-list, selectthe example format that matches theformat output by this instrument. The “Ignore Spaces” setting is typicallyused to handle numerical outputs frominstruments where the minus sign isseparated from the number by spacecharacters. Selecting “Yes” in the“Ignore Spaces” drop-list allows anOperation’s Numbers Parser to properlyparse (extract) the negative number.

Specifying the COM Port InformationClick on the “Port Setup” button. A[Communications Setup] dialog boxsimilar to the example shown in Figure3.7 will appear. To establish communi-cation to the RS232 port, the correctCOM port information must be entered.The COM port information for instru-ments included in the original databaseare already set to the default valuessuggested by the manufacturer. However, any changes to the COM portsettings can be made here.

Figure 3.7: Communications Setup

Note that by clicking on the arrow tothe right of each text box, you can see a list of available collectors from whichyou can make your selection.

RS232 CollectorThe RS232 Collector is intended fordirect RS232 serial communications orwith external devices that create stan-dard Windows® COM ports such asUSB-to-Serial converters or some Serial-to-Ethernet adapters that create virtualCOM ports.

RS485 or RS422 device outputs must beconverted to RS232 pin configurationto be connected through the RS232Collector.

35

With the RS232 Collector selected in the [Communications Setup] dialog boxselect the “Setup” button to right ofthis to edit the RS232 settings shown in Figure 3.8.

Figure 3.8: RS232 Collector

Port Select or type in the COMport number on the com-puter that is connected toyour instrument.

Baud Rate Select the Baud Rate or Bits per second (BPS) thatcorresponds to the datatransmission speed of yourinstrument or device.

Data Bits Indicate how many bits of data are in a data unitfor communication (wordlength) purposes.

Stop Bits Indicate how many stopbits are added to the dataunit.

Parity Indicate what parity bitshould be added to yourdata for successful commu-nication.

Buffer size Specifies the maximumallowable data packet sizethat can be processed.

To save the changes to the [RS232 Collector] dialog box, click on the “OK”button and “OK” in the [Collector Selection] dialog box. To disregard thechanges, click on the “Cancel” button.Both will cause the [Connections] dialog(see Figure 3.6) to return.

Flow Contol - Some Instruments require Flow Control. If this is requiredfor the instrument select either RTS/CTSor XON/XOFF to match the instrumentinterface requirements. RTS/CTS issometimes referred to as “Hardware”control, XON/XOFF as “Software” control.

Time Out (ms) – the program will collect data until an interval of timeoccurs when no more data is received.This time interval is known as the “Timeout”. After the Time out occurs, the program will parse the data. The appli-cation then prepares for the next segment of data.

A Time out that is too short will resultin data being chopped up into smallsegments. A Time out that is too largewill result in long delays betweenreceiving the data and seeing the dataat the specified destination. An overlylarge Time out can also result in missing data.

36

The default Time out value of 250 milli-seconds will work for most data collec-tion. Leave this default setting unlessyou are certain that your instrument’stiming will require a different value. The field is editable to be set to anyvalue, but is pre-populated with a list of values.

NULL Processing – this parameter determines how null characters {0} inthe instrument data should be handled.Selecting “None” will leave the null character as is, “Strip” will remove anynull characters from the data, and“Replace” [space] will change all nullcharacters to spaces {32}.

If “None” is selected for the NULL processing parameter, then the NULLcharacter and anything received afterthe NULL, is not received by the Instru-ment Manager. For example, if “None” is selected, and the command “A {0} B”is sent to the Instrument Manager, then the Instrument Manager receivesonly “A”. You would select “None” ifthe instrument is communicating via abinary protocol.

Character delay – this parameter estab-lishes the time delay in millisecondsbetween individual characters in thecommand string being sent to theinstrument. It is used to slow down thetransmission rate of characters to theinstrument in the event that an instru-ment cannot sustain the current transmission rate.

Command delay – this parameter establishes the time delay in millisec-onds between commands being sent tothe instrument. It is used to slow downthe transmission rate of commands tothe instrument in the event that aninstrument cannot sustain the currenttransmission rate.

For example, if a macro contains severalcommands in a row, a delay can beincorporated between each commandthat is sent.

Transaction LoggingTransaction Logging is used in trou-bleshooting or logging the interfacetransactions. If you require a copy ofthe communications messages beingsent between SartoCollect and theRS232 port, activate this option. Thefile name to which the communicationmessages are to be sent and saved canbe specified.

The log file will record all communica-tions. Along with the date and time, the log file will indicate whether thedata was sent to the instrument with an “S” designation or received from theinstrument with an “R” designation.

Testing the CommunicationsSelecting the “Test” button on theRS232 Collector Setup window willopen the Communications Test windowsimilar to the example shown in Figure 3.9.

37

Figure 3.9: Communications Test

String to transmitThis is the command string that will betransmitted to the external RS232device upon selecting the “Transmit”button.

New strings can be entered here or apreviously defined string can be selectedvia the drop down list.Non-printable characters such as a carriage return should be entered asASCII numbers enclosed in { } brackets.A listing of ASCII numbers is included inAppendix A.

The Transmit string allows for the inclusion of comments provided it follows a set of double forward slashes.For example, you could establish a com-mand for a balance with the followingstring:

S{13}{10}//Get WeightThis would result in an upper case “S”followed by a carriage return {13} andline feed {10} to be transmitted to theexternal RS232 device. Any text includ-ing and following the double forwardslashes would be treated part of thecomment and would not be transmittedto the instrument.

Selecting the “Transmit” button will ini-tiate the following sequence of events:

1. Any comments will be stripped from thestring

2. The string will be transmitted to anexternal RS232 device using the config-uration defined via the RS232 CollectorSetup window.

3. Any incoming communications will bereceived and displayed in the transac-tion log.

Data sent to and received in the Transaction Log appears similar to thefollowing example:

[S 2006/09/23 13:56:50.604]S{13}{10}[R 2006/09/23 13:56:50.879] 19.95g{32}{13}

The header information is containedwithin the square brackets. This infor-mation includes:

S or R – an “S” represents the data sentfrom the Instrument Manager, a “R”represents the data received from theinstrument. Date of the data transaction – the dateis always displayed as yyyy/mm/dd.Time of the data transaction – the timeis always displayed as hh:mm:ss:msec.

38

Following the information in squarebrackets is the actual data that waseither sent or received.

Selecting the “Clear” button will removethe contents of the Transaction Log dis-play.

ProtocolSome instruments require a communi-cations protocol in order to communi-cate. The SartoCollect software current-ly supports the ASTM 1381 and Modbuscommunication protocols. This shouldbe selected only if required by theinstrument or device connection

Instruments connected using the Mod-bus protocol have their Slave Addressesset in an Operation’s Command line. SeeChapter 5, Operation Setup for addi-tional details.

The Split Protocol is a special pre-processor designed to handle largermulti-sample, multi-line data files output by some instruments such as a stored log file. The “Split Protocol” can split the “Header”, “Data Block” and“Footer” of an incoming data file intosmaller more easily managed pieces andSartoCollect will process each split datafile as an individual data string, loopingthrough each one with “Timed Collec-tion” setup for the operation until finished. This “Split Protocol” enablesSartoCollect users to handle more com-plex data with a very simple data Parseras each split file will be parsed in thesame manner. If there is no “Header” or“Footer” to split, the “Number of Lines”should be left as “0” as shown in Figure 3.10. “Header” and “Footer” datais added to each split file.

Figure 3.10: Split Protocol Setup

Data FilterA filter can also be applied to incomingdata should any output from the instru-ment need to be altered before it passesthrough an Operation parser. The setupis accessed by clicking on the [FilterSetup] tab displayed in the RS232 Collector as shown in Figure 3.11.Select the “Activate Character Filter”check box to toggle it on. Type thereceived characters that require chang-ing in the “From” column and newcharacters (if any) into in the “To” col-umn.

For example, the Filter can be used to convert a “G” received from a bal-ance or scale to “grams” before report-ing this value.

39

Figure 3.11: RS232 Collector Filter Setup

Discard DataErroneous or unwanted data output byan instrument can be discarded com-pletely and ignored by the software byusing the Discard Data Containingoption. To enter a text character orstring click on the [Discard Data Setup]tab in the [RS232 Collector] dialog box,select the check box to the left of “dis-card data containing” to toggle this on.Next, select the “Add...” button andenter the text to search for in the out-put of the instrument that should bediscarded if received.

Figure 3.12:

RS232 Collector: Discard Data Setup

The “TCP/IP Collector” and “RS232 toTCP/IP Collector” are described in Chapter 5.

Once finished select “OK” to save thechanges in the [RS232 Collector] dialog.Select “OK” again to return to the [Connections] dialog tab.

Opening the COM PortIn order to automatically open the COMport upon starting the workbook, clickthe check box beside “Start on MethodOpen” to toggle it on. An indicator willmark the square when it has beenselected. The default value for “Start onMethod Open” is checked.

If this check box is left empty, you willhave to manually open the communica-tion port prior to collecting data.Selecting the “Start” command in thetoolbar menu at run-time will open thecommunication port. See “SendingCommands”, Chapter 4.

Adjusting Operation CheckboxesIn the Operation Setup section of the[Connections] dialog, click on the arrowto the right of the Operation text box tosee a list of operations defined withinthe selected instruments setup. Then click on the operation you wish to adjust.

40

In order to assign the operation in the Operation text box to the toolbar in the workbook, click the check boxbeside “Assign to Menu” to toggle it on.An indicator will mark the square whenit has been selected. The default valuefor the “Assign to Menu” setting ischecked. To remove an Operation fromthe run-time list of available operations,simply uncheck the “Assign to Menu”setting.

If the Operation is “Unidirectional”(without a Command String) or theOperation should not be sent on a con-tinual timed basis the “Settings” for thisoperation do not need to be configured.The default value for “Settings” isunchecked and set to the “Asynchro-nous” processor whether this is checkedor not.

In order for the operation in the Operation text box to be continuouslyrepeated once activated, click the checkbox to the left of “Settings” to toggle it on and click on “Settings” button. This will open the [Operation Settings]dialog box as shown in Figure 3.13.

Figure 3.13: Operation Settings dialog

Timed Interval Data CollectionTo set a specific time interval to retrieve readings automatically selectthe “Timed Collection” option from thepull-down menu in the [Operation Settings] dialog windows “Processor”section. Click on the “Setup” button toopen the [Continuous Reading Setup]dialog shown in Figure 3.14, and set thedesired time interval in Seconds, Min-utes, Hours, or Days. You can also spec-ify the exact “Number of Readings” toacquire once the Operation has beenstarted. Leave this set at zero “0” ifthere is no specific number of readingsand data collection is to continue onuntil manually stopped through the SartoCollect toolbar. Once complete, select the “OK” buttonto save the settings and return to the[Operation Settings] dialog box or “Cancel” to return without saving thechanges. Select “OK” in the [OperationSettings] dialog box to apply the set-tings to the “Operation” or “Cancel” to return to the [Connections] dialogwithout saving the changes.

Figure 3.14: Continuous Reading Setup

41

In order to execute the operation in theOperation text box immediately uponstarting the “Method”, click the checkbox to the left of the “Autostart” totoggle it on. Note that only one opera-tion from the list of operations can beselected to Autostart. The default valuefor the “Autostart” setting is unchecked.

Operation HotkeyKeyboard keys can be assigned to execute an Instrument’s Operations. At run-time, selecting this keyboard keywill trigger the Operation command. To define a “Hotkey”, first select theOperation name in the “Operation” pull-down menu of the “Connections”dialog , then select the keyboard key inthe “Hotkey” pull-down menu. Onlyone Operation can be assigned to a spe-cific Hotkey for the same Instrument.Other Instruments within the sameMethod or different Methods can utilizethe same Hotkey in order to executemultiple Operations simultaneously.

Reporting Result DataThe [Connections] dialog is not yetcomplete; you must indicate the start-ing cell destination of the collecteddata, a delimiter to place between collected data or cursor movement toexecute after each collected data valuereceived.

“Excel” interface type was selected forthe Method:In order to remind yourself of the work-book setup, click on the “View Tem-plate” button; take note of the desireddata destination cells. Then close theworkbook in the same manner as youwould an Excel® spreadsheet. This willcause the [Connections] dialog box toreturn.

1. Beside the predefined Result Name,click on the Starting Cell list box.

2. Type in the cell reference and sheetnumber.

The relative cell reference must startwith an equal sign. For example, if youwant to reference cell A3 and sheet 2,you would type into the Starting Celllist box “=Sheet 2!A3”.

Data will be retrieved to this specificsheet regardless of the sheet currentlyselected in the Method Setup or work-book. If the sheet number is not speci-fied, the sheet selected in the MethodSetup is the default value.

The cell references can be in a relativeor absolute form. If you decide to use a relative cell reference, SartoCollectautomatically addresses the informationin a columnar fashion. SartoCollectidentifies the next empty cell in theStarting Cell column and inputs thedata accordingly. The absolute form ofa cell reference uses a dollar sign “$”symbol between the Cell’s columnaddress and row address.

42

Results Setup Example:Result Name Starting CellInstrumentData = B4[Time] = C4[Counter] = A4[Date] = G$7

At run-time, the first “InstrumentData”value received by this Operation, parsedfrom the instrument output, will beadded to “B4” if this Cell does notalready contain data and add the [Time]stamp to “C4”, [Counter] stamp to “A4” and [Date] stamp to G7. The next“InstrumentData” value will be sent tothe next empty cell down the “B” column, [Time] and [Counter] stampsare added to that same row that the“InstrumentData” was sent to but stay in columns “C” and “A” respectively. The [Date] stamp is only ever sent to“G7” as this was defined as an absolutecell address.

File Interface type was selected for the Method:Beside the predefined Result Name,click on the “Delimiter” list box.Type in any character or combination ofcharacters, printable or non-printable,to use as the delimiter to place betweenits “Result Name” value and the next“Result Name” value displayed downthis column. Repeat this process untileach “Result Name” value down the col-umn has the required delimiter.

Delimiter format for the “Result Name”values can be any character or combina-tion of characters. Example:“tilda+pipe+tilda” would be entered as:“~|~“ (without quotations) in theDelimiter column to the right of the“Result Name”. The Delimiter enteredwill be placed between this value andthe next in the value in the “ResultName” list at run-time. Use the arrowson the left side to change the order ofthe data that will be reported.

Results Setup Example:Result Name DelimiterInstrumentData ~|~[Time] ~ & ~AnyStaticText

At run-time an instrument reading of15.234 is received and will be written tothe defined “Destination” file on thesame line as:

15.234~|~12:35:52~ & ~AnyStaticText

SartoCollect will automatically add acarriage return {13} and line feed {10}to end of the line when finished report-ing all the “Result Name” values to theDestination File.

Wedge Interface type was selected forthe Method:

1. Beside the predefined Result Name,click on the “Cursor Movement” listbox.

2. Type in the keystroke or combinationkeystrokes to execute after each ResultName is reported.

43

Cursor Movement format for a “ResultName” is defined by writing out thedesired movement required after eachresult is reported between “<” and “>”symbols. Keystrokes may also be com-bined within the same “Cursor Move-ment” cell with each keystroke con-tained within its own set of “<” and “>”symbols.

Use the arrows on the left side tochange the order of the data that willbe reported.

Cursor Movement keystrokes supportedby SartoCollect:<Enter> , <Tab> , <Down> , <Up> ,<Home> , <End> , <Right> , <Left>

At run-time, the first “Result Name”value is sent to whereverthe cursor is located in a defined Desti-nation. SartoCollect then executes that“Result Name’s “Cursor Movement” andrepeats this process for subsequent rowsin the Operations “Result Setup” sectionuntil finished. The entire process isrepeated for each data packet that isreceived by this Operation.

Results Setup Example:Result Name Cursor MovementInstrumentData <Tab>[Time] <Right>AnyStaticText <Enter><Home>

In this example, After reporting the“InstrumentData”, SartoCollect then“Tab’s the cursor to the next field andenters the “Time” stamp, moves rightand enters the “AnyStaticText”. Sarto-Collect then automatically executes an<Enter> and <Home> keystroke combi-nation and is ready to start the nextsequence of reporting as soon as data isreceived from the instrument.

The keystrokes to enter within the setupafter each “Result Name” value dependson how a regular keyboard and cursorbehaves in the Destination ApplicationFile or Windows™ form. For example, theRight arrow key on the keyboard maynot move the cursor from one positionto another in the defined Destinationbut the Tab key on the keyboard does.

Adding Time, Date or Counter MacrosIn addition to the existing ResultNames, you have the option of adding a Date, Time and/or Counter macro toadd a date, time or counter stamp toeach reading.

1. Click on an empty Result Name cell. 2. Type in the title “Date” or “Time” or

“Counter” or “Time.ms” or “Millisecond”enclosed in square [ ] brackets. E.g.[Date] or [Time] or [Counter] or[Time.ms] or [Millisecond]

3. In the same way you entered the Start-ing Cell, Delimiter or Cursor Movementabove, define the cell location, delimiter(if any) or cursor movement for thisMacro data.

44

Saving the Instrument SetupWhen you have completed the [Connec-tions] dialog, click on the “OK” button to save the new set-tings. This will return you to the[Method Setup] dialog to appear asshown in Figure 3.15. The instrumentshould now appear in theInstruments/Devices list box.

Testing the Instrument SetupIn order to test the Instrument Setup in a trial workbook, click on the “TestMethod” button in the [Method Setup]dialog. The test shall reflect the definedinterface type, defined Destination, and the immediate Instrument Setup.You may activate the instrument menuitems, and if the instrument is turnedon, have the data transferred to theDestination. In order to return to the[Method Setup] dialog, exit Excel® orselect the “Close” button on the float-ing toolbar if using the “Wedge” or“File” interface types.

Saving the Method SetupOnce the [Method Setup] dialog box is complete, click on the “OK” button tosave the new Method. This will causethe SartoCollect “main screen” toreturn. The Method should now appearin the list of current Method Descrip-tions.

Figure 3.15: Method Setup

Post to SartoriusIf you have created a new InstrumentSetup for an instrument or device inter-face that was not contained in the Sartorius Instrument Library and wouldlike to make this available to other Collect users around the World, selectthe “Post to Sartorius” button on the[Method Setup] dialog to display the[Post to Sartorius] dialog as shown inFigure 3.16.

45

Results Setup: Result Name Delimiter Starting Cell Cursor Movement

InstrumentData , = B4 <Right>[Time] , = C4 <Right>[Date] , = G$2 <Right>[Counter] , = A4 <Enter><Home>

Figure 3.16: Post to Sartorius dialog

Your newly created instrument can besent to Sartorius by selecting either the“Send via Internet” button, “Send viaOutlook” button or “Create InstrumentFile” on your computer to send by someother means.

The “Send via Internet” will attempt topost an exported version of the instru-ment setup to a Sartorius FTP site,however, this connection may beblocked by your network security set-tings. If so, please try the “Send via Outlook”or “Create Instrument File” options.

At this point you are ready to begin col-lecting data. For instructions on how torun a worksheet, go to “Running aMethod”, Chapter 4.

Exporting a MethodThis feature is not available in SartoCollect light.

As an alternative to creating your ownMethod, you are able to import orexport the settings for an existingMethod.

In order to export a Method, from theSartoCollect “main screen”:

1. Click once on the Method from the list of current Method Descriptions displayed which will cause it to becomehighlighted.

2. Pull down the Tools menu and selectExport Method.

3. An [Export Method] dialog box similarto the example shown in Figure 3.17will appear.

Figure 3.17: Export Method

46

Importing/Exporting

4. In the Export File Name text box, specify the destination of the exportedMethod or click on the browse “…” button shown here in the margin. Thisallows you to search for the directory;(See Figure 3.18) click on the directory.Then type in the name of the exportedMethod into the File Name text box.Note that the default extension used foran exported method is (.LIM).

Figure 3.18: Export File Name

5. Click on the “Save” button to insert thedirectory path into the Exported FileName text box.

6. Click on the Comments text box to addspecific notes regarding the exportedMethod.

7. To export the Method to the selecteddestination, click on the “OK” button. To close the dialog box and return tothe “main screen”, click on the “Cancel”button.

Importing a MethodIn order to import a previously exportedmethod:

1. Pull down the Tools menu and selectImport Method.

2. An [Import Method] dialog box similarto the example shown in Figure 3.19will appear.

Figure 3.19: Import Method

3. In the Method File text box, specify theimported Method or click on the browse“…” button to search the directory;double-click on the Method file toinsert the directory path into theMethod File text box.

4. Click on the Method Description textbox and type in a description for theimported Method. The description ofthe Method must be unique so that youwill be able to consistently identify theMethod when using SartoCollect. Theprevious Method description shouldappear as the default value.

5. To import the selected Method, click onthe “OK” button. To close the dialogbox and return to the “main screen”,click on the “Cancel” button.

The imported Method should nowappear in the list of current MethodDescriptions on the SartoCollect “mainscreen”.

If the imported Method contains aninstrument not found in the database, a user prompt will appear. You maydecide to do one of the following:

§ Go to “Importing an Instrument”, a cor-responding section in this chapter, inorder to import the missing nstrument.

47

§ Go to “User Base Library”, a correspon-ding section in this chapter, in order toupdate your current instrument data-base.

§ Go to “Configure a New Instrument”,Chapter 5, in order to configure themissing instrument.

Exporting an InstrumentSimilar to importing or exporting a Method, you are able to import orexport the settings for an instrument.However, only used-defined instru-ments can be exported.

In order to export an instrument, from the SartoCollect “main screen”:

1. Pull down the Tools menu and selectExport Instrument.

2. An [Export Instrument] dialog box similar to the example shown in Figure 3.20 will appear.

Figure 3.20: Export Instrument

3. By clicking on the arrow to the right ofthe Instrument Type and Name text boxyou can view and scroll through a list.Select an instrument type and name.

4. In the Instrument File text box, specifythe destination of the exported instru-ment or click on the browse “…” buttonto search for the directory; click on thedirectory. Then type in the name of theexported instrument into the File Nametext box. Note that the default exten-sion for an exported instrument (.DEV).

5. Click on the “Save” button to insert thedirectory path into the Instrument Filetext box.

6. To export the instrument to the selecteddestination, click on the “OK” button. To close the dialog box and return tothe “main screen”, click on the “Cancel”button.

Importing an InstrumentIn order to import a previously exportedinstrument:

1. Pull down the Tools menu and selectImport Instrument

2. The cursor will be flashing in the FileName text box. Type in the importedinstrument file or browse the directory;(See Figure 3.21) click on the instru-ment file.

Figure 3.21: Locate the instrument to be imported

48

3. To import the selected instrument, click on the “Open” button. To close thedialog box and return to the “mainscreen”, click on the “Cancel” button.

4. In the Device File (.DEV) text box, specify the file where the downloadedfile is located or click on the browse “…”button to search the directory; double-click on the file to insert the directorypath into the Device File (.DEV) textbox. Note that the default extension fora device file is (.DEV).

5. To import the Instrument file, click onthe “OK” button. To close the dialogbox and return to the “main screen”,click on the “Cancel” button.

49

Chapter 4Running a Method

Changing Method Connections’ PortSettings The Port Setup for an Instrument/Device interface contained within exist-ing Methods can be changed throughthe “Edit | Method Connections” menuoption instead of accessing the full[Method Setup].

Click once on the Method Name thatrequires Port Setup changes. Then click on the main menu option “Edit |Method Connections” or right-click onthe mouse button to open the [MethodConnections] dialog. Select the Instru-ment/Device name from the list, thenclick on the “Edit” button to changeeither its Collector type or “Setup” thecommunication port for the Collector.

Refer to Chapter 5 for details on the“RS232 Collector”, “RS232-to-TCP Collector” or “TCP/IP Collector” Setup.

After completing the Collector Setup,click on the “OK” button in the [MethodConnections] dialog to save the changes and return to the main screen.The “Cancel” button will close the[Method Connections] dialog withoutsaving the changes.

Opening a MethodIn order to run a Method:

1. Click on the Method from the list of current Method Descriptions on the SartoCollect “main screen”.

2. Pull down the File menu and selectOpen New or double-click on thatMethod Description.

This will automatically open the Methodand the default Excel® template file orWedge destination depending on whichinterface type is used. The File interfacetype will not open the destination filebut will display the SartoCollect toolbarfor that method on top of the mainscreen.

Opening an Existing DestinationThis feature is not available in SartoCol-lect light.

In order to run an existing Excel® workbook, File or defined DestinationApplication for a selected Method:

1. Click on the Method from the list of current Method Descriptions on theSartoCollect “main screen”.

2. Pull down the File menu and selectOpen or click on the “File Open” button.

3. The cursor will be flashing in the FileName text box. Type in the name of theworkbook, file or application or browsethe directory (see Figure 4.1). Click on the destination name.

50

Figure 4.1: Locate the Destination to Open

To automatically redefine the Destina-tion for the Method, click on the“Open” button. Clicking on the “Cancel”button will cause the “main screen” toreturn.

Opening Another DestinationIf you wish to open more than one Destination at a time, simply follow thesame procedure as above. However,there are a few restrictions to workingwith multiple instances of runningMethods. Since an instrument can onlycollect data from one source, Methodsusing the same COM port resourcescannot gather data at the same time.

While the procedure for configuringinstruments can be followed for anindefinite number of instruments, SartoCollect will permit data collectionfrom multiple instruments at one timeprovided you have the correspondingnumber of serial communications portsavailable. Since most computers haveonly 1 or 2 standard COM ports, addi-tional ports must be added to yourcomputer through an add-on board,Serial-to-USB converter or Serial-to-

Ethernet converter. The software willwork with multi-port boards and con-verters that are configured to workunder your operating system and createstandard Window™ COM ports. TCP/IP communications with SartoCol-lect will only work with valid IP address-es and available TCP/IP Server Portnumbers on the network. The SartoCol-lect computer must be connected withthat network if using the TCP/IP orRS232-to-TCP/IP Collectors to connectwith remote instruments or devices.

Excel® Interface - Sending Commands

Using One InstrumentOnce the workbook is opened and theinstrument is turned on, you can beginto collect data. Predefined operationsdetermined from the Operation Setupare located as a sub menu in the tool-bar. This toolbar floats above the work-book, and the instrument description isused as the tool button name (See Fig-ure 4.2). By clicking on the blue triangle abovethe Instrument Description, you canview the list of operations. The opera-tions send Command Strings to theinstrument; these strings prompt theinstrument for a suitable response. Ifthe associated COM port has not beenopened automatically, click on the Startoperation to open the communicationport and activate the operations. Thenclick on the operation to start this suchas the one associated with collectingdata. A running operating will display“Stop” to the left of the operation nameindicating that this should be selectedin order to stop executing that opera-tion.

51

Figure 4.2: Excel® Workbook toolbar

Using Multiple InstrumentsThis feature is not available in SartoCollect light.

There are several cases where multipleinstruments are used.

1) Data is collected from many instrumentsand received by many workbooks.

2) Data is collected from many instrumentsand received by the same workbook andsame sheet.

3) Data is collected from many instrumentsand received by the same workbook butdifferent sheets.

The first case is similar to Using OneInstrument because there is a oneinstrument to one workbook ratio. A toolbar floats above each workbookthat is opened by SartoCollect; eachtoolbar is independent of the others andis specific to the instrument in use. Thisis done by creating separate Methodsfor each workbook with its own set ofinstruments and running all of themsimultaneously.

The second case, when there is morethan one instrument retrieving data forthe same workbook, the software willcreate a separate tool button for each instru-ment; each sub menu is independent ofthe others and specific to that instru-ment.

In the third case, each instrument operation that receives data can be setto send the results to different sheetswithin the same workbook. For exam-ple, Instrument 1, has Starting Celllocations for instrument data beginningat =Sheet1!B3 and Instrument 2 hasStarting Cell locations for its databeginning at =Sheet2!B7. Both can berunning at the same time, Instrument 1data will be added to Sheet1 and Instru-ment 2 data added to Sheet2 regardlessof which sheet is actively displayed inthe workbook at run. Recall that theSartoCollect Excel® interface type doesnot rely on the cursor location thusallowing many instruments to be con-currently connected by SartoCollect.

52

Place DataInstrument data can be sent to any Rowin the Excel® workbook by using thePlace Data feature. With Place Dataturned ON, click on any cell in the Rowthat next reading should be entered andthe software will write the data to thatnew Row location but will remain in thesame Column. Subsequent data willautomatically be added to the next rowin the same column unless a differentRow is clicked on which will repeat the“Place Data” function. The columnlocation will always remain the same asthe Column specified in the StartingCell for an Operation unless anAdvanced Control script is used tochange this value. Note Cells that arenot empty will not be overwritten andthe software will “skip” down the col-umn to the first empty cell it finds.

The Place Data feature can be startedfrom the workbook toolbar by clickingon the green triangle. See Figure 4.3.

Figure 4.3: Place Data is OFF (disabled) whenthe Green triangle is displayed

When Place Data is active a red circlewill be displayed. Clicking on the redcircle will “stop” the Place Data featureand readings will again be entereddown.

Figure 4.4: Place Data is ON (active) when the Red circleis displayed

Note: Place Data can remain turnedON; but, if any cell in the workbook isselected and a reading from the instru-ment is sent, the software will send theresult to that new location.

Turning Off the Instrument1. Click on the arrow to the right of

instrument tool bar.

2. Click on the Close operation to turn theinstrument off and automatically closethe communication port.

Saving the WorkbookOnce data collection is finished, theworkbook must be saved. Save theworkbook in the same manner as anExcel® spreadsheet. When Excel® is exit-ed, the instrument toolbar automatical-ly closes and the Method becomes inac-tive. The SartoCollect “main screen”will return.

The application will force the user to doa Save As command when saving a newworkbook. This preserves the templatefor future use.

53

File Interface - Sending Commands

Using One InstrumentOnce the Method has been started andthe instrument is turned on, you canbegin to collect data. Predefined opera-tions determined from the OperationSetup are located as a sub menu in thetoolbar. This toolbar floats above theSartoCollect main screen, and theinstrument description is used as thetool button name (See Figure 4.5). Byclicking on the blue triangle above theInstrument Description, you can viewthe list of operations. The operationssend Command Strings to the instru-ment; these strings prompt the instru-ment for a suitable response. If theassociated COM port has not beenopened automatically, click on the Startoperation to open the communicationport and activate the operations. Then click on the operation to start thissuch as the one associated with collect-ing data. A continuously running oper-ating will display “Stop” to the left ofthe operation name indicating that thisshould be selected in order to stop exe-cuting that operation. Any data receivedby the Operation is appended to theDestination file that was defined for the Method with the defined Delimitersadded between each “Result Name”value. Each data packet received fromthe instrument that is to be reported bySartoCollect is added to the File as a new line.

Using Multiple InstrumentsThere are two cases where multipleinstruments are used with a File interface.

1) Data is collected from many instru-ments and received by many Files.

2) Data is collected from many instru-ments and received by the same File.

The first case is similar to Using OneInstrument because there is a oneinstrument to one File ratio. A toolbarfloats above the SartoCollect mainscreen for each Method run and eachtoolbar is independent of the others andis specific to the instrument in use. EachFile destination requires its ownMethod, each with its own instrumentdefined. These Methods can then be runat the same time and different instru-ment data is added to its Method’sdefined destination File.

The second case, when there is morethan one instrument retrieving data forthe same File, the software will create a separate tool button for each instru-ment on the same toolbar; each submenu is independent of the others andspecific to that instrument.

Running a Method that has multipleinstruments defined will operate in thesame manner as one instrument. Datareceived from each instrument will beappended to the destination File as anew line for the data received from eachinstrument in the sequence that Sarto-Collect received that data.

54

Figure 4.5: File Destination toolbar

Monitor ViewEvery Instrument defined for theMethod has monitor view window available to display the data that isbeing reported to the File destination.The monitor for an instrument can beopened from the running Methods toolbar by selecting the “Monitor”button and choosing the Instrumentdescription name from the drop downmenu. The monitor window, whenopened, displays the data received as it would appear in the file from the timeit was opened for that instruments dataonly. Data sent to the File before open-ing the monitor view is not displayedhere nor do other Instruments runningin the same Method.

The title bar of the [Monitor] dialog displays the Instrument Descriptionname and contents within the windowdisplay the Method name, InstrumentName (as defined in the InstrumentLibrary), Collector type with settings,and the Destination file name and location. Refer to Figure 4.6.

Figure 4.6: Instrument monitor view.

Closing the MethodTo close the running Method simplyselect the “Close” button designatedwith a red “X” located on the floatingtoolbar. Selecting this button will prompt youwith a message: “Are you sure you wish to end data col-lection and close down the method?”.Selecting “Yes” will close the Methodand return you to the SartoCollect mainscreen. Selecting “No” will cancel thiswithout closing the Method and returnyou to the SartoCollect main screenwith the Method toolbar still active.

Wedge Interface – Sending CommandsThis feature is not available in SartoCol-lect light.

55

Using One InstrumentOnce the Method has been started andthe instrument is turned on, you canbegin to collect data. Predefined opera-tions determined from the OperationSetup are located as a sub menu in thetoolbar. This toolbar floats above theSartoCollect main screen if no Destina-tion is defined in the Method Setup.The toolbar will float over top of anApplication if this Destination was previously defined in the Method Setup.The instrument description is used asthe tool button name (See Figure 4.7). By clicking on the blue triangle abovethe Instrument Description, you canview the list of operations. The opera-tions send Command Strings to theinstrument; these strings prompt theinstrument for a suitable response. If the associated COM port has not beenopened automatically, click on the Startoperation to open the communicationport and activate the operations. Then click on the operation to start thissuch as the one associated with collect-ing data. A running operation will display “Stop” to the left of the opera-tion name indicating that this should be selected in order to “Stop” executingthat operation. Any data received by theOperation is added to the open windowthat has control of the active cursorlocation or receives control of the activecursor location.

Using Multiple InstrumentsDue to the nature of this interface typethat transfers the results to any openapplication in Windows that has controlof the cursor at the time of data beingreceived, care should be taken when trying to run a Method with multipleinstruments. The Wedge interface will

transfer data to the active cursor loca-tion upon its receipt from any instru-ment. In a case where multiple instru-ments are run simultaneously there is apotential for data being reported to thewrong location.

Figure 4.7: Wedge Destination toolbar

Closing the MethodTo close the running Method simplyselect the “Close” button designatedwith a red “X” located on the floatingtoolbar. Selecting this button will prompt youwith a message: “Are you sure you wish to end data col-lection and close down the method?”.Selecting “Yes” will close the Methodand return you to the SartoCollect mainscreen. Selecting “No” will cancel thiswithout closing the Method and returnyou to the toolbar.

Hotkey – Sending CommandsThis feature is not available in SartoCol-lect light.

All Interface types can have any Operation set to a keyboard Hotkey. If a Hotkey was assigned to an Opera-tion, once the instrument has beenstarted, selecting this keyboard key willexecute this Operation as if it wereselected from the floating toolbar’sinstrument pull-down menu.

56

Chapter 5Configuring a New Instrument

IntroductionAn Instrument Library is included withthe SartoCollect software package con-taining many instruments that a com-pany would employ for analysis proce-dures. As new devices are developed,they are added to the User Base Libraryand new instrument or device interfacesetups can be downloaded from theSartorius website.

Through the Instrument Manager con-tained in the SartoCollect application,you are able to configure additionalinstruments in the event that an instru-ment or device is not available in theInstrument Library, or if the currentinstrument implementation does notsupport the functionality required.Instruments that are currently availablein the Sartorius Instrument Library arenon-editable. They may be selected foruse within a Workstation or Method,but are not accessible via the Instru-ment Manager. For a copy of a specificinstrument setup file to modify pleasecontact Sartorius SartoCollect softwaresupport.

Before you decide to configure a newinstrument, check the Collect User BaseLibrary on-line for an instrument inter-face setup file to match your require-ments. Sartorius and other Collect usercreated setups are continually beingupdated and your instrument or deviceinterface may be available.

Importing a Device FileThe Sartorius Instrument Library contains the manufacturer specifiedparameters for a large number ofinstruments supported by the Collectapplication. Over time, Sartorius andSartoCollect software Users are con-stantly adding to and improving theInstrument Library and making newUser Defined interfaces available to theSartoCollect User Community.

You should update the Sartorius Instru-ment Library for the following reasons:

§ when you have an instrument or deviceto interface that is not in the currentLibrary.

§ there are bug fixes or enhancements foryour instrument.

§ you are considering buying an instru-ment and want to confirm the instru-ment is supported by the Library.

57

Specify the directory of the downloadedfile or click on the “Browse” button tosearch the directory.

Figure 5.1: User Base Instrument/Device Download

Instrument ManagerThis feature is not available in SartoCollect light.

The Instrument Manager is a built-inmodule that allows you to configurenew instrument interfaces to add toyour SartoCollect systems.

The Instrument Manager can be calleddirectly from within a Method’s Setupon the [Connections] dialog by selectingthe “Instrument Manager” button toopen the [User Connections] dialog asshown in Figure 5.2 or from SartoCollectmain screen by selecting the menuoption, Tools | Instrument Manager....

Figure 5.2: Instrument Manager from Connections Tab

The Instrument Manager shown in Figure 5.2 displays any previously createdUser Defined instruments. An instrumentsetup is stored under an instrumentType. Using the pull-down menu, selectthe instrument “Type” that best match-es the instrument or device you have tointerface. To create new “Type” ofinstrument or device, simply place thecursor in the “Type” pull-down menuand enter a new name. Any namedinstruments stored for that Type willappear in the list. New instruments canbe created by selecting the “Add” button. Existing instruments can bemodified or copied by selecting thatinstrument Name in the list and thenthe “Edit” or “Copy” buttons respectivelywhich will display “Add/Edit Instrument/Device Operations” section on the [UserConnections] dialog or the [InstrumentSetup] dialog if accessing the InstrumentManager from the main menu. Instru-ments that are no longer required canbe deleted from the Instrument Manager.

58

You cannot gain access to the instru-ments that are contained within the Sartorius main Instrument Library. These instruments cannot be viewed,edited, copied, or deleted.

The “Import” and “Export” buttonsallow you to move instruments betweendifferent computers as well as back upan instrument to a secure location.Selecting the “Export” button will allowthe export of a selected instrument to a file. Selection of the “Import” buttonallows the import of a previously exported instrument into the system.

Adding a New InstrumentThe “Add/Edit Instrument/Device Opera-tions” section (Figure 5.3) allows you toenter specifics about an instrument cur-rently being configured for the system.

Figure 5.3: “Add/Edit Instrument/Device Operations”

The instrument Type is used to catego-rize the instruments defined for the system. The Type may be selected frominstrument Types currently existing inthe User Defined Instrument database or a new Type may be entered. The “Add/Edit Instrument/Device Opera-tions” section allows you to specify a unique instrument Name.

The Operations/Macros listed on thewindow are Operations and macroOperations currently configured for theselected instrument. From this window,Operations and Macros can be added,and current Operations or Macros canbe modified or copied by selecting the“Add”, “Edit” or “Copy” buttons respec-tively to open the Operation Setup or Macro Setup windows. Operations orMacros that are no longer required canbe deleted from the list. The Port Setupand use of Operations and Macros isdescribed later in this chapter.

Once the new instrument is finishedselect the “OK” button to save theinstrument setup and return to the[Connections] dialog. Selecting “Cancel”will return you to the [Connections]dialog without saving the changes.

Post to Sartorius If you have created a new instrument in the User Instrument Database Library,Collect will ask if you would like to send this instrument or device setup toLabtronics to make it available to theCollect User Base Community. This mes-sage will appear when the “Next” buttonis selected on the [Connections] tab.Selecting “Yes” will open the [Post toLabtronics] dialog. A new instrumentcan be sent to Labtronics via Microsoft®

Outlook® by selecting the “Send viaOutlook” button, posted to the Labtronics FTP site by selecting the“Send via Internet” or exported andsaved as a Device file to be sent bysome other means.

59

Figure 5.4: Post to Labtronics

Communicating with the InstrumentSelecting the “Port Setup” button willopen the [Communications Setup] dialog window, similar to the exampleshown in Figure 5.4.

A collector is required for each instru-ment to communicate with the soft-ware. Currently there are three collectorsavailable to SartoCollect:

RS232 Collector – will communicatewith local RS232 COM ports.

RS232 - TCP/IP Collector – will communicate with the Remote RS232-TCP/IP Collector Service loaded on a remote client computer to which theinstrument is connected. The combina-tion of the RS232-TCP/IP Collector in the Instrument Manager and theRemote RS232-TCP/IP Collector serviceallows the Instrument Manager to com-municate seamlessly with an instrumentconnected to the serial port of a remotemachine.

TCP/IP Collector – the TCP/IP Collectorcan only be configured as a client inthis case, and therefore connect to asingle TCP/IP source (instrument) andcommunicate bi-directionally with thatinstrument.

Protocol – An optional protocol may be selected for use with the instrumentto control the flow of data between theinstrument and the software. Currentlythe software supports the ASTM 1381communication protocol typically foruse with clinical analyzers and the Mod-bus protocol. The Slave address IDs fordevices that support Modbus areentered at the beginning of OperationCommand String line. Each device canhave its own Operation and Parser oruse Arguments to read the addressnumber from Excel® and insert this intothe command string at run-time to usea single Operation and single Parser.

Example Command for a ModbusOperation Setup: Command line:{50}{3}{0}{0}{0}{1}Where {50} = Slave Address IDAnd {1} = # of Registers

The Split Protocol is available can splitlarger multi-line data outputs intosmaller data packets and loop the splitlines through an Operations parser stepand must be used with Timed Collec-tion. The Split Protocol is used in caseswhere multiple lines of the same formatare repeated within a single instrumentoutput allowing for a much simplerParser to be created. The Split Protocolsetup is described later in this chapter.

60

As new collectors and protocols becomeavailable, they can be added to the sys-tem via an install process. Upon registra-tion, they will be available via the Com-munications Setup window (Figure 5.5).

Figure 5.5: Communications Setup

RS232 Collector SetupSelecting the “Setup” button for theRS232 Collector will open the [RS232Collector Setup] dialog window similar tothe example shown in Figure 5.6.

Figure 5.6: RS232 Collector Setup

RS232 SettingsTo establish communication from theRS232 port, the correct COM port infor-mation (e.g., Port, Baud Rate, Data Bits,Stop Bits, Parity and Flow Control) mustbe entered. The Baud Rate, Data Bits,Stop Bits, Parity and Flow Control settings must match the settings of theinstrument and this information is sup-plied in the Instrument’s User Manual.On some instruments this informationmay be found through the instrumentmenu option. The COM Port number is set to match the number of the porton the computer that the instrumentcable is plugged into.

Buffer size - Specifies the maximumallowable data packet size from a singleoutput that can be processed.

Time Out (ms) – the program will col-lect data until an interval of time occurswhen no more data is received. Thistime interval is known as the “Timeout”. After the Time out occurs, theprogram will parse the data. The appli-cation then prepares for the next seg-ment of data.

A Time out that is too short will resultin data being chopped up into smallsegments. A Time out that is too largewill result in long delays betweenreceiving the data and seeing the dataat the specified destination. An overlylarge Time out can also result in missingdata.

61

The default Time out value of 250 mil-liseconds will work for most data collec-tion. Leave this default setting unlessyou are certain that your instrument’stiming will require a different value. The field is editable, but is pre-populatedwith a list of values.

NULL Processing – this parameterdetermines how null characters {0} inthe instrument data should be handled.Selecting “None” will leave the nullcharacter as is, “Strip” will remove anynull characters from the data, and“Replace [space] will change all nullcharacters to spaces {32}.

If “None” is selected for the NULL processing parameter, then the NULLcharacter and anything received afterthe NULL, is not received by the Instru-ment Manager. For example, if “None”is selected, and the command “A {0} B”is sent to the Instrument Manager, thenthe Instrument Manager receives only“A”. You would select “None” if theinstrument is communicating via a binary protocol.

Character delay – this parameter estab-lishes the time delay in millisecondsbetween individual characters in thecommand string being sent to theinstrument. It is used to slow down the transmission rate of characters tothe instrument in the event that aninstrument cannot sustain the currenttransmission rate.

Command delay – this parameter establishes the time delay in millisecondsbetween commands being sent to theinstrument. It is used to slow down the transmission rate of commands tothe instrument in the event that aninstrument cannot sustain the currenttransmission rate.

For example, if a macro contains severalcommands in a row, a delay can beincorporated between each commandthat is sent.

Transaction LoggingTransaction Logging is used in trou-bleshooting. If you require a copy of thecommunications messages being sentbetween SartoCollect and the RS232port, activate this option. The file nameto which the communication messagesare to be sent and saved can be specified.

The log file will record all communica-tions. Along with the date and time, thelog file will indicate whether the datewas sent to the instrument or receivedfrom the instrument.

Testing the CommunicationsSelecting the “Test” button on theRS232 Collector Setup window willopen the [Communications Test] dialogwindow.

62

String to transmitThis is the command string that will betransmitted to the external RS232 device upon selectingthe “Transmit” button.

New strings can be entered here or apreviously defined string can be selectedvia the drop down list. Non-printablecharacters such as a carriage returnshould be entered as ASCII numbersenclosed in { } brackets. A listing ofASCII numbers is included in Appendix A.

The Transmit string allows for the inclusion of comments provided it follows a set of double forward slashes.For example, you could establish a com-mand for a balance with the followingstring:S{13}{10}//Get Weight

This would result in an upper case “S”followed by a carriage return and linefeed to be transmitted to the externalRS232 device. Any text including andfollowing the double forward slasheswould be treated part of the commentand would not be transmitted to theinstrument.

Selecting the “Transmit” button will ini-tiate the following sequence of events:

1. Any comments will be stripped from thestring

2. The string will be transmitted to anexternal RS232 device using the config-uration defined via the RS232 CollectorSetup window.

3. Any incoming communications will bereceived and displayed in the transac-tion log.

Data sent to and received in the Transaction Log appears similar to thefollowing example:[S 2002/09/23 13:56:50.604] S{13}{10}[R 2002/09/23 13:56:50.879] 10.25g

The header information is containedwithin the square brackets. This infor-mation includes:

S or R – an “S” represents the data sentfrom the Instrument Manager, a “R”represents the data received from theinstrument. Date of the data transaction – the dateis always displayed as yyyy/mm/dd.Time of the data transaction – thetime is always displayed ashh:mm:ss:msec.

Following the information in squarebrackets is the actual data that waseither sent or received.

Selecting the “Clear” button willremove the contents of the TransactionLog display.

RS232-TCP/IP Collector SetupThis feature is not available in SartoCol-lect light.

Selecting the “Setup” button for the“RS232 to TCP/IP Collector” will openthe RS232 – TCP/IP Collector Setupwindow similar to the example shown inFigure 5.7.

63

Figure 5.7: RS232 - TCP/IP Collector Setup

RS232 Settings The RS232 Settings portion of the dia-log is explained in the RS232 CollectorSetup section.

TCP/IP Settings Set the Computer Name and Port of the remote client computer (i.e., the PCwith the Labtronics Remote RS232 –TCP/IP Collector service softwareinstalled). The IP address can be usedinstead of the Computer Name. The Port number should correspond tothe Port number that is set in the RS232TCP/IP Administration Port Setup win-dow that is displayed on the Client PC.

If the IP address of the computer withthe RS232-to-TCP/IP service programinstalled is not known, go to that com-puter and select the “Run” option fromthe Windows™ Start menu. Type “CMD”(without quotations) in the Open lineand select “OK” to display the Com-mand prompt. Type in “IPConfig” in theDOS prompt and select <Enter>. The

“IP Address” for this computer shouldbe displayed in the Local Area Connec-tion section. Record this number andreturn to the computer with the Sarto-Collect software.

Note: Flow Control, Null Processing,Character Delay, Command Delay set-tings and Communication Test, Trans-action Logging options are available forthe RS232-to-TCP/IP Collector throughan Operation Setup | Test or MacroSetup | Test. Within the “Add/EditInstrument/Device Operations” section,select an existing Operation or Macrothen the “Edit” button. To create a newoperation, select “Add” and give thenew Operation a name. Click on the“Test” button located on the bottomleft of the operation/macro setup win-dow and then “Communications…”.Select the “Setup” button for theRS232-to-TCP/IP Collector.

Buffer size - Specifies the maximumallowable data packet size from a singleoutput that can be processed.

TCP/IP Collector SetupThis feature is not available in SartoCol-lect light.

Selecting the “Setup” button for theTCP/IP Collector will open the TCP/IPCollector Setup window similar to theexample shown in Figure 5.8 (see nextpage).

64

Figure 5.8: TCP/IP Collector Setup

TCP/IP Settings Set the Server Name (IP Address) andPort of the TCP/IP server to connect to.

Note: Null Processing, CommunicationTest, Transaction Logging options are available for the TCP/IP Collectorthrough an Operation Setup | Test orMacro Setup | Test. Within the “Add/EditInstrument/Device Operations” section,select an existing Operation or Macrothen the “Edit” button. To create a newoperation, select “Add” and give the newOperation a name. Click on the “Test”button located on the bottom left of theoperation/macro setup window and then“Communications…”. Select the “Setup”button for the TCP/IP Collector.

Buffer size – Specifies the maximumallowable data packet size from a singleoutput that can be processed.

Connecting the TCP/IP Collector to an E-BoxThe first step is to attach the E-link box to the network. The E-box requiresan IP address, and a port number. It ispre-set with default values as outlinedin the E-link box documentation; how-ever, these default settings can be mod-ified using HyperTerminal or some otherterminal program. Refer to the E-linkbox documentation for details.

Once the E-box has been connected to the network, you can enter its IPaddress into a web browser, and modifya variety of settings via the displayedpages. Verify that the RS232 communi-cation parameters are set to work withthe instrument that is being connectedto the E-box. Also, verify that whendefining the RS232 –Network commu-nication, the EOL characters is set to LF.

When configuring SartoCollect to workwith the E-box, you need to select theTCP/IP Collector when setting up theinstrument. Enter the E-box’s IP addressfor the Server Name, and the E-box’sport number as the Port parameter inthe TCP/IP Collector Setup window.

ProtocolAlso known as “handshaking”, the pro-tocol controls the flow of data betweenthe instrument and the SartoCollectsoftware. SartoCollect supports dynami-cally loaded communication protocols;this means the program determineswhat protocols are available on yoursystem at the time. Additional protocolsmay be added as required, contact Sartorius AG. with your specific protocolneeds.

65

ASTM 1381 – A standard communica-tions ACK/NACK type of protocol foundin many instruments for bi-directionalcommunication. This would be specifiedin the instrument User Manual if it isrequired by your instruments RS232communications. If this communica-tions protocol is not required, do notselect this for your instruments PortSetup.

Modbus Protocol – The Modbus Proto-col allows SartoCollect to communicatewith devices along the same communi-cation port. A specific devices slaveaddress is specified in the operationscommand string line in ASCII format. At run-time, this command is convertedto binary and sent to the specific deviceand returned data is converted frombinary (if necessary) to ASCII beforebeing processed by the InstrumentManager.

Split Protocol – The Split Protocol is a special data processor used by SartoCollect to simplify the creation ofParsers for large multi-line data packetsfrom instruments such as a batch logfile output containing many samples. If this is required for an Instrument,select the “Split Protocol” from thedrop-down menu and select the “Setup”button. Within the Split Protocol setupdefine the Number lines for the “Head-er”, “Data Block” and “Footer”.

With this setup applied to the interfacewith the instrument, SartoCollect willsplit each incoming data packet andappend the Header and Footer to each“Data Block” split file. Each split filecreated will then be processed by loop-ing through an operations simple parser

to extract the data required from each.The operation setting must be set toTimed Collection defined on the [Con-nections] dialog of the Method Setupthrough the “Settings” button in theOperation section.

Operation SetupThis feature is not available in SartoCol-lect light.

An Operation is a single action that can be performed on an instrument. For example, acquiring a weight from abalance, or performing a tare on a bal-ance are common Operations. An Oper-ation is typically composed of a com-mand and an accompanying response. A single instrument may potentiallyhave numerous Operations defined.

From the “Add/Edit Instrument/DeviceOperations” section (see Figure 5.3),select the “Add Operation” window toopen the Operation Setup window, sim-ilar to the example shown in Figure 5.9.

Figure 5.9: Operation Setup

66

The Operation Setup window allows youto specify a unique Operation Name,and an optional Description.

In addition to its name, an Operationconsists of a command sent to theinstrument and a response receivedback from the instrument.

CommandThe format of the command string mustrepresent the ASCII text that is trans-mitted by the Operation to the instru-ment. Non-printable characters such asa carriage return should be entered asASCII numbers enclosed in { } brackets.A listing of ASCII numbers is included inAppendix A.

The string may also contain argumentsby referencing a specified argumentfrom the “Argument Name” table.

An argument allows you to alter thecommand that is being sent to theinstrument. At run-time, you can entera value for the argument containedwithin the command string, which inturn is then sent to the instrument.

To reference an argument in the Stringtext box, enclose the reference numberin a pre-pending “[%” and an append-ing “]” at the point in the string wherethe argument is desired. For example, inorder to include the first argument in acommand string, add “[%1]” at therequired position in the string.

The Argument Value can be set in theTest Operation window (see Figure 5.10on the next page) or you have theoption to set it at run-time by definingthe Cell location for the Argument with-in the Method Setup

ResponseParserThe response that is received back fromthe instrument is often complex andcontains useless information. Throughthe use of a parser, the software willextract from the response the requiredinformation, and discard the rest. The purpose of the parser is to isolateand retrieve data segments.

When determining a Parser solution for your data, it is best to first collectthe instrument’s raw data response. This means viewing the response with-out the use of any Parser. Refer to theprocedure “Testing the Operation Set-tings”. Once you have carefully exam-ined the response in its raw form, aParser can be easily designed.

Refer to Chapter 6 – The Simple Parser.

TimeoutWhen a command string is sent to theinstrument and there is no immediateresponse from the instrument, the software will wait a specified maximuminterval of time (ms) before the Opera-tion is terminated. This interval isreferred to as the “Time Out” and is anoptional feature. If activated, thedefault value is 5000 ms. If a Time Out is not specified, the software willwait an indefinite period of time for a response, unless the Operation is manually terminated.

Result Names can be established andlisted as variables that can receiveparsed information. In order for theResult Names to correspond to the cor-rect parsed values, the Result Namesmust be entered into the table in thesame order as the data will be parsed.

67

An optional Expected Value may beentered for any Result Name. By com-paring this value to the Actual Valueobtained through the Test Operationwindow, you can ensure that the instru-ment is responding correctly. If theExpected Value does not match theActual Value, an error message willappear indicating that “The expectedresult value and actual value are different”.

Note: This check is only verified duringthe Test Operation procedure and is notperformed at run-time.

Test OperationThe “Test” button will open the TestOperation window, similar to the exam-ple shown in Figure 5.10.

Figure 5.10: Test Operation

The Test Operation window allows youto directly interact with the selectedinstrument. You are able to test thecommand and response settings estab-lished in the Operation Setup window, as well as make changes. Its primaryfunction is to assist in the developmentof the Operation Setup, and can bethought of as an extension of that dialog.

Upon opening, the Test Operation win-dow will contain all information definedvia the Operation Setup window for theselected Operation. The Name andDescription are non-editable. All fieldsin the Command and Response groupsare editable except the Actual Value textbox. The Actual Value text box containsthe parsed data that is received from the instrument.

In order to test the current commandand response settings, click on the “Execute” button. The following actionsare attempted:

1. To open the communication port to the external physical RS232 or TCP/IPdevice, based on the underlying RS232or TCP/IP communications settings.

2. To transmit the Command String to theinstrument.

3. To display the raw data received fromthe instrument in the Raw DataReceived group box.

4. To parse and display the data in theActual Value list box.

The raw data will appear in a Raw DataReceived read-only text box. This meansthat no changes can be made directly tothis box, but its contents can be copiedto a clipboard in order to save or editthe data. “Raw” data means that it isthe data received from the instrumentbefore the parser is applied to it.

There will be two separate modes bywhich the raw data can be displayed.

68

In order to display the non-printableASCII characters using { } mechanism(see Appendix A for a listing of ASCIInumbers), click the radio button besidethe “Display translated control charac-ters” to toggle it on.

In order to display the non-printableASCII characters (including carriagereturns and line feeds) with a symbolsuch as a square, click the radio buttonbeside the “Display character positionand value”. This mode is beneficial ifthe parser used is of the position type.

If the “Display character position andvalue” option is selected, there are alsothree text boxes labeled Row, Col, andChar available. These boxes will indicatethe number of lines from the top, thenumber of characters from the left-hand margin and the decimal value ofthe ASCII character that the cursor iscurrently positioned at, in the Raw DataReceived text box, respectively. Thisfeature is beneficial if the parser used isof the position type.

Selecting the “Clear” button will removethe contents of the Raw Data Receiveddisplay.

If the communication settings need tobe changed, selecting the “Communica-tions” button will open the Communi-cations Setup window (see Figure 5.5).

Macro Setup NOTE: Only advanced users with pro-gramming knowledge should attempt toutilize the [Macro Setup].

A Macro is a program or code segmentwritten in the internal macro language

(SAX Basic“) of SartoCollect. Each timea new macro is created, a templatescript file is created. The default tem-plate has a main subroutine, which SAXuses as the starting point of the script.

Macros can be written to combine sev-eral instrument Operations together, orto perform a task that cannot be com-pleted through a single Operation.Macros can be written such that theycan execute several Operations in suc-cession. The macro code can also beused to manipulate the results fromindividual Operations by modifyingalready existing variables.

As an example, the following macrocombines the Open Doors, Get Weightand Close Doors individual Operationsinto a single task. The error handlingcode, incorporated within the macro,displays an error message if an erroroccurs during the execution of any ofthe steps.

Sub Main

On Error Goto ErrHandler

OPERATIONS(“Open_Doors”).EXECUTEOPERATIONS(“Get_Weight”).ARGUMENTS(“ArgumentName”)=OPERATIONS(“MacroName”).ARGUMENTS(“MacroArgument”)OPERATIONS(“Get_Weight”).EXECUTEOPERATIONS(“Close_Doors”).EXECUTEOPERATIONS(“MacroName”).RESULTS(“MacroResult”).VALUE=OPERATIONS(“Get_Weight”).RESULTS(“Weight”).VALUEEnd

ErrHandler:MsgBox “There was an error running themacro”,,”Warning”Resume Next

End Sub

69

From the “Add/Edit Instrument/DeviceOperations” section (see Figure 5.32),select the “Add Macro” window toopen the Macro Setup window, similarto the example shown in Figure 5.11.

Figure 5.11: Macro Setup

The Macro Setup window allows you tospecify a unique Macro Name, and anoptional Description.

Selecting the “Expand” button will open a larger Macro Code window thanis available in the Macro Setup windowfor viewing and editing the macro code.

The Argument Name along with thecorresponding argument is used toassign a value to an argument that isreferenced by the Macro script.

Result Names can be established andlisted as variables that can receive datafrom the macro code.

An optional Expected Value may beentered for any Result Name. Duringruntime the received result must matchthe expected value or an error messagewill appear.

The “Import” and “Export” buttonsallow you to move macros between dif-ferent computers as well as back up amacro to a secure location. Selectingthe “Export” button will allow theexport of a selected macro to a file.Selection of the “Import” button allowsthe import of a previously exportedmacro into the system. Macros areexported as *.bas files.

Test Macro The Test Macro window allows you to directly interact with the selectedinstrument. You are able to test themacro code established in the MacroSetup window, as well as make changes.Its primary function is to assist in thedevelopment of the Macro Setup, andcan be thought of as an extension ofthat dialog.

The “Test” button will open the TestMacro window, similar to the exampleshown in Figure 5.12.

Figure 5.12: Test Macro

70

Upon opening, the Test Macro windowwill contain all information defined viathe Macro Setup window for the selectedOperation. The Name and Descriptionare non-editable. The code is editable,but due to the limited amount of spaceit may be easier to select the “Expand”button to open a larger Macro Codewindow.

All fields in the tables are editableexcept the Actual Value text box. The Actual Value text box contains theparsed data received from the instru-ment.

In order to test the current macro settings, click on the “Execute” button.The following actions are attempted:

1. To open the communication port to theexternal physical RS232 or TCP/IPdevice, based on the underlying RS232or TCP/IP communications settings.

2. To execute the macro code.

3. To display the raw data received fromthe instrument in the Raw DataReceived group box.

4. To process and display the data in theActual Value list box.

The raw data will appear in a Raw DataReceived read-only text box. This meansthat no changes can be made directly tothis box, but its contents can be copiedto a clipboard in order to save or editthe data.

There will be two separate modes bywhich the raw data can be displayed.

In order to display the non-printableASCII characters using { } mechanism(see Appendix E for a listing of ASCIInumbers), click the radio button besidethe “Display translated control charac-ters” to toggle it on.

In order to display the non-printableASCII characters (including carriagereturns and line feeds) with a symbolsuch as a square, click the radio buttonbeside the “Display character positionand value”. This mode is beneficial ifthe parser used is of the position type.

If the “Display character position andvalue” option is selected, there are alsothree text boxes labeled Row, Col, andChar available. These boxes will indicatethe number of lines from the top, the number of characters from the left-hand margin and the decimal valueof the ASCII character that the cursor iscurrently positioned at, in the Raw DataReceived text box, respectively. Thisfeature is beneficial if the parser used isof the position type.

If the communication settings need tobe changed, selecting the “Communica-tions” button will open the Communi-cations Setup window (see Figure 5.5).

71

Chapter 6The Simple Parser

In programming language the term “to parse” means to isolate and retrievedata segments from long strings ofdata.

The program will receive a block ofdata. This block of data varies from onenumber, to many numbers and charac-ters spread over several lines. At thispoint, the block of raw data receivedfrom the instrument is in memory.Before the program can make use ofthis data it must break it up into smallerreadable parts. That is to say, the pro-gram must “parse” the data. The Parsertells the program just how to break upthe block of data. If no Parser is speci-fied, the data is not modified.

There are two aspects to setting up aParser.

In order for the program to know howto recognize the data, you must deter-mine the Parser Type. In order for theprogram to save and discard the propercomponents of the data, you mustdefine the rest of the Parser Syntax.

A Tip to Follow when Trying to Designa Suitable ParserMake your Parser in stages. When youmake a change to the Parser syntax,retest the Setup.

Parser TypesThere are three different types of Parsersthat specify how to break up data thatis transmitted to the computer.

N NumbersData is parsed on a numbers-only basis.All numbers are extracted from the dataand only numbers are used. Note that a“number” is considered any continuousstring of numeric digits, including deci-mals.

P PositionData is parsed based on position. Thiscan be used when the data is always inthe same position.

D DelimiterData is parsed based on a leading andtrailing pair of Delimiters. The Delimitermay be a comma, a space (ASCII 32), orany other literal character or group ofcharacters.

The first character in a Parser must bean N, P, or a D, followed by a slash “/”;this indicates the Parser Type. This is infact the only part of the Parser Syntaxthat must be specified since it does nothave a default value.

Parser SyntaxEach type of Parser has its own syntax:N/SELECTOR/ORIENTATION/NEW LINEP/POSITIONS/ORIENTATION/NEW LINED/DELIMITERS/SELECTOR/ORIENTA-TION/NEW LINE

72

The Parser SelectorThe Selector in the Parser Syntax allowsyou to specify the data that is saved ordeleted.

The Selector is a list of Ys and Ns, suchas “/YNYNNNY/”. A Y(es) instructs the program to keepthe data, and a N(o) means do NOTkeep the data. In this example the first,third, and seventh valid data values willbe saved.

Several short forms can be used forrepeating sequences in the Selector. You may specify “*Y” to indicate that alldata from this point is to be saved oryou can specify “*N”, which indicatesthat all data from this point is not to besaved. If the Selector is not specified,“*Y” is the default value.

The Parser OrientationThe Orientation allows you to specifywhether data should be placed into theSpreadsheet across a row or down a col-umn. The Orientation can be either Rfor Row or C for column.

Orientation needs to be set to “C” suchthat all of the data will be entered downthe Results Actual Value column.

If the Orientation is not specified, “R” isthe default value.

The Parser New LineThe New Line allows you to indicatehow the program responds to a new linein the raw data block.

R When the program reaches a carriagereturn/linefeed (CRLF) or an End of Line(EOL) in the data block, the Parser willgo to the next row in the data blockand repeat the Parser String. Note:Every parsed value requires a unique“Result Name” defined within the Oper-ation Setup for the total number timesthe Parser String will be repeated.

I The program will treat all CRLF and EOLas regular characters, so that the Parserhandles the data block as if it is a singleline

If the New Line is not specified, thedefault value is based on the Orienta-tion.

Designing a Simple ParserNote that the Simple Parser is quitecompetent for most parsing situations.

Using the Numbers Parser Type Select the N type if you require only thenumbers to be extracted from the rawdata. The following is the syntax forsuch a Parser Setup:

N/SELECTOR/ORIENTATION/NEW LINE

The Parser will be an N followed by aslash “/”. This is followed by a series ofYs and Ns to indicate which numbersare to be saved. Please recall that a“number” is considered any continuousstring of numeric characters, includingthe decimal. So a number can be a sin-gle digit or several numeric characters.

73

Example: N/NNYNYN/C/RSuppose you have the following rawdata block:2.454 26.9C 1.223 27.3C9.876 27.1C3.879 26.7C 3.546 28.46.549 26.4C

SELECTOR=/NNYNYN/The third (1.223) and fifth (9.876) val-ues are saved while the others ignored.

ORIENTATION = /C/It would then put these into two cellsdown the Results Actual Value column.

1.2239.876

NEW LINE = /RThis means that when the programreaches the end of the first line, it willgo down one row and handle the nextline in the data block in the same wayas the first. This means that the 3rd and5th numbers will be parsed from thesecond line - “3.546” and “6.549” - andput into two cells in a column belowthe previous ones.

Each parsed value requires a “ResultName” including every repeated parserstring when using the New Line = /R.

1.2239.8763.5466.549

Figure 6.1: Test Operation using NumbersParser Example

Using the Position Parser TypeMany instruments generate data that isalways in the same position. For exam-ple, a balance may always have theweight in positions 1 to 7 and the unitalways in positions 9-10.

If the data is always in the same posi-tion, a Parser Type of Position (P) canbe used. The following is the syntax forsuch a Parser Setup:P/POSITIONS/ORIENTATION/NEW LINE

This Parser consists of a P followed by a “/”. This is followed by the positionsthat are to be saved. The Position is a sequence of number ranges separatedby commas.

Example: P/8-11,5-5,5-7/C/RSuppose that you have the followingraw data block received from the connection::ST +mg 90.1ST +mg .942ST +mg 2.02

74

POSITIONS=/8-11,4-44-6/The numbers represent the positions inthe data string that contain the requiredvalues. Each sequence must state a startand end position. In the above examplethe first data value consists of charac-ters in positions 8 to 11 inclusive. Thesecond data value consists of one char-acter in position 5. And the third con-sists of characters in position 5,6 and 7.

You can arrange the position numbersin any order (i.e. the 5-5 is listed afterthe 12-15 in the above example). As thedata is transferred it will be processed inthe order listed.

If required you can use a position morethan once. The above example usesposition 6 in both 5-5 and 5-7. Only listthose positions that contain data that isto be saved. In the above example datain position 1 to 4 and 10 to 11 are notrequired and therefore are not listed.

ORIENTATION=/C/It would then put these into 3 cellsdown the Results Actual Value column:90.1 + +mg

NEW LINE = /RThis means that when the programreaches the end of the first line, it willgo down one row and handle the nextline in the data block in the same wayas the first.

Each parsed value requires a “ResultName” including every repeated parserstring when using the New Line = /R. Inthis example, a total of 9 Result Nameswould need be defined for the 3 parsedvalues from 3 lines.

90.1 + +mg.942 + +g2.02 + +mg

Figure 6.2: Test Operation using Position Parser Example

Using the Delimiter Parser Type If none of the above Parser Types aresuitable for the data from your instru-ment, you may need to use the Delim-iter Type (D). “Delimiter” is a comput-ing term for any character thatseparates units of data. The comma andthe space are common Delimiters.

Look at the raw data and see if someunique characters can be foundbetween the data that is required.

The following is the syntax for such aParser Setup:D/DELIMITERS/SELECTOR/NEW LINE

The D Parser consists of a list of thevalid “Delimiters”, followed by a list ofYs and Ns (selectors) to indicate thedata that is to be saved.

Example: D/{32},/YNNYY/C/R

75

Suppose you have the following rawdata block received from the connec-tion:

19Jan98,,11:30pm 2.345mg,26.9C20Jan98,,12:00am 2.227mg,27.0C20Jan98,,12:30am 2.134mg,26.9C

DELIMITERS=/{32},/If several of these Delimiters occur insequence one after the other, the pro-gram will treat each as a separateDelimiter. For example, in the string“20Jan98,,11:30pm…” the second element is a blank because there isnothing between the two commas. A blank will be transferred as the datafor the second element.

You can list as many Delimiters as you wish. If they are standard printable(keyboard) characters, simply list themin the Delimiter (i.e./g#@+/). If they arenot printable characters, you must listthem in the form of an ASCII characterenclosed in { } brackets, such as {32}for a file that is “space delimited”.

SELECTOR = /YNNYY/For the first row in the data block, the Simple Parser in the above examplewould take the first value, ignore thenext two, then parse out the fourth andfifth. In the example, we are discardingthe times.

ORIENTATION = /C/The Simple Parser would then put thedata into 3 cells down the Results Actu-al Value column:19Jan98 2.345mg 26.9C

NEW LINE = /RThis means that when the programreaches the end of the first line in thedata block, it will go down one row andhandle the next line in the data block inthe same way as the first.

Recall that each parsed value requires a“Result Name” including every repeatedparser string when using the New Line =/R.

19Jan98 2.345mg 26.9C20Jan98 2.227mg 27.0C20Jan98 2.134mg 26.9C

Figure 6.3: Test Operation with Delimiter Parser Example

If you find that the Simple Parser isinadequate for your parsing situation,see “Advance Options for the SimpleParser” below.

If the data cannot be parsed with any ofthese Types, contact Sartorius Hotline.For the address, please visit our Internetwebsite at: www.sartorius.com.

76

Advance Options for the Simple ParserCommands can be used to help navigatethe Parser. You can embed advancedPositioning Commands within theSelector and Positions areas of the Parser Syntax.

Note that the Positioning Commandsare not required for most parsing situa-tions.

Affecting the Data Block{R:#}( )All entries between the ( ) brackets arerepeated # of times. In this command, you are able to putany of the Positioning Commands with-in the brackets ( ), including another{R:#}( ) command.

When New Line is set to R or C, the{R:#}( ) command refers only to thecurrent line. When the Parser encoun-ters an end of line in a data block, itmoves to the next line, if one exists,and starts again.

When the New Line is set to I, the{R:#}( ) command continues past anyend of line characters in the data blockuntil it completes all the repeats. An exception to this is when using the{R:#}( ) command in the Position area;the Simple Parser repeats, extracting thesame positions on the current line, anddoes not advance to a new line.

{L:#}Moves to the start of the given linenumber within the data block. The firstline in the block is 1. The Parser stops ifit reaches an invalid row, column or line.

{L+:#}Add # of lines to the current line andgoes to the start of that line. If it is out-side the data block this command isdone, the Parser stops if it reaches aninvalid row, column or line.

{L-:#}Subtract # of lines from the current lineand goes to the start of that line. If it isoutside the data block this command isdone, the Parser stops if it reaches aninvalid row, column or line.

When using the L:, L+:, or L-: com-mands, the New Line entry must be setto I, so that the Parser ignores the endsof lines in the data block and can navi-gate through the block correctly.

Example: P/1-4,7-9,{L:3}1-2,{L:5}5-9/C/I

Suppose you have the following rawdata block:Lab:0078911:30ampH__Test1Op:0012Val:6.489

77

This Parser will parse specified Positionsfrom the data, and navigate throughthe step’s data block. It first gets valuesfrom positions 1-4 and 7-9, writingthem into a row according to the R Ori-entation. The Parser advances to line 3{L:3} in the data block and extractsdata from positions 1 and 2, writing thisto a new cell in the row. Then the Parsermoves to line 5 {L:5} and gets datafrom positions 5-9.

Lab: 789 pH 6.489 Figure 6.4:

Test Operation with Multi-line Position

Parser

78

Chapter 7Advanced Control – Sax Basic® Editor

SummaryThis feature is not available in SartoCol-lect light.

The Advanced Control Function utilizesa Sax Basic engine embedded within theMethod to provide run-time interactionwith the SartoCollect application’sMethod. The function can be used toperform a variety of operations fromretrieving work-lists from databaseapplications to combining instrumenta-tion control operations based on resultsreceived, calculating averages to cus-tomized user interface (GUI) screens and user prompts.

The Sax Basic language provides thecore language definition for the script.The Sax Basic language is Visual Basicfor Applications® compatible.

Function TypeThe Advanced Control Function may belinked to any of the three AssignmentAreas:

1. Method Start-up (Public Sub “OnMeth-odStarted”) is executed when the firstinstrument in the Method is started.

2. Method Run-time (Public Sub“OnDataReceived”) is executed uponreceipt of data from any instrument inthe Method.

3. Method Close (Public Sub “OnMethod-Close”) is executed when all instrumentsin the Method have been closed.

The three Assignment Areas connectwith the Methods Instrument Objects,Excel® Objects and Method parameters. The SartoCollect application allows youto manually indicate the end of a run byselecting the File | Exit option in Excel®if using a direct to Excel interface typeor selecting the “Close” button on thefloating toolbar. This indicates to theprogram that data collection is com-plete and will close any instrumentsthat are running.

Accessing the Advanced Control Function SetupSelect the Method you are interested inadding a control script to and choosethe Edit | Method menu option fromthe SartoCollect “main screen”. To createa new Method, refer to Chapter 5.

Click on the “Advanced Control” buttondisplayed on the [Start Setup] dialog tabto open the [Advanced Control Setup]dialog. See Figure 7.1. Provide adescription for the script in the textboxprovided.

The Sax Basic editor is an interactivedesign environment for developing,testing, and executing Sax Basic scripts.

Figure 7.1: Advanced Control Setup

79

Allowing Script DebuggingYou have the option to debug the scriptat run-time. From the [Advanced Con-trol Setup] window, click on the “AllowScript Debugging” checkbox. A check-mark will appear in the box when it isselected.

Activating this option will place a ViewScript menu option below the associat-ed Menu Entry on the Host Applica-tion’s Options menu. At run-time,selecting the View Script menu optionwill open the Integrated DevelopmentEnvironment (IDE) of the script engine.

SetupThis allows you to configure any run-time settings required by the script byexecuting a setup subroutine within theSax script via the “Setup” button asshown in Figure 7.2

Figure 7.2: Sax Basic Editor

Refer to the Sax Basic help file for infor-mation on the Sax Basic programminglanguage.

Select the Save option within Sax Basicto save the script into the Method.

Using the Template Script FileThe template script file is designed suchthat you can increase the array to allowfor more menu options.

The template script file contains othersubroutine entry points within the HostApplication where the Sax Basic codedscript can be called.

Template Script File‘SartoCollect 6.0 Advanced ControlScript. ‘This script allows the user to add somecustom actions that can be performedwhen a method has started, ‘duringdata collection and when a method isstopped. This can include modifying thedata from the instrument, ‘changingoutput locations, changing excel celllocations, starting and stopping opera-tions and instruments.

Option Explicit

Const OUTPUT_EXCEL = 1Const OUTPUT_FILE = 2Const OUTPUT_WEDGE = 3

‘Add code to the OnMethodStartedevent to have actions triggered when a SartoCollect Method is started‘The InterCollect parameter is a contain-er object holding SartoCollect Methodand Instrument functions to execute‘The oExcel parameter is an Excel objectpassed in from SartoCollect allowing theuser to access the excel sheet‘The lOutputType is a flag to determinewhat form of output this method uses.1 = Excel, 2 = File, 3 = Wedge‘The strOutput path is a string path ofthe File or Wedge location set in themethod.

80

Public Sub OnMethodStarted(ByRefpCollect As Variant, ByRef pExcel AsVariant, ByVal lOutputType As Long,ByVal strOutputPath As String)

Dim CollectData As InterCollectLib.Col-lectDataSet CollectData = pCollect

Dim ExcelApp As Excel.ApplicationSet ExcelApp = pExcel

End Sub

‘Add code to the OnDataRecieved event to have actions triggered whenSartoCollect data comes back from theinstrument‘The InterCollect parameter is a contain-er object holding SartoCollect Methodand Instrument functions to execute‘The ComDevice parameter is the actualInstrument Manager Instrument devicepassed in from SartoCollect‘The oExcel parameter is an Excel objectpassed in from SartoCollect allowing theuser to access the excel sheet‘The lData parameter is a variable thatcan be used to set data from the instrument. ‘Modifying this allows the user to docalculations on the data coming backfrom an instrument and allows the user‘to output this value instead of whatcomes back from the instrument in SartoCollect.‘The lOutputType is a flag to determinewhat form of output this method uses.1 = Excel, 2 = File, 3 = Wedge‘The strOutput path is a string path ofthe File or Wedge location set in themethod.

Public Sub OnDataReceived(ByRef pCol-lect As Variant, ByRef pExcel As Variant,ByRef pComInstr As Variant, ByVallData As Long, ByVal lOutputType AsLong, ByVal strOutputPath As String)

Dim CollectData As InterCollectLib.Col-lectDataSet CollectData = pCollect

Dim CommInstr As CommInstrument Set CommInstr = pComInstr

Dim ExcelApp As Excel.ApplicationSet ExcelApp = pExcel

End Sub

‘Add code to the OnMethodStoppedevent to have actions triggered whenthe method is closed‘The InterCollect parameter is a contain-er object holding SartoCollect Methodand Instrument functions to execute‘The oExcel parameter is an Excel objectpassed in from SartoCollect allowing theuser to access the excel sheet‘The lOutputType is a flag to determinewhat form of output this method uses.1 = Excel, 2 = File, 3 = Wedge‘The strOutput path is a string path ofthe File or Wedge location set in themethod.

Public Sub OnMethodStopped(ByRefpCollect As Variant, ByRef pExcel AsVariant, ByVal lOutputType As Long,ByVal strOutputPath As String)

Dim CollectData As InterCollectLib.Col-lectDataSet CollectData = pCollect

Dim ExcelApp As Excel.ApplicationSet ExcelApp = pExcel

End Sub

81

ActiveX Automation MembersThe embedded SAX Basic Editor gives aMethod run-time access to all ActiveXLibraries available on the system Sarto-Collect is installed on.

The two SartoCollect specific librariesadded are the “InterCollectLib’ and the“LABTRONICSCOMMINSTRLib’.

InterCollect LibraryThe “InterCollectLib’ provides run-timeaccess to the SartoCollect Methodsinstrument operation command param-eters and are referenced by the Indexnumber that they represent at run time,starting from the first instrument in themenu (displayed on the far left side of the toolbar), down its operation list,to right to the next instrument in themenu, down its operation list and soon. Refer to Figure 7.3.

Figure 7.3:

SAX Editor – Referencing the InterCollect

Object Library

The Button of the first instrument inthe list/menu is always the first, Indexnumber 1, operation command value,and “Start/Close’ operation of the firstinstrument has an index number of 2,meaning that the first Operation fromthe Operations Setup of the Instrumentitself is actually represented by thenumber three (3) because SartoCollectautomatically adds the “Start/Close’operation to the beginning of theInstrument Operations list for eachinstrument setup in the Method.For example, a Method has 2 instru-ment interfaces setup and each instru-ment setup has 3 operation commandsplus the “Start/Close’ operation in itsrun-time drop down menu on the float-ing toolbar:

To Execute the second instrument oper-ation of the 1st Instrument from thescript you would call *.DoCommand (4).

To Execute the second instrument oper-ation of the 2nd Instrument you wouldcall *.DoCommand(9).

LABTRONICSCOMMINSTR Library

The “LABTRONICSCOMMINSTRLib’ pro-vides for run-time access to SartoCol-lect’s embedded Instrument Managerinterfaces which receives Results or exe-cutes another layer of embedded VBAMacros contained within the instrumentinterface objects themselves and are ref-erenced by Index Number or Name.

For example: Call CommInstr.Opera-tions(“Get_Data”).Results(“Opera-tionData”), represents the parsed, ResultName “OperationData” from the“Get_Data” Operation.

82

Figure 7.4: Sax Editor: Referencing the LABTRONICSCOMMIN-STRLib Object Library

LABTRONICSCOMMINSTRLib Operations(“ ”).Execute: Since SartoCollect has its own processfor handling and executing operations,If the Operation that needs to be rundoes not have a Command String (i.e. is a Unidirectional Operation) or isan Operation with a Command Stringthat has been setup to do “Timed Col-lection’ the InterCollect “DoCom-mand(#)’ should be used instead of“Operations(“ ”).Execute”. Doing other-wise would Stop an already runningOperation and not update the run-timeToolbar or vice versa.

Affecting a Method’s InstrumentInterfaces and DataWithin the “OnDataReceived’ Section,data received by the Instrument Manag-er can first be passed into the VBAscript to apply some logic and thenreturn the same value(s) or a modifiedvalue(s).

Obtaining all parsed “Result Name’values from an Instruments Operation;

Example: An Instrument Operationcalled “Get_Data” parses out 2 numeri-cal values using the Numbers parser“N/YY/C/I” and adds them to the ResultNames “OperationData1’ and “Opera-tionData2’;

“{Get all Result Name data from theinstrument interface’s Operation whenit is received}

Dim comVars AsLABTRONICSCOMMINSTRLib.CommVariablesDim comOps AsLABTRONICSCOMMINSTRLib.CommOperationsDim comOp1 AsLABTRONICSCOMMINSTRLib.CommOperationSet comOps = CommInstr.OperationsSet comOp1 = comOps1("Get_Data") Set comVars = comOp1.Results

Dim n As StringDim p As Stringn = comVars("OperationData1").Value *10comVars("OperationData1").Value = np = comVars("OperationData2").Value *10comVars("OperationData1").Value = p

Obtaining a specific parsed “Result Name”values from an Instruments OperationExample: A Method has 2 Instrumentseach with 3 Operations (recall the Buttonand the Start/Close operation is the firstand second in the list for each instru-ment). The first Instrument’s Operationcalled “Get_Data” has 2 Result Namevalues called “OperationData1” and“OperationData2” but only the first oneneeds to be modified and based on itsresult decide whether or not to executethe 2nd Instruments 1st Operationcommand which would have an Indexnumber of 9 counting through the 1stInstruments 4 Operations plus the 2ndInstruments “Start/Close” operation;‘{Get the Result Name data from theInstrument interface}

Dim comVarsAsLABTRONICSCOMMINSTRLib.CommVariables

Dim comOps AsLABTRONICSCOMMINSTRLib.CommOperations

Dim comOp1 AsLABTRONICSCOMMINSTRLib.CommOperation

Set comOps = CommInstr.OperationsSet comOp1 = comOps1("Get_Data")Set comVars = comOp1.Results

Dim n As StringDim p As String

‘{Multiply the Result Name data by 10}

n = comVars("OperationData1").Value *10comVars("OperationData1").Value = n

‘{Execute the 2nd Instruments first Operation if the multiplied value is greater than 100}

If n >100 ThenCollectData.DoCommand(9)

83

Appendix AASCII Numbers

If your data is delimited by a particular keyboard printable character, you can type it directly into the parser. However, if the delimiter is non-print-able, you must enter the appropriate ASCII number within { } brackets. Please refer toChapter 6, “The Simple Parser” for further details. The hexadecimal equivalents (HEX #) are also shown.

ASCII # HEX # Common Delimiters Control Character0 00h (null) NUL1 01h SOH2 02h STX3 03h ETX4 04h EOT5 05h ENQ6 06h ACK7 07h (beep) BEL8 08h (backspace) BS9 09h (tab) HT10 0Ah (line feed) LF11 0Bh (home / hard return) VT12 0Ch (form feed / page break) FF13 0Dh (carriage return) CR14 0Eh (page / column break) SO15 0Fh SI16 10h DLE17 11h DC1

ASCII # HEX # Common Delimiters Control Character18 12h DC219 13h DC320 14h (paragraph marker ¶) DC421 15h NAK22 16h SYN23 17h ETB24 18h CAN25 19h EM26 1Ah SUB27 1Bh ESC28 1Ch (cursor right) FS29 1Dh (cursor left) GS30 1Eh (cursor up) RS31 1Fh (cursor down) US32 20h (space)

For your reference, additional ASCII and hexadecimal numbers are shown here.

84

Appendix BTroubleshooting

Problem:The software receives no data or thedata that is received consists of garbage(characters that don’t make sense).

Possible Solutions:The RS232 Communications Setup (see Figure 5.4) may not be correct. This usually results in data being cap-tured but the data does not make sense.There are some key communicationparameters associated with serial(RS232) communication that must bematched exactly between your instru-ment and the configuration in SartoCol-lect. In particular, if the Baud Rate, Data Bits, Stop Bits, and Parity are notmatched exactly between the instru-ment and SartoCollect serial data trans-fer will not work. This only applies touser-defined instruments. The parame-ters of the other instruments are presetto the values recommended by themanufacturer; check that no changeswere made to these settings.

The program may not be active. ExitSartoCollect, then try starting the pro-gram again.

The cable between the instrument andthe computer may be incorrect. This willusually result in no data being received. Try a different cable and confirm thatthe wiring is correct by contacting theinstrument manufacturer.

The instrument may not be sending the data. The instrument may need tobe set up differently or its RS232 port isnot functional. Try a different instru-ment, the simpler the better, to confirmthat the computer end is working properly.

The computer hardware, especially theRS232 port, may not be working. Checkthe COM Setup, preferably on a differ-ent computer.

85

Appendix CRS232 Cable Specifications

Instrument / Device Cable RequirementsMany instruments and devices that havean RS232 port only require a standard“straight-through” serial cable that canbe obtained at a local electronics store.Some instruments and devices however,do require a special pin configurationfor the cable which does not match thestandard cable pin-out. These pin con-figuration for your instrument or deviceare usually specified within the operat-ing manual and cables can be made orpurchased from the manufacturer tomatch the instrument or device pin-outrequirements.

!Plugging a cable into an instrument or device that has an incorrect pin configuration simply because the cableends “fit” could be harmful to thatinstrument or device. Verify with themanufacturer of the instrument ordevice, any specific cabling detailsrequired for its interface to a computeror other external device COM port.

86

Standard RS232 Pin Configurations (DTE Relative)

Signal DB-25 DB-9 EIA 561 Yost pin pin RJ45 8 pin RJ45 8 pin

Common Ground G 7 5 4 4,5Transmitted Data TD 2 3 6 3Received Data RD 3 2 5 6Data Terminal Ready DTR 20 4 3 2Data Set Ready DSR 6 6 1 7Request To Send RTS 4 7 8 1Clear To Send CTS 5 8 7 8Carrier Detect DCD 8 1 2 7Ring Indicator RI 22 9 1 -

DTE, data terminal equipment (computers, printers, etc.). DCE, data communicationequipment (modems). RJ45 was primarily defined for the connection of two DTE’s directly.

RS232 DB25 to DB9 Pin ConverterDB9 - DB25 Conversion Table

Pin NumberDB9 DB25 Function1 8 Data carrier detect2 3 Receive data3 2 Transmit data4 20 Data terminal ready5 7 Signal ground6 6 Data set ready7 4 Request to send8 5 Clear to send9 22 Ring indicator

RS232 Null Modem CablesA simple null modem cable crosses Pins2 and 3 between the cable’s DB9 orDB25 connector ends.

Connector 1 Connector 2 Function2 3 Rx Tx3 2 Tx Rx5 5 Signal

ground

RS232 Cable LengthThe maximum cable length for RS232 istypically 50 feet. However, lower baudrates, asynchronous communication andhigher quality cables could extend thissignificantly.

87

Index

Page

Adding a new instrument 59ASCII Numbers 84Assign to Menu 41Autostart 42

Baud Rate 36

Cell references 42Character delay 62Command delay 62Command string 8Communications Setup 23, 35,

60, 61Configuring a new instrument 57

Data Bits 36Date Macro 24Delimited 84Delimiter 18, 72,

75, 76

Expand 70, 71Expected value 68, 70Exporting 46, 48Exporting a Method 44Exporting an Instrument 48

Flow control 36, 61,64

Page

Importing 46Importing a Method 47Importing an Instrument 48Instrument Description 34, 51Instrument library 57Instrument manager 58Instrument SetupInstrument Type and Name 21, 22,

45Interval 41

Log file 37, 62

Macro 44, 59,64, 69

Macro setup 69, 70Method Description 12, 45,

47, 50Method Setup 19, 20,

30, 42,45

Multiple instruments 52, 54,56

Null processing 37, 62Numbers parser 73

Operation 8, 16Operation Setup in Instrument Setup 24, 66

88

Page

Parity 36Parser selector 72, 73Parser Syntax 72Parser types 72, 75Parser delimiter 75Position Parser Type 74Port Settings 16, 50Protocol 39, 60,

65

Raw data 68, 71RS232 collector 35, 60,

61RS232 collector setup 61RS232-TCP/IP collector setup 63

Saving the Instrument Setup 44Saving the Method Setup 44Saving the Workbook 53Sending Commands 27, 51,

54, 55,56

Sheet Destination 32Starting Cell 10Stop Bits 36String to transmit 38, 63

Page

Template Setup 21Test macro 70Test operation 68Testing the Instrument Setup 45Testing the communications 37, 62Time out 36, 61,

67Transaction logging 37, 62Transmit string 38, 63Troubleshooting 85

View Template 24, 42

Workbooks 12, 52

89

Printed in Germany on paper that hasbeen bleached without any use of chlorineW1A000 · KTPublication No.: WYS6065-e08021

Sartorius AGWeender Landstrasse 94–10837075 Goettingen, GermanyPhone +49.551.308.0Fax +49.551.308.3289www.sartorius-mechatronics.com

Copyright by Sartorius AG, Goettingen, Germany. All rights reserved. No part of this publication may be reprinted or translated in any form or by any means without the prior writtenpermission of Sartorius AG.The status of the information,specifications and illustrations in this manual is indicated by the date given below. Sartorius AG reserves the right to make changes to thetechnology, features,specifications and design of theequipment without notice.

Status: February 2008, Sartorius AG, Goettingen, Germany