Config (Salesforce-Compliance accelerator)
The config subgroup contains commands to initialize and configure dxac.
dxac stores configuration parameters inside the dxac_user.config file under the current working directory.
Some of these configuration parameters (driver-name, plugin-name, cert_name) refer to files within the resource directory. Please ensure 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 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.
./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 config file. |
-an, –app-name |
Sets the application name in config file. |
-dn, –driver-name |
Sets the driver name in config file. |
-dc, –driver-class-name |
Sets the driver class name in config file. |
-pn, –plugin-name |
Sets the driver extension plugin name in config file. |
-r, –resource-location |
Sets the resource location in config file (if using a non-standard resource directory.) |
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 update sub-command.
Parameter |
Description |
---|---|
-en, –environment-name |
Update the environment name in the config file. |
-an, –app-name |
Update the application name in the config file. |
-dn, –driver-name |
Update the driver name in the config file. |
-dc, –driver-class-name |
Update the driver class name in the config file. |
-pn, –plugin-name |
Update the driver extension plugin name in the config file. |
-r, –resource-location |
Update the resource location in the config file (if using a 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 the environment name in the config file. |
-an, –app-name |
Update the application name in the config file. |
-dn, –driver-name |
Update the driver name in config file. |
-dc, –driver-class-name |
Update the driver class name in the config file. |
-pn, –plugin-name |
Update the driver extension plugin name in the config file. |
-r, –resource-location |
Update the resource location in the config file (if using a non-standard resource directory.) |