Symphony Messaging Dev Docs
Developer CertificationREST API
  • Start Your Developer Journey
  • Bots
    • Building Bots
    • Planning Your Bot
      • Conversational Bot
      • Interactive Bot
      • Headless Bot
    • Getting Started
      • Getting Started with BDK
      • Creating a Service Account
      • Configuration
      • Truststores
    • Overview of REST API
      • REST API Architecture
      • Overview of Pod API
      • Overview of Key Manager API
      • Overview of Agent API
      • Bot Permissions
      • REST API Reference
    • Authentication
      • RSA Authentication Workflow
      • Certificate Authentication Workflow
    • Datafeed
      • Real-Time Events
      • Overview of Streams
    • Messages
      • MessageML
        • MessageML Basics
          • Content Grouping
          • Text formatting and semantics
          • Tables
          • Images
          • Tags and mentions
            • Enhanced tags notice
          • Style Attributes
          • Special Characters
          • Emojis
        • Elements Interactive Forms
          • Buttons
            • Icon set for Buttons
          • Text Field
          • Masked Text Field
          • Text Area
          • Checkbox
          • Radio Button
          • Dropdown Menu
          • Person Selector
          • Room Selector
          • Date Picker
          • Time Picker
          • Timezone Picker
          • Table Select
          • Regular Expressions - Regex
        • Extensibility UI Actions
          • OpenChat
          • Dialog
        • Entities
          • Standard Entities
          • Custom Entities
      • PresentationML
    • Bots Best Practices
    • Open Source Code Samples
  • Extension Apps
    • Building Extension Apps
    • Planning Your App
    • Getting Started
      • Getting Started with ADK
      • Application Manifest Bundle
      • Add an Extension App to a Symphony Pod
    • Overview of Extension API
      • Initialization
      • Register and Connect
      • Extension API Services
        • Service Interface
        • Register and Subscribe
        • Modules Service
        • Entity Service
          • Entity Advanced Templating
          • Message Format - ExtensionML
        • Applications-Nav Service
        • Share Service
        • Commerce Service
        • Dialogs Service
        • UI Service
          • Receiving Conversation and User Information
          • Filter Function
    • App Authentication
      • Circle of Trust Authentication
      • OBO Authentication
  • Developer Tools
    • Symphony Messaging Generator
    • Bot Developer Kit for Java
      • Build a Conversational Bot
      • Build an Interactive Bot
      • Build a Headless Bot
      • Integrate a Bot with an Identity Provider
    • Bot Developer Kit for Python
    • App Developer Kit
      • Build a Basic Extension App
      • Build an Extension App with App Views
        • Add Buttons and Handlers to an Extension App
        • Add BDK to an Extension App for Circle of Trust
      • Build an Extension App with Message Renderers
    • Postman
    • UI Style Guide
      • Colors
      • Form Elements
      • Buttons
  • Embedded Modules
    • Symphony Messaging URI
      • Symphony Messaging URI for Mobile (deprecated)
    • Desktop interoperability
      • FDC3 intents
        • Message format
      • Configuration guide
        • Configure Interop.io
        • Configure Here Core
        • Configure Finsemble
        • Configure with Embedded Mode
        • Troubleshooting
      • Change log
    • Embedded Mode
      • Get started
      • Configuration parameters
      • Open a chat
      • Send a message
      • Create a room
      • Pin a message
      • Notifications
      • Support for extension applications
      • Open an app
      • Embedded Mode with Sponsored Access
      • Pricing tiers
      • Logout
    • Universal Webhook
      • User guide
        • Example with Splunk
      • Installation guide
  • Symphony REST API
    • Messaging REST API
    • Federation
    • Sponsored Access API
    • Enhanced Directory API
  • Developer Certification
    • Developer Certification
  • Mobile Frameworks
    • Blackberry
    • MobileIron
  • Admin Guides
    • Change Logs
      • API Agent
        • Agent - 25.5
        • Agent - 25.3 (LTS)
        • Agent - 24.12 (LTS)
        • Agent - 24.9 (LTS)
        • Agent - 24.6 (LTS)
        • Archives
          • Agent - 24.11
          • Agent - 24.10
          • Agent - 23.9 (LTS)
          • Agent - 24.8
          • Agent - 24.3 (LTS)
          • Agent - 24.2
          • Agent - 24.1
          • Agent - 23.12 (LTS)
          • Agent - 23.11
          • Agent - 23.10
          • Agent - 23.7
          • Agent - 23.6 (LTS)
          • Agent - 23.4
          • Agent - 23.3 (LTS)
          • Agent - 23.1
          • Agent - 22.12 (LTS)
          • Agent - 22.11
          • Agent - 22.10
          • Agent - 22.9 (LTS)
          • Agent - 22.8
          • Agent - 22.7
          • Agent - 22.6 (LTS)
          • Agent - 20.14
          • Agent - 20.13
          • Agent - 20.12
          • Agent - 20.10
          • Agent - 20.9 (2.62)
          • Agent - 20.7 (2.61)
          • Agent - 20.6 (2.60)
          • Agent - 20.5 (2.59)
          • Agent - 20.4 (2.58)
      • SBE (Pod API)
        • SBE - 24.1
        • SBE - 20.16
        • SBE - 20.15
        • Archives
          • SBE - 20.14
          • SBE - 20.13
          • SBE - 20.12
          • SBE - 20.10
          • SBE - 20.9 (1.62)
          • SBE - 20.7 (1.61)
          • SBE - 20.6 (1.60)
          • SBE - 20.5 (1.59)
          • SBE - 20.4 (1.58)
      • Client 2.0 APIs
        • Client 2.0 - 25.05
        • Client 2.0 - 25.03
        • Client 2.0 - 24.12
        • Client 2.0 - 24.05
        • Client 2.0 - 23.02
        • Client 2.0 - 22.11
        • Archives
          • Client 2.0 - 20.4
          • Client 2.0 - 20.5
          • Client 2.0 - 20.6
          • Client 2.0 - 20.7
          • Client 2.0 - 20.9
          • Client 2.0 - 20.10
          • Client 2.0 - 20.12
          • Client 2.0 - 22.8
          • Client 2.0 - 22.10
      • Universal Webhook
        • Univ Webhook - 2.6
        • Univ Webhook - 2.4
        • Univ Webhook - 2.2
        • Univ Webhook - 2.1
        • Univ Webhook - 2.0
    • API Change Management
    • Global Throttling
    • Agent Guide
      • Network Topology
      • Agent Download
      • Agent Installation
      • Agent Configuration Fields
      • Agent Server High Availability
      • Agent Performance Tuning
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Admin Guides
  2. Agent Guide

