UI features
The administrator can manage the features that require authorized access through the UI features. Two actions are available for each feature: Edit Permission and Edit JSON .
Edit Permission
When it comes to editing permissions, there are three crucial aspects to consider:
- Global Enablement: This setting enables the functionality for all users by default, excluding those specified in the "Exclude Users" list.
- Include Users: These are the users who are allowed to access the specific function.
- Exclude Users: This category comprises users who are explicitly denied access to the function.
Edit JSON
Each feature has its own unique characteristics and administrators have the right to fine-tune the configuration.
Before making any changes, it's crucial to be fully informed. It's recommended to back up the current configuration beforehand. After saving the settings, the instance will require a restart to apply the changes.
The following features are available for customization (in alphabetical order)
- ChemDraw Editor
- Computed Prop
- Ketcher 2 Editor
- Reaction Prediction
- User Authentication (userProvider)
ChemDraw Editor
Compatible Versions
Chemotion ELN | ChemDraw |
---|---|
1.5.3 and after | 22 |
1.0.2 to 1.5.3 | 17, 19, 20 |
1.0.2 and earlier | 17 |
Configuration in JSON
To activate ChemDraw in Chemotion ELN, use the following JSON configuration:
{
"editor": "chemdraw"
}
For detailed setup instructions for ChemDraw, please refer to Structure editor.
Ketcher 2 Editor
Compatible Versions
Chemotion ELN | Ketcher 2 |
---|---|
1.1.0 and after | 2.4.2, 2.5.1 |
Configuration in JSON
To activate Ketcher 2 in Chemotion ELN, use the following JSON configuration:
{
"editor": "ketcher2"
}
For detailed setup instructions for Ketcher 2, please refer to Structure editor.
User Authentication (userProvider)
Supported Versions
Chemotion ELN | Protocol/Services |
---|---|
1.6 and after | OIDC, shibboleth |
Setting
Once the settings have been saved, the ELN service requires a restart to apply the changes.
Configuration example:
{
extra_rules: {
enable: false,
disable_signup: true,
disable_db_login: false
},
shibboleth: {
enable: false,
uid: 'pairwise-id',
email: 'mail',
last_name: 'sn',
first_name: 'givenName'
},
openid_connect: {
enable: true,
host: "oidc.address.edu",
icon: "path/to/image.png",
issuer: "https://oidc.address.edu/path/to/issuer",
scheme: "https",
client_id: "myClientID",
redirect_uri: "https://your.chemotion_eln.address.edu/users/auth/openid_connect/callback",
client_secret: "secret",
token_endpoint: "/oauth2/token",
authorization_endpoint: "/oauth2/auth"
},
github: {
enable: false
client_id: null
client_secret: null
}
}
OIDC Parameters
Parameter | Value |
---|---|
enable | true or false |
host | address of the service |
icon | path to a public image to display on the sign-in page |
issuer | URL of the issuer |
scheme | 'https' |
client_id | client ID |
redirect_uri | your Chemotion ELN URL + '/users/auth/openid_connect/callback' |
client_secret | secret |
token_endpoint | '/oauth2/token' |
authorization_endpoint | '/oauth2/auth' |
Shibboleth Parameters
Parameters | Value |
---|---|
enable | true or false |
uid | 'pairwise-id' |
'mail' | |
last_name | 'sn' |
first_name | 'givenName' |
Extra Rules Parameters
Parameters | Value |
---|---|
enable | true or false |
disable_signup | true or false |
disable_db_login | true or false (Please make sure the system has an administrator account that can log in via third-party credentials before disabling DB login.) |