LogoLogo
  • Documentation
  • PRODUCT REFERENCE
    • Introduction
    • Concepts and Terminology
      • Console
      • Servers (X Agents)
      • Projects
      • Configurations
      • Rules Editor
      • Rules, rule catalogue, protocol rules and rule sets
      • Test Data
      • Trace Data
      • Flight Recorders
      • Case Managers
      • Data Files
      • Content Files
      • Performance Data
      • Extensions
      • Protocols
      • Credential Vault
      • Custom Functions
      • Databases
      • Input Adaptors
      • Users
      • User Roles
      • Access Rules
      • Repositories
      • Audit Log
      • Proxies
    • Architectural Scenarios
      • Command and Control
      • Simplest Form
      • Servlet Filter
      • API Transformation
      • Active Web Proxy
      • Web Application Server
      • Active Proxy With Content
      • Mobile Application Server
      • Asynchronous Multi-Protocol
      • Data Loss Prevention Architecture
    • Getting Started
      • Login
      • Essential Things to do First
      • Keeping the Product Current
      • Common Console Management Tasks
      • Viewing Active Servers
    • Quick Product Introduction
      • Preparing the Browser Proxy
      • Setting up the Proxy in the Browser
      • Verifying the Browser Configuration
      • Understanding the Configuration
      • Understanding input and variables
      • Preparing a new repository
      • Locating the Page to Modify
      • Determining the Actions Required
      • Building the First Rule Set
      • Setting Rule Properties
      • Connecting up the First Rule
      • Getting a Server Result
      • Manipulating the Server Result
      • Returning the Result to the User
      • Creating a Configuration for the Rule Set
      • Selecting the Input Source
      • Deploying the New Configuration
      • Testing the Rules
    • X Agent details
      • Configuration Settings
      • Rule Sets
      • Tips and Techniques for Working with the Rules Editor
      • Web Application Rule Set Patterns
      • Building Rule Sets for Inclusion
      • Notes on Working with SOAP
      • Zero Installation Rules Testing
    • Data Files
    • Content Files
      • Previewing Content Files
      • Editing Content Files
      • Deploying Content Files
    • Test Data
      • Uploading and Downloading Test Data
    • Performance Data
      • Setting the Performance Collection Level
      • Retrieving the Performance Data
      • Viewing Transaction Counts
      • Viewing Transaction Counts and Inline Time
      • Viewing the Complete Performance Report
      • Understanding the URI Performance Information
      • Performance Benchmarks
    • Trace Data
      • Understanding the Trace
    • Tracing the Result of a System Failure
    • Conjoined Performance and Trace data
    • Live Performance Data and Probes
      • Setting Probes
      • Live Performance Impact Considerations
    • Accessing Server Logs
      • Viewing a log
    • Working with Flight Recorders
      • Searching Flight Recorder Information
      • Retrieving Flight Recorder Data
      • Graphing Flight Recorder Data
    • Working with Case Managers
      • Case Manager Definitions
      • Navigating the Case Managers
      • Creating a Case From Rules
      • Creating a Case From the Console
      • Viewing the Queues
      • Picking a Task
      • Case View
      • Completing a Task
      • Task History
      • Searching Tasks
      • Searching Cases
    • Managing Repositories
      • Moving Files Between Repositories
      • Copying Configurations and Rule Sets Together
      • Copying Dependent Rule Sets
      • Backing up
      • Moving Entire Repositories Between Consoles
      • Setting Repository Imports
      • Specifying Repository Rule Group Restrictions
    • Version Control and Restoring Files
    • Using the Portal UI
      • Using the Start Menu
      • Positioning Windows
      • Resizing Windows
      • Maximize, Restore and Minimize
      • Storing and Switching Desktops
    • Enterprise Level Projects
      • Creating a Project
      • Working with Tasks
      • Closing a Task
      • Closing a Project
      • Project Assistants and Work Output
    • Administration Functions
      • Extensions
      • Custom Function Setup
      • Setting up a Database
      • Input Adaptors
      • Credential Vault
      • Log Adaptors
      • Server Definitions
      • Managing Large Clusters
      • Setting up the Flight Recorder in the Console
      • Creating a Case Manager Definition
      • Work Output
      • Project Definition
      • Managing Users
      • Managing User Roles
      • Managing Access Rules
      • Authenticating via LDAP
      • Authenticating via SAML
      • Audit Log
    • Installation and Configuration
      • Installing on macOS
      • Installing on Red Hat Enterprise Linux
      • Installing on Windows - Quick Start
      • System Requirements
      • Server Installation
      • Understanding the Console Deployment Structure
      • Console Server Type Configuration
      • Console Server Configuration
      • Removing Other Unnecessary Components
      • Installing Inline with an Existing Application
      • Installing a Stand-alone Multi-Protocol Feed Server
      • Installing a Stand-alone Built in Forwarding Proxy
      • Creating a Cluster Slave Console Instance
      • Understanding the magic.properties Configuration Settings
      • Port Numbers and how to Change Them
      • Dealing with Internal Failures
      • Linking Multiple Applications Together into a Single Server
      • Monitoring by External Systems
      • Installation Considerations for Portals
      • Docker Configuration Guide
      • AWS User Deployment Guide
      • Google Cloud User Deployment Guide
    • Creating a Stand-alone Built in Forwarding Proxy
      • Installing with Ubuntu and mySQL
    • Setting up a DNS override for Data Loss Prevention
      • Deciding what to Override
      • Installing a DNS Server for the Overrides
      • Setting the Override
      • SSL Considerations
    • Backup and Restore
      • The Server Component
      • The Console Component
    • Third Party Software
      • Open Source Components
      • Closed Source Licensed Components
      • Licenses
  • PROGRAMMER'S GUIDE
    • Composable Agentic Platform Concepts
    • Setting up a Development Environment
    • Creating a Rule
    • The Kapow Extension - Example
    • Java Documentation
  • CONSOLE WIZARDS
    • Create REST with JSON service
    • Create JDBC database definitions
    • Create data set maintenance custom function
  • BEST PRACTICES
    • Naming Conventions
    • Comments & Descriptions
    • Application Configuration
    • Rules & Rule Sets
    • Repositories
    • Data Manipulation
    • Internationalization
    • Debugging
    • Performance Testing
    • Tag Replacement Techniques
    • Best Practices Repository
  • GUIDES
    • Hello, World!
    • TCL Script Writer Reference
    • Windows Automation Reference
    • Browser Certificate Installation Guide
    • Web Development Guide
    • Using the Push Notification Framework
    • Raspberry Pi with PiFace Reference
    • TomorrowX Portal User Guide
    • Examples
      • CSRF attack prevention
      • Two Factor Authentication
      • Frame Busting
      • Google Analytics
      • DNS Multi Protocol
      • Customer Satisfaction Survey
  • CHANGE HISTORY
    • New in Version 8
    • New in Version 7
    • New in Version 6
    • New in Version 5
    • New In Version 3.1
    • New In Version 3.0
  • 🌏TIME ZONES
  • ❓TROUBLESHOOTING
    • DB2 SQL error: SQLCODE: -443
    • Error 404 when trying to access the console
    • java.io.IOException: Too many open files
    • Accidental deploy to console server
  • ⚙️BROWSE COMPONENTS
  • EULSA
