Running a Batch from its Interface or from the Batch Monitor

You can run a batch directly from its interface or, if the required parameters have already been defined, you can run it directly from the Batch Monitor.

This task shows you how to:

Run a Batch Directly from the Batch Interface

When a batch has been run at least once or when you click Save, an XML file containing the batch parameters is generated. In that case, you can reuse these parameters without having to define the batch parameters again.

  1. Access the Batch Monitor, either from the command line or from a session.
  2. In the Utilities tab, click the batch to be run.
  3. In the batch interface, right-click anywhere then select Read input from parameter file.
  4. In the File Selection dialog box, navigate to the desired XML file.
  5. Click OK to validate and close the dialog box.
    The batch interface displays the information contained in the parameter file.
  6. Click Run to run the batch.

Run a Batch Directly from the Batch Monitor

If you already have an XML file containing all the necessary inputs, there is no need for you to define the batch parameters and therefore, you can run the batch directly by associating the corresponding XML file to the batch to be run.

  1. Access the Batch Monitor, either from the command line or from a session.
  2. In the Utilities tab, click the batch to be run.
  3. Select File > Associate a parameter file (or right-click the batch then select Associate a parameter file).
  4. Navigate to the folder in which you saved the XML file then click Open to validate.
  5. Access the Start tab which now displays the name and location of the XML parameter file you associated to the batch.
  6. Optional: Select Edit > Properties(or right-click the batch then select Properties).
  7. Optional: Specify the target machine name by selecting the appropriate option (if you run the batch on a remote machine, you must indicate its name in the Host Name box).

    By default, batches are run on your local machine. For more information about running a batch in remote mode, see Running Batches in Remote Mode.

    Note that the Properties contextual command is grayed out if it is not available for the batch you are running.

  8. Optional: In the Settings directory box, enter the path of the directory to be used to run the batch (or click Browse then browse your file tree to the directory of your choice).
    After clicking OK, the path of the selected directory is displayed in the Settings Path column of the Start tab.
    Note: You can use a file whether in local or remote mode.
  9. Select File > Run (or right-click the batch to run then select Run).
    The batch execution starts.
    Tips:
    • You can instantiate another batch while the current batch is running.
    • The Start tab also lets you delete a batch from the list by selecting it from the list then selecting Edit > Delete (or by right-clicking then selecting Delete).
  10. Access the Processes tab.
    Below are listed generic Batch Monitor error codes and generic batch error codes:
    Generic Batch Monitor Error Codes
    1: Command line syntax error.
    2: Error in XML parameter file.
    3: Communication layer error.
    5: License acquisition error.
    6: Invalid library error.
    7: Error attempting to start a batch requiring a graphic adapter on a machine without an adapter.
    9: Miscellaneous.
    Generic Batch Error Codes
    0: Batch completely successful.
    4: Batch partially successful.
    8: Batch failed.
    20: Error checking licenses.
    21: Error accessing INPUT/OUTPUT.

    The Processes tab also lets you interrupt the batch execution. To do so, right-click the batch from the list then select Interrupt. You can also delete a batch from the list by right-clicking the corresponding line then selecting Delete.

  11. To display the report of the batch execution, double-click the desired batch.

    The Results dialog box indicates the beginning and end date and time of the batch execution as well as the name and path of the documents that have been processed.

    You can then:

    • Click Save to save your results (that is, the information displayed in the Results dialog box) in the folder of your choice. The file formats available are .txt and .xml
    • Click Close to close the dialog box and go back to the Batch Monitor.
  12. Select File > Exit to close the Batch Monitor.