Fuse technical documentation

HRIS integration with fuse

Overview

Most Fuse customers will have an HRIS integration for automatic user provisioning. Typically this will form part of their Fuse implementation project.

Benefits of HRIS Integration
Integrating your Fuse instance with your HRIS can remove much of the administration overhead associated with managing users at scale and provide all the typical user flows - Create, Update, Deactivate, Reactivate.

In addition, our Audience Management functionality provides powerful logic-based rules to dynamically assign users to their learning, content and roles on Fuse. The Fuse Audience Management uses If/Then/Else logic to reference user profile field data so can be driven dynamically by a HRIS integration.

For example, if a user changes role or location within the business and this is reflected within their Fuse user profile via the automated HRIS integration, Audience Management can automatically reassign them to new Fuse communities and learning plans. No manual community or learning plan assignment is required.

How to provision users on Fuse Platform

Users can be provisioned and managed by:

The Manage Users utility (available to Administrators via the Admin Tools)
Manual CSV upload via the Imports utility (available to Administrators via the Admin Tools)
Custom Batch CSV process via the Fuse FTP server
Fuse REST API (/manage/users endpoint)

Batch CSV processing and the Fuse REST API will be covered later in this document.

User profile fields
In addition to the typical profile fields such as Username, Email, First Name, Last Name, Fuse supports customer-defined profile fields. HRIS integration projects should always start by defining what HR data is available and what data needs to be pushed to Fuse to populate the user profile fields. Only authorised Fuse staff can create custom user profile fields. The defining of user profile fields is part of the standard Fuse implementation process. Updates to customer user profile fields can be requested via the Fuse Support ticketing system.

Linkedin Learning

User profile fields considerations
Customers are reminded that they are the Data Controller for their Fuse instance and share responsibility for their user data within Fuse. Please get approval from your Data Officer or CTO for the HR data being referenced by the integration.

Whilst Fuse can support numerous customer-defined profile fields, in the interest of simplicity, data protection, and API overhead, they should be kept to a minimum. Only data that is required for Fuse user management, reporting, and analytics should be referenced.

Based on numerous customer HRIS integrations we have listed the common user profile fields below, based on standard business data and organisation hierarchy:

Table (1)

Note: Special characters such as Æ, Ø, Å, Ü, Ö and Ä are not currently supported in usernames.

It should be stressed that there is little value in replicating complex organisational structures within Fuse as it just adds unnecessary complexity. Most customers can sort and manage their users within Fuse using a field structure similar to the one shown above.

Automated CSV process

Overview Customers with legacy HR systems or without the resource to leverage our REST APIs can provision users to Fuse via a daily CSV feed to our FTP server. Due to the customisable nature of Fuse this is a custom process for each customer. The automated CSV process is typically scoped and developed as part of the initial Fuse implementation process.

Note: This is a chargeable service, please refer to your Account Manager for more information.

Functionality The automated CSV process is based on an agreed CSV template mapped to the user profile fields on their Fuse. Customers will need to define the necessary HRIS report to populate these CSV fields and automate the upload of the daily CSVs to the Fuse FTP. FTP credentials will be provided.

Due to the constraints of CSVs we typically perform the initial bulk upload of users for the customer rather than use the automated CSV process. Customers can then check their user data, community and learning plan assignments before going live.

The CSV process supports all the standard user provisioning flows -

The Manage Users utility (available to Administrators via the Admin Tools)
Manual CSV upload via the Imports utility (available to Administrators via the Admin Tools)
Custom Batch CSV process via the Fuse FTP server
Fuse REST API (/manage/users endpoint)

The Fuse FTP server is part of our secured AWS environment. It supports FTPS, SFTP and PGP encryption of the CSVs.

The CSV should be UTF-8 format. The customer is responsible for data integrity of the CSVs. Practical CSV field character limit for the process is 60 characters.

Named customer contacts or mailboxes will receive daily process notifications listing successful creations/updates as well unsuccessful creations/updates and errors.

Automated CSV process implementation
The scope of the process will be defined in a Statement of Work beforehand. Once approved, it will typically take 8 to10 working days to develop, test and deploy. Timescales are dependent on the customer providing the necessary test data and data validation. The process will be developed and tested on the customer’s Staging instance first, before being deployed to their Production instance once approved. Once live, change requests and issues should be raised via the Fuse support ticketing system.

Fuse REST API

Overview Fuse has a suite of REST APIs (JSON) that enable customers to manage their users, content and learning. For user provisioning and management, customers can leverage the /manage/users endpoint:

http://<instance_name>.fuseuniversal.com/api/<version>/manage/users

The Fuse API Manage Users Endpoint is free to use for existing customers. Please see our SLA for more information and terms.

Our API uses the standard HTTP Request Methods/Operations for communication:

GET to lookup/retrieve users details.
POST to create new users.
PUT to edit/update/reactivate existing users.
DELETE for deactivating users.

Fuse API supports JSON (JavaScript Object Notation).

Fuse APIs are versioned. We urge customers to always use the latest version of our API.

Customer support for HRIS integrations

Throughout the customer implementation or development project, Fuse works closely with customer development teams. Once an integration project has been defined, we typically have regular project calls to ensure customer developers are up to speed with our APIs and work through any issues. We provide this support free of charge for new and existing customers. Existing customers can request support through the Fuse support ticketing system.

A customer Staging instance will be made available for development. Once tested and approved, the integration can be deployed to the customer Production instance.

API Wiki
Each Fuse instance contains a Swagger-based interactive API Wiki that lists all our APIs and profile fields associated with that instance. This is a great resource for information on all the available Fuse APIs. This is available to Administrator-level users in the Admin Panel:

http://<instance_name>.fuseuniversal.com/site-admin/api_documentations

Important information

User ID
Every user account on Fuse will have a corresponding Fuse userID that is generated automatically by the system at the time of user creation. The userID will be unique and cannot be changed. The userID forms part of many of the /manage/user API requests. Customers can lookup a user’s userID via any attribute (username, email etc).

Username
The Fuse username is a key field that can be used for authentication. It is a mandatory field that must be unique for each user (up to 32 characters). In addition to standard usernames, this is often linked to an employee ID or HR code, so it can be a key reference field across systems.

Email address
Email address is optional but if used must be unique for each user on an instance. Email address is a key field and is often used for authentication. Only valid email address syntax is accepted.

Password controls
Customers can align their instance password controls to their corporate password policy. If setting passwords as part of user creation, the passwords must comply with the password control settings of the instance.

Case-Sensitive
Fuse field names including custom fields are case-sensitive. If a field does not update or you are getting an error response, check that the field name being sent within the request matches the field name on Fuse exactly.

Settings
Most of the user configuration settings can be configured at the instance level so are generally not required to be set at the user level via API but they are available.
For example:

Pink Code box (1)

Language support Fuse supports over 45 languages (more being added continually). Whilst language can be set via the API at user level, most customers will want users to select their own language on first login. If set via the API, the user’s language settings will be overwritten each time the API fires:

Pink Code box (2) (1)

/Manage/User API examples The following are generic common examples of /manage/users API. Please see your API Wiki for more detailed information. API authorisation via Auth0 JWT based token (Oauth).

Lookup user details via user ID