Reporting Using a Batch

You can work with a batch, whose inputs are defined through a dialog box, to generate flat and unitary reports.

A batch is a non-interactive program requiring an xml file that contains parameters defining inputs and outputs.

This task shows you how to:

Before you begin: There are two ways to run CATUtil:

  • From an interactive session, from the secondary area of the Tools section, click Utility....

  • From a MS-DOS window, type catstart -env LocalEnv -run "CATUtil". The Batch Monitor dialog box is displayed, listing all available batches.

Create a New Parameter File

You can first create a new parameter file.

  1. From the Utilities tab of the Batch Monitor dialog box, right-click either:
    • FastenerFlatReport and select New parameter file.

      The FastenerFlatReport dialog box opens.

    • UnitaryFastenerReport and select New parameter file.

      The UnitaryFastenerReport dialog box opens.

  2. Click 3DEXPERIENCE Platform Object Search to select the products.

    The 3DEXPERIENCE Platform Object Search dialog box is displayed.

  3. For example, fill in the Part Number box.
  4. Click Apply to import the results into the FastenerFlatReport dialog box and click OK to close the dialog box.
  5. Remove the products you do not need by clicking .
  6. Select the Flat Report directory by clicking the Browse icon.

    You can customize the report through several options:

    • Long report: adds projection results and specific process category data for each fastener
    • Include comments: specifies that the report starts with the commented header block showing keywords description.
    • Ordered zones sorting: specifies how the joined parts specifications are ordered.
    • Translate coded values: defines attribute values belonging to a predefined list of codes are translated according to the NLS set-up. For example if the value of the fastener finish attribute is "B", using this option will display the translation "Class B" in the report.
    • Maximum fastened parts: specifies the maximum number of fastened parts.
      Note: This option is only available for unitary reports.
    • Maximum fastened components: specifies the maximum number of fastened components.
      Note: This option is only available for unitary reports.
    • Unit: either be millimeter or inch.
    • Real numbers precision: number of decimal digits of all the real numbers written in the neutral file and of the discretization values displayed in the dialog box above. This number is comprised between 0 and 10.
    • Scientific notation: Used in the report (power of 10)
  7. Select the Report directory in which the flat report will be executed by clicking the Browse icon.
  8. Optional: Modify the Report name and the Suffix for the object report.
  9. Click Save to save the parameters in the xml file.
  10. In the Save As dialog box, select the xml file and click Save.

    The xml parameter file is automatically generated in the selected directory.

    Tip: Provided you have already saved Flat Report parameters from in an xml file, you can right-click anywhere in the FastenerFlatReport dialog box and select Read input from parameter file... to retrieve these parameters.

Run the Batch

You can run the batch from two different dialog boxes.

From the FastenerFlatReport dialog box

You can run the batch from the FastenerFlatReport dialog box.

Click Run to run the batch process.
The xml parameter file is generated in the default repository.

From the Start Tab of the Batch Monitor dialog box

You can run the batch from the Batch Monitor dialog box.

  1. Right-click Run to generate the report again.

    The Processes tab enables to follow the progress and status of run batches.

    The following information is displayed:

    • name of the batch
    • name of the parameters file used to run the batch
    • status of the batch ("Ended", etc.)
    • start and end time, respectively in the "Beginning at" and "Ending at" columns
    • return code: "0" means that the batch executed correctly, "-1" means that an error occurred result of the batch execution (either "Succeeded" or "Failed")
    • batch identification number
    The batch ID corresponds to the directory, named after the batch ID, where the log is stored. In case warnings are detected, a warning log is added to the existing log file.
  2. Right-click the FastenerFlatReport and select Results.
    The Results dialog box is displayed.
  3. Click Save to save the results in a text file or Close to simply close the dialog box.

Associate an Existing Parameter File

You can associate an existing parameter file.

  1. From the Utilities tab, right-click FastenerFlatReport and select Associate a parameter file.
  2. In the dialog box that appears, select an xml parameter file and click Open.
    The xml parameter file appears in the Start tab as an argument for the start of the FastenerFlatReport utility.

Note: Report names are automatically generated: Part Number + Version + Maturity.txt.