Setting field definitions - Configuring the Candidate Profile XML

8 Candidate Profile

8.1 Configuring the Candidate Profile XML

8.1.3 Setting field definitions

Field definitions for a candidate profile immediately follow the instructional header in the XML of the candidate profile template. The field-definition elements define the data fields on the candidate profile record that appear in the More Information section.

SuccessFactors Recruiting Management Candidate Profile

Field Definitions on the Candidate Profile

8.1.3.1 Candidate Profile XML Element Structure

The XML that defines fields in the More Information section of the Candidate Profile contains the following elements:

● <field-definition> Internal identification of the field in the system. Must contain at least one field-label element.

● <field-label> The visible portion of the field, which appears the same to all internal and external candidates, recruiters, and all other users. The only reason to include multiple labels is to support multiple languages, which requires the client to purchase corresponding language packs.

● <field-description> Description of the field is an optional element within the field-definition elements. In some browsers the field-description element appears as hover text in the system user interface.

For example, the definition of the first name field consists of the following:

<field-definition id="firstName" type="text" required="false" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[First Name]]></field-label> <field-description><![CDATA[First Name]]>

</field-description>

You need not use all standard fields in the XML, only those the client requires. You need not configure the field IDs in the same way as the field IDs in the Succession Data Model, even if the fields are sm-mapped to the Employee Profile.

The field-definition element uses the following sample structure.

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

id Attribute

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

The id must be unique within the Candidate Profile XML template. Certain field-definition ids are predefined in the product as standard.

Click here for a full list of candidate profile standard field ids. Partners can access the list here.

Some standard field ids have special functionality.

Tip

You cannot define default values for any fields in the Candidate Profile XML.

Table 12: Candidate Profile Standard Fields with Special Functionality

Standard Field ID Field Type Special Functionality

contactEmail text _{● All email sent from the system}

to the candidate is sent to this email address.

● Appears on the user account creation page for external can didates. The field is required on the account creation page un less Use email as external applicant userId is not selected. ● Appears in the Candidate Pro

file business card instead of the normal field listed.

● For internal candidates, this field automatically syncs to the Employee Profile.

● Appears as a standard column / part of the Contact Info on the candidate search results. ● Required

SuccessFactors Recruiting Management Candidate Profile

Standard Field ID Field Type Special Functionality

firstName text _{● Appears on the user account}

creation page for external can didates.

● Appears in the Candidate Pro file business card instead of the normal field list.

● For internal candidates, this field automatically syncs to the Employee Profile.

● Appears as a part of the clicka ble link in the Candidate column in the candidate search results. ● Required.

lastName text _{● Appears on the user account}

creation page for external can didates.

● Appears in the Candidate Pro file business card instead of the normal field list.

● For internal candidates, this field automatically syncs to the Employee Profile.

● Appears as a part of the clicka ble link in the Candidate column in the candidate search results. ● Required

middleName text _{● Appears on the user account}

creation page for external can didates.

● Appears in the Candidate Pro file business card instead of the normal field list.

● For internal candidates, this field automatically syncs to the Employee Profile.

● Appears as a part of the clicka ble link in the Candidate column in the candidate search results. ● Required

gender derived Do not configure in the Candidate

Standard Field ID Field Type Special Functionality

ethnicity text or picklist Do not configure in the Candidate

Profile; configure in the Application instead.

race text or picklist Do not configure in the Candidate

Profile; configure in the Application instead.

cellPhone text Appears in the Candidate Profile

business card instead of the normal field list

homePhone text Appears in the Candidate Profile

search results as the default phone number.

state text or picklist _{● Configure as a picklist if possi}

ble; to improve duplicate candi date checking reliability ● Required.

country picklist Required.

zip text or picklist _{● Used as part of Radial Candi}

date Search ● Required

dateOfBirth date Do not configure in the Candidate

Profile; configure in the Application instead.

disabilityStatus text or picklist Do not configure in the Candidate Profile; configure in the Application instead.

ssn text This field is not encrypted and

should not be used.

veteranStatus text or picklist Do not configure in the Candidate Profile; configure in the Application instead.

resume richText _{Appears as an attachment field,}

even though it is configured as a richText field.

Always appears in the user inter face, even if not explicitly config ured in the Candidate Profile XML. Used in the candidate search key word functionality.

SuccessFactors Recruiting Management Candidate Profile

Standard Field ID Field Type Special Functionality

coverLetter richText _{Appears as an attachment field,}

even though it is configured as a richText field.

Always appears in the user inter face, even if not explicitly config ured in the Candidate Profile XML. Used in the candidate search key word functionality.

type Attribute

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

The type attribute defines the data that the system accepts in the corresponding field. It consists of the following options:

● text a single line of alphanumeric text with a 100-character limit (character limit and display are nonconfigurable).

● textarea alphanumeric text with a 256-character limit, shown as a 100-character-wide box (character limit and display are non-configurable).

● date a date that is manually entered or selected from a calendar. Displays mmddyyy or ddmmyyyy according to user's chosen language pack.

● percent a percent value with one decimal place.

