Kenexa     Kenexa XML Integrations                                                     

 

 

 

Forms (ILoad) Integrations:

 

Data can be imported into a pre-existing Kenexa Recruiter BrassRing form from a client-initiated XML feed.  This integration is sometimes known as the iLoad process.  Forms Data is data that directly corresponds to the client’s pre-existing custom candidate forms within Kenexa Recruiter BrassRing.  Some types of form data that might be uploaded include EEO forms, test results forms, interview forms.  Also, third party vendors can use Form Import to upload candidate test results or background check information to Kenexa Recruiter BrassRing.

 

There are two requirements for Form integration: 1. A candidate must exist in Kenexa Recruiter BrassRing before a form can be attached to the candidate’s record, and; 2. The form must be already defined in Kenexa Recruiter BrassRing. Multiple forms can be uploaded in one transaction as long as all forms are of the same type.

A typical Form Import scenario works like this: The client emulates the Kenexa Recruiter BrassRing custom form of their choice in any application they wish, such as an Excel spreadsheet. The data is then transformed by the client from the existing format and passed to Kenexa Recruiter BrassRing in XML format via the Internet.

Special Instruction for Forms (ILoad) Integrations

1.      Multiple forms can be uploaded in one transaction.  Each form must be in its own packet with only one form per packet.  The file size limit for Form Imports should be 64KB per transaction.  Wait for the response (success or failure) then send the next transaction of up to 64KB.

  1. Form tag contains ten attributes: formTypeID, FormName, formId, action, resumeKey, FirstName, LastName, email or homePhone, language and autoreq

            a.      formTypeID is a value identifying the form type and is provided by Kenexa.

b.      formName identifies the name of the form within Kenexa.

c.      formId is used when the client wants to update a form for a candidate and they know the internal formid of that  

       candidate form, they can pass that number in the feed, and Kenexa will update that specific form. Advantage  

       here is that, if the candidate has a “multiple per candidate” form, client can specify which form instance they

       want to update.

d.      Action specifies whether a new form should be inserted or an existing form should be updated.

e.      resumeKey is the candidate identification number that is sent to the candidate upon completion of a job apply.

       When resumeKey is passed in the xml, you can pass name phone number email address etc as empty  

       nodes.

f.       FirstName is used to identify candidates and is a required attribute.  Value may be empty if resumeKey is

       supplied.

g.     LastName is used to identify candidates and is a required attribute. Value may be empty if resumeKey is

       supplied.

h.     If resumeKey is not supplied, then a value for either email or homePhone is also required in order to identify the

      right candidate in the system. If no candidates or multiple candidates are found with the same FirstName, LastName and email/homePhone information, the form will be rejected. Please note: If both email and homePhone information is sent for a candidate, Kenexa will look for an exact match for both email and homePhone.  Value may be empty if resumeKey is supplied

i.      Language is the node that defines the language of the form responses( whether it is a French form or German form etc.)

j.      Autoreq is required when you insert or update a “per req” form

3.   Form updates have 3 parameters that can be sent in the processing information attribute called “action”.

                        I.      Insert – will insert a new form with the information provided

                       II.      Update – cleans the existing form and updates with new information that is provided.

                 For example, Candidate A’s EEO form information is sent using the “Update” parameter.

<SEX>Male</SEX>

<ETHNICITY>Decline</ETHNICITY>

<RACE>I am declining to provide this information</RACE>

<HISPANIC OR LATINO>No</HISPANIC OR LATINO>

                Sending this information erases all Candidate A’s existing EEO form information and updates it with the above 

               information.

                              III.      UpdateIndividual – It will only update the fields that are sent and will keep the remaining fields untouched.

                          For example, the same Candidate A’s EEO form information is sent using the “UpdateIndividual” parameter.

<ETHNICITY>Native Hawaiian or Other Pacific Islander</ETHNICITY>

<RACE>Caucasian</RACE>

                     This will update only the Ethnicity and Race fields, leaving the existing Sex and Hispanic or Latino responses 

                      untouched.

 

Sending empty elements will update fields to blank.  If the below XML is sent, then even though no information is sent in Hispanic or Latino, the integration will update it to blank.

<ETHNICITY>Native Hawaiian or Other Pacific Islander</ETHNICITY>

<RACE>Caucasian</RACE>

<HISPANIC OR LATINO></HISPANIC OR LATINO>

 

4.   FormInput contains the field id and the field name as defined on the specific candidate

form. These values are provided in each template and should not be changed.

 

 

Sample XML 

 

<?xml version="1.0"?>

<Envelope version="01.00">

       <Sender>

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

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

       </Sender>

       <Recipient>

             <Id/>

       </Recipient>

       <TransactInfo transactType="data">

             <TransactId>5555</TransactId>   <!-- This is for tracking purpose for use to the Client only. It can be numeric or alphanumeric -->

             <TimeStamp>2006-02-28 09:22:10AM</TimeStamp>    <!--date-time value for troubleshooting and tracking -->

       </TransactInfo>

       <Packet>

             <PacketInfo packetType="data">

                    <PacketId>1</PacketId>

                    <Action>SET</Action>

                    <Manifest>MANIFESTNAME</Manifest> <!-- Manifest is configured for a client at the time of integration. Provided by Kenexa-->

             </PacketInfo>

             <!-- The PayLoad information below is for a given Form. The information below will be different depending on the Form. The ID values are generally different in Staging and Production  -->

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

<form formTypeId="327" formName="Assessment Form" action="Insert">

       <FormInput name="1627" title="Percentile">49</FormInput>

       <FormInput name="1628" title="T Score">49</FormInput>

       <FormInput name="1629" title="Language">EN</FormInput>

       <FormInput name="1630" title="Norm Group">Experienced</FormInput>

</form>

]]></Payload>

       </Packet>

</Envelope>

 

© 2008 Kenexa