Debugging Runbook Executions Using the Factory
Learn how to use the Factory to track job executions, investigate failures, and reship jobs after fixing issues to streamline troubleshooting.
The Factory (Job Reports)
The Factory provides a high-level overview of all jobs processed by a runbook.
- Job Report: Displays a list of all executions, including date, time, status, and a unique Job UUID.
- Job Details: Selecting a specific job lets you view the exact input and output data for each step in that run. This is the primary tool for troubleshooting and validating your integration logic.
How to access the Factory
Go to the runbook’s Designer page and click on Factory.
Using the Dock
Once the Factory is opened, the Dock appears.
On the right side, you will see:
- Jobs: Use this tab to view success and failure logs.
- New Shipment: Use this tab to send test payloads to the runbook.
Viewing Failed Jobs
- Go to the Jobs tab.
- Use the Status and Date filters to narrow down failed jobs.
- Once the failed jobs are displayed, select a job and click Add to Dock.
You can add up to 8 jobs to the Dock.
Analyzing Job Details
- Click on a job in the Dock to view its details.
- Any errors in the job are highlighted with a red warning icon.
Viewing Error Details
- Click on the Xurrent mutation step (highlighted in red when an error occurs).
- The error details will be displayed in the logs.
Example:
“Subject can't be blank”
Reshipping the Job :
After identifying and analyzing the issue in a failed job, you can use the Reship option to reprocess the job with corrected data.
- Open the failed job from the Dock.
- Review the input and output details, and identify the root cause of the failure.
- Make the necessary corrections (for example, fixing missing or invalid fields like “Subject can't be blank”).
- Click on Reship to resend the job with the updated input.
This allows you to:
- Quickly validate the fix without creating a new test from scratch
- Reuse the same job context and payload
- Speed up troubleshooting and testing cycles
Note: Ensure all required fields and configurations are corrected before reshipping, as the job will fail again if the underlying issue is not resolved.
New Shipment (Testing Payloads)
The New Shipment tab allows you to manually trigger the runbook by sending test data (payloads). This is useful for validating logic, debugging issues, and simulating real-world scenarios.
Fields and Options
- Select Solution Version
Choose which version of the runbook you want to execute:- Latest Draft: Runs the most recent, unpublished version. Ideal for testing changes in development.
- Published: Runs the currently live version. Useful for validating production behavior.
- Body
Enter the request payload here (typically in JSON format). This represents the input data for the runbook. - Headers
Optionally provide HTTP headers (e.g., authentication, content type), if required. - Send Message
Click to trigger the runbook with the provided payload.
How to Use
- Select the appropriate Runbook version (Latest Draft or Published).
- Enter your test data in the Body section.
- Add any required Headers (if applicable).
- Click Send Message to execute the runbook.
- The execution will appear as a new job in the Jobs tab.