Configuring an External System as a Source or Target

When you create or edit a Micro-Integration you must supply the appropriate connection details for the external system. For details about how to configure the source or target parameters for your external system, see the vendor-specific sections linked below:

To configure your event broker service, see Configuring Your Event Broker Service as a Source or Target.

Amazon SNS

You can configure Amazon SNS only as a target . The parameters are described in the following tables:

For message headers, see Amazon SNS Message Headers.

Amazon SNS Target Parameters

The following table describes the parameters for configuring Amazon SNS as a target.

Field Description
AWS Region The AWS region for this SNS topic.

Authentication Scheme

The authentication scheme to use when connecting to Amazon SNS. One of:

  • AWS Access Key—Additional configuration is required. For more information, see AWS Access Key.

  • AWS Chained IAM Role Assumption—Additional configuration is required. For more information, see AWS Chained IAM Role Assumption.

Authentication using AWS Chained IAM Role Assumption is supported only for event brokers hosted on AWS.

Destination

The SNS ARN (Amazon Resource Name) or target SNS topic name.

If you provide the SNS topic name:

  • If the SNS does not exist, the Micro-Integration attempts to create the SNS and then returns its ARN.

  • If the SNS already exists, the Micro-Integration returns the ARN for the existing SNS.

You should be aware that when you provide the SNS topic name, the account configured for the Micro-Integration must have the necessary SNS create permissions, otherwise the creation process fails due to insufficient access.

For example, you can specify an ARN value as follows:

arn:aws:sns:us-east-2:123456789012:MyTopic

Amazon SNS Authentication Parameters

The tables that follow describe the parameters required for the selected authentication scheme. You can choose one of:

AWS Access Key

Field Description
AWS Access Key An access key identifier.
AWS Secret Key The secret key associated with the AWS Access Key.

AWS Chained IAM Role Assumption

Chained IAM role assumption allows Micro-Integrations to securely access AWS resources across different AWS accounts without requiring direct credential exchange. Chained IAM role assumption works through a trust relationship between AWS accounts:

  • The resource owner creates an IAM role (solace-mi-workload-role) in their AWS account, and configures it with the specific permissions required.

  • This role is configured to trust the Solace AWS account's role (single-pod-identity-role).

  • When a Micro-Integration needs to access the resource, it uses the trust chain to temporarily assume the necessary permissions, as follows:

    [Assume single-pod-identity-role] → [Get credentials to assume solace-mi-workload-role] → 
[Assume solace-mi-workload-role] → [Get credentials to access the target vendor resource] → 
[Access the resource]

The resource owner must do the following:

  1. Create a role called solace-mi-workload-role in the resource owner's AWS account and attach the following trust policy:

    {
  "Version":"2012-10-17",
  "Statement":[{
    "Effect":"Allow",
    "Principal":{
      "AWS":"arn:aws:iam::718462147973:role/single-pod-identity-role"
     },
    "Action":[
     "sts:TagSession",
     "sts:AssumeRole"
     ]
  }]
}
  2. Attach the required resource permissions to the solace-mi-workload-role. The minimum required permissions are:

    • sns:Publish

    • sns:ListTopics

    • sns:CreateTopic

The following table describes the parameters for configuring authentication using chained IAM role assumption.

Field Description
AWS Account ID  The 12-digit AWS Account ID to be used for IAM role assumption. This is the account where the solace-mi-workload-role exists.
Session Name

The session name to use for the assumed role session (defaults to solace-mi-workload-session if not provided)
External ID

An optional external ID to use if the resource owner's trust policy requires it.

To configure it, the resource owner must separate the sts:TagSession and sts:AssumeRole into different statements in the solace-mi-workload-role trust policy and add the following condition to the sts:AssumeRole statement:

"Condition":{
  "StringEquals":{
    "sts:ExternalId":"<your_external_id_string>"
   }
 }

Amazon SQS

You can configure Amazon SQS as either a source or a target. The parameters are described in the following tables:

For message headers, see Amazon SQS Message Headers.

Amazon SQS Source Parameters

The following table describes the parameters for configuring Amazon SQS as a source.

Field Description
AWS Region The AWS region for this SNS topic.
Authentication Scheme

The authentication scheme to use when connecting to Amazon SNS. One of:

  • AWS Access Key—Additional configuration is required. For more information, see AWS Access Key.

  • AWS Chained IAM Role Assumption—Additional configuration is required. For more information, see AWS Chained IAM Role Assumption.

Authentication using AWS Chained IAM Role Assumption is supported only for event brokers hosted on AWS.

