API Linx Mapper

Introduction

The API Linx Mapper is a powerful tool designed to facilitate the mapping of data between different systems. This document provides an overview of the key features and functionalities of the API Linx Mapper, including Maps, DOMs, API functionality, and Catalog features.

Maps

Maps are used to define the transformation rules for data as it moves between different systems. The API Linx Mapper allows users to create, edit, and manage maps with ease. Key features include:

• Drag-and-drop interface for creating and editing maps
• Support for complex data transformations
• Validation and testing tools to ensure data integrity

Creating a map

• Click on create map in the top right corner

• Enter in the name of your map

• Select the document type

• Select target

• Select the method type

• Enter version for the map

• Select Document or upload a file (EDI or XML)

• Select the target document (if not using a DTS Global DOM, specific DOM would need to be created first)

• Click Submit

The mapping screen is designed to streamline the mapping process. On the left, you'll find the source files, while the target is displayed on the right. To map fields, simply drag and drop them from the source document to the target. Once a field is mapped, a line will connect it to the corresponding target field, and the source field will be highlighted in green on the target side.

On the target side, icons provide details about each field, including whether it is required. Hovering over these icons reveals additional options, such as mapping conditions or deleting the mapping for that field.

At the bottom of the screen, dropdowns for Map Rules and Change History are available. The Change History section logs all modifications to the mapping, including the date and time, the user who made the change, and a description of the change

While in the map, there is the option to collapse or expand the lines, lock/unlock the DOM, go to the source/target DOM, view line names instead of segment values.

Unlocking a DOM allows reorganization of the fields along with editing the data in the fields.

After all the fields are mapped there are options to download, upload, test the map with the API, or undo the rules.

The testing tool allows for testing of the map without sending it to the target. 

• Click on test map

• Select the method either post or get

• Choose the file

• Click Run

DOMs

DOMs (Document Object Models) represent the structure of the data being mapped. The API Linx Mapper provides tools for creating and managing DOMs, including:

• Visual editor for defining DOM structures
• Support for multiple data formats (XML, JSON, etc.)
• Import and export functionality for sharing DOMs between projects

Create a DOM

• Select the document type

• Select the trading partner

• Enter in the version number for this DOM

• If uploading a file, click to enable and attach file.

• Click Submit

DOM fields can be collapsed or expanded for easy viewing. On the right is the DOM Information

• DOM owner (only DOMs owned by you can be changed)
• Associated Maps (all map IDs that use this DOM will be displayed)
• DOM version (Version number assigned when DOM was built.

The elements associated to each segment will be indented.

Segments

• Add elements
• Sort by Index Value
• Edit
• Copy
• Delete

Adding elements to a segment, click on the +

• Select Element

• Under General enter information for the new element.

• Click on Codes to enter in code associated to values (if needed)

• Click Save

To make changes to elements, click the pencil icon and edit fields as needed.

API Functionality

The API Linx Mapper includes robust API functionality, allowing users to integrate their maps and DOMs with external systems. Key features include:

• RESTful API support for seamless integration
• Authentication and authorization mechanisms to ensure security
• Comprehensive documentation and examples for developers

Transactions

• Display of API transactions both Get and Post. 

• Click the checkbox to select a message to archive or delete.

• Right side will display details on selected message

• Transaction ID (unique identifier for each transaction)
• Map ID
• DOM ID (source and target)
• Status
• Method (Post or Get)
• Document type
• WebEDI Message ID (details will display for failed transactions)
• Payload detail (Payload will not display for messages that are in error status)

Bottom of screen will display notifications

• Select the event type for notification
• Enter email address for notification

Credentials

The bearer token can be displayed by clicking on the eye icon. Token validity date will be displayed. 

*Note* Regenerating API token will automatically disable previous credentials.

Catalog Features

The Catalog feature in the API Linx Mapper allows users to organize and manage their maps and DOMs efficiently. Key features include:

• Hierarchical organization of maps and DOMs
• Search and filter functionality for quick access
• Version control to track changes and maintain history