Synchronisation key

Cirrus Assessment Support Team -

Synchronisation key

The synchronisation key (syncId) it is a unique identifier used for external integrations. In IMS LIS it is also known as sourcedId.

Please note:

SyncId's can only be filled with a (non meaningful) GUID (adhering to the  IMS LIS standards).

The 'problem' with a non meaningful GUID is that all the 'read' methods only have the sourceId as a request parameter. This means for example that you won't know which GUID to fill when we want to read person with employee number U123456.

This can easily be resolved using Cirrus:

Hierarchy synchronisation key

  • In Cirrus, a system administrator can view and change the synchronisation key of the hierarchy (group) (also knows as Group in IMS LIS).
  • Synchronisation key can be set during hierarchy creation using Cirrus Administration panel.
  • Go to Administration panel > Hierarchies, then click on the "Add hierarchy" button (fig 4).
  • An "Add hierarchy" dialog will appear (fig 5) in which the administrator can set the Synchronisation key for the new group.
  • In order to view or change Synchronisation key of existing hierarchy go to Administration panel > Hierarchies,
  • Click on the "Edit" icon (fig 4) - the pencil.
  • An edit dialog will appear (fig 6) in which the administrator can see and change the Synchronisation key of the hierarchy.
  • The synchronisation key must be a valid unique GUID (according to IMS LIS standard) and it is not a mandatory input field.
  • Note, that changing the Synchronisation Key can influence the integration with the external system.

Fig 4. Hierarchy tree

2018-09-04_1518-add-hierarchy.png

 

[fig : Edit hierarchy page in Cirrus UI]

2018-09-04_1021-joost.png

 

User synchronisation key

In Cirrus, a system administrator can view and change the sourcedId (Synchronisation key field in Cirrus) of the user. Synchronisation key can be set during user creation using Cirrus Administration panel.

  • Go to Administration panel > Users, then click on the "Add new user" button (fig 7).
  • A user creation dialog will appear in which the administrator can set the Synchronisation key for the new user (fig 8).
  • In order to view or change Synchronisation key of existing user go to Administration panel > Users, then click on the table row (fig 7) for a specific user.
  • An edit page will appear in which the administrator can see and change the Synchronisation key of the user (fig 9).
  • Synchronisation key must be a valid unique GUID and it is not a mandatory input field.
  • Note, that changing the Synchronisation Key can influence the integration with the external system.

Fig 7. Users list preview

Fig 8. User creation dialog

Fig 9. User edit page

 

Comments 0

Cirrus uses Zendesk to provide our Help Center services. Check out Zendesk's Terms of Service and Privacy Policy, as they govern your use of these services.

Powered by Zendesk