About the CheckRepresentation Batch

This topic provides information about some of the options used to run the CheckRepresentation batch .

This page discusses:

Report Directory

The report directory has a default name which can be modified.

You can change the default report directory by setting the PLMBATCH_Default_TargetDir environment variable to a valid directory (i.e. an existing directory with write access).

Important: An error message is displayed when the new report directory does not match an existing directory with write access, and the selection is refused.

When entering directly the path of the new report directory, you can use ${VARIABLE} to valuate the report directory. For instance, entering ${TMP} automatically fills the Report directory box with the C:\temp directory when $TMP is set to C:\temp.

Report Name

The report name has a default name and a list of restrictions apply when you define it.

The default name is CheckRepresentation_GlobalReport.xml.. You can change this default name by setting the CHECKREP_GlobalReportName environment variable to the new default name. You can also change the global report name by entering the desired name in the Report Name box.

As for the report directory, you can use ${VARIABLE} to valuate the global report name. For instance, entering GlobalReport_${UID} automatically fills the Report Name box with GlobalReport_ME directory when $UID is set to ME.

The following restrictions are applicable to the report name:

  • A string (or the value of a ${VARIABLE}) cannot contain the following characters: * : ? < > | , \\ / ". These characters are ignored when defined in a string.
  • A list of "." characters is automatically replaced by a simple ".". A name cannot contain the string "..".
  • The global report name defined in the startup XML file has priority.

    For instance, if you use this command line: set CHECKREP_GlobalReportName=CHECKREP_GlobalResults_Variable

    and if the CheckRepresentation.xml file contains the tag <ReportName>CHECKREP_GlobalResults_Xml</ReportName>

    then, the global report will be named CHECKREP_GlobalResults_Xml.xml in the report directory.

  • If $VARIABLE is not exported or contains invalid characters, it is partially or totally ignored. Below are three examples.

    1) unset TOTO GlobalReport=Myreport.${TOTO} means that the text editor displays Myreport.

    2) set TOTO=":><|\/" GlobalReport=Myreport.${TOTO} means that the text editor displays Myreport.

    3) set TOTO="a?f" GlobalReport=Myreport.${TOTO} means that the text editor displays Myreport.af.

Environment Variables

You can export environment variables to run the CheckRepresentation batch.

Variable Use
PLMBATCH_CheckRepresentation_Startup When the batch has been run at least once, lets you prevaluate parameters by specifying the path of the XML file to be used
PLMBATCH_Default_TargetDir Lets you change the default report directory by specifying a valid directory (i.e. an existing directory with write access)
CHECKREP_GlobalReportName Lets you change the default Global Report name by specifying a new default name.

Note: In addition to this, you can use ${VARIABLE} to valuate any CheckRepresentation environment variable.