Using Check Tool to validate configuration

Objective

After completing this lesson, you will be able to Verify that the configuration is valid using the Check Tool.

Using the Check Tool

If your SAP SuccessFactors applications are behaving in unexpected ways, it is likely that it has a configuration or data conflict: you have some data that is inconsistent or a configuration error. The Check Tool quickly identifies these types of problems so that you can avoid support tickets. You might still need to create a support ticket if the problem is severe, but even in severe cases, the check tool can save you time because it can export the results of the check and your configuration for support. The support engineer, therefore, can identify the issue more quickly.

The history of check results is retained and users can review the history of check runs in the Check Tool user interface.

In addition to that, the Check Tool can generate a list of all available checks. This is available via the help feature in the Check Tool and provides a high-level summary of all checks. It is not limited to the checks a user has access to.

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.
  • Validation: Checks that need one or more input parameters to run, for example, a specific template, user, or time frame.
  • Migration: Checks that migrate features.

Why is it important?

This list provides a useful Built-in Support documentation summary for any user wanting to understand the full capabilities of the Check Tool. No information is provided to the user that would not normally be shared via standard SAP help documentation channels.

Permissions for the Check Tool

The Check Tool has its own permissions.

The specific permissions are:

  • The Access Check Tool permission authorizes users to access the tool.

  • The Allow Configuration Export permission authorizes users to attach configuration information to a ticket in cases where they need to create one.

  • The Allow Check Tool Quick Fix permission authorizes users to fix configuration and data issues.

To set the required permissions, go to Manage Permission Roles. Select the role for which you want to maintain the permission, click on Edit and then Next, then scroll down until you see the Check Tool role. Make the appropriate settings.

Quick Fixes in Check Tool

You can run Quick Fixes in Check Tool for issues found by checks with parameters. These checks are included in the Validation tab. The available checks with parameters, that include Quick Fix are:

ModuleCheck ID
User ManagementPurgeECDataForExternalLearnersCheckExecutor
Time OffTimeAccountAccrualWithEmptyPeriodIds
To-Do FoundationReportTimestampInconsistenciesForTodos
To-Do FoundationReportTodoEntryNotDecorated
OnboardingONB2CheckProcessTriggerObjectExists

As a prerequisite please have the following Role-Based Permissions in the Check Tool enabled:

  • Access Check Tool
  • Allow Configuration Export
  • Allow Check Tool Quick Fix

The Quick Fix button is displayed under Proposed Solution, on the Result tab. Selecting the Quick Fix starts a 3-step-wizard to initiate the automated fix.

Verify Permissions with the Check Tool

Business example

Some of your colleagues are reporting errors when running ad-hoc reports. Your task is to troubleshoot and resolve the issue or raise a ticket.

ExerciseStart Exercise

Prerequisites

Before you start, make sure you have the required permissions to access the Check tool as described in previous lesson. If needed, add permissions to the Administrators group. Remember: Once permissions are added, you will need to log out and log back in to the system for changes to take effect.

Steps

  1. Access the Check Tool.

    1. Use the Action Search to navigate to Check tool.

  2. Run the check of your Role-Based Permissions.

    1. From the Application dropdown, select the Role-Based Permissions to run a check for.

    2. The list of checks is automatically updated depending on the application selected.

    3. Select all of the rows.

    4. Choose run X checks.

      Note

      You can run as many checks as you want. The Run Checks button at bottom right gets updated to tell you how many you have selected.

  3. Look at the detailed results and decide what next steps to take.

    Result

    On completion of the check, the Check Tool displays results.

    The results can be any of these:

    • No inconsistencies found. All checks have successfully passed.
    • X inconsistencies found, where "X" is the number of inconsistencies. In cases where inconsistencies are found, you see either a yellow warning icon or a red alarm icon.
    • The yellow icon is a warning that something not too serious is wrong. The system proposes a solution.
    • The red icon indicates that the problem is serious. You must take action, which might include creating a Support ticket.

    If creating a customer incident make sure it is under the relevant category, and do provide the component value you copied from the Need Assistance? section as shown below:

Log in to track your progress & complete quizzes