Import and export components

This topic explains how to export components from a source server and import them to a target server.

You can create and validate components on one server, export the components, and then import them to another server.

Export components

When you export a component, the system creates a JSON file that contains the component's source configuration details, properties, and processes.

To export a component:

  1. Navigate to Management > Components.

  2. In the list of components, click Export next to the component you want to export.

You can load the file into a text editor or save it. The saved JSON file has the same name as the selected component, for example, helloWorld.json.

Back to top

Import components

When importing a component, you can create a new component or upgrade an existing one.

If the imported component was created from a template, you can use the template or create a new one.

Note: If the Import Versions Automatically option was selected for the imported component, Deployment Automation imports component versions automatically as long as the artifacts are accessible to the importing server.

To import a component:

  1. Navigate to Management > Components.

  2. Click Import. The Import Component dialog box opens.

  3. (Optional) To upgrade an existing component, select Upgrade Component.

    If the component's name in the JSON file (not the name of the file itself) matches an existing component, the systems updates the component's properties with the new values and adds new items, such as processes. If the name is not found, the command has no effect.

    Note: The component's name is the first property in the JSON file, for example: "name": "helloWorld"

  4. If the imported component was originally created from a template, select an option from the Component Template Upgrade Type list to specify how to use the template.

    For these options, the template must be on the importing server. If the imported component was not created from a template, the options are ignored.

    The following table describes available options.

    Option Description
    Use Existing Template

    Select this option to use the imported component's template.

    The new component is an exact copy of the imported one and contains a pointer to the imported component's template. This option is especially useful if you are importing many components based on the same template.

    If you are upgrading, the component also contains a pointer to the imported template.
    Create Template

    Select this option to create a new template.

    The new component is an exact copy of the imported one and contains a pointer to the newly created template (which is based on the imported component's template).

    If you are upgrading a component, a new template is also created.
    Fail if Template Exists

    Select this option to create a fresh installation and ensure a template is not on the importing server.

    If you are creating a component, it creates both a new component and template unless the template already exists, in which case the component is not imported.

    If you are upgrading a component, the upgrade fails if the imported component's template already exists.
    Fail if Template Does Not Exist

    Select this option to ensure the template is on the importing server.

    If you are creating a component, it creates both a new component and template unless the template does not exist, in which case the component is not imported.

    If you are upgrading a component, the upgrade fails if the imported component's template does not exist on the importing server.
    Upgrade if Exists

    Select this option to upgrade the template.

    The system creates a new component and upgrades the template on the importing server. If the template does not exist, a new one is created.

  5. From the Process Plugins Import Type list, select how you want to import plugin steps in processes.

    The following options are available.

    Option Description
    Import processes as is Select this option to import processes without changes.

    If a process uses a plugin that is not available on the target sever, the import fails.
    Upgrade processes to latest plugins

    Leave this option selected to upgrade all imported plugin steps to a later plugin version available on the target server.

    You don't need to have current plugin versions if more recent versions are available on the target server.

    This is the default option.
    Ignore missing plugins Select this option to import processes even if they use plugins that are missing from the target server.
  6. Click Choose File and select the JSON file containing the component.

  7. Click Import.

Back to top

See also: