Headless Mode (Automation)
Headless mode for ReadySuite is an automation toolkit for running script packs, enabling you to automate common features of ReadySuite with functionality available in script packs. With headless mode, you can import one or more load files, execute a script pack, and optionally export new load files and/or script report files.
All functionality available when using scripts is available in headless mode, as well as the ability to create your own scripts.
To run headless mode
-
From your ReadySuite installation folder (example: C:\Program Files\Compiled\ReadySuite), run readysuite-cmd.exe
To view headless mode help
-
In the Command Prompt window, type
readysuite-cmd.exe--help
|
Command (short form) |
Command (long form) |
Description |
|---|---|---|
| -i=VALUE | File to import (*.dat, *.opt). Default import mode Create (Allows only new files to be uploaded to the ReadySuite workspace.) | |
| -c | --create | Use with i command for Create mode -ci [FILE NAME] (Allows only new files to be uploaded to the ReadySuite workspace.) |
| -o | --overlay | Use with i command for Overlay mode -oi [FILE NAME] (Requires files to match an existing file in the ReadySuite workspace to be uploaded.) |
| -b | --both | Use with i command for Create Overlay mode -bi [FILE NAME] (Enables new files and those matching an existing files in the ReadySuite workspace to uploaded.) |
| -v | --version --result[=VALUE] |
Prints current application version optional output load file |
| -d | --workdir=VALUE | Sets working directory |
| -r | --reports=VALUE | Sets output folder for script reports |
| -s | --scripts=VALUE | The script pack profile |
| -h | --help | Displays Headless Mode help |
To use headless mode
- Open the Script Pack dialog box and create the script pack you want to automate with headless mode.
- In the Command Prompt, type
readysuite-cmd.exe -i[file path of imported load file (You can specify a single file or multiple files to open. When specifying multiple files, you can choose the creation and/or overlay modes for those files.)]-s [script pack]
Example Uses of Headless Mode
Example 1
readysuite-cmd - FILE_dat -oi FILE_2.dat -i FILE_3.dat -S Scripts.scp
Imports FILE_1.dat in Create mode, FILE_2.dat in Overlay mode, FILE_3 in Create mode and runs scripts defines in Scripts.scp on imported set.
Example 2
readysuite-cmd -i C:\Data\ENR001\ENR001.dat -io C:\DATA\ENR001\ENR001.opt
In a document volume (C:\Data\ENR001) with a Concordance file (ENR001.dat) and a Opticon load file (ENR001.opt) , opens and reads all the records from ENR001.dat and overlays all the records from ENR001.opt to the first file.
Example 3
readysuite-cmd -i ENR001.dat -io ENR001.opt -d C:\DATA\ENR001
Specifies a working directory to Example 2 to make referencing multiple files simpler.
Example 4
readysuite-cmd -i ENR001.dat -io ENR001.opt -d C:\DATA\ENR001 -s ValidateProd.csp -r Results
Runs the pack "ValidateProd" with the files in the previous examples and saves any report file(s) generated by the scripts in it.
Example 5
readysuite-cmd -i ENR001.dat -s EditLoadFiles.csp -o ENR001_2.dat
Opens the ENR001.dat load file, runs all the scripts defined in the "EditLoadFiles" pack (such as truncating fields) and saves a new load file to ENR001_2.dat with the same fields plus any new fields created.