Linking the DTD to the Compensation XML Plan

Objective

After completing this lesson, you will be able to validate a Compensation XML plan with the DTD.

Data Type Definition (DTD)

The Data Type Definition (DTD) can be described as an XML dictionary because it has all of the elements and attribute definitions for SAP SuccessFactors Compensation. In addition to validating XML codes, it is also a resource for finding configuration options.

The DTD used for Compensation is:

Code Snippet
1
sf-form.dtd
In the case of training, a copy of the DTD, sf-form.dtd, is available in the Configuration Files folder for this course. Alternatively, you can also download DTDs from SAP Help Portal under the SAP SuccessFactors Employee Central main page.

SAP SuccessFactors Compensation planning is a form-based application; the form structure is XML-based unlike other SAP SuccessFactors solutions that are Metadata Framework (MDF)-based (for example, Rewards and Recognition). Even though compensation planning is XML-based, the available administration tools allow most configurations to be completed in the admin interface.

However, there are still some configurations that require XML configuration. Knowing how to validate XML templates against the DTD helps in cases where you have to modify the compensation XML plan.

Create a Compensation Plan for a Customer Demonstration

Steps

  1. Clone the pre-configured compensation plan from the training demo instance as your starting point. You can also use the pre-configured plans in the SuccessStore as your baseline template.

    Compensation Home page highlighting how to clone preconfigured plans.

  2. Alternatively, you can also download the XML plan and save to your local drive.

    Compensation Home page showing how to download an XML of the plan locally.

  3. Copy the sf-form.dtd in the same folder where the XML plan is located.

  4. Open the XML plan and the sf-form.dtd file by using any XML editor.

  5. Change the URL found at the top of the XML plan to allow easier validation.

    XML extract displaying a before and after of a URL

  6. Make the configuration changes you want and then select Validate under the XML menu (shortcuts may vary depending on XML editor).

    The Validate icon being highlighted.

    Result

    You should then receive a no errors message or a list of errors in the bottom portion of the XML editor.

  7. Upload the XML plan as a new plan.

    Template Name and Template Filename fields for uploading a XML plan are displayed.

To Link the DTD to the Compensation XML Plan and Validate it with the DTD

To create a new compensation plan for a customer demonstration, proceed as follows:

Steps

  1. Clone the pre-configured compensation plan from the training demo instance as your starting point. You can also use the pre-configured plans in the SuccessStore as your baseline template.

    Compensation Home page highlighting how to clone preconfigured plans.

  2. Alternatively, you can also download the XML plan and save to your local drive.

    Compensation Home page showing how to download an XML of the plan locally.

  3. Copy the sf-form.dtd in the same folder where the XML plan is located.

  4. Open the XML plan and the sf-form.dtd file by using any XML editor.

  5. Change the URL found at the top of the XML plan to allow easier validation.

    XML extract displaying a before and after of a URL

  6. Make the configuration changes you want and then select Validate under the XML menu (shortcuts may vary depending on XML editor).

    The Validate icon being highlighted.

    Result

    You should then receive a no errors message or a list of errors in the bottom portion of the XML editor.

  7. Upload the XML plan as a new plan.

    Template Name and Template Filename fields for uploading a XML plan are displayed.

Summary

  • The Data Type Definition (DTD) functions like an XML dictionary, containing all element and attribute definitions for validating and configuring SAP SuccessFactors Compensation, with sf-form.dtd as the specific DTD used for this purpose.

  • For training and configuration, a copy of the sf-form.dtd is accessible in the course's Configuration Files folder, and additional DTDs can be downloaded from the SAP Help Portal under SAP SuccessFactors Employee Central.

  • SAP SuccessFactors Compensation uses an XML-based form structure for planning, unlike other MDF-based solutions, and while most configurations are manageable via the admin interface, understanding XML validation against the DTD is crucial for modifying compensation plans.

Learning

SAP FacebookSAP YoutubeSAP LinkedIn