Use the Event Template editor to customize the parameters that are returned when an ASAP event is triggered. If there is no matching template for an event type, no parameters are returned. You can configure static event templates, using the editor, for just four types of events like Order Startup event, Order Complete event, Order Timeout event, and Order Fail event.
Notes:
The dynamic event templates have precedence over static ones. Therefore, if there is any matching dynamic event template, no static event template will be checked. See ASAP System Administrator's Guide for more information.
Depending on the variable INCLUDE_SERVICE_ACTION_DETAIL, the service action parameters are returned. See the ASAP Server Configuration Guide for more information.
In the Studio Projects view, double-click an event template entity to open the Event Template editor. You can create the editor using the Event Template Wizard.
When working with the Event Template editor, see the following topics:
Use the Editor tab to define values for an event template. When ASAP is processing an event, ASAP will check if there exists an event template based on the service action, order parameter name and order parameter value, or on all the three: service action, order parameter name, and order parameter value. These details are configured in the Details tab. Based on the event name in the Details tab, the configuration in the Return Data Set tab is selected. The event, in the Details tab, is populated with the parameters configured in the Return Data Set tab.
| Field | Use |
|---|---|
| Add | Click to add the default event type, Order Complete Event, to the Event Templates area. |
| Remove | Click to clear an event template from the editor. |
When working with the Editor tab, see the following topics:
Use the Details tab to define a selection criteria for selecting an event template in case of an ASAP event.
| Field | Use |
|---|---|
| Use recommended name | Click to enable the Event Template Name Suffix field. In the Event Template Name Suffix field, you can specify a suffix to the event template name. You can see the suffix being added in the grayed out Event Template Name field. The event template name in this case will be E_Vendor-Technology_SoftwareLoad_EventTemplateNameSuffix. |
| Event Type | Select an event type from the list.
Note: You can apply event templates to just the four event types like Order Startup event, Order Complete event, Order Timeout event, and Order Fail event. |
| Event Template Name | If the Use recommended name check box is deselected, you can specify a name to the event template. |
| Order Parameter Name | (Optional) Specify a name to the order parameter. This name is used together with the order parameter value. |
| Order Parameter Value | (Optional) Specify a value to the order parameter. This value is used together with the order parameter name. |
| Select | (Optional) Click to select a service action that is applicable for only matching Order Fail event type events. The matching is against the service action name in the Order Fail event type events.
Note: Only Order Fail event type events include a service action name that identifies the service action that was executed when the failure occurred. |
| Open | Click to open the service action entity in the Service Action editor. |
| Clear | Click to clear the service action displayed in the Service Action field. |
| Event Template Desc | Specify a description to the event template. |
Use the Return Data Set tab to configure parameter type related values that will be returned for an event type. Only the parameters that are defined in this tab for an event template are returned in the related work order events. If no parameter is defined in this tab for an event template, no parameter will be returned for a defined event type.
| Field | Use |
|---|---|
| Parameter Type | Select a parameter type from the list that will be returned when an ASAP event is triggered. |
| Add | Click to add a row with a default parameter type and parameter name to the Return Data Set tab in the Event Template Details area. You can add rows in the Return Data Set tab for each of the parameter types. |
| Remove | Click to clear a parameter type's related details. |
| Parameter Name | Specify a parameter name, for the selected parameter type, that will be returned when an ASAP event is triggered. |
| Select | Click to select a service action. If a service action is selected, the service action parameter in the Parameter Name will be returned only for the specific service action. If a service action is not selected and the parameter in the Parameter Name is a service action parameter, the service action parameter is returned in the event for each service action that has the parameter in the service model. |
| Return Data Set | Specify a description for the return data set. |
Use the Blueprint tab to view the generated documentation for the event template entity. This tab is read only.