IBM Datacap Web Client Help

Define workflows, jobs, and tasks with the Administrator > Workflow tab

The Workflow tab defines workflows, jobs, and tasks for the application. Tasks on the Workflow tab are linked to task profiles that are created in Datacap Studio.

New

Click New to create a task, job, or workflow:

To create a task, select the parent job and click New.
To create a job, select the parent workflow and click New.
To create a workflow, ensure that no items are selected and click New.

After you create the item, specify the details in the Selected details pane.

Copy

Makes a copy of the selected item and names it Copy of <item>. You can change the name and details in the Selected details pane.

^ (up arrow)

Moves the selected item up the list.

v (down arrow)

Moves the selected item down the list.

Remove

Removes the selected item.

Workflow list

Displays all workflows, jobs, tasks, and conditions that are defined for the current application. To change the settings for an item, select the workflow, job, or task to open the Selected details pane.

Selected task details

Select a task to open the Selected task details pane and change the settings for the selected task. Click Apply when your changes are complete.

Name: Displays the task name.

Description: Displays the task description.

Mode

Each task must be linked to a mode. The mode specifies the behavior of the task. The menu displays the modes that are available for selection.

Batch Creation: Select this mode for use with VScan, or if you are creating a task to scan hardcopy documents in Datacap Desktop or in Datacap Web Client.
Important: A job can contain only one Batch Creation task. If the job that you are modifying already includes a batch creation task, you must remove that task.
Router: Select this mode if the task routes the batch to a different task or job when the criteria of a condition are met. One example of a condition is a document integrity failure that requires a supervisor’s intervention. When you select this mode, Datacap automatically inserts a Return Conditions key under the Parameters section. See more information about Selected condition details below.
Normal: This mode is for all other tasks that are not used for Batch Creation or that do not require special handling.

Queue by

Determines which combination of user ID and station ID can open a batch queued for this task. The following are the Queue by options.

None: Any user on any station can open the batch (default setting).
Station: Only the station that stored the batch can open the batch.
User: Only the user that stored the batch can open the batch.
Other Station: The station that stored the batch cannot open the batch.
Other User: The user that stored the batch cannot open the batch.
Station and User: Only the station and user that stored the batch can open the batch.
Station and Other User: Only a different user on the station that stored the batch can open the batch.
User and Other Station: Only the same user on a different station can open the batch.
Other Station and Other User: Only a different user on a different station can open the batch.

Important: Changing the Queue by setting does not affect batches that are already queued.

Store

Determines which combination of station ID and user ID is stored with the batch upon completion of this task. The following are the Store options.

None: No user ID or station ID is stored (default setting).
Station ID: Stores the station ID with the batch.
User ID: Stores the user ID with the batch.
Station ID and User ID: Stores the station ID and the user ID with the batch.

Parameters

In the Parameters section for a selected task, you can specify the program to use with the task. Click Apply after the changes are complete. You can choose the following programs from the Program menu.

Multiple

Select this program if the task can be run in the background by Rulerunner, in the Datacap Web Client, or in an application client, such as FastDoc or Datacap Desktop.

Datacap Desktop

Select for tasks that are exclusively completed in Datacap Desktop.

FastDoc

Select this program for tasks that are exclusively completed in FastDoc.

Scancl.aspx

Select this program for a scan task that is run from Datacap Web Client.

VScancl.aspx

Select this program for a virtual scan task (file import) that is run from Datacap Web Client.

UplBFcl.aspx

Select this program for an Upload task that is required after remote scanning in Datacap Web Client.

Click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window to modify options that includes the following options.

Upload pause: Determines the time delay between uploading of images.
Maximum upload size: Determines the maximum size of an upload.

Pickup.aspx

Select this program for a batch creation task in Datacap Web Client that involves different types of documents, such as graphics, bar codes, text, and forms.

Click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window to modify options that include the following options.

Thumbnail scale
Files per batch

ProtoID.aspx

Select this program for a manual page identification task in Datacap Web Client that includes reordering images, inserting new images, flagging, image review, image rotation, and application of document integrity rules and Rulerunner Service rules.

Click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window to modify options that include the following options.

Validation Statuses
Task profile
Page ID: This option includes the types of pages to highlight, special variable values, thumbnail scale, enabling document integrity rules, and the type of page to use when anew page is inserted.

Restruct.aspx

Select this program for a manual document assembly task in Datacap Web Client. Document assembly is usually an automatic process that runs in the background. However, in some cases, the automatic assembly task does not correctly identify page types. For these occasions of misidentification during document assembly, you can use Restruct.aspx to force manual identification of page types.

To configure a task to use Restruct.aspx:

Select the task and click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window.
Scroll down to the DCO Tree View section.
Under Display Variables, enter 1,setup for the Props for var TYPE value. (The default is 0,setup.)
Click Save.

