Previous Topic Next topic Print topic


Action Descriptor

An action descriptor describes a sequence of tools. Actions can be executed at the following locations:

Attribute Type Meaning
ID * ID * The ID of the action descriptor.
Label [O] String The labeling of the action descriptor. The label of an action descriptor is mainly seen in the context menu.
Execution Mode Selection Valid values are MODAL or MODELESS. The action is executed in the background if you are using the MODELESS option which means that the UI is not blocked until the action has finished.

For ISPF non-dialog tools you must make sure that no parallel ISPF requests are sent to one ISPF session. Therefore it is recommended to use the MODAL option, whereas for ISPF dialog tools it is best practice to use the MODELESS execution mode.

Table Structure [O] Element List Structure Only to be set if a tool returns an element list.

The element list is then assigned to the selected element list structure. See Table Structure for more information.

Key Binding Context [O] Selection The binding context in which a set key binding sequence is active (see Key Binding for more details).

The key binding context is ignored if no key binding sequence has been set.

The default value is AWM Team Developer Element Views.

Key Binding Sequence [O] Key Sequence The keystroke combination to execute the action (see Key Binding for more details).
Link Element List Boolean Only to be set if a tool returns an element list.

If set to true, the created element links to the context resource of the action. Ignored if no element list is created. See Linked Element List for more information.

The default value is true.

Mass Processing Boolean To be set if enabling mass processing for multi selections.

If set to true, the action executes only once, even if several elements are selected. Tools of the action must support mass processing to process the whole selection. See Mass Processing Overview for more information.

The default value is false.

Related_Save_Action [O] ActionDescriptor To be set if dealing with an Edit action. The selected Save action executes when saving the editor.
Related_Close_Action [O] ActionDescriptor To be set if dealing with an Edit or Browse action. The selected Close action executes when closing the editor.
Refresh_List Boolean If the action is executed on elements in the Team Developer Table view and this attribute is set to true, the current element list is refreshed at the end of the action by executing the action that was used to create the list. This attribute does not support refreshing element lists in the Team Developer Tree view.

The default value is false.

Icon [O] Icon The icon of an action descriptor can be seen in context menus.
Table_View_ID [O] String The Team Developer View secondary ID, which shows element lists created by this action. You can overwrite this value with the value set in the element list structure.  
Table_View_Label [O] String The label that the Team Developer Table View takes when showing element lists created by this action. You can overwrite this value with the value set in the element list structure.  
Relationship Cardinality Description
Has_Tool 1..* Relationship to a tool descriptor. The tool sequence for an action arises through these relationships.

Samples

Action Descriptor SCLM_ACT_DeleteLockEntry

Attribute

Value

Explanation

Element List Creation

not relevant as the action doesn't create an element list

Essential

ID

SCLM_ACT_DeleteLockEntry

unique identifier of the action in this model

Key Binding

not relevant as no short key is defined for the action

Optional

Execution Mode

Modal

Actions containing tools of type "Execute ISPF Command" should always be executed in modal mode.

Icon

Reference to the icon SCLM_ICON_ACT_Delete

Icon shown in the context menu in front of the action label.

Label

Delete Lock-Entry...

Label shown in the context menu for the action.

Mass Processing

false

The tools of this action are designed only to delete a single element per call.

Refresh List

false

The element list should not be refreshed after the execution of this action.

Save/Close

not relevant as the action isn't an edit action

Action Descriptor SCLM_ACT_DeleteMember

Attribute

Value

Explanation

Element List Creation

not relevant as the action doesn't create an element list

Essential

ID

SCLM_ACT_DeleteMember

unique identifier of the action in this model

Key Binding

not relevant as no short key is defined for the action

Optional

Execution Mode

Modal

Actions containing tools of type "Execute ISPF Command" should always be executed in modal mode.

Icon

Reference to the icon SCLM_ICON_ACT_Delete

Icon shown in the context menu in front of the action label.

Label

Delete member...

Label shown in the context menu for the action.

Mass Processing

true

The tools of this action are designed to support processing more than one element. The modelled MassProcessing input parameters for all selected elements are passed to the tools of the action all at once.

If the tool is of type "Execute ISPF Command" the parameters are passed via the ISPF table TAUTOTIP.

Refresh List

false

The element list should not be refreshed after the execution of this action.

Save/Close

not relevant as the action isn't an edit action

Action Descriptor SCLM_ACT_FilterMemlist

Attribute

Value

Explanation

Element List Creation

Link Element List

true

The created element list is linked to its parent. This means among others that the element list is deleted when the parent filter is deleted.

Table Structure

reference to the Element List Structure SCLM_ELIST_Member

The element list structure to be used when the element list generated by a tool of the action is displayed in the TD Table view.

Table View ID

---

Only relevant if the element lits should be shown int a secondary view ID of the secondary view in this case..

Table View Label

---

Only relevant if the element lis should be shown in a secondary view. Label of the secondary view in this case.

Essential

ID

SCLM_ACT_FilterMemlist

unique identifier of the action in this model

Key Binding

not relevant as no short key is defined for the action

Optional

Execution Mode

Modal

Actions containing tools of type "Execute ISPF Command" should always be executed in modal mode.

Icon

---

For this action no icon is defined.

Label

Filter SCLM Members

Label shown in the context menu for the action.

Mass Processing

false

The tools of this action aren't designed to support processing more than one element per call. Typically an action generating an element list won't support mass processing.

Refresh List

false

The action itself produces an element list.

Save/Close

not relevant as the action isn't an edit action

Previous Topic Next topic Print topic