Configure Transflo DMS Capture

Product Limitations and Assumptions

• TRANSFLO® Administration Tool and a corresponding database have been installed on the server or on servers in the same domain.

• Administration Tool must be installed on a server running Internet server software.

• A Capture Administrative User has been created with access to the Companies and Document Classes that will be used by the Capture application. This Administrator will be granted full rights to the Aliases and Queues that will be used by Capture.

• If you configure more than one company in the TRANSFLO® Administration Tool, the None authentication mode will not work with your TRANSFLO® Capture client installations.

In order for TRANSFLO® client applications to communicate with TRANSFLO® Server, the TRANSFLO® Client configuration application must be properly configured. If you are experiencing connection problems with TRANSFLO® Server, you should verify these settings.

To access the TRANSFLO® Client Configuration application and verify its settings:

1. Click the Windows Start button, point to Programs, point to TRANSFLO®, and click Client configuration.

2. The TRANSFLO® Client Configuration window appears.

To configure or verify settings:

• In the Web Service URL box, type the address of the TRANSFLO® Web service being used for communications with TRANSFLO® Server.

  The default address is shown in the above screen capture.

  Click Validate to ensure that the connection is active.

• If your TRANSFLO® Server installation requires authentication, select the Authenticated Access check box and type the appropriate user name and password in the boxes provided.

• If the local computer connects to the Internet via a proxy server, select the Use Proxy Server check box and type the proxy server address, connection port number, user name, and password in the boxes provided.

  When you have finished entering or verifying connection information, click Apply, and then click the Logging tab.

  3. On the Logging tab of the TRANSFLO® Client configuration window, enter or verify the logging settings that should be used for TRANSFLO® applications.

To enter or verify logging settings:

• Expand the Logging Level list and click the desired level of complexity for logged events.

• In the Days to keep box, enter the number of days that events should remain in the log before being erased.

  When you have finished configuring the logging settings for your TRANSFLO® client applications, click Apply to save your changes.

  When you have finished entering your logging settings, click Apply, and then click the Authentication tab.

4. If you would like to use TRANSFLO® authentication, on the Authentication tab of the TRANSFLO® Client Configuration window check the Store TRANSFLO® Authentication Information check box and enter a User Name and Password in the corresponding boxes.

When you have finished configuring your TRANSFLO® Client configuration, click OK.

For troubleshooting purposes you can temporarily override the Capture Log Level from the file system.

To override the log level:

1. Navigate to the Capture log folder. (This typically is:

C:\Program Files\Pegasus TransTech\Capture\Logs\Capture.)

2. Create a text file in the log folder and rename it to Log.Config.

3. Open the file with a text editor and add the following line to the file:

<Config LogLevel="[Level]" />

where,

[Level] is an integer between 0 and 4 indicating the log level.

The available log levels are:

0. - No Logging

1. - Errors Only

2. - Errors and Warnings

3. - Detailed

4. - Trace

   Example: For the log level to be set to Trace the entry in the Log.Config file will be: <Config LogLevel="4" />

4. Save and close the Log.Config file.

The log level has changed.

5. To disable this feature and revert to the configured log level, rename the Log.Config file to Log.Config.Old.

Note: This same procedure can be used to override the TRANSFLO® Client Log usually located in C:\Program Files\Common Files\Pegasus TransTech\Transflo Client\Logs\Transflo.ClientConfig.

The General tab is used to configure settings that define the appearance and navigation of the Capture User interface.

To configure this tab, follow the instructions below:

1. The Reject, Accept/Re-Index, and Pass buttons can be enabled or disabled for the Capture window. To enable the Reject button, select the Reject Button Visible check box. To disable the button, clear the check box.

2. In the same way, enable or disable the Accept/Re-Indexand Pass buttons by selecting or clearing the Accept/Reindex Button Visible and Pass Button Visible check boxes.

   By default, the Reject and Pass buttons are enabled and the Accept/Re-Index button is disabled.

3. Select the default zoom setting that should be used for document images displayed in the TRANSFLO® Capture window. Expand the Default Zoom list, and click a setting:

   • Fit Height - Re-sizes the image so that it fits the display area vertically. This is the default setting.

   • Fit Width - Re-sizes the image so that it fits the display area horizontally.

   • Fit Height and Width - Re-sizes the image so that it fits entirely within the display area.

