Source Systems

Part III: Environment Items > Source Systems > Registry Settings for the XTRAC Viewer > Creating a Source System

Source Systems

A source system is the repository that Workbench operators can use to store and view documents, annotations, and images that are attached to work items.

You can use source system functionality to integrate an application with an XTRAC workflow. For example, you can integrate the XTRAC Viewer with XTRAC. An operator can then view and attach documents to an XTRAC work item in a specified repository. They can also view images of different file types.

To avoid possible security threats or viruses, you can use the File Types tab on the Source System Detail window to control the types of files that an XTRAC Workbench operator can attach to a work item and upload to the document repository.

WARNING: If you do not select any file types in the Source System Detail (File Types Tab) window, operators in XTRAC Workbench can upload all file types to the document repository.

Creating a Source System

You need to specify the details of your repository before operators in Workbench can use that repository.

Note: To define a source system, you need the Create and Source System security functions as part of the security group that is associated with your entitlement set.

To create a source system

In Feature Explorer, click Environment > Source Systems.
In the Source System Summary window, click New.
In the Source System Detail (General Tab) window, in the Name field, type a name for the source system (up to 30 characters).
In the Description field, type a description for the system (up to 60 characters).
In the Connection field, type the connection information (up to 256 characters).
Check the check boxes for the features that you want to allow Workbench operators to use.
Specify the minimum and maximum file sizes allowed for the specified repository.
Provide any of the other details for the repository, such as the URL, its type, and the location of the attachment folder.
(Optional) In the Change Request ID field, type the ID for the change request (up to 30 characters).
(Optional) In the Memo field, type the reason for creating the source system (up to 60 characters).
Click Save.

XTRAC saves the new source system and lists in the Source System Summary window.

Associating the Source System with a Node

For an operator to view images that are attached to a work item, their default working node must have a source system associated with it.

Note: To associate a source system with a node, you need the Create and Node security functions as part of the security group that is associated with your entitlement set.

To associate a source system with a node

In Feature Explorer, click Environment > Nodes.
In the Node Summary window, click Open.
In the Node Detail window, click the Source tab.

Note: You can also associate a source system when you are creating a new node.

In the Source tab, click Add.
In the Select Source Systems window, select one or more source systems, and then click OK.

XTRAC adds the Source Systems section to the Source tab.
In the Operator and Password fields, type the user name and password to use to log in to the source system.

You need to specify these fields if you want operators in Workbench to be able to access the source of the image. These two fields are used to log into the server and to invoke the viewer. The viewer then retrieves the image. These fields are case sensitive.

There is no length limit on these fields.

(Optional) In the Change Request ID field, type the ID for the change request (up to 30 characters).
(Optional) In the Memo field, type the reason for associating a source system (up to 60 characters).
Click Save.

XTRAC saves the source system association.

Registry Settings for the XTRAC Viewer

IMPORTANT: This functionality applies only to Work Manager, not to Workbench.

The XTRAC Viewer uses the registry setting on each desktop to figure out how to behave. You can find the registry settings under the following directory structure:

HKEY_CURRENT_USER\Software\VB and VBA Program Settings\DOCATT

Under the DOCATT directory, the following subdirectories exist:

AddDocument
See AddDocument
DDE
See DDE
DEBUG
See Debug
FileNet CS
See Source Systems
FileNet IS
See Source Systems
Images
See Images

In addition, the following registry settings exist:

FIMS
See FIMS
Override
See Override
Failover
See Failover
Location/Size
See Location/Size Settings

AddDocument

The AddDocument registry section contains the following keys. For more information, see the FileNet documentation.

