1. GoldenGate Stream Analytics
  2. Manage
  3. Connections
  4. Create Connections

Create Connections

A connection is a collection of metadata (such as URLs, credentials, etc.,) required to connect to an external system. A connection is the basis for creation of sources (Streams, References, or Geo Fences) and Targets. You can reuse connections to create and access multiple sources, targets, or both, in the same system. For example, different Kafka topics in the same Kafka cluster, or different database tables in the same Oracle database.

GGSA supports the following connection types:
Connection Types Supported Artifacts

ADW or ATP
  • Reference
  • Target

AWS S3
  • Target

Coherence
  • Reference
  • Target

Druid
  • Target

Elasticsearch
  • Target
GoldenGate
  • Stream ( Microservices only)

HBase
  • Target

HDFS
  • Target

Hive
  • Target

Ignite Cache
  • Reference
  • Target

JMS
  • Stream
  • Target

Kafka
  • Stream
  • Target

Microsoft Azure Data Lake-Gen2
  • Target

MongoDB
  • Target

MySQL DB
  • Reference

OCI
  • Target

ONS
  • Target

Oracle AQ
  • Stream

Oracle DB
  • Reference
  • Target

OSS
  • Stream
  • Target

Creating a Connection to ADW or ATP

To create a connection to Autonomous Data Warehouse (ADW) and Autonomous Transaction Processing (ATP):

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Oracle Database from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Connect using: Select Wallet from the drop-down list.

    • Service name/SID: Enter the name of the Service, SID, or Wallet that you want to connect to.

    • Wallet Archive > Upload File: Upload the archive wallet file stored in your local machine.

      If you do not have the wallet file, you can download it from the OCI Autonomous Database console.

      After you have successfully uploaded the wallet file, all the database services configured under the wallet's tnsnames.ora will be displayed in the service list. Select one of the services based on your requirements.

    • Username: Enter the database account user name.

    • Password: Enter the password for your database account.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to AWS S3

Prerequisites:

To create a connection to AWS S3:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select AWS S3 from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Client ID: Enter the Access Key ID obtained from AWS.

    • Client Secret: Enter the Secret access key obtained from AWS.

    • Region: Region in which the S3 Bucket is already created, or in which you want to create a new bucket. See Regions and Endpoints.
  6. Click Test Connection, to ensure credentials are correct and to download the third party libraries required to connect to AWS S3.

    The download will take some time to complete, because these jars will be downloaded from maven repository, for the first time. You can track the progress in jetty logs. For the subsequent Test Connection or OSA pipeline deployment, third party jars will be available locally.

  7. Click Save.

Creating a Connection to Coherence

To create a connection to a Coherence:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Coherence from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • Server Url(s): Enter the server url(s) of the coherence cache server(s) in the following format:

      Host1:Port1,Host2:Port2

      The port is the Coherence Extend Proxy Services TCP/IP Server Socket port.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to Druid

To create a connection to Druid:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Druid from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Zookeepers: Enter the zookeeper URL.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to Elasticsearch

To create a connection to ElasticSearch:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Elastic Search from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • Server Url(s):Enter the server url(s) for the ElasticSearch server, in the format host1:port1, host2:port2.
    • Authentication Type
      • None: Select this option to disable security for the ElasticSearch cluster.
      • Basic: Select this option to secure the ElasticSearch cluster with Basic Authentication.
        • User Name: Set the authentication username.
        • Password: Set the authentication password.
      • SSL: Select this option to secure and enable ElasticSearch cluster communication over HTTPS.
        • User Name: Set the authentication username
        • Password: Set the authentication password.
        • Trust Store: Upload the truststore file.
        • Truststore Password: Set the truststore password.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to GoldenGate

To create a connection to GoldenGate:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select GoldenGate from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Service Manager Host: Enter the name or IP address of the GoldenGate Service Manager.

    • Service Manager Port: Enter the port on the Service Manager, to connect to GoldenGate.

      Set the port to 443 to create a connection to the Goldengate instance running on an OCI Goldengate stack, because you can access only port 443, by default.

    • GG Username: Enter the username to authenticate the GoldenGate connection.

    • GG Password: Enter the password for the GoldenGate connection.

    • Is SSL?: Select this option if the Goldengate instance uses a SSL based connection

    • Is GG Marketplace?: Select this option if the GG instance is running on OCI Marketplace Goldengate stack.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to HBase

