Administrator Server Payload Service Database

A payload service supports archiving, persisting and retrieving large size payload data. It is an independent service and does not depend on a log service. However, a log record sent to a log service can include a payload URL field to link a log message and payload data. You can store payload data in the same database used by Administrator server or use another database.

If you did not deploy the logging and payload services when you created the Administrator server using the TIBCO Configuration Tool, see TIBCO_HOME\administrator\version\scripts\logging\readme.txt.

Field Description
Use ActiveMatrix Administrator Server Database Select to have the payload service use the same database as the Administrator server. If cleared, the database configuration fields display to let you specify database information.

Default: Selected.

If you decide to use a non-default database, the wizard prompts you for database details.
Note: Use the default embedded database only during development.
If you are using an external database, see Database Requirements. To enable SSL communications, see Secure Communication Channels and SSL Requirements.
Note: The properties that the wizard sets in the build.properties file depend on the context in which the prompts are displayed. By default, specify the properties for the Administrator Server database and the information is then used for the Notification Service database, the Log Service database, and the Payload Service database. You can, however, overwrite the values for the Notification Service, Log Service, and Payload Service, and you can change them in the build.properties file.
Field Description
Database Driver

Driver for the external database:
  • TIBCO enabled JDBC driver for IBM DB2 4.12.55
  • TIBCO enabled JDBC driver for IBM DB2 4.19.66
  • TIBCO enabled JDBC driver for IBM DB2 4.24.92
  • TIBCO enabled JDBC driver for Oracle 11.1.0
  • TIBCO enabled JDBC driver for Oracle 12.1.100
  • TIBCO enabled JDBC driver for Oracle 12.2.0
  • TIBCO enabled JDBC driver for Oracle 18.3.0
  • TIBCO enabled JDBC driver for Oracle 19.3.0
  • TIBCO enabled JDBC driver for Microsoft SQL Server 4.0.0
  • TIBCO enabled JDBC driver for Microsoft SQL Server 4.2.0
  • TIBCO enabled JDBC driver for Microsoft SQL Server 6.0.0
  • TIBCO enabled JDBC driver for Microsoft SQL Server 7.0.0
  • TIBCO enabled JDBC driver for PostgreSQL 10.7.0 (postgresql-42.2.8.jar is required)
  • TIBCO enabled JDBC driver for PostgreSQL 11.5.0 (postgresql-42.2.8.jar is required)

Default: JDBC driver provided for HSQL 1.8.400.

Database URL

URL of the external database.

Default: jdbc:hsqldb:hsql://localhost:1234/amx.

Note: For PostgreSQL database, you must add client machine IP address entry in the pg_hba.conf file. If the TIBCO ActiveMatrix Administrator is replicated, you must also add IP address of the machine on which ActiveMatrix Administrator is replicated in the pg_hba.conf file. For more information, see PostgreSQL documentation.
Username External database username.

Default: sa.

Password External database password.

Default: None.

Max Connections Maximum number of database connections to allocate.

Default: 10.

Database Server is SSL Enabled Check to enable the database server for SSL. When checked, the SSL Keystore Configuration fields are enabled.
Default: Cleared.
Note: PostgreSQL database with SSL enabled is not supported in TIBCO ActiveMatrix 3.4.0 Hotfix 002.
Test Connection Click the Test Connection button to ensure that you can connect to the database.
Field Description
Create a Trust Store... Invokes a wizard to import certificates from a server and create the trust store.
  1. Specify a password to protect the trust keystore and click Next. The SSL setup wizard displays certificates imported from the trusted server.
  2. In the Trusted Certificates area, select the checkboxes next to the certificates to trust and click Finish.
Browse Invokes a dialog to navigate to a keystore file.
Keystore Location Location of the keystore.
Keystore Type Type of the keystore: JKS or JCEKS.

Default: JKS.

Keystore Password Password that protects the keystore.