elisctl 2.0.0

Command line interface for controlling ELIS

elisctl

elisctl is a set of tools that wrap the Elis Document Management API to provide an easy way to configure, integrate and customize Elis - either interactively or programmaticaly.

Installation

Windows

Download an installation file from GitHub releases. Install it. And run it either from start menu or from command prompt.

UNIX based systems

Install the package from PyPI:

pip install elisctl

How to use

Individual Elis operation are triggered by passing specific commands to elisctl. Commands are organized by object type in a tree-like structure and thus are composed of multiple words (e.g. user create or schema transform).

The elisctl tool can be either used in a command line interface mode by executing each command through elisctl individually by passing it as an argument, or in an interactive shell mode of executing elisctl without parameters and then typing the commands into the shown prompt.

So either get the list of commands and execute them immediately such as:

elisctl --help
elisctl configure

or run the interactive shell by simply running

elisctl

Edit Schema

Some of the most common advanced operations are related to setting up the sidebar-describing schema according to business requirements. Using elisctl you can edit schema easily as a JSON file.

List queues to obtain schema id:

elisctl queue list
  id  name                           workspace  inbox                                       schema  users
----  ---------------------------  -----------  ----------------------------------------  --------  ----------------------
   6  My Queue 1                             6  [e-mail]                    7  27

Download schema as a json:

elisctl schema get 7 -O schema.json

Open schema.json file in you favourite editor and upload modified version back to Elis.

elisctl schema update 7 schema.json

From now on, documents will follow new schema.

As an experimental feature, you can also edit schema as an Excel (xlsx) file.

elisctl schema get 7 --format xlsx -O schema.xlsx
elisctl schema update 7 --format xlsx schema.xlsx

Schema Transformations

In addition, there is a scripting support for many common schema operations, that may be easily used for schema management automation. See elisctl schema transform and elisctl tools tools for further reference.

Run something like:

elisctl schema transform default_schema.json substitute-options centre <( \
   elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 --sheet 1 | elisctl tools csv_to_options - ) \
 | elisctl schema transform - substitute-options gl_code <( \
    elisctl tools xls_to_csv ~/Downloads/ERA_osnova_strediska.xlsx --header 0 | elisctl tools csv_to_options - ) \
 | elisctl schema transform - remove contract \
 > era_schema.json

License

MIT

Contributing

• Submit a pull request from forked version of this repo. And select any of the maintainers as a reviewer.
• Use pre-commit to avoid linting issues.
• When releasing, run in master branch:

  bumpversion minor
  git push
  git push --tags
  

Changelog

2019-03-08 v1.1.1

• Fixed bug with UnicodeDecodeError in elisctl schema get ID -O file.json on Windows

2019-03-03 v1.1.0

• Added support for python 3.6
• Added User-Agent header (elisctl/{version} ({platform})) for every request to ELIS API
• Improved error when login fails with the provided credentials