DCM Input Example Tool
Overview
The Data Connection Manager (DCM) feature provides the ability to securely create, retrieve, update, delete, and synchronize Data Sources, Credentials, and Connections (Credentials linked to a Data Source). Only a small subset of these functions is accessible from the Python SDK.
The DCM Input tool example demonstrates how to use all these functions.
DCM Configuration
The DCM Input tool requires the DCM feature to be enabled in Alteryx Designer. You can do this via the Admin configuration:
- Navigate to Options > Advanced Options > System Settings.
- Navigate to the DCM > General section and select the Enable DCM for your Organization check box.
You can also enable DCM via Designer's User Settings:
- In Designer, navigate to Options > User Settings > Edit User Settings.
- Open the DCM tab.
- Select Override DCM Settings and select Enable DCM.
Please go to the DCM Documentation for more information about DCM configuration.
Prepare the DCM Connection
The DCM Input tool requires the DCM connection ID to work. To create a DCM connection, in Designer...
- Navigate to File > Manage Connections.
- By default, the Manage Connections window shows a list of available Data Sources.
- Select Credentials to check the available Credentials.
- Use the Add Credential button to create a new credential, if needed.
- Return to the Data Sources tab and select the desired Data Source from the list.
- Select Connect Credential to create a new DCM connection.
- Specify your desired Authentication Method and select a credential from the list.
- Make sure to check the box to Allow connection for SDK or this connection will not be accessible from the Python SDK.
- Select the Link button to finalize the creation of the connection.
Use the Tool
If you know the DCM connection ID, select the DCM Input tool and enter DCM connection ID in the DCM ID field.
If you don't know the connection ID...
- Select the DCM Input tool and select the Set DCM ID from Connection Manager... button.
- Select your desired Data Source and it will display the available connections.
- Select the Connect button for the connection that you want to use.
- Use the Enter new password field to specify a new password for this connection.
- Once your workflow runs, the DCM Input tool gets connection information, acquires a write-lock for it, updates the connection with a new password, and frees the write-lock.
Python SDK DCM API
A special "dcm" Provider of the PluginV2 class contains these asynchronous methods to work with DCM:
5.1 get_connection()
get_connection( conection_id: str, callback_fn: Callable)
This method retrieves connection information (including secrets) by connection ID and passes it to callback_fn function as a dictionary.
- Input parameters:
- connection_id: A connection ID.
- callback_fn: A callback function that is executed once the DCM request is executed.
- Output to the callback:
- Dict that contains connection information for the specified ID, including secret values.
5.2 get_write_lock()
get_write_lock( connection_id: str, role: str, secret_type: str, expires_in: Optional["dt.datetime"], callback_fn: Callable)
This method attempts to acquire an exclusive write lock.
- Input parameters:
- connection_id: A connection ID.
- role: A role connection parameter.
- secret_type: A secret type connection parameter.
- expires_in: (Optional) A value that asks how long the lock should be held for (in milliseconds).
- callback_fn: A callback function that is executed once the DCM request is executed.
- Output to the callback:
- Dict that contains an
expires_in value and a lock_id.
5.3 free_write_lock()
free_write_lock(connection_id: str, role: str,secret_type: str,lock_id: str,callback_fn: Optional[Callable])
This method frees a lock obtained from a previous call to get_write_lock().
- Input parameters:
- connection_id: A connection ID.
- role: A role connection parameter.
- secret_type: A secret type connection parameter.
- lock_id: Lock ID acquired from a previous call to
get_write_lock().
- callback_fn: A callback function that is executed once the DCM request is executed.
- Output to the callback:
- N/A. Exception raised upon failure.
update_connection_secret()
update_connection_secret(connection_id: str, role: str, secret_type: str, value: str, expires_on: Optional["dt.datetime"], parameters: Optional[Dict[str, str]], lock_id: str, callback_fn: Optional[Callable])
This method updates a single secret for role and secret_type to value as well as the optional expires_on and parameters.
- Input parameters:
- connection_id: A connection ID.
- role: A role connection parameter.
- secret_type: A secret type connection parameter.
- lock_id: Lock ID acquired from a call to
get_write_lock().
- value: The new value to store for the secret.
- expires_on: (Optional) Expiration of this secret.
- parameters: (Optional) Dict of parameter values for this secret. This is arbitrary user data stored as JSON.
- Output to the callback:
- N/A. Exception raised upon failure.
