closes #38

Important

These utilities work on a server that has the changes from https://github.com/RESOStandards/reso-certification/pull/1319 merged.

Basic Usage

Backup a given Reso Cert API server

node index.js backup -u <server base url> -p <path to the directory where we want the reports backed up> -d -w

-d and-w are optional flags that specify whether to 'only backup DD/DA reports (-d)' or to 'only backup webAPI reports (-w)'. Omitting/Including both will back up everything.

Example usage:

node index.js backup -u http://localhost -p ~/Downloads

Restore from a server backup

node index.js restore -u <server base url> -p <path to the server backup directory> --restoreFromBackup

The --restoreFromBackup or -r flag tells the tool to restore from the backed-up server data rather than raw reports.

Example usage:

node index.js restore -u http://localhost -p ~/Downloads/reso-server-backup/data_dictionary-1.7 -r

Run a transformation on all reports of a given cert API server

node index.js transform -u <server base url> -p <path to the directory where we want the reports backed up> -r -b

The -b or --backup flag creates a backup of all the DD/DA reports from the given server before starting the transformation.

The -p or --pathToBackup option is required when using the backup flag.

The -r or --rescore flag is a transformation that adjusts the EMPTY_LIST/NULL_VALUE counts, rescores the report, and posts them back to the cert API server.

The -e or --runEtl flag is another transformation that takes in a DA report, converts it to raw form, and runs the ETL method on the report. This transformation will always be run last if more than one transformation is provided.

Note: It is advisable to always create a backup before running any transformations.

Example usage

node index.js transform -u http://localhost -r -b -p ~/Documents