Importing components

Importing and exporting can be especially useful if you have multiple IBM® UrbanCode Deploy servers, for example, and must quickly move or update components.

About this task

When you import a component, you can create an entirely new component or upgrade an existing one. Additionally, if the imported component was created from a template, you can use it or create a new one.

Note: If the imported component has the Import Versions Automatically parameter set to true, the new component automatically imports component versions while the artifacts are accessible to the importing server.

Procedure

To import a component:

  1. Display the Import Component dialog (Components > Import Component).
    Figure 1. Import Component dialog
  2. Enter the path to the JSON file that contains the component definition or click Browse to select one.
  3. If you want to upgrade an existing component, select the Upgrade Component check box. To create a component, leave the box cleared. If the component name in the JSON file (not the name of the file itself) matches an existing component, the parameters are updated with the new values, and new items, such as processes, are added. If the name of the component is not found, the command has no effect.
    Note: The component name is the first parameter in the JSON file; for example,
    "name": "helloWorld",
    .
  4. If the imported component was originally created from a template, use the Component Template Upgrade Type list to specify how you want 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, these options are ignored.
    • To use the imported component's template, select Use Existing 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 that are based on the same template.

      If you are upgrading, the component also points to the imported template.

    • To create a template, select Create 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.

    • When you want to create a fresh installation and ensure that a template is not on the importing server, select Fail if Template Exists. 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.

    • To ensure that the template is on the importing server, select Fail if Template Does Not Exist. 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.

    • To upgrade the template, select Upgrade if Exists. This option creates a component and upgrades the template on the importing server. If the template does not exist, a new one is created.
  5. Click Submit.

Feedback