qacli validate config

Manage the configuration of the Helix QAC project within Validate.

Usage

validate config  {-c|-u|-d|-s|-a <ENABLE|DISABLE>|-D <ENABLE|DISABLE>|-S <ENABLE|DISABLE>} -P <directory> [-U <[protocol://]host:port>] [-b <Validate project/stream>] [-r <REPLACE|UPDATE|MERGE>] [--] [-h]

Extended Description

Helix QAC project configuration is stored on the Validate ‘connected’ project. This command allows that configuration to be stored (push) and retrieved (pull) and synced i.e. the pulling of the RCF.

Helix QAC project configuration is stored on the Validate ‘connected’ project. This command allows that configuration to be stored (push) and retrieved to an existing Helix QAC project (pull), synced i.e. automatic or manual the pulling of the RCF. A Helix QAC project can also be created from a Validate project.

All commands, except --create, must have previously set up a link to a Validate project. See qacli validate connect for more details.
Configuration data cannot be stored in a Validate stream. It will be stored in the parent project.

Options

Name, shorthand Default Description
‑‑create, ‑c   Create a local Helix QAC project from the previously stored Validate project/stream, then connect both projects.
‑‑help, ‑h   Displays usage information and exits.
‑‑ignore‑rest, ‑‑   Ignores the rest of the labeled arguments following this flag.
‑‑auto‑sync, ‑a ENABLE Automatically synchronize the RCF from the Validate 'connected' project, before every analysis.
‑‑auto‑sync‑diags, ‑D ENABLE Automatically synchronize diagnostics from the Validate 'connected' project/stream.
‑‑auto‑sync‑suppressions, ‑S ENABLE Automatically synchronize suppressions from the Validate 'connected' project/stream.
‑‑qaf-project, ‑P  

Specify a path to a valid Helix QAC project to act upon.
‑‑validate‑project, ‑b   Name of the Validate project/stream to use when creating a Helix QAC project whose configuration is stored on Validate.
‑‑push, ‑u   Push the Helix QAC project configuration into the Validate 'connected' project/stream.
‑‑pull, ‑d   Pull and use the Helix QAC project configuration from the Validate 'connected' project/stream.
‑‑sync, ‑s   Synchronize the RCF from the Validate 'connected' project/stream.
‑‑rcf‑update‑method, ‑r  

When synchronizing the RCF this option specifies how the RCF is imported. Choose one of:

  • MERGE : Merge rules from both local and the incoming RCF (Default).
  • REPLACE: Replace RCF with the incoming RCF from Validate.
  • UPDATE: Update RCF, replacing mappings for existing components.
‑‑url, ‑U   URL of the Validate server. By default the http protocol is assumed. Examples include; localhost:80, 127.0.0.1:8080, https://prometheus:8888

Examples

Send a Helix QAC Configuration into a Connected Validate Project

To push a Helix QAC configuration, from a project (in the current directory) to an existing connected project on the Validate server, issue a command such as:

qacli validate config -P . ––push

All the configuration files for the Helix QAC project will be now stored in the Validate project.

Create a Helix QAC Project from a Connected Validate Project

To push a Helix QAC configuration, from a project (in the current directory) to an existing connected project on the Validate server, issue a command such as:

qacli validate config -P local_project --create --url http://validate_server:8080/ --validate-project validate_project

A new Helix QAC project will be created in the specified location, pulling its configuration from the Validate project.

Retrieve and Use a Helix QAC Configuration from a Connected Validate Project

To create a Helix QAC project from an existing project on the Validate server, issue a command such as:

qacli validate config -P . --pull

All the configuration files for the Helix QAC project that are stored in the Validate project will now be retrieved and used.

Retrieve and Use Configuration (RCF) from a Connected Validate Project

To synchronize configuration (RCF), into an existing Helix QAC project (in the current directory) from an existing connected project on the Validate server, issue a command such as:

qacli validate config -P . --sync

The RCF for the Helix QAC project, stored in the Validate project will be merged with the local RCF. Other merge methods are available, for example to replace the local RCF with the RCF from the Validate project:

qacli validate config -P . --sync --rcf-update-method REPLACE

Disable the Automatic Synchronization of the RCF Before Analysis

To disable the synchronization of the RCF from Validate before analysis begins then set the option to DISABLE (or ENABLE to enable it):

qacli validate config -P . –-auto-sync DISABLE

Only the local RCF will be used during analysis.