Documentaction
Class: code
Documents can have custom actions that perform specific instructions. You can use a custom action to automate certain business processes.
Learn about Record Role Triggers in Vault Help.
| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault's base language. Although you can enter up to 60 characters, the Vault UI only displays the first 40 characters. |
active | Type: Boolean | Indicates whether the component is active. |
checksum | Type: String Max length: 1500 | Used to check data for errors. |
icon | Type: String Max length: 1500 | Specifies the icon to display for your action in the Vault UI Actions menu. If omitted, no icon is displayed and the action is not eligible to appear in the the most frequently used section of the Action Bar. See the Vault Java SDK Documentation for a list of allowed values. |
lifecycle | Type: Component | The lifecycle where this document action is available. |
source_code | Type: SdkCode Max length: 1048576 | The source of this document action. For example, Custom means this is a custom action developed with the Vault Java SDK. |
usages | Type: String Max length: 1500 Multi-value | Specifies where in Vault this action is available for configuration and execution. For example, User Action or Entry Action. UNSPECIFIED means the action is available everywhere document actions are supported. |
user_input_object | Type: Component | If your action takes user input, identifies the user input object. |
user_input_object_type | Type: Component | If your action takes user input, identifies the user input object type. |
Supported Operations
Section link for Supported Operations| Operation | Support |
|---|---|
| Create | |
| Recreate | |
| Alter | |
| Drop | |
| Rename | |
| Describe | |
| Generate Recreate | |
| Queryable |