Specify custom actions

To specify custom actions:

  1. Enter custom fields for each action. See Custom Fields
  2. Add function calls. See Function calls

Custom Fields

Field Type / Max.length Contents
Name String / 30

Name of the action.

Description String / 80

Description of the action that is displayed as tooltip for the action in the toolbar.

Icon String / 100

Icon that represents the action in the toolbars.

Active Type String / 100

Possible values are:

  • Collection: the action is active only if one or several collections are selected.
  • Object Type: the action is active when one or several instances of the Object Type or sub-element are selected.
Active Path String / 100 Type of element that must be selected to activate the action. This setting must only be filled when Active Type is set to Object Type
Selection String / 10

Number of objects that must be selected to activate the action:

  • Any: any number
  • Multiple: several instances
  • None: no instance
  • Single: one instance
Status list collection String / 250

Status of the Collection for which the action is activated.

Possible values are:

  • Empty value (active for all statuses)
  • All statuses declared in Collection Status list
Status list object String / 250

Status of the Object for which the action is activated.

Possible values are:

  • Empty value (active for all statuses)
  • All statuses declared in Object Status list
Except String / 1 Checkbox used to negate the above list of statuses. When checked, the action is displayed for all statuses except the ones set above.
Save required String / 1 Checkbox used to prompt the user.When checked and changes have been made to the Collection and not saved, the user will be prompted to save or cancel.
Show confirmation dialog String / 1

Checkbox used to prompt the user. When checked, the user will be prompted to confirm the execution of the action.

Function calls

Name Type / Max. length Description
Function type String / 80 Execute Action
When String / 10 Function is called BEFORE or AFTER the action.
Library String / 50 Library where the function is declared. This library can be any of the libraries created in the application.
Function String / 50 Name of the function. This function can be any of the functions of the given function type declared in the library specified previously.
Arguments String / 50 Depending on the selected function, specific fields, if any, are displayed dynamically. They correspond to the arguments of the selected function.

Related Links