- 06 Sep 2024
- 4 minutes to read
Totara Connect settings
- Updated on 06 Sep 2024
- 4 minutes to read
When setting up Totara Connect on your site you can configure the following settings.
Totara Connect server settings
These can be configured via Quick-access menu > Users > Accounts > Totara Connect server > Settings.
Setting | Description | Notes |
---|---|---|
Sync user passwords | If you want to send user password hashes from your server site to client sites, enable this setting. | - |
Totara Connect client settings
These settings can be configured under Quick-access menu > Plugins > Authentication > Totara Connect client > Settings.
Setting | Description | Notes |
---|---|---|
Automatic single sign-on via server | This setting allows you to automatically log on to a Totara Connect client site connected to a specific Totara Connect server. Choose a Totara Connect server to automatically sign on from. Note that you need to connect to a server first to select it from the list. | - |
Migrate local accounts | When enabled, local accounts are migrated to Totara Connect accounts. Totara Connect accounts can log in only via single sign-on. | You should make sure the selected account mapping cannot be abused by Totara Connect server users to hijack existing client accounts. For example, when mapping via username, users should not be allowed to sign up for new accounts on the Totara Connect server. |
Account mapping | Choose the field you want to use to map user accounts by during migration. You should make sure this field is locked and cannot be modified by ordinary users or customised during user self-registration, both on the server and clients. User fields available are:
| - |
Synchronise custom profile fields | When enabled, custom profile field data for users will be automatically copied from the server site. | Matching custom profile fields must be created manually on the client site first. |
Action to take when a user is removed from the restricted audience | If your Totara Connect users are restricted to an audience on the server, this setting determines what happens with local accounts when the user is removed from that audience on the server. Options are:
| Please note that any synchronised users who are deleted from the server will also be deleted from the local site. |
Synchronise job assignments | When enabled, job assignments will be automatically copied from the server site. Managers and appraisers are not synchronised, and other manual changes in synchronised job assignments are automatically reverted. Manual job assignments can still be used, and are not affected. | - |
Synchronise positions | When enabled, position frameworks and positions will be automatically copied from the server site. It is recommended that you change permissions so that users cannot modify positions manually. | Position types must be created manually with the same ID numbers, including any matching custom fields from the server site on the client site. Custom fields should also be locked on client sites. |
Synchronise organisations | When enabled, organisation frameworks and organisations will be automatically copied from the server site. It is recommended that you change permissions so that users cannot modify organisations manually. | Organisation types must be created manually with the same ID numbers, including any matching custom fields from the server site on the client site. Custom fields should also be locked on client sites. |
Allow requests to plugin services | When enabled, this allows requests from Totara Connect servers to access services defined in any plugins. | - |
Totara Connect client system settings
As a Site Administrator you can add a client by going to Quick-access menu > Users > Accounts > Totara Connect server > Client systems and selecting Add client.
Setting | Description | Notes |
---|---|---|
Name | Enter a name for the client site. | - |
Client URL | The URL of the client site. This should be the URL provided when connecting to a new server. |
|
Client setup secret | The setup secret for the client site. This should be the client setup secret provided when connecting to a new server. | - |
Allow plugin service requests | When enabled, this allows requests from Totara Connect servers to request services defined in any plugins for the Totara Connect client. | - |
Sync custom profile fields | When enabled, custom profile field data for users will be automatically copied from the server site. | Custom profile fields must be created manually with the same short name on the client site first. |
Sync job assignments | When enabled, job assignments will be automatically copied from the server site. Managers and appraisers are not synchronised, and other manual changes in synchronised job assignments are automatically reverted. Manual job assignments can be still used and are not affected. | - |
Sync position frameworks | Choose the position framework(s) to synchronise to the client site. | - |
Sync organisation frameworks | Choose the organisation framework(s) to synchronise to the client site. | - |
Restrict to audience | You can choose to only synchronise users from a specific audience from the Totara Connect server to the Totara Connect client site. The restriction is applied to all synchronised audiences, and courses too, i.e. only the audience restricted gets synchronised. | - |
Add new courses | If enabled, each new course created in the LMS will be synchronised with the client to create a matching new audience (Totara Learn). The enrolled users of the courses will be added as members to the respective groups or audiences created. | - |
Add new audiences | If enabled, each new audience created in the LMS will be synchronised with the client to create a new audience (Totara Learn). The members of the audiences are added as members to the respective groups or new audiences. | - |
Synchronised audiences | Choose one or more audiences and synchronise members to the client site. | - |
Synchronised courses | Choose one or more courses and synchronise all enrolled users to the client site. | - |
Comment | Add any applicable comments related to the client site. | - |
© Copyright 2024 Totara Learning Solutions. All rights reserved.