Organization Linking

A tutorial on creating Org Links/sync between Synatic instances.

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Organization linking means that you can sync a solution/s or component from another Synatic environment to a 2nd Synatic environment.

In Synatic, you can build a solution in a development environment and copy it to a Quality Assurance (QA) environment where it can be tested to confirm its reliability and integrity before moving the Solution to a live production environment.

This tutorial will show how to build a link between different organizations. To create a new organization, contact support@synatic.com.

The tutorial will show you how to:


Organization Linking - Video Tutorial


Obtain the API Key of the source organization

An API key is required to allow secure access before continuing to create a link to an organization. Obtain the key from the account owner of the organization. Alternatively, regenerate the API Key by following these instructions:

1. Log into the 2nd organization/environment.

2. Click on your username initials located on the top right of the page to open the org’s menu. Then click on settings as highlighted in the below image.

3. Click on the Generate New API Key button highlighted in the image below.

4. Copy the API Key and keep it safe to use later.

Create a link to the organization

The Linked Orgs tab is used to create and manage linked organizations.

To create a link to an Organization, follow these steps:

1. In the 1st organization/environment, click on the username initials located on the top right of the page to open the org’s menu. Then click on Linked orgs as highlighted in the below image.

2. The below page will appear. Click on the Create button as shown.

3. Provide an Org Link Name (the description is optional).

4. Provide the Org name to link with.

5. Enter the API Key that you copied and saved earlier.


Test the Org Link

Once a Link is set up, test it first to ensure it is working.

Click the Test Linked Org button. If the link setup is correct, the test information shown below is displayed.

Synchronize a solution with the Organization

The final step in this process is to select and synchronize the Synatic solutions and flows to the organization. The Compare to Org option lets you display all the Solutions, Connections, Flows, and other solutions available that can be synchronized and linked to the organization.

The comparison list indicates whether the object exists or not in the linked organization. You can select which of the functions to synchronize and link with the organization.

The Compare to Orgs panel opens and contains a tab for each of the Synatic solutions. Each item contains an indicator of its existence in the target organization and an option to Sync and Link. Click the Compare to Org button as highlighted in the image below.

All solutions contain a Sync option. Click the Sync button to copy the solution to the target Org and synchronize it as shown in the image above.

The Connection and Relay solutions also include a Link option. Click the Link button to link a connection to a data source that already exists in the target organization.

Status descriptions

Exists

This indicates that the synchronized solution flow does exist in the target Organization with one of two conditions.

  • No Differences - indicates that there are no differences in the solution between the source organization and the target organization.

  • Differences - indicates that there are differences in the solution between the source organization and the target organization. The differences have a link ID that can be viewed by clicking the 'eye' icon.

Doesn't Exist

This indicates that the solution flow does not yet exist in the target organization because the solution has not been sync'd to the source organization.

View the organization

To view the status of the linked organization, click on the username initials located on the top right of the page to open the org’s menu. Then click on Linked Orgs option.

All the synchronized solutions will be available to use.


Did this answer your question?