AireFrame

Appearance

AireGlu Data Source ​

AireGlu is the AireSuite integration engine.

The AireGlu data source exposes data returned by user-configured AireGlu endpoints. It is available as a Bundled Data Source. You can add multiple instances of the AireGlu data source, to be used for different purposes.

The user-configured AireGlu endpoints receive requests from AireFrame and return the appropriate data in the structure that AireFrame requires. Which endpoints need to be configured depends on the capabilities you wish the AireGlu data source to provide. These endpoints must be created in AireGlu in the same tenant that you are using for AireFrame.

Currently AireGlu data sources can support the following capabilities:

  • SubjectRead
  • StructuredData

AireFrame uses cursor-based pagination. More details are included in the specifications of the paging-related endpoints.

Preparing to set up your AireGlu data source ​

To use an AireGlu data source, you must contact support@airelogic.com to request the set up of an AireIdentity client which AireFrame will use to authenticate the calls to AireGlu. You will need the client ID and secret to proceed. This client can be reused across multiple AireGlu data sources if wished.

For each AireGlu data source, you must do the following:

  1. Decide on an identifier that will be included as a prefix to the AireGlu endpoints that AireFrame calls. This will be specified when you set up the data source (see Configuration Options)
  2. Create the following AireGlu endpoint:

Now you are ready to add your AireGlu data source in AireFrame.

Configuration Options ​

When you add an instance of an AireGlu data source, you will be presented with the following configuration options:

  • AireGluClientId - The id of the client used to authenticate the calls to AireGlu
  • AireGluClientSecret - The secret of the client used to authenticate the calls to AireGlu
  • AireGluEndpointPrefix - The prefix you will include in the name of all the user-configured AireGlu endpoints that this data source will use
  1. Enter the configuration details
  2. Select Validate. AireFrame will now call the AireGlu get-capability-metadata endpoint you have set up. If the call is successful you will see a list of the capabilities you have specified
  3. Select Create

Creating endpoints to fulfil the capabilities you have specified ​

In addition to the endpoint-prefix-aireframe-get-capability-metadata endpoint that you must configure for all AireGlu data sources, the following AireGlu endpoints must be configured to support different capabilities:

SubjectRead endpoints ​

For the SubjectRead capability, you must configure the following endpoints:

These endpoints allow the AireGlu data source to be used as a subject provider for AireFrame.

StructuredData endpoints ​

For the StructuredData capability, you must configure the following endpoints:

These endpoints allow the AireGlu data source to provide the ability for users to define data extracts in AireFrame and ultimately produce visualisations.

Managing data ​

(StructuredData capability)

For performance reasons AireFrame will by default cache data returned by AireGlu endpoints implemented for the StructuredData capability. You will need to manage the refreshing of this cache, otherwise the data will not update after initial retrieval. There are two mechanisms provided by AireFrame to allow you to programatically do this:

  • An API which you can call when data has changed externally on a per subject basis. This is detailed here. This is the preferred mechanism.
  • An API which can be called by an AireGlu job on a scheduled basis (e.g. nightly) to refresh an entire data set (the data stored for a particular data extract). This is detailed here. The AireGlu endpoint you use to call this API should be secured by InternalOnly authentication.

To opt out of the caching of structured data, set the optional CacheStructuredData property on the endpoint-prefix-aireframe-get-capability-metadata AireGlu endpoint to false (specification).

Updating your data source settings ​

If you change any settings in the JSON returned by your get-capability-metadata endpoint, for example adding a new capability or disabling the caching of structured data, then click into the data source instance in the config area of AireFrame and use REFRESH AND SAVE CAPABILITIES to pull through your updated settings.

The configuration options you were presented with within AireFrame, such as the AireGluClientId, can be updated by clicking into the data source instance and changing the values entered there then using UPDATE. This will also refresh the settings pulled from the get-capability-metadata endpoint.