Enabling Publish Rules
Your site administrator establishes whether Publish Rules Processing is to be used. This is done by including the names of all Authoring Applications that use Publish Rules processing in the WVS property publish.usesPublishRules in the wvs.properties file.
The publish.usesPublishRules property uses the syntax
publish.usesPublishRules=<AuthoringApplication> <AuthoringApplication>
Where <AuthoringApplication> is the specified internal name of an MCAD or ECAD authoring application in a space separated list of one or more authoring applications.
For example, using the xconfmanager utility, to use Publish Rules for processing EPMDocuments authored by the Windchill Arbortext or Creo Parametric applications only, set the property to
publish.usesPublishRules=ARBORTEXT PROE.
No other authoring applications are affected by Publish Rules in this example.
Use the internal names of all authoring applications to establish Publish Rules, as for all other configuration setting that use authoring applications. The following table lists some of the Authoring Application names used in the Publish Rules evaluation:
Authoring Application Name
|
CAD Application
|
ARBORTEXT
|
Windchill Arbortext
|
ISODRAW
|
Windchill Arbortext IsoDraw
|
CADDS5
|
Creo CADDS 5
|
COCRDRAFT
|
Creo Elements/Direct Drafting
|
COCRMOD
|
Creo Elements/Direct Modeling
|
GALAXY
|
Creo Illustrate
|
PROE
|
Creo Parametric
|
RSD
|
Creo Schematics
|
INVENTOR
|
AutoDesk Inventor
|
CATIA
|
Dassault CATIA V4
|
CATIAV5
|
Dassault CATIA V5
|
SOLIDWORKS
|
Dassault SolidWorks
|
UG
|
Siemens NX
|
The process for enabling publish rules is outlined below:
1. An administrator must load a Publish Rules XML files into a WVS Configuration Template. The Administrator can create WVS Configuration Templates in Product/Project/Library, Organization, or Site contexts.
If you receive an error message when loading the Publish Rules XML file, there is a discrepancy in the syntax. For assistance in finding and correcting any errors, see “Investigating Publish Rules Errors”.
2. When determining whether to publish an EPMDocument, WVS checks whether the authoring application for the EPMDocument is listed in WVS Property publish.usesPublishRules.
3. If WVS finds the authoring application in the publish.usesPublishRules property entry, the EPMDocument’s Product/Project/Library, Organization, and Site contexts are searched hierarchically for a WVS Configuration Template containing a Publish Rules XML file.
◦ The first Publish Rules file found during that search is used during Publish Rules Evaluation.
◦ If a Publish Rules file is not found during this search, processing continues as if the authoring application was not configured for Publish Rules Processing.
4. Publish Rules Processing needs to match to a <publish on=value/> in the publish rules in order for a job to be created and submitted. There are five values that trigger Publish Rules processing:
◦ <publish on=”checkin”/> — the trigger for Publish Rules evaluation is a publish job for an EPMDocument resulting from a check-in.
◦ <publish on=”create-representation”/> — the trigger for Publish Rules evaluation is a publish job for a New Representation action (via the New Representation wizard) executed from an EPMDocument (or its owner-associated WTPart) from the Representations/Annotations table.
◦ <publish on=”schedule”/> — the trigger for Publish Rules evaluation is a publish job for an EPMDocument resulting from a job submitted using WVS Job Scheduler Administration.
◦ <publish on=”unknown-source”/> — the trigger for Publish Rules evaluation is a publish job resulting from any other event, such as from a manual republish, republish on change, workflow initiated (doPublish), etc.
◦ <publish on=”manual-post”/> — specifies that a matching EPMDocument can have manual post-publishing of its representations invoked from the Representations/Annotations table. See
Manual Post Publishing for details.)
Use Case for <publish on=”unknown-source”/> — To ensure that a job is submitted, at the bottom of the rules file, include one or more “fall back” <publish on=> tags. For example, assume that the WVS property publish.republishondocumentchange or publish.publishondocumentchange has been set to true. When using Publish Rules, you must have a publish on=”unknown-source”/> tag in the rules in order to have publish jobs submitted when performing a set state action. For an illustration of the syntax, see the example PublishRules.xml file that resides in <Windchill>/codebase/com/ptc/wvs/server/xml.