entityCustomActionDto Data Type

Custom action.

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
appliesTo string attribute 0/1 Entity action applies to
applicableOnEl string element 0/1 EL expression when action button should be visible.
guiPosition string element 0/1 Where action should be displayed. Format: tab:<tab name>:<tab relative position>;action:<action relative position in tab> Tab and field group names support translation in the following format: <default value>|<language3 letter key=translated value> e.g. tab:Tab default title|FRA=Title in french|ENG=Title in english:0;fieldGroup:Field group default label|FRA=Field group label in french|ENG=Field group label in english:0;action:0 OR tab:Second tab:1;action:1
label string element 0/1 Button label.
labelsTranslated languageDescriptionDto element 0/unbounded Button label translations.
script scriptInstanceDto element 0/1 Script to execute.
Properties inherited from enableBusinessDto
code string attribute 1/1 The code
description string attribute 0/1 The description
id long attribute 0/1 The id.
auditable auditableDto element 0/1  
auditableField auditableFieldDto element 0/unbounded  
disabled boolean element 0/1 Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
updatedCode string element 0/1 The updated code.

Example

<EntityCustomAction appliesTo="..." code="..." description="..." id="...">
  <applicableOnEl>...</applicableOnEl>
  <label>...</label>
  <labelsTranslated>
    <languageCode>...</languageCode>
    <description>...</description>
  </labelsTranslated>
  <script>
    <executionRoles description="..." name="...">
      <permissions>
        <permission/>
      </permissions>
      <roles>
        <role/>
      </roles>
      <accessibleEntities>
        <accessibleEntity/>
      </accessibleEntities>
    </executionRoles>
    <sourcingRoles description="..." name="...">
      <permissions>
        <permission/>
      </permissions>
      <roles>
        <role/>
      </roles>
      <accessibleEntities>
        <accessibleEntity/>
      </accessibleEntities>
    </sourcingRoles>
    <scriptInstanceCategoryCode>...</scriptInstanceCategoryCode>
    <type>...</type>
    <reuse>...</reuse>
    <script>...</script>
  </script>
  <guiPosition>...</guiPosition>
  <disabled>...</disabled>
  <auditable created="..." creator="..." updated="..." updater="..."/>
  <auditableFields>
    <auditableField actor="..." changeOrigin="..." code="..." created="..." currentState="..." description="..." entityClass="..." fieldName="..." id="..." originName="..." previousState="...">
      <auditable/>
      <auditableFields>
        <auditableField/>
      </auditableFields>
      <updatedCode>...</updatedCode>
    </auditableField>
  </auditableFields>
  <updatedCode>...</updatedCode>
</EntityCustomAction>