Importing Hosted Specifications

To import a hosted specification:
  1. From the Studio Projects View context menu, select Import and then select Import Hosted Specification.

  2. In the Specification Description field, enter a description of the hosted specification.

  3. In the Specification file field, click the Browse button and then select the OpenAPI YAML file that you want to import.

  4. In the Event Target System field, enter a logical name for the external system that will receive northbound TMF event notifications. The name of the target system must match any of the target system definitions in the OSM CNTK specification files.

  5. In the Cartridge Name field, enter a name to be used by Design Studio to generate TMF cartridges.

  6. In the Cartridge Version field, enter the version to be used by Design Studio when generating TMF cartridges.

  7. Click Finish.

Design Studio runs the following validations on the specification file you import:

  • Validates the API Name in servers.url. The supported APIs are productOrderingManagement and serviceOrdering.
  • When importing an OSM extended specification, it must be of the OSM release that aligns with the Design Studio version.
  • Validates the specification against the OpenAPI 3.0 document schema.
  • Validates whether the version of servers.url is 4 or greater, which is the minimum version supported by OSM.

After successful validation, Design Studio creates the following projects in the Studio Projects view:

  • An OSM cartridge project: Uses the name entered in the Cartridge Name field in the import wizard. In the OSM project, you can see the hosted specification entity, which holds the details of hosted specification. This project contains the hosted specification, fulfillment mode, order life-cycle policy and role entities.

  • A data model project: Uses the entered cartridge name appended with _CDT. This project contains the data schemas and data structure definitions associated with the imported specification.