Registering Applications

As a system administrator of ChemAxon Synergy, you can register new application instances n the Synergy portal. A registered application always has to belong to exactly one team, so application registration can be initiated from the team's page.

Registering a new application instance

If you want to register a new application instance for a team on the Synergy portal, click on the Add application button on the team's page.
On the opening Add application page, you can fill in the Application info URL field with an URL which can give information about the application instance you would like to register in Synergy. The information page of an application has to provide the followings:

  • Application name;

  • Address URL;

  • Icon URL;

  • Health check URL;

  • Communication type, i.e., communication between the user and the application via direct access or via ChemAxon Synergy's gateway service.

Once you hit Approve, you will be navigated to the application registration form, which will already be filled with all the information provided by the application information URL.

Alternatively, you can skip filling in the Application information URL field (by hitting Skip this step) and navigating directly to the application registration form which contains the following fields:

FIELD

DESCRIPTION

REQUIRED

Communication type

type of communication between the user and the application (can be direct or via Synergy's gateway service)

YES

URL part (in the case of "via gateway" communication only)

an identifier of the application, which will be used as a part of the URL where team members can access their team workspace

YES

Name

the name of the application instance, which will appear in the list of the available applications

YES

Address

the URL to the deployed instance

YES

Icon URL

(optional) the URL to the application's icon which will be used in ChemAxon Synergy

NO

Health check URL

URL to provide information about the status of the registered application

YES

Notes

(optional) further information about the deployed instance of the application

NO

Communication type

Please note that depending on the application to be registered, the communication between the user and the new application instance can occur in a direct way or via Synergy's gateway service.

  • If the "via gateway" way has been selected, you will have to set the URL part during registering the application, i.e., an identifier of the application instance, which will be used as a part of the URL where team members can access their team space.

  • If the communication occurs via direct access, you do not have to specify the URL part; however, once the application instance has been registered, a Client ID and a Client secret will be generated for the new registered application. These two properties have to be added to the configuration file of the registered application instance and after that the application can be deployed. In order to get the generated Client ID and Client secret, the system administrator has to go back to the registered application's page (by clicking on the application instance in the Application List page), copy the required properties and paste them in the application's configuration file (or send them to the application developer who will configure and deploy the registered instance).

Once the necessary properties have been entered and the Register application button has been hit, the new registered application will be assigned to the team workspace where the registration has been initiated and an entry will be added to the team's page. Furthermore, the application instance together with its status will be added to the list of registered applications as well on the Applications page.

List of registered applications

By navigating to the Applications page, you can see a list of the already registered application instances and their current status. The status is determined by the health endpoint provided by the application. The cases when this health endpoint is not provided or when the application is down are also indicated by the application status.

Based on this, a registered application instance can have one of the following five statuses:

STATUS

DESCRIPTION

UP

Application is running and is providing a health endpoint

SHUTTING_DOWN

Application is running and providing a health endpoint, but it is marked to shut down

DOWN

Application is down

ERROR

Application is running and providing a health endpoint, but is emitting an error status

UNKNOWN

Application is running, but its status cannot be resolved (e.g., no health endpoint is provided)

Editing a registered application

A system administrator can edit certain settings of registered application instances. By clicking an application name in the list on the Applications page, you will be navigated to the application's page, where you can edit the following settings:

  • Name;

  • Icon URL;

  • Health check URL;

  • Notes.

Please note that the Address, Communication type, URL part (in the case of communication via gateway), Client ID and Client secret (in the case of direct access) fields cannot be edited. If you have to modify any of those fields, you will have to remove the previously registered application instance from the portal and register a new one with the appropriate settings.

Removing a registered application

A registered application instance can be removed from the Synergy portal by navigating to the team's page whom the application belongs to or by navigating directly to registered applications list on the Applications page. If you hover over one of the items in the list, a red Remove button will appear in the same row. After clicking on this button and confirming the removal of the instance, it will be deleted from the portal, and the team to whom it was previously assigned will not be able to use it anymore.