About Intelligent Capture Connector

Using both Outbound and Inbound connectors, Administrators can configure a use case where documents are captured in AccuRoute and sent to IC via the Outbound connector for image processing then sent back to AccuRoute via the Inbound connector for delivery of the document to a network file share folder on the server.

Note: This is a simple use case where documents in color are converted to black and white known as binarize. There are other use case scenarios that can be configured by an Administrator to meet a company’s document workflow requirements. The description of the use case, details and instructions below are used for illustrative purposes and may not reflect your unique workflow requirements.

 

Before you begin

You will need a IC Administrator account username, password, and a predefined workflow to set up the IC Outbound connector.

Administrators must complete the following tasks.

• Get a IC Tenant license with an associated page count and Administrator account. Contact your Account Manager for more information.

• Create a IC workflow for Outbound connector use.

Setting up the IC Outbound connector

You can set up the IC Outbound connector by using Connectors in the Server Administrator. Use the IC Outbound connector to send documents and metadata associated with IC-defined workflows in a one-way direction. A IC Outbound connector can only be linked to a single workflow.

Note: Multiple outbound connectors can be configured to support multiple workflows. One outbound connector per workflow is required.

To set up the IC Outbound connector

1. Start the Server Administrator.

2. Right-click Connectors. The Connectors shortcut menu appears.

3. Select New AccuRoute connector > IC Outbound. The Create New IC Outbound Connector wizard appears.

4. Use the default Message Server setting or specify the Remote Server parameters if necessary.

5. Select Next.

6. Use the default connector name or specify a new one in the Name box.

7. Select Next.

8. Specify the IC Administrator account username and password.

9. Select Next.

10. Select Finish. The IC Outbound connector appears in the Connectors details pane as enabled.

Linking a IC workflow to the IC Outbound connector

Use the IC Outbound on the Server Properties dialog box to link a workflow to the connector.

To link a workflow

1. Select IC Outbound on the Server in the details pane. The IC Outbound on the Server Properties dialog box appears.

2. Select the IC Configuration tab.

See the IC Outbound on the Server Properties dialog box example below.

3. Select the appropriate workflow from the Workflow drop-down list.

4. Select OK.

Setting up a IC Outbound connector rule

A rule must be created to route AccuRoute jobs to the IC Outbound connector. You can use RuleSets in the Server Administrator to create rules. In this example, the rule activates an email destination that is used to route documents to the IC Outbound connector.

To set up a Route to Connector rule

1. Start the Server Administrator.

2. Select RuleSets.

3. Right-click User.

4. Select New > Route to Connector. The RuleSets wizard appears.

5. Ensure Email is selected as the Destination type.

6. Type an email address, for example, outbound@ic.com in the Matches box.

Note: AccuRoute Desktop users must specify an email address format. Non-AccuRoute Desktop users are not required to use an email address format when using email as a destination type in a rule.

7. Select Next.

8. Select IC Outbound on the Server from the Connector drop-down list.

9. Select a format, for example, PDF, from the Format drop-down list.

Note: Any format can be used except for Deliver Original Format. The job will fail if set to the default, Deliver Original Format.

10. Use the default Include Template setting or select Never on the Include Template drop-down list if you do not want to include a routing or cover sheet with your documents.

11. Select Next. The rule and details appear in the Rule Name box.

12. Select Finish. The rule appears in the RuleSets details pane.

13. Continue with Adding metadata to a document.

Adding metadata to a document

You can add metadata to a document by using Rule Properties > Actions. For example, you can use the DeliveredDocumentName property to add a fixed filename without an extension to a document. All documents sent to IC will have the same filename. Server Administrator job properties and IC data fields must be created with the same name before any metadata can be applied. Display names are not to be used.

To add metadata

1. Start the Server Administrator.

2. Select RuleSets > User.

3. Select the appropriate rule, for example, if email is outbound@ic.com.... The Rule Properties dialog box appears.

4. Select the Actions tab.

