Package Setup
Installation
Firstly, it is necessary to install the uCheck package into the client's org - contact the Seven20 Product team to obtain the link for the latest package version.
Seven20's uCheck package is dependent on the following core product packages:
- Seven20 - Utilities
- Seven20 - Core
Authentication Set-up
Authentication for the uCheck integration is handled by a named credential and an associated external credential.
-
Create the External Credentials and named principal authentication parameters.
- From setup, navigate to Named Credentials. Select External Credentials and create a new one named uCheck
- Set Authentication Protocol to Custom and save the record
- Under Principals, select New and set Parameter Name to uCheckApiKey
- Set Identity Type to Named Principal
- Under Authentication Parameters, select Add and name it key
- For the value, paste the API key provided by uCheck and save
-
A related Named Credential must be created.
- Under Named Credentials select New. Label and name the record uCheck
- Set URL to https://api.ucheck.co.uk
- Ensure Enabled for Callouts is checked
- For External Credential, select the uCheck record
- For Callout Options, only Allow Formulas in HTTP Body should be checked
- In Allowed Namespaces, enter seven20
- Save the record
-
Users must manually be assigned permission to use the external credential principal uCheckApiKey
- From setup, create a new permission set
- Select External Credential Principal Access and move uCheck - uCheckApiKey to the enabled column
- Under Object Settings find UserExternalCredential and enable Read permissions
- Save the permission set and assign it to all users who should be allowed to post to uCheck
If using uCheck's UAT environment, return to the named credential record called ‘uCheck’ and edit the URL to be the UAT URL: 'https://uat-api.ucheck.co.uk'. A remote site setting with the UAT endpoint must also be configured.
Results Retrieval
Results are retrieved by a schedulable apex job seven20.UCheckResultRetrieverScheduler, that will retrieve all the available results for the last two days from the time it runs. It is recommended to schedule the job to run once a day outside of business hours.
If a request for results is made less than 10 minutes after the previous one, it will be rejected by uCheck with an error.
The apex job can be scheduled as follows:
- From setup, navigate to Apex Classes and select Schedule Apex
- Enter a sensible and recognisable name, for example, uCheck Results Retriever
- Select seven20.UCheckResultRetrieverScheduler in the apex class lookup
- Configure the frequency and preferred start time of the run and save
Permissions
The below required permissions are included in the packaged Seven20__uCheck permission set:
| Type | Name | Access Level |
|---|---|---|
| Object | seven20__Compliance_Request__c | Read, Edit, Create |
| Field | seven20__Compliance__c | Read, Edit |
| Field | Seven20__Error_Text__c | Read, Edit |
| Field | seven20__External_Request_Id__c | Read, Edit |
| Field | seven20__External_Status__c | Read, Edit |
| Field | seven20__Internal_Status__c | Read, Edit |
| Field | seven20__Report_Status__c | Read, Edit |
| Field | seven20__Requested_Date_Time__c | Read, Edit |
| Field | seven20__uCheck_Applicant_Pay__c | Read, Edit |
| Field | seven20__uCheck_HR_Ref__c | Read, Edit |
| Field | seven20__uCheck_Sub_Type__c | Read, Edit |
| Field | seven20__uCheck_Type__c | Read, Edit |
| Object | seven20__Compliance__c | Read |
| Field | seven20__Compliance__c.seven20__Contact__c | Read |
| Object | Contact | Read |
| Field | Read | |
| Custom Metadata Type | seven20__Trigger_Action__mdt | Enabled |
| Record Type | uCheck | Enabled |
The below required permissions are NOT included in any packaged permission set:
| Type | Name | Access Level |
|---|---|---|
| External Credential Principal Access | uCheck - uCheckApiKey | Enabled |
| Object | UserExternalCredential | Read |