Configuring variables in the batch structure

Edit online

By default, Datacap Navigator displays read-only TYPE and STATUS variables for batches in the batch structure (also known as the DCO Tree View). You can configure Datacap Navigator to display variables as drop-down lists that allow users to select values. Alternatively, you can display variables as text boxes that allow users to input values for each variable. You can also add and remove variables from the batch structure.

To configure the display of variables in the batch structure:

  1. Open the Datacap Navigator Administration View. In a browser, enter a URL with the following format: 
    http://host_name:port_number/context_root/?desktop=dcadmin
    By default, the context root is navigator.
  2. Navigate to the Display variables area of the advanced task settings.
    1. In the left pane, click Workflows.
    2. In the right pane, select a workflow and click Edit.
    3. Select a job and click Edit.
    4. Select a task and click Edit.
    5. On the Task > Advanced tab, scroll down to the Display variables area.
  3. Enter key-value pairs in the Props for var fields to configure how variables are displayed in the batch structure.
    The first field contains the variable name (such as TYPE). Enter values in the second field as follows:
    Value in Props for Var field (second box) Description
    0 Displays read-only variable values.
    1 Displays editable variable values. A drop-down list is displayed for the TYPE and STATUS columns in the batch structure. When you enter 1 for other variables, a text box editor is displayed in the batch structure column for the variable.
    1,setup Displays a drop-down list of values that are configured in the Setup DCO dictionary. Use Datacap Studio to define the dictionary. The name of the dictionary is based on the level:
    Batch level
    The dictionary name is B:colname
    Document level
    The dictionary name is D:colname
    Page level
    The dictionary name is P:colname
    1,comma-separated list of values Specify values to display in the drop-down list. For example, enter 1,a,b,c to display a drop-down list that contains the values a, b, and c.
    Tip: To add a variable, click the plus sign (+). To remove a variable, click the minus sign (-).

    The batch tree view provides a support to display Check Box in its columns that helps for better productivity in some scenarios, and provides an easy method to set a column value. To improve efficiency, you can use the check box to select Yes or No with one click.

    The following process explains how this check box works in batch tree:
    1. Set variable as check box in task settings:

      In task settings XML file, add a new variable and settings pair in the Display variables section. For example: 0 0 11, 1, 001

      With reference to the above example, you can add a variable IsChecked. Comma separated 3 flags: "1, 1, 001". The first one is 11 that means the column in batch tree is CheckBox, and 11 is required. The second AllowEdit to indicate whether the check box is editable. It is optional, and default is Editable. The third value is 3 bits value for Batch, Document and Page settings, 1 means the check box is displayed in the corresponding DCO row. The value is optional, default is 001, and it means only pages' check box are shown by default. For another example, 101 means the check box only shows for Batch and Page rows in Batch tree view.

    2. In batch tree view, you might see the check box in the column. Click the check box cell, the checked or unchecked status will be changed. The function also supports multiple selections. Select multiple lines in batch tree view, then click the check box column cells. The checked ones will become unchecked, and those unchecked will become checked.
    3. When you hold or submit a batch, the checked variable value is set to true in the task XML file. The variable that is not checked is set to false.