SAP Knowledge Base Article - Public

2195717 - SCR Form: XML Software Change Requests for Compensation and Variable Pay Programs - Compensation

Symptom

This article describes which changes can be completed by Cloud Product Support via Software Change Request, and which changes should be completed by Implementation Partners for Compensation and Variable Pay templates.

Important Note to Customers:

  • Software change requests should not be initiated via the Chat Channel. 
  • If a supported XML change request is required, please follow the process outlined below under "To submit a software change request" to create a support ticket and fill out the required information.

Environment

  • SAP SuccessFactors Compensation
  • SAP SuccessFactors Variable Pay

Resolution

What can be done via self-service tools in Admin Center

Additional assistance can also be found via the Community Quick Question Forum (login required).

What is considered an Implementation Request

Custom changes that cannot be completed via SuccessFactors Admin Tools can be delivered by Implementation Partners and Professional Services.

  • Creation of new worksheets
  • Evaluating current programs for design optimization
  • Creation of new system fields, and associated permissions
  • Creation of new system filter fields to be used throughout the program
  • Creation of new workflows and the associated user permissions within forms and programs not supported via admin tools
  • Anything you would like assistance to implement (For eg: adding publish info to the xml)

How to engage an Implementation Partner

  1. Visit our SAP Partners page.
  2. Click the "Search Now" button on "Find a Partner" tile > click the button "Search the SAP Partner Finder".
  3. You can filter the search by solution, industry and location.
  4. From the list, click on the Partner name you want to work with to see contact details for the partner.
  5. Partners can provide quotes and estimates based on your needs.

Please note that each partner may determine the types of services they offer for customers. Pricing can vary between partners. There are a number of partners that are happy to perform the types of changes listed here.

Partners should NOT attempt to change live form XML via any front end or provisioning level tools! Any damage caused to forms are likely irreversible, and may result in loss of data and forms that can no longer be used. Changing live XML code in a production instance may breach SAP policies.

XML Upload via Provisioning

If you made changes in a template XML and now needs to upload it in the system in order to update it, please engage your Implementation Partner or Professional Services to fulfill this task or, alternatively to the XML upload, request instead each supported change individually as per the Software Change Request (SCR) process described below. For more information on this topic please refer to KB Article 3236270 - Requests to upload XML Templates via Provisioning.

Supported XML Changes we can Deliver via Product Support

 Itemized List

Details of Changes Supported Via Cloud Product Support SCR Process

Change Currency Centric Settings

In the Currency Section of the Settings Page under compensation Home, we can already select the functional currency but we cannot set what type of currency centric it is.

XML Section that needs to be updated:

<comp-config showFormRatingAs="number-text" functionalCurrencyCode="USD" baseCurrencyView="functionalCurrencyCentric" statementCurrencyView="localCurrencyCentric" makeCustomDataReportable="false" checkRatingSourceAcrossTemplates="false" autoSyncP4PData="false">

Enable Youcalc Analytics

XML Section that needs to be added/updated:

<comp-youcalc-application appID="261" appDisplayHeight="200" showInExecutiveReview="true">
    <comp-field-label lang="en_US"><![CDATA[Metrics]]></comp-field-label>
</comp-youcalc-application>

Change YouCalc Dashboard ID to template 

XML Section to be added/updated:

<comp-youcalc-application appID="81" appDisplayHeight="400" showInExecutiveReview="true">
    <comp-field-label lang="en_US"><![CDATA[Metrics]]></comp-field-label>
</comp-youcalc-application>

Create/Clone Variable Pay Goal Plan

This would require download of goal plan template via provisioning, updating the goal plan ID to the new value and re-import.No changes will be done to the content of the XML and no direct uploads of XML files will be supported (see KBA 3236270 )

Change merit, lumpSum, lumpSum2 basedOn calculation 

By default the fields merit, lumpSum, lumpSum2 calculations are based on CurrentSalary. Changing the calc basedOn will alter the calculation to the value it is changed to.

Change from:
<lumpsum-calc basedOn="CurrentSalary"></lumpsum-calc>

Change to:
<lumpsum-calc basedOn="LumpSumTarget"></lumpsum-calc>

Add 'personalCompensationStatement' to the Data Model

