Config (SAP Compliance accelerator)

The config subgroup contains commands to initialize and configure dxac.

Caution

dxac stores configuration parameters inside the dxac_user.config file under the current working directory.

Some of these configuration parameters (driver-name, plugin-name) refer to files within the resource directory. Make sure that these parameters are set accurately.

Usage

Every dxac command in the config subgroup follows the below pattern:

dxac : The main cli name.
config : Indicates that you are running a command under the config subgroup.
sub-command : The sub-command you are running under config.
parameters : Required and optional parameters for the sub-command.

./dxac config <command> -option <value>

Sub-Commands

Following are the sub-commands under the config group.

Sub-Command	Description
init	Initialize dxac
get	List the current dxac configuration parameters
update	Update a dxac configuration parameter

1. init

After installing dxac, init must be the first command that you run. This command initializes dxac.

During the initialization process, dxac will:

create a log folder under the resource directory.
create a database folder under the resource directory and initialize the dxac.db.
create a user config file in the current working directory.

Recommendation

It’s a good practice to keep the dxac executable and the resource directory under the same folder.

./dxac config init -r <resource-loc>

parameters

Following are the parameters for init sub-command.

Parameter	Description
-en, –environment-name	Sets the environment name in the config file.
-an, –app-name	Sets the application name in the config file.
-dn, –driver-name	Sets the driver name in the config file. This name must match the driver zip file name under `resource/jdbc_driver` folder. If the driver is already uploaded, this name must match the driver name in the Delphix engine.
-dc, –driver-class-name	Sets the driver class name in the config file.
-pn, –plugin-name	Sets the driver extension plugin name in the config file. This name must match the plugin jar file name under the `resource/plugin` folder.
-r, –resource-location	Sets the resource location in the config file (if using non-standard resource directory).

Use single quotes when setting environment-name, app-name, and driver-name values on MacOS or Linux.

2. get

The get sub-command under config can be used to list the current dxac configuration.

./dxac config get -option

parameters

Following are the parameters for init sub-command.

Parameter	Description
-en, –environment-name	Sets the environment name in the config file.
-an, –app-name	Sets the application name in the config file.
-dn, –driver-name	Sets the driver name in the config file. This name must match the driver zip file name under the `resource/jdbc_driver` folder. If the driver is already uploaded, this name must match the driver name in the Delphix engine.
-dc, –driver-class-name	Sets the driver class name in the config file.
-pn, –plugin-name	Sets the driver extension plugin name in the config file. This name must match the plugin jar file name under the `resource/plugin` folder.
-r, –resource-location	Sets the resource location in the config file (if using non-standard resource directory).

3. update

This command can be used to update one or more of the dxac configuration parameters.

./dxac config update -option <value>

parameters

Following are the parameters for update sub-command.

Parameter	Description
-en, –environment-name	Update environment name in the config file.
-an, –app-name	Update application name in the config file.
-dn, –driver-name	Update driver name in the config file. This name must match the driver zip file name under the `resource/jdbc_driver` folder. If the driver is already uploaded, this name must match the driver name in the Delphix engine.
-dc, –driver-class-name	Update driver class name in the config file.
-pn, –plugin-name	Update driver extension plugin name in the config file. This name must match the plugin jar file name under the `resource/plugin` folder.
-r, –resource-location	Update resource location in the config file (if using non-standard resource directory.