Running the CheckRepresentation Batch

You can check structural data within a product, part, drawing, etc., and clean (i.e. modify) the data structure. The CheckRepresentation batch provides a diagnostic and whenever possible, fixes representations that contain errors. You can process V6-type representations stored in 3DEXPERIENCE.

This batch is useful in the following situations:

  • Before recovering external data
  • Before starting with a new 3DEXPERIENCE release
  • Broken links when opening products
  • Incidents when updating a component (e.g. sketch update)
  • The Links window
  • Performance problems when opening a product (because of lost links)

This task shows you how to:

Before you begin: To run the batch directly from the Batch Monitor or from the command line, see 3DEXPERIENCE Native Apps User's Guide: Running Batches: Running Batches Using the Batch Monitor.
See Also
List of Detected Return Codes
Table of Detected Return Codes
Errors Detected from CheckRepresentation

Select the CheckRepresentation Batch

This task explains how to access the Batch Monitor to select the CheckRepresentation batch.

  1. Access the Batch Monitor from a Session.
  2. Double-click CheckRepresentation.
    The following dialog box appears:

Search Objects

This task explains how to search the objects to process with the batch.

  1. Click 3DEXPERIENCE platform Object Search to open the search dialog box.

    For more information, see:

    • Running queries and Output options, see Searching for Objects.
    • Rename Criteria options, see Searching for Files (if you use the Convert to file conversion type).

  2. Click Apply to launch the search.
    Your search results are displayed in the Object Selection area.
  3. Optional: Click Cancel in the search dialog box to cancel the operation, including the object selection you performed
    A warning message is displayed and you can either choose to keep your selection by clicking Yes, or confirm the removal by clicking No.
  4. Optional: Remove the objects you do not want to process.
    1. Select the objects to be removed.
      Tip: Double-click an object if you want to display the mapping information for the object in a separate window.
    2. Click Removes the selected objects from the list .

Configure the Filters

This task explains how to define the parameters of the filters.

  1. In the Selected Operation pull-down list, choose the action to be performed:

    • Check to check the representation.

    • Clean to check and clean the representation. Cleaned representations will be automatically written, depending on the output criteria you define.

    Important: It is highly recommended to first select the operation because many options in the dialog box depend on the selected operation.
  2. Filter the list of errors to detect.

    By default all errors are taken into account but you can filter them through the following tabs:

    • Priority: lets you choose the priority errors (1 and/or 2 and/or 3 choices).
    • Domain: lets you check or clean errors from one or many specific domains.
    • Keywords: lets you check or clean errors with a specific impact on:

      • Specification

      • Geometry

      • PCS and performance result

      • LinksMngt

      • Update

    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 is then dynamically computed.

  3. Optional: To restore the initial selection (i.e. all priorities), click Reset Filter.
  4. Optional: If you decide afterwards not to process one or several objects displayed in the list, select the objects to be removed and click .

Run the CheckRepresentation Batch

This task explains how to configure the report generated after running the batch.

  1. In the Report directory box, enter the report directory or click .

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

    An additional tag is inserted in the XML file generated when the batch is run:

    <folder id="targetDir" destination="C:\temp" folderPath="C:\temp" type="bin" upLoadable="RightNow" extension="*" automatic="1"/>

    Note: For more information see Report Directory.

  2. Enter the name of report in the Report Name box.
    By default, the report is named CheckRepresentation_GlobalReport.xml.

    An additional tag is inserted in the XML file generated when you run the batch: <ReportName>CHECKREP_GlobalReport</ReportName>

    Note: For more information, see Report Name.
  3. Optional: Select the Verbose Report check box.

    The Verbose Report is a light a version of the report.

  4. Click Run to launch the batch.
    If one of the above boxes is not correctly filled, the command is not available. When the operation is over, CheckRepresentation application generates:
    • A quick result information you can access in the Processes tab.
    • A detailed XML report saved in the report directory.

      At the end of the report, one of the following return codes will be displayed:

      • ReturnCode=0 The batch ended successfully.
      • ReturnCode=4 At least one object could not be processed.
      • ReturnCode=8 The batch aborted.

  5. Click Save to save your batch parameters in an XML file. You have to save the batch parameters if you want to postpone the batch execution or reuse the batch parameters for another batch execution.

    The XML file contains information about the batch (name of the batch, name of the representations you want to check or clean, path directory of the check/clean report, etc.).

    This file can also be used to valuate all the fields, using the contextual menu or the PLMBATCH_CheckRepresentation_StartUp variable.

    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.

  6. Optional: To modify your conversion parameters, click Close then run the batch once again.
  7. Optional: Click Save to save your results in the folder of your choice.

    This file is different from the one you saved from the batch interface. You can use the Save button in the Batch Monitor window to save the batch results (i.e., the data displayed in the Results window displayed above), whereas in the Batch Interface window, you can use the Save button to save the batch parameters.

  8. To display an XML version of the global report, click Open XML Report .

    This button is activated only when a report has been generated, otherwise it is grayed out.

    The XML report contains three sections:

    • Data Source
    • Metrics and Options
    • Details for Objects

    Note: Errors are listed at the beginning of the report whereas warnings are displayed under each object responsible of the warning.

    Tip: Another method to visualize the report is to open the XML file from the directory in which it has been saved.
  9. To display the report for each processed object, click the plus sign next to the object of interest.

    The following information is provided:

    • Priority Level: corruption level of the file,

    • Return codes can be corrected: the number of return codes that can be solved in the clean mode.

    • Synthesis report providing the list of errors for each priority.

    • Name of checked and cleaned representations.

    • Number of detected return codes.

    • Number of fixed return codes.

    • Number of priority1 / priority2 / priority3 return codes.

    Notes: The displayed information is different depending on the mode selected (Clean or Check) above, and if the Verbose Report check box is selected.
    • In Check mode, you can see a CheckResults section with the checked objects and the errors that can be fixed.
    • In Clean mode, you can see a CleanResults section with the checked objects and the fixed errors. The CheckResults are also displayed.
    • If you did not select the Verbose Report check box, only CleanResults are displayed.

    The output directory is not automatically emptied by the CheckRepresentation before launching a new check or clean execution. The XML report contains hyperlinks to the official documentation for each detected error.

  10. Access the Processes tab in Batch Monitor to display information on the batch execution.
    Tips:
    • When the batch has been run at least once, an XML file containing the batch parameters is generated. You can reuse these parameters next time you access the CheckRepresentation batch by right-clicking then selecting Read input from parameter file.... This opens a dialog box which lets you navigate to the desired XML file. When finished, click OK to validate: the batch window is updated and displays all the data contained in the parameter file.
    • You can also use this XML file as a startup for all CheckRepresentation applications by setting the PLMBATCH_CheckRepresentation_Startup environment variable to the path of the XML file.
  11. To read the reports generated by the batch execution, access the folder c:\temp\batchID or /temp/batchID.