Use > Create Designs > Sequenced Designs > Import and Export a Service Design

Import and Export a Service Design

For more information about sequenced designs, see Sequenced Designs.

Prerequisites

Before you import a service design archive, complete the following prerequisites:

  1. Import all process definitions that are referenced by the service design, including any referenced by resource offerings that are part of the service design. The process definitions must be imported to the Codar installation in which the service design will be imported. During import, process definitions are resolved by name. For process definitions that are associated with the Operations Orchestration process engine, the name corresponds to the full path to the Operations Orchestration flow (for example, /Library/CSA/3.2/Providers/vCenter/vCenter Clone Server/Actions/vCenter Simple Compute - Deploy). Make sure that these flows have identical signatures and identical paths as the flows on the system from which the service design was exported. For instructions about how to import OO flows, see the section "Import Operations Orchestration Flows" in the Configuration Guide.
  2. If the service design you want to import has a dependency on any custom component types, these custom component types must be imported before the service design can be imported.

  3. If the imported service design is part of an upgrade path, all service designs upgradable to the service design represented by the content archive must be present on the target system.

The archive (.zip) file can only reference files or content contained within the .zip file itself, or files that are already contained in the csa.war file. By default, all images in the archive files must end in one of the following suffix values. For information on adding additional suffix values, see the Configuration Guide.

jpg|jpeg|jpe|jfif|svg|tif|tiff|ras|cmx|ico|pnm|pbm|pgm|ppm|rgb|xbm|xpm|xwd|png|gif|bmp|cod|ief

Importing and Exporting

When the Option field is set to Import:

The import process imports archives of service designs and their supported artifacts. Supported artifacts for service designs include associated resource offerings. Service designs with the same internal name are considered to be functionally equivalent and are not imported.

Note If the service design you want to import is part of an upgrade path and is also upgradable to another service design, it will not be imported.

When the Option field is set to Update:

This is an import-by-update option. During the update process, identical artifacts that exist on the target system are updated (overwritten) with the changes from the archive. Artifacts are created if they do not exist on the target system.

Note If the service design you want to import-by-update is part of an upgrade path and is also upgradable to another service design, it will not be imported.

When the Option field is set to Update and Preserve Originals is selected:

This is an update-by-preserve-original option that applies only to service offerings that do not have an upgrade path. This action imports all artifacts present in an archive, whether they exist on the target system or not. During this operation, if there is a service design with the same internal name in the system, then the name is modified internally, and the description and version of that service design are updated with "Superseded on" and the date. The internal name, display name, description, and version of the artifact being imported remain intact. Other artifacts referenced by the service design are handled similarly, with superseded items identified by "Superseded on" and the date.

Note When the Option field is set to Update and Preserve Originals is checked, you cannot import an archive if the service design is part of an upgrade path.

Content archive for service designs

Exporting a service design creates a content archive (.zip) file. The content archive contains XML documents for the service design you are exporting, as well as associated artifacts, icons for customizing the artifacts, and the Manifest XML document, which contains meta-information about the archive files.

To import a service design version archive

If a service design has active service offerings associated with it, the subscriber options for the service design being imported must match that of the service design on the target system; otherwise, the import of the service offerings does not succeed.

Notes: When you import a design, any tags you have selected in the designs area do not affect the imported design. The imported design will contain the tags that were included when the design was exported, and new tags will be created on the system, as necessary, to match what was exported.
  1. In the Sequenced Designs view where All Designs displays, click the gear icon and select Import Design.
  2. In the Import Design dialog, select or specify the Archive File (.zip file) that contains the service design you want to import. Archive filenames for service designs begin with SERVICE_DESIGN_.
  3. Select an Option:
    1. Import - Imports a new service design and its associated resource offerings from the selected archive file, if it does not already exist. This action does not update existing service designs. You cannot import a service design if it has the same internal name as the existing service design.
    2. Update - Imports an existing service design and its associated resource offerings from the selected archive file. If the service design already exists, this action updates (overwrites) existing service design versions. If the service design does not exist, this action will add it to CSA. Check Preserve Originals to create a backup copy of the existing service design. The backup copy will be saved with "Superseded" and the date appended to the display name of the service design.
  4. Click Preview to see a report of prospective results for the import process, including information about the artifacts and their status.

  5. Click Import and wait for the confirmation message. Click View Detailed Report to see a summary and details of the import process, including information about the artifacts and their status.

  6. Click Close. The new version is listed in the All Designs area.

Exporting

  1. Select the design version you want to export.
  2. Click the gear icon and select Export.

When you export a service design archive, the service design and all referenced resource offerings are packaged in an archive file named:

SERVICE_DESIGN_<service_design_display_name>_<service_design_id>.zip

For more information about importing and exporting artifacts, see the Cloud Service Automation Content Archive Tool document.