Queue Name The source SQS queue name.

Amazon SQS Target Parameters

The following table describes the parameters for configuring Amazon SQS as a target.

Field Description
AWS Region The AWS region for this SNS topic.
Authentication Scheme

The authentication scheme to use when connecting to Amazon SNS. One of:

  • AWS Access Key—Additional configuration is required. For more information, see AWS Access Key.

  • AWS Chained IAM Role Assumption—Additional configuration is required. For more information, see AWS Chained IAM Role Assumption.

Authentication using AWS Chained IAM Role Assumption is supported only for event brokers hosted on AWS.

Queue Name The target SQS queue name.

Amazon SQS Authentication Parameters

AWS Access Key

Field Description
AWS Access Key An access key identifier.
AWS Secret Key The secret key associated with the AWS Access Key.

AWS Chained IAM Role Assumption

Chained IAM role assumption allows Micro-Integrations to securely access AWS resources across different AWS accounts without requiring direct credential exchange. Chained IAM role assumption works through a trust relationship between AWS accounts:

  • The resource owner creates an IAM role (solace-mi-workload-role) in their AWS account, and configures it with the specific permissions required.

  • This role is configured to trust the Solace AWS account's role (single-pod-identity-role).

  • When a Micro-Integration needs to access the resource, it uses the trust chain to temporarily assume the necessary permissions, as follows:

    [Assume single-pod-identity-role] → [Get credentials to assume solace-mi-workload-role] → 
[Assume solace-mi-workload-role] → [Get credentials to access the target vendor resource] → 
[Access the resource]

The resource owner must do the following:

  1. Create a role called solace-mi-workload-role in the resource owner's AWS account and attach the following trust policy:

    {
  "Version":"2012-10-17",
  "Statement":[{
    "Effect":"Allow",
    "Principal":{
      "AWS":"arn:aws:iam::718462147973:role/single-pod-identity-role"
     },
    "Action":[
     "sts:TagSession",
     "sts:AssumeRole"
     ]
  }]
}
  2. Attach the required resource permissions to the solace-mi-workload-role. The minimum required permissions are:

    • sqs:GetQueueAttributes

    • sqs:GetQueueUrl

    • sqs:SendMessage

    • sqs:ReceiveMessage

    • sqs:DeleteMessage

The following table describes the parameters for configuring authentication using chained IAM role assumption.

Field Description
AWS Account ID  The 12-digit AWS Account ID to be used for IAM role assumption. This is the account where the solace-mi-workload-role exists.
Session Name

The session name to use for the assumed role session (defaults to solace-mi-workload-session if not provided)
External ID

An optional external ID to use if the resource owner's trust policy requires it.

To configure it, the resource owner must separate the sts:TagSession and sts:AssumeRole into different statements in the solace-mi-workload-role trust policy and add the following condition to the sts:AssumeRole statement:

"Condition":{
  "StringEquals":{
    "sts:ExternalId":"<your_external_id_string>"
   }
 }

Azure Service Bus

You can configure Azure Service Bus as either a source or a target.

Azure Service Bus offers different service tiers, each with varying capabilities. We've tested the Premium tier with this Micro-Integration and it meets the expected performance throughput. In addition, even though the Azure Service Bus offers large message sizes of 80 MB and above, you cannot use message sizes larger than:

  • 30 MB for PubSub+ event broker services (Enterprise service classes)
  • 10 MB for PubSub+ event broker services (Developer service class).

Ensure that you select an Azure Service Bus tier that meets your requirements for performance throughput. For more information about tier differences, see Azure Service Bus Premium messaging and Azure Service Bus Quotas.

The parameters are described in the following tables:

For message headers, see Azure Service Bus Message Headers.

Azure Service Bus Source Parameters

The following table describes the parameters for configuring Azure Service Bus as a source.

Field Description

Service Bus Namespace Connection String

The Azure Service Bus connection string.

The connection string must provide either:

  • a Shared Access Key (SharedAccessKeyName and SharedAccessKey)

  • OR, a Shared Access Signature (SharedAccessSignature)

For details, see Connection String Authentication.

AMQP connection strings are not supported.

Destination Type

The type for the Azure Service Bus destination, which can be an Azure TOPIC or QUEUE.

Destination

The source destination.

Subscription

The subscription name for the group consumer.

Azure Service Bus Target Parameters

The following table describes the parameters for configuring Azure Service Bus as a target.

Field Description

Service Bus Namespace Connection String

The Azure Service Bus connection string.

