Additional integrations / Add-ons
This article is about additional integrations / add-ons that are not part of any Aptem Apprentice package. If you want to use this functionality, please contact your Customer Success Manager. See Aptem Apprentice pricing and packages for information about the packages.
(epaPRO is now Proficient)
Overview
As an admin with the Manage Tenant Settings role, you can set up the epaPRO integration. epaPRO, now called Proficient, is an end-point assessment management tool built to support end-point assessment organisations (EPAOs).
This feature is only available in Aptem Console.
Before you set up the epaPRO integration for your tenant, make sure you have an active epaPRO account with a provider login you can use for the integration. Standards must be assigned to your provider account so learners can be registered in epaPRO as apprentices.
Enable End-Point Assessment
Select Settings in the left navigation bar. You see this option when you have the Manage Tenant Settings role.
In the navigation bar at the top, select Integrations.
On the Integrations page, select End-Point Assessment.
Set Enable End-Point Assessment to Yes. It's set to No by default.
Once the integration is enabled, you can add connections.
You can also turn on Enable Learners Registration Email. If it's on, every learner registered in epaPRO as an apprentice gets a "New User Created" email from epaPRO with their credentials, so they can activate their apprentice account and sign in to epaPRO.
Add a connection
To add a connection, select +Add connection.
The Add Connection screen opens.
In EPA software provider, select epaPRO.
Enter a Connection name.
Enter your epaPRO username and password. These are your epaPRO provider account credentials.
Enter your End-Point Assessment ID. It must be unique: you can't create more than one connection with the same ID.
Enter the API endpoint. This is the URL you usually use to open your epaPRO instance, for example {trainingprovider}.epapro.co.uk. Remove any extra text, such as "/login", from the end of the URL, or you'll see an error when you add the connection. The API endpoint must be unique: you can't create more than one connection with the same API endpoint.
-
Enter a Client ID and Client Secret, so the two systems can communicate securely. They're case-sensitive alphanumeric strings, which you can get from epaPRO through your EPAO.
Once you save the connection, the password and client secret are hidden and can't be viewed again. To change them, see Edit your epaPRO (Proficient) integration settings.
Add Standards and Specialisms as needed. For details, see Adding EPAPro Standards and Specialisms.
Select Add.
Note: if you see a "Client authentication failed" error, correct the API endpoint, Client ID and Client Secret for the connection.
End-Point Assessment organisation ID
When you set up the epaPRO integration, enter the End-Point Assessment organisation ID for the EPAO.
Aptem accepts two formats for this field:
EPA#### format: for example, EPA0001. This is the standard epaPRO identifier.
8-digit UKPRN: for example, 12345678. Use this if your EPAO uses their UK Provider Reference Number (UKPRN) as their epaPRO identifier.
If the value doesn't match either format, Aptem shows a validation message explaining which format is expected. Correct the value and save again.
Note: if you're not sure which format your EPAO uses, contact them to confirm.
Once the connection is successful, its details are added to the page.
The grid shows the EPA software provider, connection name, EPA ID, API endpoint, client ID and client secret. You can edit or delete connections using the columns.
You need one connection per EPAO. If you work with several EPAOs, create a connection for each.
Connections are shown in the order they were created.
You can edit or delete an existing connection.
Check your Proficient standard codes
Each standard in Aptem must be mapped to the right Proficient standard code (external_standard_id), or the integration won't work for learners on that standard. To find the Proficient code for every standard in your Proficient workspace:
Sign in to your Proficient provider site with an admin account.
Right-click anywhere on the page and select Inspect to open your browser's developer tools.
Go to the Network tab.
In Proficient, go to the Manage Apprentices page (
[your_domain]/modules/users/apprentice).Refresh the page. More network requests appear in the developer tools.
On the Network tab, search for
get_Standardsand select the request.Open the Response tab. It shows the
external_standard_id(Proficient standard code) for each standard.Compare these with the mappings on the epaPRO (Proficient) configuration page in Aptem, at
https://<yourtenant>.aptem.co.uk/pwa/tenant-settings/integrations/epa-pro/connections.Check each Aptem standard code is mapped to the correct
external_standard_id. If any are wrong, update them on the configuration page.
Adding epaPRO Standards and Specialisms
Add a Standard
As a tenant administrator, you can define the standard mappings between an epaPRO instance and Aptem, so that you can register the learner correctly with the epaPRO instance.
- When adding a connection, click + Add Standard to add a standard.
- In the Standard code field, enter the LARS code (same as within the ILR token) of the standard you wish to add. This field accepts numeric values only.
- In the epaPRO standard code field, enter the epaPRO equivalent for the standard code. This field accepts alphanumeric values.
- Click Add.
After you have added the Standard, it will be displayed in the Standards section as shown below.
You can have multiple standards added to your epaPRO connection. To add another standard, repeat the procedure.
Delete a Standard
Standards already entered can be deleted. Note - these standards can only be deleted not edited.
- Click the delete icon to delete a standard.
- Confirm to delete.
- The Standard will be deleted.
Add Specialism
As a tenant administrator, you can define the specialisms mappings between an epaPRO instance and Aptem, so that you can register the learner correctly with the epaPRO instance.
Where the learner is on an apprenticeship programme where there is a specialism involved, you can add the specialism. Make sure the corresponding Standard is also added to the Connection - otherwise, the mapping will be considered incomplete and the Learner registration will not succeed.
- When adding a connection, click + Add Specialism to add a mapping.
- To add a specialism, you must specify the Programme and Specialism ID fields.
- Select the Programme from the dropdown list of delivery programme/sub-programmes. Programmes you have already selected for specialisms for will not appear in the dropdown list.
- Enter the Specialism ID. The Specialism Id field allows any alphanumeric value to be entered. This must relate to one of the standards added to the connection.
- Click Add.
- After you have added the Specialism, it will be displayed in the Specialisms section as shown below.
To add another specialism, repeat the procedure. It is possible to add one or more specialism mappings when adding a connection.
Delete Specialism
Specialisms already entered cannot be edited but can be deleted.
- Click the delete icon to delete a specialism.
- Confirm to delete.
- The Specialism will be deleted.