SAP Knowledge Base Article - Public

3584917 - How to use the Service Layer Diagnostic Tool - Onboarding

Symptom

Service Layer Diagnostic Tool is a tool that enables self-diagnosis and self-analysis of the complete data transaction and workflow processing in a single view. With the help of this tool customers can resolve issues related to service layer independently. 

Environment

SAP SuccessFactors Onboarding

Resolution

What are the supported transaction types: 

  • Workflows
  • Centralized Services Save Actions
  • Snapshot View
  • Rule Execution View

Prerequisites:
The following permissions should be enabled:

  • Administrator > Diagnostic Tool > Diagnostics Tracing Configuration
  • Administrator > Diagnostic Tool > Workflows Diagnostics Data
  • Administrator > Diagnostic Tool > Centralized Services Diagnostics Data 
  • Administrator > Admin Center Permissions > Access Diagnostic Tool

Recommended Best Practice:

  • We recommend creating a permission group to restrict access to this tool to only a few people/admins.
  • This tool does not respect RBP access at field levels therefore the provided admins can see restricted employee's data.
  • To avoid such issues or concerns please create a separate permission role for this access and give the access to few admins/users so that it can be easily monitored and controlled.
 
How to use the Tool?
Save Action Transaction: 
  • Snapshot View shows the snapshots or the records starting from the fields that were changed till the related changes, rules, end date corrections, forward propagation, and final save action. In each stage, tabular data will be shown for all related cross-entities or sub-entities involved. We can compare the field changes in each stage to get an idea of which stage the field values changed.
  • Rule Execution view shows in detail all the records that were filtered out for rule execution with reason, all the rules that were filtered out with reason, and all the rules that got executed with timestamp and details of the fields and their values the rule changed. It gives functionality to search by rule ID or field ID for cases where several rules were executed.
  • After enabling the tool, the issue needs to be replicated and then the transaction trace is available for issue analysis.
  • Tracing will turn off after 15 minutes. The traced data will auto-delete after 10 days.
  • The tool doesn't support MDF objects for now.
  • Only onSave rules data are captured.
  • Mass changes, API, and import save transactions are not traced.

Save Action Configuration:

  • In Manage Data, set up the Diagnostics Tracing Configuration MDF object.  You may also use the direct link in diagnostic tool page, where a link to "Enable Tracing" is provided.
  • In Diagnostic Trace Configuration, create new or modify existing trace, by entering any code, status= active and Activate Diagnostic Trace = Yes.
  • Enter user name of user completing the transaction in Requested By field (if using proxy enter that user's name). 
  • Requested For field doesn’t support external onboarding users yet.
  • Save the object and then replicate the save action on a user.
  • Once this object is saved from the start time provided the tracing will be active for 15 minutes.
  • Within this time frame, any Save transaction executed by the requested user would be captured and available in the tracing details.
  • Business Action enlists all supported Change Sources.
    New Hire Data Review / Access New Hire Data / Personal Data Collection – Onboarding
    Manage Pending Hires – Hire/Rehire Processes

Workflow Tracing:

  • The approval or actions on the workflow should be done only from the "workflow details page".
  • If the workflows are approved from the "home page quick action" or "mobile device" or "Manage workflow requests" admin tool by taking action on the workflows by admin and changing workflow approvers or status, then such changes will not be traced. In the diagnostic tool for such scenarios, only the initiate data with pending workflow status will be shown because other approvals or send-back actions were not traced.
  • Workflow tracing will start and keep capturing from the date the Role-based permission (RBP) is provided to the Diagnostic tool > Workflow Configuration Data. However, after 10 days of no action on the workflow, the tracing data will get auto-deleted. If any action is done on the workflow like approval or send back, the tracing data will stay for + 10 days, and so on.
  • Auto-approval or CC role workflows are supported.
  • Workflows based on HRIS Elements are only supported.
  • Workflow trace will be only if the workflow is submitted. No simulation tracing is available.

Workflow Tracing Transaction:

 

Search fields for Workflow Tracing:

Requested By = user doing the transaction
Requested For = user whose data is getting changed in the transaction
Date Range = Workflow initiate date Or when the changes on employee was done/ issue replication date. At a time only 3 days can be selected and searched.

See Also

Keywords

Service Layer, Diagnostic Tool, Centralized Services, Error, Application, Application Error, Workflows, Data Transaction , KBA , LOD-SF-OBX-PDC , Personal Data Collection , LOD-SF-OBX-NHR , Onboardee Data Review , LOD-SF-OBX-EC , Integration EC - MPH, Hire , How To

Product

SAP SuccessFactors Onboarding all versions