Available commands

Category

Command

Context

Explanation/Parameter

Common

Document

single selection

Opens a modal dialog for uploading and linking Documents to business objects.

Open external URL

according to parameter settings (see right)

Opens an absolute or relative URL defined via the URL template parameter as a calculation expression in a new browser tab of the client. The URL is considered absolute if it starts with a protocol identifier (e.g. http:). Otherwise, it is resolved relative to the client URL and may refer to content in the web folder (see File manager).

  • In the URL template parameter, characteristics from the data context can be accessed via the variables loadedItem (detail view), selectedItem or selectedItems (overview). For example, the following expression opens the profile image of the owner of the entity displayed in a detail form in a new tab (if available): avatar/user_avatar_{loadedItem.ownerId}.png

Supported contexts are specified by checkboxes for the following parameters:

  • Supports new item

  • Supports single selection

  • Supports multi-selection

  • Supports no selection

See also: Open external URL (in forms) or Open external URL (in Event handling)

Reload main menu

(any)

Reloads the main menu.

Always hidden

(any)

Hides a specific macro button from a ribbon menu category (see Ribbon macros).

Always disabled

(any)

Disables a specific macro button in a ribbon menu cateogry (see Ribbon macros).

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg IMPORTANTimages/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/warning.svg The option Required must always be set. for this command.

Close

(any)

Closes the overview or form (may ask for confirmation to discard unsaved changes).

Show history list

single selection

Opens a modal view with history list (see History (Business objects)).

Working states

Add

single selection

Opens a dropdown menu with a search to pick Working state to add to the selected business object.

Add: [Working state]

single selection

Sets a specific Working state; a dedicated command is featured for each working state defined.

History

single selection

Opens a modal view with the working state history for the selected business object.

Client workflow

Client workflow

Depending on settings for the parameters listed on the right.

Executes a Client workflow. The following settings are available:

  • Supports new data object

  • Supports single selection

  • Supports multiple selection

  • Supports empty selection

  • Execute only one workflow

  • Lock view: Locks the associated user interface until the workflow has been processed.

Data context

Show

NOT:
new item

Opens a modal dialog with information on data context (view name, menu node name, access mode, matching criteria, permissions);
results for access mode and matching criteria may vary depending on selection.

Details

Cancel

single selection
new item

Cancel edit mode (may call for confirmation to discard unsaved changes).

Edit

single selection

Edits selected object (e.g. by opening input form).

Show details

single selection

Shows detail of selected object (e.g. by opening input form).

Prepare form data


Transfers data from client (form) to the object (without validation).

Get loaded object


Returns the object, e.g. for use in a wizard step.

Copy

single selection

Copies selected object and shows the copy in the input form.

Delete

single selection
multi-selection

Deletes selected object(s), if confirmed.

New

(any)

Initializes the input form with a new object.

Save

single selection

Saves data of selected object (after validating).

Print

Excel

single selection
multi-selection

Creates a file in the selected format (see Print type) using the layout of an applicable print document.

Which Print documents are applicable for an export depends on matching Association criteria.

The selection can be optionally limited by further criteria:

images/download/attachments/106962908/image2021-11-24_18-0-31-version-1-modificationdate-1659101427335-api-v2.png

  • The optional Name pattern parameter can be applied as a search criteria for 'name' to restrict options to a subset of all Print documents applicable according to the all-matching-principle. This pattern may include wildcards (*, % and _) as well as operators like | (disjunction, OR) and & (conjunction, AND).

  • In the Category parameter, a positive list for the Print document category can be optionally defined. Categories can be added and removed via the images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/add.svg and images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/forbidden.svg icons. If information is available, only Print documents that are assigned to one of the selected categories are available for selection.

If this yields no applicable print document, a message is shown upon execution of the command.

If multiple print documents and/or paginations are available, a user choice is polled by a context menu for the button.

If there is only one option available, it is automatically used for 'printing'.

PDF

single selection
multi-selection

RTF

single selection
multi-selection

Text

single selection
multi-selection

Web

single selection
multi-selection

Word

single selection
multi-selection

Zebra

single selection
multi-selection

Custom action event

Dispatch:[Name of action event]

according to parameter settings (see right)

This command is offered for each custom action event.