The connection string must provide either:

  • a Shared Access Key (SharedAccessKeyName and SharedAccessKey)

  • OR, a Shared Access Signature (SharedAccessSignature)

For details, see Connection String Authentication.

AMQP connection strings are not supported.

Destination

The target destination.

Google Cloud Pub/Sub

You can configure Google Cloud Pub/Sub as either a source or a target. The parameters are described in the following tables: 

For message headers, see Google Cloud Pub/Sub Message Headers.

Google Cloud Pub/Sub Source Parameters

The following table describes the parameters for configuring Google Cloud Pub/Sub as a source.

Field Description
Project ID The Google Cloud project identifier.
Credentials The Google Cloud Application Default Credential (ADC). The maximum length is 10000 characters.
Destination The Google Cloud Pub/Sub topic name.
Subscription Name The Google Cloud Pub/Sub subscription name.
Auto-Create Resources The option to auto-create the Google Cloud Pub/Sub topic and/or subscription if it doesn't exist. The option is disabled by default.

Google Cloud Pub/Sub Target Parameters

The following table describes the parameters for configuring Google Cloud Pub/Sub as a target.

Field Description
Project ID The Google Cloud project identifier.
Credentials The Google Cloud Application Default Credential (ADC). The maximum length is 10000 characters.
Destination The Google Cloud Pub/Sub topic name.
Auto-Create Resources The option to auto-create the Google Cloud Pub/Sub topic if it doesn't exist. The option is disabled by default.

IBM MQ

You can configure Google Cloud Pub/Sub as either a source or a target. The parameters are described in the following tables: 

For message headers, see IBM MQ Message Headers.

IBM MQ Source Parameters

The following tables describe the parameters for configuring IBM MQ as a source. The parameters differ depending on whether you choose to use a native connection or a JNDI lookup.

Native Connection

Field Description
Connection Name The name of the connection to IBM MQ, such as the hostname or IP address. For example, 123.123.123.123 (1414), where 123.123.123.123 is the host and 1414 is the port.
Username The username to authenticate with IBM MQ.
Password The password to authenticate with IBM MQ.
Queue Manager The name of the queue manager on IBM MQ. For example, QM1.
Channel The channel on IBM MQ. For example,DEV.APP.SVRCONN.
Additional Connection Properties

(Optional) The IBM MQ connection properties (refer to the IBM MQ documentation). Click Add Context if you need to specify additional context properties.
Destination Type Select TOPIC or QUEUE when the destination name is known, otherwise use UNKNOWN for a JNDI lookup.
Destination The binding identifier of the queue in IBM MQ. For example, my-ibmmq-target-queue_mqConnector_mq_sourceQ_10.
Durable Subscription Name

The name of the durable subscription multiple consumers can bind to. Durable subscriptions accumulate messages even when all consumers are offline, ensuring that no messages are lost.

This value is mandatory when the Destination Type is TOPIC. It is also required if the Destination Type is UNKNOWN and the destination resolves to a topic.

JNDI Lookup

Field Description
JNDI Context

(Optional) The IBM MQ connection properties (refer to the IBM MQ documentation). The required connection properties are as follows:

  • java.naming.factory.initial
  • java.naming.provider.url

(Optional) Click Add Context if you need to specify additional contexts.
Connection Factory Name The name of the JMS connection factory that defines the properties for the connection.
Username The username to authenticate with IBM MQ.
Password The password to authenticate with IBM MQ.
Destination Type Select TOPIC or QUEUE when the destination name is known, otherwise use UNKNOWN for a JNDI lookup.
Destination The binding identifier of the queue in IBM MQ. For example, my-ibmmq-target-queue_mqConnector_mq_sourceQ_10.
Durable Subscription Name

The name of the durable subscription multiple consumers can bind to. Durable subscriptions accumulate messages even when all consumers are offline, ensuring that no messages are lost.

This value is mandatory when the Destination Type is TOPIC. It is also required if the Destination Type is UNKNOWN and the destination resolves to a topic.

IBM MQ Target Parameters

The tables describe the parameters for configuring IBM MQ as a target. The parameters differ depending on whether you choose to use a native connection or a JNDI lookup.

Native Connection

Field Description
Connection Name The name of the connection to IBM MQ, such as the hostname or IP address. For example, 123.123.123.123 (1414), where 123.123.123.123 is the host and 1414 is the port.
Username The username to authenticate with IBM MQ.
Password The password to authenticate with IBM MQ.
Queue Manager The name of the queue manager on IBM MQ. For example, QM1.
Channel The channel on IBM MQ. For example,DEV.APP.SVRCONN.
Additional Connection Properties

