Configuring Succession Data Model

Objective

After completing this lesson, you will be able to configure a background element and custom filters.

Configuration of Background Elements

These elements are where a one-to-many relationship exists between the field and the data it can store. There are two kinds of background elements: those consisting of data fields and those with rating fields. Some examples of background data elements are Education and Work Experience.

Rating fields can be the ones from the Performance Management module or can be imported, or can also be those entered in the People Profile. The kind of rating depends on the field used and its configuration.

The background element contains an ID which must be unique. This ID is used in the export and import live profile background and rating files.

Any ID that begins with sys means that this section is a special system section and it has certain restrictions when modifying it. You cannot remove or comment out data-fields or rating-fields from a sys section. If a field is removed, set the hidden attribute to true for the data fields and the visibility attribute to none for the rating fields.

Background Element Definition

AttributeDescription
type-idA unique Type ID for each background element, which has to be an integer. It is required; there’s no default value.
idA unique ID for each element. The global name for this section is a string field. It has no default value.
max-entriesThe attribute defines the maximum number of rows that could be added from the UI. This limit does not apply when importing data items.
scaleIdFeedbackTypeOnly applicable for Trend Elements (sysOverall). The supported types are:
  • Competency (5)
  • Objective (6)
  • Potential (7)
  • Performance (8)
  • Custom1 (27)
  • Custom2 (28)

Background Element - Data Field Attributes

Attribute XMLOption in BCUIDefinition
idId

The ID must be unique for each background element data field. This name is the name used in the templates and is a required field.

 EnabledTo enable the field. Possible values include Yes and No. This option is only visible in Manage Business Configuration.
requiredRequiredForce the user to input information for that field. Possible values are true or false (default is false if not configured)
hiddenHiddenValue is true or false. Same effect as visibility="none". The value "false" is the default if not configured
url-linkURL LinkValue is true or false. Mostly used with Google Docs.The value "false" is the default if not configured
field-nameField NameThis field is the database field name to use. Available values* are:
  • VFLD1-VFLD20 (text/varchart fields)
  • IFLD1-IFLD8 (integer fields)
  • FFLD1-FFLD8 (real number/float fields)
  • DFLD1-DFLD4 (date fields)
  • START
  • ATTACHMENT_ID
  • DESC
  • END
  • LASTMODIFIED
  • NAME
  • ORDERPOS
  • USERS_SYS_ID
max-lengthMax. LengthThe maximum number of characters that can be entered.
display-sizeDisplay SizeNot used
piiMaskedNot supported currently
document-type-idDocument Type IdAttachment field attribute to identify the classification. The following types are supported:

RESUME | COVERLETTER | HRIS_ATTACHMENT | PERFORMANCE_ASSESSMENTS | 360_MULTI_RATER_ASSESSMENTS | CERTIFICATIONS | PUBLICATIONS | USER_DEFINED | HISTORY | ATTACHMENTS | APPLICATION_INTERVIEW_ATTACHMENTS

max-file-size-KBMax. File Size KBWith this attribute, you can define the maximum size file that can be uploaded. The size must be smaller than the size specified by Attachment max file size set in Company System and Logo Settings or Provisioning.
file-formatsFile FormatsDetermines what file extension is allowed. For example, if only a PDF file is allowed, the value is pdf. Multiple formats can be set using the pipe separator (|). The following file formats are supported:

doc | pdf | csv | htm | ppt | xls | gif | png | jpg | jpeg | html | rtf | bmp | xlsx | docx | pptx | txt | xml | msg | docm | tif | eml

text-area-enabledText Area EnabledWith this attribute set to true, the input area becomes a text area that support multiple lines.
logreadaccessLog Read AccessThis field attribute can be set to true if it must be configured as read audit field. Default value is false if not configured.
labelLabelThis label is the label that displays in the UI for the end users. It allows you to add translations from BCUI or in XML by using the xml:lang attribute.
picklist id=PicklistThe field formats text/varchart (VFLD) allow you to associate to a picklist to select from dropdown values rather than adding an input text.
parent-field-idParent Picklist IdCascading picklists are also possible when adding the parent-field-id in the picklist configuration.

*The following field-name are supported in XML: name | desc | vfld1 | vfld2 | vfld3 | vfld4 | vfld5 | vfld6 | vfld7 | vfld8 | vfld9 | vfld10 | vfld11 | vfld12 | vfld13 | vfld14 | vfld15 | startDate | endDate | dfld1 | dfld2 | dfld3 | ifld1 | ifld2 | ifld3 | ifld4 | ifld5 | ffld1 | ffld2 | ffld3 | ffld4 | lastModified | attachment1

