Symptom
- What is the SuccessFactors Check Tool?
- Changes to the Check Tool in 2H 2022 release.
Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.
Environment
SAP SuccessFactors HXM Suite
Resolution
What is the Check Tool?
Sometimes, you might find the system doesn’t work as expected. There can be different reasons for this, such as:
- Some data is inconsistent.
- The system is not configured correctly.
With the check tool, you can identify what's wrong, rather than simply creating a support case. The check tool:
- Finds out what is wrong and how bad the problem is.
- Suggests a solution.
Prerequisites
Metadata Framework (MDF) must be enabled to use the Check Tool. If it is not enabled yet, contact your Implementation Partner for assistance.
The required features are:
- Enable Generic Objects
- Enable the Attachment Manager
Role-Based Permission Prerequisites:
You have the following Administrator Check Tool permissions:
- Access Check Tool
- Allow Configuration Export
- Allow Check Tool Quick Fix
Enabling the Check Tool
Once the prerequisites are met, grant permission to the tool by following these steps:
- Navigate to Admin Center > Manage Permission Roles
- Select the role you wish to grant this permission (note - this is a tool for Super Admins only)
- Click the "Permissions..." button and then navigate to the very bottom of the left panel and select Check Tool
- Tick the "Access Check Tool" option in the right panel (you should ideally grant the "Allow Configuration Export" "Allow Check Tool Quick Fix"
option too as it will help export the configuration should you need to open a Support case). - Click Done
- Click Save Changes
Login to instance -> Go to Check Tool from action search
The checks are now grouped on tabs according to the check type they belong to. Each check type follows a specific purpose:
- System Health: Checks that run periodically in the system and that require no input parameters. Additional information on a check is displayed on the right side of the page when you click on a check.
There's an initial run of the new checks at the beginning of a new release, and the checks run once a month or more often automatically.
Predefined selection criteria provide you an overview of the issues you need to work on for checks on the System Health and Migration tab, to provide you a kind of worklist.
- Validation: Checks that need one or more input parameters to run. For validation checks, it requires input parameters to be run and thus need to be triggered manually.
For example, a specific template, user, or time frame.
- Migration: Checks the migrate features. You can select the Application from the drop down list and check the executed checks.
You can access the legacy check tool UI from the new check tool UI by clicking on Use legacy check tool UI.
Note:
There's an initial run of new checks at the beginning of a new release (only for checks that require no input parameters). We recommend that you open the check tool after the upgrade weekend to check for any new errors or warnings.
Predefined selection criteria provide you an overview of the issues you need to work on for checks on the System Health and Migration tab, to provide you a kind of worklist. This isn’t true for validation checks, as these require input parameters to be run and thus need to be triggered manually.
See Also
- Check Tool Handbook
- KB article 2438812 - Check Tool: How to use Check Tool to identify Orphaned Person IDs from your system
- KB article 2785629 - Check Tool: How to use Check Tool to check for duplicate usernames
- Check Types | SAP Help Portal
Keywords
Checktool, LOD-SF-PLT, LOD-SF-PLT-CHK, System Health, Validation, Migration, SF, SuccessFactors, Check Tool, Configuration, Check, Status, Verify, Verification, Consult, Run Check, Result. , KBA , LOD-SF-PLT , Platform Foundational Capabilities , LOD-SF-EC , Employee Central , LOD-SF-RCM , Recruiting Management , LOD-SF-EP , People Profile (Employee Profile / PP3) , LOD-SF-PM , Performance Management , LOD-SF-CMP , Compensation Management , LOD-SF-CDP , Career Development Planning , LOD-SF-CPM , Continuous Performance Management , LOD-SF-VRP , Variable Pay Programs , How To