Configuring the Succession Data Model XML

Objective

After completing this lesson, you will be able to configure the Succession Data Model by using XML when changes are needed

Succession Data Model XML

As valuable as the Business Configuration UI is to configure HRIS elements for Succession and Country Specific Succession Data Models, the use of XML still has some advantages over BCUI. These include: 

  • Using XML makes it easier to make simultaneous changes to a variety of global and country-specific fields, while BCUI will often get an error 
  • Backup versioning is available for every data model upload, while changes in BCUI cannot be undone

Learn to configure the XML attributes in the interaction.  

Succession Data Model XML

Any newly enabled fields in the data models or BCUI must be permissioned using Role Based Permissions for any role to access it. In the sample configuration for ACE, the field  Preferred Name has permission at all levels: View Current, History, Edit/Insert,  Correct, and Delete. 

Exporting the Succession Data Model in the Admin Center

Before you start with any configuration using the Succession Data Model XML, be sure to download the latest XML version. Files can be downloaded directly from the Admin Center. All previous versions can be exported directly from the Export Succession Data Model tool. You can restore the data model to a specific version from the list. The list of versions only stores up to 100 previous versions.

Supplemental Resources for this Lesson

Here are some additional resources you can explore relevant to this lesson (access requires S-ID):

Exercise: Configure the Succession Data Model using XML

Business Example

Ace Corp wants to make changes to the Job Information block. They want to enable and update the label of the Supervisor Level field. They also want to include a custom field to store Additional Job Details. The changes can be made either in the data model or Manage Business Configuration UI. Do not make any changes to hris-element IDs or hris-field IDs.

Note

You must have completed Prepare an Instance (Unit 1) and Prepare the Data Models (Unit 2) exercises before completing this hands-on. This exercise activity is not required for completing succeeding hands-on exercises for this course. It is recommended to carry out the activity in the Succession Data Model as an additional XML practice.

Hint

If you need to create a custom field (string, date, and so on), you can reference the XML examples in the Implementing Employee Central Core guide. If your custom field label does not appear correctly, you can add a line for English US: <label xml:lang="en-US">Additional Job Details </label>.

Steps

  1. Go to Export the Succession Data Model to download the latest configuration and initiate the necessary XML changes.

    1. Go to Export Succession Data Model using Action Search.

    2. Select Export Succession Data Model.

    3. Save the file with your other data models, rename the file to match the other files, and increment the version number on your file.

    4. Open the Succession Data Model in XML editor. (Optional) If you use an XML editor that validates versus a DTD, update row 4 to a value of "sf-form.dtd".

  2. (Optional) If you completed the Manage Succession Data Model with Manage Business Configuration (BCUI) exercise (Unit 5), verify if you can see the attachment-id field in the personInfo element. Changes made in BCUI are synced to the data model and vice versa.

    1. Search for personInfo to locate the hris-element.

    2. Scroll down to locate the hris-field attachment-id.

    3. Verify the field has the label (Biographical Attachment) and is set to editable (visibility = "both").

  3. Go to jobInfo element to enable the Supervisor Level field and update the field label to Management Level.

    1. Go to HRIS ElementjobInfo .

    2. Go to hris-fieldsupervisor-level .

    3. Change the visibility to "both".

    4. Change the label: Supervisor LevelManagement Level.

    5. If necessary, to change the en-US label, go toSupervisor LevelManagement Level.

  4. In jobinfo element, enable custom-string8 field to store the Additional Job Details. It is a common mistake to misplace and inadvertently add the field in another hris-element. Ensure that you are in jobInfo element. Place the custom-string8 AFTER the closing tag of supervisor-level field and BEFORE the opening tag of is-cross-border-worker field.

    Code Snippet
    123
    <hris-field id="custom-string8" visibility="both"> <label>Additional Job Details</label> </hris-field>
    1. Go to HRIS ElementjobInfo . Search for supervisor-level field.

    2. Place the custom-string8 right after the supervisor-level field end tag. Define the field attributes as follows.

      Code Snippet
      123
      <hris-field id="custom-string8" visibility="both"> <label>Additional Job Details</label> </hris-field>
    3. (Optional) Validate your XML if supported by your XML editor.

    4. Save a new version of your data model.

  5. Go to Provisioning to upload the updated version of the Succession Data Model.

    1. Log in to Provisioning.

    2. Go to Succession ManagementImport/Export Data Model .

    3. Browse for the file in the local drive and enter a description/comment for the new version.

    4. Select Submit.

  6. Go to Manage Permission Roles to set the permissions for Management Level and Additional Job Details fields for System Admin role.

    1. Log in to your instance. Go to Manage Permission Roles using Action Search.

    2. Select Edit in the Actions column of System Admin role. Select next.

    3. Search for the Additional Job Details and the Management Level fields in the Employee Central Effective Dated Entities category. Select all permission level for the fields.

    4. Select next and save.

  7. Go to Marcus Hoff's profile to test your configuration.

    1. Log in to your instance.

    2. Go to Marcus HoffEmployment Information .

    3. Ensure that you can see your two changes:

      • Management Level

      • Additional Job Details

Log in to track your progress & complete quizzes