Key	Description
System	When an operator saves a document from a local file system using File > Save, the System key communicates with the XTRAC Viewer. It specifies whether the document is saved in FileNet's image management server (IS) or FileNet's content management server (CS). Key values that are stored in the FileNet CS determine the section of the FileNet CS that documents are saved in.
LocalDefaultDir	When an operator opens a document from a local file system using File > Open Existing Document > From Local Drives, the LocalDefaultDir key value represents the first folder that the operator sees when the Open window displays. The operator can use this folder to accumulate all of the local documents that are attached to XTRAC work items. Note: Before the XTRAC Viewer can open email attachments, they must be saved as local files.
DocClass	When an operator saves a document to the FileNet system (whether CS or IS), the DocClass key value determines the document class to save the document to. This is a FileNet requirement. Two major attributes of a document class are security and user-defined indexes or properties. The system administrator sets up this document class on the server. The XTRAC Viewer operator only needs to know what values to type for user-defined index or properties if the selected document class uses these attributes. The following rules apply when you use the DocClass key: If the DocClass key is left empty, the XTRAC Viewer automatically shows the XTRAC Viewer - Add Document window that includes a complete list of document classes that the operator has accessed. If the DocClass key has a valid value and the Folder key also has a valid value, the XTRAC Viewer > Add Document window does not display to the operator. If the system administrator sets up the document class so that user-defined indexes are required, a message displays to the operator that required properties must be filled under the DocAttachment class and prompts them if they want to use a wizard to help fill the properties. Note: This message does not appear if the selected document class has no required user-defined indexes or properties. For example, with CS, the General document class gets installed out-of-the-box without any user-defined indexes or properties.
Folder	The Folder key determines the folder that the XTRAC Viewer saves the document in. Folders help operators to locate documents. The same document can be stored in several different folders and subfolders. Folders also can contain documents that belong to different document classes. The following rules apply when you use the Folder key: If the Folder key value is empty, the XTRAC Viewer > Add Document window displays to the operator and the operator determines whether to save the document into what folder (if any). If the registry contains valid values for the folder name and document class, the XTRAC Viewer > Add Document window does not display to the operator.
IndexingUI	The value of 1, true, or yes always opens the wizard interface when the operator clicks File > Save to save a document to FileNet. A value of 0 means that the wizard won't open. However, if the selected document class has required properties, the wizard opens even if the value is 0. Otherwise, FileNet does not save the document.

DDE

The DDE registry section contains the following keys:

Key	Description
External. . .	The first four keys that start with External describe how an external application, such as XTRAC, exposes its DDE functionality to the XTRAC Viewer. See the XTRAC Programmers Guide.
Link Topic	One of the two strings that XTRAC needs to establish the DDE connection with the XTRAC Viewer. XTRAC determines the other string, the DDE Service, from the name of the XTRAC executable (without the extension). These two strings let XTRAC successfully connect DDE to the XTRAC Viewer without doing any DDE work.

Debug

Debug contains only the Trace key, which has the following values:

0: Turns debugging off.
1: Turns debugging on. Setting the value to 1 writes the debug.txt file to the same directory where the XTRAC Viewer executable resides. This file helps reveal how XTRAC communicates internally with the XTRAC Viewer by using the command-line argument (CLA) and DDE strings. For example:

FileNet CS

The FileNet CS registry section contains the following keys:

Key	Description
AllowExtendedCheckOut	0 or 1. Usually, it is set to 0, which forces the operator to check the document back in or cancel the checkout before being able to work with another XTRAC work item.
CheckOutDir	Not required. It represents the location on the operator’s machine where a document the operator is working on is checked out from a FileNet CS system. The XTRAC Viewer automatically enables or disables this item depending on the type of document. The XTRAC Viewer also checks if the operator can check out the document.
Host and System	Required. They describe the FileNet CS system that the XTRAC Viewer is configured to work with by default.
Group	Because a CS operator can belong to multiple groups with different securities, the Group key specifies the specific access group to use at login. If the Group key is empty, the CS server automatically uses the default group for the operator.

FileNet IS

The value of FileNet IS is the default IS system with which the XTRAC Viewer is configured to work. Both Domain and Organization are required fields.

Images

The Images registry section contains the following keys: DefaultShowAnnotations and DefaultShowThumbnails. When an operator opens an image document in the XTRAC Viewer, these keys determine whether or not to show annotations and thumbnails by default.

FIMS

IMPORTANT: Except for the Cache Directory key, all other keys are used only if there are changes to the FIMS interface. If you modify the following keys, the XTRAC Viewer does not work with FIMS:

