Order Component Specification Editor System Interaction Tab

Use the System Interaction tab to import a specification (OpenAPI YAML) file that describes an external system's REST API.

Field Use

Specification File

Use this field to select an OpenAPI YAML file that you want import or delete. In the event that a system interaction specification of the same type and version is already being used by another order component, use this field to select an existing System Interaction from your workspace.
  • Delete icon: Deletes the System Interaction entity defined in the Order Component Specification along with its OpenAPI and AsyncAPI specification files in that project.
  • Import: Click to import a new OpenAPI YAML file that describes the REST API of an external system.

Version

Displays the version of a specification file.

Target System

Specify the name of the external system. This is a logical name for the external system participating in this system interaction. This name must match with the target system name defined in the OSM CNTK project and instance specification files. This name should describe the function of the target system rather than its specific location. For example, a logical name of "Wireless-Activation" would be appropriate, as opposed to "Test-ASAP".

Note:

When you configure system interactions, set the value of the OSM_RUNTIME_TYPE cartridge management variable to MultiService.