(Optional) The IBM MQ connection properties (refer to the IBM MQ documentation). Click Add Context if you need to specify additional context properties.
Destination Type Select TOPIC or QUEUE when the destination name is known, otherwise use UNKNOWN for a JNDI lookup.
Destination The binding identifier of the queue in IBM MQ. For example, my-ibmmq-source-queue_mqConnector_mq_sourceQ_10.

JNDI Lookup

Field Description
JNDI Context

The IBM MQ connection properties (refer to the IBM MQ documentation). The required connection properties are as follows:

  • java.naming.factory.initial
  • java.naming.provider.url

(Optional) Click Add Context if you need to specify additional contexts.
Connection Factory Name The name of the JMS connection factory that defines the properties for the connection.
Username The username to authenticate with IBM MQ.
Password The password to authenticate with IBM MQ.
Destination Type Select TOPIC or QUEUE when the destination name is known, otherwise use UNKNOWN for a JNDI lookup.
Destination The binding identifier of the queue in IBM MQ. For example, my-ibmmq-source-queue_mqConnector_mq_sourceQ_10.

MQTT

You can configure MQTT as a source connector or a target connector. The parameters are described in the following tables: 

For message headers, see MQTT Message Headers.

MQTT Source Parameters

The following table describes the parameters for configuring MQTT as a source.

Field Description

MQTT Server URIs

The comma-separated list of MQTT server URIs, such as tcp://host:port.

MQTT Version

(Optional) The MQTT version. The default is MQTT v5.0.

Username

(Optional) The username for authentication with the MQTT broker.

Password

(Optional) The password for authentication with the MQTT broker.

Enable Clean Session

(Optional) Enable an MQTT Clean Session when selected. This option is selected (enabled) by default.

For more information about MQTT Clean Sessions, see MQTT Sessions.

Session Expiry Interval

(Optional) The number of seconds a session survives after its client becomes disconnected. The minimum value is 0.

For more information about MQTT Session Expiry Intervals, see MQTT Clean Start and Session Expiry Interval.

Enable Automatic Reconnect

(Optional) Enable automatic reconnection when selected. The option is selected (enabled) by default.

Automatic Reconnect Delay

(Optional) The maximum number of seconds to wait before attempting to reconnect. The number of seconds can be 0 or more. The default is 30.

Connection Timeout

(Optional) The number of seconds for the connection timeout. The number of seconds can be 0 or more. The default is 30.

Keep Alive Interval

(Optional) The number of seconds for the MQTT Keep Alive interval. The number of seconds can be 0 or more. The default is 60.

For more information about MQTT Keep Alive, see MQTT Keep Alive Parameter.

SSL Configuration

(Optional) Enable or disable Secure Sockets Layer (SSL) configuration. The default is Disable SSL Configuration. If SSL configuration is enabled, additional parameters are required.

For more information, see MQTT SSL Configuration Parameters.

Will Configuration

(Optional) Enable or disable MQTT Last Will configuration. The default is Disable Will Configuration. If Last Will configuration is enabled, additional parameters are required.

For more information, see MQTT Last Will Configuration Parameters.

Destination

The MQTT topic name. This field supports multiple topics where each topic is separated by a comma, wildcards, and shared subscriptions (MQTT v5 only).

For more information about MQTT topics, see MQTT Topics and Wildcards.

Client ID

(Optional) The client identifier for the publisher connection.

QoS

(Optional) The quality of service for published messages. The default value is 1.

Enable DLT

(Optional) The option to enable Dead-Letter topics (DLT) for failed consumer messages. If the DLT Name is not configured, failed consumer messages are forwarded to the dlt/{source-topic-name} topic.

For more information about Dead-Letter topics, see Dead-Letter Topic Processing.

DLT Name

(Optional) The name of the Dead-Letter topic. If DLT is enabled, failed consumer messages are forwarded to the topic that is configured with the DLT name.

MQTT Target Parameters

The following table describes the parameters for configuring MQTT as a target.

Field Description

MQTT Server URIs

The comma-separated list of MQTT server URIs, such as tcp://host:port.

MQTT Version

(Optional) The MQTT version. The default is MQTT v5.0.

Username

(Optional) The username for authentication with the MQTT broker.

Password

(Optional) The password for authentication with the MQTT broker.

Enable Clean Session

(Optional) Enable an MQTT Clean Session when selected. This option is selected (enabled) by default.

For more information about MQTT Clean Sessions, see MQTT Sessions.

Session Expiry Interval

