Document a Workday tenant by reading it, not by retyping screens. Every business process, security policy, tenant setting and integration system can be opened in a report or task Workday ships, and the output is the first draft of a design workbook. A test script is written from the same rows.
Which Workday reports document a business process?
Workday’s Business Process Framework course describes the business process definition as the main record. Its header shows the effective date, the security groups allowed to initiate the process, and a button for a visual of the process flow. The body has tabs, each of which is a section of your document.
| Definition tab | What to record |
|---|---|
| Definition tabBusiness Process Steps | What to recordThe order of steps. Steps can run in sequence or in parallel. |
| Definition tabNotifications | What to recordSystem and custom notifications, and what triggers each one. |
| Definition tabAllowed Actions by Role | What to recordThe actions allowed in the process, such as review and subprocesses. |
| Definition tabAllowed Services | What to recordServices allowed in the process, such as creating or resetting Workday accounts. |
| Definition tabRelated Links | What to recordExternal links on the process. |
| Definition tabAvailable Rules & Fields | What to recordThe condition rules and fields that can be used in conditional logic. |
Workday says the initiation date of a transaction decides which version of the definition runs. To document a definition as it stood on another date, use View Definition from the related actions menu of the definition. Record the effective date next to every definition you capture.
The reports to start from:
| Report or task | Use it to document | Source |
|---|---|---|
| Report or taskBusiness Process Definitions | Use it to documentThe business processes in the tenant, including the ones Workday delivers | SourceSetup Considerations: Business Processes |
| Report or taskBusiness Process Configuration Options | Use it to documentWhich steps and actions can be attached to a process | SourceSetup Considerations: Business Processes |
| Report or taskBusiness Process Exception Audit | Use it to documentDefinitions with critical errors, with warnings optional | SourceFAQ: Business Processes |
| Report or taskFind Events, Business Process Cycle Times | Use it to documentReal events and the average days per process type and step | SourceSetup Considerations: Business Processes |
The Business Process Exception Audit is part of documentation, not only repair. A definition with a critical error cannot run, so the document should say whether each one is clean.
How do I document business process security?
Each business process type has one business process security policy that covers every definition of that type. Workday’s course lists the permissions it secures, including initiating, approving, delegating and cancelling. A definition can route steps to different security groups as long as those groups are in the policy for the type. That is why a step table that names a group is incomplete without the policy beside it. See domain versus business process security for how the two layers differ.
The Security for Administrators course maps questions to reports. These cover the tenant security that a workbook usually needs:
| Question the document must answer | Report |
|---|---|
| Question the document must answerWhat can a security group do? | ReportView Security Group, Security Analysis for Security Group, Action Summary for Security Group |
| Question the document must answerWhich policy secures a given item? | ReportView Security for Securable Item |
| Question the document must answerWhich groups is a worker in? | ReportView Security Groups for User |
| Question the document must answerWhat is the current security for a functional area? | ReportDomain Security Policies for Functional Area, Business Process Security Policies for Functional Area |
| Question the document must answerWhich policy edits are waiting for activation? | ReportDomain Security Policies with Pending Changes, Business Process Security Policies with Pending Changes |
| Question the document must answerWho changed security, and when? | ReportBusiness Process Security Policy History, Domain Security Policy History, Audit Trail - Security |
| Question the document must answerIs the configuration broken? | ReportSecurity Exception Audit |
To view the policy for a business process from its definition, use Business Process Policy, View from the related actions menu. Workday states that policy edits do not take effect until Activate Pending Security Policy Changes runs, and that it activates every pending change in the tenant, whoever made it. So record the activation state before you write that a role can do something.
How do I document tenant setup and integrations?
Workday groups tenant-wide options under the Tenant Setup report and a set of tasks such as Edit Tenant Setup - System, Edit Tenant Setup - HCM and Edit Tenant Setup - Business Processes. Open the report, view each task for the areas in scope, and copy the values that change behaviour. The Setup Considerations page for business processes names the Edit Tenant Setup - Business Processes task and the domains that secure it: Business Process Administration, Manage: Business Process Definitions and Set Up: Tenant Setup - BP and Notifications.
For integrations, Workday describes an integration system as the framework it uses to launch and track an integration with an external system or a Workday endpoint, and says every integration is represented as one. Each integration system is therefore one row of the integration inventory. A business process can reach one through an Integration step, so record that link on the process row. Workday also provides a Touchpoints Kit on Workday Community with resources for understanding configuration relationships in a tenant.
Workday lists the Calculated Field Exception Audit and Integration Exception Audit alongside the business process and security audits. Run all four and file the results with the workbook.
What does a design workbook contain?
Workday’s methodology for the Architect and Configure stage names configuration workbooks among its design artifacts, next to an integrations tracker and a reporting tracker, and describes the stage as aiming for a common understanding of the business needs and a prototype configuration. The tab layout below is ours, built from the objects above, not a Workday template. One tab per area works:
- Scope and version: tenant, date captured, effective dates of each definition, who captured it.
- Business processes: one row per definition, with initiators, steps in order, step type, responsible group, condition rules and notifications.
- Security: the business process security policy per type and the domain policies that matter, with pending-activation state.
- Tenant setup: each setting, its value, and the task it came from.
- Integrations: integration system, the process that launches it.
- Exceptions: output of the four exception audits, with an owner for each item.
- Decisions: why each non-default choice was made. Reports cannot supply this one; ask the consultant who built it.
What does a test script contain?
Workday’s methodology page for the Architect and Configure stage says the customer creates customer-specific test scenarios for unit and lifecycle testing, and that consultants review them for missing cases. Write each scenario as rows tied to the workbook:
| Column | Content |
|---|---|
| ColumnScenario | ContentThe case, for example a Change Job that triggers the extra approval |
| ColumnWorkbook ref | ContentThe row it proves |
| ColumnTest data | ContentThe worker or record, and why it meets the entry condition |
| ColumnStep | ContentOne action |
| ColumnRun as | ContentThe person or role performing it |
| ColumnExpected | ContentThe route, the awaiting person, the saved data |
| ColumnActual and result | ContentFilled in during the run |
After each step, open the Full Process Record. Workday documents its Process tab (steps, due dates, who completed each) and All Actions tab (the actions that ran). Those two tabs are the evidence column. The end-to-end testing guide covers running the script, and the test data guide covers building the cases.
Worked example: documenting a Hire process
In Workday’s Global Modern Services demo tenant, the Hire definition would be documented like this.
- Run Business Process Definitions, open Hire, and note the effective date and the groups allowed to initiate it.
- Copy the Business Process Steps tab into the process tab, one row per step, and the Notifications tab into its own rows.
- Open Business Process Policy, View on the definition and copy the groups per action into the security tab. Check Business Process Security Policies with Pending Changes is empty.
- Run Business Process Exception Audit with warnings shown. Record “no critical errors” or each finding.
- Write one test row per branch: one worker who meets a condition rule and one who does not, then a send back. Tie each to the step rows in step 2.
When someone changes the definition during testing, rerun steps 1 to 4 and compare. That comparison is the drift check. Our post on generating the workbook and test script from the live tenant covers the drift problem in more detail, and moving configuration between tenants is a separate task.
Kiweely Vine reads a client’s tenant with consent and keeps each project’s Deliverables folder as its record, so a workbook and test script like these can be kept current from what is actually configured.
Frequently asked questions
Is there one Workday report that documents all configuration?
No. Workday documents the pieces as separate reports: the Business Process Definitions report for processes, the security reports for who can do what, the Tenant Setup report for tenant-wide options, and the exception audits for problems. A configuration document is these outputs put in one place.
How do I show who can initiate and approve a business process?
Open the definition and read the header, which lists the security groups allowed to initiate the process. For the full set of actions, open the business process security policy from the related actions menu with Business Process Policy, View.
How do I see what changed in security since the design was written?
Run the Business Process Security Policy History and Domain Security Policy History reports, or the Changed within Time Range versions of them. Workday lists them as the audit trail for security policy changes.
What is the difference between a design workbook and a test script?
The design workbook records what is configured and why. The test script records the steps to run, as which person, and the result to expect. Each test row should point back to one row in the design workbook.
Sources checked
- Workday Education, HCM Core for Administrators: Business Process Framework
- Workday Education, Security for Administrators: Choosing the Right Security Group Type
- Workday Education, Security for Administrators: Report Security
- Workday Administrator Guide: Concept: Exception Audit Reports
- Workday Administrator Guide: Setup Considerations: Business Processes
- Workday Administrator Guide: Concept: View Business Process Details
- Workday Administrator Guide: Concept: Integration Systems and Events