Civica Authority Altitude

Connection

The connection to Civica Authority Altitude requires a Connection Profile be configured in Admin → Workstation Options. Use the New button to select Civica Authority Altitude from the list of available integrations. Give the profile a name (e.g. Authority PROD) and then fill in the below connection settings.

Option	Description
API Base URL	The Civica Altitude API base URL (for example, `https://customer.altitudelg.com/main/`).
Client ID	The Client ID to use for authorisation.
Client Secret	The Client Secret to use for authorisation.
Username	Login using this username. Supports placeholders `<<S2>>` and `<<CurrentUser>>`.
Password	Login using this password. Supports placeholder `<<CurrentPassword>>`.

KFI Browse

The following actions are available to browse or search records in Altitude from a KFI Field when the browse button […] is pressed.

Lookup Module Entity Data (PREVIEW)

Automatically lookup entity data from modules such as Applications, Infringements, and Name Register.

This action requires an API endpoint that uses the GET http method and supports OData query parameters. Refer to the Authority API’s Swagger UI page for available endpoints.

Option	Description
API Endpoint	The API endpoint to query. For example: `api/v2/applications/applications` `api/v2/infringements/infringements` `api/v2/nameregister/names/search` `api/v2/streetregister/searchstreets`
Filter	The OData filter to use to filter results of the respective API endpoint. For example, to filter the name regsiter items by email address: `emailAddress eq 'mytestemail@civica.com.au'`
Order By	Order returned items by this field. For example: `emailAddress asc`
Limit	The maximum number of results to find. Default is `1`.
Result Format	The formatting to use for matched items. This can contain placeholders inside curly brackets that contain either a property name or JSON path. For example, to return the email address of the matched entity in name register use: `{emailAddress}` For example, use JSON path to select an array item: `{$.addresses[0].postCode}`

Choose Name Register Links (PREVIEW)

Choose Name Register links to pass through to OpenText Content Manager upload to search for and/or create a corresponding location to link to the record.

Option

Description

ID Format

The identifier format to return to the hidden field after selecting a NAR entry. The default format is NR[Id].

Person Location Format

Configure the location field pairs to pass through to OpenText Content Manager upload person entities. This value is used when searching for or creating a location to attach to the record.

The default format is:

IdNumber||[Id]||Surname||[FamilyName] [FormatName2]||GivenNames||[GivenName1] [GivenName2]||Initials||[Initials]||Type||PERSON

Organisation Location Format

Configure the location field pairs to pass through to OpenText Content Manager upload for organisation entities. This value is used when searching for or creating a location to attach to the record.

The default format is:

IdNumber||[Id]||CompanyName||[OrganisationName]||Type||COMPANY

Choose Module Links (PREVIEW)

Choose entities from various modules to pass through to OpenText Content Manager upload and link to the record.

Option

Description

Link Modules

Configure the Modules that will be available to operator to search for entities to link to the record in OpenText Content Manager upload.

Use the browse button […] to edit this value.

For each module required:

Enter a unique display name
Select the Search method*
Enter the module code to prefix the unique identifier with
Enter the entity field that will contain its unique identifier
Enter the description format using entity field placeholders (enclosed in square brackets)

Search methods are linked to API methods that are defined in the following file:

<EzeScanInstallDir>\Connectors\Civica.Authority.Altitude\ModuleSearches.json

Additional API endpoints can be manually added to this JSON file as required.