4. By default, the following features are disabled. To enable one or more of these features, follow the sub-steps below:

   1. If the cursor should be automatically moved to the first empty required field when a new document appears in the TRANSFLO® Capture window, select the Tab Stop at First Empty Field check box.

   2. If the Windows Print dialog box should appear when a user clicks the Print button on the toolbar or clicks Print in the File menu, select the Use Printer Dialog check box. The Print dialog box allows the user to select a printer and modify print settings. If the dialog box is bypassed, the default printer and print settings for the local computer will be used.

   3. If a user should be able to e-mail the document batch being indexed in Capture, select the Email check box.

5. In the After indexing a document navigate to group, select one of the radio buttons.

   • If a user has Indexed a Document in the middle of a batch, and you want the next un-indexed Document to open, select the first un-indexed document radio button.

   • If a user has Indexed a Document in the middle of a batch, and you want to open the next Document, regardless of whether it was indexed or not, select the next document radio button.

     The default is first un-indexed document.

6. If you want a confirmation box to open before a batch is submitted, check the Confirm batch submission check box.

7. To disable the User’s ability to reorder the batch with the Make Current functionality, check the Disable documents reorder button.

8. When the Pass button is clicked in Capture, the Pass Confirmation dialog box appears, prompting the user to confirm that they want to pass the document image. Choices are Yes, No, and Clear.

   • If the Yes button is clicked, the image will be passed and values entered in any Fields will be preserved.

   • If the Clear button is clicked, the image will be passed and any entered values will be cleared.

     Select or clear the Clear Group Separator Values by Default on Pass check box depending on which button should be the default. By default, the check box is disabled.

     • If the Clear Group Separator Values by Default on Pass check box is selected, the Clear button will be the default button on the Pass Confirmation dialog box, allowing the user to simply press the Enter key to clear the values and pass the document image.

     • Conversely, if this check box is cleared, the Yes button will be the default button on the Pass Confirmation dialog box.

9. If a Capture User should be required to enter a note when he or she passes a document image, select the Require Note on Passing check box. If the user should not have to enter a note explaining why the document image was passed, clear the check box (the default setting).

10. To apply the sticky field rules configured on the Fields tab when your indexers pass a document check the Apply sticky fields when passing check box. If the document is passed and sticky is enabled for a field, Capture uses the previous accepted value for the next un-indexed document.

    Example: If 12345 is the accepted value from Document 1 and the current Document (Document 2) is passed, the next un-index Document (Document 3) will have the sticky value carries over from Document 1 as 12345.

    To disable the feature, clear the check box (the default setting).

11. The same business logic can be applied when a document is rejected. By default, this setting is enabled. To apply the sticky Field rules configured on the Fields tab when your indexers reject a Document check the Apply sticky fields when rejecting check box. If the Document is rejected and sticky is enabled for a Field, it will not use the previous accepted value for the next un-indexed Document.

    Example: If 12345 is the accepted value from Document 1 and the current Document (Document 2) is rejected, the next un-index Document (Document 3) will not have the sticky value carries over from Document 1 as 12345 but it has the value as <blank>.

    By default, the check box is enabled.

    Note: The Apply sticky fields when rejecting feature will only apply to Batch Fields and will not apply to the Document Type.

12. When you have finished configuring the General tab, click the Save button to apply your changes. (To exit without saving your changes, click the Cancel button.)

The Fields tab is used to configure the Field attributes of the currently selected document class alias.

The Fields that have been configured for the document class alias are listed in the Field Name column.

Check boxes and text boxes next to each Field name allow you to configure the attributes of that Field.

To configure any of the Fields, follow the instructions below:

1. To make the Field visible, select the check box in the Visible column.

To hide the Field, clear the check box.

Note: If you select any combination of check boxes in the following columns, the check box in the Visible column will be selected automatically: Tab Stop, Re- Enter, and Auto Tab.

The check box in the Visible column cannot be cleared until all of these other check boxes are first cleared.

2. To include the Field in the tabbing sequence in the Capture interface, select the check box in the Tab Stop column.

To remove the Field from the sequence, clear the check box.

If the Field is removed from the tabbing sequence, the user will have to click in the Field’s text box in order to enter a value.

3. If a Field is designated as Sticky,, it means that any value for the Field will be carried over from the previous indexed document until either the Group Separator (formerly known as the “newtrip” identifier) is encountered or the end of the batch is reached.