To create a connection to HBase:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select HBase from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • hbase-site.xml: Upload the hbase-site. xml file. This file is used to create connection to zookeeper that manages the Hbase cluster. This file must contain zookeeper IP and port.
    • Authentication Type:
      • None: Select this option if the Hbase server does not have any authentication enabled.
      • kerberos: Select this option if the kerberos authentication is enabled for the HBase server.
    • Kerberos Principal: Enter the Kerberos principal for the Hbase service.
    • Kerberos KeyTab: Enter the kerberos keytab for the Hbase service. The keytab file has the .keytab extension.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to HDFS

To create a connection to HDFS:
  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select HDFS from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • core-site.xml: Upload the core-site.xml file with fs.defaultFS, fs.default.name, hadoop.security.authentication, and fs.AbstractFileSystem.hdfs.impl properties.
    • hdfs-site.xml : Set client-specific properties. This is an optional field.
    • Use Kerberos: To use a kerberized cluster, select this option to enable Kerberos principal and Kerberos keytab. Provide the following details:
      • Kerberos KDC
      • Kerberos Realm
      • Kerberos Principal: Set HDFS service principal.
      • Kerberos Key Tab: Upload the keytab file that has HDFS service principal
  6. Click Test Connection, to ensure that you have successfully created a connection, and to download the third-party libraries required to connect to HDFS. The libraries are also used by targets to write to HDFS paths.

    Note:

    Retain the core-site.xml and hdfs-site.xml file names exactly as they are.
  7. Click Save.

Creating a Connection to Hive

To create a connection to Hive:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Hive from the submenu.
  3. Click Connection, and select from the drop-down list.
  4. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  5. Click Next.
  6. On the Connection Details screen, enter the following details:

    • Core Site XML: Upload the core-site.xml file to connect to HDFS, where the files to create external hive table are loaded. This is a mandatory field..

    • Hdfs Site XML: Upload the hdfs-site.xml file to connect to HDFS, where the files to create external hive table are loaded. This is an optional field.

    • Use Kerberos: In case of a kerberized cluster, you can provide the Kerberos principal and keytab by enabling this option.
    • Kerberos KDC: Provide the host having the Key Distribution Center(KDC).
    • Kerberos Realm: Provide the kerberos realm.
    • Kerberos Principal: Set the Kerberos principal for the hive service.
    • Kerberos KeyTab: Upload the kerberos keytab file for the hive service.
    • Hive JDBC URL: You can connect to hive database using following jdbc url : jdbc:hive2://host:port/<DB_NAME>. The default port is 10000 and default database is "default".

    • Hive JDBC Username: Enter the username to connect to hive database. If you are using the default database, this field can be left blank.

    • Hive JDBC Password: Password used to connect to hive database. If you are using the default database, this field can be left blank.

  7. Click Test Connection, to ensure that you have successfully created a connection, and to download the third-party libraries required to connect to hive database to create an external table.
  8. Click Save.

Creating a connection to Ignite Cache

To create a connection to a Ignite Cache:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Ignite Cache from the submenu.
  3. Click Connection, and select from the drop-down list.
  4. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  5. Click Next.
  6. On the Connection Details screen, enter the following details:
    • External cache server url(s): Enter the ignite server IP address. This is a comma-separated field.
  7. Click Test Connection, to ensure that you have successfully created a connection.
  8. Click Save.

Creating a Connection to JMS

To create a connection to JMS:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select JNDI from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • JNDI Provider: Select WebLogic as the JNDI service provider.

    • Server Url(s): Enter the server url(s) for the JNDI connection, in the format host1:port1, host2:port2.

    • Username: Enter the user name for authenticating the JNDI connection.

    • Password: Enter the password for the JNDI connection.

    • Jndi Other Properties: This is not a required field for a WebLogic JMS connection.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to Kafka

To create a connection to Kafka:
  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Kafka from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Use Bootstrap: Check this box to use a bootstrap based connection.

    • Zookeepers: Enter the zookeeper URL. Use this option only if you did not select the Use Bootstrap box in the previous step.

    • Kafka bootstrap: Enter the bootstrap URL.

    • SSL: Check this box to connect to an SSL enabled Kafka cluster.

      • Truststore Location: Locate and upload the truststore file. This field is applicable only to connect to an SSL enabled Kafka cluster.

      • Truststore Password: Enter the truststore password.

    • SASL: Check this box if Kafka broker requires authentication.

      • User Name: Enter the SASL username for the Kafka broker.

        You can retrieve this information from the OCI console. This field is enabled only if you have checked the SASL option.

      • Password: Enter the SASL password, which is an authentication token that you can generate on the User Details page, of the OCI console.

        Note:

        Copy the authentication token when you create it, and save it for future use. You can not retrieve it at a later stage.

    • MTLS: Select MLTS to enable 2-way authentication of both the user and the Kafka broker.

      • Truststore: Locate and upload the truststore file. This field is applicable only to connect to an SSL enabled Kafka cluster.

      • Truststore Password: Enter the truststore password.

      • Keystore: Locate and upload the keystore file. This field is applicable only to connect to an SSL enabled Kafka cluster.

      • Keystore Password: Enter the keystore password.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to Microsoft Azure Data Lake-Gen2

