Skip to main content
Previous sectionNext section

Portal Tools

The Management Portal provides pages to help you view the schema categories and their subdivisions, view documents, and perform related tasks. This chapter describes how to use these pages in general, and it contains the following topics:

Accessing the Tools

  1. In the Management Portal, switch to the appropriate namespace.

    To do so, click Switch in the title bar, select the namespace, and click OK.

  2. Click Interoperability.

  3. Click Interoperate.

  4. Click the menu option that corresponds to the EDI format in which you are interested.

Using the Schema Structures Page

InterSystems IRIS® provides versions of the Schema Structures page for X12, EDIFACT, and XML. In general, you can use the Schema Structures page to view and import schemas. For X12 documents, you can also use the page to export schemas.

To access this page:

  1. Click Interoperability > Interoperate, and then click the menu option that corresponds to the EDI format you are interested in.

  2. Click the option ending with Schema Structures, and then click Go.

    InterSystems IRIS displays a page that lists the schemas of this type in this namespace.

In most cases, this page displays a list of schema categories on the left; these are all the schema categories in this namespace related to this format.

This area enables you to specify which schema category you are interested in examining. When you click a schema category, InterSystems IRIS displays details for that category in the tabs on the right.

Depending on the EDI format, you might see the following tabs on the right side of the page:

  • DocType Structures identifies the sequence and grouping of segments within a message structure.

  • Segment Structures lists the fields in each segment.

  • Data Structures lists the contents of composite data fields.

  • Code Tables lists the values that can be used within an enumerated field.

Additionally, you may see buttons that enable you to do some or all of the following:

  • Import a schema into this namespace, for this EDI standard. To do so, click Import, use Browse to choose a file, and click OK.

  • Export an X12 schema to a file. To do so, select the schema category, then click Export, enter a filename, select a file type, and click OK.

  • Remove a custom schema from this namespace. To do so, select a custom schema and click Delete, and then click OK. You cannot delete any of the standard schemas installed with InterSystems IRIS.

    The schema is immediately removed.


    You cannot undo this operation.

  • Create a new schema based on an existing schema. To do so, click New and then specify the base schema and the new custom schema name. You can then specify the details for the custom schema.

Using the Document Viewer Page

For information on the document viewer, see Using the X12 Document Viewer Page. The information presented in these guides is equally applicable to XML, EDIFACT, or any other EDI format.