SubmitJobsOnLifecycleTransition

This client customization is intended to be used in combination with the powerJobs Settings Dialog to automatically queue jobs based on certain lifecycle transitions and filter conditions.
It supports all Vault entities: Files, Items, Folders, Change Orders and Custom Objects.

Requires powerJobs Processor

The SubmitJobsOnLifecycleTransition script relies on the configuration from the Job Triggers section of the powerJobs Settings Dialog to work properly.

  • Minimum powerJobs Processor version: 23.0.1

  • Folder state changes require:

The user performing the action must have the Vault Get Options permission to retrieve the trigger settings configured with the powerJobs Settings Dialog.

The script listens to successful lifecycle state changes in Vault and queues the configured job for entities that meet the following conditions:

  • At least one entity transitioned to a configured lifecycle state.

  • All configured filters match the entity.

  • For the powerJobs Processor Sample.CreateDXF&STEPfromSheetmetal job, the Vault environment must be configured correctly document type verification.

This script makes use of Post events and registers the following Vault events:
UpdateFileStates, UpdateItemStates, UpdateFolderStates, UpdateChangeOrderState and UpdateCustomEntityStates.

Vault Configuration

In order to identify sheet metal parts a Vault UDP (User defined property) must be configured to differentiate between document types (i.e. Sheet Metal or regular part, Weldment or regular Assembly).
The User Defined Property must be mapped to the Inventor iProperty Document Sub Type Name (only works with an English or German Inventor/Vault) or to the Inventor iProperty Document Sub Type which contains the required information.
The name of the User Defined Property is automatically determined by script.

To configure the required mapping in Vault, navigate to Tools -> Administration -> Vault Settings -> Behaviors tab -> Properties -> New
Define the name for the new UDP (e.g. Document SubType) and select the categories used for Sheet Metal parts, so it will be automatically listed in the properties panel.
Switch to the Mappings tab and create a new mapping for the provider “Inventor” and select the Doc Sub Type or Doc Sub Type Name (only works with an English or German Inventor/Vault) Inventor property.

../../_images/vault_map_document_subtype_iproperty.png

Autodesk Knowledge Tutorial: Mapping Inventor iProperty to Vault user defined property

Testing

This customization can be tested by performing the following steps:

  1. Open the Vault Client, open the powerJobs Settings Dialog and navigate to the Job Triggers section of the dialog. Configure a job to be queued on a lifecycle transition.

  2. Navigate to an entity of the selected type (e.g. file)

  3. Change the Lifecycle State to the configured state

  4. Open the Job Queue

  5. The Job Queue contains a configured job for the changed file with the set description and priority

Out of the box this client customization is enabled.
When the script is not used it can by disabled by moving it to the %PROGRAMDATA%\coolOrange\Client Customization\Disabled folder.