The exception to this is that if a Field already has a value, the previous value will not overwrite the existing value.

Designating a Field as Sticky aids productivity by not requiring a user to re-enter the same data for multiple document images.

To enable the Sticky attribute for the Field, select the check box in the Sticky column.

To disable the attribute, clear the check box.

Known Issue: Although the Capture - Index administration allows you to check Sticky on Group Separator Fields, Group Separator Fields should not be set to Sticky.

4. If a value was previously entered for the Field, and the User should be forced to manually re-enter a value, select the check box in the Re-Enter column.

If the user should not be forced to re-enter a value for the Field, clear the check box.

By default, the check box is cleared.

Note: If the Field also has the Sticky attribute enabled (see the previous step), the user will still have to manually re-enter the Field value if the user sets focus on the Field and then attempts to tab or click out of the Re-Enter field.

5. If a value must be entered for a Field before the document image can be indexed, select the check box in the Required column.

If the Field should not be required to have a value, clear the check box.

6. If the user should not be able to modify the Field’s value, select the check box in the Read Only column.

If the Field should be editable, clear the check box.

7. If the Field’s value should be cleared if a group separator is encountered, select the check box in the Clear on Group column.

If the Field’s value should not be cleared if a group separator is encountered, clear the check box.

Note: If the check box is selected and the user passes the document image and clicks the Clear button, the Field's value will retain the original value.

8. If the cursor should automatically tab ahead to the next Field once the user has completed the current Field, select the check box in the Auto Tab column.

Once the user has typed the number of characters specified in that Field’s mask, the cursor will move to the next available Field.

If the cursor should not move to the next Field automatically, clear the check box.

9. The Batch List window gives the user the ability to see document information about a batch, before selecting it for indexing.

This information can be displayed in a table that appears below the original batch row, if its tree view is expanded.

If the Field you are configuring should be displayed as a column in this special table, select the check box in the Process Specific Field column.

If the Field should not be displayed, clear the check box.

10. If the Field should have a static value, type that value in the text box in the Force Value column.

Any value entered here will override a previously entered value or a Sticky value in Capture.

However, if a Field’s value is retrieved from HEC, the HEC value will override the forced value.

By default, the box is blank.

11. If the Field should have a default value, type that value in the text box in the Default Value column.

If the Field does not already have a value in Capture, the Field will default to this value.

It can be overridden either by the user or by HEC.

By default, the box is blank.

12. When you have finished configuring all of the attributes for the Field, you can continue configuring the attributes of the remaining Fields if necessary.

When you have finished configuring the Fields tab, either click another tab to continue configuring Capture settings, or click the Save button to apply your changes.

To exit the tab without applying your changes, click the Cancel button.

Note: The Field name ID is reserved by the TRANSFLO® Server.

Ensure that none of your Fields are named ID.

Naming a Field “ID” will cause unexpected behavior when Capture is run in Process Specific mode.

The Field Order tab allows you to change the order the fields will display in Capture.

The Fields are listed in the Fields box.

To move a Field to a different place in the order, click it to select it, and then click the up or down arrow buttons, located to the right of the box, to move the Field to the desired position in the Field order.

Note: You cannot configure a Field Order for Fields that have not been configured on the Fields tab. The default sort order for Fields that have not been configured is alphabetic and not the Document Class Field order.

A group separator consists of a Field type, a trigger value, an action, and a value “stickiness” setting.

If Capture processes a document image containing the trigger value in the specified Field, it performs the action selected for the group separator and applies the stickiness option that was configured.

Note: A “sticky” Field is one whose value for the previous document image is used as the default value for the current document image if the Field is blank.

A group separator can be used to reject a document image, override a Field’s default stickiness setting, or both, if a specific Field is found to contain a specific value.

To add and configure a group separator, follow the instructions below:

1. To activate the group separator feature in Capture, select the Separators Enabled check box.

This check box serves as a master control switch for all group separators.

To later deactivate the group separator feature if necessary, clear the check box.

By default, the check box is disabled.

2. To add a group separator, click the Add button.

The group separator configuration interface appears on the Group Separator tab.

3. In the Field list, select the Field to which this group separator should apply.

Expand the list and click the name of the desired Field.

4. In the Value box, type the value that will act as the trigger for the group separator.