5. Select Start Workflow on the Actions tree. The Action Properties dialog box appears.

6. Select the Job Properties tab.

7. Select Add. The Set Job Property dialog box appears.

8. Type DeliveredDocumentName or use the Ellipsis (….) button in the Property box.

9. Type a filename in the Value box, for example, From_Server_LCR_Document.

10. Select OK on the Set Job Property dialog box.

Note: In this example, all document filenames sent to IC are overwritten with the fixed filename specified in the Value box.

11. Select OK on the Actions Properties dialog box.

12. Select OK on the Rule Properties dialog box.

Note: IC will merge multiple documents from the same job into a single PDF as they are received from the Outbound connector.

 

You can set up the IC Inbound connector by using Connectors in the Server Administrator. Use the IC Inbound connector to retrieve documents and metadata from a IC workflow for delivery to a AccuRoute related destination, for example, a network folder.

How it works

The workflow must have an API step. It represents the queue where work items are collected. The Inbound connector will monitor the queue and take jobs from it for processing on the AccuRoute server. The Inbound connector will advance the work item to the next step in the workflow after successful completion of the API step. In this example, the Outbound and Inbound connectors use the same Image Processing workflow to send and receive documents to and from IC.

See the IC Image Processing Binarize workflow with API step, PickupByServer example below.

Before you begin

You will need a IC Administrator account username and password and a workflow with an API step to set up the IC Inbound connector.

Administrators must complete the following tasks.

• Get a IC Tenant license with an associated page count and Administrator account. Contact your Account Manager for more information.

• Create a IC workflow with an API step for Inbound connector use.

To set up the Inbound connector

1. Start the Server Administrator.

2. Right-click Connectors. The Connectors shortcut menu appears.

3. Select New AccuRoute connector > IC Inbound. The Create New IC Inbound Connector wizard appears.

4. Use the default Message Server setting or specify the Remote Server parameters if necessary.

5. Select Next.

6. Use the default connector name or specify a new one in the Name box.

7. Select Next.

8. Specify the IC Administrator account username and password.

9. Select Next.

10. Select Finish. The IC Inbound connector appears in the Connectors details pane as enabled.

Linking a IC workflow and export queue to the IC Inbound connector

Use the IC Inbound on the Server Properties dialog box to link a workflow and export queue to the connector. The workflow and export queue parameters indicate to the Inbound connector which workflow and api step to monitor for incoming jobs.

To link a workflow and export queue

1. Select IC Inbound on the Server in the details pane. The IC Inbound on the Server Properties dialog box appears.

2. Select the IC Configuration tab.

3. Select the appropriate workflow from the Workflow drop-down list.

4. Select the appropriate export queue from the Export Queue drop-down list.

See the IC Inbound on the Server Properties dialog box example below.

5. Select OK.

Setting up a IC Inbound connector rule

A rule must be created to route jobs from IC to the appropriate server-related destination. The rule lets the Inbound connector know what to do with the jobs it retrieves from IC. You can use RuleSets in the Server Administrator to create rules.

Note: The rule can be set up to fulfill any use case requirement.

To set up a Route to Connector rule

1. Start the Server Administrator.

2. Select RuleSets.

3. Right-click User.

4. Select New > Route to Connector. The RuleSets wizard appears.

5. Ensure Email is selected as the Destination type.

6. Type an email address, for example, pickupbyserver in the Matches box.

Note: In this example, the name of the export queue (api step) must be used as an email address to initiate the rule. The exact name of the IC export queue selected from the Export Queue drop-down list must match the email address specified in the Matches box. See Linking a IC workflow and export queue to the IC Inbound connector for more information.

7. Select Next.

8. Select Filescan on the Server from the Connector drop-down list.

9. Select a format, for example, PDF, from the Format drop-down list.

10. Use the default Include Template setting or select Never on the Include Template drop-down list if you do not want to include a routing or cover sheet with your documents.

11. Select Override Destination.

