eFTL Service Configuration Parameters

This topic presents the FTL server configuration parameters that apply to the eFTL service.

Example

The configuration file sets a parameter for the eFTL services in all servers. Next, it specifies a unique client name for the eFTL services on each of the three servers. 

globals:

  core.servers: # The set of core servers and their locations.
    ftl1: host1:8585
    ftl2: host2:8585
    ftl3: host3:8585

servers:
  ftl1:
    - eftl:
        name: my_eftl_cluster
        client.label: eftl-svc-1

  ftl2:
    - eftl:
        name: my_eftl_cluster
        client.label: eftl-svc-2

  ftl3:
    - eftl:
        name: my_eftl_cluster
        client.label: eftl-svc-3
Parameter Arguments Description
name <cluster_name> Optional.

Cluster name.

An eFTL service belongs to exactly one eFTL cluster.

You may supply the name of the cluster to which this service belongs.

When absent, the default value is Cluster.
client.label <label> Optional.

When present, the eFTL service uses this string as its client label. You can use this string to distinguish among fault-tolerant eFTL services in the GUI.

Security: EMS Server

If you are using eFTL with an EMS channel, set the following to the location of the EMS client library:

  • Linux: LD_LIBRARY_PATH

  • MacOS: DYLD_LIBRARY_PATH

  • Window: PATH

Parameter Arguments Description
ssl.params <path> Required for secure connections to an EMS server.

The eFTL service reads parameters from this file, and uses them when connecting to a secure EMS server.

For details, see "SSL Parameters for EMS Connections" in TIBCO eFTLTM Administration.

Messages

An eFTL service can automatically append user and client identification information to the messages that clients publish. See "Client Information Fields" in TIBCO eFTL Development.

Parameter Arguments Description
publish.client.id <boolean> Optional.

When present and true, the eFTL service appends the _client_id field to every message that any eFTL client publishes.

See "Client ID Field" in TIBCO eFTL Concepts.

publish.user <boolean> Optional.

When present and true, the eFTL service appends the _user field to every message that any eFTL client publishes.

See "User Field" in TIBCO eFTL Concepts.

Logging

Parameter Arguments Description
loglevel <level> When present, the eftl service logs protocol communication at this level of detail.

You may specify any of the standard log level strings. See “Tuning the Log Level” and its sub-topics in TIBCO FTL Development. You can set a general log level, or custom log levels for different elements.

When this parameter is absent, the default level is info.

OAuth 2.0 Parameters for EMS connections

If you configure any EMS channels in an eFTL cluster, you must also arrange a configuration file with parameters from the following table. The eFTL service uses these parameter values when connecting to an EMS server and EMS server is set up for OAuth 2.0.

For information about these parameters, see “tibemsOAuth2Params and Environment Variables” in TIBCO Enterprise Message ServiceTM User Guide.

For syntax, see the example configuration file in the samples directory.

Supply OAuth 2.0 parameters in a file, and specify the file name as the value of the FTL server configuration file parameter oauth2.params. oauth2.params (similar to ssl.params) that we use for eFTL.

Note: All the EMS channels in a cluster must use the same set of OAuth 2.0 parameter values for connecting to their respective EMS servers.

oauth2 parameters

eFTL oAuth 2.0 specific parameter meter Description
oauth2_server_url This is the uRL of the OAuth 2.0 server
oauth2_client_id OAuth 2.0 specific client id use to get an oAuth 2.0 access token
oauth2_client_secret OAuth 2.0 specific client id use to get an oAuth 2.0 access token
oauth2_server_trust_file If the connection to the OAuth 2.0 server is secure, specify this trust file
oauth2_expected_hostname The expected hostname of the server from the server certificate.
oauth2_disable_verify_hostname Option to disable verify hostname