Activation tasks provide integration between OSM and either ASAP or IP Service Activator. You can model a process flow that includes one or more tasks that activate services in a network using those systems.
Before modeling activation tasks, you must import at least one ASAP or IP Service Activator service cartridge, which you use to define relationships between tasks and service actions. See "Importing Activation Cartridge Projects" for more information.
When you create a first activation task in a workspace, Design Studio creates a data dictionary project called ActivationOSMIntegrationDataDictionary containing the data schema structure for ASAP and IP Service Activator. Data elements are annotated on the Notes tab of the Data Schema editor. The ASAP data schema is called ASAP_OSM. The IP Service Activator data schema is called IPSA.
When modeling activation tasks, see the following topics:
The interaction between OSM and the activation system is established through a service request and response, which you configure by mapping OSM task data to system parameters.
For ASAP, the OSM data is transformed to an OSS/J or Web Services order and sent to ASAP to activate the specified services.
For IP Service Activator, the OSM data is transformed to a Web Services order that is sent to IP Service Activator to activate the specified services.
The activation system returns event responses or exceptions, depending on the result of the activation.
Using the activation task, you can:
Update OSM orders with data from all events and exceptions returned by the activation system (either ASAP or IP Service Activator).
Map OSM data to Activation order headers, global parameters, and service action parameters.
Automatically map OSM data to global or service action parameters with the same name.
Define conditional transition states and statuses for completion events and completion exceptions returned by the activation system.
Enter Map and Key security credentials for Web Services orders.
Mapping OSM data to ASAP and IP Service Activator parameters ensures:
That OSM sends the data that the activation system requires for service actions (the request)
That OSM orders are updated with the right information returned from the activation system (the response)
That the OSM activation task transitions properly when the integration is complete
See the following topics for more information on service action requests:
The service action request is made up of the following data:
OSM header data: information that applies to the customer or to all line items on the order
OSM task data: information that is available to the task and necessary for the task to complete
The service action is made up of the following data:
Activation order header data: information that applies to the entire work order
Service action data: information that is required to activate a service
Global parameters data: information that you define once and which applies to multiple service actions
You define parameter values in the Design Studio Properties view. For service action and global parameters, you can define default mapping information. For activation order header parameters, you can define either default mapping information or default actions (for example, the default value for the srqAction parameter is ADD).
Some parameters in the activation order headers are prepopulated with default values, indicated by a check mark when you first expand the Activation Order Headers in the Service Actions tree.
You create data structures in OSM to contain the response information returned from ASAP and IP Service Activator. For each event and exception returned by the activation system, you select the parameter values you want to retain, then identify the OSM data structure to which these parameters are added. When the activation system returns an event or exception, OSM updates the order data with the parameter values that you selected.
The list of events and exceptions and activation response parameters are different for each activation system.
The activation response parameters for ASAP can be customized.
The activation response parameters for IP Service Activator cannot be modified and conform to how IP Service Activator expects to receive response data from OSM.
The infoParm parameter is significantly more complex for IP Service Activator than it is for ASAP.
When an activation task is configured with IP Service Activator service actions that require an IP Service Activator transaction to fulfill the activation request, the transaction structure in the InfoParms structure contains information relating to the IP Service Activator transaction
When an activation task is configured with IP Service Activator service actions that look up data (such as for navigation service actions), the return data conforms to the infoParms structure in the activation response, with one infoParm per service action.
Using the Task editor Response Data tab, you can configure state and status transitions for completion events and exceptions returned by the activation system. You can define multiple transitions (each with an XPath expression) to model different scenarios for variations in the response data. For example, if an ASAP or IP Service Activator parameter returns the value DSL, you may want the task to transition to a DSL task; when the same parameter returns the value VOIP, you want the task to transition a different task.
You can define state transitions for user-defined states only. You cannot define transitions for system states, such as received, accepted, and completed. You define the condition in the Properties views. At run time, OSM evaluates the conditions in the order you have defined them and stops evaluating when a condition evaluates to true.
Completion events and exceptions must include a default transition in the event that all specified conditions fail. You can change or delete the predefined default values, or you can create your own. You can change or delete the predefined default values or you can create your own. If you define no default conditions for the required completion events and exceptions (no condition is defined with XPath expression true()) Design Studio creates a problem marker.
The following table lists completion events and exceptions that require a default transition configuration:
| Name | Activation System | Type |
|---|---|---|
| orderCompleteEvent | ASAP and IP Service Activator | Event |
| orderCreateEvent | ASAP only | Event |
| orderEstimateEvent | ASAP only | Event |
| orderFailEvent | ASAP and IP Service Activator | Event |
| orderNEUnknownEvent | ASAP only | Event |
| orderRollbackEvent | ASAP only | Event |
| orderSoftErrorEvent | ASAP only | Event |
| orderStartupEvent | ASAP only | Event |
| orderTimeoutEvent | ASAP only | Event |
| orderTimeoutWarningEvent | ASAP and IP Service Activator | Event |
| createOrderByValueException | ASAP and IP Service Activator | Exception |
| getOrderByKeyException | ASAP only | Exception |
| queryManagedEntitiesException | ASAP only | Exception |
Configuring Service Action Response State and Status Transitions
You model activation tasks to integrate OSM with either and ASAP or IP Service Activator. You can model a process flow that includes one or more tasks that activate services in a network.
Note:
Before modeling activation tasks, ensure that you have defined the Design Studio preferences for the OSM SDK and WebLogic Server installations. See "Defining Order and Service Management General Preferences" for more information.To model an activation task:
Import an ASAP or IP Service Activator service cartridge.
See "Importing Activation Cartridge Projects" for more information.
Create an Activation Task entity.
You create an Activation Task entity to hold all of the information necessary to send a request to the activation system, receive the response, update the order, and transition the task. See "Creating New Tasks" for information about creating tasks, and see "Designing Tasks and Activities" for information about creating tasks from the Process editor.
Note:
The first time that you create an Activation Task entity in a workspace, Design Studio automatically creates a new project to contain data elements necessary for integration between OSM and the activation system. This project is sealed and the data within should not be changed.Model the activation task data.
You select the data that the activation task requires from the order data or from a data dictionary. See "Defining Task Data" for more information.
Configure the mapping information needed to make the service action request to the activation system.
See "Configuring Service Action Requests" for more information.
Configure the mapping information needed to update OSM orders with the response data returned by the activation system.
See "Configuring Service Action Responses" for more information.
Configure state and status transitions for completion events and completion exceptions returned by the activation system.
See "Configuring Service Action Response State and Status Transitions" for more information.
Configure activation task details.
You define the attributes that enable the activation task to execute properly in the Activation environment. See "Task Editor Details Tab" and "Task Editor Activation Task Details Tab" for more information.
Define activation task compensation strategies.
You specify how to compensate an activation task if the task is affected by amendment processing. See "Task Editor Redo Tab" and "Task Editor Undo Tab" for more information.
Configure activation task states and statuses.
A task state determines the milestone of a task in a process. A task status describes how a task was completed and determines the next task in the process. See "About Task States and Statuses" and "Assigning Task States and Statuses" for more information.
Configure activation task permissions.
You assign execution modes to roles for each task to specify which roles can perform the execution mode. See "Assigning Task Permissions" for more information.
(Optional) Configure activation task jeopardies.
You can configure conditional jeopardy notifications to alert users or systems that the activation task may be at risk. See "Task Editor Jeopardy Tab" for more information.
(Optional) Configure task state automation events.
You configure state-based event notifications to alert users or systems of changes to the activation task state. See "Task Editor Events Tab" for more information.
You configure service action requests by mapping OSM order header and task data to Activation order header, service action, and global parameters. Additionally, you can define conditional logic to determine when service actions should be added to a work order request.
Note:
See "Modeling ASAP Services" and "Defining Service Action Properties" for more information about creating and configuring service actions.To configure service action requests:
Associate service actions with the activation task:
On the Request Data tab, right-click in the Service Actions area and select Add Service Action.
Note:
Service actions for IP Service Activator are available in reference Design Studio IP Service Activator projects or are generated by Design Studio when a CTM template is imported into an Activation IPSA project. See "About CTM Templates" for more information.Right-click the service action to either change the sequence of service actions, open them in the Service Action editor, or remove them from the task.
(Optional) Define new global parameters.
You can define service actions as global parameters to avoid mapping the parameter multiple times:
In the Request Data tab, right-click in the Service Actions area and select Add Global Parameters.
The Add Global Parameter dialog box is displayed.
In the Name field, select the desired parameter, enter the value, and click OK.
Map OSM data to Activation order header, service action, and global scalar parameters:
Note:
For details about mapping and optionally transforming OSM data to service action XML parameters, see "Mapping OSM Data to Service Action XML Parameters"In the Request Data tab Task Data area, select Order Header or Task Data.
Depending on your selection, the fixed order header data or the task data defined for the activation task is displayed in the Task Data area.
In the Service Actions area, expand the Activation Order Headers folder, the Global Parameters folder, or any service action folder to display the parameters.
Required service action parameters are displayed with an asterisk after the parameter name.
Drag an OSM order header or a task data node onto an Activation order header, service action, or global parameter.
A check mark appears next to the parameter to indicate that it is mapped to OSM data. Right-click the parameter and select Properties to review the mapping information, default value, and condition expression, depending on the parameter.
Note:
To automatically build XPath expressions, press and hold the Alt key, then drag OSM data from the Task Data area to the Properties view Binding field. Constants or default values must be enclosed within apostrophes (' ').(Optional) Automatically map task data to global parameters:
In the Request Data tab Task Data area, select Task Data.
In the Task Data area, right-click a data structure and select Auto map parameter.
Design Studio automatically maps the data structure, including its child elements, to a global parameter of the same name (case sensitive).
Define conditional logic for service actions and parameters.
You define conditional logic (as an XPath expression) to determine when to include a service action on a work order request. See "Properties Service Action Binding View" for more information.
Add service action parameters to OSM task data.
You can add all parameters of a service action to a selected OSM data structure. Service action parameters are not added to the structure if it contains a child element with the same name as the parameter. See "Task Editor Request Data Tab" for more information.
Note:
Design Studio limits the maximum length of service action parameters to 1000 characters when adding them to a structure. If you create data elements for service action parameter fields manually (using the Data Schema editor), ensure that you set the maximum length of the new data element equal to the maximum length defined for the service action parameter.About Service Action Request Mapping
The Activation Task editor supports the following ways of mapping OSM data to ASAP and IP Service Activator service action XML data types:
Mapping OSM XML data to an ASAP or IP Service Activator XML parameter without modeling the XML structure using an XPath expression. See"Mapping OSM Data to Service Action XML Parameters Using XPath" for more information.
Mapping and optionally transforming OSM XML data structures with child elements to an ASAP or IP Service Activator XML parameter using an XSLT snippet. See "Mapping OSM Data to Service Action XML Parameters Using XSLT" for more information.
About Service Action Request Mapping
To map OSM XML data to ASAP or IP Service Activator parameters using an XPath expression:
Open a data schema associated to an OSM project.
The Data Schema editor is displayed.
Right-click in the parameter area and select Add Structure (CTRL + ALT + S).
The Create Data Schema Structure dialog box is displayed.
Do the following:
In the Name field, enter a name for the structure. For example, XMLTypeNoChildren.
Click Finish.
The empty structure is displayed in the Data Schema editor parameter area.
Open an OSM order that you want to associate the structure to.
The Order editor is displayed.
Right-click in the Order Template area and select Select from Dictionary.
The Select Data Elements dialog box is displayed.
Select the empty structure.
Click OK.
The structure is displayed in the Order Template area.
Open an Activation Task that you want to associate the structure to.
The Activation Task editor is displayed.
In the Request Data tab Task Data area, select Task Data.
Right-click in the Task Data area and select Select from Order Template.
The Select an Order Template Node dialog box is displayed.
Select the empty structure.
Click OK.
The structure is displayed in the Task Data area.
In the Service Actions area, right-click and select Add Service Action.
The Select a Service Action dialog box is displayed.
Select a service action that includes the XML parameter you want to map to the empty OSM structure.
Click OK.
The service action is displayed in the Service Actions area.
Expand the newly added service action.
All parameters associated to the service action appear.
From the Task Data area, drag the empty structure to the corresponding service action XML parameter in the Service Action area.
A check mark appears next to the parameter to indicate that it is mapped to the OSM structure.
Click the service action parameter. Verify the following fields in the Properties tab:
In the Binding Type field, ensure that the XPath expression field is selected.
In the Binding field, ensure that the XPath expression references the OSM structure. For example: osm:XMLTypeNoChildren
To map and optionally transform OSM XML data structures with child elements to an ASAP or IP Service Activator XML parameter using XSLT snippets:
Open a data schema associated to an OSM project.
The Data Schema editor is displayed.
Create an OSM structure with any number of child elements and child structures with child elements.
Open an OSM order that you want to associate the structure to.
The Order editor is displayed.
Right-click in the Order Template area and select Select from Dictionary.
The Select Data Elements dialog box is displayed.
Select the structure.
Click OK.
The structure is displayed in the Order Template area.
Open an Activation Task that you want to associate the structure to.
The Activation Task editor is displayed.
In the Request Data tab Task Data area, select Task Data.
Right-click in the Task Data area and select Select from Order Template.
The Select an Order Template Node dialog box is displayed.
Select the empty structure and click OK.
The structure is displayed in the Task Data area.
Right-click in the Service Actions area and select Add Service Action.
The Select a Service Action dialog box is displayed.
Select a service action that includes the XML parameter you want to map to the OSM structure.
Click OK.
The service action is displayed in the Service Actions area.
Expand the newly added service action.
All parameters associated with the service action are displayed.
From the Task Data area, drag the structure to the corresponding service action XML parameter in the Service Action area.
A check mark appears next to the parameter to indicate that it is mapped to the OSM structure.
Note:
The OSM structure and children do not map to structures in the Service Actions area, only to individual parameters.Click the service action parameter. Verify the following fields in the Properties tab:
In the Binding Type field, ensure that the XSLT snippet field is selected.
In the Binding field, ensure that the XSLT snippet maps the OSM structure to the ASAP or IP Service Activator structure.
For example:
<mslv-sa:serviceValue xsi:type="mslv-sa:ASAPServiceValue">
<mslv-sa:name>stuff1</mslv-sa:name>
<mslv-sa:xmlValue>
<ASAPproj:XMLData xmlns:ASAPproj="http://xmlns.oracle.com/communications/sce/dictionary/ASAPproj/ASAPproj">
<ASAPproj:data>
<ASAPproj:Title>
<xsl:value-of select="osm:XMLData/osm:data/osm:Title"/>
</ASAPproj:Title>
<ASAPproj:LineItem>
<xsl:value-of select="osm:XMLData/osm:data/osm:LineItem"/>
</ASAPproj:LineItem>
</ASAPproj:data>
<ASAPproj:XMLId>
<xsl:value-of select="osm:XMLData/osm:XMLId"/>
</ASAPproj:XMLId>
<ASAPproj:XMLType>
<xsl:value-of select="osm:XMLData/osm:XMLType"/>
</ASAPproj:XMLType>
</ASAPproj:XMLData>
</mslv-sa:xmlValue>
<mslv-sa:type>OPTIONAL_XML</mslv-sa:type>
</mslv-sa:serviceValue>
Note:
By default, Design Studio assumes that the OSM and Activation parameters structures are identical. If the parameters are different, modify the default mapping as described in the next step.(Optional) If the default XSLT expression mapping does not correspond to the ASAP or IP Service Activator parameter structure, change the parameter mappings within the <mslv-sa:xmlValue> element.
For example:
<mslv-sa:serviceValue xsi:type="mslv-sa:ASAPServiceValue">
<mslv-sa:name>stuff1</mslv-sa:name>
<mslv-sa:xmlValue>
<ASAPproj:NewValue1 xmlns:ASAPproj="http://xmlns.oracle.com/communications/sce/dictionary/ASAPproj/ASAPproj">
<ASAPproj:NewValue2>
<ASAPproj:NewValue3>
<xsl:value-of select="osm:XMLData/osm:data/osm:Title"/>
</ASAPproj:NewValue3>
<ASAPproj:NewValue4>
<xsl:value-of select="osm:XMLData/osm:data/osm:LineItem"/>
</ASAPproj:NewValue4>
</ASAPproj:NewValue2>
<ASAPproj:NewValue5>
<xsl:value-of select="osm:XMLData/osm:XMLId"/>
</ASAPproj:NewValue5>
<ASAPproj:NewValue6>
<xsl:value-of select="osm:XMLData/osm:XMLType"/>
</ASAPproj:NewValue6>
</ASAPproj:NewValue1>
</mslv-sa:xmlValue>
<mslv-sa:type>OPTIONAL_XML</mslv-sa:type>
</mslv-sa:serviceValue>
where NewValue1 to NewValue6 correspond to the ASAP or IP Service Activator XML parameters.
You create data structures in OSM to contain the response information returned from ASAP or IP Service Activator. For each event and exception returned by the activation system, you select which parameter values to retain, then identify the data structure to which these parameters are added. When the activation system returns an event or exception, OSM updates the order data with the selected response parameter values.
To configure service action responses:
In the Activation Task editor Response Data tab, select an event or exception from the Event/Exception area.
All of the data an event or exception returns appears in the Activation Response area.
Add an OSM data structure from the order template or from a data dictionary to contain the information returned by the service action response:
Right-click in the Response Data Location area or the OSM Data Binding area and select Select from Order Template or Select from Data Dictionary.
If you select a structure from a data dictionary, Design Studio automatically adds that structure to the order template.
Select a structure from the dialog box and click OK.
The structure is displayed in the Response Data Location and OSM Data Binding area.
Note:
Do not add a data structure that uses a distributed order template. Attempting to map a response value to a data element in a distributed order template will cause an error. For more information about distributed order templates, see OSM Concepts.Do at least one of the following:
Map fixed activation response structures to task data structures:
Click the Set Data Location subtab.
In the Activation Response area, check the activation response elements or structures that you want to map to task data structures.
In the Response Data Location area, right-click a task data structure and select Set as Data Location.
Design Studio adds the data you selected for the event or exception in the Activation Response area to the structure in the Response Data Location area. When the event or exception is returned from the activation system, OSM adds the data values to the OSM structure.
Bind activation response elements to arbitrary task data elements:
Click the Response Data Mapping subtab.
In the Activation Response area, drag an activation response data element onto a task data element in the OSM Data Binding area.
The task data element is checked.
If you select no data in the Activation Response area for an event or exception, OSM ignores that event or exception when it is returned by the activation system.
(Optional; ASAP only) Define conditional mappings for service action response parameters. See "Filtering ASAP Response Data".
This step enables you to reduce the response data returned to OSM.
Note:
The information returned by IP Service Activator infoparms is structured to enable a detailed mapping of return data back to OSM order data. Therefore, there is no need to filter the amount of response data.The ASAP Infoparm is less structured.
Right-click the OSM structure and select Open Properties View.
The Properties view for the task data node is displayed.
Click the Identification tab.
See "Task Data Node Properties View Identification Tab" for more information.
Select Override Data Dictionary Minimum/Maximum.
In the Maximum field, select Unbounded.
Click Save.
The amount of response data returned by an activation system can be very large, while the needed data might be quite small. Parsing large amounts of response data can affect OSM performance. If you notice a reduction in OSM performance due to large amounts of response data, you can specify a condition on specific parameters to limit the response data. You can create response data limitations for as many events or exceptions as you choose by binding the activation response data to the desired OSM data.
To limit response data:
In the Task editor Response Data tab, select an event or exception from the Event/Exception field.
In the Response Mapping area, click the Set Data Location tab.
In the Activation Response area, right-click InfoParm.
The Response Filter Properties view is displayed.
Drag a parameter into the Response Filter Condition field.
The XPath representation of the parameter is created in the Condition field.
Add the desired condition to the XPath representation.
For example, consider that you only want to update infoParm data in OSM if the serviceId infoParm parameter from orderCompleteEvent is equal to 2. First, select orderCompleteEvent in the Event/Exception field. Then click Detailed Parameters and infoParm in the Activation Response field. Drag serviceId into the Condition field. The XPath representation of serviceID is as follows:
mslv-sa:serviceId
Now set the desired condition by adding ='2':
mslv-sa:serviceId='2'
Click Save.
Configuring Service Action Responses
For completion events and exceptions returned by the activation system, you can configure state and status transitions.
To configure state and status transitions:
In the Activation Task editor Response Data tab, select an event or exception from the Event/Exception field.
Predefined default states and status transitions appear in the Transition to State and Status area.
Click the Add button.
The State/Status Selection dialog box is displayed.
In the Condition Name field, enter a name for the transition.
Select the State or Status option.
If you select State, select a user-defined state. If you select Status, select a predefined task status. See "About Task States and Statuses" and "Assigning Task States and Statuses" for more information.
Click OK.
Design Studio adds the new transition to the table.
(Optional) Select a transition row and click Move Up or Move Down to change the order of the transitions.
The order in which they appear in the table determines the order in which OSM evaluates the conditions at run time.
Select a transition row and click Properties.
The Properties view for the state/status transition is displayed.
In the Condition field, define an XPath expression to define the conditions under which the transition occurs.
See "Properties State/Status Transition View" for more information about defining conditions.
Click Save.