If the customer doesn't have the option ''Personal Compensation Statement' in the Employee Data in order to provide RBP permissions for manager to look at the target population's statements. As per the KBA 'Cannot Grant Compensation Plan Permissions via Role Based Permissions - personalCompensationStatement' (2084923), the following definition has to be added in the Data Model:

<standard-element id="personalCompensationStatement" max-length="225" required="false" matrix-filter="false">
<label>Personal Compensation Statement</label>
<label xml:lang="en-US">Compensation Statement</label>
</standard-element>

Add standard field as Category in People Pool of Manage Statement Assignment Groups > Group Definition

In reference to KBA 2162679. Change to be made within the Data Model.

Add the standard element under this line:

<element-permission type="read">
<role-name>*</role-name>

Removing a Salary, Stock or Bonus Tab from a compensation Form

This may require removing whole section of the xml of the compensation form

Note: Adding a new section such as a Stock Section or Bonus Section requires professional services as it is a process change

Add CMP embedded template ID to PM template

XML Section to be updated in the PM template:

<compensation-sect index="3">
  <compensation-sect-name><![CDATA[Compensation proposal]]></compensation-sect-name>
    <fm-sect-config>
    <section-color><![CDATA[005BBE]]></section-color>
    <rating-label><![CDATA[Rating]]></rating-label>
    <rating-label-others><![CDATA[Rating]]></rating-label-others>
    <default-rating><![CDATA[unrated]]></default-rating>
    <hidden-strength-threshold>0.0</hidden-strength-threshold>
    <blind-spot-threshold>0.0</blind-spot-threshold>
    <num-decimal-places>2</num-decimal-places>
    <publish-button-label><![CDATA[Publish Content]]></publish-button-label>
  </fm-sect-config>
  <compensation-template-id><![CDATA[285]]></compensation-template-id>
  <compensation-field id="localCurrencyCode" show-if-value-empty="true"></compensation-field>
  <compensation-field id="curSalary" show-if-value-empty="true"></compensation-field>
  <compensation-field id="merit" show-if-value-empty="true"></compensation-field>
  <compensation-field id="finSalary" show-if-value-empty="true"></compensation-field>
  <compensation-field id="lumpSum" show-if-value-empty="true"></compensation-field>
</compensation-sect>

Change labels in the budget box

  • To modify the “Budget” label you will need to change/add the following field.

    <comp-field-definition id="budget" isCustomField="false" isVisible="true" useFor="salary" readOnly="false" hidePercentage="false" hideAmount="false" percentageReadOnly="false" reloadable="true">
    <comp-field-label><![CDATA[ADD THE NEW LABEL]]></comp-field-label>
    </comp-field-definition>

  • To modify the “More to Allocate” label you will need to change/add the following field.

    <comp-field-definition id="moreToAllocate" isCustomField="false" isVisible="true" useFor="salary" readOnly="false" hidePercentage="false" hideAmount="false" percentageReadOnly="false" reloadable="true">
    <comp-field-label><![CDATA[ADD THE NEW LABEL]]></comp-field-label>
    </comp-field-definition>

  • To modify the “Total” label you will need to change/add the following field.

    <comp-field-definition id="budgetPlannedTotal" isCustomField="false" isVisible="true" useFor="salary" readOnly="false" hidePercentage="false" hideAmount="false" percentageReadOnly="false" reloadable="true">
    <comp-field-label><![CDATA[ADD THE NEW LABEL]]></comp-field-label>
    </comp-field-definition>

COMPENSATION: Modify Manager First Name and Last Name labels for Executive Review

This change requires to update three sections in the XML:

First we need to set the fields to "true" in the comp-include:

<comp-include-salary includeSalaryUserNameRight="false" includeEmployeeFirstName="false" includeExecRuleViolation="true" includeEmployeeLastName="false" includeMgrLastName="true" includeMgrFirstName="true" includeSalaryMgrId="false" includeMgrLastNameInForm="false" includeMgrFirstNameInForm="false" includeSalaryUserNamePreData="false" includeJobTitle="false" includeJobLevel="false" includePayGrade="true" includeFinalPayGrade="false" includeFinalPayGuide="false"....

Note that the fields to update are includeMgrLastName and includeMgrFirstName and not includeMgrLastNameInForm and includeMgrFirstNameInForm

