The FileNet connector is a DMS connector developed by
How it works
The connector supports the delivery of documents with the use of user-defined job properties and a rule that is specified in the Server Administrator.
Note: The configuration should be completed by experienced
Before you begin
Administrators must complete the following tasks.
Setting up FileNet connector
You can set up the FileNet connector by using Connectors in the Server Administrator.
To set up FileNet connector
-
Start the Server Administrator.
-
Right-click Connectors. The Connectors shortcut menu appears.
-
Select New AccuRoute connector. The Connector type list appears.
-
Select FileNet. The FileNet and DMS Configuration dialog box appears.
See the FileNet and DMS Configuration dialog box example below.
-
Specify the following parameters in the appropriate boxes.
-
Content Engine URI – FileNet installation web address
-
Domain – Hierarchical element where the connector will deliver to
-
Username – FileNet Administrator username
-
Password – FileNet Administrator password
-
-
Select Allow secure connection to server with invalid certificate only; for example, Self-signed certificates and useful for testing purposes.
-
Select Finish.
Note: For security reasons, it is recommended that you do not select this option.
Expand to view more information.
Creating user-defined job properties
Job properties are system or user-defined attributes that you can apply to your company's capture, process, and delivery workflows referred to as jobs. You can create job properties by using Configuration > Job Properties in the Server Administrator.
You must create the following job properties. Contact
-
ObjectStore
-
DocumentClassName
-
FolderPath (optional)
Note: These properties are case-sensitive and must be created for every FileNet installation.
The job properties will be text. Keep the defaults as is and specify the appropriate names for the user-defined job properties listed above.
To create a user-defined job property
-
Start the Server Administrator.
-
Expand Configuration.
-
Select Job Properties. The Job Properties details pane appears.
-
Right-click User. The Job Properties shortcut menu appears.
-
Select New > Job Property.
-
Specify the job property name; for example, ObjectStore in the Name box.
-
Select OK.
Repeat Steps 4 through 7 until you are done.
Metadata user-defined job properties
Every FileNet installation has a document class that contains metadata field definitions saved with a document. If Administrators want the FileNet connector to apply data to the metadata fields, they must create user-defined job properties for the metadata fields. FileNet Content Manager may display user-friendly names for the metadata fields, but symbolic names must be used to create the job properties in the Server Administrator. Metadata user-defined job properties are also case-sensitive.
Use the steps listed above to create the metadata user-defined job properties.
See the FileNet metadata field definition CaseID example below.
Note: You must use the name that appears in the Symbolic Name box when creating metadata job properties in the Server Administrator.
The FileNet connector only supports the following metadata types.
-
Boolean
-
Date/Time
-
Float (Decimal number)
-
Integer
-
String
Setting up a rule
A Routing Rule functions like a dispatcher telling a message where to go. It matches specific criteria with an action like sending messages to different connectors, splitting attachments, merging attachments, converting one file format to another, and more.
A rule is required to deliver documents to the FileNet connector. You can create rules by using RuleSets in the Server Administrator.
To create a rule to route documents to the FileNet connector
-
Start the Server Administrator
-
Expand RuleSets.
-
Right-click User. The RuleSets shortcut menu appears.
-
Select New > Route to Connector. The Criteria dialog box appears.
-
Specify the appropriate filenet@filenet.com email address in the Matches box.
-
Select Next.
-
Select FileNet on the Server on the Connector drop-down list.
-
Select Next.
-
Select Finish.
To add the user-defined and metadata job properties to the rule
-
Select RuleSets, if necessary.
-
Select User, if necessary. The RuleSets details pane appears.
-
Select the FileNet connector rule.
-
Select the Actions tab. The Actions > Route to Connector tree appears.
-
Select Start Workflow.
-
Select the Properties button. The Actions Properties dialog box appears.
-
Select the Job Properties tab.
-
Select the Add button. The Set Job Property dialog box appears.
-
Type the job property name in the Property box or use the Ellipsis (…) button to search.
-
Ensure the job property is selected.
-
Specify the appropriate FileNet Content Manager environment value in the Value box.
12. Select OK on the Set Job Property dialog box. The job property appears in the Job Property/Value table.
13. Repeat Steps 8 through 11 until you are done.
14. Select OK on the Action Properties dialog box.
15. Select OK on the Rule Properties dialog box.
The ObjectStore, DocumentClassName user-defined job properties must be added to the FileNet connector rule and your FileNet metadata fields using the symbolic names.
ObjectStore and DocumentClassName must be set to the following values.
-
ObjectStore – ObjectStore name where the DocumentClass is defined in the FileNet Content Manager environment.
-
DocumentClassName - DocumentClass name used for document delivery defined in the FileNet Content Manager environment.
Note: FolderPath is optional. If this property is not set or left blank, the FileNet connector will deliver documents to the DocumentClassName default repository. If the FolderPath property is set, the FileNet connector will deliver documents to the FolderPath specified in FileNet Content Manager.
More about the metadata user-defined job properties
The FileNet connector queries FileNet Content Manager for the metadata field names and determines which data types need to be imported.
See example below.
This example shows a Document class named MyDocument with the following metadata fields defined in FileNet Content Manager.
-
Metadata Field CaseID – Integer
-
Metadata Field A – Boolean
-
Metadata Field B – Date/Time
-
Metadata Field C – Float
-
Metadata Field D – String
The metadata fields in the example above are hard-coded, but the values can be substituted with variables. For example, the Integer value can be substituted with a pre-defined variable
See the Set Job Property > Value dialog box example below.
Note: Delivery failures may occur if the rule, job properties, and metadata values are not set up correctly. Contact
See also