SAP Knowledge Base Article - Public

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

Symptom

  • I need to make changes to my program, how do I engage a Partner or Solutions Consultant?
  • What changes does Cloud Product Support still do for free?
  • List of the supported XML configuration changes that support can deliver for customers.

Environment

  • SuccessFactors Compensation Management
  • SuccessFactors Variable Pay

Resolution

Solution Consultants and Partners

In general all custom changes that you cannot complete yourself via Admin Tools, can be delivered via our Solution Consultants and our Partner network.

  • 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 with to implement

Please reach out to our Partners today to engage with an expert.

How to use the SAP Partner Finder:

  1. Select your country
  2. Select your desired partner type based on your requirements
  3. Select your required solution area and specific SAP Authorization to show partners who are authorized for that solution. To show partners with SAP Recognized Expertise for a solution, tick the box in this section.
  4. Select your chosen industry (optional). To show partners with SAP Recognized Expertise in a specific industry, tick the box in this section.
  5. Click the Search button

What Can We Change Ourselves?

  • Changes to data, people, settings, reports:

 

Supported XML Changes we can Deliver via Product Support

Supported changes are typically characterized as "existing program maintenance" that are..

  1. a necessary change to keep the existing program working as-is
  2. small year-over-year change not possible via admin tools
  3. adding functionality driven by SAP’s quarterly releases not possible via admin tools, and required by SAP. 
  4. The options below apply to new worksheets only, and not for forms you have already launched. We do not support xml/code changes to live worksheets (forms already launched), ...but we do support many data & setting changes in live compensation programs. Details here

    • This xml change 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.
    • These changes apply to existing programs created by partners or PS that were working as needed except for the need to make a small change.
    • As your request will be added to our existing backlog of requests, please allow Cloud Product Support up to 4 weeks to process your changes. 

To submit your software change request please:

  • copy the template details below into your case and provide us the details.
  • Then add the actual change you need that is in our approved list of changes. 
  • Ensure the items you will be requesting are in the list below.

SCR Template:

  • (Just copy & 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 where 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. Additional/Other Comments:
  • Support Admin Access is needed please note it in the incident's Secure Area.

 

 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. We cannot also specify what currency views we want to see.

                     XML Section that needs to be updated:

                       <comp-config showFormRatingAs="text" functionalCurrencyCode="USD" baseCurrencyView="localCurrencyCentric"

                       <comp-currency-view includeFunctionalCurrency="true" includePlannerCurrency="false" includeEmployeeLocalCurrency="true" />

Change the Number formats in Compensation forms

This would only be for Compensation as Variable pay already has this feature in admin tools. Jira CMP-9637 is arleady created as an enhancement Request

                    XML Section that needs to be updated depending on specific format

                        <comp-number-format-ext id="defMoneyFormat" mode="truncate" useFor="money">

                        <comp-number-format-ext-format><![CDATA[#,##0]]></comp-number-format-ext-format>

                        </comp-number-format-ext>

                        <comp-number-format-ext id="defPercentFormat" mode="round" useFor="percent">

                        <comp-number-format-ext-format><![CDATA[#,##0.00]]></comp-number-format-ext-format>

Change Currency Centric Settings

XML Section that needs to be updated:

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

Fix Rounding issues and Default Formats 

 XML Section that needs to be updated:

      <comp-number-format-ext id="defMoneyFormat" mode="round" useFor="money">
        <comp-number-format-ext-format><![CDATA[#,##0.00]]></comp-number-format-ext-format>
      </comp-number-format-ext>
      <comp-number-format-ext id="defPercentFormat" mode="truncate" useFor="percent">
        <comp-number-format-ext-format><![CDATA[#,##0.000]]></comp-number-format-ext-format>
      </comp-number-format-ext>
      <comp-number-format-ext id="defAmountFormat" mode="round" useFor="amount">
        <comp-number-format-ext-format><![CDATA[#,##0]]></comp-number-format-ext-format>
      </comp-number-format-ext>
      <comp-number-format-ext id="defRatingFormat" mode="truncate" useFor="rating">
        <comp-number-format-ext-format><![CDATA[0.##]]></comp-number-format-ext-format>
      </comp-number-format-ext>
      <comp-number-format-ext id="defRatioValueFormat" useFor="ratio-value">
        <comp-number-format-ext-format><![CDATA[#,##0.0#]]></comp-number-format-ext-format>
      </comp-number-format-ext>
      <comp-number-format-ext id="defProrationFormat" useFor="proration">
        <comp-number-format-ext-format><![CDATA[#,##0.##]]></comp-number-format-ext-format>
      </comp-number-format-ext>

Change Rating as label to number-label

 XML Section to be updated:

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

 

From b1611 onwards customers will be able to perform this change through Admin Centre > Compensation > Actions for All Plans > Company Settings

Add Remove Totals Row

 XML Section to be updated:

<comp-include includeTotal="false" includeBudget="false">

Enable Youcalc Analytics

There is CMP-8703 enhancement request already created to have this added as admin tools

                    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>

Update Date Prorating Ranges or EC Effective Date

XML Section that needs to be updated

                       <date-proration-calc reviewStartDate="2013-01-01" reviewEndDate="2013-12-31" canExceedReviewPeriod="false">

Enable or Disable Force comment

 XML Section to be added/removed/updated:

<comp-force-comment-config useFor="salary" mode="guideline" fieldId="merit"/>

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.

Moving Compensation forms from Test to Production

 Note: This does not apply to Variable Pay forms as the best practice is always to create the variable pay program from within Compensation Home in Admin tools.

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>

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

Correct column misalignment in Variable Pay

XML Section to be updated:

        <varpay-ajax>
          <budget-ajax enabled="false" />
          <group-total-ajax enabled="false" />
        </varpay-ajax>

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>

Increase/Reduce number of users displayed per page

XML Section to be updated:

<comp-page-size>10</comp-page-size>

Change labels in the budget box

 In the Old UI:

The change is done at T3 Language Pack Level.

In the New UI:

 - 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

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.

 

 

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.

 

 

Keywords

  • CCOR
  • Configuration Change
  • XML change
, KBA , LOD-SF-CMP-SCR , Software Changes, Services, Provisioning etc. , LOD-SF-CMP-ADM , Admin Tools, Settings, Permissions , Problem

Product

SAP SuccessFactors HXM Core all versions