(Optional) The number of seconds a session survives after its client becomes disconnected. The minimum value is 0.

For more information about MQTT Session Expiry Intervals, see MQTT Clean Start and Session Expiry Interval.

Enable Automatic Reconnect

(Optional) Enable automatic reconnection when selected. The option is selected (enabled) by default.

Automatic Reconnect Delay

(Optional) The maximum number of seconds to wait before attempting to reconnect. The number of seconds can be 0 or more. The default is 30.

Connection Timeout

(Optional) The number of seconds for the connection timeout. The number of seconds can be 0 or more. The default is 30.

Keep Alive Interval

(Optional) The number of seconds for the MQTT Keep Alive interval. The number of seconds can be 0 or more. The default is 60.

For more information about MQTT Keep Alive, see MQTT Keep Alive Parameter.

SSL Configuration

(Optional) Enable or disable Secure Sockets Layer (SSL) configuration. The default is Disable SSL Configuration. If SSL configuration is enabled, additional parameters are required.

For more information, see MQTT SSL Configuration Parameters.

Will Configuration

(Optional) Enable or disable MQTT Last Will configuration. The default is Disable Will Configuration. If Last Will configuration is enabled, additional parameters are required.

For more information, see MQTT Last Will Configuration Parameters.

Destination

The MQTT topic name. This field supports multiple topics where each topic is separated by a comma, wildcards, and shared subscriptions (MQTT v5 only).

For more information about MQTT topics, see MQTT Topics and Wildcards.

Client ID

(Optional) The client identifier for the publisher connection.

QoS

(Optional) The quality of service for published messages. The default value is 1.

Retained

(Optional) The option to retain published messages. The option is disabled by default.

For more information about MQTT retained messages, see MQTT Retained Messages.

Async Publish

(Optional) The option to publish asynchronously. The option is disabled by default.

MQTT SSL Configuration Parameters

Field Description

Certificate Authority (CA) certificate

The Certificate Authority (CA) certificate.

Client Certificate

The client certificate.

Client Private Key

The client private key.

Client Private Key Password

The client private key password.

Server Hostname Verification

The option to enable server hostname verification. The option is disabled by default.

MQTT Last Will Configuration Parameters

Field Description

Last Will Topic

The MQTT Last Will topic to publish to.

For more information about MQTT Last Will or Will Message, see MQTT Will Message.

Last Will QoS

The quality of service for the MQTT Last Will. The level of the quality of service can be 0, 1, or 2. The default is 0.

Last Will Retain

The option to retain the MQTT Will Message. The option is disabled by default.

Last Will Message

The payload for the MQTT Will Message.

Will Message Delay Interval

The number of seconds for the MQTT Will Message delay interval.

Will Message Expiry Interval

The number of seconds for the MQTT Will Message expiry interval.

Will Message Content Type

The Content Type of the MQTT Will Message.

Response Topic

The topic name for the MQTT response message.

For more information about MQTT response messages, see MQTT Request and Response.

Correlation Data

The MQTT Correlation Data.

For more information about MQTT Correlation Data, see MQTT Request and Response.

Oracle AQ

You can configure Oracle AQ as a source connector or a target connector. The parameters are described in the following tables: 

For message headers, see Oracle AQ Message Headers.

Oracle AQ Source Parameters

The following table describes the parameters for configuring Oracle AQ.

Field Description

Datasource URL

The URL of the connection to Oracle AQ. For example, jdbc:oracle:thin:@//localhost:1521/freepdb1.

Username

The username to authenticate with Oracle AQ. Optional. If not supplied, you must upload an Additional Properties File.

Password 

The password to authenticate with Oracle AQ. Optional. If not supplied, you must upload an Additional Properties File.

Additional Properties File

A connection properties file that contains name=value pairs that assign a value to the name of a connection property. For example:

oracle.jdbc.user=<my-user-id>
oracle.jdbc.password=<my-password>

When this file is provided, the Micro-Integration appends the query parameter oracle.jdbc.config.file=file:///file-path to the datasource URL, incorporating the properties from the uploaded file.

For more information, see the Oracle connection properties file documentation.

Destination Type

Select TOPIC or QUEUE.

Destination 

The name of the Oracle AQ topic or queue.

Durable Subscription Name

The name of the durable subscription multiple consumers can bind to. Durable subscriptions accumulate messages even when all consumers are offline, ensuring that no messages are lost.

This value is mandatory when the Destination Type is TOPIC.

Oracle AQ Target Parameters

The following table describes the parameters for configuring Oracle AQ.

Field Description

Datasource URL

