freight-trust-xml/README.md

XSD schemas for XML messages for supply chain and logistics companies utilizing AS2/MQ

# Freight Trust Network XML Message Schemas

## Version

LTS: 2020-09

> XSD Schema files for XML-based Messages on the Freight Trust Network

## Overview

Usage for generating Java Classes, validating, parsing, etc.

### Tested Against:

<!-- You can find specific versioning information used here at https://gist.github.com/sambacha/116b0dfc5c99cc8905545d63002b8f94 -->

|     Version     |        Build         | Date <br>(yyyy-mm-dd) |
| :-------------: | :------------------: | :-------------------: |
| Version 2020-09 | c70743634dcf6878b7e5 | 2020-09-05T01:01:01Z  |

### Proposal Responsibility

| Person    | Contact Info                | Responsibility |
| --------- | --------------------------- | -------------- |
| @sambacha | sam@freightrust.com         | Maintainer     |
| support   | support@freight.zendesk.com | Helpdesk       |

## Schemas

_Overview of Main XSD Schemas_

Click to see file details:

<details>
  <summary>Native.xsd</summary>
  <br>

Native XSD Schema file for the subset of Native**\$files**

  <hr>
</details>

<details>
  <summary>Universal.xsd</summary>
  <br>

Universal XSD Schema file for the subset of Universal**\$files**

  <hr>
</details>

<details>
  <summary>$file*xsd.xml</summary>
  <br>

These are auto-generated files for use in testing only

  <hr>
</details>

## Usage

XSD XML Reference files for Validation of XML-based Messages sent on the Freight Trust Network

_For further deployment templates and options see:_ [Deployment Documentation](docs/deployment.md)

| Method  | Import   |
| ------- | :------- |
| Altova  | Standard |
| EDIZone | Native   |

## Change Log

- 2020-09 Release

[Improvement Change Log](CHANGELOG.md)

## Other Information

Contact: sam@freighttrust.com

### Additional Support documentation

_See the following for additional support documentation related to building and managing process projects:_

1. [Best Practices and Documentation Patterns](docs/patterns.md)
1. [Helper Scripts and Snippets](docs/helpers.md)

### Terminology

A list of terms used by this project.

| Term        | Acronym               | Definition                     |
| ----------- | --------------------- | ------------------------------ |
| Native\*    | Native**FileName**    | Native of Freight Trust        |
| Universal\* | Universal**FileName** | Universal File (subset of X12) |

## License

Mozilla Public License 2.0 Customers of the platform can request a difference source license if so desired.