12. Type a destination, for example, c:\dtemp\from_ic in the Override Destination box.

13. Select Next. The rule and details appear in the Rule Name box.

14. Select Finish. The rule appears in the RuleSets details pane.

15. Continue with Adding metadata to a document.

Adding metadata to a document

You can add metadata to a document by using Rule Properties > Actions. Data fields in IC and job properties in AccuRoute must be predefined and created with the same name. The actual name of the data field and job property is used as the document’s metadata not the display name.

Note: Data fields are created in IC by using the data dictionary. Data properties are created by using job properties in AccuRoute. Data fields and job properties must be created before adding metadata to a document.

For example, you can use the DeliveredDocumentName property to add a fixed filename without an extension to a document. All documents sent to the server will have the same filename.

To add metadata

1. In the Server Administrator, select RuleSets > User.

2. Select the appropriate rule, for example, if email is pickupbyserver…. The Rule Properties dialog box appears.

3. Select the Actions tab.

4. Select Deliver on the Actions tree. The Action Properties dialog box appears.

5. Select the Job Properties tab.

6. Select Add. The Set Job Property dialog box appears.

7. Type DeliveredDocumentName or use the Ellipsis (….) button in the Property box.

8. Type a filename in the Value box, for example, From_IC_LCR_Document.

9. Select OK on the Set Job Property dialog box.

Note: In this example, all document filenames sent to the server are overwritten with the fixed filename specified in the Value box.

10. Select OK on the Actions Properties dialog box.

11. Select OK on the Rule Properties dialog box.

Note: Server Administrator job properties and IC data fields must be created with the same name before any metadata can be applied. Display names are not to be used.

 

Outbound Connector Only

From WebApps

To test the Outbound connector you will need to disable the Inbound connector temporarily in the Server Administrator to view the processed work item details.

Note: Use the In Process and History folders to track the processing and delivery of the documents in the Server Administrator.

1. Start WebApps from your browser.

2. Create a distribution.

3. Add a destination using an email destination type to outbound@ic.com.

4. Specify a subject.

5. Add the attachments.

Note: Ensure the test documents are in color. The workflow will convert the documents to black and white. See Create Distributions for more information.

6. Specify comments.

7. Save the distribution and name it.

8. Select Send.

From IC

To view the work item details for the documents sent, sign into IC. Verify that all parameters set on the Outbound connector, rule, and metadata were processed successfully.

1. In IC, select Work Items.

2. Specify your Search parameters if necessary.

3. Expand the appropriate work item by using the Expand/Collapse arrow. The Work Item details appear.

See the LCR Image Processing Workflow work Item details example below.

See the LCR Image Processing Workflow data fields details example below.

Note: These data fields are helpful when troubleshooting jobs sent from the server by the Outbound connector. See Adding troubleshooting metadata for more information.

The IC journal is similar to the Server Administrator journal. It provides you with status-related details about the workflow/job.

See the LCR Image Processing Workflow journal details example below.

 

Both Outbound and Inbound Connectors

From WebApps

To test the connectors you will need to enable the Inbound connector in the Server Administrator to view the processed work item details.

Note: Use the In Process and History folders to track the processing and delivery of the documents in the Server Administrator.

1. Start WebApps from your browser.

2. Create a distribution.

3. Add a destination using an email destination type to outbound@ic.com.

4. Specify a subject.

5. Add the attachments.

Note: Ensure the test documents are in color. The workflow will convert the documents to a PDF format and change the color to black and white. See Create Distributions for more information.

6. Specify comments.

7. Save the distribution and name it.

8. Select Send.

From the Server Administrator

Use the Server Administrator to view the job details for the documents sent and received. Verify that all parameters set on the connectors, rule, and metadata were processed successfully.

1. Go to the network folder, c:\dtemp\from_ic where the documents were sent and verify that the required conversions took place, for example, PDF and binarize.

2. Use the Messages > History folder and select the appropriate job.

