https://github.com/lanceengland/EdiTools

PowerShell scripts for managing and parsing EDI files
https://github.com/lanceengland/EdiTools

edi powershell x12

Last synced: 3 months ago
JSON representation

PowerShell scripts for managing and parsing EDI files

• Host: GitHub
• URL: https://github.com/lanceengland/EdiTools
• Owner: lanceengland
• License: mit
• Created: 2017-04-19T13:03:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-14T21:24:05.000Z (over 4 years ago)
• Last Synced: 2024-07-10T22:27:15.190Z (4 months ago)
• Topics: edi, powershell, x12
• Language: C#
• Size: 131 KB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• Electronic-Interchange-Github-Resources - lanceengland/EdiTools - EdiTools is a repository of PowerShell scripts for parsing EDI X12 files. (CLI utilities / Golang)

README

        
# EdiTools

EdiTools is a PowerShell module to support searching, filtering, and displaying EDI file contents.

## Design Goals

When creating EdiTools, I had specific design goals in mind:

* Fast

* Composable

* Narrow scope

* PowerShell 2 compatible

* Line-break agnostic

* Convenience properties with relevant data type

### Fast

I wanted the cmdlets to be as fast as possible without sacrificing usability. The "heavy lifting" of the file parsing is done in C\# code. PowerShell provides the usability with the pipeline and cmdlets.

### Composable

Each cmdlet works together, using the previous cmdlet output as input. For example, Get-EdiFile | Get-TransactionSet | Get-Edi835. The first cmdlets are general EDI functions, where the last cmdlet is a specific EDI format, in this case 835. The Get-Edi835 is the only format-specific cmdlet currently.

Each cmdlet exposes more properties on the output object. In addition, the first cmdlet, Get-EdiFile, support piped input from both Get-ChildItem and Select-String, to simplify searching for specific files while leveraging this module.

### Narrow scope

This is not a full-fledged EDI parser. The primary focus was an easy way to search, filter, and display EDI file contents. As such, only certain values of the segments and elements are promoted as properties.

### PowerShell 2 compatible

This is a personal constraint, but as of now, I needed the module to be PowerShell 2 compatible. As such, the C\# code is written in a .net 2.0 style. I had to avoid some newer features else it would not run on PowerShell 2.0. Once I can move the minimum supported version to at least 3.0, then I can "modernize" the C\# a bit.

### Line-break agnostic

The parsing process needed to be agnostic to "wrapped" (single line), or "unwrapped" (CR/LF, or LF-only) files

### Convenience properties with accurate data type

Certain segment/element values from the EDI file are promoted for convenience. These convenience properties are converted to data types designated in the specification.

For example, the Interchange segments ISA09 and ISA10 are interchange date and time, respectively. These properties are combined into property Interchange.Date of type System.DateTime.

## Installation

If you don't want to clone the repo, and just want to install the PowerShell module:

1. [Download the EdiTools.psm1 file](https://github.com/lanceengland/EdiTools/raw/master/PowerShell/EdiTools.psm1)

2. Save the file to c:\Users\Documents\WindowsPowerShell\Modules\EdiTools

3. Right-click on the file and choose Properties -> Click the Unblock button

4. From a PowerShell prompt, type "Import-Module EdiTools -Verbose" (the -Verbose is optional, but will give you conformation the cmdlets installed).

## Project Roadmap

Future development may include:

* Additional EDI document type functions e.g. Get-Edi999, Get-Edi837, etc.

* Move up to at least PowerShell 3.0 (once my primary use case upgrade their client machines :))

* Change Add-Type from inline C\# to referenced DLL

* Create a .net Core and PowerShell Core version?