Configuring Outbound Actions
For Outbound Actions to be passed from ASM Core to the external system, you need to configure ASM Core by mapping, for each Outbound Action type, the fields from ASM Core to those of the external syst
In parallel, you must also configure the external system to specify what must happen when it receives an Action sent by ASM Core (for example, initiate a workflow, send a notification, and so on).
Each connector supports a number of Outbound Actions specific to the third-party system it connects to.
The mappings defined in the Outbound Actions window do not apply to outbound action tasks. They must be defined at the level of the task.
Viewing Outbound Action Type Mappings
Select Menu and then Admin.
From the submenu, select Integration.
The Integration Platform Settings window appears. Select the Outbound Actions option from the explorer pane.
Select a source from the Filter by Source list to view outbound action types configured for the selected source. This displays the outbound action types configured for the selected source in the browse table. Outbound action types depend on the source system at the connector level, and are therefore read-only.
If selected, the Mapped checkbox indicates that details for the outbound action type have been added. It does not necessarily mean that incoming and outgoing transactions for the action type have been mapped
To access the mappings for an Outbound Action type, double-click the outbound action type in the browse table. The Outbound Action Type Mappings window appears, displaying the following information.
Source | displays the name of the selected source from which the outbound action type is derived |
Outbound Type | displays the name of the outbound action type |
The Mappings browse table displays the following details about a mapping:
Mapping | the name of the mapping specified when defining the mapping details |
Screen Set | the name of the call or task screen set defined in the mapping details |
You can view, add, or delete a data mapping for the outbound action type. You can also change the priority of the data mappings defined for this outbound action type.
Adding an Outbound Action Type Mapping
Select Menu and then Admin.
From the submenu, select Integration.
The Integration Platform Settings window appears. Select the Outbound Actions option from the explorer pane.
Select a source from the Filter by Source list to view outbound action types configured for the selected source.
Select the New button.
Specify the Outbound Action Type mapping details.
Select the Save icon to save the changes.
Updating an Outbound Action Type Mapping
Select Menu and then Admin.
From the submenu, select Integration.
The Integration Platform Settings window appears. Select the Outbound Actions option from the explorer pane.
Select a source from the Filter by Source list to view outbound action types configured for the selected source.
Select the Outbound Action you want to update and select the Action icon, or double-click on the entry.
The Outbound Action Type window appears. View or update the details as required.
Select the Save icon to save the changes.
Deleting an Outbound Action Type Mapping
Select Menu and then Admin.
From the submenu, select Integration.
The Integration Platform Settings window appears. Select the Outbound Actions option from the explorer pane.
In the browse table, select the Action you want to delete and select .
Confirm the deletion.
Changing the Priority of Mappings
ASM Core will apply the mappings in the order in which they appear in the Mappings browse table.
If more than one mapping applies to an action, then the mapping that is higher in the list will be applied first, then the second one in the list, and so on.
Select Menu and then Admin.
From the submenu, select Integration.
The Integration Platform Settings window appears. Select the Outbound Actions option from the explorer pane.
Select a source from the Filter by Source list to view outbound action types configured for the selected source.
Select a mapping you want to move, and use the Move up and Move Down buttons to reposition it.
Repeat for any other mappings you wish to reposition.
Select the Save icon to save the changes if appropriate.
Specifying the Outbound Action Type Mapping Details
The mapping details window for an Outbound Action allows you to define the conditions that must be met for ASM Core to initiate an Outbound Action, and how data fields will be mapped between the two systems.
The following are the main steps for defining an Outbound Action mapping:
Associate external suppliers and contracts with the Outbound Action.
Select the actions (rules) you want ASM Core to take when it receives incoming messages associated with the Outbound Action.
Selecting when ASM Core must send outgoing messages for the Outbound Action.
Mapping the fields between ASM Core and the source system for both incoming and outgoing messages. This is required for an Outbound Action to be successful.
The mappings defined here are only applied when a call or External Supplier task is forwarded externally. An Outbound Action initiated by an Outbound Action task uses the mapping defined on the task.
Click New or select an existing mapping and click Open on the Outbound Action Type Mappings window.
The Source and Outbound Type fields are pre-populated based on the source and type you selected to access this mapping.
Complete the details.
| Name | Type a name for the mapping. This name appears in the Mappings table. | ||||
|---|---|---|---|---|---|
Screen Set | select a call or External Supplier task screen set from the multi-tiered list. The screen set determines the fields that will be available for this mapping under the Fields – Outgoing and Fields – Incoming tabs.
| ||||
call screen set | Select to enable the Outbound Action to trigger when a call is forwarded externally. Call screen sets are defined by your system administrator. | ||||
External Supplier | Select to enable the Outbound Action to trigger when an External Supplier task is forwarded externally. External Supplier task screen sets are defined by your system administrator. |
If you change the screen set after defining outgoing or incoming field mappings, a warning appears indicating that some field mappings may become invalid.
To associate an external supplier and contract with the Outbound Action mapping, select the Suppliers & Contracts tab.
| External Supplier | Select a supplier |
|---|---|
Contract | Select a contract. If you do not specify a contract, the Outbound Action will be matched by the external supplier only. |
You cannot specify the same supplier and contract (per screen set) for more than one Outbound Action mapping. However, you can link an external supplier to one mapping and the same supplier plus a contract to another mapping.
In this case, the most specific mapping will be applied: if the call or task is forwarded to a supplier and contract matching the supplier and contract specified on the second mapping, this mapping will be applied. If not, it will use the default mapping for that supplier.
Click Add to add the supplier and/or contract to the browse table. Whenever a call or External Supplier task is forwarded to that external supplier and/or contract, this Outbound Action mapping will be applied.
Select the Action tab and specify the rules for Incoming and Outgoing Transactions using this mapping.
Select the Fields - Outgoing tab and specify how field values from the ASM Core call or External Supplier task must correlate with the field values on the external system when an outgoing message is sent by ASM Core.
To map a field, click Add. In the Add Fields window, select the fields (from the external system) you want to map to fields on the call or task, and click OK. On the browse table, click the corresponding cell in the Internal Field column. Then select to pick a static value or a field relating to the Call or External Supplier Task screen set you selected earlier.
Depending on the field’s data type, additional options can be selected in the field selector , including: field transformations, profile maps, or resolution rules. Also, the call or task fields displayed are determined by the screen set. You can only select a field that is compatible with the field specified in the Action Field column.
Select the Fields – Incoming tab and specify how the field values from the external system must match the field values on the call or External Supplier task in ASM Core when an incoming message is received by ASM Core.
To map a field, click Add. In the Add Fields window, select the call or task fields from the selected Screen Set (including any custom fields created in ASM Designer), you want to map to fields used in the external system. If the selected screen set is an External Supplier Task screen set, then you can also select fields from the task’s parent request. On the browse table, click the corresponding cell in the Action Field column. Then select to pick a static value or a field from the external system. These fields are defined at the level of the connector.
Depending on the field’s data type, additional options can be selected, including: field transformations, profile maps, or resolution rules.
In the Update column, select the conditions for populating the field on the call or task.
Always | always matches the ASM Core field value with the value in the external system field. This means that any change to this field in the external system automatically updates the field value in the ASM Core call or task. |
The Only When Blank | only populates the ASM Core field with the value of the external system field if the field on the call or task is blank. This means that an existing value on the ASM Core call or task cannot be overridden by a field value in the external system. |
On Initial Population Only | is not relevant for Outbound Actions |
Rules for Incoming and Outgoing Transactions - Outbound Actions
Rules for the way ASM Core will apply an outbound action type mapping to Incoming Transactions for the selected outbound action type are set in the Action tab on the mapping details window for an Outbound Action. The rules are described below.
When Updated externally | Select the rules that ASM Core must apply when receiving an UPDATE message for an Outbound Action using this mapping, specifically select the action that must be taken if the call or External Supplier task that resulted in the creation of the Outbound Action is still open:
| ||||||||
Update | automatically updates the call or task with the details of the UPDATE message received from the external system | ||||||||
Add note | automatically adds a note to the call or task with the details of the UPDATE message received from the external system | ||||||||
Take no action | ignores the UPDATE message received from the external system | ||||||||
When Updated externally and Call or Task is closed | Select the rules that ASM Core must apply when receiving an UPDATE message for an Outbound Action using this mapping, specifically select the action that must be taken if the call or External Supplier task that resulted in the creation of the Outbound Action is closed:
| ||||||||
Add note | leaves the call or task closed but automatically adds a note to it with the details of the UPDATE message received from the external system | ||||||||
Take no action | ignores the UPDATE message received from the external system | ||||||||
When Notified externally | Select the rules that ASM Core must apply when receiving a NOTIFY message for an Outbound Action using this mapping, specifically the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is still open:
| ||||||||
Add note | automatically adds a note to the call or task with the details of the NOTIFY message received from the external system | ||||||||
Take no action | ignores the NOTIFY message received from the external system | ||||||||
When Notified externally and Call or Task is closed | Select the rules that ASM Core must apply when receiving a NOTIFY transaction for an event using this mapping, specifically the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is closed:
| ||||||||
Add note | leaves the call or task closed but automatically adds a note to it with the details of the NOTIFY message received from the external system | ||||||||
Take no action | ignores the NOTIFY message received from the external system | ||||||||
When Completed externally | Select the rules that ASM Core must apply when receiving a COMPLETE message for an Outbound Action using this mapping, specifically select the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is still open:
| ||||||||
Close | automatically closes the call or task | ||||||||
Update | automatically updates the call or task with the details of the COMPLETE message received from the external system | ||||||||
Add note | automatically adds a note to the call or task with the details of the COMPLETE message received from the external system | ||||||||
Take no Action | ignores the COMPLETE message received from the external system | ||||||||
If child calls are present | Select the action that must be taken if the call that resulted in the creation of this Outbound Action has calls linked as children:
| ||||||||
Close child calls | automatically closes the calls linked as children | ||||||||
Add note to child calls | automatically adds a note to the child calls with the details of the COMPLETE message received from the external system | ||||||||
Take no Action | takes no action on the child calls | ||||||||
When Completed externally and Call or Task is closed | Select the rules that ASM Core must apply when receiving a COMPLETE message for an Outbound Action using this mapping, specifically, select the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is closed:
| ||||||||
Add note | leaves the call or task closed but automatically adds a note to it with the details of the COMPLETE message received from the external system | ||||||||
Take no action | ignores the COMPLETE message received from the external system | ||||||||
When Not Completed externally | Select the rules that ASM Core must apply when receiving a NOT COMPLETE message for an Outbound Action using this mapping, specifically select the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is still open:
| ||||||||
Close | automatically closes the call or task | ||||||||
Update | automatically updates the call or task with the details of the NOT COMPLETE message received from the external system | ||||||||
Add note | automatically adds a note to the call or task with the details of the NOT COMPLETE message received from the external system | ||||||||
Take no action | ignores the NOT COMPLETE message received from the external system | ||||||||
If child calls are present | Select the action that must be taken if the call that resulted in the creation of this Outbound Action has calls linked as children:
| ||||||||
Close child calls | automatically closes the calls linked as children | ||||||||
Add note to child calls | automatically adds a note to the child calls with the details of the NOT COMPLETE message received from the external system | ||||||||
Take no Action | takes no action on the child calls | ||||||||
When Not Completed externally and Call or Task is closed | Select the rules that ASM Core must apply when receiving a NOT COMPLETE message for an Outbound Action using this mapping, specifically select the action that must be taken if the call or External Supplier task that resulted in the creation of this Outbound Action is closed:
| ||||||||
Add note | leaves the call or task closed but automatically adds a note to it with the details of the NOT COMPLETE message received from the external system | ||||||||
Take no action | ignores the NOT COMPLETE message received from the external system | ||||||||
Send Notify for system generated history messages | Select this option to send a NOTIFY message to the external system whenever a system-generated entry (such as an agreement escalation) is added to the history of the call or External Supplier task that resulted in the creation of this Outbound Action. |
What happens if the system is configured to update, add a note, or take no action?
When the system is configured to update the call or task, add a note to it, or take no action, on receiving the COMPLETE or NOT COMPLETE message, the call is automatically forwarded back to the analyst who forwarded the call externally, and the task is automatically forwarded to the request manager.
The call or task history is updated on receiving a COMPLETE or INCOMPLETE message.