Search docs.molo17.com
    A newer version of this documentation is available.
    View Latest (v2.3)

    Static Oracle XStream Gluesync Configuration

    Web UI Configuration

    Configure the following parameters in the Gluesync Web UI:

    Basic Connection Settings

    • Hostname / IP Address: DNS record or IP Address of your server

    • Port: Optional, defaults to 1521

    • Database name: Name of your database

    • Username: Username with read access to the tables

    • Password: Password belonging to the given username

    • Max connections count: Maximum number of connections the pool can instantiate

    Advanced Settings

    • Connection type: (optional, defaults to SID) Connection type used to connect to Oracle. Available types are:

      • SID

      • SERVICE_NAME

    • Timeout seconds: (optional, defaults to 60 seconds) Number of seconds to set as timeout for operations

    • Xstream server name: (defaults to GSXOUT) The name of the Xstream outbound server

    • Use wallet authentication: (defaults to false) Enables Oracle wallet authentication

    • Wallet path: (defaults to null) Path to the wallet when using wallet authentication

    Multi-Tenant Specific Settings

    For multi-tenant databases, additional settings are required:

    • CDB Name: Name of the container database

    • PDB Name: Name of the pluggable database containing the data

    REST API Configuration

    Basic Connection Setup

    curl --location --request PUT 'http://core-hub-ip-address/pipelines/{pipelineId}/agents/{agentId}/config/credentials' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: ••••••' \
    --data '{
            "hostCredentials": {
            "connectionName": "myAgentNickName",
            "host": "host-address",
            "port": 1521,
            "databaseName": "db_name",
            "username": "",
            "password": "",
            "maxConnectionsCount": 100,
            "enableTls": true,
            "certificatePath": "/myPath/cert.pem"
          },
          "customHostCredentials": {
            "connectionType": "SID",
            "xstreamServerName": "GSXOUT"
          }
    }'

    XStream-Specific Configuration

    Configure XStream-specific settings via REST API:

    curl --location --request PUT 'http://core-hub-ip-address/pipelines/{pipelineId}/agents/{agentId}/config/specific' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: ••••••' \
    --data '{
      "configuration": {
          "xstreamLowWatermarkRetentionHours": 24
      }
    }'

    Configuration Parameters

    XStream Parameters

    • xstreamLowWatermarkRetentionHours: (optional, defaults to 24 hours)

      • Controls the retention period for the lowest watermark level

      • Affects tables that have not had changes during the specified period

      • Helps manage archive log retention

    Security Parameters

    • enableTls: Enable TLS/SSL encryption

    • certificatePath: Path to TLS/SSL certificate

    • useWalletAuthentication: Use Oracle Wallet for authentication

    • walletPath: Path to Oracle Wallet

    Best Practices

    1. Connection Pool Management:

      • Set appropriate maxConnectionsCount based on your workload

      • Monitor connection usage patterns

    2. Timeout Configuration:

      • Adjust timeoutSeconds based on network latency

      • Consider longer timeouts for large data operations

    3. XStream Settings:

      • Keep default xstreamServerName unless multiple instances needed

      • Adjust xstreamLowWatermarkRetentionHours based on change frequency

    4. Security:

      • Always use TLS in production

      • Consider wallet authentication for enhanced security

    Troubleshooting

    For configuration-related issues:

    1. Verify connection parameters

    2. Check user permissions

    3. Validate XStream server name

    4. Review timeout settings

    5. Check TLS certificate if enabled

    For detailed troubleshooting steps, see XStream Troubleshooting Guide.