Name | Description |
---|---|
Wex ID | com.wincomplm.wex-coversheet |
Name | Coversheet |
Version | 1.19 |
This extension allows to add cover sheet at the beginning of a an PDF document. This is often required when your PDF are distributed outside of your organization, as a typical use case consists in sending documents to regulation organizations: adding a cover sheet provides an audit trail of approval on a specific date for the PDF.
The sheet is designed with a GUI based tool, called the Report Manager and requires minimal training
The coversheet tools supports documents and can append and remove coversheets.
It requires the following
Go to the Report Manager under the Quick Links
menu
Create a new Template to use as a Coversheet
Go to a document associated to a change and access the menu (you need to be wex admin)
The new UI allows you to download a coversheet
The administrator have access to the following interface
The Persisted Data shows if this document has an existing coversheet added
Various templates may be created using the Report Manager
The templates are stored in Windchill here
A UI is added to both documents and CAD elements so that the admin can manually add a coversheet and test the template
The behavior of which content to process can be adjusted
The exact behavior is as follows
Primary | Secondary | Description |
---|---|---|
no | no | Nothing is processed |
yes | no | The primary is processed if it is a PDF |
no | no | All secondary are processed if they are PDF |
yes | yes | If the primary is a PDF it is processed and no secondary are processed even if they are PDF. If the primary is not a PDF all secondary are processed |
The users that can access the UI must be in the group that can be selected by the configuration or be admins
The coversheet may render dates and these can be configured in the configuration screen of the Report Designer
The extension contains two sets of robots 1 to add the coversheet, the other can be used to publish and wait for the publishing
Once created the templates can be added and removed using the following workflow robots
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover", self, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover", self, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail", self, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail", self, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover-rep", self, businessObject,representable, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover-rep", self, businessObject, representable, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail-rep", self, businessObject, representable, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail-rep", self, businessObject, representable, templateName);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-cover-change-object", self, templateName,includeAffected,includeResulting);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-cover-change-object", self, templateName,includeAffected,includeResulting);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.add-trail-change-object", self, templateName,includeAffected,includeResulting);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-cover-robots.remove-trail-change-object", self, templateName,includeAffected,includeResulting);
Here is a short description of what each of the workflow parameters means:
In addition to the standard keys all String workflow variables are also added to the mapping in the coversheet. For example if the workflow has a variable called user-data
it will be available in the template as ${user-data}
The first robot will send the object or containing object to be published
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-publish-robots.publish",self, republish, purge);
This robot will return true for as long as there is one item still to be published
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","workflow-publish-robots.isWaitingToPublish",self);
It is used in a loop with a timer
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke(“com.wincomplm.wex-coversheet”,“workflow-cover-robots.remove-trail-change-object”, self, templateName,includeAffected,includeResulting);
Similar to the workflow robots, download, overwrite/add and remove a coversheet using the API methods. The API provides the user with 3 different actions.
Downloading and overwriting actions offer the possibility to pass a specific process or no process at all. In case the process is not specified, the latest process will be used.
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","cover-api.download-coversheet", process, document, businessObject, template, coveronly, reportPosition, userData);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","cover-api.download-coversheet", document, businessObject, template, coveronly, reportPosition, userData);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","cover-api.add-coversheet", process, document, businessObject, template, reportPosition, userData);
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","cover-api.add-coversheet", document, businessObject, template,
reportPosition, userData);
Description of each parameter used above:
com.wincomplm.wex.kernel.api.invoke.WexInvoker.invoke("com.wincomplm.wex-coversheet","cover-api.remove-coversheet", persistable, reportPosition);
Description of each parameter used above:
The diagnostic tools is available to test the workflow robot
It requires the process and template to be entered