Setting up xAPI Actions
Last updated
Last updated
Having created a Salesforce Connected App, we can now go on to setup the xAPI Actions app itself.
Note that you will need to have successfully completed the Creating a Connected App process and generated/copied your consumer key and secret in order to continue setting up your xAPI Actions app.
Search for xAPI Actions from the App Launcher, or "View All" and locate the app:
On first launch you will be presented with an xAPI Actions Setup screen that will need to be populated with essential values in order to get up and running.
Complete the required fields to setup your connection:
Actions Connected App Consumer Key: [Copy and paste this "Key" from your Actions Connected App consumer connection setup.]
Actions Connected App Consumer Secret: [Copy and paste this "Secret" from your Actions Connected App consumer connection setup.]
Enable checkbox: note that the connection is only enabled if selected.
Save the setup configuration to continue.
After saving the initial setup Last enabled and Last disabled date/time stamps are listed along with a reason for the enable/disable decision which may include:
User action
System license change
Org connection failure
Limits exceeded
For a guide to troubleshooting errors on save refer to the Error Messages and Troubleshooting page. If you encounter any ongoing problems with setting up our applications you can always reach out to support@globebyte.com for assistance.
On a successful Save setup the following 2 read-only fields will be populated:
LRS/LMS/LXP Forwarding Endpoint URL
LRS/LMS/LXP Access Token
You will need these to configure your learning platform's forwarding setup.
There is a Copy function associated with each string for accuracy and convenience.
For information on applying the optional statement filters see the documentation here
There is an option to "Regenerate" the LRS/LMS/LXP Access Token. You will need to confirm this action. It is important to note that if you regenerate your access token then you will need to copy the new token and apply it to your LRS/LMS/LXP setup via your learning platform forwarding configuration as described below before normal operation is resumed.
Most learning platforms' "forwarding setup" requirements share common settings which will likely align with the following generic model:
An "Endpoint URL" (sometimes just called “URL”) will need to be entered into the appropriate LRS setting, exactly as generated and in its entirety, there is a copy function to write the Endpoint URL to your clipboard.
A "Token" (sometimes called the "Client Secret") will need to be entered into the appropriate LRS setting, exactly as generated and in its entirety, there is a copy function to write the Token to your clipboard.
An "Authorisation Type" needs to be specified (usually via a dropdown selection).
It is important to note that we only support the “Bearer token” (sometimes just called “Token”) authorisation type. We do not currently support “no auth” or “basic username/password” authorisation types.
You can now continue to create your first Flow
For practical examples of connecting to learning platforms; see here for the forwarding setup documentation for the Learning Pool LRS (formerly Learning Locker), or see here for a description of the Watershed LRS "Add Outbound Data Source" process, here and here for information on connecting with Udemy for Business.
