Skip to content

Jahia/jcustomer-custom-event-checker

Repository files navigation

custom-event-checker

jCustomer events checker CLI

oclif License

Usage

$ npm install -g @jahia/jcustomer-custom-event-checker
$ jcustomer-custom-event-checker COMMAND
running command...
$ jcustomer-custom-event-checker (--version)
@jahia/jcustomer-custom-event-checker/0.3.0 darwin-x64 node-v19.4.0
$ jcustomer-custom-event-checker --help [COMMAND]
USAGE
  $ jcustomer-custom-event-checker COMMAND
...

Commands

jcustomer-custom-event-checker help [COMMANDS]

Display help for jcustomer-custom-event-checker.

USAGE
  $ jcustomer-custom-event-checker help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for jcustomer-custom-event-checker.

See code: @oclif/plugin-help

jcustomer-custom-event-checker validateEvents

This script will get the events from a jCustomer instance and will validate them on another one.

USAGE
  $ jcustomer-custom-event-checker validateEvents -f <value> -o <value> -s <value> -d <value>

FLAGS
  -d, --limitOfDays=<value>  (required) [default: 60] Exclude events older than this flag in days
  -f, --configFile=<value>   (required) [default: ./defaultConfig.json] jCustomer JSON configuration file location
  -o, --out=<value>          (required) [default: ./errors.json] Exported file path
  -s, --step=<value>         (required) [default: 1000] Number of events to process per batch

DESCRIPTION
  This script will get the events from a jCustomer instance and will validate them on another one.
  The structure of the configuration file can be found in the defaultConfig.json file at the root of this project

EXAMPLES
  $ jcustomer-custom-event-checker validateEvents --configFile=./path/to/your/config/config.json --out=./out.json
    Start the events analysis
    Looking for configuration in file ./path/to/your/config/config.json
    Processed 315 events in 1546 ms

See code: dist/commands/validateEvents/index.ts