13 Working with System Interaction Specifications
Oracle Communications Order and Service Management (OSM) uses System Interaction specifications to interact with external systems that utilize REST APIs.
When working with System Interaction specifications, refer to the following topics:
About System Interaction Specifications
A System Interaction specification enables OSM to interact with external systems that utilize REST APIs.
The System Interaction specifications can be TMForum REST APIs used in fulfillment (such as TMF700 for shipping or TMF 641 for provisioning), but can also be non-TMF APIs expressed as OpenAPI specifications.
A System Interaction is defined on the Order Component Specification Editor.
For conceptual information about the System Interaction specification, see OSM Concepts and OSM Modeling Guide.
Related Topics
Importing System Interaction Specifications
-
In the Order Component Specification editor, select the System Interaction tab.
-
In the Specification File field, click the Import button and then select the OpenAPI YAML file that describes the REST API of an external system.
-
In the Target System field, enter the name of the external system. This name must match the name of the target systems defined in the OSM CNTK project and instance specification files.
Design Studio runs the following validations on the specification file you import:
- Validates that the version that is specified in
server:urlmatches with the one ininfo:version. Ensure that these values match before importing the specification. The version is dictated by the external system. - Validates the specification against the OpenAPI v3 document schema.
After successful validation, Design Studio creates the following files:
-
OpenAPI yaml file stored in the /openapi folder.
-
AsyncAPI yaml file stored in the /asyncapi folder.
These files are read-only and MUST not be altered under any circumstances.
A specification of a particular version can only be imported once. If you want to update an existing specification with the same version, delete the existing System Interaction entity and import it again.
Updating a System Interaction Entity
To update a System Interaction specification, use the Specification File dropdown in the Order Component Specification editor System Interaction tab, which lists all System Interaction Entities defined in the workspace.
When you select a specification file from the dropdown, the values of the associated System Interaction entity are copied to the System Interaction entity defined for the current Order Component Specification, but the specification file is not created again in the project.
To remove a System Interaction defined in an Order Component Specification, use the delete button. Selecting the --select– placeholder or clicking the Delete button deletes the System Interaction entity defined in that Order Component Specification along with its OpenApi and AsyncApi specification files in that project. If the deleted System Interaction entity refers to the OpenAPI and AsyncApi specification files from another project, then the specification files are not deleted.
For conceptual information about the System Interaction specification, see OSM Concepts and OSM Modeling Guide.
Using System Interactions in Automation
System Interactions are defined on OSM Order Components. Automation tasks can reference the operations and events defined within the System Interaction specification. To do so, the automation task must have a relationship to the specification file through the hierarchy of task-process-order component. The specification on an order component can be accessed from any automation task that is part of the process defined on the same Order Component.
The automated task should be associated with only one process and that process should be associated with only one order component.
To use System Interactions in automated tasks, in the Automated Task Details tab, select System Interaction in the Transport dropdown.
To update Automation properties for an automated task, use the System Interaction tab in the Properties view of the Automation tab.
- Task Editor Details Tab in Working with Tasks
- Task Editor Automation Tab in Working with Tasks