Defining Common Batch Parameters

Before running a batch from the Batch Monitor, you must define the parameters to be applied for the selected batch.

Before you begin: Appropriate licenses are required to access objects in the provider you are connected to.
  1. Depending on the location of the objects to be converted:
    • Click 3DEXPERIENCE platform Object Search to search for objects stored in the 3DEXPERIENCE platform: see Searching for Objects.
    • Click File Object Search to search for file objects: see Searching for Files.
  2. Set the batch parameters as explained in the corresponding guide.
  3. Specify the report directory either by entering its path directly in the Report directory box, or by clicking Change the Target Directory to browse your filetree.
    The Report directory box contains the path of the directory where the reports and the processed documents are stored.
    Important: This box is mandatory. By default, it is initialized with the current or temporary directory, depending on your configuration and on the write access.
  4. Enter the name of the report generated in HTML format.

    The default report name depends on the batch you are running but you can replace it by the name of your choice if needed.

    This report is a global report dealing with all the documents that have been processed. In addition to this global report, the batch also creates an individual report for each processed document in the report directory.

  5. Optional: Use the Suffix for object report box to enter a string to be added at the end of each report name.
  6. Click Save to save your batch parameters in an XML file.
    By default, it is saved in a temporary folder.

    The file is named "BatchParameters" suffixed with the hour at which the batch was run (for example, "BatchParameters_14.41.25.xml" to indicate that the batch was run at 14.41.25 PM). When saved, this file can be edited manually and used later on to run the batch directly without having to re-access the batch interface.

    Important: It is recommended to open the XML file in a text editor. As the Parameters.dtd file is not located in the same folder than the XML file being validated, the file may not open.

    You can now either click Run to run the batch from the interface of the selected batch or click Cancel to close the batch dialog box and go back to the Batch Monitor dialog box (to start other batches for example).

  7. In the Batch Monitor, access the Start tab.
    The name and location of the XML file containing the batch parameters you defined in the previous steps (as well as the name of the host computer if you run the batch in remote mode) are displayed.
  8. Optional: If you have not already run the batch, select File > Run (or right-click the batch to run then select Run).
    The Start tab lets you instantiate another batch while the current batch is running. It also lets you delete a batch from the list by selecting it from the list then choosing Edit > Delete (or by right-clicking then selecting Delete).
  9. Optional: From the batch interface, click Open Main HTML Report which is activated as soon as a report has been generated:
    This opens directly the global report in HTML format.

    You can also visualize the report by opening the result file from the directory where it has been saved. If a GlobalResults.htm file already exists, it is automatically replaced by the new one.

  10. Access the Processes tab to display information on the batch execution.

    See Generic Batch Monitor Error Codes and Generic Batch Error Codes for more information about batch errors.

    Note: The Processes tab also lets you interrupt the batch execution. To do so, right-click the desired 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 from the list.

    The Results dialog box displays 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 in the folder of your choice. The file formats available are .txt and .xml. Note that this file is different from the one you save from the batch interface: the Save button in the Batch Monitor dialog box lets you save the batch results (that is, the information displayed in the Results dialog box) whereas the Save button available in the batch interface lets you save the batch parameters.
    • Click Close to close the dialog box and go back to the Batch Monitor dialog box.
  12. To read the reports generated by the batch execution, access the folder c:\temp\batchID.
    Three files are created:
    • A report in text format named batchIDLOG.txt
    • A report in XML format named batchIDLOG.xml
    • A log containing the output named batchIDOUTPUT.xml.

    where batchID is the number identifying the batch.

    You can modify the default storage location of these files by exporting the following variable:

    set BATCH_HOME=new_path

    where new_path is the path of the new storage location.

  13. Select File > Exit to exit the Batch Monitor.