5. In the Action list, select the action that should occur if Capture encounters the above Field and value pair.

Expand the list and click the desired action.

The available actions are:

• Keep - The document image can be indexed normally and accepted.

• Reject After Indexing - The document image can be indexed, after which it is rejected.

• Reject Before Indexing - The document image is automatically rejected and cannot be indexed.

  The default action is Keep.

6. In the Stickiness list, select the stickiness setting that should be applied to the Field.

Expand the list and click the desired setting.

The available settings are:

• Force Default - The stickiness setting selected on the Fields tab is used.

• Force No-Sticky -The Field is made non-sticky, overriding the setting made on the Fields tab.

• Force Sticky - The Field is made sticky, overriding the setting made on the Fields tab.

  The default stickiness setting is Force Default.

  Note: If Keep was selected in the Action list and HEC is called by the Field, HEC will override any stickiness that has been applied to the Field.

7. When you have finished adding and configuring the group separator, click the Save button immediately adjacent to the group separator settings (as opposed to the button at the bottom of the tab).

If you do not wish to save the group separator configuration, click the Cancel button.

8. When you have finished configuring the group separator, you can add and configure additional group separators as necessary.

When you have finished configuring the Group Separator tab, either click another tab to continue configuring Capture settings, or click the Save button (at the bottom of the tab) to apply your changes and exit the Capture administration interface portion of TRANSFLO® Administration Tool.

To exit the tab without applying any changes that you have made, click the Cancel button.

Maintain Group Separators

Once you have created one or more group separators, they appear in a table on the Group Separator tab.

You can edit these group separators, reset their values to their default settings, or delete the group separators as needed.

• To edit a group separator, click it to select it, and then click the Edit button.

  Edit the group separator’s settings using the same instructions provided earlier in this section.

• To reset a group separator’s values to their default settings, click the group separator to select it, and then click the Reset button.

• To delete a group separator, click the group separator to select it, and then click the Delete button.

If desired, you can disable all group separators that have been configured.

To do this, clear the Separators Enabled check box.

The configured group separators are now hidden, but still exist and will reappear if the check box is selected again.

With the Separators Enabled check box cleared, you can bulk-reset the values of all existing group separators.

To do this, click the Reset button.

The Document Types tab is used to configure general settings for the Document Type area in the TRANSFLO® Capture window, as well as specific settings for each document type. The tab is divided into two areas: 

• the top area is used to configure the general settings.

• the scrolling table area below it is used to assign document-type-specific attributes.

Configure Global Document Type Settings

Global document type settings are configured in the area at the top of the Document Types tab.

To configure these settings:

1. If Capture Users should be able to tab to the Document Type area in the TRANSFLO® Capture window, select the Tab Stop check box.

If Users should instead be forced to click the appropriate document type in the area, clear the check box.

By default, the check box is selected.

2. If selecting a Document Type should cause the current document image to be automatically accepted, select the Auto Accept on Document Type Exit check box.

To disable this feature, disable the check box.

By default, this check box is disabled.

Select the Visible check box.

To hide the area, clear the check box.

By default, the check box is selected.

4. If theDocument Type area should be sticky, meaning that the document type selected for the previous document image should also be the default selection for the current document image, select the Sticky check box.

To disable this feature, clear the check box.

By default, the check box is cleared.

5. If a group separator is encountered, or the Clear button is clicked during validation of a document image being passed, the value in the Document Type area can be cleared.

To enable this feature select the Clear on Group Separator check box.

To disable the feature, clear the check box.

By default, this check box is cleared.

6. The document types listed in the Document Type area in the TRANSFLO® Capture window can be arranged either alphabetically or by assigned document type number.

The images below display the difference between these two settings.

Alphabetical:

Numerical:

To display an alphabetical listing, select Alpha option under Index Method.

To display a numerical listing, select the Numeric option.

The default option is Alpha.

Configure Individual Document Type Settings

In addition to the general settings described earlier in this section, there are also settings specific to each document type that can be configured.

A keyboard shortcut, or hot key, can be assigned to each document type, allowing the Capture User to select the appropriate document class with a single keystroke.

If a hot key is assigned, it can be enabled or disabled as necessary.

The document type itself can also be enabled or disabled from this interface.

To configure settings for an individual document type:

1. In the table on the Document Types tab, click the row of the document type whose settings you wish modify.