Second, we will need to create the comp-field-definition sections for each field (ask the customer what labels must be displayed):

<comp-field-definition id="mgrLastName" isCustomField="false" isVisible="true" useFor="salary" readOnly="false" width="10" hidePercentage="false" hideAmount="false" percentageReadOnly="false" reloadable="true" displayOrder="24">
    <comp-field-label><![CDATA[Manager Last Name]]></comp-field-label>
</comp-field-definition>

<comp-field-definition id="mgrFirstName" isCustomField="false" isVisible="true" useFor="salary" readOnly="false" width="10" hidePercentage="false" hideAmount="false" percentageReadOnly="false" reloadable="true" displayOrder="24">
    <comp-field-label><![CDATA[Manager First Name]]></comp-field-label>
</comp-field-definition>

*note for other Include fields ( i.e. includeSalaryMgrId ) the field ID will always be in Camel case hence salaryMgrId

COMPENSATION: defining API comp-group ID feature

To enable compatibility with SFAPI, the following code must be added to the template XML:

<comp-group id="some value"> where "some value" is the group ID for the template.

For more details, please see KBA 2085185 - Using SFAPI and defining API comp-group ID feature

VARIABLE PAY: Show Manager First Name and Last Name in Executive Review

To show the columns 'Manager First Name' and 'Manager Last Name' in Variable Pay Executive Review the below tags must be set to TRUE.

          <show-mgr-first-name><![CDATA[false]]></show-mgr-first-name>
          <show-mgr-last-name><![CDATA[false]]></show-mgr-last-name>

Note that the default configuration is that it is set to FALSE.

VARIABLE PAY: Enable Bulk Print of Variable Pay Statements

The following code needs to be added to the variable pay template XML:

         includeVarpayStatement="true" under <comp-config> tag

For more details on enabling Bulk Printing, see KBA 2078691 - Bulk Printing Varible Pay Statements - Variable Pay

Notes:

  • SAP Cloud Product Support doesn't make new changes in XML  i.e. doesn't add new XML code at the backend.
  • This service is available only to Enterprise customers and their designated primary administrators.
  • It is not available to Professional Edition customers.
  • It is not available to Partners.
  • The change process does not cover changes you can make via Admin Tools.
  • It is limited to 1-2 changes and to 1 template per request, to avoid any confusion and to be better to assist you.
  • We don't support adding of new publish related information. 
  • Cloud Product Support can take up to 4 weeks to process change requests. Please submit your changes at least 4 weeks in advance.

How to request a change from Cloud Product Support?

If the change you want to apply is listed in the table above, you can submit an case in the Support Portal requesting it. Please use the below template:

SCR Template: (Just copy and paste this into your case)

  1. Data Center (URL of your login screen):
  2. Company Instance ID (where to apply changes):
  3. Name of the Template Changes Will be Applied to:
  4. Testing Usernames we will use to test change:
  5. Itemized Change (from list below, which item needs to be changed):
  6. Other Comments: 

Testing of Software Changes

Upon completion of the requested configuration changes, we require that you thoroughly test to ensure that the content has been coded to specifications and all functionality behaves accordingly and to expectations including all the way to printing and reporting if applicable. Only you the customer will ever know if something is wrong, as what is right for 1 customer can be wrong for another. Every option we have is right for someone, and is why we simply would not know what was "right or wrong" for you. Only you the customer can determine that for your program. If you feel you need consultant level assistance then consider a paid engagement with our Solution Consultants via our Partners.

See Also

  • SAP Partner Finder
  • KB article 2149831 - SAP Professional Services / SAP Certified Partner / SAP Account Management Team [SuccessFactors Cloud]
  • KB article 2706322 - What is Support – What is Consulting: Cloud Solutions
  • KB Article 3236270 - Requests to upload XML Templates via Provisioning

Keywords

SF, Success Factors, SuccessFactors, Compensation, Variable Pay, CMP, CCOR, Configuration, Change, XML, software, request, compensation, variable, pay, admin center, admin tools, partner, partners , KBA , LOD-SF-CMP-SCR , Software Changes, Services, Provisioning etc. , LOD-SF-CMP-ADM , Admin Tools, Settings, Permissions , How To

Product

SAP SuccessFactors Compensation all versions