Working with Scopes

When working with App Config Versions in the Axsy Config Tool it is possible to define multiple Config Scopes so that different profiles and/or users receive different configuration settings.

There is always an Org Default Config Scope. To create additional scopes:

  1. While in edit mode with the Axsy Config Tool, select the Manage Scopes button
  2. In the window that appears, select the Create Scope button
  3. Give the scope a name, and search for profiles and/or users to add to the scope
  4. Select Save

Figure 1 - Select the "Manage Scopes" button to create a new scope

Figure 2 - The "Manage Scopes" window displays a list of existing scopes along with a "Create Scope" button to create a new one

Figure 3 - Each Scope can be given a name and has search boxes available to add users and profiles to the scope

Figure 4 - To view and edit an existing scope, select it from the "Scope" drop-down list in the Axsy Config Tool

After completing the above steps, the newly created scope will initially match the Org Default, but further edits to the scope can be made to apply different behaviour. Scopes are applied to users logged in to the Axsy Mobile App based on a hierarchy:

  1. If the user is listed in the Users List for a scope, that scope's configuration will be applied
  2. If the user is not listed in any Users List for a scope, but the user's profile is listed in the Profiles List for a scope, that scope's configuration will be applied
  3. If the user is not listed in any Users List for a scope and the user's profile is also not listed in any Profiles List for a scope, then Org Default scope will be applied

Comparing Scopes

It is possible to visually compare the differences between two scopes. To compare the current scope being edited to a different scope:

  1. Select the scope to view and edit from the Scope drop down list
  2. Select the scope to compare it to from the Compare drop down list

Any differences will be highlighted in yellow. Yellow highlighting of differences is done in real-time as you make edits. This allows you to actually compare a scope to itself, effectively highlighting any changes you're making in real-time from the previously saved version of the scope.

Figure 5 - In the above example, the "Community Plus Scope" is being compared to the Org Default scope and the yellow highlighting shows that, under "Sync > Visits > Query Parameters" that there is a difference between the "Next Days" and "Previous Days" parameters

Figure 6 - Using the same example as above, the yellow highlighting shows that, under "Sync > Events > Related Objects", that the "Account" object being included in the "Community Plus Scope" sync tree differs from the Org Default scope

Applying a Patch File to Match Scopes

When comparing two scopes, it's possible to download a JSON Patch file that contains all the differences between the two scopes - i.e. effectively a file representing those items highlighted in yellow. The JSON Patch file can then be applied to a scope which updates it with the differences contained in the JSON Patch file so that both scopes are now identical.

Figure 7 - The "Download" button to the right of the "Compare" drop-down list will allow you to save a JSON Patch file while the "Upload" button to the left of the "Manage Scopes" button will allow you to apply a JSON Patch file to the current scope being edited