Getting started (SAP Compliance accelerator)
Follow the below documentation to install, configure, and run the SAP Compliance Accelerator.
Prerequisites
Component |
Description |
---|---|
Delphix Continuous Compliance Engine: Installed and Configured |
See the Support Matrices page for guidance on compatible engine versions. |
Delphix Continuous Compliance Engine: Admin User Credentials |
dxac requires Delphix Continuous Compliance admin user credentials to authenticate and deploy the scrambling metadata bundle. |
Target SAP Database: Ready State |
During deployment, dxac will try to make a JDBC connection to the Target SAP database. dxac assumes that the database-specific prerequisites have already been met. |
Target SAP Database: User Credentials |
Delphix Continuous Compliance Engine requires login credentials to authenticate with the SAP database, such as a user name & password. The specified SAP user must have sufficient read/write privileges. For more details on privileges, see Continuous Compliance SAP. |
dxac: Host Machine |
dxac requires a host to run. It can be a MacOS, Windows 10, or RHEL 7.9/8.x machine. When downloading dxac from the Delphix Downloads, make sure that you get the correct distribution for the Host Machine. |
dxac: Storage |
You must have at least 150MB of disk space on the host to install and run dxac. |
dxac: Ports, Firewall, and Connectivity |
The dxac’s runtime Host Machine must be able to connect to the Delphix Continuous Compliance Engine over ports 80 and 443. |
SAP NGDBC Driver |
A compatible SAP driver must be downloaded and installed. If you need guidance, see Continuous Compliance SAP. |
Installation
To install dxac, you must extract the tar (or zip) file into a folder of your choice. The extraction process creates a folder named dxac-sap-<os>-<version>
. It is the working directory for dxac.
Contents of dxac-sap-<os>-<version>
folder
-
3
sap/<database>/resource
folders -
The
dxac
command line tool -
Simple
README.md
file
Before you can run the dxac
tool, you must give it the execute permissions:
chmod +x dxac
Initialization
After dxac is installed and extracted, the next step is to initialize and prepare for the deployment. To initialize dxac, run the following command from the dxac directory using a terminal window (or Powershell).
./dxac config init -r ./sap/<database>/resource
Update the <database>
value with the folder name that aligns with the Target scrambling SAP application. The available options are:
-
S4_hana_1909
-
S4_hana_2020
-
oracle
For example, if scrambling a SAP S/4HANA 2020 application, specify S4_hana_2020
. Most configuration is performed within its ./sap/<database>/resource
directory.
During this step, dxac does the following within the current working directory:
-
Creates a
log
folder. -
Creates a
dxac_user.config
file.
Configuration
The dxac tool relies on three sets of configuration components: the SAP JDBC driver, dxac_user.config, and connector.properties. Each component is used differently to deploy the scrambling metadata into a Delphix Continuous Compliance Engine.
-
SAP HANA JDBC Driver: Enables the connection between the SAP HANA database and Delphix Continuous Compliance Engine.
-
If you are connecting to an Oracle database, then this step can be skipped as the Compliance Accelerator will leverage the native Oracle JDBC connection capabilities.
-
-
dxac_user.config
: Contains information to create your Compliance Application object model, such as Application name, Environment name, Driver name, and Driver class name. -
connector.properties
: Contains information to connect the created Delphix Continuous Compliance Environment and ruleset to the SAP database via the JDBC Driver.
SAP HANA JDBC Driver
If you need to install the SAP HANA JDBC Driver, then follow these steps. These steps can be ignored if using an Oracle database. The Driver installation can be performed manually or through the dxac tool. If an SAP HANA JDBC Driver has already been installed, then it can be reused. Please confirm before continuing.
Manual Installation
Automated dxac Installation
-
Download an SAP JDB Driver for a local installation or download the SAP JDBC Driver as described in these directions.
-
Copy the Driver jar file into the
../resource/jdbc_driver
folder. -
(Optional) Copy a Driver Support Plugin into the
../resource/plugin
folder -
Configure the
driver_name
,driver_class_name
, andplugin_name
(optional) parameters as specified in the following dxac_user.config section.
Once the JDBC driver and parameters are specified, we will upload the Driver in the next Deploying metadata documentation directions. For now, you can continue on with the following configuration directions.
dxac_user.config
The values in this section define the Compliance object model. We suggest using the dxac tool to set these parameters. All values are housed in dxac_user.config
file under the current working directory.
These parameters can be specified directly through the command line. For example:
$ ./dxac config update -en DEMO-ENV -an DEMO-APP
The full set of configurable parameters are listed below.
Command Line Parameters |
Description |
---|---|
-en, --environment-name |
(Recommended) Name of the Delphix Continuous Compliance Environment. |
-an, --app-name |
(Recommended) Name of the Delphix Continuous Compliance Application. |
-dn, --driver-name |
(Required) Specify an existing Driver name or the name of the Driver to be created. If uploading the JDBC Driver, this name must match the file name in the |
-dc, --driver-class-name |
(Optional) Name of the Driver class to be used while creating the driver. Only required if uploading the SAP JDBC Driver. |
-pn, --plugin-name |
(Optional) Name of the Plugin that is to be created. Only required if uploading a Driver Support Plugin. If uploading a Driver Support Plugin, this name must match the file name in the |
-cn, --cert-name |
(Recommended) Name of the certificate that is to be created. |
–help |
Show this message and exit |
To see the current default values, simply view the dxac_user.config
file.
[DEFAULT] # this is an autogenerated config file. # please don't edit it manually. # use dxac config update command to update any parameter [AcceleratorConfig] environment_name = DEMO-ENV app_name = DEMO-APP plugin_name = resource_location = ./sap/oracle/resource driver_name = Oracle connector_type = DatabaseConnector [DatabaseConfig] driver_class_name =
For more information, see dxac config documentation or run the following command:
$ ./dxac config update --help
connector.properties
This file is located under the ../resource/connector
directory and contains information to set up a Connector to the database that is being masked. Unlike the dxac_user.config
file, these values are updated directly in the connector.properties
file.
Parameters |
Description |
---|---|
connector_name |
(Optional) A user-friendly name for the connector. If no entry is provided, then a default name is assigned. |
database_type |
(Optional) The type of database: Oracle, Extended, etc. |
jdbc |
(Required) A full JDBC string to connect to the data source being masked. See below for additional details. |
schema_name |
(Optional) The Schema Name of the data source being masked. |
username |
(Required) The SAP database user with the required read/write permissions for scrambling. |
kerberos_auth |
(Optional) Enable Kerbero Authentication: true/false |
The following example shows the sample content of the connector.properties
file for SAP ECC’s Oracle and SAP S4/HANA’s HANA databases.
For Oracle
[DatabaseConnector] connector_name = DX_SAP_ORACLE_CN database_type = ORACLE jdbc = jdbc:oracle:thin:@<host name>:<port name>:<database name>schema_name = SAPSR3 username = SAPSR3 kerberos_auth = false
For HANA
[DatabaseConnector] connector_name = DX_SAP_HANA_CN database_type = EXTENDED jdbc = jdbc:sap://<host-name>:<portno>?databaseName=<database-name>schema_name = <schema name>username = <user name>kerberos_auth = false
Additional JDBC Details
The following are examples of the key parameters in a JDBC URL that Delphix Continuous Compliance Engine can use to connect to SAP.
Oracle
jdbc:oracle:thin:@<VM-name>:<port-no>:<SID>For eg :- jdbc:oracle:thin:@ecc-oracle.dlpxdc.co:1521:ODB
HANA
jdbc:sap://<host-name>:<portno>?databaseName=<database-name>For eg :- jdbc:sap://hana-1909.dlpxdc.co:30013?databaseName=S19
If you are uncertain of the correct JDBC string, then we recommend attempting to configure the connection manually through the Delphix Continuous Compliance Engine’s UI and then return to the Compliance Accelerator solution.
What’s Next?
You have now successfully installed, initialized, and configured dxac. The next step is to deploy the scrambling metadata to a Continuous Compliance Engine. For detailed instructions, see Deploying Metadata.
For in-depth details on dxac commands, refer to the Compliance Accelerator’s Config section.