Running CATDUA V5 in Batch Mode

This batch lets you make a diagnostic and, whenever possible, fix the documents (CATPart, CATProduct, CATProcess, CATAnalysis, CATDrawing, CATMaterial) for which errors have been detected.

This task shows you how to:

• Access the Batch Interface from the CATDUA V5 Interactive Tool
• Access the Batch Interface from the Batch Monitor
• Define the Batch Parameters
• Run the CATDUA V5 Batch directly from the Batch Monitor
• Manage Assembly Links Consistency.

• Table of Detected Return Codes
• List of Detected Return Codes.

Accessing the Batch Interface from the CATDUA V5 Interactive Tool

On Windows

1. In a MS-DOS window (or Command Prompt), go to the level in which CATIA is installed (example: E:Install...).

2. Enter the following command: cd intel_a code bin.

3. Enter the following command: CATDUAV5.  The CATDUA V5 dialog box appears.

On UNIX

1. Change the directory to: cd Install_folder/OS_a/code/command.

2. Run the following command: ./catstart -env EnvName -dirEnv DirName -run "CATDUAV5".
   Note that EnvName is the environment file and DirName is the directory in which the environment is. The same CATDUA V5 dialog box appears.

Accessing the Batch Interface from the Batch Monitor

1. Access the Batch Monitor interface, either from the command line or from a V5 session.

   For more information, refer to "Running Batches Using the Batch Monitor" in the Infrastructure User's Guide.

   The Batch Monitor opens:

2. Double-click CATDUA V5.

   You can also access the CATDUA V5 interface by selecting File > New parameter file, or by right-clicking CATDUA V5 in the list then selecting New parameter file.

   When accessing the CATDUA V5 from the Batch Monitor, some additional options are available:

   Remote mode You can choose to run the batch locally, or on a remote computer by selecting the appropriate option: Run Local: default option. When selected, the batch is run in local on your local computer. Run Remote: select this option then indicate the name of the remote computer on which the batch will be run. The remote computer uses the printers set up on your local computer. Note that: When using Windows printers, you can run the batch in remote mode on Windows computers only When using 3DPLM printers, you can run the batch in remote mode either on UNIX or on Windows computers. For more information, refer to "Running Batches Using the Batch Monitor - Running Batches in Remote Mode".

   Licensing You also have the ability to select a license by clicking Licensing Setup.... For more information, refer to "Running Batches Using the Batch Monitor - Defining the Batch Parameters".

   Getting contextual help The batch-specific online documentation can be accessed directly from the PrintBatch interface by clicking in the top-right corner (on Windows) or Help (on UNIX).

Defining the Batch Parameters

Selected Operation

1. Use the Operation pull-down list to select the operation you want to process:

   Check: if you only want to check the document. Clean: if you want to check and clean the document. In that case, cleaned documents will be automatically written, depending on the output criteria you will define below (see Document Selection section).
   	It is strongly recommended to select first of all the operation (Check or Clean) you want to process, as many following options depends on the operation.

2. In the Select Filter area, filter the list of errors you want to detect. By default all errors are taken into account.

   Priority: this option lets you choose the result of priority errors you want to get (1 and/or 2 and/or 3 choices). Domain: this option allows you to check or clean errors from one or several specific domains. Keywords: this option allows you to check or clean errors with a specific impact. Dealing with GhostLink Dealing with the Specification Dealing with the Geometry Impacting the PCS and performance result Dealing with the Updates.
   You can combine all filters, but at least one error must be selected for processing. Otherwise, an error message is displayed and the last filter selection is ignored.
   The list of available errors according to the filters selection is dynamically computed.
   	You can go back to the initial selection (all priorities) anytime by clicking Reset Filter.

3. In the Error Selection area, specify whether you want to apply:

   All but the list of selected errors, None plus the list of selected errors.

4. If needed, you can also manually exclude or add an error by selecting the error in the list.

5. In the Display messages area, select the type of information to be displayed in the report.

   Note that Short messages, Long messages and Short/Long messages are not available for all CATDUA rules and the same message is issued in such cases.

   Document Selection

6. In the Document Selection area, select the type of documents to be processed: either File, ENOVIA VPM or ENOVIA LCA.

7. Click to select the documents to be processed.

   Each document type is associated to a specific search interface:

   File When searching for File documents with the Clean action selected, the search is performed via the following File Selection dialog box:

   Note that this option allows you to rename automatically the cleaned documents, keeping the input directory structure, and many more useful options. If the "Check" action is selected, the File Selection dialog box slightly differs because this action does not require as many data as the "Clean" action:

   For detailed information about this dialog box, refer to "Running the Data Life Cycle Batch - Searching for File Documents" in the Infrastructure User's Guide.

   ENOVIA V5 VPM

   When searching for ENOVIA V5 documents, the search is performed via the Search Documents in ENOVIA V5 VPM dialog box:

   As for the File selection, this dialog box may differ depending on the option you selected: Check or Clean.

   For detailed information about this dialog box, refer to "Running the Data Life Cycle Batch - Searching for Documents in ENOVIA LCA" in the Infrastructure User's Guide.

   ENOVIAVPM (UNIX only)

   When searching for ENOVIAVPM documents, the search is performed via the Search Documents in ENOVIAVPM dialog box:

   As for the File selection, this dialog box may differ depending on the option you selected: Check or Clean.

   For detailed information about this dialog box, refer to "Running the Data Life Cycle Batch - Searching for Documents in ENOVIAVPM" in the Infrastructure User's Guide.

   This scenario takes the File Document Location as an example.

