Reporting Using CATUtil

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

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

This task shows you how to:

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

  • From an interactive session, select Tools > Utility.

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

Related Topics
Reporting Using a Batch
Creating Flat Reports

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 FastenerFlatReport and select New parameters file.

    The FastenerFlatReportdialog box opens:



  2. Click ENOVIA V6 Object Search to choose the products containing the fastener sets from the database.

    The Enovia V6 Object Search dialog box is displayed.

  3. For instance, fill in the Part Number field:



  4. Click Apply to import the results into the FastenerFlatReport dialog box and click OK to close the Enovia V6 Object Search dialog box.



  5. Select the products you do not need and click . Here are the selected products:



  6. Select the Flat Report directory.

    The dialog box enables you to 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 instance if the value of the fastener finish attribute is "B", using this option will display the translation "Class B" in the report.
    • 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.

  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.

    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 the Read input from parameter file... contextual item to retrieve these parameters.

Run the Report Batch

You can run the report 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.

    Important: You can also generate a report using a Reporting Using a Batch with a parameter file (CATBatchXMLFile).

    The Processes tab enables to follow the progress and status of launched 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 parameters 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.

Warning:
  • Flat report names are automatically generated: Part Number + Version + Maturity.txt.
  • It is not possible to choose a particular fastener set to be reported, i.e. all the fastener sets found inside the product will be output.