To create a connection to Microsoft Azure Data Lake-Gen2:
  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select HDFS from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • core-site.xml: Upload the core-site.xml file with fs.defaultFS, fs.default.name, hadoop.security.authentication, and fs.AbstractFileSystem.hdfs.impl properties.

      Note:

      Download the files core-site.xml and hdfs-site.xmlfrom the Azure website.
    • hdfs-site.xml : Set client-specific properties. This is an optional field.
    • Use Kerberos: To use a kerberized cluster, select this option to enable Kerberos principal and Kerberos keytab. Provide the following details:
      • Kerberos KDC
      • Kerberos Realm
      • Kerberos Principal: Set HDFS service principal.
      • Kerberos Key Tab: Upload the keytab file that has HDFS service principal
  6. Click Test Connection, to ensure that you have successfully created a connection, and to download the third-party libraries required to connect to Azure Data lake-Gen2. The libraries are also used by targets to write to HDFS paths.

    Note:

    Retain the core-site.xml and hdfs-site.xml file names exactly as they are.
  7. Click Save.

Creating a Connection to MongoDB

To create a connection to MongoDB:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select MongoDB from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Connection Mode: Select the connection mode from the drop-down list:

      • Server Address List:
        • Server Address List: Connection to a list of Replicat set members or mongos. This field accepts a comma separated list of hostnames:port. For example, localhost1:27017, localhost2:27018.
          • Authentication Mechanism: Select the authentication mechanism for the connection, from the drop-down list. This is an optional field. Enter the following details for the mechanism you select:

            • Username: Enter the database account user name.

            • Password: Enter the password for your database account.

            • Credentials Source: Enter the source of the authentication credentials, typically the database that the credentials have been created in.
            • Write Concern: Enter the value in JSON format. Accepted keys are w and wtimeout. For example, {"w": "value" , "wtimeout": "number"}
      • Client URI:
        • Client URI: Set the client URI in the format: mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
        • Authentication Mechanism:
          • None: Select this option to disable connection authentication.
          • SSL Server Certificate Validation:
            • Trust Store File: Upload the truststore file.
            • Trust Store Password: Set the truststore password.
          • SSL Server/Client Certificate Validation:
            • Trust Store File: Upload the truststore file.
            • Trust Store Password: Set the truststore password.
            • Key Store File: Upload the client certificate, for a two-way SSL communication.
            • Key Store Password: Set the keystore password.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to MySQL Database

To create a connection to a MySQL Database:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Generic Database from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • database: Select a MySQL database to connect to.
    • Jdbc url: Enter the JDBC connection url to create a database connection.

      The format for a MySQL JDBC url:

      jdbc:mysql://<user>:<password>@<host>:<port>/<database>

      Replace <user>, <password>, <host>, <port>, <database> with the MySQL database username, password, hostname or IP of MySQL database server; the MySQL database server port, and database name respectively.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to OCI Object Store

To create an OCI Object Store connection:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select OCI from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • OCI User OCID: Enter the OCI user ID.

    • OCI Fingerprint : Enter the fingerprint of the API public key file that you uploaded to OCI. For example, oci_api_key_public.pem.

    • OCI Key File: Select the API private key file for signing API calls. For example, oci_api_key.pem.

    • Key Passphrase: Enter the Passphrase for the API private key file. The API key can be passphrase-protected.

    • OCI Tenancy OCID: Enter the OCID of the tenant in which the Object Store bucket is defined.

    • OCI Profile: Set the OCI profile. Default value is DEFAULT.
    • OCI Namespace: Enter the OCI namespace that spans all compartments within a region.
    • Region: Enter the region in which tenancy is created. For a list of OCI regions, refer to the Region Identifier column in the Regions and Availability Domains documentation.

    • OCI Compartment OCID: Enter the OCID of the compartment in which the ONS topic or Object Store is defined.

  6. Click Test Connection, to validate the credentials to connect to OCI, and to ensure that the dependent client libraries are downloaded from maven central repository.
  7. Click Save.