Attachment Field and Text Area Field

In the following figure, see an example of xml code for a background that contains an attachment and a text area field.

An XML code snippet that defines a background-element with attributes for documents and type.

As an end user, you can add the attachment by selecting the paper clip icon.

Documents for Certificate section that allows the user to manage documents related to completion of trainings.

A Cascading Picklist in a Background Element

Background elements can contain fields linked to a picklist. Cascading picklists are also possible when adding the parent-field-id in the picklist configuration. See an example of xml code with a cascading picklist in the following figures. The XML code is continuous, although it is presented in separate figures here for easier reading:

XML structure that defines various elements and attributes related to language skills and competencies.
XML structure that defines various elements and attributes related to language proficiency, including Speaking Proficiency, Reading Proficiency, and Writing Proficiency.

In this following example, the connection between the picklists variant and language also exists at the picklist level by adding the parent picklist code from the language picklist in the corresponding child value in the picklist variant.

For managing an employee's language skills it includes fields for the language, language variant, speaking proficiency, reading proficiency, and writing proficiency.

Background Elements with Rating Fields

These background elements are rating sections.

The feedback-type attribute is a unique integer that specifies the source of feedback for the section:

  • 5: Overall Competency Rating

  • 6: Overall Objective Rating

  • 7: Overall Potential Rating

  • 8: Overall Performance Rating

  • 27: Custom1

  • 28: Custom2

The XML code is continuous, although it is presented in separate figures here for easier reading:

XML structure that defines various elements and attributes related to an Overall Competency for an employee.
XML structure that defines various elements and attributes related to an employee's information, including their name, description, and a rating field.
XML structure that defines various elements and attributes related to a rating or labeling system for employees.
XML structure that defines various elements and attributes related to a rating or labeling system for employees.
For managing an employee's overall competency it includes fields for the start date, end date, and a label for the competency level.

Configure the Succession Data Model

Your customer has some requirements that should be implemented to the Employee Data structure. You will complete the following changes:

  • Add a new standard element to store Company/Legal Entity.
  • Add background elements to include employee details about their internal and external work experience, as well as their geographic mobility.

