SIS Liberty Command Line Usage

In order to use SIS Liberty on the command line you will need to have it fully configured, if SIS Liberty is not configured you will need to go through the setup described in the user manual.

Once SIS Liberty is set up you can use the command line to run extracts, or schedule these tasks.

From the command line (or from a batch file, or as the Action in a scheduled
task) SIS Liberty uses the following syntax:

Usage:
sislib_ui.exe command [--switches] [--argument=value]

Valid command arguments:
[ run ]
[ params ]

Valid optional switches:
[ --all ]
[ --demo ]
[ --att ]

Valid optional arguments:
[ --school=(argument) ]
[ --bridges=(argument) ]
[ --builders=(argument) ]
[ --recipients=(argument) ]
[ --destinations=(argument) ]
[ --paramkey=(paramkey) ] only usable with [ params ] call and currently only supports --paramkey=datasets

To run an extract exactly as if you hit the Start button from the Run tab:
Run
sislib_ui.exe run

Optional switches:
--all : run extracts for attendance and demographic data (assumed if not included)
--demo : run extracts with only demographic data
--att : run extracts with only attendance data

Optional arguments:
--sites=[list of sites] : process a selection of sites (schools) this should be a comma separated list of the serial numbers for each school (listed in the license files)
ex.: sislib_ui.exe run –sites=1102,1103
This would only run all applications that are licensed for sites 1102, and 1103

--licenses=[list of files] : process a selection of license files (schools) this should be a comma separated list of the license paths for each school (paths to the license files)
ex.: sislib_ui.exe run –sites=”C:\Demo High.paf”,“c:\Demo Elementary.paf”
This would only run all applications that use these license

--datasets=[list of dataset keys comma separated] : process as a run (based on other params) but only include recipients that use a dataset key given in this list. This should be a comma separated list of dataset keys, this list can be obtained by running a params call (see below)
ex.: sislib_ui.exe run --datasets=86,87
This would only run recipients that use dataset 86 or 87

Application switches:
--bridges=[true | false]: run bridges if true, skip bridges if false
ex.: sislib_ui.exe run --bridges=false
would not run bridges, but run all other applications

--builders=[true | false] : run builders if true, skip builders if false
ex.: sislib_ui.exe run --builders=false
would not run builders, but run all other applications

--recipients=[true | false] : run recipients if true, skip recipients if false
ex.: sislib_ui.exe run --recipients=false
would not run recipients, but run all other applications

--destinations=[true | false] : run destinations if true, skip destinations if false
ex.: sislib_ui.exe run --destinations=false
would not run destinations, but run all other applications

Params
sislib_ui.exe params --paramkey=[paramkey]

The params command obtains a list of elements for a given paramkey. Currently only datasets is supported. You must include the --paramkey= argument to get results.
Optional switches: None
Optional arguments:
--paramkey=[datasets]: obtain a list of elements for a given paramkey
ex.: sislib_ui.exe params --paramkey=datasets
would get a list of current datasets

The results of this call will be: If less than 10 datasets: the information will appear in a popup message. The data will appear in a table with Key, Name listed. If 10 or more datasets: the information will be saved to a file found in the current run directory. A popup message will indicate where this file is located. The file name will be datasets.txt or datasets_[timestamp].txt if there is trouble saving.