As a system administrator of Chemaxon Cloud, you can register new application instances on the Chemaxon Cloud portal. A registered application always has to belong to exactly one team, so application registration can be initiated from the team's page.
If you want to register a new application instance for a team on the Chemaxon Cloud portal, click on the Add application button on the team's page ("+" icon next to the "Application" section title).
On the opening Add Application page, you can provide an application "Name" and then click on the Create application button to create a placeholder application instance.
Afterwards, the Edit Application page opens for the newly created application instance, where you should fill in the Application info URL field with an URL which can give information about the application instance you would like to register in Chemaxon Cloud. The Application info URL of an application has to provide the following information:
More information on the format of the data to be provided by the Application info URL can be found in the Application info article.
Once you hit Refresh button, the form fields will be filled with all the information provided by the application information URL.
The application form contains the following fields:
| FIELD | DESCRIPTION | REQUIRED |
|---|---|---|
| Client ID | to share with application so that it can authenticate with the Okta Oauth Authorization Server | read-only |
| Client Secret | to share with application so that it can authenticate with the Okta Oauth Authorization Server | read-only |
| 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 | NO |
| Application info URL | URL to provide information about the application | YES |
| Notes | (optional) further information about the deployed instance of the application | NO |
| Hidden (toggle) | (optional) to hide the application from the dashboard of the team space | NO |
Once the necessary properties have been entered or changed and the Save 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.
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) |
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 Edit Application page, where you can edit the settings mentioned in the table of the Registering a new application instance section above.
{info} Please note that the Client ID and Client Secret fields cannot be edited.
A registered application instance can be removed from the Chemaxon Cloud 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.