Agent Configuration Fields

Agent Configuration Fields

This page describes the fields of the agent.yml configuration file used during the Agent Installation.

Field

Description

agent.certificate.agentservice.file

The "agentservice" user certificate file. Either certificate or RSA authentication of the user key must be set for OBO functionality to be available. Default: unset.

agent.certificate.agentservice.password

The "agentservice" user certificate password. Required if the agentservice certificate is set. Default: unset

agent.certificate.agentservice.type

Required.

The "agentservice" user certificate type. Default: pkcs12.

agent.certificate.ceservice.file

agent.certificate.ceservice.password

Required if the ceservice certificate is set. The "ceservice" user certificate password. Default: unset

agent.certificate.ceservice.type

The "ceservice" user certificate type. Default: pkcs12.

agent.cloudlogger.enabled

Indicates whether to enable cloud logging. Default: true

agent.cloudlogger.flushingInterval

The flushing interval of the cloud logger. Default: 5

agent.cloudlogger.maxPayloadSize

Maximum payload size of the cloud logger. Default: 1

agent.cloudlogger.onPrem.flushingInterval

The flushing interval of the on-prem cloud log. Default: 5

agent.cloudlogger.onPrem.level

The log level of the on-prem cloud log. Default: INFO

agent.cloudlogger.onPrem.maxPayloadSize

Maximum payload size of the on-prem cloud log. Default: 1

agent.cloudlogger.onPrem.sink.flushingInterval

The flushing interval of the on-prem cloud logger sink. Default: 5

agent.cloudlogger.onPrem.sink.maxPayloadSize

