Help Center

What: The Transfer Configuration Connection is used to send the configuration of objects in BlueConic (e.g., connections, segments, dialogues, plugins) from one tenant to another without duplicating setup efforts. Use cases for this connection include:

• Transferring configurations from test to production environments (and vice versa).
• Replicating configurations in multiple tenants split by region, country, brand, etc.

Why: This connection allows you to efficiently move your configurations across different tenants to ensure consistency—without having to redo the setup. This not only saves time, but also reduces the likelihood of errors. It's especially useful if you do all your configurations and validation on a test tenant before moving to production; you have the confidence of knowing that everything will transfer as you designed it to.

Supported object types

The following BlueConic objects are supported for the Transfer Configuration Connection:

• Connections
• Segments
• Dashboards
• Profile properties
• Timeline event types
• Listeners
• Dialogues
• Plugins
• Notebooks
• Objectives
• Group types

Installing the Transfer Configuration Connection

By default, the Transfer Configuration Connection is not installed in BlueConic. To install it, navigate to BlueConic settings > Plugins, click the Add plugin button at the top right, and register the following external URL:

https://plugins.blueconic.net/connection_transfer_configuration/index.xml

For more detailed instructions, review the article Overview: What are BlueConic plugins?. And if you need further assistance, reach out to BlueConic Support.

Creating a Transfer Configuration Connection

In the tenant that has the configuration you want to transfer (known as the "source tenant"), use these steps to create a new Transfer Configuration Connection:

1. Click Connections in the BlueConic navigation menu.
2. Click the Add connection button at the top right.
3. In the window that opens, enter "transfer" in the search bar to find this connection.
4. Click the Transfer Configuration connection option to open the Transfer Configuration Connection page.
5. Expand or collapse the metadata fields (to mark it as a favorite, add labels, or write a description) by clicking the gray chevron at the top of the page.
6. Enter a name for your connection at the top, and save your settings.

Setting up your Transfer Configuration Connection

Once you finish creating the connection, you must next define the tenants you want to transfer the configuration to (known as the "target tenants") and optionally anything you want replaced on those tenants. This is all done on the Set up page. 

Defining target tenants

To initiate any object transfer, you first need to have specific BlueConic tenants defined as targets in your connection. (You can later pick and choose which of these tenants you want to use for your transfer on the configuration goal page.)

To define a new target tenant, click Add tenant in the "Define target tenants" section and input the following information:

• Name
• Hostname
• Consumer key
• Consumer secret

The consumer key and consumer secret can be found when using the BlueConic API Access Connection on the target tenant. If you do not have access to this connection, reach out to BlueConic Support.

Defining replacements

You can define specific replacements that should be made before the configuration is moved over to a specific target tenant. Replacements are especially useful when working with multiple brands and/or regions. For instance, you may want to replace any directory names to coincide with the target tenant. Replacements are also useful when you want to add an identifier to the name of the object, like "Country."

Synchronizing configuration goals

You can make multiple transfers in a single connection by setting up individual configuration goals. To add a goal, click Add goal at the bottom left of the connection page and select Sync configuration. A goal page opens to name this particular transfer and select the objects (and their configurations) that you want to move to the target tenant.

Each goal page includes two sections to complete:

1. Select tenants
2. Analyze objects before transfer

Selecting tenants

In this first section, you select which of your target tenants you want to use for your object transfer. You can either choose "All tenants" (i.e., every one you defined on the Set up page) or "Specific tenants." If you select "Specific tenants," the list of defined tenants opens underneath; only those you check will be included in the transfer.

Note: The default option is "All tenants."

Selecting a merge strategy

If you click "Show advanced settings," an additional "Strategy" setting displays for you to determine what merge strategy to apply when matching objects between the source tenant and target tenant. You can choose to always create a new instance of identical objects or to merge based on name matching (like if a connection has the same name on both the source and target).

Note: By default, matching is done by name except for objects that have a human-readable ID (e.g., profile properties, Timeline event types, user and group types).

Analyzing objects before transfer

In this second section, you determine the exact objects you want to transfer. This is where you:

• Add or remove objects to transfer
• Analyze your objects before transfer
• Initiate the transfer

Adding and removing objects

To add an object configuration to transfer to your target tenant, click the Add objects button. This opens an advanced search window to select one or multiple objects from your source tenant. Use the search bar and filter options in the left panel to find what you're looking for.

All objects that you add display in a table in this second section on the goal page. The first column of the table lists each of your objects, with a relevant icon next to it (e.g., a plug icon for connections). Underneath each object are all related items (i.e., everything used by that object); for instance, if you add an import connection, all profile properties used in that connection's mapping will be listed.

Tip: Show or hide these related items underneath an object by clicking the chevron to the left of the object's name.

Notes:

• An object can be removed by clicking the X next to that object in the table.
• Since templates are implemented differently, to add a template, click the dropdown arrow next to the Add object button and select Add template.
  
  Then, from the "Select templates" menu that opens, check any templates that you want to add.

Analyzing objects

Before transferring the configuration, click the Analyze button to run a test (or simulation) transfer of all objects in the table. This shows you what objects would be created or updated on the target tenant. 

The analysis also allows you to detect any errors or warnings with the transfer before you initiate it. For instance, the analysis may tell you that a certain profile property with ID 123 would transfer successfully to one target tenant but not another.

Inspecting the analysis

When you run your analysis, the columns in the table for your target tenants will display the results of what would happen with each object. Some terms you may see include:

• "Create": The object will be created on the target tenant.
• "Found": The object is found based on ID (e.g., a profile property) and will be used; nothing will be created or updated.
• "Matched by name": The object is found based on name (e.g., a segment) and will be used; nothing will be created or updated.
• "Up-to-date": The plugin is found on the target tenant and has the same version number, so it is not transferred.

Objects not found in the target tenant will be marked "Not found" with an orange exclamation point, along with a green plus sign to create that object. (As an alternative, you can set up the object in the target tenant and reanalyze.)

Also keep in mind the following notes and safety checks:

• Profile and group properties are created if they don’t exist on the target tenant (based on the ID).
• Timeline event types on the source and target tenant are merged.
• Plugins are created and/or updated (if necessary based on version number). However, an error will display if the plugin version on the source tenant is less than the version on the target tenant. (You cannot transfer the configuration unless this is resolved.)
• When a selected object (not a related item) is changed on the target tenant, a warning is shown because a transfer would override the adjusted object.
• When matching by name, a warning will display if:
  • No match is found. (You could then correct it manually afterward or make sure a replacement is defined that matches.)
  • Multiple matches are found. (No selection will then be made.)

Initiating the transfer

To initiate the transfer, click the Transfer button. A popup will open asking you to confirm the transfer, since it is irreversible. After confirming, the transfer will be done for each selected target tenant.

Once the transfer is complete, green checkmarks will display next to each result in the table to confirm success.

Notes:

• If you do not have the appropriate permissions to run the transfer, the Transfer button will be disabled, and a message will display explaining that you don't have access to transfer the configuration. 
• The replacements you defined on the Set up page will be applied just before the transfer is made to the target tenant.