Creating a Connection to ONS

The OCI Notification Service (ONS) connection option is currently available only on the OCI Marketplace GGSA instance.

To create an ONS connection:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select OCI from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:
    • OCI User OCID: Enter the OCI user ID.

    • OCI Fingerprint : Enter the fingerprint of the API public key file that you uploaded to OCI. For example, oci_api_key_public.pem.

    • OCI Key File: Select the API private key file for signing API calls. For example, oci_api_key.pem.

    • Key Passphrase: Enter the Passphrase for the API private key file. The API key can be passphrase-protected.

    • OCI Tenancy OCID: Enter the OCID of the tenant in which the ONS topic is defined.

    • OCI Profile: Set the OCI profile. Default value is DEFAULT.
    • OCI Namespace: Enter the OCI namespace that spans all compartments within a region.
    • OCI Region: Enter the region in which tenancy is created.

      For a list of OCI regions, refer to the Region Identifier column in the Regions and Availability Domains documentation.

    • OCI Compartment OCID: Enter the OCID of the compartment in which the ONS topic or Object Store is defined.

  6. Click Test Connection, to validate the credentials to connect to OCI, and to ensure that the dependent client libraries are downloaded from maven central repository.
  7. Click Save.

Note:

To integrate with OCI Notification service, you have to define an OCI Notification service topic. Once you have defined a topic, note down the following parameters that are required to send Messages from GGSA to OCI Notification:
  • My Message: The message that target pushed to OCI Notification service topic.
  • Topic: The topic created on OCI Notification service. The OSA target can publish message to this topic.
  • Email, Function, HTTPS, Slack: The subscriptions to the topic. All users who have subscribed to the topic receive the message.

Creating a Connection to Oracle AQ

To create a connection to Oracle Advanced Queue (AQ):

  1. On the Catalog page, click Create New Item
  2. Hover the mouse over Connection and select JNDI from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • JNDI Provider: Select Oracle AQ as the JNDI service provider.

    • Server Url(s): Enter the server url(s) for the JNDI connection, in the format host1:port1, host2:port2.

    • Username: Enter the user name to authenticate the JNDI connection.

    • Password: Enter the password for the JNDI connection.

    • Jndi Other Properties: This value should always be:

      • sid=<sid>. For example, sid=XE

        or

      • service_name=<service_name> For example, service_name=slc.us.oracle.com.
  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to Oracle Database

To create a connection to Oracle Database:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Oracle Database from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Connect using: Select the database identifiers from the drop-down list.

    • Service name/SID: Enter the name of the Service, SID, or Wallet that you want to connect to.

    • Host name: Enter the host name on which the database is running.

    • Port: Enter the port on which the database is running. It is usually 1521.

    • Username: Enter the database account user name.

    • Password: Enter the password for your database account.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.

Creating a Connection to OSS

To create a connection to OSS:

  1. On the Catalog page, click Create New Item.
  2. Hover the mouse over Connection and select Kafka from the submenu.
  3. On the Type Properties screen, enter the following details:
    • Name: Enter a unique name for the connection. This is a mandatory field.
    • Display Name: Enter a display name for the connection. If left blank, the Name field value is copied.
    • Description
    • Tags
    • Connection Type: The selected connection is displayed.
  4. Click Next.
  5. On the Connection Details screen, enter the following details:

    • Use Bootstrap: Check this box to use a bootstrap based connection. This is mandatory for OSS connections. Connection to OSS can only be established using the Bootstrap server option.

    • Kafka bootstrap: Enter the bootstrap URL.

    • SSL: Do not check this box when connecting to OCI Streaming Service.

    • SASL: Check this box if Kafka broker requires authentication. This is mandatory for OSS connections.

    • User Name: Enter the SASL username for the Kafka broker, in the following format:

      tenancyName/username/stream pool id

      Note:

      Enter the tenancyName and userName, not tenancy OCID and user OCID. Similarly, enter the stream pool ID and not the stream pool name. Ensure that the auto create topic is enabled for the stream pool ID.

      You can retrieve this information from the OCI console. This field is enabled only if you have checked the SASL option.

    • Password — Enter the SASL password, which is an authentication token that you can generate on the User Details page, of the OCI console.

      Note:

      Copy the authentication token when you create it, and save it for future use. You can not retrieve it at a later stage.

  6. Click Test Connection, to ensure that you have successfully created a connection.
  7. Click Save.