You may need to scroll through the list to find the desired document type.

With the document type selected, click the Edit button at the bottom of the table.

Note: If your Document Type list is extensive, you may need to scroll to the bottom of the list to find the Edit button.

The Document Types tab changes to display the configuration interface for the document type that you selected.

The document type abbreviation appears in the Document Type list box.

This box appears for information only and the list is not enabled.

2. To designate a hot key for the document type, first select the check boxes for the key combination (if any) of the special keys: [Ctrl], [Alt], or [Shift].

Next, expand the Key list and click the name of the desired keyboard key.

To remove a value from the Key list, click the Clear link.

3. After entering a hot key, you must enable it before it can be used in Capture.

To do this, select the Validation Bypass check box.

To disable an active document type hot key, clear the check box.

By default, the check box is cleared.

With a hot key configured and enabled, the Capture User can press the appropriate key to select a document type instead of clicking it in the Document Type area.

4. With or without a hot key, in order for the Capture User to be able to select the document class at all, it must be enabled for use so that it will appear in the Document Type area of the Capture interface.

To do this, select the Selected check box.

To disable a document type, so that it does not appear in the Capture interface, clear the check box.

5. As you configure the Document Types you can change their display order.

The Document Types are listed in the Display Order box.

To move a Document Type to a different place in the order, click it to select it, and then click the up or down arrow buttons, located to the right of the box, to move the Document Type to the desired position in the Document Type order.

6. When you have finished configuring the document type’s settings, click the Save button to record the new attributes and return to the original view of the Document Types tab.

To discard the changes click the Cancel button.

The Hot Keys tab is used to configure the navigational and image-orientation keystroke functionality provided in Capture.

To configure the Hot Keys tab:

1. To designate a hot key, first select the appropriate check boxes for the key combination (if any) of the special keys: [Ctrl], [Alt], or [Shift].

Next, expand the Key list and click the name of the desired keyboard key.

Important: Take care not to assign any hot key that is already in use.

To quickly delete a hot key setting from the Current Setting box, click the Clear link to the right of the box.

Hot key values can also be reset to their default values by clicking the Default link.

The default value for each function is displayed in the Default Setting column.

2. When you have finished configuring the Hot Key tab, either click another tab to continue configuring Capture settings, or click the Save button to apply your changes.

To exit the tab without applying the changes that you have made, click the Cancel button.

The Scripts tab allows you to configure VBScripts that can be launched from TRANSFLO® Capture during indexing.

To configure a script perform the following:

1. Click the Add button.

The script configuration page opens in the Scripts tab.

2. Select an event from the Event drop down.

The available events are HotKey, Accept, NewPage, and FieldLeave.

3. If you selected the Accept event, the script you enter in the Script text box will be executed when the user clicks the Accept button in Capture.

4. If you selected the NewPage event, the script you enter in the Script text box will be executed when new document opens in Capture.

5. If you selected the HotKey event you must specify which combination of keys will trigger the event.

You do this by checking a combination of the Ctrl, Alt, and Shift check boxes and a keyboard key form the Key drop-down list.

The script you enter in the Script text box will be executed when the user types the Hot Key combination in Capture.

Note: When selecting Hot Key events, do not use keyboard combinations that are used elsewhere in Capture, or that are used by the Windows® operating system.

6. If you selected the FieldLeave event, the script you enter in the Script text box will be executed when the focus moves off of any Field.

7. Enter your VBScript code in the Script box.

8. Repeat this process until all of your event/script combinations are configured.

You can only have one script for the Accept event and one script for the NewPage event.

You can have several Hot Key events for different keyboard key combinations.

Note:Accept Event and Field Leave scripts defined on the Scripts tab will run before Actions defined on the Hosts tab.

New Page Event scripts defined on the Scripts tab will run after Actions defined on the Hosts tab.

Available Script Objects

In addition to the standard VBScript methods and properties, Capture scripting exposes several script objects that can be included in your custom scripts.

Among other things, these script objects allow you to:

• Determine the Field name of the current Field,

• Get the value of a Field on the current Document, and

• Change the value of a Field on the current Document.

The Multiple tab is used to configure the ability to create multiple Documents based on different values for a specific Field.

When the Multiple feature is enabled, Capture will show a button labeled Multiple in the command button pane.

When the user is in the Field configured for Multiple and clicks the Multiple button, a pop-up box will open.