Tip: The fields in the Webpage dialog window include tooltips that provide guidance about acceptable values that you can enter.

aIndex.aspx

Select this program for a manual document assembly task in Datacap Web Client that includes page identification, document creation, indexing, data validation, anchor setting, image reordering and rotation, document integrity validation, and double-blind or multi-pass data entry.

Click Setup (or, for a new task, click Create Setup and then Setup) to open theWebpage dialog window to modify options that include the following options.

Page Statuses
Document startup: Specify whether to load all data files and image files when the task begins processing.
Field Statuses
Alternative or blind texts: These include alternative text index, blind confirmation index, and displaying other alternative texts.
Task profile and alternate task profiles
Index: These include read-only field statuses, enabling local processing when there is no firewall between Datacap Web Client and Datacap, hiding document types, and specifying a template folder.

Tip: The fields in the Webpage dialog window include tooltips that provide guidance about acceptable values that you can enter.

aVerify.aspx

Select this program for data validation and verification tasks that are completed in Datacap Web Client.

Click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window to modify options that include the following options.

Page Statuses
Document startup: Specify whether to load all data files and image files when the task begins processing.
Field Statuses
Task profile and alternate task profiles

Tip: The fields in theWebpage dialog window include tooltips that provide guidance about acceptable values that you can enter.

Rulerunner

Select this program for background tasks that are run exclusively by Rulerunner.

aVerify.aspx

Select this program for data validation and verification tasks that are completed in Datacap Web Client.

Click Setup (or, for a new task, click Create Setup and then Setup) to open the Webpage dialog window to modify options that include the following options.

Page Statuses
Document startup: Specify whether to load all data files and image files when the task begins processing.
Field Statuses
Task profile and alternate task profiles

Tip: The fields in theWebpage dialog window include tooltips that provide guidance about acceptable values that you can enter.

ImgEnter.aspx

Select this program for data verification of unstructured documents in Datacap Web Client. Data values appear in a pop-up window in front of the document image.

Verifine.aspx

Select this program for data verification of documents in Datacap Web Client. Data values appear in a one-column or two-column grid that can be customized. See Creating and using custom web pages in the IBM® Knowledge Center for Datacap for details about using Verifine.aspx.

Mobile Capture

Select this program for tasks when you are using a mobile device to capture documents. You can configure the initial batch creation task in a job to use the Mobile Capture program. The mobile application communicates with Datacap by using Datacap Web Services. The GetMobileProfiles REST API method provides the mobile application with a list of jobs that begin with a Mobile Capture task. For more information on the GetMobileProfiles REST API, see GET method for mobile profiles in the IBM Knowledge Center for Datacap.

Selected job details

Use the Selected job details pane to change the settings for the selected job. Click Save.

Name: Displays the job name.
Description: Displays the job description.
Priority: Determines the priority of batches that are created for this job (1 is the highest priority and 10 is the lowest priority). If two batches of different priority are pending for the same task, Datacap processes the batch with the highest priority first. Changing this setting does not affect batches that are already queued.

Selected workflow details

Go to the Selected workflow details pane to change the settings for the selected workflow. Click Save.

Name: Displays the workflow name.

Description: Displays the workflow description.

Program Name: Always TDCO.Batch.

Selected condition details

When you select Router as the Mode for a task, Datacap automatically inserts a Return Conditions key under the Parameters section. Conditions are used to implement branching and splitting. For example:

Branching: If a batch fails document integrity checking, you can route it to a special FixUp task. Then, the operator can address the issue and then return the batch to the main workflow.
Splitting: If a batch contains pages that meet certain exception criteria, you can split those pages from the batch and route them to an administrator for special handling.

Applications can raise conditions by using the Task_RaiseCondition action or the SplitBatch action. (See the action help in Datacap Studio for details.) For more information and examples, see Datacap application development in the IBM Knowledge Center for Datacap.

Name: Displays the condition name. The condition name is stored in the task.set.xml file for the related task. You cannot change the condition name here.

Spawn Type

Determines the action that is taken when the condition is raised:

not set: Does nothing.
Branch: Sends the current batch to the specified job, then returns the batch to the main job.
Jump: Skips the next <steps> tasks in the current job workflow.
Split: Used with the SplitBatch action to send specific pages from the current batch to another job.
Stop: Stops processing the batch (status = "batch stopped").

Important: The action does not occur until the current task completes.

Child Job: Specifies the job to which the batch or split portion of the batch is sent when the condition is raised.

Parent Status: Specifies the status that is assigned to the batch in the main job when the child job completes. Pending is the default setting.

Child Status: Specifies the status that is assigned to the batch in the child job. Pending is the default setting.

Steps

The purpose of this field varies depending on the Spawn Type field.

When used with Jump: The number of workflow tasks to jump.
When used with Branch: The return point after the branching (0 = same task, 1 = next task, and so on).