Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleContents
Table of Contents
maxLevel1

...

Setting up and editing Lequinox-enabled applications is available to user accounts with the console administration levels Organisation  Organisation administrator and Platform administrator.  

The Lequinox console is the platform user interface. Other Lequinox enabled applications are to be developed or obtained by the platform owner to custom fit their needs. To benefit from the platform functionality, all applications must be Lequinox compatible and communicate via the platform REST API.

Depending on the application, there might be slightly different preconditions and installation processes.

Warning

The applications under the ‘System’ tab should not be tampered with. For example, changing the Integration API key for the Console service will affect console functionality and – most importantly – make it impossible to sign in to the Lequinox console.

...

Add a new application

Info

Application prerequisites

To set up a new application, you first need

to create the server account, user agreement and user group that are to be associated with the application

to make sure that all that is to be associated with the application is in place:

  1. an applicable user agreement,

  2. at least one user group, connected to the applicable user agreement,

  3. server account.

Steps

  1. Click Applications in the top navigation bar.

  2. Click Applications in the drop-down.

  3. Click New.

  4. Fill in the name of the application.

...

  1.  

  2. Fill in

...

  1. the

...

Info

The URL must be in the https format, the http protocol is not supported.

...

  1. preferred Integration API key. It is possible to get a new key by clicking Generate.

  2. Select the server account intended for the application.

  3. Select the user group or user groups intended for the application.

  4. Click Create.

Info

Write down or save the Integration API key and the Application global id of the application. They will be needed during the next phase of the application activation. To find the required information, click on the newly created application in the list of applications. A page with application information opens.

Edit application information

Steps

  1. Click Applications

...

  1.  in the top navigation bar.

...

  1. Click Applications

...

  1.  in the drop-down.

  2. Click the application you want to edit, the Edit application page opens.

  3. Make the intended changes and click Update

Info

For an application, it is possible – but not recommended – to change the

  • name

URL
  • integration API key

  • server account

  • user group

  • status (enabled/disabled).

Use caution when making changes, since these settings affect application functionality.

Delete application information

Steps

  1. Click Applications

...

  1.  in the top navigation bar.

...

  1. Click Applications

...

  1.  in the drop-down.

  2. Click the application for which you want to delete the information, the Edit application page opens.

  3. Click Delete, and then click Yes to confirm.