It is also possible to determine in which situations the command should be executed. The following parameters (checkbox) are available for this purpose:

  • Supports new data object

  • Supports single selection

  • Supports multiple selection

  • Supports empty selection

  • Only one event will be triggered (only one event will be triggered for a multiple selection. Caution: The input object of an event handling is NOT the list of selected objects, but null (nothing). However, the IDs of the selected objects are available in a variable called 'entityIds').

  • Lock view: Locks the associated user interface until the event has been fully processed.

Custom action events are managed via the Custom action event dynamic enumeration.

Export

Show print XML

single selection
multi-selection

Opens a new browser window/tab to show the print XML for the selected object(s).

Export

single selection
multi-selection

Creates Meta exchange export data for the selected object(s).

►NOTE◄ This command is only applicable for configuration objects (and not business objects), which feature the 'Export' button in the main category 'Export' of the default ribbon menu.

Show XML

single selection

Opens new browser window/tab to show XML representation of the selected business object.

Guest user

Add

single selection

Polls an e-mail address for the new Guest users by a modal dialog and triggers the event 'Create guest user' (see Guest user (Events)).

A new guest user can be added by the event action Create guest user by an event handler, that can refer to the selected object as data context, whereas the e-mail address is stored in a variable (guestUserEmailAddress).

List

Search

(any)

Reruns the search in an overview to update the data in the list.

Clear

(any)

Resets filters and sorting criteria in an overview.

Manifest

Create manifest from shipments

single selection
multi-selection
(shipments only)

Opens an input form for Manifests with a new manifest containing the selected Shipments.

This process triggers the event 'Create from shipments', which can be used to optionally handle details.

Add shipments to manifest

single selection
(manifests only)

Opens a modal window with an overview of Shipments to add to the selected manifest (see Manifests).

Shipments selected in the overview can be added to the manifest via the 'Add shipment' (Common/Manifest) button, which also opens the manifest in an input form.

Entity template

New from template

(any)

Initializes a new object from an existing template (see Working with templates).

The context of the template is defined by a static parameter of the command. If there is exactly one template for this context, it is used immediately. Otherwise, the names of all applicable templates are listed as choices in a context menu.

Create template

single selection
new item

Creates a new entity template (see Working with templates) from the current object.

The context of the template is defined by a static parameter of the command. Further properties of the new template (Name, Company-wide flag) are polled form the user by a dialog at runtime.

Delete template

(any)

Deletes an existing template (see Working with templates).

The context of the template is defined by a static parameter of the command. To select the template to be deleted, a context menu appears with the names of the templates for this context.

Portals

Open portal

according to parameter settings (see right)

Opens a specific portal (identified by the Portal name parameter) with specific settings for the following parameters:

  • Prepare profile, prepareDataEncoder, preparateDataDecoder

  • Unique (checkbox)

  • Modal (checkbox)

Further parameters (checkboxes) specify which type of context the macro supports:

  • Supports new item

  • Supports single selection

  • Supports multi-selection

  • Supports no selection

Tracking state


Add

single selection
multi-selection

Opens a context menu with a Tracking state that may be added to the selected object(s) (see Tracking state workflows).

For a multi-selection, the context menu lists only a Tracking state that can be added to all selected objects.
►NOTE◄ If no Tracking state is applicable to all selected objects (empty intersection), an error message appears.

Add specific

single selection
multi-selection

Adds the tracking state specified by the Tracking state parameter to the selected object(s), if allowed (see Tracking state workflows).
►NOTE◄ The button is not disabled automatically if the transition to this tracking state is invalid for one or more selected objects. An error message appears for every failed attempt to add the specified tracking state to one of the selected objects.

History

single selection

The Tracking state history of the selected object is displayed in a modal window.
This can be restricted to a specific status type.
In addition, the history of the tree view can be hidden.

The following commands are only relevant in the Time slot management tool module:

Anonymous booker

Add

single selection
(timeslot booking)


Select time slot

Select

single selection
(timeslot booking)

Selects a time slot

Batch booking

single selection
(timeslot booking)

Batch booking of time slots

Remove batch booking

single selection
(timeslot booking)

Removes batch booking entries

Time slot booking entry

Create

single selection
(shipments only)

Calls event Create header from shipment (see Time slot management tool (Events)) with the selected shipment as data context.