Implementations

Implementations are digital representations of a trading partner’s EDI specification – the detailed rules that define how a particular X12 document type (like an 810 Invoice or 856 Ship Notice) should be structured for that partner. Each outbound transaction setting requires an implementation.

Let Us Build Them For You

Implementations are complex. Fortunately, you don’t have to build them on your own. Send your trading partner implementation guides/specs to info@tediware.com and our team will build them for you in 1-2 business days.

You can also check the Public tab for implementations that Tediware has already built. If one matches your trading partner’s requirements, you can import it directly into your organization.

Organization vs Public

The Implementations page has two tabs:

  • Organization – implementations that belong to your organization. These are the ones you assign to outbound transaction settings.
  • Public – implementations built and maintained by Tediware. These cover common trading partner specifications and can be imported into your organization with a single click.

Importing a Public Implementation

  1. Navigate to Implementations and select the Public tab
  2. Find the implementation you need (use the search bar to filter by name)
  3. Click Import next to the implementation
  4. Optionally adjust the name and description for your own reference
  5. Click Import to add it to your organization

The imported implementation is a full copy – you can edit it independently without affecting the public version.

Creating an Implementation

If you are building an implementation yourself:

  1. Navigate to Implementations and click Add Implementation
  2. Fill in the required fields:
    • Name – an internal label for your reference. Not visible to trading partners.
    • X12 Release – the X12 release version (e.g., 005010). If you need a release that is not listed, contact us.
    • Transaction Set – the document type (e.g., 856 Ship Notice). Select a release first to populate the list.
  3. Optionally provide a Version (e.g., “1.0”, “2024-01”) and Description
  4. Click Create

You are taken directly to the implementation editor after creation.

The Implementation Editor

The editor uses a three-panel layout:

  • Structure (left) – a navigation tree showing the segments and loops included in the implementation. Click any item to edit it.
  • Detail (center) – the editing area for the selected segment, loop, element, or component. This is where you set usage requirements, conditions, code lists, and notes.
  • Alts & Levels (right) – shows alternates and HL level instances for the selected item. Alternates allow the same segment or loop position to have different configurations based on a discriminant value.

Select Nodes

Click Select Nodes in the toolbar to choose which segments and loops from the base X12 specification to include in your implementation. Trading partners typically use only a subset of the full X12 standard – this is where you define that subset. Segments marked as mandatory in the X12 standard (like ST and SE) are always included.

Editing Details

Select a segment, element, or component in the navigation tree to edit its properties:

  • Status – whether the item is required, situational, or not used
  • Conditions – rules that govern when an element is required or how elements relate to each other
  • Notes – free-text notes from the implementation guide
  • Code lists – for elements that use code values, which codes are valid

Changes are saved individually per item. The editor warns you if you try to navigate away with unsaved changes.

Settings

Click Settings in the toolbar to update the implementation’s name, description, and tags.

Validation

The editor automatically checks your implementation against the base X12 specification and flags deviations – for example, marking a mandatory element as “not used” or setting an element to a requirement that differs from the standard. Click the deviations indicator in the toolbar to review findings and jump to the relevant item.

Deviations are not errors. They are informational and highlight where your implementation diverges from the X12 standard, which is expected and normal.

Viewing an Implementation

The implementation detail page shows the full specification in a read-only view with two tabs:

  • Specification – the structured view of segments, elements, and their properties
  • JSON Schema – the generated JSON schema that Tediware uses for validation during processing

Managing Implementations

Duplicating

From the implementations list, click Duplicate next to an implementation to create a copy. This is useful when a new trading partner has similar requirements to an existing one – duplicate the closest match and adjust the differences.

Deleting

From the implementations list, click Delete next to an implementation. Deleting an implementation removes it permanently. If the implementation is in use by a transaction setting, you will need to reassign or remove that transaction setting first.

Use the search bar on the implementations list to filter by name.

Using Implementations

Implementations are assigned to outbound transaction settings on a partner. When you add an outbound transaction setting, you select an implementation that defines the partner’s expected format for that document type.

During outbound processing, Tediware uses the implementation in two ways:

  • Schema validation – the generated JSON schema validates submitted data before EDI generation. This catches structural errors early.
  • Mapping target – in the mapping editor, the implementation’s schema defines the target structure, so the AI assistant and validation tools know what shape the output should take.