npm package: @jahia/jcustomer-custom-event-checker
Description: Script that check events coming from a jCustomer to another one
Author: SINOVASSIN-NAIK Jonathan
Latest version: 0.9.0

custom-event-checker
=================

jCustomer events checker CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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.9.0 linux-x64 node-v20.14.0
$ jcustomer-custom-event-checker --help [COMMAND]
USAGE
  $ jcustomer-custom-event-checker COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`jcustomer-custom-event-checker help [COMMANDS]`](#jcustomer-custom-event-checker-help-commands)
* [`jcustomer-custom-event-checker validateEvents`](#jcustomer-custom-event-checker-validateevents)

## `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](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_

## `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> -t <value>
    [--createScopes]

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
  -t, --scrollTimeValidity=<value>  (required) [default: 2h] Period to retain the search context for scrolling query .
                                    Value in time unit
  --createScopes                    If scopes are missing, the script will attempt to create those in the remote
                                    jCustomer

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](https://github.com/Jahia/jcustomer-custom-event-checker/blob/v0.9.0/dist/commands/validateEvents/index.ts)_
<!-- commandsstop -->