Steps

  1. Enable the Full Profile of the Latest People Profile in your instance.

    1. Navigate to Company System and Logo Settings using Action Search.

    2. Select Enable Full Profile for the latest people profile.

    3. Scroll down to the bottom of the page, and select Save Company System Setting.

  2. Export Succession Data Model from the instance.

    1. Log into your instance and navigate to Export Succession Data Model by using action search.

    2. Select the Export Succession Data Model button.

      The latest version of the Succession Data Model will be downloaded to your local computer. It will show as [COMPANY ID]-data-model.xml.

  3. Add the standard element company in the Succession Data Model.

    1. Open the XML file downloaded previously with an XML Editor of your choice.

    2. Change the line 4 of the data model to confirm with the sf-form.dtd file to ensure validation (the DTD is in the same folder as your XML template). Replace the following: "http://svn/viewvc/svn/V4/trunk/src/com/sf/dtd/sf-form.dtd?view=co"> with "sf-form.dtd">.

    3. Navigate to the standard-element area, and verify that company is not available.

    4. At the end of the standard-element section, but before the next one, add the following code that corresponds to the Company:

      Code Snippet
      1234
      <standard-element id="company" max-length="255" required="false" matrix-filter="false"> <label>Company</label> </standard-element>
    5. Add the new company field reference in the Employee Profile template. Scroll down to the view-template area, and expand the view-template "employeeProfile" to access the edit-template subsection.

    6. On the list of standard elements, add the following code before thedivision reference.

      Code Snippet
      1
      <standard-element-ref refid="company"/>
    7. Repeat the step to add this same code on the following area: view-template id="sysUserDirectorySetting, expand edit-template subsection, and include the reference to company.

  4. Add the background elements insideWorkExperience, outsideWorkExperience, and mobility into your Succession Data Model.

    1. Navigate to the background-element area, and verify that the background elements do not exist already in the Succession Data Model.

    2. At the end of the background-element section, but before the next one, add the following code that corresponds to the Work Experience Within Company:

      Code Snippet
      12345678910111213141516
      <background-element id="insideWorkExperience" type-id="1"> <label>Work Experience Within Company</label> <data-field id="startDate" field-name="startDate" required="true" max-length="999" max-file-size-KB="1000"> <label>Start Date</label> </data-field> <data-field id="endDate" field-name="endDate" max-length="999" max-file-size-KB="1000"> <label>End Date</label> </data-field> <data-field id="title" field-name="vfld1" required="true" max-length="4000" max-file-size-KB="1000"> <label>Title</label> </data-field> <data-field id="department" field-name="vfld2" max-length="4000" max-file-size-KB="1000"> <label>Department</label> </data-field> </background-element>
    3. Below the Work Experience Within Company, add the following code that corresponds to the Previous Employment:

      Code Snippet
      1234567891011121314151617181920
      <background-element id="outsideWorkExperience" type-id="4"> <label>Previous Employment</label> <data-field id="startDate" field-name="startDate" required="true" max-length="999" max-file-size-KB="1000"> <label>Start Date</label> </data-field> <data-field id="endDate" field-name="endDate" required="true" max-length="999" max-file-size-KB="1000"> <label>End Date</label> </data-field> <data-field id="employer" field-name="vfld1" required="true" max-length="4000" max-file-size-KB="1000"> <label>Company Name</label> </data-field> <data-field id="businessType" field-name="vfld2" max-length="4000" max-file-size-KB="1000"> <label>Type of Business</label> <picklist id="industry"/> </data-field> <data-field id="startTitle" field-name="vfld3" required="true" max-length="4000" max-file-size-KB="1000"> <label>Title</label> </data-field> </background-element>
    4. Below the Previous Employment, add the following code that corresponds to the Geographic Mobility:

      Code Snippet
      1234567891011
      <background-element id="mobility" type-id="15"> <label>Geographic Mobility</label> <data-field id="willingness" field-name="vfld1" required="true" max-length="4000" max-file-size-KB="1000"> <label>Willing to Relocate</label> <picklist id="yesnomaybe"/> </data-field> <data-field id="location" field-name="vfld2" max-length="4000" max-file-size-KB="1000"> <label>Location Desired</label> </data-field> </background-element>
    5. Validate, and then save as a new version, such as [COMPANYID]-data-model_v1.xml.

      Caution

      You may see some validation errors Attribute "id" with value "company" must have a value from the list, you can ignore it. The import via Provisioning should still be successful.
  5. Import the Succession Data Model into your instance.

    1. Navigate to ProvisioningSuccession ManagementImport/Export Data Model.

      The radio button Import File: is already selected by default.

    2. Select Choose File and locate the [COMPANYID]-data-model_v1.xml that you saved in the previous step.

    3. In the comment box, add the following Background Elements import.

    4. Choose Submit.

      A confirmation message appears that the template was successfully imported.

  6. Grant permissions to edit the new Standard and Background Elements from Role-Based Permissions.

    1. Log in to the instance and navigate to Manage Permission Roles by using action search.

    2. Locate the All Employees role, and then select Edit from the Actions column.

    3. Select Next to navigate to step 2. Add Permissions.

    4. In User Permissions, locate and select the Employee Data section that controls the access to Background Elements.

    5. On the Employee Profile section, locate the Company field and select Edit.

    6. Scroll down to the Background section, and ensure that the following elements are visible:

      • Work Experience Within Company
      • Previous Experience
      • Geographical Mobility
    7. Grant Edit permissions for all three elements.

    8. Select Next to navigate to the step 3. Preview.

    9. Choose Save.

    10. Log out and log back into your instance to reflect the permission changes.

  7. Add the Standard and Background Elements in People Profile.

    1. Navigate to Configure Latest People Profile using action search.

    2. Select the Personal Data section. Notice there is an Employee Information card.

    3. Choose Add Card to create a new one.

    4. On the Object Type, select User Information. Choose Apply to continue.

    5. On the Card Title, type Organizational Details.

    6. Scroll down to the Content Configuration and select Add to include the following standard elements:

      • Company
      • Division
      • Department
      • Location
    7. Choose Save to save your changes.

    8. Repeat the steps to add a Custom Card for each of the background elements. You will be selecting Object Type as Custom Background ElementSave every time to save the changes.

      Custom Background Element Cards

      DetailsBlock 1Block 2Block 3
      Card TitleInternal ExperienceExternal ExperienceGeographical Mobility
      Element NameWork Experience Within CompanyPrevious EmploymentGeographical Mobility
      Primary FieldTitleCompany NameWilling to Relocate
      Secondary FieldDepartmentType of BusinessLocation Desired
      Additional FieldEnd DateTitle 
    9. Verify your changes by navigating to HomeMy Employee File and review section where you placed these cards.

      The image shows the final results with the custom cards displayed.

    Note

    You will be importing some data for these background elements in a later exercise for some of the employees.