The URL of the connection to Oracle AQ. For example, jdbc:oracle:thin:@//localhost:1521/freepdb1.

Username

The username to authenticate with Oracle AQ. Optional. If not supplied, you must upload an Additional Properties File.

Password 

The password to authenticate with Oracle AQ. Optional. If not supplied, you must upload an Additional Properties File.

Additional Properties File

A connection properties file that contains name=value pairs that assign a value to the name of a connection property. For example:

oracle.jdbc.user=<my-user-id>
oracle.jdbc.password=<my-password>

When this file is provided, the Micro-Integration appends the query parameter oracle.jdbc.config.file=file:///file-path to the datasource URL, incorporating the properties from the uploaded file.

For more information, see the Oracle connection properties file documentation.

Destination Type

Select TOPIC or QUEUE.

Destination 

The name of the Oracle AQ topic or queue.

Durable Subscription Name

The name of the durable subscription multiple consumers can bind to. Durable subscriptions accumulate messages even when all consumers are offline, ensuring that no messages are lost.

This value is mandatory when the Destination Type is TOPIC.

Transacted

Specifies that messages are received within a local transaction. When selected, this option indicates that the JMS consumer reads messages within a local transaction and commits the transaction when the batch has been successfully processed.

Qdrant (Beta)

You can configure Qdrant only as a target connector.

Qdrant Target Parameters

The following table describes the parameters for configuring Qdrant as a target.

Field Description
Qdrant Target Connection Details

Select Content Splitter

Select the method for splitting incoming content for vectorization. Valid values are:

  • JSON Document Splitter—splits JSON data. Additional parameters are required. For more information, see JSON Document Splitter Parameters.

  • Character Document Splitter—splits text data using a single separator. Additional parameters are required. For more information, see Character Document Splitter Parameters.

  • Structured Text Splitter—splits structured text using one or more separators. Additional parameters are required. For more information, see Structured Text Splitter Parameters.

  • No Splitter to Use with Pre-Split Unstructured Data—does not split incoming data.
OpenAI-Compatible Embedding Model Provider

Endpoint URL

The API endpoint URL for the embedding model provider. Example: https://api.openai.com/v1/embeddings

Model ID

The specific version or name of the embedding model to use. Example: openai/text-embedding-3-large

Secret Access Key

The API Secret Access Key for the embedding model provider.

Organization ID

The OpenAI Organization ID.

Chunk Size

The size of text segments into which a document is divided by an embedding model for vector database storage. Default: 1000.

Embedding Model Context Length

The maximum number of tokens to embed at once by the embedding model. Default: 8191.

Number of Embedding Dimensions

The number of dimensions in the resulting output embeddings.
Qdrant Vector Database

Endpoint URL

The API endpoint URL for the Qdrant Vector Database. Example: https://xyz-example.eu-central.aws.cloud.qdrant.io:6333

Secret Access Key

The API Secret Access Key for the Qdrant provider.

Collection Name

The name of the Qdrant collection. Note: When a collection with the specified name does not exist, a new empty basic collection with the specified name will be created.

JSON Document Splitter Parameters

Field Description

Max Chunk Size

The maximum number of tokens per text chunk during document splitting. Controls the size of segments created during text ingestion for vector storage. Default: 2000.

Note: Larger chunks preserve more context but may reduce retrieval precision. Smaller chunks improve granular search but may lose contextual relationships.

Character Document Splitter Parameters

Field Description

Chunk Size

The maximum number of characters allowed in each text segment when splitting a document. Default: 4000.

Chunk Overlap

The number of characters that overlap between consecutive chunks. Overlap helps to maintain context between split segments. Default: 200.

Separator

The character sequence used to split text into chunks, allowing control over split points at natural boundaries like paragraph breaks. Default: "\n\n".

Structured Text Splitter Parameters

Field Description

Chunk Size

The maximum number of characters allowed in each text segment when splitting a document. Default: 4000.

Chunk Overlap

The number of characters that overlap between consecutive chunks. Overlap helps to maintain context between split segments. Default: 200.

Separators

The character sequence used to split text into chunks based on text structure allowing control over split points at natural boundaries like paragraph breaks. This can be a comma-separated list of separators like: "separator1","separator2". Each separator is applied individually. Default: "\n\n", "\n", " ", "".

Salesforce (Beta)

You can configure Salesforce as a source connector or a target connector. The parameters are described in the following tables: 

For message headers, see Salesforce (Beta) Message Headers.

Salesforce Source Parameters

The following table describes the parameters for configuring Salesforce as a source.

Field Description

