SD Worx

Follow

SSO Integration

What can be expected?

This integration allows the users to log into the MobieTrain App, by being authenticated through SD Worx.

Users that exist in SD Worx and log into the MobieTrain App, will also exist on MobieTrain side and can be viewed in the MobieTrain CMS.

Users in MobieTrain will be classified according to their data in SD Worx. This means that for each user we’ll have, in MobieTrain CMS:

  • First Name
  • Last Name
  • Email Address
  • Company ID / External ID
  • User Groups / Paygroups
  • Store / Department

All the users also belong to the Default Group user group. This is a MobieTrain default User Group, that allows to target all the users, when needed.

How does it work?

For the users to be able to log in via SD Worx SSO, they should come in via a special link, created specifically for the client, in the following format:

https://app.mobietrain.com/login/external/<client-account-slug>/<identifier>

When going to this link:

  • If the user is already logged in in SD Worx, he will immediately be accepted into the app.
  • If the user is not logged in, the SD Worx log in page will appear, where the user can insert his credentials, and then he’ll be redirected to the MobieTrain app already logged in.

A user will not be able to log in if:

  • Doesn’t belong to any Paygroup (Paygroups are mandatory on SD Worx end).
  • Belongs to a Paygroup that doesn’t exist in MobieTrain.

User Groups

MobieTrain’s User Groups reflect the SD Worx’s Paygroups.

  • SD Worx’s Paygroups for the users that should be able to log into MobieTrain must already be uploaded into MobieTrain as User Groups.
  • MobieTrain’s User Groups’ External ID is a transformation of the SD Worx’s Paygroups’ ID. This will be used to control unique User Groups / Paygroups.
  • In the CMS, the User Groups will follow the naming convention: Pay Group: <description or name>.
    • If description exists (not mandatory in SD Worx), it will be used in the User Group name.
    • If not, the name field (mandatory in SD Worx) will be used instead.
  • In the database, the User Groups External IDs will follow the naming convention: Pay Group-<pay group ID>

Stores

MobieTrain’s Stores reflect the SD Worx’s Departments. When a User logs in, that is assigned to a department in SD Worx:

  • If the Store already exists in MobieTrain, the User will be assigned to it.
  • If the Store doesn’t exist in MobieTrain, a new Store is created, and the User will be assigned to it.
  • When creating a new store, SD Worx Department’s ID will be the MobieTrain’s Store External ID.
    • If the SD Worx Department has a description, this will be the Store name (Department Description is not mandatory in SD Worx).
    • If the SD Worx Department doesn’t have a description, the Name will be used as Store name (Department Name is mandatory in SD Worx).
  • Stores created automatically in MobieTrain, from SD Worx integration, will follow the naming convention: <department description or name>

What are the dependencies?

  • User Groups Upload must be done. The existing Paygroups that should have access to the MobieTrain App should be uploaded.

What do we need from the client?

  • SD Worx companies’ IDs to use in the integration. SD Worx should be contacted by the client to get this information.

F.A.Q.

  • Can the users still login normally through the MobieTrain App login?
    No. A user that logs in via the normal MobieTrain App login will not be recognized as a user belonging to the client’s account.
  • Can a user login through the MobieTrain App using SD Worx credentials?
    No. The user’s SD Worx credentials are known only to SD Worx and can’t be used anywhere else.
  • Is the SD Worx SSO integration compatible with CNAME configuration?
    Yes. The only thing it should be taken into consideration is that the special link that is used to log in through SD Worx will be different, containing the client’s configured domain.
  • Can the user add the MobieTrain app to his Home Screen?
    Yes. But he should only do this after he’s logged into the MobieTrain app. Otherwise, he will be adding the SD Worx log in page instead of the MobieTrain app.
  • What happens if I add a Paygroup in SD Worx that doesn’t exist in MobieTrain?
    Any user that is assigned to that Paygroup, will not be able to log into the MobieTrain app. In order to be able to do this, the Paygroup should be added manually in MobieTrain CMS, following precisely the naming conventions for the User Group Company ID/External ID.
    If the naming conventions are not followed, the system will not recognize it as an existing User Group.
  • If I edit a User, User Group or Store in the MobieTrain CMS, will this be reflected in SD Worx?
    No. The synchronization of users is done from SD Worx to MobieTrain. It might happen that the MobieTrain information can even be overwritten by the SD Worx information. Also, making changes in the CMS, in the Users, User Groups or Stores, might break the integration and it might stop working. SD Worx should be conisdered as “source of truth”, and changes to Users, User Groups or Stores in the MobieTrain’s CMS should always be discussed with your Customer Success agent.

User Groups Upload

What can be expected?

MobieTrain will upload all the needed User Groups to start using the SD Worx integration.

It doesn’t include future User Group maintenance (adding, editing or removing). This is the responsibility of the client.

How does it work?

After the client provides a CSV file with the information for each User Group/Paygroup, MobieTrain will upload these into the CMS, according to the rules to work with the SD Worx SSO integration.

What are the dependencies?

  • None.

What do we need from the client?

  • A CSV file with all the Paygroups that will be used in MobieTrain, so that they can be uploaded up front. Remember that a user that belongs to a Paygroup that doesn’t exist in MobieTrain, will not be able to log in. This list should include, for each Paygroup, from SD Worx:
    • id
    • name
    • description

Button Display

What can be expected?

This integration allows that a button is displayed in SD Worx for the SD Worx’s users. This button is a direct link to the MobieTrain App that allows the users to go directly to the App, already logged in.

How does it work?

To display the MobieTrain’s button that links to the MobieTrain App, there’s an action - cron job - that is run every day at 1:00 UTC:

  1. An SD Worx endpoint is called to get a list of all the employees, per Company ID.
  2. If the employee is active, we call an additional SD Worx PUT endpoint, to show the button for that employee.
  3. If the employee is inactive, we call an additional SD Worx PUT endpoint, to not show the button for that employee.

<aside> ⚠️ We do not do any kind of user update, creation or removal, in this process.

</aside>

What are the dependencies?

  • The SD Worx SSO integration should also be implemented.

What do we need from the client?

  • SD Worx companies’ IDs to use in the integration. SD Worx should be contacted by the client to get this information.

F.A.Q.

  • Can the users still use the special link for SD Worx SSO?
    Yes. The users can go to MobieTrain’s App by clicking the button, or by using the special SSO link created for the integration.
  • Is it needed to implement the Button to use SD Worx SSO?
    No. The users can log in via the special SSO link without the button.

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.