Site Topology Reference

Site Topology — Site Settings
Property Notes
Site Name

Default value is the name of the site topology file.

In a multi-cluster configuration, the name must be the same for every cluster (in each site topology file).

Description Description of the site.
Number of Clusters Read-only field. Only one cluster per site is supported in this release. (Not present in the site topology XML file.)

In a multi-cluster configuration, each cluster is configured in a different site topology file. Hence, the number of clusters in the site topology file will always be one.

Number of Hosts Read-only field displaying the number of hosts in this topology. (Not present in the site topology XML file.)
Site Topology — Cluster Settings
Property Notes
Cluster Name Read-only field displaying the cluster name specified in the CDD. This name is set in the Cluster Name field of the CDD editor.

In a multi-cluster configuration, the cluster name must be unique for each cluster.

TIBCO BusinessEvents Version Read-only field displaying the version of TIBCO BusinessEvents. Must match the Host Settings field of the same name.
Note
 If you copy a site topology from a prior release into a project and open it in the current release, this field value displays the prior release version number. The field is red, and it is editable. Update the field value to the current version. It again becomes a read-only field. Also change the host-level TIBCO BusinessEvents Version field in a similar way: both must match. If you migrate the project, this issue does not occur. See the section "Migration" from 4.x to 5.1, in TIBCO BusinessEvents Installation.
Project CDD Location and name of project CDD. This is the location used by TIBCO BusinessEvents Studio for configuration of the site topology. See Project Master and Deployed Locations of CDD and EAR Files .
Master CDD Location and name of the master CDD. This is the location used by the MM server. See Project Master and Deployed Locations of CDD and EAR Files .
Master EAR Location and name of the master EAR. This is the location used by the MM server. See Project Master and Deployed Locations of CDD and EAR Files .
Site Topology — Deployment Unit Settings
Property Notes
Deployment Unit Name Name of the deployment unit. It can be helpful to include the operating system of the host to which you will deploy this DU in the DU name. If a DU contains any host-specific settings, it is also a good idea to put the host name in the DU name.

In a multi-cluster configuration, the deployment unit name must be unique.

Note
Paths in different operating systems are specified using different tokens. Even if the DUs are identical in all other settings, you must create different DUs for different operating systems.

Default value is DU_n where n is a number that increments each time you add a DU to the diagram.

Deployed CDD Absolute file path to the location where the MM server will deploy the copy of the master CDD. See Project Master and Deployed Locations of CDD and EAR Files .
Deployed EAR Absolute file path to the location where the MM server will deploy the copy of the master EAR. See Project Master and Deployed Locations of CDD and EAR Files .
Processing Unit Configurations Displays a list of processing unit configurations. Adding and configuring PUCs is explained in Site Topology in TIBCO BusinessEvents Studio .
Site Topology — Processing Unit Settings
Property Notes
Processing Unit Configuration Name The name that identifies this configuration of the processing unit, as specified in the Processing Unit setting (see below). The processing unit name must be unique across the deployment unit.

The processing units settings are configured in the CDD. For more information, see TIBCO Business Events Developer's Guide.

Use As Engine Name Check this check box to use the value of the Processing Unit Configuration Name field as the engine name.

For best results, ensure that you use the same choice across all processing units in the cluster.

Processing Unit Select the processing unit that you want to use. Only processing units configured in the CDD selected as the Project CDD appear in the list. The same processing unit can be used in multiple PUCs.
Number of Agents Displays the number of agents in the selected processing unit. (Not present in the site topology XML file.)
JMX Port JMX port used by MM to perform monitoring and management. Required.

When more than one PU is deployed on the same host (in one DU or multiple DUs), you must ensure the JMX port in each of these PUs is different.

See JMX Remote Port Number Setup at Runtime for more details.

Site Topology — Host Settings
Property Notes
General Settings
Host Name Name of the machine hosting the mapped DUs (including the domain extension). Used for remote access. Used to identify the host in the MM user interface. Required.

To validate the hostname, ping the host using this name from the MM server machine.

Note
Specify the exact name of the host. Errors in the host name result in the host appearing in the MM Console UI as an unpredefined machine. Do not, for example, use localhost.
IP IP address of the host machine. Used for remote access. Required.
User Name User name to log onto the host machine.

The user credentials are used for remote deployment and execution, including starting a process unit.

At run time, a dialog box pops up to authenticate the user, for example when deploying a PU. If you provide a user name and password here, then the dialog is prepopulated with these values. You can enter different values as needed.

If you do not provide the credentials here, then you must provide them at the pop-up dialog.

You can specify a local user or a domain user.

Enter details for the user you specified for the remote connection utility you are using. For example, if you use PsTools, specify domain\user for domain users.

Note
 If you use a SSH server, you must specify the same user credentials here that you used to install the SSH server, or the credentials of a user who is enabled to log in to the SSH server.
Password Password of the user referenced in the User Name field. The password is encrypted.

See notes in User Name section.

Operating System Operating system of the host machine. See the product readme for a list of supported platforms.
Installation Settings
TIBCO BusinessEvents Version Read-only field displaying the version of TIBCO BusinessEvents. Must match the Cluster Settings field of the same name.
Note
 If you copy a site topology from a prior release into a project and open it in the current release, this field value displays the prior release version number, the field is red and it is editable. Update the field value to the current version. It again becomes a read-only field. Also change the cluster level TIBCO BusinessEvents Version field in a similar way: both must match.
TIBCO BusinessEvents Home Install location of TIBCO BusinessEvents on the host machine, for example:

c:/tibco/be/<version>

TRA File Location of the be-engine.tra file, for example:

c:/tibco/be/<version>/bin/be-engine.tra

Start PU Method Setting
Start-PU-Method Choose the method that MM will use to start this processing unit on remote machines:
  • Use Hawk
  • Use PsTools
  • Use SSH. If you choose Use SSH, and do not want to use the default port number of 22, then also enter the port. The host must accept a secure connection through this port. Using the default port is generally recommended because it is also the default port used by most Linux SSH servers.

    Note that a user name and password for the remote machines are required for MM to connect (see notes for User Name and Password fields).

    See Software for Remote Start and Deployment for details on each option.

    Default is SSH. Default SSH port number is 22.