Maximum payload size of the on-prem cloud logger sink. Default: 10

agent.cloudlogger.onPremError.flushingInterval

The flushing interval of the on-prem cloud error log. Default: 5

agent.cloudlogger.onPremError.level

The log level of the on-prem cloud error log. Default: WARN

agent.cloudlogger.onPremError.maxPayloadSize

Maximum payload size of the on-prem cloud error log. Default: 1

agent.cloudlogger.onPremError.sink.flushingInterval

The flushing interval of the on-prem cloud error logger sink. Default: 5

agent.cloudlogger.onPremError.sink.maxPayloadSize

Maximum payload size of the on-prem cloud error logger sink. Default: 10

agent.cloudlogger.sink.maxPayloadSize

Maximum payload size of the cloud logger sink. Default: 1

agent.cloudlogger.sink.flushingInterval

The flushing interval of the cloud logger sink. Default: 5

agent.cloudmetrics.enabled

Indicates whether to enable cloud metrics. Default: true

agent.df1ToDf2Bridge.enabled

Indicates whether to enable datafeed v1 support over datafeed v2. Default: false.

agent.dlp.violationSource

If set to "audit", specifies that the DLP APIs will retrieve violation data in the audit service. Required to use the DLP APIs for GCP deployed tenants.

agent.endpoints.deprecated.disable

Indicates if deprecated endpoints from Agent API should be disabled. Default: false

agent.features.elements.enabled

Indicates if Symphony Elements are enabled to be sent via Agent Messaging APIs. Default: true.

agent.limits.attachmentUploadThreads

Number of threads to use for attachment upload. Default: 10

agent.limits.allowedOrigins.refreshAvailableAppFixedDelayInMillis

The interval between refreshing allowed app origins, in milliseconds. Requires the "agentservice" user to be configured. Default: 60000

agent.limits.blastMessageStreamsLimit

The maximum of Streams where a message can be sent using the Blast Message endpoint. Default: 100

agent.limits.client.connectionRequestTimeout

The timeout used when requesting a connection from the connection manager, in milliseconds. A value of zero is interpreted as an infinite timeout. Default: 32000

agent.limits.client.connectTimeout

The timeout until a connection between the Agent and the pod or key manager is established, in milliseconds. A value of zero is interpreted as infinite timeout. Default: 2000

agent.limits.client.maxConnections

Maximum number of concurrent HTTP(s) connections opened by the Agent. Default: 200.

agent.limits.client.maxConnectionsPerRoute

Maximum number of concurrent HTTP(s) connections opened by the Agent per route. Default: 150

agent.limits.client.readTimeout

The time the Agent will wait for data from the pod or key manager, in milliseconds. A value of zero is interpreted as infinite timeout. Default: 30000

agent.limits.connectivity.refreshConnectivityStateFixedDelayInMillis

The time the Agent will wait on startup before trying to check connectivity to the pod or key manager, in millisecods. Default: 30000

agent.limits.datafeed.maxPerUser

Maximum number of active Datafeeds per user. Default: 5

agent.limits.datafeed.pollTimeout

The timeout of Datafeed poll requests, in milliseconds. If no messages are available, the Firehose will return HTTP 204 after this timeout is reached. Default: 30000

agent.limits.datafeed.queueSize

The unread Datafeed messages capacity. Once it is reached, the Datafeed will expire. Default: 250

agent.limits.firehose.pollTimeout

The timeout of Firehose poll requests, in milliseconds. If no messages are available, the Firehose will return HTTP 204 after this timeout is reached. Default: 30000

agent.limits.firehose.maxPerUser

Maximum number of active Firehoses per user. Default: 2

agent.limits.firehose.queueSize

The unread Firehose messages capacity. Once it is reached, the Firehose will expire. Default: 500

agent.limits.importThreads

Number of threads to use for message import. Default: 20

agent.limits.keyCache.size

Maximum number of stream keys to cache. Default: 1000

agent.limits.keyCache.ttl

Time to live of stream key cache entries, in hours. Default: 72

agent.limits.sessionCache.size

Maximum number of sessions to cache. Default: 10000

