---
title: "An Integration Run Book Assistants Can Query — Kiweely"
description: "How to keep an integration run book of times, counts, and outcomes that an assistant can query without payloads."
url: https://kiweely.com/guides/workday-integration-run-book-for-assistants
---

# An Integration Run Book Assistants Can Query

Record when the run started, how it ended, and how many rows moved. Leave the file, the worker rows, and the pay figures out of the book an assistant can read.

-   **Checked** against Workday on November 16
-   Applies to **Workday Extend**
-   9 min read
-   Published November 16
-   By Kiweely

Building an integration run book assistants can query

An assistant can answer “what happened last night” only if the record it reads was written for that question. Workday’s integration event is written for a person who is allowed to open the event, and it can contain the output file and the messages a developer chose to attach. That is the wrong document to hand to an assistant. The run book you want is smaller: when the run started, when it ended, how Workday finished, whether the file was delivered, how many rows the outcome record knows about, and how a vendor response, if you loaded one, changed the count. No file. No worker. No pay.

[Kiweely Roots](https://kiweely.com/roots), coming next, states this as a platform rule. Workday data passes through and is gone when the run ends. What remains is times, counts, and outcomes. This guide is how to build that book from Workday’s own event, so an assistant has something safe to query even before an outside platform stores it for you. The guide does not depend on a particular assistant product.

## What Workday already stores, and why it is too wide

After you launch a connector, the background process page shows status, processing time, who started the run and when, a link to the integration event, an output-files tab, and a messages tab. Status values include aborted, completed with errors, completed with warnings, and not run due to exceptions on a future process, plus the ordinary completed state. That page is necessary. It is not a run book for an assistant, because the output-files tab is the file.

Studio’s logging course is the warning to copy onto the first page of the book. Do not log the mediation message in production. Anyone with integration-event access can read a raw web service or report response, and that response can be confidential. Excessive logging also slows the integration and fills disk. The course’s limits are concrete: the server log is capped, a single integration message component will put only 500 messages on the event and spill the rest to the server log, and the cloud log is a separate file you store on purpose. None of those mechanisms is a filter an assistant will respect. If the text is in the tool result, the assistant can repeat it.

Document retention makes the same point from the benefits template. The 834 services include an integration document retention setting whose default is 30 days. Workday keeping the file for a month is a Workday retention decision. Copying that file into a second store “so the assistant can help” doubles the retention and widens the audience. The assistant does not need the file to say whether the run delivered.

The business process guidelines split generation from delivery. The fire-integration step produces the file. Document delivery sends it. A success notification Workday uses as an example — the payroll file was generated and delivered — is a statement about those steps. Put both facts in the run book as separate fields. A single “success” field is how an assistant learns to lie.

## The fields

Store one row per run. Store a second row, or an update with its own time, when a vendor acknowledgment arrives later. Do not overwrite the fact that Workday delivered the file at 01:10 with the fact that the vendor rejected rows at 07:00. Both are true. The assistant needs both times.

| Field | Allowed content | Not allowed |
| --- | --- | --- |
| Integration name | The name operators use | A filename that includes an employee id |
| Run started, run ended | Timestamps | — |
| Workday event status | Completed, completed with warnings, completed with errors, failed, aborted | A pasted message body |
| Delivery status | Not configured, delivered, delivery failed | The remote directory listing |
| Population counts | Integers: rows read, rows written, rows skipped, rows rejected | The rows |
| Vendor outcome | A later status and a count, if you loaded an acknowledgment | The acknowledgment file |
| Error class | A short code you maintain: transport, format, security, unknown | The raw stack, which can contain data |
| Fix state | None, tested on Sandbox, waiting for a person, resumed, rolled back | The diff of the file |
| Actor | Which schedule or which person started it | That person’s personal data beyond a directory id you already expose at work |

Counts have to be computed by the integration, deliberately, from a counter. They must not be computed by an assistant that was handed the file and asked to count. The second method is a leak with an extra step. Studio’s course prefers a small number of integration messages that summarize the event, not one message per record. A summary message of “written 27, skipped 2” fits the book. A message per worker does not, and it will also hit the 500-message ceiling and spill.

Vendor outcome is optional because many integrations do not load the acknowledgment. If you do not have it, leave the field empty and teach the assistant to say “vendor outcome not recorded.” Do not let it infer acceptance from Workday’s Completed status. The benefits testing chapter is the reason: connectivity, file format, and data-and-events are different cycles. Delivery is the first. A blank required field is the second, and it shows up in the vendor’s response, not in the delivery step.

## Where the book lives

Keep the book in a system whose access matches who may ask the question. A payroll run’s counts are still sensitive in aggregate — headcount and rejection counts can be confidential in a small population — so “no payloads” is not “everyone in the company.” Match the book’s permissions to the integration’s operators.

Do not use the integration event’s message text as the system of record for the assistant. You can extract the safe fields from the event with a person or a job that reads the event under an integration security policy and writes only the table above. The job’s output is the book. The event remains for the people who are allowed to open output files. Studio’s warning stays intact because you did not add a new reader of the raw message.

If you are evaluating Roots, this table is the acceptance test. The page says times, counts, and outcomes, never the records. A stored book that also has the document has failed the page, whatever the marketing line says. A book that only has Workday’s status, and calls it the outcome, has collapsed delivery and vendor acceptance. Ask early access to show a run that was delivered and later vendor-rejected as two facts.

Workday will still have the file if the template retains it. Operators who need a row open the event, under the permissions they already have. The assistant’s path does not. That split is the design. Collapsing it because “it is easier for support” is how the file reaches a chat transcript.

## How an assistant is allowed to speak

Give the assistant this glossary, and do not give it the event payload.

| Someone asks | The book has | The assistant says |
| --- | --- | --- |
| Did it run? | Start and end, status | The time and the Workday status, by name |
| Did they get the file? | Delivery status | Delivered, or delivery failed. Not “accepted” |
| How many people? | A count | The integer. Not the names |
| Did the vendor reject anyone? | Vendor outcome present | The rejection count and the time it was recorded |
| Did the vendor reject anyone? | Vendor outcome empty | “Not recorded. Delivery status is not vendor acceptance.” |
| Why did it fail? | Error class | The class, and that a person with event access has the detail |
| Is a fix waiting? | Fix state | Waiting, or resumed, or none. Not the file diff |

Refuse anything that needs a row: “what was Sam’s deduction,” “read the segment,” “who was skipped.” The refusal is not a limitation of the model. The book does not have the answer. A model that answers anyway is inventing, and the prompt should say the book is the only source.

Fix state is the field that connects the book to a repair policy. [Which integrations may auto-remediate](https://kiweely.com/guides/which-workday-integrations-may-auto-remediate) decides whether a fix may resume. The book records which of those states the integration is in. An assistant that can recite “waiting for a person” is useful. An assistant that can clear that field is not an assistant. It is an approver. Do not grant that write to the querying identity.

## What to strip if you already log too much

Teams that followed the path of least resistance have worker identifiers in messages, because the logging course itself says a good error includes context such as the worker’s name. That advice is for a person debugging inside Workday. It is in tension with the same course’s instruction not to expose confidential data on the event, and you resolve the tension by audience. A Workday user who already has the domain can see the name. An assistant used by a broader set of managers should not receive a copy of that message.

Practical cleanup:

1.  Stop writing per-record messages. Write counters. You will also avoid the 500-message spill.
2.  Keep a cloud log or a stored document for the integration team if you truly need row context, and do not point the assistant at that document.
3.  Map vendor codes to your error class outside the book, in a table that contains no personal data.
4.  Delete or stop exporting historical message archives into the tool the assistant uses. Retention of the safe book can be long. Retention of a dumped message archive should not be “forever” simply because a chat might ask.
5.  Test the assistant with a question designed to tempt it: ask for a name that exists only in the file. The correct answer is that the book does not contain names. Any other answer means the tool is reading more than the book.

## A week’s implementation

1.  Pick one nightly outbound integration. Benefits is the best teacher, because delivery and vendor format are already separate in Workday’s course.
2.  Add counters to the integration, using a summary message or a cloud-log total, not a row dump.
3.  Write one book row at the end: times, Workday status, delivery status, counts, error class.
4.  If an acknowledgment comes back, write a second fact. Do not rewrite the first.
5.  Point a single internal assistant or a report at the book, not at the output-files tab.
6.  Ask the five questions in the glossary. Reject any answer that contains a value from the file.
7.  Only then add a second integration. Payroll waits for a human in your remediation list; the book still should not contain the payroll file.

Roots, when you look at it, should be able to replace steps 3 and 5 for integrations it runs, because the page already commits to the fields and to the deletion of the rest. It should not replace your judgment about vendor outcome. If the platform never sees the acknowledgment, its “none rejected” means “we did not record a rejection,” and the assistant has to be able to say that. Put that sentence in the glossary before you connect anyone.

The book is finished when an operator can ask what happened without opening the file, and when opening the file is still required to see a person. That is the line Workday’s logging chapter draws for production. An assistant does not move the line. It makes the cost of crossing it higher, because the audience is a chat.

## Sources checked

-   [Studio logging and what not to record](https://doc.workday.com/workday-education/en-us/course-manuals/creating-integrations-using-workday-studio/logging-and-error-handling.html)
-   [Workday connectors: the integration event page](https://doc.workday.com/workday-education/en-us/course-manuals/creating-and-securing-integrations/workday-connectors.html)
-   [Integration business process guidelines](https://doc.workday.com/admin-guide/en-us/manage-workday/business-processes/business-processes-guidelines/integration-business-process-guidelines.html)
-   [Create benefits connectors, including document retention](https://doc.workday.com/workday-education/en-us/course-manuals/creating-benefits-connector-integrations/create-benefits-connectors.html)
-   [Test benefits connectors](https://doc.workday.com/workday-education/en-us/course-manuals/creating-benefits-connector-integrations/test-benefits-connectors.html)
-   [Concept: Studio error handlers](https://doc.workday.com/admin-guide/en-us/workday-studio/integration-design/error-handler-components/egj1510323126986.html)

## Related guides

[All guides](https://kiweely.com/guides)

-   [### Which Workday Integrations May Auto-Remediate Use Workday’s approval-before-delivery pattern for payroll and benefits. Let a directory feed resume after a tested fix, and keep a person on anything that changes money or access.](https://kiweely.com/guides/which-workday-integrations-may-auto-remediate)
-   [### Why a Delivered Workday File Was Still Rejected Workday can mark a file generated and delivered while the carrier’s companion guide still rejects segments, codes, or coverage. Those are different tests.](https://kiweely.com/guides/workday-file-delivered-carrier-rejected-rows)

### More guides on Integrations and APIs

[All 89 guides](https://kiweely.com/guides#integrations)

-   [When Workday Integrations Should Leave the Tenant](https://kiweely.com/guides/when-workday-integrations-leave-the-tenant)
-   [Workday API Rate Limits When Many Employees Ask Questions in Chat](https://kiweely.com/guides/workday-rate-limits-when-employees-ask-in-chat)
-   [Workday SFTP File Contracts, PGP, and Overnight Failures](https://kiweely.com/guides/workday-sftp-file-contracts-pgp-overnight-failures)
-   [Recover Workday Integration Attributes After a Sandbox Refresh](https://kiweely.com/guides/workday-sandbox-refresh-integration-attributes)
-   [Inventory Every Workday Integration System, Schedule, and Owner](https://kiweely.com/guides/inventory-workday-integration-systems-schedules-owners)
-   [Sandbox Checklist Before AI Chat, Custom Screens, or Integration Platforms](https://kiweely.com/guides/sandbox-checklist-before-ai-chat-screens-or-integrations)
-   [Security Review Packet: Pass-Through UI, AI Chat, and Zero-Retention Integrations](https://kiweely.com/guides/security-review-packet-pass-through-ui-chat-and-integrations)
-   [What Is an EIB in Workday? How to Build, Template and Load One](https://kiweely.com/guides/what-is-an-eib-in-workday)

### From the blog on Integrations and APIs

[All posts](https://kiweely.com/blog)

-   [How to Reconcile Workday Payroll Feeds in Studio Without Days of Manual XML Diffs](https://kiweely.com/blog/reconciling-workday-payroll-studio-feeds-with-ai)
-   [Turning a Messy Client Spreadsheet into a Clean Workday EIB Load in One Conversation](https://kiweely.com/blog/messy-spreadsheet-to-workday-eib-load-with-ai)
-   [Workday REST API vs. SOAP Web Services: Why Setup Work Still Needs the Task Screen](https://kiweely.com/blog/workday-rest-api-vs-soap-coverage-gaps)

## Let Workday check the work.

Kiweely writes WQL and builds orchestrations in your own tenant, and Workday, not Kiweely, says whether they passed.

[Start for free](https://kiweely.com/download) [See how it works](https://kiweely.com/vine/how-it-works)

## Get the next guide in your inbox.

One email a month with new guides and one Extend tip. Nothing else.