Powered by GitBook
On this page
Export as PDF
  1. PRODUCT REFERENCE
  2. Installation and Configuration

Console Server Configuration

PreviousConsole Server Type ConfigurationNextRemoving Other Unnecessary Components

Last updated 4 months ago

In addition to changing the server type, there are some console configuration items that can also be configured from within the console itself.

Changes to these setting are stored in a configuration file with the application itself. The following is a list of the console configuration settings in the file configuration.properties. This file can be found in the Composable Agentic Platform HOME folder under Applications/console/[build number]/WEB-INF/classes. The explanation for each item equally applies to the console setup:

Setting

Details

Home

The home folder for the console. Configuration and rule sets will be stored within subfolders under this folder. The folder must exist, and the console application server user must have read and write authority to it.

The value can be an absolute or relative file path.

Languages

A CSV list of the languages supported (and made available) in the console.

Locales

A CSV list of the locales that map to the languages installed.

Schema

The database schema used for the console configuration database.

Catalog

The database catalog used for the console configuration database.

DriverClass

The name of the actual JDBC driver class as it is loaded by the connection pool. Even though configuration information could be stored in DB2 (or some other production level database), it is recommended to use the default Derby driver for configuration. In production environments, the Derby driver should not be configured for use within the product. This will ensure that it is impossible to write a rule set that modifies the product’s own configurations.

