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).
Supported contexts are specified by checkboxes for the following parameters:
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).
|
|
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:
|
Data context |
Show |
NOT: |
Opens a modal dialog with information on data context (view name, menu node name, access mode, matching criteria, permissions); |
Details |
Cancel |
single selection |
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 |
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). |
|
|
Excel |
single 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:
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'. |
|
single selection |
||
RTF |
single selection |
||
Text |
single selection |
||
Web |
single selection |
||
Word |
single selection |
||
Zebra |
single 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:
Custom action events are managed via the Custom action event dynamic enumeration. |
Export |
Show print XML |
single selection |
Opens a new browser window/tab to show the print XML for the selected object(s). |
Export |
single 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 |
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 |
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 |
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:
Further parameters (checkboxes) specify which type of context the macro supports:
|
Tracking state |
Add |
single 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. |
Add specific |
single selection |
Adds the tracking state specified by the Tracking state parameter to the selected object(s), if allowed (see Tracking state workflows). |
|
History |
single selection |
The Tracking state history of the selected object is displayed in a modal window. |
|
The following commands are only relevant in the Time slot management tool module: |
|||
Anonymous booker |
Add |
single selection |
|
Select time slot |
Select |
single selection |
Selects a time slot |
Batch booking |
single selection |
Batch booking of time slots |
|
Remove batch booking |
single selection |
Removes batch booking entries |
|
Time slot booking entry |
Create |
single selection |
Calls event Create header from shipment (see Time slot management tool (Events)) with the selected shipment as data context. |