The Check Tool helps to eliminate common errors and catch configuration and data-related issues. It is recommended to run checks before launching forms, as the information returned by the Check Tool can provide valuable input to an administrator, and can be used to identify potential issues before a Compensation cycle begins with forms launched.
Prerequisites and Permissions
The Check Tool requires role-based permissions and Metadata Framework.
To use the feature, grant the following administrative permissions:
Access Check Tool authorizes users to access the tool.
Allow Configuration Export authorizes users to export system configuration data from within the Check Tool.
The Check Tool can be launched directly from the Manage Worksheet page or by using Action Search.
The checks available for Compensation and Variable Pay are as follows:
Check for cyclic dependency: Use this check to determine if there are any cyclic dependencies for a planner in their compensation plan hierarchy. A cyclic dependency is when Employee A is the Planner for Employee B and Employee B is the Planner for Employee A. When that happens, the system is not able to continue generating forms.
- Check for head of hierarchy: Use this check to determine if the top of hierarchy's Manager ID is set to NO_MANAGER for Standard Suite hierarchy and if the Manager ID is blank for Second Manager hierarchy method.
Check for inactive planners: Use this check to determine inactive planners in the compensation plan hierarchy. When the hierarchy is not correctly defined, it can happen that inactive managers have direct reports still depending on them. As forms are not created for inactive managers, these employees are not reviewed.
Check for users without planners: Use this check to determine users who don't have an assigned planner in the system. When using the Compensation Manager Hierarchy the field may contain the value NO_MANAGER. When that happens and the Head of Hierarchy has that value defined, it is not possible to launch forms for the whole company (it is possible to launch single forms).
Check for Formula Configuration Issues: Use this check to determine formula-related issues, such as toDate, dateDiff, toNumber, toString, lookup, arithmetic operations, if/else, and so on. This check can be applied at template or user level. A validation check is also available to determine if all user data file dates are formatted correctly, MM/DD/YYYY.
Check for invalid configuration: Use this check to determine invalid configuration in the plan template, such as when customers are defining custom formulas in fields and these formulas use values coming from lookup tables. These require the function toNumber or toString so the values are correctly displayed. In other cases, the formula syntax is incorrectly defined as there are missing parenthesis.
Check for reloadable custom fields: Use this check to determine all the configured reloadable custom fields in the plan template. One of the most recurring incidents is when customer had already launched forms and for certain custom fields they import new values while worksheets are in-progress and expect the changes to be dynamic on the form, but as these fields were not defined as Reloadable = "true" the form still reflects the old value. This issue has no workaround and it is necessary to delete all in-progress forms and relaunch to update custom fields with new values. Defining a check that could tell how many custom fields are reloadable would help customers identify which fields have been defined as reloadable and see what they have missed and can modify them before launching forms.
Check for reportable custom fields: One of the most recurring incidents is when customer has completed their compensation forms and want to see certain custom fields in Ad Hoc Reporting, but as these fields were not defined as Reportable = "true", they are not available for selection in reporting. This issue has no workaround and will necessitate deleting and relaunching forms. Defining a check that could tell us how many custom fields are reportable would help customers identify which fields have been defined as reportable and see what they’ve missed and can modify them before launching forms.
Check for statement setup: Use this check to determine configuration issues with the statement setup that occurred while the compensation plan template was being set up, such as when you’ll need to configure the statement-specific XML attributes to "true" in the plan template. Note that includeSalaryStatement, includeBonusStatement, and includeStockStatement attributes need to be configured as "true" in the template to view the Compensation statements under the Salary, Bonus and Stock tabs in the worksheets respectively.
- Additional checks for worksheets: Use this check to determine if a lookup table exists, to validate data type mismatches for custom field and standard fields, to check case-sensitive duplicated field IDs.
The check results can be any of the following:
- No issues found
- Warning: Inconsistency is found. System proposes a solution.
- Error: Inconsistency is found, admin must take action, which might include creating a ticket.