Key	Description
Cache Directory	The location to put FIMS images. If not specified, the program creates a directory named cache under the application directory.
RetrievalServiceName	The name of the FIMS image retrieval service. If not specified, the program uses `fimsRetrievalService`.
SoapAction	The value of the SoapAction element that communicates with FIMS image services. If not specified, the program uses `http://TestAttachments/Test`.
SecurityNS	The value of an element that communicates with FIMS image retrieval service. If not specified, the program uses `http://schema.xmlsoap.org/ws/2002/xx/secext`.
FimsNS	The value of an element that communicates with FIMS image retrieval service. If not specified, the program uses `http://schemas.xmlsoap.org/ws/2002/07/utility.`
RetDocLoc	The value of an element that communicates with FIMS image retrieval service. If this is not specified, the program uses `http://fims.fmr.com/ns/fimsRetrievalService.`
AnnotationServiceName	The name of the FIMS image annotation service. If not specified, the program uses `fimsAnnotationService.`
AnnotDocLoc	The value of an element that communicates with FIMS image annotation service. If not specified, the program uses `http://fims.fmr.com/ns/fimsAnnotation.`
ImageKey	The value of an element that communicates with FIMS image retrieval and annotation services. If not specified, the program uses `images`.
AnnotKey	The value of an element that communicates with FIMS image annotation service. If not specified, the program uses `annotations`.

Override

Override lets you use more than one FileNet server. If the Enable Override value is set to 1 to enable it, the XTRAC Viewer ignores the connection information that XTRAC sent and uses the connection information from the registry to open the document.

Note: Override affects the documents that an operator accesses through the XTRAC Sources window only. If an operator attempts to access a document directly from the XTRAC Viewer by clicking File > Open Existing Document, the override is ignored.

The Override registry section contains the following keys:

Keys	Description
Enable Override	The XTRAC Viewer ignores the connection information that was sent from the work item client and uses the connection information that is stored here. Possible values are 1 and 0. The default value is 0.
IMS Domain	The domain information for a FileNet image system. For example, FI_FISC_SLC.
IMS Organization	The organization information for a FileNet image system. For example, FileNet.
DMS Host	The host information for a FileNet document management system. For example, winterstick.
DMS System	The system information for a FileNet document management system. For example, dslib.

Failover

If XTRAC is unable to access the primary system and load the document, it attempts to log in to the failover system and load the document. XTRAC does not attempt failover if it is able to accomplish the following tasks:

Log into the system but cannot retrieve the document from the system.
Access the system but cannot log in.

It takes time to determine that a system is not accessible. Therefore, after the system fails over to the secondary system, it continues to use the secondary system when attempting to open documents.

To reset access to the primary system, shut down the XTRAC Viewer and restart it. It is not necessary to restart XTRAC Work Item.

Note: Failover affects that documents that an operator accesses through the XTRAC Sources window only. If an operator attempts to access a document directly from the XTRAC Viewer by clicking File > Open Existing Document, the secondary system is ignored.

The Failover registry section contains the following keys:

Key	Description
Enable IMS Failover	If the XTRAC Viewer is unable to retrieve the document, it attempts failover for image servers. Possible values are 1 and 0. The default value is 0.
IMS Domain	The domain information for a FileNet image system. For example, FI_FISC_SLC.
IMS Organization	The organization information for a FileNet image system. For example, FileNet.
Enable DMS Failover	If the XTRAC Viewer is unable to retrieve the document, it attempts failover for document servers. Possible values are 1 and 0. The default value is 0.
DMS Host	The host information for a FileNet document management system. For example, winterstick.
DMS System	The system information for a FileNet document management system. For example, dslib.

Location/Size Settings

The Location/Size Settings lets XTRAC keep track of how the operator sizes the XTRAC Viewer window and where they position it on the screen. XTRAC retains these settings from session to session.

The Settings registry section contains the following keys. Each setting is updated when XTRAC Viewer closes.

Key	Description
ViewerHeight	The height of XTRAC Viewer. The default value is 10000.
ViewerLeft	The left position of XTRAC Viewer. The default value is 3990.
ViewerTop	The top position of XTRAC Viewer. The default value is 0.
ViewerWidth	The width of XTRAC Viewer. The default value is 8500.