The user can add different values in the Field configured for Multiple, and a list of these values is created in the pop-up.

Once the Document is accepted, Capture will make a copy for each Multiple value entered.

Each copy will have the same Index values as the original except for the Field configured for Multiple.

The Field will have the corresponding value that was added to the Multiple pop-up.

To configure the Multiple tab:

1. To enable the Multiple feature check the Enable check box.

2. Select a Field that will accept multiple values from the Field drop down.

3. If you want the pop-up to be pre-populated with values from previous multiple values, select the Sticky check box.

4. Click the Save button to save you changes.

Click the Cancel button to discard you changes and close the Capture administration interface for the Alias.

As a developer, you can expand Capture functionality with exposed VB Script objects. This topic provides sample code to help explain what is required to create VB Scripts for TRANSFLO® Capture in the TRANSFLO® Administration Tool.

Scripting Events

All Scripting events are defined on the TRANSFLO® Administration Tool > Capture – Index > Scripts Tab for each Alias. These events correspond to actions performed by the Capture Client End-User or by the Capture Auto-Process feature.

It is a recommended practice to only define one script, for each scripting event per alias In Transflo DMS, an alias is a defined pointer or link to a subset or subclass of the fields and properties of a Transflo document class. An alias is essentially a copy of a document class. Creating multiple aliases for a document class allows you to have multiple instances of that document class. Aliases are used by Capture and Batch Scan. During imports, aliases map Gauss bases to workflows. By default, each document class that you create is automatically assigned an alias of the same name. You can edit the name and create more aliases. You can use an alias to configure fields, document types, and other parameters to customize the Capture application.. In that script all of the conditions for the event can be scripted.

TRANSFLO® Capture Scripting allows you to write scripts that run on the following events:

• HotKey

• Accept

• NewPage

• FieldLeave

 

HotKey

The HotKey event allows you to define a hot key combination. The HotKey event will fire whenever the hot key combination is pressed.

Accept

The Accept event fires when the Accept button is pressed.

The Accept event will fire before any HEC script.

This allows you to suppress the HEC script if needed.

NewPage

When you open a document In Transflo DMS, a document is an image file of a scanned page usually stored as a black and white TIFF image., any New Page HEC scripts run first followed by the NewPage scripting event.

FieldLeave

The FieldLeave event fires when an Index Field that has focus loses its focus. An example of this is when a user tabs out of an Index Field.

The FieldLeave event will fire before any HEC script. This allows you to suppress the HEC script if needed.

Scripting Objects

The following is a listing of the scripting objects that are available for Capture scripting:

Property List Property

Name	Description	Data Types	Possible Values
Set Value ([PropertyName], [Value])	If [PropertyName] is set to “BypassIndexValidation” and the [Value] is set to True, the HEC script for the event will not excecute. [Value] for “BypassIndexValidation” will remain set for all future events fired for the current Document. When the next Document loads, “BypassIndexValidation” will have its [Value] set to False (by default). If [PropertyName] is set to “CurrentFieldName”, the Field name that currently has focus is returned. You cannot use SetValue to change “CurrentFieldName”. "BypassValidation” if set to True will bypass for the current document any type of validation like Required Fields.	[Property Name]: String, [Value]: Boolean, or String	[Property Name]: “BypassIndexValidation” or “CurrentFieldName”, [Value]: True, False, or Index Field Name
Get Value ([PropertyName])	Gets the value of [PropertyName]. (Same as in PropertyList.SetValue.)	[Property Name]: String	[Property Name]: “BypassIndexValidation” or “CurrentFieldName”,

UI Script Object

Method	Description	Parameters	Returns
GetFieldValue	Returns the value of the Index Field FieldName for the current Document.	FieldName as string	String
SetFieldValue	Sets the value of the Index Field FieldName for the current Document.	FieldName as string, FieldValue as string	Void
GetFormHandle	Returns the Capture Main window handle.	hWnd as Integer	Integer
BypassValidation

WinAPI Script Object

Method	Description	Parameters	Returns
FindWindow †	This method is used to find an open window by its class name and caption. The className parameter holds the program’s class name. The windowName parameter holds the expected text in the window’s title bar (caption). If the window is found it will return the window’s handle, otherwise FindWindow will return 0.	className as String windowName as String	Integer
GetWindowText †	Returns the text in a window’s title bar. The hWnd parameter is the window’s handle.	hWnd as Integer	String

