JD Edwards Orchestrator Design Template
JD Edwards Orchestrator lets you expose a business process, such as a transfer or an order inquiry, as a REST service that other systems can call through the AIS server. A short design document before you build in Orchestrator Studio saves rework. This template covers purpose, inputs, steps, outputs, security and tests.
Fill in
JD Edwards Orchestrator Design Template
Document control
Orchestration: CreateTransferRequest Business owner: Warehouse manager Author: Integration developer Date: 2026-10-20 Target environments: Dev, test and production
Purpose
Allow a handheld app to request an inventory transfer between two locations without opening JDE forms.
Called by: Warehouse handheld app Expected volume: 200 calls per day, peak 20 per hour
Inputs
item_number (string), from_location (string), to_location (string), quantity (number), branch_plant (string)
For each input record the data type, whether it is required and a sample value. Align names with the calling system's schema.
Steps
1. Form request to inventory transfer application 2. Rule to reject quantity of zero or less 3. Form request to commit the transfer 4. Return confirmation or error text
Step detail
| Step | Type | JDE application or rule | Inputs mapped | On error |
|---|---|---|---|---|
| 1 | Form request | Return error message | ||
| 2 | Rule | Stop and return | ||
| 3 | Form request | Return error message | ||
| 4 | Output mapping |
Outputs
status (string), document_number (number), message (string)
Security and access
Describe how the caller authenticates to the AIS server, which JDE user or role runs the orchestration, and which application security applies. Confirm the service user has only the permissions the steps need. Record who may see the orchestration in Orchestrator Studio and who may change it.
Error handling and logging
List expected errors, the message returned to the caller and who is alerted. State how failed calls are logged and for how long. Define behaviour on timeout and whether the caller may retry safely without creating a duplicate transaction.
Test cases
| Case | Input | Expected result | Actual | Pass |
|---|---|---|---|---|
| Valid request | ||||
| Missing required field | ||||
| Invalid location | ||||
| Quantity of zero | ||||
| Duplicate submission |
Approvals
The example is illustrative. Orchestrator capabilities depend on your tools release, so check which step types and features your release supports. This template is a starting point for your own design review.
Design review for an AI or mobile integration
Optional: have an expert review your orchestration design and its guardrails.
Optional. The tool and every export work without this. No spam.
How to use the template
Fill in the fields about the business purpose, the calling system, the input and output fields and the steps. The generated document includes tables for step detail and test cases that you complete by hand after export. Share it with the business owner and your security reviewer before building, then update it when the design changes during testing.
- Name the orchestration clearly, since the name appears in the service URL
- List inputs with type and whether required
- Describe each step, rule and the error path
- Define the output exactly as the caller expects it
How an orchestration is built
An orchestration is a defined sequence that receives inputs, calls JDE applications through form requests or other connectors, applies rules and returns outputs. It is developed in Orchestrator Studio, run through the AIS server and called over REST, typically at an address under the AIS path followed by the orchestrator name. Because it can run real JDE forms, it can change data, so design it as carefully as any interface.
Security and idempotency
Decide which JDE profile executes the orchestration and keep its permissions narrow. Think about repeats: if a caller retries after a timeout, can the same transfer or order be created twice? Add a reference field from the caller and check for it, or design the step so a repeat is harmless. Test with invalid and missing data, not only the happy path.
Common mistakes
Teams often map too many fields, embed business rules in the calling app rather than the orchestration, or run everything under an administrator profile. Others forget to document the version of the tools release the design was built on, which matters when features differ. Keep a record of changes for audit.
Frequently Asked Questions
What is JD Edwards Orchestrator?
It is the JDE tool for building REST based services from business processes without custom code in the calling system. You design orchestrations in Orchestrator Studio and run them through the AIS server, calling JDE forms and other steps.
Does an orchestration need custom code?
Many do not, because they use form requests and rules available in Orchestrator Studio. More complex logic may need custom Java or business functions. Check what your tools release supports before you design.
How do I secure an orchestration?
Use authenticated calls to the AIS server, run under a service profile with narrow JDE security, and restrict who can change orchestrations in Studio. Test with a profile that lacks access to confirm it is blocked.
Should I use Orchestrator for bulk data loads?
Usually not. It suits transactional, real time requests. For large batch loads use UBEs, Z-file interfaces or database level conversion tools designed for volume.
If you are connecting JDE to AI agents or mobile apps, Netray can help design the orchestrations and the guardrails, including human approval before any write-back.
Related Tools
JD Edwards Security Workbench Worksheet
Editable worksheet to record JD Edwards role security records by type, with the actions allowed, risk notes and approver for each.
OracleJD Edwards Tools Release Upgrade Checklist
A phased checklist for moving JD Edwards EnterpriseOne to a newer tools release, from certification checks to post-cutover monitoring.
Developer ToolsJD Edwards SQL Query Generator (Open Sales Order Lines)
Generates a read-only SQL Server query for open JDE sales order lines, with Julian date conversion, implied decimal handling and branch filters.
OracleJD Edwards UBE Job Scheduling Worksheet
Editable worksheet to plan and document scheduled UBE batch jobs with versions, queues, run windows, dependencies and owners.
More Oracle tools
See all- JD Edwards Document Types Reference (OP, SO, OV, PV)
- JD Edwards Table Reference (F4211, F4311, F0101, F4101, F4102)
- JD Edwards Environment Refresh Runbook Template
- JD Edwards UBE Runtime Log Worksheet
- JD Edwards Next Numbers Capacity Worksheet
- JD Edwards Object Promotion Request Template
- JD Edwards Data Dictionary Item Request Template
- JD Edwards User Defined Code Change Log Worksheet
- JD Edwards Go-Live Cutover Plan Worksheet