|
The reconciliation can be automated by running
the CATPDMReconcileEV5Batch batch process. This batch is driven via a
command line giving as input the root of the assembly on which the
reconciliation will be done. |
|
When applying the reconciliation rules,
an attempt will be made to obtain locks for all objects (instances, parts,
documents) that will be modified. If any locks cannot be obtained
(for example, a part may be locked by another user) a detailed error
message will be given. Note that if the Apply does not succeed, all
objects whose locks were obtained by the reconciliator will be released. |
|
-
To retrieve the help information:
CATPDMReconcileEV5Batch -help
-
To run the reconciliation:
CATPDMReconcileEV5Batch -file filename [-structure] [-simul (Execute|Rule|NoRule]]
[-checkDoc numberOfDocs]
[-reload docname] [-keepExternal docname] [-publication docname]
[-outputFileList] [-inxml fileName [-completeWithDefaultMapping] [-epexml
fileName] [-queryName queryname] [-xml filename] [-newVersion
object] [-newRevision object] [-forceNewVersion] [-server xxx] [-role xxx] [-user xxx] [-pwd xxx]
|
|
Arguments
-help Help
-file filename : Name of the CATIA file to be loaded
and reconciled. Several file statements are possible.
-structure : Enable to switch from a full document Publication
Exposed to a mode where CATProducts are save in Structure Exposed.
-simul Execute|Rule : Enable not to execute
Save or Apply in VPDM.
Execute means
that reconciliation is applied, but the save is not done.
Rule means
that the mapping and rules are set but neither the reconciliation is
applied nor the save is done.
NoRule means
that only reconciliation session creation is done.
-reload docname : Enable to set rule to Reload instead of
Overwrite for an object with a specified name. Several reload statements
are possible.
-keepExternal docname : Enable to set rule to Keep as
External reference for an unloaded document. Several keepExternal
statements are possible.
-publication docname : Enable to set an included
CATProduct document to be Publication Exposed when the main CATProduct
document is in Structure Exposed mode. (only possible when -structure
parameter is used). |
|
-checkDoc
Provide number of documents in the Reconcile session for validation.
-outputFileList Enables to define the file path of the output file
containing the files that will be reconciled.
-inxml Enables to specify an input EpeXML file to restart the batch
from a previous reconcilation session; this option should be used with -completeWithDefaultMapping
if the XML file does not specify the mapping for all objects.
-epexml Enables to generate an EpeXML file that will be used with
option -inxml. |
|
-queryName queryname : Name
of the criterion to be searched (Default is Query by object Id). -xml
filename : Stream Reconciliation session in an XML
file. -newVersion object : object can
either be the name of a document or a part version. When a
document is specified (for example PartA.CATPart) the New Version rule
will be set on the publication exposed CATPart. When a part version is
specified, the New Version rule will be set on all eligible mapped
objects under the specified part version. Several new version
statements can be issued in one command. -newRevision
docName : sets the new revision rule on the specified document.
Several new revision statements can be issued in one command. -forceNewVersion: results in all documents
(for example, CATDrawings) being saved as new
revisions and all publication exposed CATProducts and CATParts being
saved as new versions.
Global Set |
Parameter |
Meaning |
Values |
New |
forceNew |
force even on mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
Query |
queryName |
query name |
Name of query (as displayed in the reconciliater
panel) |
|
skipWhenMapped |
skip or not already mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
|
implicitRule |
the rule of all objects that are mapped is set to
Overwrite and all objects that are not mapped is set to
New. |
YES (or TRUE)
NO (or FALSE)YES is the default. |
StructureExposed |
No parameters |
|
|
PublicationExposed |
No parameters |
|
|
Overwrite |
forceOverwrite |
force overwrite even on mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
NewVersion |
forceNewVersion |
all objects, even those with rules already defined
on them, will be set to New Version, if
possible. |
YES (or TRUE)
NO (or FALSE)NO is the default. |
|
onlyOnDocuments |
version only part version of the CATPart documents |
YES (or TRUE)
NO (or FALSE)NO is the default. |
Reload |
forceReload |
force reload even on mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
NewRevision |
forceNewRevision |
force new revision even on mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
KeepExternal |
forceKeepExternal |
force keep external even on mapped objects |
YES (or TRUE)
NO (or FALSE)NO is the default. |
SearchNode Filter Inputs |
Availability |
Meaning |
Values |
ScmType |
|
Scm object type |
ANY, PART, ANYDOC, DOC |
DocExt |
available if Type is ANYDOC, DOC or PROXYDOC |
the extension of the document |
string |
SubTree |
|
name of the Scm object considered as the root of the
tree |
|
Name |
|
name of the Scm object |
string |
FileName |
available if Type is ANYDOC, DOC or PROXYDOC |
name of the file corresponding to the document |
string |
State |
|
status |
ANY, MAPPED, NOTMAPPED |
Mode |
|
exposition (storage) mode |
ANY, PUBEXP, STRUCTEXP |
<Attr Name> |
|
attribute name/value pair. Attr Name is
actually the display name of the attribute (for example,
owner). |
string |
-server xxx : Provide a connection string describing how
to establish a connection to VPDM repository. -role xxx : Role used for ENOVIA V5 VPM connection. -user
xxx : User for ENOVIA V5 VPM connection. -pwd xxx : User password for database connection. |
|
Building the reconciliation session
from information given in an input XML file enables the user to explicitly
indicate which rule and mapping will be applied to each object to be
reconciled. The basic scenario is as follows:
- First the batch user runs a reconciliation in simulation
mode (simulation mode is specified using the
option -simul on the batch command line) and using the
command line parameter -epexml so that the batch will
generate an XML file (called EpeXML file) of the reconciliation session
state. This XML file will be used as a pre-valuated template in the
ensuing steps.
- The user will eventually have to complete the generated
EpeXML file to resolve those ambiguities that were not resolved by the
simulation (e.g. if the query returned several results, the mapping
must be completed by hand). The user can also modify the EpeXML file to
explicitly indicate the rule and mapping to be applied to a given
object.
- Then using the completed EpeXML file, the user reruns the
reconciliation batch with the command line parameter -inxml.
- The batch can be rerun multiple times using the same EpeXML
file with -inxml command line parameter.
|
|
Examples
When running batches, you must always:
- use the command catstart
- the catstart environment (option -env) to be used is the
same as the environment used with VPM Navigator.
For more details, see the Infrastructure Guide, Basic Tasks, Starting
a Session on Windows.
set CNEXTOUTPUT=E:\tmp\trace.txt
catstart -run "CATPDMReconcileEV5Batch -file \"E:\DataREC\RECV5_TEST1rootprc.CATProduct\"
-structure -queryName \"Query by object Id\" -user odtitp -pwd xxxxx
-role VPMADMIN.ADMIN.DEFAULT -server \"servername:portnumber\""
- Reconciliation of an assembly
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct:
set CNEXTOUTPUT=E:\tmp\trace.txt
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-structure queryName "Query by object Id" -user odtitp -pwd xxxxx
-role VPMADMIN.ADMIN.DEFAULT -server "xxxxxxxxx:nnnn"
- Reconciliation with reload of CATParts
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct containing two CATParts
RECV5_TESTPART1.CATPart and RECV5_TESTPART2.CATPart:
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query by object Id" -reload RECV5_TESTPART1.CATPart
-reload RECV5_TESTPART2.CATPart
- Reconciliation with sub-products as publication exposed
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct containing two sub-product
RECV5_TEST1prd1.CATProduct and RECV5_TEST1prd2.CATProduct:
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query by object Id" -publication
RECV5_TEST1prd1.CATProduct -publication RECV5_TEST1prd1.CATProduct
- Reconciliation with CATParts as KeepExternal
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct containing two CATParts
RECV5_TESTPART1.CATPart and RECV5_TESTPART2.CATPart that are missing
(broken link):
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query by object Id" -keepExternal RECV5_TESTPART1.CATPart
-keepExternal RECV5_TESTPART2.CATPart
- Reconciliation with CATParts when the Part Number is different from
the file name
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct containing two CATParts
RECV5_TESTPART1.CATPart and RECV5_TESTPART2.CATPart when the part
number is not equal to the file name. The queries Query by Object
Id and Easy Query will failed in this case, the correct
query to use is Query Document by Part Id.
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query Document by Part Id"
|
|
- Generating an EpeXML file with a reconciliator batch
simulation
To generate an EpeXML based on a workpackage
composed of e:\DataREC\RECV5_drawing.CATDrawing and e:\DataREC\RECV5rootprc.CATProduct,
the command line is:
CATPDMReconcileEV5Batch -file "e:\DataREC\RECV5_drawing.CATDrawing"
-file "e:\DataREC\RECV5rootprc.CATProduct"
-structure -queryName "Query by object Id" -simul Rule
-epexml "e:\tmp\XMLSessionEpe.xml"
- Rerunning a session using an EpeXML file
The
previously generated and modified EpeXML file can be used to rerun the
session:
CATPDMReconcileEV5Batch -file "e:\DataREC\RECV5_drawing.CATDrawing"
-file "e:\DataREC\RECV5rootprc.CATProduct"
-inxml "e:\tmp\XMLSessionEpe.xml"
-
Reconciliation of an assembly with two leaf CATParts, one to
be saved to ENOVA V5 VPM as new version and the other as new revision
(Note that saving as new version will version the part and revision the
corresponding geometry document)
Here is an example of the command line to use to reconcile an
assembly RECV5_TEST1rootprc.CATProduct containing two CATParts
RECV5_TESTPART1.CATPart and RECV5_TESTPART2.CATPart. :
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query by object Id" -newVersion RECV5_TESTPART1.CATPart
-newRevision RECV5_TESTPART2.CATPart
-
Reconciliation of an assembly with two leaf CATParts and a CATDrawing
document
This example uses the -forceNewVersion to create new versions of the
leaf parts (which also created new revisions of their corresponding
CATPart documents) and a new revision of the CATDrawing.
CATPDMReconcileEV5Batch -file E:\DataREC\RECV5_TEST1rootprc.CATProduct
-queryName "Query by object Id" -forceNewVersion
-
-
-
|
|
Limitations
- Only one assembly structure (one PRC):
The -file option can be used to reconcile several CATProducts, but the
reconciliation will succeed
only if all the listed CATProducts compose the same assembly structure
because only one assembly
root per reconciliation is accepted.
- Getting traces:
The batch is based on CATIA V5 ApplicationFrame infrastructure, therefore
a CATIA V5 window may appear when running the batch.
The batch therefore needs a running window manager.
The batch runs as a background task and its traces are not displayed in
the window from which it was started. Traces can be retrieved using
CNEXTOUTPUT environment variable.
|
|
Diagnostics
Possible exit status values are:
- 0: Successful completion.
- 4: Failure due to one or more of the standalone documents (-adddoc
documents).
- 8: Failure due to any of the following:
- Query failed
- Load of PDM data failed
- Save of loaded data failed
- Locks could not be obtained
|
|
|
|