Apache CouchDB connection

Introduction

An Apache CouchDB connection, created using the Apache CouchDB connector, establishes access to Apache CouchDB. These activities, once configured, interact with Apache CouchDB through the connection.

Create or edit an Apache CouchDB connection

A new Apache CouchDB connection is created using the Apache CouchDB connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing Apache CouchDB connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure an Apache CouchDB connection

Each user interface element of the Apache CouchDB connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Apache CouchDB connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Apache CouchDB endpoint, which refers to both a specific connection and its activities.

• URL: Enter the URL.

• Auth Scheme: Select the authorization scheme, one of:

  • Basic

    • User: Enter the user.

    • Password: Enter the password.

  • JWT

    • JWT Subject: Enter the JWT subject.

    • JWT Algorithm: Select the JWT algorithm, one of:

      • RS256

      • RS384

      • RS512

      • ES256

      • ES384

      • ES512

      • HS256

      • HS384

      • HS512

    • JWT Key Type: Select the JWT key type, one of:

      • PEMKEY_FILE

      • PEMKEY_BLOB

      • SYMMETRIC

    • JWT Key: Enter the JWT key.

    • JWT Expiration: Enter JWT expiration. Default value: -1.

    • JWT Headers: Enter the JWT headers.

    • JWT Claims: Enter the JWT claims.

    • Credentials Location: Enter the credentials location.

  • None

    • Public Databases: Enter the public databases.

• Use Proxy Settings: Select to use private agent proxy settings.

• Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

  • Add: Adds a row to the table. Enter a key-value pair for each property.
  • Submit: Saves the key-value pair to the table. Visible when hovering on a row in edit mode.
  • Discard: Discards a new row or any edits made to an existing row. Visible when hovering on a row in edit mode.
  • Edit: Allows you to edit an existing key-value pair. Visible when hovering on an existing row.
  • Delete: Deletes the row from the table. Visible when hovering on an existing row.
  • Clear All: Deletes all rows from the table.

  Important

  Fields in the Advanced Configurations table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After an Apache CouchDB connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• Query: Retrieves records from a table at Apache CouchDB and is intended to be used as a source in an operation.

• Create: Inserts a record into a table at Apache CouchDB and is intended to be used as a target in an operation.

• Update: Updates a record in a table at Apache CouchDB and is intended to be used as a target in an operation.

• Delete: Deletes a record from a table at Apache CouchDB and is intended to be used as a target in an operation.

• Execute: Executes a procedure at Apache CouchDB and is intended to be used as a target in an operation.