Custom Fields and Filtering

SAP SuccessFactors supports custom fields and filtering. Customers can add up to 15 standard-elements (with field ids custom01 to custom15) to use across different searching tools within the SAP SuccessFactors HCM solution in addition to the standard filters, Department, Division, Location, and Username. When custom filters are set up, these elements can be used for reporting purposes or for performing administrative functions, such as generating forms. For example, a custom field like Region, can be used in Reporting Dashboards to further filter information.

More information can be found in the SAP Help Portal: Adding Custom Filters in Succession Data Model

The Custom Filters XML Element

HTML code that defines two background elements with labels Successor Portlet and Development Objectives Portlet.

To enable filtering based on custom fields, you must add the <custom-filters> element to the XML data model.

This element is not included in the system default data model of the training instance, so the code must be added manually as follows:

  1. Since this new <custom-filters> element must be added after the last background-element and before the first element-permission, locate the position to add the custom filter file.
  2. Add in the custom filter element with the appropriate standard element references. In the preceding figure, you can see that a filter for custom field 01 is added.
  3. Save a new version and upload the updated data model to Provisioning.

Create a Custom Background with an Attachment and a Text Area

Business Example

Your organization needs a custom card in the profile to allow the employees to upload their resumes. This card must contain an attachment field and a text area field. In this case, you will use the Manage Business Configuration UI (BCUI) tool to create this custom Background Element, as an alternative to the Succession Data Model XML.

Steps

  1. Create a new Background Element to store resumes by using the BCUI tool.

    1. Navigate to Manage Business Configuration by using action search.

    2. In the Employee Profile section, locate the Background Elements subsection, and expand it to display all the available elements.

    3. Select the Create New option, located at the end.

    4. Add the following details:

      • Id: resumes.
      • Type Id: 40.
      • Label: Resumes.
      • Enabled: Yes.
    5. Select Submit.

    6. Choose Save.

  2. Add the following Data Fields to your Background Element: Resume Name, Attachment (allowing .doc, .docx and .pdf as the possible file formats), and Comments.

    1. Select Take ActionMake Correction to add the first Data Field.

    2. Add the following details:

      • Id: resumeName.
      • Enabled: Yes.
    3. Select Details and add the following parameters:

      • Field Name: VFLD1.
      • Label: Resume Name.
    4. Select Done.

    5. Add the next Data Field for Attachments:

      • Id: attachment.
      • Enabled: Yes.
    6. Select Details and add the following parameters:

      • Field Name: ATTACHMENT_ID.
      • Document Type Id: ATTACHMENTS.
      • Max. File Size KB: 3000.
      • File Formats: doc | docx | pdf.
      • Label: Attachment.
    7. Select Done.

    8. Add the next Data Field for Comments:

      • Id: comments.
      • Enabled: Yes.
    9. Select Details and add the following parameters:

      • Field Name: VFLD2.
      • Text Area Enabled: Yes.
      • Label: Comments.
      • Max Length: 1000.
    10. Select Done.

    11. Select Save. A confirmation dialog displays for some default values that will be automatically set for your Data Fields. Select Confirm.

  3. Grant permissions to edit the new Background Element from Role-Based Permissions.

    1. Log in to the instance and navigate to Manage Permission Roles by using action search.

    2. Locate the All Employees role and select Edit from the Actions column.

    3. Select Next to navigate to step 2. Add Permissions.

    4. In User Permissions, locate and select the Employee Data section, which controls the access to Background Elements.

    5. Scroll down to the Background section, and ensure that the Resumes element is visible.

    6. Grant Edit permission.

    7. Select Next to navigate to step 3. Preview.

    8. Choose Save.

    9. Log out and log back into your instance to reflect the permission changes.

  4. Add the Background Element in People Profile.

    1. Navigate to Configure Latest People Profile using action search.

    2. Select the Personal Data section, where you included the Custom Cards for the other elements in a previous exercise.

    3. Choose Add Card to create a new one.

    4. On the Object Type, select Custom Background Element. Choose Apply to continue.

    5. On the Card Title, type Resumes.

    6. Add the following details:

    Resumes

    DetailsCard 1
    Element NameResumes
    Primary FieldResume Name
    Secondary FieldAttachments
    Additional FieldComments
  5. Test your changes from the profile.

    1. Verify your changes, navigating to HomeMy Employee File, and review the section where you placed the custom card.

    2. Verify that you have three columns:

      (i) Resume Name – Text Field

      (ii) Attachment with a paper clip icon

      Comments – Text Area Field

    3. Try adding an attachment with an unsupported file format, like an image (.jpg or .png), and choose Upload.

    4. Verify you see an error message, for example: The file type of Image.jpg is not in the supported list doc, docx, or pdf.

    5. Select OK and cancel the action entirely.

