Information for: DEVELOPERS   PARTNERS   SUPPORT

Credential management for CDP connectors

You can leverage CDP-managed instances or bring your own credentials to configure CDP connectors. If you have the credentials, you can set up a limited set of connectors yourself. However, if you do not have the credentials, you can use the CDP-managed instances and use its credentials.

CDP provides the self-service credential management feature in the CDP user interface. By using this feature, you can leverage CDP-managed instances and associate them to connect to multiple source and destination connectors. You can generate credentials to connect to such instances instantaneously, without having the need to connect to any third-parties.

You can save draft connectors and test them before publishing. CDP maintains the entire infrastructure for such connectors. However, if you do not want to leverage connectors that are associated with CDP-managed instances, you can integrate your existing instances as well. To configure such connectors, contact Acquia Support.

Supported source and destination connectors

Currently, CDP supports the following connectors that support the self-service credential management feature:

Source connector

  • DW Tracker Connector

Note

For information on configuring source connectors, see Configuring sources.

Destination connectors

Note

For information on configuring destination connectors, see Configuring destinations.

Before you begin

You can provision CDP credentials for the preceding connectors. Before you integrate, review the following:

  • CDP-managed instances are not mandatory to provision connectors.
  • Your password is displayed during the credential creation process. To view your password again, you must reset your password.
  • To deactivate or delete one of your connectors, contact Acquia Support.
  • For enhanced security, CDP does not fetch credential information during the edit flow.
  • To access this feature, you must have specific role-based permission.

All CDP accounts are entitled the following number of instances for each indicated connectors:

Integration Number of Instances
AWS s3* 10
Acquia SFTP* 20
DW Tracker API 5
360 Profile API 5

*You can create unlimited number of destinations or sources. However, you can only create instances provided by Acquia CDP. The resources generated through CDP apply to the number of instances noted earlier.

If you reach your entitled number of instances, you will receive an error message when trying to provision an additional instance. If you require additional connector instances, contact Acquia Support.

User role and permissions

Users who manage data integration on your team can access the credentials management interface. Access to the credentials management interface is managed through specific user roles and permissions.

The following are the user roles and associated permissions for this feature:

Client Integration Admin (Read Only)

  • View list of connectors and connector-specific configuration and documentation (sources or destinations).
  • View the list of instances and instance-specific configuration.
  • Test credentials. This applies to only external connectors.

Client Integration Admin (Full)

  • View, add, edit, or delete connectors (sources or destinations).
  • View, add, or edit instances.
  • Regenerate credentials for instances.
  • Publish connectors.

To receive the appropriate user role and its associated permissions, contact your Acquia Account team with the username, email address, and desired permission of the users on your team that must receive access to this feature.

Creating instances

CDP allows you to create new instances or leverage existing instances. The instances that you create by using the CDP user interface are called CDP-managed instances. However, you can use your existing external instances as source or destination connectors.

A few examples where you can opt for CDP-managed instances are:

  • When you want to enable connector for DW Tracker API or 360 Profiles API.
  • When you do not have a dedicated SFTP server and have not set up an SFTP output connector.
  • When you do not have a dedicated AWS S3 account and have not set up an AWS S3 output connector.

To create an instance:

  1. Sign in to the CDP user interface.

  2. Click Integrations > Instances.

    Note

    If you do not see the Instances tab in the user interface, you do not have the correct user role associated with your account. To get access to this user role, follow the instructions in User role and permissions.

  3. Click Add Instance.

  4. In Name, enter a name for your instance.

  5. In Instance Type, select the type of instance you want to create. The appropriate credentials field populates based on the selected instance type. The available instance types are:

    • 360 Profiles
    • AWS S3
    • DW Tracker
    • SFTP Service Provision
  6. Click Save.

    CDP populates the Instance Credential fields with the instance information. The system displays the fields according to the selected instance type.

To continue configuring your integration, follow Configuring sources or Configuring destinations.

Note

You must provision your instance on the Instances tab of the CDP user interface. For outbound and inbound connectors, use the Destinations or Sources tab respectively.

Viewing all instances

CDP displays the list of all newly created CDP-managed instances on the Instances page. This page does not display any existing instances that you might want to use with your connectors. You can view the following information about the CDP-managed instances:

  • Name: The name of the instance.
  • Modified: The date when the instance was last modified. In addition, you can view the details of the user who modified the instance details.
  • Created: The date when the instance was created. In addition, you can view the details of the user who created the instance.
  • Current Status: The status of the instance. The available options are:
    • Ready to Use: The instance is configured but not used as a source or destination connector.
    • In Use: The instance is configured and used as a source or destination connector.
    • Delete Failed: The instance deletion process failed.
    • Not Provisioned: The Support team updated the details of an instance after the instance was created.
    • In Progress: The instance creation process is taking longer than the usual time. Typically, the process to create an AWS S3 instance might take more time.
    • Delete In Progress: The instance deletion process ia taking longer than usual time.
    • Failed: The instance creation process failed. To retry the provisioning of the instance, access the Edit Instance page for the failed instance, and click Retry Provision.
  • Connected To: The source or destination connector that is associated with the instance.

