Introduction

This article describes two methods to move a TIBCO Scribe® Online integration from a sandbox environment to production. Method one uses distinct Connections and Solutions for the different environments (development, sandbox, production, etc). Method two uses existing Solutions and Connections, by changing the Connection to use production parameters.
 

Method 1 - Use Separate Connections And Solution(s) For The Production Integration.

Pros:

• Only way to maintain separate development, sandbox, staging environments
• Easier to debug and validate metadata

Cons:

• Requires more time and may be cumbersome if you have many Solutions
• Need to manage multiple copies of the Maps 

Step 1: Export Maps from original Solution(s)
 

1. In TIBCO Scribe® Online, edit the Solution, scroll down to the Maps section
2. Select one or more Maps
3. Select Export Selected from the Menu by clicking the Menu icon.
4. Save to local drive

Pro Tip: After exporting, rename the file to include a date and/or version number as a version control and backup measure.

Here's a screenshot:

Step 2: Create and test Connections to all the production data sources
 

Create Connections for every source and target used by the Maps. For each endpoint, follow these steps:

1. Create a New Connection.
2. Enter the credentials and parameters for your production system. Be sure to use the username, passwords and URLs are for the production system.
3. Confirm that the parameters match those in your sandbox Connection. For example, "Use Salesforce Bulk API for batch operations"
4. Test the Connection for the Agent you will be using in the production Solution. It might be a different Agent than the one used for development.
5. Save the Connection.

Pro Tip: Include "Prod" in the Connection name i.e. "Salesforce (Prod)". You can also specify a Connection Alias instead of the default.

Pro Tip: The Agent selected in the drop down to "Test Connection" IS NOT permanently assigned to the Connection. It is used to test the Connection for that specific Agent, because a Connection may not work with all Agents. Agents are assigned to Solutions through the "Agent" drop-down in the Edit Solution page.

Here's a screenshot:


 

Step 3: Create new Solution(s)
 

1. On the Solutions page select Add > Integration
2. On the Solution Edit Page - Give it a meaningful name like "ERP --> SFDC (Prod)"
3. Solution Edit Page - Select the Agent you used in Step 2

Step 4: Import Maps into new Solution(s)
 

1. On the Solution Edit Page in the Maps section, click the Menu icon and select Import Maps
2. Select the local .json file you saved in Step 1
3. If you exported the Maps as separate json files, repeat the import for each Map

Step 5: In each Map, change the source Connection
 

After importing, the Map will have the status "Incomplete" until all the Connections are re-assigned, and any errors have been corrected.

1. Edit the Map
2. In the Connection section, change the Connection by selecting Reassign Connection from the Gear menu associated with the old Connection.

Here's the screenshot:

 

Step 6: In each Map, re-assign the rest of the Connection(s)
 

For each Connection, re-assign it within the Map.

1. Select Reassign Connection from the Gear menu for the old Connection
2. Select the production Connection in the drop-down
3. Click OK.

 

Step 7: Review, Tweak, and Save

If no errors are reported after changing the Connections, save the Map. Otherwise, check for these common causes of errors:

• Development and Production metadata mismatch
  • Confirm all custom entities and fields have been configured correctly for all end points
  • Then, reset the metadata through the Gear menu for the Connection in the Map
• Complex formulas
  • Confirm Connection and field names are correct inside any formulas

 

Method 2 - Change the Connection parameters

Pros:

• Fastest and easiest method

Cons:

• Can't be used for separate Sandbox / Production environment

Steps

• For each Connection, modify the connection parameters to point to the production system
• That's it!

 

Additional Information

 

Multiple TIBCO Scribe® Online Accounts

In some cases, you may have access to multiple TIBCO Scribe® Online Organizations (accounts). You can use a variation of Method 1 to move Maps between Organizations:

• In Step 1, export the Maps from the source Organization
• Install all necessary Agents in the target Organization
• Use the target Organization for the remaining steps

 

Setting up a Sandbox Environment

If your Solutions are already running in production, you can create a separate environment to develop and test changes to your Maps. Follow the steps in Method 1, but reverse the Production / Development Connections.


 

Describes how to move Maps from test to production. Concepts can be applied in other situations like setting up a separate development environment or moving Maps between different TIBCO Scribe® Online Organizations.