Kenexa     Kenexa XML Integrations                                                     

 

 

 

Candidate Export Integrations:

Candidate Data is any data that applies to a candidate, such as name, address, previous employers, education, skills, or status that is maintained in a client’s HRIS or on a Kenexa Recruiter BrassRing form.

·        Candidate data is usually sent from Kenexa Recruiter BrassRing based upon a trigger of a final HR Action. For example, the client may wish to export candidate data from Kenexa Recruiter BrassRing each time they move a candidate to a final status of “Hire”.

The action can also be manually triggered from the candidate’s talent record by a specified group of Kenexa Recruiter BrassRing users.

·        Candidate data is typically sent from Kenexa Recruiter BrassRing to the client’s HRIS or a vendor, such as a background check provider, with the Candidate Export integration type.

 Candidate information can be exported from Kenexa Recruiter BrassRing to an external system. Candidate information is any data that applies to a candidate, such as name, address, previous employers, education, skills, or status that is maintained in a client’s HRIS or on a Kenexa Recruiter BrassRing form.

Candidate data is usually sent from Kenexa Recruiter BrassRing based upon a trigger of a final HR Action. For example, the client may wish to export candidate data from Kenexa Recruiter BrassRing each time they move a candidate to a final status of “Hire”. The action can also be manually triggered from the candidate’s talent record by a specified group of Kenexa Recruiter BrassRing users.

Special Instructions for Candidate Export Integrations

 

Notes: Candidate exports may be sent with or without supporting requisition data.  The above sample shows Candidate export with requisition data.  Thus the XML envelope contains two packets.  The first packet always contains candidate information and the second contains data about the requisition that candidate was hired against. The Requisition payload is configurable based on the fields requested by the customer during the data mapping process. If a customer has the Requisition import functionality enabled, then all of the fields that are mapped for requisition import will also be present in the second payload in the candidate export.

 

The Candidate payload always contains the following five tags: CANDIDATEID, REQUISITIONNUMBER, BRREQNUMBER, JOBCODE, and STATUS.

1. CANDIDATEID tag contains a unique candidate identifier (Resume Key).

2. REQUISITIONNUMBER contains the client’s optional requisition id number.

3. BRREQNUMBER tag contains the Kenexa Recruiter BrassRing requisition number.

4. JOBCODE tag contains the Job Code associated with the requisition that candidate was hired against.

5. STATUS tag contains the HR action that triggered candidate export.

 

In the envelope section, the <Recipient><Id> node contains target URL where the candidate data will be sent. The Customer may specify any custom URL as well as port number for the transfer.  The Target URL must be accessible from the Internet (i.e. not behind firewall, etc.). All other tags in the payload section are custom tags defined by the customer.

 

Please Note: Data can be pulled only from forms attached to the candidate. This includes basic

candidate information such as the candidate’s name and address.

 

Below is an example of sending the Candidate and the Requisition Payload. However, the Requisition is OPTIONAL and may not be sent if it is not required by the client.

 

Sample Export XML

 

<?xml version="1.0" encoding="UTF-8"?>

