-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#38: added readme files for new utils
- Loading branch information
Showing
4 changed files
with
46 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## Backup a Reso Cert API server | ||
```bash | ||
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: | ||
|
||
```bash | ||
reso-certification-utils backup -u http://localhost -p ~/Downloads | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Run a transformation on all reports of a given cert API server | ||
```bash | ||
node index.js transform -u <server base url> -p <path to the directory where we want the reports backed up> -r -b -e | ||
``` | ||
|
||
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 | ||
|
||
```bash | ||
node index.js transform -u http://localhost -r -e -b -p ~/Documents | ||
``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.