Test a SuccessFactors tool before you make it available to an assistant or workflow.
Testing lets you check that the tool sends the expected request to SuccessFactors and returns a useful response. You can also use the Run trace to see what happened during the test.
Before you begin
Test a tool
- Open the SuccessFactors tool you want to test.
- Go to Test tool.
- Enter sample values for any required inputs.
- Select Test.
- Review the result.
- Open Run trace to see how the tool ran.
If the test succeeds, save the tool.
If it fails, use the run trace to identify the problem, update the tool configuration, and test it again.
Use sample inputs
Use realistic test values that represent how the tool will be used in a conversation.
For example, for a tool that looks up an employee's job details, test with an employee or user that the SuccessFactors API user is allowed to access.
If you mapped an input from Context, you don't need to enter a value for it. The tool uses the relevant signed-in user or case person.
Review the run trace
The Run trace shows what happened during the test.
Use it to check:
- Inputs and mappings.
- Any lookups the tool performed.
- The request sent to SuccessFactors.
- The response returned.
- Any enrichment or response shaping.
This can help you identify whether the problem lies in the tool configuration, the SuccessFactors request, or the returned data.
Fix and retest
If the test fails, check the run trace and review the tool configuration.
Common problems include:
| Problem | What to check |
| A required value is missing | Check that all required inputs are mapped. |
| The wrong person or records are returned | Review your filters and input mappings. |
| The response contains too much information | Review the Final response and return only the fields the assistant needs. |
| A lookup does not return the expected options | Check the lookup configuration and the SuccessFactors permissions for the API user. |
| The request is rejected by SuccessFactors | Check the request mapping and confirm that the API user has permission to access the relevant data or action. |
After making changes, select Test again.
Use a test result to shape the response
If the response returned by SuccessFactors is different from what you expected, you can use the test result to help configure the response shape.
Depending on the result, you can choose Use test result shape instead or Ignore and configure the response manually.
A good response should contain the information the assistant needs to answer the person clearly, rather than the complete SuccessFactors payload.
Test guided requests
If your tool supports a guided request, test the complete conversation flow.
Check that the tool:
- Collects all required information.
- Asks for confirmation when required.
- Sends the correct values to SuccessFactors.
- Returns a clear result.
For an action that changes SuccessFactors data, use a safe test case and confirm the result before making the tool available to users.
Test before you go live
A successful tool test confirms that the current tool configuration can run against SuccessFactors.
Before making the tool available to users, also check that:
- The tool has a clear description.
- Inputs and mappings are correct.
- The response is focused and useful.
- The activity message is clear.
- Guided requests collect and confirm the required information.
Next steps
After you've tested the tool, make it available to the appropriate assistant, case session, or workflow.