Configuring sources

You can leverage the CDP-managed instances or use your existing infrastructure as source connectors in CDP.

To configure a source:

  1. Sign in to the CDP user interface.

  2. Click Integrations > Sources.

  3. Click Add Integration.

  4. Select a connector of your choice. For example, DW Tracker Connector.

  5. Click Next.

  6. In Name, specify a name for the source connector.

  7. Click Next.

  8. In Instance Type, select an instance from the available options. Note that the system displays only the instance types that belong to the same category as the selected connector. In addition, CDP displays only the instances that are in the Ready to Use state.

    Note

    To edit an instance, select the instance and click Edit Instance.

  9. Click Save. The system saves the source connector in the Unpublished state.

  10. To publish the connector, click Publish. The system saves the source connector in the Active state. You can use the connector for further processing.

Viewing sources

CDP displays the list of all sources. The Sources tab displays the source connectors that are associated with either CDP-managed instances or external instances. You can view the following information about the source connectors:

  • Name: The name of the source connector.
  • Status: The status of the configured source connector. The available options are:
    • Active: The source connector is published and is already in use.
    • Unpublished: The source connector is saved but not published. Therefore, it is not in use.

Configuring destinations

You can leverage the CDP-managed instances or use your existing infrastructure as destination connectors in CDP.

To configure a destination:

  1. Sign in to the CDP user interface.
  2. Click Integrations > Destinations.
  3. Click Add Integration.
  4. Select a connector of your choice. The available destination connectors are:
  5. Click Next.
  6. In Name, specify the name for your destination connector.
  7. In Description, specify a description for your connector.
  8. Click Next.
  9. Perform the steps according to the selected destination connector. Note that the options on the Credentials tab vary according to the selected destination type. For more information, see Destination connectors.
  10. Click Save. The system saves the source connector in the Unpublished state.
  11. To publish the connector, click Publish. The system saves the source connector in the Active state. You can use the connector for further processing.

Destination connectors

SFTP CSV Connector

To create a CDP-managed instance that you want to associate with an SFTP destination connector:

  1. Perform the steps mentioned in Creating instances.

  2. In Instance Type, select SFTP Service Provision.

  3. In Allow-List Source IP Addresses, add the comma-separated IP addresses that can access the SFTP location. Note that CDP does not give access to the SFTP location by default.

    The following are the criteria to allowlist IP addresses:

    • Private IP addresses are not allowed. For example, 10.0.0.0 10.255.255.255, 172.16.0.0 172.31.255.255, 192.168.0.0 192.168.255.255
    • Domain and IP range is not allowed.
    • Subnet masks must not be less than 22. For example, xx.yyy.0.0/22.
    • IPv6 addresses are not allowed.
  4. Click Save. The system populates the following fields with new values:

    • SFTP URL Domain
    • SFTP Port
    • Username
    • Password

    Important

    The password generated at the time of provisioning is displayed once and is not visible after you navigate away from this page or reload your screen. To reset your password, click Re-generate Credentials.

  5. Note the username, password, SFTP URL domain, and port information generated during the instance provision.

To configure an SFTP destination connector:

  1. Sign in to the CDP user interface.

  2. Click Integrations > Destinations.

  3. Click Add Integration.

  4. Click SFTP CSV Connector > Next.

  5. Perform the steps as mentioned in Configuring destinations.

  6. Continue with either of the following:

    If you have an external non-CDP SFTP instance:

    1. Select SFTP External.

    2. Enter the host URL and port number.

    3. Specify your user name and password.

      Alternatively, paste the private SSH key to access the SFTP instance.

    4. To test the connection with the external SFTP instance, click Test Connection.

    5. Click Next.

    6. In Basic Parameters, do the following:

      1. Select a delimiter from the available options.
      2. Define whether you want to include the executionID column in the output file.
      3. Select a date and time format from the available options.
    7. In Advanced Parameters, do the following:

      1. Define whether you want to use a non-traditional CSF format.
      2. Select a date and time format for the output file name.
      3. Define whether you want to enable PGP encryption to your output file.
      4. Specify the extension for non-CSV format output files.

    If you have a CDP-managed SFTP instance:

    1. Select SFTP CDP.
    2. In Instance Name, select a CDP-managed instance. Note that the system displays only the instance types that belong to the same category as the selected connector. In addition, CDP displays only the instances that are in the Ready to Use state.
    3. Click Next.
    4. In Basic Parameters, do the following:
      1. Select a delimiter from the available options.
      2. Define whether you want to include the executionID column in the output file.
      3. Select a date and time format from the available options.
    5. In Advanced Parameters, do the following:
      1. Define whether you want to use a non-traditional CSF format.
      2. Select a date and time format for the output file name.
      3. Define whether you want to enable PGP encryption to your output file.
      4. Specify the file extension for non-CSV format output files.
  7. Click Save. The system saves the destination connector in the Unpublished state.

  8. To publish the connector, click Publish. The system saves the destination connector in the Active state. You can use the connector for further processing.

  9. To use the connector, click Actions > Campaigns+ and create a campaign. After you access the Destinations tab, you can search for the destination name and select the destination for your campaign.

