Use > Topology Designs > Browse Topology Designs > Import and Export a Topolgy Design

Import and export a topology design

Prerequisites

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

The archive (.zip) file can only reference files or content contained within the .zip file itself, or 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 Cloud Service Automation 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 designs and their supported artifacts. Designs with the same internal name are considered to be functionally equivalent and are not imported.

When the Option field is set to Update

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.

When the Option field is set to Update and Preserve Originals

This process imports all the 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, the name and description of the existing design are modified internally. The description is updated to include "Superseded on" along with the current date. A new version of the service design is then created, with a suffix such as '-1' or '-2', to contain the newly imported design.

Content archive for designs

Exporting a design creates a content archive (.zip) file. The content archive contains XML documents for the 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 design archive

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

Note 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.

If CSA has been configured to verify the authenticity of imported service design, service offering, and catalog content archives (which is done by setting the property csa.security.enable), then service design, service offering, and catalog content archives that were successfully imported into CSA 4.20 or earlier will no longer import properly until they have been digitally signed. See Cloud Service Automation Configuration Guide for information on how to digitally sign a content archive.

  1. In the All Designs area, click the gear icon and select Import Design.
  2. Select or specify the Archive File (.zip file) that contains the design you want to import. Archive filenames for designs begin with SERVICE_DESIGN_.
  3. Select an Option:
    1. Import - Imports new designs. This action does not update existing service designs. You cannot import a design with the same internal name as an existing design.
    2. Update - Imports new designs and updates (overwrites) existing designs. Check Preserve Originals to create backup copies of the original items, appending "Superseded on" and the date to the description of the service design version that is superseded.
  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.
  6. Click View Detailed Report to see a summary and details of the import process, including information about the artifacts and their status.
  7. Click Close.

To export a design archive

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

  3. Save the exported design, if required by your browser.

When you export a design archive, the design and all referenced artifacts are packaged in an archive file whose name is:

SERVICE_DESIGN_<service_design_display_name>_<service_design_id>.zip

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