xConnect DevEx CLI plugin

The CLI estimate contacts command

Version:

The xConnect DevEx CLI plugin includes an estimate command with a contacts subcommand. This command estimates the number of contacts a purge process would delete based on the provided CutoffDays and other options.

Usage

You can use the command as follows:

sitecore xconnect estimate contacts [options]

Options

You can use the following options with the command:

Option	Required?	Description
`-c, --config`	Yes	The path to the `sitecore.json` configuration file (default: cwd). A DevEx CLI standard option.
`-n, --environment-name`	Yes	The Sitecore environment to use. Default: `default`. A DevEx CLI standard option.
`-d, --cutoffdays`	Yes	The number of days the contact has not interacted with the brand. For example, `-d 190`. Note This option is the only requirement with no default value. There is a list of restrictions for the `cutoffdays` option: The minimum available value is 180 days by default (see Configure the Cortex Processing Engine for task registration). The value must be a positive integer.
`--sp, --start-percentile`	No	The range-bound start percentile for the data extraction. For example, `--sp 0`. There is a list of restrictions for the `start-percentile` option: You must specify both the start and end percentile or none of them. The range-bound for both is between 0 and 1. The `start-percentile` must be lower than the `end-percentile`.
`--ep, --end-percentile`	No	The range-bound end percentile for data extraction. For example, `--ep 1`. There is a list of restrictions for the `end-percentile` option: You must specify both the start and end percentile or none of them. The range-bound for both is between 0 and 1. The `end-percentile` must be higher than the `start-percentile`.
`-v, --verbose`	No	Report additional diagnostic and performance data.
`-t, --trace`	No	Report additional diagnostic and performance data.
`-?, -h, --help`	No	Help for the command.

Examples

The following are examples of the estimate contacts command use:

sitecore xconnect estimate contacts -d 180

sitecore xconnect estimate contacts -d 200 --sp 0.3 --ep 0.5 -n test --trace --verbose

If you have suggestions for improving this article, let us know!