Running a Batch from the Command Line

If you already have an XML file containing all the necessary inputs, there is no need to access the batch interface and you can run the batch from the command line. This parameter file can be used to run the batch using the Batch Monitor capability through the CATUTIL command.

Before you begin: CATUTIL does not support all the parameters that can be used in the 3DEXPERIENCE Platform. For example, cloud launch options are not supported.
  1. Access the default folder: C:\Program Files\Dassault Systemes\B424\OS_a\code\bin.
  2. Run CATUTIL -Name batch_name xml_file

    where batch_name is the name of the batch you want to run and xml_file is the path and name of the XML file.

    For instance:

    CATUTIL -Name DownwardCompatibility e:\users\my_parameters.xml

    Tip: To use an environment file, launch CATUTIL with the CATSTART command using the -env and -direnv options: catstart -run "CATUTIL -Name batch_name xml_file" -direnv env_dir -env env_file

    where

    • batch_name is the name of the batch you want to run and xml_file is the path and name of the XML file.
    • env_dir is the name of the directory containing the environment file and env_file is the environment file.

    For more information, see Installation and Administration: 3DEXPERIENCE Platform: 3DEXPERIENCE Platform Installation: Native Apps Installation: Configuring the Software: Configuring Environments for more information.

  3. To check if the batch executed correctly, access the folder c:\temp\.
    A .txt file named "BatchMonitorResults_" suffixed with the hour at which the batch was run (e.g. "BatchMonitorResults_8.46.34.txt") gives you information on the batch execution and indicates the folder where the reports generated by the batch execution are stored.
  4. 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.

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

    set BATCH_HOME=new_path (on Windows)

    where new_path is the path of the new storage location.