8. Enter your search criteria in the search dialog box.

   When the documents are selected, their names are displayed in the Name list.

   When working with File documents, note that the former Pointed document option (allowing to process all the documents pointed to by the document to be checked or cleaned) has been replaced by the Select pointed documents option available in the File Selection dialog box.

   If you change your mind afterwards and decide not to process one or several documents displayed in the Name list, select them (you can use the multi-selection), then click the button to remove the documents from the list. As long as no document is selected, the button is grayed out.

   Output

9. In the Target Directory field, key in the output directory or DLName or, click the button to navigate through the file tree to the desired directory.

   This box is mandatory and is initialized with the current or temporary directory by default.

   If you set the DLName environment as "Current" in the Tools  >  Options  >  General  >  Document tab, the usual File Selection dialog box will be replaced by the following one:

   The DLName document environment lets you restrict the access to specific folders referenced by logical names,as "DLNames" (each folder is assigned a logical name). In this mode, the different file opening and saving commands only allow end users to access documents in directories referenced by DLNames. DLNames are identified by the string CATDLN://, for instance "CATDLN://DLNAME3". Use the "Look in:" pull-down list to select the root DLName in which you want to navigate. The sub-folders (if any) stored in the selected root DLName are then displayed in the DLName list below and you can choose a DLName in list: the selected DLName is displayed in the "Selected DLName" field and will be set as the target directory. Note that once you are in a sub-folder, you can re-access the upper level by clicking the button. You can also click the  icon to access the Search Results dialog box which lets you search for DLNames using a specific interface. For more information, please refer to Searching for DLNames in the Infrastructure User's Guide (Customizing Settings, General, Document). Once you have found the desired DLName, click OK to validate.

10. Enter the name of report in the Report Name box.

    By default, the report is named "GlobalResults".

    For each processed document, the batch creates a document report in the target directory. By default, the name of the report is the name of the document suffixed with ".htm". You can change this default name by suffixing the document report name with the string of your choice. To do so, enter the string to be added at the end of the name in the Append String to Document Report box. All this information can be automatically valuated using an existing xml file, in the contextual menu "Read input parameters from file".

11. Click Save then navigate to save your XML file in the desired location.

    By default, it is saved in a temporary folder. This file contains information about the batch (name of the batch, name of the documents you want to check or clean, path directory of the check/clean report, etc.). 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. However, bear in mind that to be able to open and edit the XML file, you must use a text or XML editor.

12. Click Run to start the batch

13. To display information on the batch execution, access the Processes tab in the Batch Monitor window.

    The following batch-related information is displayed: Name of the batch Name of the parameter file used to run the batch Name of the host computer (if you run the batch on a remote computer) Status of the batch ("Ended", "Running", etc.) Feedback on the batch completion in the "Progress" column. "100%" is displayed when the batch is ended Start and end time, respectively in the "Beginning at" and "Ending at" columns Return code: "0" means that the batch executed correctly ; a code other than zero means that the batch has failed. For more information, refer to "Generic Batch Monitor Error Codes" and to "Generic Batch Error Codes" in "Running Batches Using the Batch Monitor" in the Infrastructure User's Guide. Result of the batch execution (either "Succeeded" or "Failed") Batch identification number.

14. To display the results of the batch execution, access the Processes tab then double-click the line corresponding to the batch you have just run (or right-click it and select Results).

    This window 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 (i.e. the data displayed in the Results window) in the folder of your choice. The file formats available are .txt and .xml Close to close the window and go back to the Batch Monitor.

15. To read the reports generated by the batch execution, access the folder c:\temp\batchID (on Windows) or /temp/batchID (on UNIX).

16. To display an HTML version of the report, click Open HTML Report . This button is activated only once a report has been generated, otherwise it is grayed out.

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

To know how to have access to the results of the check/clean execution, refer to Viewing Results of CATDUA V5 Execution in this guide.

Running the CATDUA V5 Batch directly from the Batch Monitor

1. Access the Batch Monitor interface, either from the command line or from a V5 session.

2. In the Utilities tab, click the CATDUA V5 batch then select File > Associate a parameter file (or right-click the batch then select Associate a parameter file).

3. Navigate to the folder in which you saved the XML file then click Open.

4. Access the Start tab which now displays the name and location of the XML file you associated to the batch.

   You can associate several xml files in order to obtain a list of batches that you could run later.

4. Select File > Run (or right-click the batch to run then select Run) to start the batch execution.

   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).

5. Access the Processes tab to get some information on the batch execution.

   At the end of the execution, one of the following return codes will be returned: ReturnCode = 0  >  the batch ended successfully ReturnCode = 4  >  at least one document could not be processed ReturnCode = 8  >  the batch aborted. To display an HTML version of the report, click Open HTML Report in the CATDUAV5 dialog box . This button is activated only once a report has been generated, otherwise it is dimmed.

6. To display the report of the batch execution, double-click the desired batch in the list to open the Results window.

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

Managing Assembly Links Consistency