Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ballerina-platform/module-ballerina-edi
Ballerina EDI runtime component
https://github.com/ballerina-platform/module-ballerina-edi
ballerina edi
Last synced: 2 months ago
JSON representation
Ballerina EDI runtime component
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerina-edi
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2023-05-04T02:47:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T11:06:44.000Z (8 months ago)
- Last Synced: 2024-04-18T02:38:34.624Z (8 months ago)
- Topics: ballerina, edi
- Language: Ballerina
- Homepage:
- Size: 1.21 MB
- Stars: 111
- Watchers: 55
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ballerina EDI Module
[](https://github.com/ballerina-platform/module-ballerina-edi/actions/workflows/build-timestamped-master.yml)
[](https://github.com/ballerina-platform/module-ballerina-edi/actions/workflows/trivy-scan.yml)
[](https://codecov.io/gh/ballerina-platform/module-ballerina-edi)
[](https://github.com/ballerina-platform/module-ballerina-edi/actions/workflows/build-with-bal-test-graalvm.yml)
[](https://github.com/ballerina-platform/module-ballerina-edi/commits/main)
[](https://github.com/ballerina-platform/ballerina-library/labels/module%2Fballerina-edi)
## Overview
Electronic Data Interchange (EDI) is a technology designed to facilitate the electronic transfer of business documents among various organizations. This system empowers businesses to seamlessly exchange standard business transactions like purchase orders, invoices, and shipping notices. These transactions are formatted in a structured, computer-readable manner, eliminating the reliance on paper-based processes and manual data entry. Consequently, EDI technology significantly boosts efficiency and minimizes errors in the business-to-business (B2B) communication landscape.
The Ballerina EDI module offers robust functionality for the effortless conversion of EDI text to JSON, and inversely, JSON to EDI. Tailored to augment integration capabilities, this module is a key component in enhancing the handling of EDI data within Ballerina applications. It provides a more streamlined, efficient approach, ensuring seamless data management and integration in business processes.
## Define EDI Schema
Before utilizing the EDI parser, it is crucial to define the structure of the EDI data intended for import. Developers can refer the [Ballerina EDI Schema Specification](./docs/specs/SchemaSpecification.md) for guidance. This specification outlines the essential elements necessary to describe an EDI schema, covering attributes such as name, delimiters, segments, field definitions, components, sub-components, and additional configuration options.
As an illustrative example, consider the following EDI schema definition for a _simple order_, assumed to be stored as "schema.json":
```json
{
"name": "SimpleOrder",
"delimiters" : {"segment" : "~", "field" : "*", "component": ":", "repetition": "^"},
"segments" : [
{
"code": "HDR",
"tag" : "header",
"minOccurances": 1,
"fields" : [{"tag": "code"}, {"tag" : "orderId"}, {"tag" : "organization"}, {"tag" : "date"}]
},
{
"code": "ITM",
"tag" : "items",
"maxOccurances" : -1,
"fields" : [{"tag": "code"}, {"tag" : "item"}, {"tag" : "quantity", "dataType" : "int"}]
}
]
}
```
This schema can be used to parse EDI documents featuring one HDR segment, mapped to _header_, and any number of ITM segments, mapped to _items_. The HDR segment incorporates three _fields_, corresponding to _orderId_, _organization_, and _date_. Each ITM segment comprises two fields, mapped to _item_ and _quantity_.
Below is an example of an EDI document that can be parsed using the aforementioned schema. Let's assume that the following EDI information is saved in a file named 'sample.edi':
```
HDR*ORDER_1201*ABC_Store*2008-01-01~
ITM*A-250*12~
ITM*A-45*100~
ITM*D-10*58~
ITM*K-80*250~
ITM*T-46*28~
```
## Reading EDI Files
The utility functions in EDI package allows you to read Electronic Data Interchange (EDI) files and convert them into JSON data. Here's a quick example demonstrating how to read an EDI file, parse it using a defined schema, and print the resulting JSON data:
```ballerina
import ballerina/io;
import ballerina/edi;
public function main() returns error? {
// Step 1: Load EDI schema from a JSON file
edi:EdiSchema schema = check edi:getSchema(check io:fileReadJson("resources/schema.json"));
// Step 2: Read the EDI file as a string
string ediText = check io:fileReadString("resources/sample.edi");
// Step 3: Convert EDI string to JSON using the specified schema
json orderData = check edi:fromEdiString(ediText, schema);
// Step 4: Print the resulting JSON data
io:println(orderData.toJsonString());
}
```
In this example, the EDI file (`sample.edi`) is read, and its content is converted into a JSON variable named `orderData`. The JSON variable structure corresponds to the expected output.
## Writing EDI Files
Furthermore, edi module provides functionality to convert JSON data into EDI text using a specified schema. The following code snippet demonstrates how to create a JSON variable representing an order and convert it into an EDI string:
```ballerina
import ballerina/io;
import ballerina/edi;
public function main() returns error? {
// Step 1: Create a JSON variable representing an order
json order2 = {
"header": {
"code": "HDR",
"orderId": "ORDER_1201",
"organization": "ABC_Store",
"date": "2008-01-01"
},
"items": [
{
"code": "ITM",
"item": "A-250",
"quantity": 12
},
{
"code": "ITM",
"item": "B-250",
"quantity": 10
} // ... Additional items ...
]
};
// Step 2: Load the EDI schema from a JSON file
edi:EdiSchema schema = check edi:getSchema(check io:fileReadJson("resources/schema.json"));
// Step 3: Convert the JSON order data to EDI string using the schema
string orderEDI = check edi:toEdiString(order2, schema);
// Step 4: Print the resulting EDI string
io:println(orderEDI);
}
```
In this example, the `order2` JSON variable is converted into an EDI string using the specified schema, and the resulting EDI string is printed. This demonstrates the capability of the Ballerina EDI module to seamlessly convert JSON data into EDI format.
## Issues and projects
The **Issues** and **Projects** tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc., visit the Ballerina library [parent repository](https://github.com/ballerina-platform/ballerina-library).
This repository only contains the source code for the package.
## Build from the source
### Prerequisites
1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:
* [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
* [OpenJDK](https://adoptium.net/)
> **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.
2. Download and install [Ballerina Swan Lake](https://ballerina.io/).
3. Download and install [Docker](https://www.docker.com/get-started).
> **Note**: Ensure that the Docker daemon is running before executing any tests.
### Build options
Execute the commands below to build from the source.
1. To build the package:
```bash
./gradlew clean build
```
2. To run the tests:
```bash
./gradlew clean test
```
3. To build the without the tests:
```bash
./gradlew clean build -x test
```
4. To debug package with a remote debugger:
```bash
./gradlew clean build -Pdebug=
```
5. To debug with the Ballerina language:
```bash
./gradlew clean build -PbalJavaDebug=
```
6. Publish the generated artifacts to the local Ballerina Central repository:
```bash
./gradlew clean build -PpublishToLocalCentral=true
```
7. Publish the generated artifacts to the Ballerina Central repository:
```bash
./gradlew clean build -PpublishToCentral=true
```
## Contribute to Ballerina
As an open-source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
## Code of conduct
All the contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
## Useful links
* For more information go to the [EDI package](https://central.ballerina.io/ballerina/edi/latest).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.