Test an Applaud tool before making it available to an assistant or workflow. After a successful test, activate the tool and attach it to the experiences that should be able to use it.
This is the final step in the Applaud tool authoring process.
Before you begin
Test the tool
Testing helps you confirm that the tool sends the expected request and returns a useful response before you make it available to employees.
- Open the Test step.
- Enter any required sample inputs.
- If the tool uses Context, make sure you have the appropriate user or case context available.
- Select Test.
- Review the result.
The test runs using your current tool definition and your Applaud access. It doesn't simulate another employee's permissions.
Review the run trace
Use Run trace to see what happened during the test.
The trace can help you understand:
- Which request the tool sent.
- Which values were provided.
- Whether other tools were called.
- What the underlying operation returned.
- How the response was shaped.
- Where an error occurred.
Use the trace when a tool runs successfully but doesn't produce the expected result.
Review the response shape
If the test returns data in a different structure than expected, review the response configuration.
Where available, you can use the test result to help update the response shape, or ignore the suggested shape and configure the response yourself.
Before moving on, make sure the response gives the assistant the information it needs without returning unnecessary fields.
Save the tool
After you've tested the tool, save your changes.
You can choose Skip & save if you don't want to run a test, but testing before activation is recommended.
A successful test confirms that the tool can run. You should still test the tool through the assistant after you attach it.
Activate the tool
Saving the tool doesn't automatically make it available to assistants.
- Open the tool.
- Set its status to Active.
An active tool is available, but it still needs to be attached to an assistant or workflow before it can run.
Attach the tool
Attach the tool to the agents or workflows that should use it.
Only attach a tool where its permissions, inputs, and behavior are appropriate.
For example, a tool that retrieves an employee's own records might be suitable for employee chat but unsuitable for an unattended workflow that runs with a system identity.
Test the tool in the assistant
After you activate and attach the tool, test it where employees will use it.
- Open the main assistant.
- Ask a question or request that should use the tool.
- Confirm that the assistant selects the expected tool.
- Check the activity message.
- Review the final response.
- If the tool changes data, verify that the expected change occurred.
For example:
"Have I received a recognition this quarter?"
For a guided create or update, complete the full interaction:
Collect → Confirm → Submit
Use a safe test record when testing actions that change data.
Troubleshooting
| Problem | What to check |
| The test fails with a permission error | Confirm that your account can access the underlying Applaud data or operation. |
| The test returns unexpected data | Review the request mappings and the values sent to the operation. |
| The assistant gives a poor answer | Review the response configuration and return only the fields the assistant needs. |
| The assistant doesn't use the tool | Confirm that the tool is Active and attached to the assistant. Review the tool description to make sure it clearly explains when to use the tool. |
| A nested tool fails | Open Run trace and check the nested call and any authentication requirements. |
| A create or update doesn't produce the expected result | Review the request mappings, conditions, and confirmation flow. Then check the run trace. |