S3 Output Connector

To create a CDP-managed instance that you want to associate with an AWS S3 destination connector:

  1. Perform the steps mentioned in Creating instances.

  2. In Instance Type, select AWS S3.

  3. Click Save. The system populates the following fields with new values:

    • Bucket Name
    • Folder Name
    • Secret Key
    • Access Key

    Important

    The keys generated at the time of provisioning are displayed once and are not visible after you navigate away from this page or reload your screen. To reset your keys, click Re-generate Credentials.

  4. Note the bucket name, folder name, secret key, and access key generated during the instance provision.

To configure an S3 destination connector:

  1. Sign in to the CDP user interface.

  2. Click Integrations > Destinations.

  3. Click Add Integration.

  4. Click S3 Output Connector > Next.

  5. Perform the steps as mentioned in Configuring destinations.

  6. Continue with either of the following:

    If you have an external non-CDP managed AWS S3 instance:

    1. Select S3 External.
    2. In AWS S3 Bucket Name, specify the name of your S3 bucket.
    3. In AWS S3 Bucket Folder Name, specify the folder name that contains your S3 bucket.
    4. In AWS Access Key, specify your AWS access key.
    5. In AWS Secret Key, specify your AWS secret key.
    6. To test the connection with the external S3 instance, click Test Connection.
    7. Click Next.
    8. In Basic Parameters, do the following:
      1. Select a delimiter from the available options.
      2. Define whether you want to enable AWS server side encryption.
      3. Select a date and time format from the available options.
    9. In Advanced Parameters, do the following:
      1. Select a date and time format for the output file name.
      2. Define whether you want to enable PGP encryption to your output file.
      3. Specify the file extension for non-CSV format output files.
      4. Define whether you want to split your output file. If you select Yes, specify the number of parts in which you want to split the file.

    If you have a CDP-managed SFTP instance:

    1. Select S3 CDP.
    2. In Instance Name, select a CDP-managed instance. Note that the system displays only the instance types that belong to the same category as the selected connector. In addition, CDP displays only the instances that are in the Ready to Use state.
    3. Click Next.
    4. In Basic Parameters, do the following:
      1. Select a delimiter from the available options.
      2. Define whether you want to enable AWS server side encryption.
      3. Select a date and time format from the available options.
    5. In Advanced Parameters, do the following:
      1. Select a date and time format for the output file name.
      2. Define whether you want to enable PGP encryption to your output file.
      3. Specify the file extension for non-CSV format output files.
      4. Define whether you want to split your output file. If you select Yes, specify the number of parts in which you want to split the file.
  7. Click Save. The system saves the destination connector in the Unpublished state.

  8. To publish the connector, click Publish. The system saves the destination connector in the Active state. You can use the connector for further processing.

  9. To use the connector, click Actions > Campaigns+ and create a campaign. After you access the Destinations tab, you can search for the destination name and select the destination for your campaign.

360 Profiles API

To configure a 360 Profiles API destination connector:

  1. Sign in to the CDP user interface.
  2. Click Integrations > Destinations.
  3. Click Add Integration.
  4. Click 360 Profiles API > Next.
  5. Perform the steps as mentioned in Configuring destinations.
  6. In Instance Name, select a CDP-managed instance. Note that the system displays only the instance types that belong to the same category as the selected connector. In addition, CDP displays only the instances that are in the Ready to Use state.
  7. Click Save. The system saves the destination connector in the Unpublished state.
  8. To publish the connector, click Publish. The system saves the destination connector in the Active state. You can use the connector for further processing.
  9. To use the connector, click Actions > Campaigns+ and create a campaign. After you access the Destinations tab, you can search for the destination name and select the destination for your campaign.

Viewing destinations

CDP displays the list of all destinations. The Destinations tab displays the destination connectors that are associated with either CDP-managed instances or external instances. You can view the following information about the destination connectors:

  • Name: The name of the destination connector.
  • Status: The status of the configured destination connector. The available options are:
    • Active: The source connector is published and is already in use.
    • Unpublished: The source connector is saved but not published. Therefore, it is not in use.
  • Description: The description for the destination connector.