1. Overview
This is a guide on how to use ACHgenie Command-Line Interface (CLI).
CLI can help automate processes and integrate into existing business workflows.
1.1. System Requirements
CLI is available for
- Windows 11
- Ubuntu
1.2. Download
1.2.1. Windows
1.2.2. Ubuntu
ACHgenie CLI version 3.8 (for Ubuntu) is available for download from:
1.3. Installation Steps
After unzipping the zip file, place the contents in any folder.
1.3.1. License Key
For clients using the desktop, the license will be picked up automatically by the CLI.
For clients using the CLI only, place the “license.txt” file inside the CLI folder.
2. CLI Functionality
CLI provides the following functionality:
- ACH file validation
- Bulk update
2.1. CLI help
ACHgenie-CLI -h
<< ACHgenie CLI >>
Usage Guide:
-b (--bulkUpdate) : Process bulk update (default: false) -c (--configurationFile) VAL : Configuration data file. -h (--help) : Show usgae guide (default: true) -i (--inFile) VAL : Input ACH file name. -j (--json) : Output as JSON file. (default: false) -o (--outFile) VAL : Output ACH file name. -q (--quiet) : Quiet mode (default: false) -v (--validate) : Validate ACH file (default: false) -z (--version) : Version information (default: false)
To validate ACH file:
achgenie-cli.exe -v -i inputAchFile [ -o outputAchFile ]
To perform bulk update:
achgenie-cli.exe -b -c configfile -i inputAchFile -o outputAchFile
2.2. ACH file Validation using CLI
ACHgenie CLI now supports command-line validation of ACH files. This feature enables automation of ACH validation.
Here is how to run command-line validation:
achgenie-cli.exe -v -i inputAchFile [ -o outputAchFile ]
If the ACH file has validation errors, they will be displayed as text output:
2.2.1. Valiation Output as JSON
Passing in "-j" as shown below
achgenie-cli.exe -v -i inputAchFile -j [ -o outputAchFile ]
will provide JSON output.
2.2.2. Automating Validation via Command Line
Validation could be automated by invoking CLI validation when a new file is dropped in a folder.
2.3. Bulk Update using CLI
Bulk update is a command-line tool for updating certain data elements in an ACH file.
It is available in the Enterprise version.
Here is how to run the bulk update command:
achgenie-cli.exe -b -c “bulk-changes.ini” -i “input.txt” -o “updated.txt”
Here is a sample bulk update configuration file.
[fileheader]
immediate.destination = 122000661
immediate.destination.name = Nova Scotia Bank
immediate.origin = 333333333
immediate.origin.name = Bank of America
[batchheader]
company.name = Good Company
company.id = 777
odfi = 12288866
[transaction]
rdfi = 12200066
check.digit = 1
dfi = 77777
identification = 678
receiving.company.name = Hello Bank
[batchcontrol]
company.id = 777
odfi = 12288866
The above fields in their respective record types are supported at the present time.
The program will update the values provided. Remove any values that do not need to be updated.
For example, if odfi does need to be modified for batch control, then supply only the field that needs to be updated “company.id” as follows:
[batchcontrol]
company.id = 777
After performing the update, the program will recalculate the HASH values and save the updated document.
2.3.1. Scrubbing Data with Bulk Update
Bulk update can be used to scrub sensitive data.