● bool true or false (shown as a check box); if you make this attribute required because if must always be checked.

● enum an enumerated type (shown as a pull-down list) where values are defined in the XML. ● number a number value with two decimal places, formatted by locale.

● currency a currency value, where currency symbol is determined by the field id "currency." ● picklist field options from a picklist defined in admin (shown as a pull down list).

● derived a pull-down or "find value" field (depending on length of list) where values are automatically determined from another area of the system

● instruction a non-editable field that stretches left-to-right across the screen, used to display messages to users. Cannot be made reportable or writable; if reportability or writability is configured, error messages will result

● multiattachmentselection A field that can have multiple documents uploaded and attached. Acts as a mini library where all documents uploaded are stored for later reuse. This means that there is an additional check box next to all uploaded files and that checkbox must be selected to attach the document to the record.

● hyperlink field that stores a URL and text to show instead of the URL

required Attribute

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

This attribute defines whether a field is required for a candidate profile record to be completed.

Required fields are required for both candidates and recruiting users when completing a Candidate Profile. Allowable values for required fields are true or false. You cannot make fields conditionally required on the candidate profile; that is, a required field displayed to both internal and external candidates is required for both candidate types. For this workflow, create two separate fields with the same label, where one is set to

required="trie", and the other as required="false". Use field-level permissions to show the required field to one audience and the optional field to the other audience. Advise the client that this workaround has a reporting impact and they must add both fields separately to reports.

You cannot make a field required for candidates and optional for a recruiting user who is entering a candidate manually using the Add Candidate functionality. The recruiting user must complete every required field a candidate has to complete. For this reason, clients may choose to configure fewer required fields, add a special value (such as N/A or Picklist) to picklists for internal recruiting users to select when adding a candidate without knowing the correct value (such as N/A or Pending), and advise recruiting users about the appropriate values to use in fields without picklists.

You cannot hide, show, or make a field required, based on the answer to an earlier field. For example, you cannot ask, “Have you ever been convicted of a felony?” and then show a “Please explain” field if the candidate selects yes for the first question. The suggested workarounds are:

● Make the “Please explain” field optional and name it something like “If yes, please explain.”

● Make the “Please explain” field required and name it something like “If yes, please explain (enter N/A if not applicable).”

custom Attribute

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

Some field id attributes are reserved as standard fields. They do not necessarily need to be included in the XML configuration but if used, they must have the appropriate corresponding field type and be marked as

custom="false". All other field ids should be marked custom="true".

anonymize Attribute

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

SuccessFactors Recruiting Management Candidate Profile

The anonymize attribute identifies whether a given field contains personally identifiable information and should be purged.

Related Information

Candidate Profile Standard Field Guide

Candidate Profile Standard Field Guide - Partner Access

8.1.3.1.2 field-label Element

The field-label element usually controls the appearance of a field name in the user interface. However, not all UI field labels are controlled by this element. On certain fields, the Succession Data Model controls the field label; on other fields Provisioning settings control the label used throughout the system.

The label element is not conditional;that is, a single field cannot show one label to internal candidates and a different label to external candidates. By the same token, a single field cannot show one lable to candidates, and another to recruiting users.

The field-definition element must contain at least one field-label element.

<field-label mime-type="text-plain"><![CDATA[First Name]]></field-label>

mime-type Attribute

<field-label mime-type="text-plain"><![CDATA[First Name]]></field-label>

Mime-type determines whether or not the system renders HTML tags defined in the CDATA content. The two supported mime types are:

● text-plain: Plain text, unformatted. ● text-html: HTML-formatted text.

8.1.3.2 Candidate Profile Field XML Sample

This example is for reference purposes only, and is not a recommended configuration.

<field-definition id="firstName" type="text" required="true" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[First Name]]></field-label>

<field-label mime-type="text-plain" lang="en_US"><![CDATA[First Name]]></field- label>

</field-definition>

<field-definition id="lastName" type="text" required="true" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[Last Name/Surname]]></field-label> <field-label mime-type="text-plain" lang="en_US"><![CDATA[Last Name/Surname]]></ field-label>

</field-definition>

<field-definition id="cellPhone" type="text" required="false" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[Cell Phone]]></field-label>

<field-label mime-type="text-plain" lang="en_US"><![CDATA[Mobile Phone]]></field- label>

</field-definition>

<field-definition id="contactEmail" type="text" required="true" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[Email Address]]></field-label>

<field-label mime-type="text-plain" lang="en_US"><![CDATA[Email Address]]></field- label>

</field-definition>

<field-definition id="primaryEmail" type="text" required="true" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[Username]]></field-label>

<field-label mime-type="text-plain" lang="en_US"><![CDATA[Username]]></field- label>

</field-definition>

<field-definition id="country" type="picklist" required="true" custom="false" anonymize="false">

<field-label mime-type="text-plain"><![CDATA[Country]]></field-label>

<field-label mime-type="text-plain" lang="en_US"><![CDATA[Country]]></field-label> <picklist-id>country</picklist-id>

</field-definition>

In document SuccessFactors Recruiting Management Handbook (Page 119-127)