Installing A Driver Support Plugin

Install Driver Support jar on Masking Engine

1. Select POST /file-uploads

2. Click "Choose File" and select desired driver support jar

The response will look similar to the following with a return status of 200:

{
    "fileReferenceId": "delphix-file://upload/f_xxxx/sampleDriverSupport.jar"
}

Create Driver Support Plugin

1. Select POST /plugins
2. fileReferenceId: delphix-file://upload/f_xxxx/sampleDriverSupport.jar
3. pluginName: whatever desired name
4. pluginType: DRIVER_SUPPORT

The response will look similar to the following with a return status of 200:

{
    "pluginId": 9,
    "pluginName": "Sample Plugin",
    "pluginAuthor": "Sample Plugin Author",
    "pluginType": "DRIVER_SUPPORT",
    "originalFileName": "driverSupport.jar",
    "originalFileChecksum": "f8398c0768ecf7709c6992b3f048f9da8be640285b3ccc968973949ca3cceb02",
    "installDate": "2021-04-21T15:29:01.982+00:00",
    "installUser": 5,
    "builtIn": false,
    "pluginVersion": "1.5.0",
    "pluginObjects": [
        {
            "objectIdentifier": "1",
            "objectName": "Disable Constraints",
            "objectType": "DRIVER_SUPPORT_TASK"
        },
        {
            "objectIdentifier": "2",
            "objectName": "Disable Triggers",
            "objectType": "DRIVER_SUPPORT_TASK"
        },
        {
            "objectIdentifier": "3",
            "objectName": "Drop Indexes",
            "objectType": "DRIVER_SUPPORT_TASK"
        }
    ]
}

Info

The objectIdentifier field refers to the ID of the task. Specifying the ID of the tasks is required to enable tasks on a masking job. The order in which the tasks are returned from the API is the order in which the tasks will be executed; the objectIdentifier (task ID) has no bearing on the task execution order.

Create JDBC Driver that Uses Driver Support Plugin

1. Select POST /jdbc-drivers
2. Form the request body as follows:

{
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "fileReferenceId": "delphix-file://upload/f_xxxx/sampleJdbcDriver.zip",
    "driverSupportId": 9
}

The response will look similar to the following with a return status of 200:

{
    "jdbcDriverId": 8,
    "driverName": "HANA driver",
    "driverClassName": "com.sap.db.jdbc.Driver",
    "version": "2.4",
    "uploadedBy": "admin",
    "uploadDate": "2021-04-27T20:34:47.748+00:00",
    "checksum": "a5b7cf1323b71398e68fd583cd4f40ef8a5f4212ae94b63e95c904ed226d4c7b",
    "builtIn": false,
    "loggerInstalled": true,
    "driverSupportId": 9
}

Warning

If the referenced driver support plugin is being used by existing masking jobs that have tasks enabled, extra validation is performed. In the case of updating a driver support plugin or updating a JDBC driver to use a different driver support, the driver support plugin must implement all enabled tasks on any existing masking job. If the other driver support does not implement all enabled tasks, the update will fail. In the case of deleting a driver support plugin, the delete will fail if the driver support plugin is being used by any existing masking jobs that have tasks enabled.