Articles in this section

Clone integrations and resources

Tom Santiago
Updated

Cloning allows you to keep the original resource or integration unchanged while modifying a duplicate version. This is particularly useful when cloning between environments for development and testing purposes.

This article describes how to clone custom automations and integrations. For instructions on cloning integration app flows, see Clone integration app flows with the template utility.

Note

  • You can’t clone shared integrations or shared data flows.
  • Referencing integration resources with aliases makes cloning more efficient, removing additional steps to configure the new integration.
  • The Next flow run and flow schedule settings are not included in a cloned flow, but you can modify the copy to match the original.
  • If you clone an integration with flow groups, the groups and flow assignments are also cloned.

Clone an integration

  1. Ensure you're in the correct environment by looking for the environment name at the top, right-hand side of the screen. If you only have one environment you won't see any other environments available.
  2. On the Home page, go to the integration.
  3. Based on the integration view you use, follow the steps given below.

    1. Tile view: Select the overflow (...) menu in the upper-right corner of the tile and select Clone integration.

      cloneIntTile.png

    2. List view: In the Actions column, select Clone integration from the overflow (...) menu.

      CloneIntegrationListView.png

    3. Integration dashboard: Select Clone integration.

      Clone_integration_for_ILM.png
  4. In the Clone integration page, enter details.
    1. Name: Enter a unique name for the clone. Make sure that it is unique enough that you can identify it later. You can always rename your integration tile or flow outside of the cloning process.
    2. Environment: Select your environment. Only active environments you have Manage access to (or above) are visible. After cloning to a new environment, you must complete the setup steps; however, you can choose to complete the setup later. Learn how to use multiple environments.
  5. Review the list of all items contained within the new integration. This includes flows, APIs, and any other integration components.
  6. Select Clone integration at the bottom of the list of cloned integration components.
  7. If you've successfully cloned your integration, you'll see a success message asking if you'd like to configure your cloned integration now or later. If you've cloned to a different environment, you'll be asked if you want to switch to that environment to configure the integration. Your cloned integration will contain all flows and APIs from the original.

Configure the cloned integration

After cloning, you must configure connections for the cloned integration — connections are not copied from the original. If the cloned flows and the original flows remain in the same environment, the Celigo platform preselects the connection used in the original flows during cloned flow configuration. If the cloned integration is moved to a different environment than the original, then you can select existing connections during flow configuration (or create new connections).

For each connector, select the Configure link, then provide the requisite information for the connection and test your connection. See Connector solutions for help setting up connections for particular connectors.

For a lookup cache, either reuse an existing one if it is in the same environment or clone it. If you choose to clone a lookup cache, the entries will only be included if Include data when lookup cache is cloned or downloaded was selected, the lookup cache is being cloned into the same environment, and the lookup cache size is less than 5 MB. (If you have more than one lookup cache, then the total size should be less than 5 MB.)

Cloning never duplicates a topic within an environment. When you clone into the same environment, cloned publish steps and topic listeners keep pointing at the original topic. When you clone into a different environment, the topic's configuration (name, description, and retention) is created there and registered to the new integration. If the topic already exists in that environment, the clone reuses it. A clone into a different environment fails if creating its topics would put the target account over its topic limit. Retained messages and subscription positions (where each topic listener resumes reading) are never copied. See Clone an integration for ILM.

Once you've successfully configured your connections, the Integration details page will open, showing all of your data flows. Here, you can turn flows off and on, schedule or run them and modify their field mappings.

Clone a flow

When you clone a flow, its publish steps and topic listeners point to the same topics as the original in the same environment. In another environment, the topic's configuration is created there unless the topic already exists. Messages aren't copied.

  1. Open the integration tile that contains the flow you want to clone.
  2. Select the Actions overflow (...) menu in the Flows dashboard and select Clone flow.
  3. In the Clone flow page, enter details.
    1. Name: Enter a unique name for the clone.
    2. Environment: Select your environment. Only active environments you have Manage access to (or above) are visible. After cloning to a new environment, you must complete the setup steps; however, you can choose to complete the setup later. Learn more about using multiple environments.
    3. Integration: Select the integration tile to save the cloned flow. A cloned flow will be stored in the same integration and flow group as the original by default.
    4. Flow group: This option appears if your selected integration uses groups to organize flows. Select a group for the cloned flow or set it to Unassigned. A cloned flow will be stored in the same flow group as the original by default.
  4. Review the list of components included in the duplicate flow. Cloned flows assume you are using the same connections as the original flow by default.
  5. At the bottom of the list of cloned flow components, select Clone flow.

Clone an API

You can clone an API for versioning, testing, repurposing, or promotion to a new environment easily through the Celigo platform.

To clone an API:

  1. Navigate to Resources → APIs → API builder.

    resources_api.png

  2. From the API builder list view, find the API you'd like to clone and select Actions overflow (...) → Clone API. A new window will appear.

    – OR – 

    From the API builder, select Actions overflow (...) → Clone API. A new window will appear.

    Clone_API_Actions_menu_.png

    API builder list view

    canvas_clone.png

    API builder

  3. Add a unique name for your cloned API.
  4. Environment: Select an environment to clone your API into. Learn more about multi-environment management. This option is unavailable for accounts that do not have multiple environments enabled.

  5. Version: Add a version for your cloned API. 

    Note

    API Builder enforces version control by requiring unique combinations of HTTP method, version, and relative URI per environment (when using the new multi-environment management feature). In the case of the standard Sandbox-Production environment setup, the unique combination is enforced across both the environments, as API tokens are shared across these environments.

  6. Description (optional): Add a description for your cloned API.

  7. Review your API resources. Your resources (APIs, lookups, and imports), branching, filters, and transformations are all cloned.

    Clone_API_-_resources.png
  8. Select Clone API to continue.

  9. Configure your connection details. You can use existing connections or create a new one.

    Clone_API_-_configure_connections.png