Method	Description	Parameters	Returns
FindWindowRegEx †	Same as FindWindow but finds a window with a caption that matches regular expression passed in the windowName parameter.	className as String windowName as String	Integer
SendMessage †	Sends a message to a window and waits until the message has been processed by the window. The hWnd parameter holds the window’s handle. The wMsg parameter contains the message ID that will be sent. The wParam and lParam hold additional data sent with the message that depend on the message Id.	hWnd as Integer wMsg as Integer wParam as Integer lParam as Integer	Integer
CopyMemory	Copies a block of memory from one location to another. The destination parameter contains a pointer to the starting address of the copied block, and the source parameter contains a pointer to the starting address of the block of memory to by copied. The length parameter specifies the number of bytes to copy.	destination as Integer source as Integer length as Integer	Void
SetForegroundWindow	Puts a specified window in the foreground and gives it focus. The hWnd parameter contains the window’s handle. The function returns True if it succeeds.	hWnd as Integer	Boolean
SendCopyData	Sends a WM_COPYDATA message to a window specified by the hWnd parameter. The dwData contains additional data put into dwData field of the COPYDATASTRUCT structure that is being send with the message. The data parameter holds the string that is being referenced by COPYDATASTRUCT structure.	hWnd as Integer dwData as Integer data as String	Integer

See Microsoft® Windows API documentation for details.

Examples

Example 1:

This basic example will get the value for the BILLTO Index Field. If the value in the BILLTO Index Field is equal to 11111, Then the BILLCODE, INVOICENO, DocType.

• The BypassIndexValidation property is set to True, so any HEC scripts that follow will be skipped for the current document.

  If the BypassIndexValidation property is set to False in a script that fires after this one on the current Document, HEC scripts run from that point forward.

Sub main()

fieldValue = UI.GetFieldValue("BILLTO") if fieldValue = "11111" then

UI.SetFieldValue "BILLCODE", "01234" UI.SetFieldValue "INVOICENO", "AAAAA"

UI.SetFieldValue "DocType", "TRP"

PropertyList.SetValue "BypassIndexValidation", True end if

end Sub

Example 2:

This example is for the FieldLeave event. This script gets the current Index Field’s name.

If the Index Field’s name is BILLTO, it will get the Index Field’s value. If this value is 11111, then the values for BILLCODE, BATCHID, SHIPPERNO, INVOICENO, INVOICE1, and DocType Index Fields are set.

Lastly the BypassIndexValidation property will be set to False which will suppress HEC calls until BypassIndexValidation is set to False on the current Document or a new Document is open.

Sub main()

currentFieldName = PropertyList.GetValue("CurrentFieldName") if currentFieldName = "BILLTO" then

currentFieldValue = UI.GetFieldValue(currentFieldName) if currentFieldValue = "11111" then

'MsgBox "Running Script before Leaving Field " & currentFieldName UI.SetFieldValue "BILLCODE", "01234"

UI.SetFieldValue "BATCHID", "AAAAA" UI.SetFieldValue "SHIPPERNO", "SSSSS" UI.SetFieldValue "INVOICENO", "INVOICE1"

UI.SetFieldValue "DocType", "TRP"

PropertyList.SetValue "BypassIndexValidation", True end if

end if end sub

Example 3:

This example is used in conjunction with open TMW windows. It searches for one of three possible TMW windows by the window caption with the regular expression Billing Desk.*

• If it finds a window it gets the value for the Order Number field and writes it to the TMW window and gives it focus.

• If none of the specified TMW windows are found a message box alerts the user.

Sub Main 'MsgBox "F2"

sCaption = "Billing Desk.*"

' call findwindow with various class definitions used by TMWSuite hWnd = WinAPI.FindWindowRegEx("FNWND370", sCaption)

If hWnd = 0 Then

hWnd = WinAPI.FindWindowRegEx("FNWND3105", sCaption) End If

If hWnd = 0 Then

hWnd = WinAPI.FindWindowRegEx("FNWND3110", sCaption) End If

If hWnd > 0 Then

orderNumber = UI.GetFieldValue("Order Number") WinAPI.SendCopyData hWnd, 700, orderNumber WinAPI.SetForegroundWindow hWnd

Else

MsgBox sCaption & " is not currently running." End If

End Sub