DriverConnection

The connection string used by the JDBC driver to connect to the database.

DriverUser

DriverPassword

The user ID and password to use for the JDBC connection

MailServer

This is the system wide SMTP server used for all sending of emails from within the Composable Agentic Platform console (mostly password notifications).

MailUser

MailPassword

If the SMTP server requires authentication, specify the user ID and password in these settings.

MailingHost

The name of the host being used to identify the sending host in any email. This value allows the emails to link back to the original web page.

MailingSender

The email address used to send password reset notifications and user ID notifications

MailUseSSL

Specifies if the mail server uses SSL for connectivity. If yes, this value should be set to "true" otherwise it should be "false" or not exist

MailUseTLS

Specifies if the mail server uses StartTLS for connectivity. If yes, this value should be set to "true" otherwise it should be "false" or not exist

AuthenticationPlugins

A list of plug-ins that can alter the logon behaviour of the Composable Agentic Platform console.

UpdateServer

The URL of the Composable Agentic Platform update server. This server will be checked regularly for new available updates. This setting is optional.

ProxyHost

ProxyPort

ProxyUser

ProxyPass

ProxyDomain

These settings are used to define a proxy server that the console must pass through to access the update server or other www based services.

These settings are optional, however, if the ProxyHost is set, all other settings must be defined.

If the web proxy used NTML authentication, the proxy host should be the fully qualified name of the proxy (for example: myproxy.mycompany.com) and the ProxyDomain must also be set to the local domain. For other non-Microsoft proxies, the ProxyDomain should be blank.

UserRegEx

PassRegEx

These settings specify how user IDs and passwords are validated in the form of regular expressions. The default is to require a minimum of five characters/numbers, but alternatives can be specified here. Please note that the regular expression format is as used by JavaScript.

MasterConsole

MasterId

MasterPwd

These settings change the behaviour of the console from being a master console to being a slave console (Cluster Node). To make a console a slave console for cluster management, the MasterConsole setting must contain a URL pointing to the root web path of the master console (for example: https://192.168.1.1/console). The use of SSL is recommended for a master console connection.

The MasterId and MasterPwd refers to the corresponding values specified for this slave console in the master console.

Please see the section on managing large clusters for more information.

AccessManager

The access manager field can be used to override the method for user authentication. The currently supported access managers are for either the SAML or LDAP Authentication Plugins.

This is set on the AccessManager property as follows: LDAP

software.tomorrow.authenticate.LDAPAuthenticationPlugin SAML

software.tomorrow.authenticate.SAMLAuthenticationPlugin

Additional properties are required for either the LDAP and SAML Authentication Plugins. Please see below.

LDAPDomain

LDAPHost

LDAPSearchBase

LDAPTimeZone

These properties are used to define how the console connects to an LDAP server when the LDAP Authentication Plugin is set as the access manager

The LDAP Domain is set as follows:

LDAPDomain=mycompany.com

The LDAP Host is set as follows:

LDAPHost=ldap://myldaphost.mycompany.com

The LDAP Search base is used to locate the correct segment in the LDAP server. A typical configuration would be:

LDAPSearchBase=DC=mycompany,DC=com

The LDAP TimeZone denotes the time zone that will be used for the users authenticated via LDAP. For example:

LDAPTimeZone=GMT

SAMLMetaData

This property is used to define how the console connects to an identity provider (IdP) using SAML when the SAML Authentication Plugin is set as the access manager. SAML metadata value is the XML document which contains information necessary for interaction with SAML-enabled identity or service providers or the http reference to the meta data URL. SAMLMetaData=[XML or HTTP reference to meta data URL]

Settings
Advanced tab