Stedi Guides: Shareable EDI implementation guides for modern EDI integrations
This post mentions Stedi’s EDI Translate API. Converting EDI into JSON remains a key Stedi offering, however EDI Translate has been superseded by Stedi Core, an event-driven EDI system that allows you to configure integrations without being an EDI or development expert.
The first step in any EDI relationship is agreeing on a set of EDI specifications. These requirements are typically shared as a PDF document, which is helpful for human reference but does not enable automated translation or validation of EDI documents.
- Machine-readable JSON Schema artifacts to read, write, and validate EDI documents.
- Built-in support for all X12 transaction sets and releases, allowing you to configure X12-conformant specifications without custom development.
- Customizable specifications, so you can make the standard work for you and not be constrained by strict X12 interpretation.
- No coding experience required to build a Stedi guide using the visual interface.
If you are reading this, you probably encountered one of these situations:
- You’ve received EDI requirements from a trading partner in a PDF document, and are wondering about how best to incorporate those into your development workflow.
- You meticulously built and sent an EDI file to your trading partner, only to be told days or weeks later that the file has errors.
- You receive EDI files from a partner and want to validate and parse them according to your specifications.
Stedi Guides is built to address these use cases, and more.
The fundamental problem with EDI is that while conforming to EDI specifications is critical to every EDI implementation, PDFs are a poor format for communicating a schema. Trading partners are left trying to visually validate an EDI file against a PDF and attempting to capture the nuances of a complex guide in custom validation logic. To complicate matters, EDI specifications almost always differ from one trading partner to another, making it unmanageable to keep track of differences while generating accurate EDI files for every partner.
Stedi Guides solves these problems by giving you a visual interface for building robust artifacts – guides – to encapsulate EDI specifications, while making them available for programmatic access.
You can publish the guide privately within your organization for others to access it as an interactive documentation on a web page.
guideId) and a JSON object, and the API will return a conforming EDI file – or a list of validation errors encountered during translation. See the demo for writing EDI for a detailed walkthrough.
// Translate the Guide schema-based JSON to X12 EDI
const translation = await translateJsonToEdi(mapResult.content, guideId, envelope);
const translation = await translateEdiToJson(ediDocument, guideId);
Stedi Guides is the foundation of every modern EDI system. Stedi Guides allows you to build integrations that are reliable, easy to troubleshoot, and scalable as you onboard with new trading partners and transaction sets. The no-code interface makes it easy for anyone to create and maintain EDI specifications, regardless of their technical ability or EDI knowledge. In addition to reading and writing EDI programmatically, Stedi Guides renders human-readable documentation in the browser, allowing for real-time validation of EDI files using Inspector.
Get blog posts delivered to your inbox.