29 Packaging and Deploying a Capabilities Cartridge
This chapter describes the steps you need to follow to package and deploy a Capabilities Cartridge.
Prerequisites
- Target Server Version: The OSM target server version of all OSM cartridges included in the solution should be >= 8.0.
- Cartridge Type: Capabilities cartridges must be TMF cartridges (TMF order linked to a hosted specification) and not free form.
- Relationship Types: You must define only two relationship types, Primary and Auxiliary.
- Orchestration Stages: The solution must have 3 stages of orchestration.
Generating a Capabilities Cartridge Using the Wizard
Table 29-1 Generate Capabilities Cartridge Wizard Fields
| Field Name | Description |
|---|---|
| Fulfillment Model Cartridge | An OSM cartridge that holds the test fulfillment model while in Design Studio, but will replaced by a fulfillment model in Solution Designer during the dynamic design journey. You can only select one cartridge from the given list. |
| Parameter Binding XQuery | An existing Order Item Parameter Binding XQuery is auto-populated in the text box. You can review and edit the XQuery. |
| Default Order Item Properties | Order Item properties of the Order Item associated with the TMF
order are provided. You should select only the properties that need
to be exposed in Solution Designer, for decomposition and routing
rule conditions.
Note: Currently only the Order Item Properties with data types string, int, boolean, or long are supported. |
| Usage Summary | A Text description for the current Capabilities Cartridge build. This field will be made visible in Solution Designer to provide guidance on whether the cartridge has the capabilities desired by the modeler. |
- Select Generate Capabilities Cartridge: Choose the Generate Capabilities Cartridge option from the Project menu in Design Studio.
- Fulfillment Model Cartridge: Select the cartridge that will hold the fulfillment model.
- Parameter Binding XQuery: Review and edit the auto-populated XQuery as needed.
- Default Order Item Properties: Select the Order Item Properties that will be exposed for decomposition/routing rule conditions.
- Usage Summary: Enter a description for the current Capabilities Cartridge.
- Finish: Click Finish to start the Capabilities Cartridge build.
About the Generated Content
When you finish the wizard, Design Studio generates two artifacts. Each of these artifacts will be used in the second phase of the dynamic design journey.
The first artifact is a .cpar file located in the cartridgeBin folder of the solution cartridge. You need to convert the .cpar file to an image using the Image Builder and load it into OSM Cartridge Assembler.
Note:
The .cpar file is a specialized archive that contains the capabilities cartridge content. It is not a deployment package like a .par file, and therefore cannot be deployed directly to OSM from Design Studio. It can only be used inside OSM Cartridge Assembler (OCA).The second artifact is the Capabilities Manifest file (CapabilitiesManifest.json) which is inside the cartridgeBuild/META-INF folder of the solution cartridge. The manifest will be delivered to an SCD catalog administrator so that it can be imported into Solution Designer.