<Envelope version="01.00">

       <Sender>

             <Id></Id>

             <Credential>100</Credential>

       </Sender>

       <Recipient>

             <Id>https://ClientHRSystem/PostURL/PostNewhireRecord.aspx</Id>

       </Recipient>

       <TransactInfo transactType="data">

             <TransactId>HSCAND636096</TransactId>

             <TimeStamp>8/21/2008 5:34:34 PM</TimeStamp>

       </TransactInfo>

       <Packet>

             <PacketInfo packetType="data">

                    <PacketId>1</PacketId>

                    <Action>SET</Action>

                    <Manifest>MANIFESTNAME</Manifest>

             </PacketInfo>

             <Payload><![CDATA[<?xml version="1.0"?>

<CANDIDATE>

       <CANDIDATEID>8513444</CANDIDATEID>

       <REQUISITIONNUMBER/>

       <BRREQNUMBER>13659BR</BRREQNUMBER>

       <JOBCODE>41122478</JOBCODE>

       <STATUS>03-Offer Accepted</STATUS>

       <SSN/>

       <LAST_NAME>MAHONEY</LAST_NAME>

       <FIRST_NAME>PATRICK</FIRST_NAME>

       <EMAIL_ADDR>patrick_mahoney_06@sbcglobal.net</EMAIL_ADDR>

       <ADDRESS1>3510 E.Berkshire Court, Unit A</ADDRESS1>

       <ADDRESS2/>

       <CITY>Orange</CITY>

       <STATE>CA</STATE>

       <ZIP>92869</ZIP>

       <COUNTRY>USA</COUNTRY>

       <BIRTHDATE/>

       <ETHNIC_GROUP>White (Not of Hispanic Origin)</ETHNIC_GROUP>

       <WAGE_GRADE>E7</WAGE_GRADE>

       <PAY_SCALE_TYPE>PaySc 02</PAY_SCALE_TYPE>

       <PAY_SCALE_AREA>Zone 3</PAY_SCALE_AREA>

       <EMPLOYEE_GROUP>EEGRP-Reg</EMPLOYEE_GROUP>

       <EMPLOYEE_SUBGROUP>EE-Sub-FT_SL1</EMPLOYEE_SUBGROUP>

       <WORK_SCHEDULE_CODE>Monday-Friday / 40 hours</WORK_SCHEDULE_CODE>

       <SAP_COSTCENTER>10990</SAP_COSTCENTER>

</CANDIDATE>]]></Payload>

       </Packet>

       <Packet>

             <PacketInfo packetType="data">

                    <PacketId>2</PacketId>

                    <Action>SET</Action>

                    <Manifest>REQUISITION</Manifest>

             </PacketInfo>

             <Payload><![CDATA[<REQUISITION language="en">

       <REQUISITIONNUMBER>13659BR</REQUISITIONNUMBER>

       <JOBCODE>41122478</JOBCODE>

       <POSITION_TITLE>Applications Support Specialist</POSITION_TITLE>

       <GLOBAL_UNIT>COO &amp; GRAPHIC COMMUNICATIONS GROUP</GLOBAL_UNIT>

       <ORG_UNIT>GC US&amp;C WESTERN APPLICATIONS</ORG_UNIT>

       <GEOGRAPHIC_LOCATION>USA - CA - Los Angeles</GEOGRAPHIC_LOCATION>

       <FLOOR_BUILDING_SITE>virtual</FLOOR_BUILDING_SITE>

</REQUISITION>]]></Payload>

       </Packet>

</Envelope>

 

 

Synchronous Response XML (sent by client's URL)

 

Success Response

 

<Envelope version="01.00">

       <Sender>

             <Id></Id>

             <Credential>100</Credential>     <!-- Configured for a Client - Integration User - this information does not change once Kenexa provides -->

       </Sender>

       <Packet>

             <PacketInfo packetType="response">

                    <PacketId>1</PacketId>

                    <Action>SET</Action>

                    <Manifest>CANDIDATE</Manifest>

                    <Status>

                           <Code>200</Code> <!-- 200 indicates Success -->

                           <ShortDescription>Upload successful.</ShortDescription>

                           <LongDescription>Candidate was uploaded successfully.</LongDescription>

                    </Status>

             </PacketInfo>

             <Payload/>

       </Packet>

       <Recipient>

             <Id>https://ClientHRSystem/PostURL/PostNewhireRecord.aspx</Id>

       </Recipient>

       <TransactInfo transactType="response">

             <TransactId>HSCAND636096</TransactId>

             <TimeStamp>2008-08-21T14:32:41-07:00</TimeStamp>

             <Status>

                    <Code>200</Code>

                    <ShortDescription>Success</ShortDescription>

                    <LongDescription>Candidate export from Kenexa was a success</LongDescription>

             </Status>

       </TransactInfo>

</Envelope>

 

 

Failure Response 

 <Envelope version="01.00">

       <Sender>

             <Id></Id>

             <Credential>100</Credential>     <!-- Configured for a Client - Integration User - this information does not change once Kenexa provides -->

       </Sender>

       <Packet>

             <PacketInfo packetType="response">

                    <PacketId>1</PacketId>

                    <Action>SET</Action>

                    <Manifest>CANDIDATE</Manifest>

                    <Status>

                           <Code>401</Code> <!-- 401 indicates Failure -->

                           <ShortDescription>Upload unsuccessful.</ShortDescription>

                           <LongDescription>There was an error uploading the Candidate. {Client description of the Error}</LongDescription>

                    </Status>

             </PacketInfo>

             <Payload/>

       </Packet>

       <Recipient>

             <Id>https://ClientHRSystem/PostURL/PostNewhireRecord.aspx</Id>

       </Recipient>

       <TransactInfo transactType="response">

             <TransactId>HSCAND636096</TransactId>

             <TimeStamp>2008-08-21T14:32:41-07:00</TimeStamp>

             <Status>

                           <Code>401</Code> <!-- 401 indicates Failure -->

                           <ShortDescription>Upload unsuccessful.</ShortDescription>

                           <LongDescription>There was an error uploading the Candidate. {Client description of the Error}</LongDescription>

             </Status>

       </TransactInfo>

</Envelope>

© 2008 Kenexa