Linking Organizations

A reference guide to Org Links between Synatic instances

Written by Alan Andrew
Updated over a week ago

In this reference guide, you will be exposed to the various settings and options used to build an organization link. If you require a new organization to be created, contact your Synatic Account manager.

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.

📝 Note that Synatic can create organizations in different regions, such as the EU or the US. However, to link and synchronize organizations, they must exist in the same region.

Click a link below to view more:

Linking Organizations

Each Synatic organization requires an API key for access by external entities. So to link organizations between Synatic instances, you will need the API key of the target organization when creating the link.

Getting the API key

The API key can be obtained from the owner of the target organization, or if you recently created the target organization, you can generate a new API key in the Account menu Settings option.

Creating a new link to an organization

To create a new link to a target organization, go to the Account menu and select the Linked Orgs option.

When creating a link to an organization, you must provide a meaningful name and description for the link.

Configuring the link requires the name of the target organization you want to link to and the API Key required to access it.

  • Org Name - Enter the name of the organization that you want to link to.

  • API Key - Enter the API Key of the target Organization, which will be in the following 64-character HEX format - "11ce52e2ccbac ............ b4fc147f3a8b"

Testing the Link

When the organization link has been created and saved, you can test the link by clicking the Test Org Link.

The display above indicates a successful link test.

Linking and synchronizing a solution to the new organization

Once the new organization is created, the Org Link Information window opens and is ready to be linked.

To link Solutions, click the Compare to Orgs option.

The Compare to Orgs panel opens and contains a tab for each of the Synatic solutions. Each contains an indicator of its existence in the target organization and an option to Sync and Link.

  • All solutions contain a Sync option to copy the solution to the target Organization (QA) and synchronize it.

  • The Connection and Relay solutions also include a Link option to copy the connection configuration.

It is recommended that the synchronizing and linking be done in the order of tabs from left to right.

The list also has a status column indicating the solution's status relative to the target Organization (QA).

Status descriptions

  • Exists
    This indicates that the synchronized solution flow does exist in the target Organization (QA) with one of two conditions.

    • No Differences - indicates that there are no differences in the solution between the source Dev organization and the target Organization (QA).

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

    • Click the Sync option to update the solution in the target Organization (QA).

  • Doesn't Exist
    This indicates that the solution flow does not yet exist in the target QA because the Solution has not been Sync'ed to the target Organization (QA).

  • Sync
    This option is available when the solution does not yet exist in the target Organization (QA) and be selected and synchronized.

  • Link
    Some solutions such as a Connection or a Relay contain security credentials and require these to use an alternate data source connection which probably only exists in the target organization (QA). This implies that you will substitute the connection in the source organization (Dev) with one in the target organization.



Advanced Mode Options


Limitations and known issues

Synatic can create organizations in different regions, such as the EU or the US but can only link and synchronize organizations that exist in the same region.

Useful Tutorials

See the Linked Organizations tutorial.

Revisit the Getting Started page for a refresher.

Read more about Flow Steps.

Did this answer your question?