plan_integration
Generate Workday Studio assembly and diagram skeleton files from gathered design decisions, scaffolding sub-flows, splitters, and auth before you build integration logic.
Instructions
⚠️ DO NOT CALL THIS TOOL without first gathering ALL design decisions from the user.
Design questions you MUST ask before calling:
DATA SOURCE — How does data enter the integration? raas → Workday custom report (most common for scheduled/outbound) soap-get → Workday SOAP Get_* (when RAAS is not available) inbound-file → User uploads a file on the integration event webhook → Workday event listener fires (listener-service) external-rest → Fetch data from a third-party REST API
DATA DESTINATION — Where does processed data go? workday-soap-write → Workday SOAP Put_*/Change_*/Hire_* etc. workday-rest-write → Workday REST custom objects PUT/POST/DELETE external-rest → POST/PATCH to a third-party API file-delivery → Output file delivered on the integration event email-only → Send email notification (no system update)
TRIGGER — What launches this integration? scheduled → Workday scheduler (daily, hourly, etc.) event-driven → Workday business event (hire, terminate, etc.) launch-params-manual → Manually launched, optional filter params inbound-file → Triggered by file upload on the integration event
RECORD VOLUME — How many records does the integration process? single → Always exactly 1 record (no splitter needed) small → Under 100 records (xpath-splitter loads all into memory) large → Over 100 records (MUST use xml-stream-splitter for streaming)
EXTERNAL AUTH — What auth does the external system require? none → No external system involved oauth2 → OAuth2 token refresh flow (adds GetToken sub-flow) basic → Username + password (Base64 encoded) api-key → Static API key
ERROR HANDLING: integration-messages → Log to Workday event log (always minimum) email-notification → Send failure email (adds Email sub-flow) rethrow → Stop integration and propagate the error
RAAS REPORTS (if data_source = raas or multiple): For each report: alias name, what data it returns, any filter params. Filter param syntax: "Worker!WID" for object refs, "Effective_Date" for text, "format=simplexml" to strip wd: namespaces from response. Example: alias="INT145_Get_Workers", filters=["Worker!WID", "format=simplexml"]
SOAP OPERATIONS (if soap-get or workday-soap-write): For each: application (e.g. Human_Resources), operation (e.g. Get_Workers), version.
INTEGRATION ATTRIBUTES: Any credentials or config stored in Workday? (API keys, URLs, OAuth credentials) Note: oauth2/basic/api-key auth types auto-generate the standard attributes.
CONDITIONAL LOGIC: Any routing decisions? e.g. "employee vs contractor", "new hire vs rehire", "active only"
Once you have all answers, call with project_name + sub_flows + design_brief. The tool writes assembly.xml + assembly-diagram.xml with correct declarations pre-populated.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_name": "<project_name>",
"sub_flows": "<sub_flows>",
"design_brief": "<design_brief>"
},
"name": "plan_integration"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sub_flows | Yes | Ordered list of sub-flows. Order = execution order in the main flow chain. | |
| design_brief | Yes | ||
| project_name | Yes | Existing project name (e.g. "INT145_My_Integration"). Must already exist in the workspace. |