Creating a custom connection - Cloud

Talend Management Console User Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Management Console
Content
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Pipelines
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks
Last publication date
2024-04-15

Procedure

  1. Open your artifact in Talend Studio.
  2. Open the Contexts view under the design workspace of your artifact.
  3. Click + under the context table.
  4. In the new row, enter the required information.

    In the Name column, enter the name of the connection parameter in the format connection_<custom-connection-type>_<custom-connection-param_name>.

    For more information on setting context parameters, refer to the Talend Studio User Guide.

  5. Publish your artifact to Talend Cloud.
    For instructions, see Publishing the Job to Talend Management Console.
  6. Open Talend Management Console.
  7. Open the Management page.
  8. Go to the Connections tab.
  9. Select the environment using the faceted search at the top of the page.
  10. Click Add connection.
  11. In the Add new connection wizard, select the workspace in which to create the connection.
    The current workspace is selected by default.
  12. Select the Custom connections from the Application drop-down list.
    The Application name is automatically set to Custom.
  13. Change the Application name to the one defined in Talend Studio.
    Note: Ensure that your custom application name differs from the predefined application that already exist in Talend Management Console.

    If you use a custom connection with the same application name as a native connection, the application name of the custom connection will be treated by Talend Management Console as if it were the native connection, therefore losing all the custom parameters previously defined and resetting the existing parameter values.

    Example

    If the connection you defined was connection_CustomConnection_CustomParameter, you must enter CustomConnection to the Application name field. This field is case sensitive.
  14. Enter a name for the connection.
  15. In the Parameters section, click Add parameter.
  16. Define the parameter keys and enter the parameter values specific to the current connection.
    • You can encrypt or decrypt the parameter values by clicking the icon next to the fields.

      Note that if you display this parameter in the task run log but need to mask it, in addition to using this icon to encrypt its value, you must configure your Remote Engine by following this procedure: Masking sensitive connection information in the task run logs.

    • As explained in the previous section, use \\ instead of \ when the value should be interpreted as a special character, for example, \t.
  17. Optional: You can reorder the parameters by clicking the arrows on the left side of the parameter fields.
  18. After all the parameter keys and values are added, click Save.