Import Standard and Background Information Data

In the following exercise, you will be importing employee data for a set of users, to populate details on the Custom Cards you have included in the People Profile and test the results.

Prerequisites

A knowledge of the import tools and process is required. If you need to refresh on this concept, you can check the learning journey SAP SuccessFactors Platform Introduction Academy

Steps

  1. Import Company values for the Employees in the organization

    Note

    When customers have Employee Central enabled, the Company/Legal Entity is coming from the hris-field which would be assigned when employee is hired. In this example, we will add this organizational data on the standard-element, following the non-EC scenario. More information about the Employee Central scenario is explained in the following learning journey

    Configuring SAP SuccessFactors Employee Central Core

    1. Navigate to Employee Export using Action Search.

    2. Select the option Export User File.

    3. Open the ZIP file and extract it in your local computer.

    4. Open the User Directory CSV file with your editor.

    5. Notice the column K for COMPANY is empty.

    6. Review the locations for each employee on the column N, and based on the location, set the following values on the COMPANY column:

      • Employees located in USA (several locations): GlobalTech USA
      • Employees located in Paris: GlobalTech France
      • Employees located in Shanghai: GlobalTech China
      • Employees located in London: GlobalTech UK
      • Employees located in Walldorf: GlobalTech Germany
      • Employees located in Manila: GlobalTech Philippines
    7. Save the CSV file as a new version.

    8. Navigate to Employee Import using Action Search.

    9. On the Choose File, select your updated CSV file.

    10. Select Validate Import File. If no errors are found, select again your file and choose Import User File.

    11. Navigate to an employee profile and verify the Organizational Details now display the Company value.

  2. Import Background Information for Employees in the Leadership and Marketing Departments.

    1. Open your User Data File and filter by DEPARTMENT, to display only employees in the Marketing and Leadership departments.

    2. Keep this file open and navigate to the instance to the Import Extended User Information tool.

    3. Select Background Information on the type of information to import, and choose Download Data Import File Template.

    4. Open the CSV template. Remove the rows for the elements not needed, and leave only these ones insideWorkExperience, outsideWorkExperience, mobility.

    5. Add rows below each of these elements to add the data. 5 rows for each one should be enough, to import data for 5 employees of your choice.

      Example on how to add rows to include the employee data to import.
    6. Select 5 employees of your choice to import data (copy the User IDs and paste them in column A in the import file.

    7. Fill in information to import. You can use this example:

      Caution

      Some of the fields, like businessType, is associated to a picklist. Make sure to use any of the possible picklist options and nothing else, otherwise you will get an error when validating the import file in Import Extended User Information.
      An example on how the data needs to be filled in the Import File.
    8. Save as a new version.

    9. Navigate to Import Extended User Information using Action Search.

    10. Choose File: Select your updated CSV file.

    11. Select Background Information as the type of information to import, if not already selected.

    12. Select Import by incrementally adding data.

    13. Select Import Extended User Data File.

    14. On the confirmation dialog, select the checkbox to confirm you have backed up all existing records. For the purpose of this exercise, you can continue without backing up the data, since there is no existing background information for these employees.

      Caution

      In a real scenario, you should ALWAYS back up your data before doing any imports on the Extended User Information.
    15. Select Import to confirm.

    16. Verify your results, navigating to one of the employee's profiles. The example below shows how Alex Anderson has now information displayed on the new Custom Cards created.

      The imported data shows as expected for one of the employees.

Summary

Some of the key takeaways of this lesson are:

  • The configuration of the Succession Data Model can be done from an XML editor or using the Manage Business Configuration tool.
  • Some of the background elements in Succession Data Model can include rating fields. Other capabilities include the option to add attachment fields or picklists, that can be cascaded on a parent-child relationship.