SAP Knowledge Base Article - Public

2085335 - Worksheet Design - Require Comments for Forms - Compensation

Symptom

  • This Article reviews how to require comments for forms.
  • How do I force a person to add a comment to explain an amount?
  • What fields can I apply the Force Comment feature to?
  • What conditions invoke the forced comments box to show?
  • What is <comp-force-comment-config>?
  • What is the red or blue comment bubble on the comp form for?

Environment

Successfactors Compensation

Resolution

  • Form: You now have the option to require comments in these situations: 1) When an employee is given a raise that is outside the guidelines; 2) when an employee is not given a salary raise at all; or 3) anytime an employee is given a raise. When you use this option and one of these situations occurs, an asterisk is added to the Comment area to show that a Comment is now required. To use this option, contact SuccessFactors Customer Success to have your form template updated. (CMP-3042)

Configure force comment feature

  1. This feature is enabled by adding a new configuration item into compensation template.
  2. This feature can be configured for the following fields:
    1. On salary tab, merit, promotion, extra, extra2, lumpSum and lumpSum2 fields can be configured.
    2. On stock tab, stock, options, stockUnits, stockOther1, stockOther2 and stockOther3 fields can be configured.
  3. This feature can be configured for the following modes:
    1. An employee is not given a raise. That means managers did not input any value in one of the fields configured with force comment.
    2. An employee is given a raise. That means managers inputted a value in one of the fields configured with force comment.
    3. An employee is given a raise violated guidelines. That means managers inputted a value violated guidelines in one of the fields configured with force comment.
  4. Each field can be configured with only one mode.
  5. Validate whether the configuration is correct when users upload a compensation template with force comment feature enabled.
    1. All fields configured with force comment feature should be included in compensation template.
    2. Configured fields can only be merit, promotion, extra, extra2, lumpSum and lumpSum2 for salary tab and stock, options, stockUnits, stockOther1, stockOther2 and stockOther3 for stock tab.
    3. All fields configured with force comment feature and mode is given a raise violated guidelines, they should also be applied guidelines.

 

Input/view force comment

  1. Managers can input comment for each field configured with force comment.
  2. Managers can view all force comments inputted before by themselves or other managers. They can't modify those comments.
  3. Managers can only view all force comments inputted before by themselves or others if compensation form is in en route folder. They can't input force comment.

 

Validate whether managers inputted force comment

  1. When managers send compensation form to the next step, validate whether they have inputted force comments for all fields configured with force comment feature and one of the following conditions is met.
    1. Managers did not input any value in one of the fields configured with force comment feature and mode is not given a raise.
    2. Managers inputted a value in one of the fields configured with force comment feature and mode is given a raise.
    3. Managers inputted a value violated guidelines in one of the fields configured with force comment feature and mode is given a raise violated guidelines.
  2. Prompt managers to input force comments for those fields they should input that. Do not allow managers to send compensation form to the next step before force comments are inputted.

 

Comment Icon

We display a comment icon besides specific fields for which force comment is enabled.

 

When compensation form is initialized, we display a red icon besides those fields with the following conditions met and do not have comments.

  • The mode is guideline and this field has a value violated guideline.
  • The mode is given a raise and this field has a value.
  • The mode is not given a raise and this field has no value.

We display red icon besides those fields that have no comment and do not meet the above conditions. We need to display blue icon besides those fields that have comments.

We display a tool tip for comment icon when mouse cursor is over the comment icon like the following. The tip is last comment user inputted when this field has comments. If it is not, the tip is "Click to add comment".

 

Security

  • Security to permission who can see, edit and delete comments will be available only in clients on b1411.

 

Reporting on Comments

  • Currently Ad Hoc Reports cannot report the comment field. They are however tracked in the db as described below, and therefore will be stored as part of our Audit Capabilities. If you have the latest compensation audit features enabled then a person with that permission could report on comments, comment changes, and deleted comments from the comp audit report.
  • Only Aggregate Report can export comments today. See article 2084829 - Reports - Aggregate Export Report - Compensation
  • There is already an enhancement request filed for this - ability to report comments. Kindly vote for it here so it can be considered as a possible future enhancement to the product by the Product Management Team. 

 Information for Partners & Support

A Force Comment field has the following db attributes.

Column

Description

comp_comment_id

This column is the ID of force comment. Its value comes from sequence COMP_COMMENT_ID_SEQ.

comp_entry_id

This column is the entry ID force comment belongs to. It is a foreign key referencing table COMP_ENTRY.

comp_comment_type

This column represents which tab of compensation form force comment belongs to. The value comes from constants - NOTES_TYPE_SALARY and NOTES_TYPE_STOCK in CompPlanEntryBean class.

comp_comment_field

This column is the field ID force comment belongs to. The value comes from defined field IDs in CompFieldDefBean class.

comp_comment_comment

This column is the content of force comment.

created_date

This column is the date when force comment was created.

created_by

This column is the user ID who created force comment.

last_modified

This column is the date when force comment was last modified. Currently, it is the same as created_date.

Last_modified_by

This column is the user ID who last modified force comment. Currently, it is the same as created_by.

 Note: To modify force comments on fields please raise an incident with Support (CMP-7828 and VRP-6197)

By updating the xml, the user will be able to enable the template to add a customized message for Force comment warning.

The following XML will be used

<comp-force-comment-config useFor, mode, fieldId>
<comp-warning-message><![CDATA[
Custom Message]]></comp-warning-message>
</comp-force-comment-config>

Example:

1. <comp-force-comment-config useFor="salary" mode="guideline" fieldId="extra">
<comp-warning-message><![CDATA[Please provide comment to justify Additional Adjustment against guideline.]]></comp-warning-message>
</comp-force-comment-config>

2. <comp-force-comment-config useFor="salary" mode="raise" fieldId="extra2">
<comp-warning-message><![CDATA[Please provide comment to justify Additional Adjustment against guideline.]]></comp-warning-message>
</comp-force-comment-config>

3. <comp-force-comment-config useFor="salary" mode="no-raise" fieldId="lumpsum">
<comp-warning-message><![CDATA[Please provide comment to justify Additional Adjustment against guideline.]]></comp-warning-message>
</comp-force-comment-config>

Following default message change are hard coded. These messages will be seen when the custom warning are not enabled.

Default force comment warning message:
mode = guideline – Please provide an explanation.
mode = raise – userFullName is planned for fieldLabel. Please provide an explanation.
mode = no-raise – userFullName is not planned for fieldLabel. Please provide an explanation.

 

See Also

2084829 - Reports - Aggregate Export Report - Compensation

Keywords

force comment, report comment, comp comment, CMP-5654 , KBA , sf compensation worksheet design , LOD-SF-CMP-ADM , Admin Tools, Settings, Permissions , How To

Product

SAP SuccessFactors HCM Core all versions