Package com.veeva.vault.sdk.api.action

Annotation Interface DocumentActionInfo

@Target(TYPE) @Retention(RUNTIME) public @interface DocumentActionInfo
Indicates a class is a document action. Describes the action and indicates where the action is available for configuration in Vault.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    label
    UI label of the document action in Vault.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    icon
    Name identifying the icon displayed with the action label in the Vault UI Action Bar.
    String
    lifecycle
    The lifecycle this document action supports, for example, general_lifecycle__c.
    String
    name
    Deprecated.
    as of 18R3.
    Usage[]
    usages
    Defines where in Vault the action is available for configuration.
    String
    user_input_object
    Name identifying object describing user inputs to be collected immediately prior to action execution.
    String
    user_input_object_type
    Name identifying object type describing user inputs to be collected immediately prior to action execution.

  • Element Details

    • label

      String label
      UI label of the document action in Vault. Displayed in various action configurations in Vault Admin. This is distinct from the label given to an action instance when it is configured.
      Returns:
      action type label

    • name

      @Deprecated String name
      Deprecated.
      as of 18R3. Code names are now derived from the name of the top-level class
      Name of the document action in Vault, for example, action__c.
      Returns:
      action name
      Default:
      ""

    • lifecycle

      String lifecycle
      The lifecycle this document action supports, for example, general_lifecycle__c. Default is "", indicating all lifecycles are supported.
      Returns:
      name of the supported lifecycle, if the action is constrained to a particular lifecycle
      Default:
      ""

    • usages

      Usage[] usages
      Defines where in Vault the action is available for configuration. Default is UNSPECIFIED, meaning the action is available everywhere actions are supported.
      Returns:
      usages in Vault where the action is available for configuration
      Default:
      {UNSPECIFIED}

    • user_input_object

      String user_input_object
      Name identifying object describing user inputs to be collected immediately prior to action execution. Default is "", indicating no inputs are required.
      Returns:
      name of object, if user inputs are required
      Default:
      ""

    • user_input_object_type

      String user_input_object_type
      Name identifying object type describing user inputs to be collected immediately prior to action execution. Default is "", indicating no type specialization of inputs over that indicated by object value if user_input_object is specified. Default value may also indicate no inputs are required.
      Returns:
      name of object, if type specialization of inputs is required
      Default:
      ""

    • icon

      String icon
      Name identifying the icon displayed with the action label in the Vault UI Action Bar. Default is "", indicating no icon is displayed and the action is not eligible to appear in the most frequently used section of the Action Bar. Learn more about action icons in the Vault Developer Portal.
      Returns:
      action icon name
      Default:
      ""