Pub/Sub API Endpoint 

The endpoint used by the Salesforce Pub/Sub API. For example, the Salesforce Global Endpoint is api.pubsub.salesforce.com. For more information, see Pub/Sub API Endpoints in the Salesforce documentation.

Pub/Sub API Port

The port used by the Salesforce Pub/Sub API. Allowed values are 7443 and 443.

Login URL

The Salesforce login URL (for example, https://<personal_domain>.develop.my.salesforce.com/).

Authentication Flow

The authentication method to use when connecting to Salesforce. Choose one of:

The default is USERNAME_PASSWORD_SOAP.

Destination

The source of events from Salesforce. For example, Change Data Capture events (/data/ChangeEvents and /data/<OBJECT_NAME>ChangeEvents) or Custom Events (/event/<CUSTOM_EVENT_NAME>__e).

Last Value Queue

The name of the Last Value Queue (LVQ) on the PubSub+ event broker to use for checkpointing. The Connector for Salesforce stores the last successful Salesforce Replay ID in the LVQ. The LVQ must exist on the same event broker and VPN as the target destination.

Salesforce Target Parameters

The following table describes the parameters for configuring Salesforce as a target.

Field Description

Pub/Sub API Endpoint 

The endpoint used by the Salesforce Pub/Sub API. For example, the Salesforce Global Endpoint is api.pubsub.salesforce.com. For more information, see Pub/Sub API Endpoints in the Salesforce documentation.

Pub/Sub API Port

The port used by the Salesforce Pub/Sub API. Allowed values are 7443 and 443.

Login URL

The Salesforce login URL (for example, https://<personal_domain>.develop.my.salesforce.com/)

Authentication Flow

The authentication method to use when connecting to Salesforce. Choose one of:

The default is USERNAME_PASSWORD_SOAP.

Destination

The target custom platform event in Salesforce. For example, /event/<CUSTOM_EVENT_NAME>__e.

Salesforce Legacy Username and Password Parameters

Field Description

Username

The Salesforce username to authenticate with.

Password

The password that corresponds to the Salesforce username.

Security Token 

The security token generated by Salesforce. If you don’t have a security token, click your avatar in Salesforce, then click Settings > Reset My Security Token. A new token is emailed to you.

Salesforce OAuth 2.0 Client Credentials Parameters

Field Description

Client ID

The OAuth 2.0 Client ID to authenticate with. The Client ID might appear as "Consumer Key" in Salesforce.

For more information, see Configure a Client Credentials Flow in the Salesforce documentation.

Client Secret 

The OAuth 2.0 Client Secret. The Client Secret might appear as "Consumer Secret" in the OAuth Settings in Salesforce.

For more information, see Configure a Client Credentials Flow in the Salesforce documentation.

Salesforce OAuth 2.0 JWT Bearer Flow Parameters

Field Description

JWT Bearer Token

The OAuth 2.0 JWT Bearer token to authenticate with.

For more information, see Configure a JWT Bearer Flow in the Salesforce documentation.

In addition to following the Salesforce instructions, you must ensure that Plugin Policies are set to Admin approved users are pre-authorized and the user profile/permission set is authorized for the connected app.

You can build and sign a JWT using the template on jwt.io. Change the default text to your client ID and username e-mail, then add your private key to sign the token.

To test your JWT before using it in the connector, issue the following POST request:

POST <YOUR_LOGIN_URL>/services/oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
							
grant_type= urn:ietf:params:oauth:grant-type:jwt-bearer&
assertion=eyJpc3MiOiAiM01WRz...[omitted for brevity]...ZT

SFTP

You can configure SFTP as a source connector or a target connector. The parameters are described in the following tables: 

For message headers, see SFTP Message Headers.

SFTP Source Parameters

The following table describes the parameters for configuring SFTP as a source.

Field Description
Checkpoint Store Configuration

Checkpoint Queue

The name of the Last Value Queue (LVQ) (spool size 0) to be used for checkpointing. The queue must exist on the same event broker and Message VPN as the target queue.

The Connector for SFTP stores the current progress of file processing in a checkpoint store backed by the specified LVQ.

If the LVQ is deleted (administratively) or a message from the LVQ is deleted or consumed by another consumer, the Connector for SFTP will not be able to resume from the last checkpoint. In addition, the LVQ should not be shared by multiple instances of the Connector for SFTP.

Auto Create Checkpoint Queue

Select this option to automatically create the LVQ if it does not exist.
SFTP Server Configuration

SFTP Server URI

The source SFTP server URI and start directory path.

Required format: sftp://<host>:<port>/<startDirectoryName>/

For example: sfpt://localhost:22/orders-data/

Username

The username to use to log in to the SFTP server.

Password

The password to use to log in to the SFTP server, if you are using password authentication. If you don't set a password, you must upload a private key file.

Private Key File

The private key file to use for private key verification.

Private Key Passphrase

The private key file passphrase to use for private key verification.

Known Hosts File

The Known Hosts file for the SFTP server to use for host key verification.

File Format

The format of the files coming from the SFTP server:

Additional Properties

(Optional) Any additional configuration related to SFTP. Click Add Context if you need to specify additional context properties. For more information, see SFTP Source Configuration Options.

Delimited File Configuration Properties

Field Description

Event Delimiter

The events in the files are separated by this character. Example: \n (a newline character).

Field Delimiter

The fields within the events are separated by this character. Example: , (a comma).

JSON File Configuration Properties

Field Description

JSON Path Filter Expression

The JSON path expression to extract, split, or filter the data from the JSON file.

The default value of $ means the entire JSON file content will be processed as a single event. For a JSON file larger than 30 MB, this will cause an error because the maximum size of a Solace message is 30 MB. We recommend splitting the JSON file content into multiple events by configuring the JSON path expression.

XML File Configuration Properties

Field Description

XPath Filter Expression

The XPath expression to extract, split, or filter the data from the XML file.

The default value of / means the entire XML file content will be processed as a single event. For XML file larger than 30MB, it would result in exception as max Solace message size is 30MB. We recommend splitting the XML file content into multiple events by configuring the XPath expression.

For example, for an employees.xml file with following content, the XPath expression to extract employee nodes would be //employee:

<employees>
    <employee>
        <name>John</name>
        <age>30</age>
    </employee>
    <employee>
        <name>Smith</name>
        <age>40</age>
    </employee>
</employees>

SFTP Target Parameters

The following table describes the parameters for configuring SFTP as a target.

Configuration Option Description
Checkpoint Store Configuration

Checkpoint Queue

The name of the Last Value Queue (LVQ) (spool size 0) to be used for checkpointing. The queue must exist on the same event broker and Message VPN as the target queue.

The Connector for SFTP stores the current progress of file processing in a checkpoint store backed by the specified LVQ.

If the LVQ is deleted (administratively) or a message from the LVQ is deleted or consumed by another consumer, the Connector for SFTP will not be able to resume from the last checkpoint. In addition, the LVQ should not be shared by multiple instances of the Connector for SFTP.

Auto Create Checkpoint Queue

Select this option to automatically create the LVQ if it does not exist.
SFTP Server Configuration

SFTP Server URI

The target SFTP server URI and start directory path.

Required format: sftp://<host>:<port>/<startDirectoryName>/

For example: sfpt://localhost:22/orders-data/

Username

The username to use to log in to the SFTP server.

Password

The password to use to log in to the SFTP server, if you are using password authentication. If you don't set a password, you must upload a private key file.

Private Key File

The private key file to use for private key verification.

Private Key Passphrase

The private key file passphrase to use for private key verification.

Known Hosts File

The Known Hosts file for the SFTP server to use for host key verification.

Write Mode

The action to take if a file with the same name already exists:

  • Append—Events are added to the existing file.

  • Override—The existing file is replaced.

  • Fail—An error is generated, indicating that there is already an existing file.

Maximum File Size

The maximum size of the file in bytes. If the value is 0, then there is no limit.

Maximum Number of Events

The maximum number of events to be written to a file, after which a new file is created. If the value is 0, then there is no limit.

Additional Properties

(Optional) Any additional configuration related to SFTP. Click Add Context if you need to specify additional context properties. For more information, see SFTP Target Configuration Options.

Snowflake

You can only configure Snowflake as a target.

Snowflake Target Parameters

The following table describes the parameters for configuring Snowflake as a target.

Field Description

Snowflake URL

The URL of the Snowflake instance. For example, the format of the URL can be <LOCATOR>.<REGION>.snowflakecomputing.com:443. For more information about the URL and account information, see the Snowflake documentation.

Snowflake Username

The username to log in to Snowflake.

Role

The type of role in Snowflake. For example, ACCOUNTADMIN, SECURITYADMIN, USERADMIN, SYSADMIN, or PUBLIC. For more information about the Snowflake roles, see the Snowflake documentation.

Private Key Path

The path to the private key file. For more information about the private key path, see the Snowflake documentation.

Private Key Password

The password for the private key, if applicable. For more information about the private key password, see the Snowflake documentation.