Features

This section describes the salient aspects of this feature in detail.

Validating the new Notification Transport Server Configuration

The following configuration parameters provided in the qin_data.xml are validated before the update:

  1. The "group_name" is validated against the Enterprise name.

    For example: If the Enterprise name is "amxadmin", the "group_name" provided in the qin_data.xml should also be "amxadmin".

    Note: To see the Enterprise name, navigate to the Administrator GUI and view the screen: Admin Configuration -> Admin Server -> Transport Configuration.
  2. Connectivity to the specified TIBCO EMS Server URL.

The Notification Transport Server Configuration update can be executed only if both the above validations succeed.

For example, in the sample output shown below, the validation related to "Connectivity to specified TIBCO EMS Server URL" has failed.

Sample output for setNotifyConfig command:

ant -f qin_build.xml setNotifyConfig 

...
...
...
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Notification Transport will be updated with below details: 
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Group Name: dev-enterprise
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - User Name: admin
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Password: ******
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Recovery Attempt Delay: 600
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Recovery Timer Timeout: 6000
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - Server URL: tcp://emshost:7222
[AMXAdminTask] 27 Sep 2016 13:30:56  INFO - enableSSL: false
[AMXAdminTask] 27 Sep 2016 13:31:16 ERROR - TIBCO-AMX-HPA-050283: Exiting Notification Transport Update as Test Connection to URL 'tcp://emshost:7222' with the new Notification Transport parameters failed. BUILD FAILED

/home/amx_user/amx_Installation/config.home/admin/dev-enterprise/samples/qin_build.xml:42: TIBCO-AMX-CLI-000042: Failed on error : 'TIBCO-AMX-HPA-050283: Exiting Notification Transport Update as Test Connection to URL 'tcp://emshost:7222' with the new Notification Transport parameters failed.'

Multi-threaded Behavior

If the number of Hosts in an Enterprise is greater than 10, 5 threads execute the Notification Transport Server Configuration update in parallel on 5 different Hosts. The SystemHost is always updated first.

Idempotent behavior

If a Host, along with all the Nodes managed by the Host, are already using the configurations specified in the data file, Notification Transport Server Configuration update is skipped for that particular Host.

For example, in the sample output shown below, Notification Transport Server Configuration update is skipped for host RemoteHost_1 as it is already updated with latest information.

Sample logs for setNotifyConfig command:

ant -f qin_build.xml setNotifyconfig 

...
...
[AMXAdminTask] 12 Aug 2016 10:57:36 INFO - Starting Notification Transport Update for host: RemoteHost_1
[AMXAdminTask] 12 Aug 2016 10:57:36 INFO - Skipping Notification Transport Update on host: RemoteHost_1 as it is already updated with latest information.
[AMXAdminTask] 12 Aug 2016 10:57:36 INFO - Notification Transport Update is completed for Host: RemoteHost_1
...
...

Eligibility of a Host for Notification Transport Server Configuration Update

Since the Notification Transport Server is at the very core of the ActiveMatrix Enterprise, ensure that the TIBCO ActiveMatrix Enterprise is in a healthy state before attempting to update the Notification Transport Server Configuration, that is, all Hosts and Nodes should be in a "Running" state. A Host is considered ineligible for the Notification Transport Server Configuration update if:

  • The Host is not in "Running" state.
  • Nodes managed by the Host are not in "Running" state.
  • The System Application ("com.tibco.amx.platform") is not in "Running" state on any one of the Nodes managed by the Host.

The TIBCO ActiveMatrix Administrator CLI tries to stop the user from executing the Notification Transport Server Configuration update if the Enterprise has any ineligible Hosts. Refer to Prerequisites for Invoking the Notification Transport Server Configuration Update Target.

For example, in the sample output shown below, Notification Transport Server Configuration update is skipped for the host RemoteHost because the System Application ("com.tibco.amx.platform") on node "testNode_RemoteHost" is in "PARTIALLY_RUNNING" state.

Sample logs for setNotifyConfig command:

ant -f qin_build.xml setNotifyconfig 

...
...
[AMXAdminTask] 28 Sep 2016 00:26:18 INFO - Notification Transport Update will be skipped for host: 'RemoteHost' because the System Application "com.tibco.amx.platform" on node 'testNode_RemoteHost' is in  PARTIALLY_RUNNING' state.
...
...

For more information on the setNotifyconfig target, refer to Available ANT Targets.

Note: If the TIBO ActiveMatrix Administrator GUI shows a Host in "Installed" state but the Host is actually running on the physical machine, the Host is still considered eligible for Notification Transport ServerConfiguration update. Additionally, if the Host manages any Nodes, the "ping" operation is executed on the Nodes to get the real time status of the Nodes and the Host is considered eligible only if the "ping" operation passes on all the Nodes managed by the Host.

Refer section Managing Hosts in an Inconsistent State to understand how a Host can enter this state.

To read more about Enterprise Deployment Health Check’s “Ping” operation, refer to Enterprise Deployment Health Check.

Track logs related to a particular Notification Transport Server Configuration Update using a 'operationID'

Every time the Notification Transport Server Configuration Update operation begins, an 'operationID' is generated and printed in the TIBCO ActiveMatrix Administrator CLI console output. This 'operationID' can be searched in the SystemNode's log to track log entries related to the specific Notification Transport Server Configuration update.

Sample output from TIBCO ActiveMatrix Administrator CLI Console for setNotifyconfig command showing 'operationID':

ant -f qin_build.xml setNotifyconfig 

...
...
[AMXAdminTask] 09 Sep 2016 08:51:58 INFO - TIBCO-AMX-HPA-050281: This action is tracked in logs by operationID: 'root_NotificationTransportUpdate_20160927165247'
...
...