By defining user actions for a lifecycle state, you allow users to perform those actions on documents in that state, for example, start a workflow or move documents into another state. Additional types of user actions are available for specific features and applications, like Send to CLM for the CLM Integration feature. Once active, the user actions appear in the Actions menu for documents or binders that are in the selected state. User actions respect the Vault’s access controls, so only users with the correct permissions for an action will see it in the menu.
Accessing User Action Administration
You can configure user actions for a specific lifecycle state from Admin > Configuration > Document Lifecycles > [Lifecycle] > States > [State] > User Actions. You must have a security profile that grants Admin: Document Lifecycles permissions.
Action Types
You can configure the following types of actions:
- Change State to
- This type of action allows the user to manually move a document into a different lifecycle state. Vault enforces entry criteria and entry actions for the state change.
- Create Related Record
- This type of action allows the user to create a related object record without leaving the document viewer. This action is only available for objects with at least one active document reference field. If the document reference field is version-specific, Vault auto-selects the current document version.
- Generate Form
- This action is only available if enabled and configured. It uses one or more configured XFA forms, XML Element object records, and data from the document/binder where users trigger the action to create and populate a new form document.
- Web Action
- Initiates a preconfigured web action. Some options may be automatically available within Web Action in your Vault.
- Workflow
- This action starts the specified workflow. Only workflows that are already configured and active for the selected lifecycle are available. Only one user action can exist in each state for a single workflow.
Your Vault may have additional custom actions which are not listed here. These actions are created by your organization with the Vault Java SDK to meet your specific business needs. Talk to your Vault Administrator to learn more about these actions.
Action Types in PromoMats Vaults
- Add Material and Regenerate Compliance Package
- This action is only available in PromoMats Vaults that are configured for eCTD Compliance Package Generation. It allows users to add documents to the binder and regenerate the Compliance Package.
- Harvest Claims
- This action allows users to create claims by harvesting metadata from link annotations on steady state documents. Users must have
annotation_keywords__sysobject permissions to perform this action.
Action Types in PromoMats & MedComms Vaults
- Create Email Fragment
- This action is only available in PromoMats and MedComms Vaults that are configured for Approved Email Integration. It creates an email fragment for a document by applying a master email fragment.
- Create Presentation
- This action is only available in PromoMats and Medcomms. It creates multiple Multichannel Slide documents and a Multichannel Presentation binder from a single document. This applies to Vaults that are configured for Engage integration or CLM integration.
- Create Related Document or Binder
- This option is only available in PromoMats and Medcomms Vaults. This action allows users to simultaneously create a new document or binder, and a relationship from a source document. For example, when a document enters an Approved state, you can choose to create a new document along with the necessary outbound relationship to the source document.
- Send to CLM
- This action is only available for PromoMats and MedComms. It publishes documents and binders to CLM. This applies only to Vaults configured for CLM integration and documents or binders configured as CLM content.
- Send to CRM
- This action is only available for PromoMats and MedComms. It opens a dialog allowing the user to type in the credentials to publish documents and binders to a specific CRM application. This applies only to Vaults configured for the older version of CRM Client integration and documents or binders configured as CLM content.
- Send to Engage
- This action is only available in PromoMats and MedComms Vaults that are configured for Engage Integration. The action only applies to documents or binders set as Engage content. It publishes documents and binders to the Engage player.
- Obsolete dropped slides
- This action is only available for PromoMats and MedComms Vaults with Engage integration or CLM integration enabled. It moves Multichannel Slides removed from a Multichannel Presentation to their lifecycle’s Obsolete state. You should apply this user action to the presentation lifecycle’s Steady state.
- Obsolete related presentation and slides
- This action is only available for PromoMats and MedComms Vaults with Engage integration or CLM integration enabled. It moves any Multichannel Slide or Multichannel Presentation to their lifecycle’s Obsolete state when the document they were generated from moves to an Obsolete state. To apply this user action, you must set a specific state for the Obsolete state type on a document lifecycle that includes the Create Presentation user action.
How to Create User Actions
To create a new workflow user action:
- From the User Actions tab, click Edit.
- Click Create Rule.
- Optional: Select All conditions are met or Formula evaluates to True if the user action should only appear for documents that meet certain conditions. See details.
- Under Allow the following actions, select a user action type. See details.
- Define details for the user action. For example, with a workflow action, you need to select a specific workflow and enter a label.
- Optional: Add additional actions by clicking Add action. If the rule is conditional, these additional criteria will share the same conditions.
- Click Save. The action is immediately available to users with the correct permissions.
Note: If your Vault uses Atomic Security for Documents: Document Lifecycle Actions, the new action may not be accessible to users. Navigate to the Atomic Security tab. From here, you can review the default access for the new action and set override access if needed. Learn about Atomic Security for Documents.
How to Define Conditions
Certain user actions are only available when the document meets a set of conditions. For example, different workflows could be available for US documents and UK documents, so the workflow user action could be conditional based on the document’s Country field.
To define conditions, select All Conditions are met, and then a document field, operator, and value. Some system fields and most fields associated with document types that use the lifecycle are available. You can also select Formula evaluates to True to use a formula expression that returns a boolean (true/false) expression to define the condition. The user action executes only if the formula returns a true expression. If needed, you can define multiple conditions by clicking Add condition.
A document must meet all of the conditions defined within a rule for Vault to make the user actions available. If a condition uses a field that does not apply to the document, Vault does not validate that condition.
Note: If you select Formula evaluates to True to define a condition, you can use the Fields panel to select fields and data from the User object for the current user.
About Referencing Missing Records in Criteria & Actions
When you clone a lifecycle configuration during Vault provisioning, references to specific object records in entry criteria or conditions may become invalid if those records do not exist in the new environment. If this occurs, references to missing object records are shown as empty in lifecycle configuration fields.
While Vault allows you to save configurations even with these missing records, we recommend resolving these missing references by recreating the records with the same ID values using Vault Loader or via the API if you want to use these conditions in the new environment. If you only want to update another configuration and take it back to the source environment, you can leave the missing references as is.
How to Reorder Actions
You can change the order of the options that appear in the Actions menu. To rearrange actions, click and drag the rules themselves, or click and drag the actions within a rule. You can click and drag from the upper left corner.
How to Edit or Delete User Actions
To make changes to user action rules, click Edit. Make any necessary changes. If you need to delete a rule, a condition within the rule, or a user action within the rule, click the X icon on the row. When your changes are complete, click Save.
User Action Rule Limits
For each lifecycle state, you can define up to fifty (50) user action rules. Within a rule, you can specify up to ten (10) actions. If a rule is conditional, it can have up to five (5) conditions.
Vault does not prevent Admins from creating multiple actions with the same Action Label value. When this occurs, a user may see duplicate options in their actions menu.
Create Related Document or Binder Options
There are several fields available for configuring this action:
- Action Label: Indicates how the user action appears to the user.
- Create a Document or a Binder: Specify whether or not users will create a related document or binder.
- Document Type: Specify the document type for the newly related document.
- Lifecycle: Specify the lifecycle of the newly created document. Although document types are typically associated with a single lifecycle, this action allows you to associate multiple lifecycles. Vault only lists lifecycles that are valid for the specified document type.
- Choose Template: This is an optional field that specifies a template to use when creating the document.
- Relationship Type: Specify the relationship type used to relate the new document to the source document. Vault only lists valid relationship types based on the specified document type.
When configuring the Relationship Type field, only the following relationship types are available for selection:
- Relationship types that are valid for the selected document type
- Custom relationship types, or Related Original Document relationship types
- Relationship types that are not source-specific, or if they are source-specific, they have the Carry Forward Source Relationship attribute selected.
Additional Details for Create Related Document or Binder
The Create Related Document or Binder user action does the following:
- Adds a prefix of Related Binder, Related Placeholder, or Related Template to the newly created document name (inherited from the source document). For example, Related Binder – My Presentation.
- Automatically maps all matching field values for custom fields and some standard fields on the source document to the related document.
- Executes asynchronously and sends a notification once the action is complete.
- Creates an outbound relationship from the created document to the source document. Vault bases this on the relationship type configured on the user action.
Supported Standard Fields
The Create Related Document or Binder action automatically maps the following standard object fields on the source document to the related document:
- Product
- Country
- Portal
- CLM Content
- Engage Content
- Directory
- Enable Survey Overlay
- Start Date
- EndDate
- Keyword
- Presentation Id
- Survey
- Training
- Website
- CRM Org
- CRM Product
- CRM Detail Group
Non-populated required fields or mismatched data types will cause the action to fail.