Home /  Guides / 

Create a Stedi guide based on a PDF guide

When your trading partner gives you an implementation guide, it’s typically a PDF document. With Stedi Guides, you can turn that into a machine-readable guide, which you can use to generate EDI documents.

Every PDF guide looks a bit different. Some don’t even come in PDF, but in a format like Microsoft Word. Point is: the screenshots you’ll see here will look different from what you have to work with, but they should be similar enough to help you understand the process.

Creating a guide

Every guide is based on a transaction set. The transaction set serves as a template for the implementation guide, so when you tell Stedi Guides which transaction set the guide is based on, it can start you off with many segments and elements already defined.

The cover sheet of an implementation guide.
856 is the Transaction Set. 5010 is the X12 Release.

Including segments and elements

By default, Stedi Guides only lists the segments and elements that are required by the base transaction set. Chances are that your implementation guide includes a lot of the optional segments and elements as well. Click on Select guide nodes to select the segments and elements you need.

A screenshot of the Stedi Guides UI, with the button Select Guide Nodes at the bottom.

You can change if a segment or element is included by clicking on the boxed letter to the right of it. There are three options.

  • R: Required. Some PDF guides use M instead (for Mandatory).
  • O: Optional.
  • N: Not used by this implementation guide.

The PDF guide might also have elements that are marked as conditional (X). These have special rules associated with them. At this step, you should mark them as optional.

An example of required, optional, and conditional elements. Shown as it is presented in an implementation guide, and as it is presented in the Stedi Guides UI.
On the left, the implementation guide. On the right, the same information transferred to Stedi Guides.

Conditional elements

Some elements come with conditions that tell you when they should be included. For example, if you specify a date in the date/time-segment, you must also specify a date qualifier. Similarly, if you specify a time, you must also specify a time qualifier. You can specify either a date or a time, but you must include at least one.

The date/time-segment as presented in an implementation guide, with the conditionals highlighted.

In Stedi Guides, you specify conditions for elements on the segment level. So, for the example, you would select the G62-segment and enter the conditions there.

The date/time-segment as presented in an the Stedi Guides UI, with the conditionals highlighted.

Every condition begins with a letter that specifies the type of condition, followed by one or more element numbers to which the condition applies. For example, R0103 means that you must specify at least one of the elements 01 or 03.

It’s possible to specify more than two elements, so R010304 would mean that you must specify at least one of the elements 01, 03, or 04.

LetterNameCondition
CConditionIf the first element is present, then all the other elements must be present.
EExclusiveOnly one of the elements may be present.
LList conditionalIf the first element is present, then at least one of the other elements must be present.
PPairedIf one of the elements is present, then all elements must be present.
RRequiredAt least one of the elements must be present.

Data type and size

Every element has a specific data type and size. Stedi Guides copies these from the transaction set. It’s unlikely that an implementation guide specifies a different data type, but sometimes the size is different than the one in the transaction set.

An example of an element that accepts specific codes. Shown as it is presented in an implementation guide, and as it is presented in the Stedi Guides UI.
You can find the data type of an element under the advanced settings.

Allowed values

Many elements have a value that’s based on a standardized list of codes. For example. the date/time segment has the date qualifier segment, which tells you what kind of date you’re dealing with. The transaction set lists well over a hundred possible codes. Most likely, you won’t need all of them when dealing with a specific trading partner, so the implementation guide should list which ones are valid for you.

An example of an element that accepts specific codes. Shown as it is presented in an implementation guide, and as it is presented in the Stedi Guides UI.
On the left, the implementation guide. On the right, the same information transferred to Stedi Guides.

The UI suggests values based on the standardized list of codes, but you can add any code you need to, standard or not.

JSON Schema

EDI Translate can work with your Stedi guide directly, but if you want to use it with Stedi Mappings, or with a third-party tool, you can grab the JSON Schema.

An example of an element that accepts specific codes. Shown as it is presented in an implementation guide, and as it is presented in the Stedi Guides UI.

Next steps

Creating a guideIncluding segments and elementsConditional elementsData type and sizeAllowed valuesJSON SchemaNext steps