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 components, you can create new components or upgrade existing components. Additionally, if the imported components were created from a template, you can use the template or create a new one.

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

Procedure

To import one or more components:

  1. Display the Import Component window (Components > Import Components).
    The Import Components window
  2. Enter the path to the JSON file that contains the component definition or click Browse to select the file.
  3. If you want to upgrade existing components, select the Upgrade Component check box. To create components, 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 components were 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 components were not created from a template, these options are ignored.
    • To use the imported components' template, select Use Existing Template. The new components are an exact copy of the imported components. They contain a pointer to the imported components' template. This option is especially useful if you are importing many components that are based on the same template.

      If you are upgrading, the components also point to the imported template.

    • To create a template, select Create New Template. The new components are an exact copy of the imported components. They contain a pointer to the newly created template (which is based on the imported components' template).

      If you are upgrading components, 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 components, it creates both new components and a template unless the template already exists, in which case the components are not imported.

      If you are upgrading components, the upgrade fails if the imported components' template already exists.

    • To ensure that the template is on the importing server, select Fail if Template Does Not Exist. If you are creating components, it creates both new components and a template unless the template does not exist, in which case the components are not imported.

      If you are upgrading components, the upgrade fails if the imported components' template does not exist on the importing server.

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

Feedback