agent.limits.sessionCache.ttl

Time to live of session cache entries, in hours. Default: 72

agent.messaging.retry.initialDelay

(in milliseconds), the initial time before making the first polling call to check if a message has been correctly ingested. Changing this parameter can increase the load on the backend, is subject to rate limiting, and should only be done in specific scenarios following a discussion with the Symphony team.

agent.messaging.retry.delayMultiplier

(in milliseconds), the multiplier between each retry polling calls to check if a message has been ingested. Changing this parameter can increase the load on the backend, is subject to rate limiting, and should only be done in specific scenarios following a discussion with the Symphony team.

agent.onPrem

Indicates whether this is an on-prem or cloud installation. Default: true.

agent.podName

An identifier for the pod (e.g. the hostname of the pod).

agent.privateKey.agentservice.file

The "agentservice" user RSA private key file. Either certificate or RSA authentication of the user key must be set for OBO functionality to be available. Default: unset

agent.privateKey.agentservice.content

agent.privateKey.ceservice.file

agent.privateKey.ceservice.content

agent.proxy.certAuth.enabled

Indicates whether certificate authentication requests should go through the pod proxy. Default: false

agent.proxy.certAuth.keyauth.enabled

Indicates whether certificate-based keymanager authentication requests should go through the KM proxy.

agent.proxy.firehose.password

The Firehose proxy password. Default: unset

agent.proxy.firehose.uri

The URI through which to proxy requests to the Firehose. Default: unset

agent.proxy.firehose.username

The Firehose proxy username. Default: unset

agent.proxy.keymanager.password

The key manager proxy password. Default: unset

agent.proxy.keymanager.uri

The URI through which to proxy requests to the key manager. Default: unset

agent.proxy.keymanager.username

The key manager proxy username. Default: unset

agent.proxy.symphony.password

The pod proxy password. Default: unset

agent.proxy.symphony.uri

The URI through which to proxy requests to the pod. Default: unset

agent.proxy.symphony.username

The pod proxy username. Default: unset

agent.proxy.certAuth.sessionauth.enabled

Indicates whether certificate-based session authentication requests should go through the pod proxy.

agent.registration.retry.delayMultiplier

The delay multiplier rate after aditional failures. Default: 2

agent.registration.retry.initialDelay

The delay after the first registration failure. Default: 1000ms

agent.registration.retry.maxAttempts

After this number of attempts the process will stop retrying. Default: 5

agent.registration.retry.timeout

The timeout for all retry processes. After this time the process will stop retrying. Default: 35000ms

agent.url.agent

The URL of the Agent. Used for Agent registration. Default: ${symphonyUrl}/agent

agent.url.keyauth

The URL of certificate-based key manager authentication. Default: ${symphonyUrl}:8444/keyauth

agent.url.keymanager

The URL of the key manager. Default: ${symphonyUrl}/relay

agent.url.login

The URL of web-based login. Default: ${symphonyUrl}/login.

agent.url.pod

The URL of Pod API endpoints. Default: ${symphonyUrl}/pod.

agent.url.register

Required. The Agent registration URL. Default: ${symphonyUrl}/appstore/v1/internal/mgmt/agent/register.

agent.url.sessionauth

The URL of certificate-based session authentication. Default: ${symphonyUrl}:8444/sessionauth.

agent.url.symphony

Required.

The base URL of the Symphony pod.

Last updated 6 months ago

Was this helpful?

The "ceservice" user certificate file. Default: unset Required to enable if your ceservice authenticates using certificates. For RSA auth, please refer to agent.privatekey.ceservice.

The "agentservice" user RSA private key content, this value will override the file if set. Either certificate or RSA authentication of the user key must be set. This field can be encrypted. See .

The "ceservice" user RSA private key file. Default: unset Either ceservice.file or ceservice.content must be set to enable if your ceservice authenticates using RSA. For certificate auth, please refer to agent.certificate.ceservice.

The "ceservice" user RSA private key content, this value will override the file if set. Either ceservice.file or ceservice.content must be set to enable if your ceservice authenticates using RSA. This field can be encrypted. See .

Datahose
Datahose
Datahose
Property encryption
Property encryption