Professional Documents
Culture Documents
21A Assessment Partner Integration V2
21A Assessment Partner Integration V2
Integrations -
Assessment
Release 21A
December 2020 (version 2)
DISCLAIMER
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your
access to and use of this confidential material is subject to the terms and conditions of your Oracle software license and service
agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be
disclosed, copied, reproduced or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part
of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
This document is for informational purposes only and is intended solely to assist you in planning for the implementation and upgrade of
the product features described. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in
making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains
at the sole discretion of Oracle.
Due to the nature of the product architecture, it may not be possible to safely include all features described in this document without
risking significant destabilization of the code.
Note: In the images or examples included in this document regarding: user details, company names, addresses, emails, and/or
telephone numbers represent a fictitious sample of data (based upon made up data used in a demo environment). Any similarity to
actual persons, living or dead, is purely coincidental and not intended in any manner.
Introduction
This document is intended to explain the features for conducting assessments using Oracle’s assessment
partner services. It explains the integration enablement and activation along with the technical details for
orchestrating such integrations.
This document is a draft and the information contained is subject to change on further reviews.
What’s new in 20B: The possibility for customers to include the assessment inline in the external candidate
application flow. This comes with few additional indicators, a new status and a return URL with job application
as a parameter, so candidate can continue the application process. Details highlighted in version 20B and
above.
Assessment Overview
Oracle Recruiting customers can initiate candidate assessments from within the application.
When the recruiter creates a job requisition, the recruiter can assign one or more assessment screening
packages to the job requisition until job applications are added to the job requisition.
For assessments during the job application, the recruiter selects the assessments for the internal job
application flow, the external flow, or both. Internal candidates receive an email from the partner to
complete the assessment as soon as they submit their job application. For external candidates, it
depends if the assessment has been defined inline as a block in the application block or is triggered
at time of submission. When inline, additional attributes, including returning URL, is included in
the request, send right away. This is new in 20B. For assessment trigger at the end of the flow,
the candidate can click on the link to initiate the request. If this is not done right away, the schedule
job can send the request to the partner, which in turn can contact the candidate to remind them to
complete the assessment.
For assessments during the selection process, the recruiter selects the phase and state when the
assessment request is sent to candidates then select the assessments. When a job application is
moved to a specific state within a phase, a call is made to the assessment partner’s service who
initiates one or multiple assessments, based on the selected packages in the job requisition. The
partner validates the user requesting the screening service and retrieves candidate and job
requisition information. Once the partner has received all the information, the status of the
assessment is set to “Started”. The partner then sends an email to the candidates with a link to take
the assessments. The partner updates the status to “In progress” when the candidates start the
assessment process. Once the candidates complete all the assessments, the partner updates the
status to “Completed”, “Completed – Fail” or “Completed – Pass” and the overall assessment results
are available in the candidate job applications.
The recruiter can view the results of the assessments from all partners. The recruiter can also click on the link
to access the partner's portal to view more details about the assessment results.
To enable the integration in Oracle Recruiting Cloud, the partner configures their Oracle HCM instance with
integration details such as the web service endpoints, portal information, user accounts. Once the integration is
validated, the partner exports the integration configuration and retains it. The integration and partner details are
published on the Oracle Cloud Marketplace. Customers can see the services and partners on the Oracle Cloud
Marketplace and work with the partners directly for provisioning the integration on their Oracle HCM instance.
The following illustration describes the process to enable and provision the integration.
Field Description
Name Name of the integration partner.
Logo Logo of the integration partner.
Multiphase Support If partner supports multiphase assessments for a
single job application.
Number of Supported Phases Number of supported phases.
Access Token URL – Web Service Endpoint Web service URL to retrieve the access token.
Access Token URL – Method Should keep the Get method.
Access Token URL – Partner Specific Partner specific parameter. Those parameters
Parameters are static parameter that a partner can decide to
append to their URL. No variables or token are
supported in the Partner Specific Parameters.
Account Validation Web Service - Web Service Web service to validate the user account.
Endpoint
Account Validation Web Service - Method Should keep the Get method.
Account Validation Web Service - Partner Partner specific parameter.
Specific Parameters
Assessments Submission Web Service – Web Web service where the selected assessments
Service Endpoint for specific job applications are posted.
Assessments Submission Web Service - Method Should keep the Post method.
Assessments Submission Web Service – Partner Partner specific parameter.
Specific Parameters
Assessments Results URL Web Service – Web Website to return candidate’s assessment
Service Endpoint results.
Assessments Results URL Web Service - Method Should keep the Get method.
Assessments Results URL Web Service - Partner Partner specific parameter.
Specific Parameter
Assessment Notification Web Service - Web Web service where the notifications are sent.
Service Endpoint Added in 20A
Assessment Notification Web Service - Method Should use the Post method. Added in 20A
Field Description
Share Results Across Job Applications This is used when the candidate does not need to re-take the
same package for a different job for a certain period of time.
Validity Period in Days Period for which the results can be shared.
Reference Key Client reference key, customer identifier provided by the
partner to the customer at provisioning. This key is different
for customer’s test and production instances.
Client ID Used with the Client Secret to get the OAuth token.
Client Secret Used with Client ID to get the OAuth token.
4. Assign a user account before activating the partner. You use user accounts to distinguish the type of
service or service packages. For example, you may want to use different user accounts for behavioral
assessment and technical assessment. Note that user accounts are not created through integration,
they need to be added manually. At least one user account must be created. User name and
description are provided. Those users are visible to all now and packages are assigned through
integration.
5. Click Save.
Once the validation is done and the integration is ready to be generally available, the partner exports the
integration configuration and retains the exported files. The integration and partner details are published on the
Oracle Cloud Marketplace. Customers can see the services and partners on the Oracle Cloud Marketplace and
work with the partners directly for provisioning the integration on their Oracle HCM instance.
Partner saves the configuration and activates the assessment integration on their Oracle HCM instance.
Information provided during the activation step is not included as a part of integration provisioning data that is
shared with the customers.
This completes the enablement process and the integration is ready for validation.
1. In the Setup and Maintenance work area, click the Tasks icon and select the Manage Implementation
Projects task.
2. In the Implementation Projects page, click the Plus icon to create an implementation project.
3. In the Create Implementation Project page, provide the following information:
Start Date: Enter the date when the project will start.
Finish Date: Enter the date when the project will finish.
4. Click Save and Open Project.
5. In the newly created implementation project page, click the Plus icon.
6. In the Task Lists and Tasks page, search for the task Recruiting Category Enablement.
7. Select the Recruiting Category Enablement task, click Apply, then click Done.
8. Exit the Implementation Projects page.
1. In the Setup and Maintenance work area, click the Tasks icon and select the Manage Configuration
Packages task.
2. In the Manage Configuration Packages page, click the Plus icon to create a configuration package.
3. In the Create Configuration Package page, provide the following information:
Export: Select the option Setup task list and setup data.
Note: Fields in the Configuration Package Details section are automatically populated with data from the
implementation project.
Security
When accessing a partner’s service from Fusion, the call uses Partner's OAuth token in Authorization header.
When the partner accesses Oracle HCM, the web service call includes Oracle HCM credentials which are used
for basic authentication before enabling access to the requested service. These credentials are provided by the
customer to the partner as a part of the integration provisioning process.
Important Note: LBAC, Location Based Access, might have been activated by customers, preventing access
from external locations (IP). When doing so, the customer is responsible to provide a PUBLIC custom role for
the partner user calling the rest services. If the role is not public, the rest services cannot be called from
outside the customer firewalls. Documentation on LBAC is accessible online.
Assessment Transactions
List of transactions with the logical sequence and examples of those transactions, including some tips on
where to visualize and create some transactions in Recruiting.
This service is used by Recruiting for getting the OAuth token from the partner.
HTTP Method
GET (or POST if partner prefers)
URL
https://{partnerBaseURL}/{context}/accessToken?client_id={clientId}&client_secret={clientSecret}&grant_
type={grantType}
Headers
Customization
Base URL, context and service name are partner specific
{
"client_id" : "XYZ",
"client_secret" : "WER007S",
"grant_type" : "client_credentials"
}
Sample Output
{
"access_token" : "weaasn0ashadzxczxc",
"expires_in" : 1000
}
This service validates the given partner account's username and returns the list of assessment packages
available for the given partner account. It is invoked from partner account setup page.
HTTP Method
Get
URL
https://{partnerBaseURL}/{context}/assessmentAccounts?partnerUsername={partnerUsername}&clientR
efKey={clientRefKey}&{custom_params}
Headers
Authorization : Bearer <oAuth_token>
Customization
Base URL, context and service name are partner specific, Custom parameters can be appended to
end of the URL.
Security Details
Partner's OAuth token in Authorization header.
{
"PartnerUsername" : "OCRl.nasa.acc1",
"Description" : "Account with all the packages",
"packages": [
{
"PackageCode": "ASMT0125",
"PackageName": "Technical Skills",
"Description" : "Package to assess candidate's technical skills"
},
{
"PackageCode": "ASMT0150",
"PackageName": "Soft Skills",
"Description" : "Package to assess candidate's soft skills"
}
]
}
Error
Service: recruitingAssessmentAccountPackages
This service is used by the partner to update partner account status, description or update list of packages for
the given partner account. This service will not create a new user account.
IMPORTANT: for all calls performed by the partner, a user, created by the customer, with appropriate
privileges must be used. The Rest API privilege needed for the calls is: “Use REST Service - Candidate
Assessments”.
URL
https://{RecruitingBaseURL}/hcmRestApi/resources/latest/recruitingAssessmentAccountPackages
Headers
Authorization : Basic <basic_auth_token> Content-Type:
application/vnd.oracle.adf.resourceitem+json
Security Details
Basic Authorization - Integration user account and password in authorization header
This service updates the data for the given partnerUserName even if it is soft deleted or deactivated,
because packages name and description might get updated and indicate that it is obsolete.
Sample Payload
//Create/update/delete packages (Post only active packages for the given account in the
packages array)
{
"PartnerId" : "5D81B08D65C24E5AB6C3030D884D162A",
"ClientReferenceKey" : "65C24E5AB6C3030D88",
"PartnerUsername" : "ocr.nasa.acc1",
"ActiveFlag": true,
"Description" : "Account with all the packages",
Note: All packages associated to an account have to be sent every time. Packages already in Recruiting for an
account but not sent in the transaction will be deactivated.
A user with access to Recruiting, usually a recruiter with the “Manage Job Requisition Screening” privilege,
selects one or multiple assessment packages in the Screenings section of a job requisition. To select
assessment packages, the packages must have been updated in the environment.
In the job requisition Screenings section, the user selects the partner and a user account. Once saved, the
user can update the list of packages associated with various triggers. Those triggers are defined or not within
the application flow configuration and the candidate selection process configuration, both available under the
Setup and Maintenance work area.
In the following image, there is no trigger associated with the candidate selection process, thus no option to
select a package while passing to a pre-defined phase and state. But the same package has been associated
to both the internal application flow, for employees, and the external application flow, for external candidates.
Or once defined inline, the option is visible before reaching the Submit option. The candidate has to complete
the assessment on the partner side, and the partner has to return the candidate to the flow using the return
URL with appropriate token.
The process is similar for internals compared to externals, although the configuration is done within HCM
Experience Design Studio. The assessment block must be activated in the Apply to Internal Jobs flow, as well
as the inline support must be activated at the partner configuration level.
This service is used for triggering assessment request that are not inline or at the end of the external flow if
candidate forgets to click on the link.
URL
https://{partnerBaseURL}/{context}/candidateJobAssessments
Headers
Authorization : Bearer <oAuth_token>
Customization
Base URL, context and service name are partner specific, Custom parameters can be passed in
Payload
Security Details
Partner's OAuth token in Authorization header
Such duplicate calls are valid/expected and partner should handle them gracefully.
},
{
"PackageCode" : "ASMT0185"
}
],
"assessmentSetup": [ //External applyflow
packages are not listed since the candidate is internal.
{
"TriggerType": "ORA_IRC_APPLY_INT",
"PackagesCount": 2, //All two packages listed below
"MultiPhaseFlag": false,
"packages": [
{
"PackageCode": "ASMT0125",
"PackageSequence": 1,
"StatusCode": "ORA_INPROGRESS"
},
{
"PackageCode": "ASMT0150",
"PackageSequence": 1,
"StatusCode": "ORA_INPROGRESS"
}
]
},
Y
ClientRefKey Client reference key STRING 64
InternalCandidateFla
Flag to indicate if the candidate is internal BOOLEAN Y
g
Valid values:
1. ORA_IRC_APPLY_EX
T for assessments
configured for
external applyflow
2. ORA_IRC_APPLY_INT
TriggerType STRING 30 Y
for assessments
configured for
internal applyflow
3. ORA_IRC_CSP for
assessments
configured for
candidate selection
process
packages Y
Unique code identifying the assessment
PackageCode STRING 30 Y
package
Package sequence of this package, if it is
PackageSeque
used in multi phase assessment setup. It will NUMBER 9 Y
nce
be 1 by default for single phase assessments.
Result status code
Valid status codes:
OCR_SERVICE_REQUESTED (Meaning:
Partner service called from Recruiting,
but partner has not posted back the
results yet)
StatusCode STRING 30 Y
ORA_STARTED
ORA_INPROGRESS
ORA_COMPLETED
ORA_COMPLETED_PASS
ORA_COMPLETED_FAIL
ORA_ERROR
ORA_COMPLETED_BY_CAND
IDATE
Notes:
Recruiting provides draft application flag to the partner. Partner knows if it is a draft application based
on this flag.
o Draft application might never be completed
o Draft application has less personal data
o Draft application has higher chance of being deleted
o Inline occurs only for draft applications
o Candidate can be redirected to draft application without 4 hours
Recruiting can provide either email or phone number to partner (to be fetched from token framework
session/table) for net-new candidates. Other personal data will be empty for net-new candidates.
If Redirect URL is provided, partner redirects the candidate to this URL after completing assessments.
CandidateToken generated by this service includes the following inputs going forward;
o ResultsId from IRC_ASMT_RESULTS table instead of SubmissionId & ProvisioningId. While
this has no impact on partner directly, this is required to support the draft application concept in
Recruiting, where the submissionID is not yet created.
o VersionId with value 2 to indicate to Recruiting this is the new version of the CandidateToken.
Output
AssessmentURL
URL to partner portal that can be used by the candidate to take assessments.
Only one combined URL is expected for all the triggered packages in the input payload.
{
"AssessmentURL" : "https://partner_site/partner_parameters"
}
This is entirely managed by the partner. Candidates are notified. Reminders can be sent. Candidates get
information and details on how and when to perform the requested assessments.
recruitingCandidateAssessmentResults
This service is provided for the partner to post assessment results to Recruiting.
HTTP Method
POST
URL
https://{RecruitingBaseURL}/hcmRestApi/resources/latest/recruitingCandidateAssessmentResults
Headers
Authorization : Basic <basic_auth_token> Content-Type:
application/vnd.oracle.adf.resourceitem+json
Security Details
Basic Authorization - Integration user account and password in authorization header
Sample Payload
},
{
"TriggerType": "ORA_IRC_CSP",
"PackageCode": "ASMT0150",
"StatusCode": "ORA_INPROGRESS",
"StatusDescription" :
"QXNzZXNzbWVudCBwcm9jZXNzaW5nIHN0YXJ0ZWQ=", //Base64 string
"Score": 22.2,
"Percentile": 67,
"Band": "RED"
}
]
}
Y
CandidateNumber Candidate number STRING 30
N
Comments Overall comment in base64 CLOB
ORA_IRC_APPLY_EXT for
assessments configured for external
applyflow
ORA_IRC_APPLY_INT for
TriggerType
assessments configured for internal
applyflow
ORA_IRC_CSP for assessments
configured for candidate selection
process
ORA_STARTED
ORA_INPROGRESS
ORA_COMPLETED
StatusCode STRING 30 Y
ORA_COMPLETED_PASS
ORA_COMPLETED_FAIL
ORA_ERROR
ORA_COMPLETED_BY_CANDIDATE*
InputGuide
36 Assessment Partner Integration for this
21Afield
V2is Based64 string
N
Score Assessment score for this package NUMBER 9
N
Percentile Assessment percentile for this package NUMBER 4
Notes:
Once a completed status is provided, it cannot be reverted to in progress anymore.
Status ORA_CANDIDATE_DECLINED has been added, as well as canceled.
Transactions are usually cancelled by Recruiting, not partners.
Status description is not displayed in Recruiting for now, as such, not needed.
A new status was introduced in 20B: Completed by Candidate. This can be used, instead of any
other completion status, if the results will come later. If all results are already available, the existing
statuses, completed, completed – pas or completed fail, continue to be valid. A completion status,
including Completed by Candidate, allows the candidate to submit their job application and should be
returned when the candidate is returned to Recruiting. If there is no completion status returned,
candidate won’t be able to submit job application.
recruitingPartnerCandidateDetails
Service provided for the partner to retrieve more information about the candidate and assessments configured
for the given candidate.
Draft applications, a new concept, might have some empty external candidate values.
o If inline support is enabled, partner will start to receive requests from draft job applications. This
could be for net new candidates with limited data or existing candidate with all data.
o Internal candidates are never net new, thus all available content is always sent.
HTTP Method
GET
URL:
https://{RecruitingBaseURL}/hcmRestApi/resources/latest/recruitingPartnerCandidateDetails/<Candidate
Token>?expand=all
Security Details
Basic Authorization - Integration user account and password in authorization header
Assessment Configuration
Partner, candidate and requisition information are derived using the CandidateToken.
Sample Payload
{
"CandidateToken": "oMJK8Ea08IzZVvKpfvQyyJmH46AyP92PahPNmDLqC-
Ibwv7Yyvg_kt60NTSfQQA3Uu8KxQBa6EZduiHvuqkZgClqq",
"RequisitionNumber": "REQ-US_PLS-101",
"CandidateNumber": "CAND-US-15250",
"CandidateEmail": "jane.doe@example.com",
"FirstName": "John",
"LastName": "Doe",
"MiddleNames": null,
"NamePrefix": "Doctor",
"NameSuffix": "Jr",
"PhoneCountryCode": null,
"PhoneAreaCode": null,
"PhoneNumber": null,
"Address": "1200 First St, Apt 201. <BR> New York, NY <BR> 10000, Unites States".
"AddressDetails":[
{
//ALL 18 attributes
"AddressLine1": "123 Main",
"AddressLine2": "address 2",
"AddressLine3": null,
"AddressLine4": null,
"City": "PLEASANTON",
"Region1": null,
"Region2": "CA",
"Region3": null,
"Country": "US",
"PostalCode": "94568",
"LongPostalCode": null,
"Building": null,
"FloorNumber": null,
"AddlAddressAttribute1": null,
"AddlAddressAttribute2": null,
"AddlAddressAttribute3": null,
"AddlAddressAttribute4": null,
Notes
CandidateToken: Input token passed by the partner is echoed back here. Mandatory.
RequisitionNumber: Job requisition number. Mandatory.
CandidateNumber:Candidate number. Mandatory.
CandidateEmail: Candidate email address. Personal for external candidate and work email for
internals. Mandatory.
FirstName: Candidate's first name. Optional. Now included even for draft applications.
LastName: Candidate's last name. Mandatory. Now included even for draft applications.
MiddleNames: Candidate’s middle names. Optional.
This service is used by Recruiting for getting the URL to partner portal that can be used by the recruiter or
hiring manager to view detailed assessment results of a candidate for a given requisition.
HTTP Method
GET
URL
https://{partnerBaseURL}/{context}/candidateAssessmentResults?partnerUsername={partnerUsername}
&clientRefKey={clientRefKey}&requisitionNumber={requisitionNumber}&candidateNumber={candidateNu
mber}&sessionLang={sessionLang}&{custom_params}
Headers
Authorization: Bearer <oAuth_token>
Customization
Base URL, context and service name are partner specific, Custom parameters can be passed in
Payload
Security Details
Partner's OAuth token in Authorization header
Input
Sample Payload
{
"ResultsURL" : "https://partner_site/partner_parameters"
}
ResultsURL: URL to partner portal that can be used by the recruiter or hiring manager to view detailed
assessment results of a candidate for a given requisition
This service is used to send various notifications. It can be to cancel previous orders or to inform a candidate has been
deleted or has been deleted following a merge into another candidate file. It is up to the partner to react to those
notifications. They can start updating the new candidate ID following a merge, as the original candidate won’t exist
anymore, or they can stop processing a canceled order or even delete the deleted candidates. Adhering to the
notification service is optional. If not defined, Recruiting will not be able to call it. If defined, all notifications will be
sent, thus if partner just support some of those notifications, they should ignore the others.
Note related to 20B: Because 20B now supports inline assessments for draft applications, chances to get deletion
notification from those draft applications are higher. It is recommended to partners to properly handle deleted job
applications and deleted candidates.
Method
POST
HEADER Authorization : Bearer <oAuth_token>
Response Codes
201 Created
401 Unauthorized, if Auth token is invalid
Notes:
Duplicate or Contradicting events can possibly posted. They should be handled gracefully and should not result
in service failure.
Example 1. Delete event and Cancel Order event for the same candidate
Example 2. Cancel order is placed more than once for a given requisition & candidate combination.
Example 3. Merge event reported for the same alpha candidate because two different candidates got
merged to same alpha candidate
Sample Payload
//Merge Event
{
"ClientRefKey":"5D81B08D65C24E5AB6C3030D884D162A",
"CustomValues":"key1=value1",
"Event":[
{
"EventType":"ORA_IRC_CANDIDATE_MERGE",
"RequesterFirstName":"John",
"RequesterLastName":"Doe",
"RequesterEmail":"john.doe@email.com",
"SystemRequestFlag":false,
"EventTime":"2019-07-22T13:44:16.000-0700",
"CandidateNumber":"ALPHA-401",
"MergedCandidate":[
{
"CandidateNumber":"BETA-4001"
}
]
}
]
}
//Delete Event
{
"ClientRefKey":"5D81B08D65C24E5AB6C3030D884D162A",
"CustomValues":"key1=value1",
"Event":[
//Cancel Event
{
"ClientRefKey":"5D81B08D65C24E5AB6C3030D884D162A",
"CustomValues":"key1=value1",
"Event":[
{
"EventType": "ORA_IRC_ORDER_CANCEL",
"RequesterFirstName": "John",
"RequesterLastName": "Doe",
"RequesterEmail": "john.doe@email.com",
"SystemRequestFlag" : false,
"EventTime": "2019-07-22T13:46:16.112-0700",
"CandidateNumber" : "CAND-700",
"RequisitionNumber" : "REQ-JAVA-DEV01"
}
]
}
Notes
You can also select the country in the Manage Person task by using the Territory Code (also known as the
legislation code).
Oracle
Language Iso codes for
Official Labels Codes reference Oracle Login Label
American English US en English
Arabic AR ar Arabic
Brazilian
Portuguese PTB pt-BR Portuguese (Brazil)
Canadian French FRC fr-CA French (Canada)
Czech CS cs Czech
Danish DK da Danish
Dutch NL nl Dutch
Finnish SF fi Finnish
French F fr French
German D de German
Hebrew IW he Hebrew
Hungarian HU hu Hungarian
SSL Support
JDK version 1.7
Cipher suites:
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
Tracking Changes
V1: detailed address format added to candidate details
V2: Highlighted the disclaimer about person images in yellow and removed generic person image from screen
capture