3. Use the Job Properties, Journal and Related Jobs tabs to review and verify job details.

See the Messages > History Outbound/Inbound Job Properties examples below.

Outbound	Inbound

Job Properties shows the following details and more (from left to right).

• DeliveredDocumentName – From_Server_LCR_Document, From_IC_LCR_Document

• Destination – outbound@ic.com, pickupbyserver

• FinalForm Code – PDF outbound and inbound

• FinalStatusText – Successful outbound and inbound

• JobID Text – 000007, OriginalRecipientID – 7

• JobEntryID – inbound only.

The Journal displays a history of events related to a message on the server.

See the Messages > History Outbound/Inbound Journal examples below.

Outbound	Inbound

Related Jobs shows the relationship between jobs.

Outbound	Inbound

Note: You can also view the work item details in IC.

 

AccuRoute and IC Outbound and Inbound connectors support the use of line item metadata. Setup is required in AccuRoute and IC to send and receive line item metadata between server jobs and IC work items.

All metadata from the Outbound connector goes to IC as text. IC will map the job properties to the appropriate data fields and types, for example, date/time, integer, text, line item and more if the value allows it. Administrators must ensure that the data types and respective values defined are consistent on both the server and IC. For example, jobs may fail if the job property type defined on the server is different from the data field type defined in IC.

Note: Line item metadata functionality is for AccuRoute Desktop and AccuRoute Queue use only. Licenses and the installation of the AccuRoute Desktop and AccuRoute Queue applications are required. Contact your Account Manager and Technical Support for further assistance. See the AccuRoute Client Installation Guide for more information.

Setting up Line Item metadata

Line items are items in a list like a bill of sale with details about products, price, quantities and total.

Product Name	Description	Price	Quantity	Total
Product A	Product A Description	xx.xx	100	xxxx.xx
Product B	Product B Description	xx.xx	150	xxxx.xx
Product C	Product C Description	xx.xx	200	xxxx.xx
Product D	Product D Description	xx.xx	250	xxxx.xx

Use the following instructions to set up the line items in the Server Administrator and IC after installations have been completed.

To set up Line Item metadata

AccuRoute manages line items data in a Table property. The Table property must be configured with the job properties that will be stored in a IC workflow. The job properties names must match the IC line items data field names.

To create line items (Job Properties) for Products A through D

1. In the Server Administrator, expand Configuration and select Job Properties.

2. Right-click User.

3. Select New > Job Property. The Job Property dialog box appears.

4. Type a name in the Name box, for example, Product A.

5. Ensure Single - valued property is selected.

6. Select OK.

7. Repeat steps 2 through 6 until you are done.

To add line items to a Table property

1. In the Server Administrator, expand Configuration and select Job properties.

2. Right-click User.

3. Select New > Job Property.

4. Specify a name in the Name box, for example, LCR Products.

5. Select Table property and select Add. The Select Job Property dialog box appears.

6. Type User to go to the User category and select the appropriate line items, for example, Products A through D.

7. Select OK on the Select Job Property dialog box.

8. Select OK on the Job Property dialog box.

See the Table property with line items example below.

In IC, use the Data Dictionary to create new data fields. In this example, Products A through D are created first as text data fields. LCR Products is created as a Line Items type. Data fields, Products A through D are then added as line items to LCR Products.

See the IC Data Fields Line Items example below.

Note: AccuRoute job properties and IC data field names must match.

 

The following text data fields in IC can be added and used to support you when troubleshooting jobs sent from the server by the Outbound connector.

• OriginalRecipientID – shows the recipient id of the original outbound job.

• JobEntryID – shows the job entry id assigned to the job in IC.

The following text data field can also be added and used to support you with identifying job-related issues sent from IC by the Inbound connector. It will contain the value of the original work item that the Inbound connector retrieved from IC. The information is used to diagnose bugs or errors.

• UICWorkItemID – shows the work item id in IC that the server retrieved for a specific job.