Copyright © Cloud Software Group, Inc. All Rights Reserved

Site Topology Reference

Site Settings

 

Table 154 Site Topology — Site Settings 

Property	Notes
Site Name
	Site name. The default value is the name of the site topology file.
Description
	Description of the site, as desired.

Cluster Settings

 

Table 155 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.
Project CDD
	Location and name of project CDD. This is the location used by the Studio for configuration of the site topology.
Master CDD
	Location and name of the master CDD. This is the location used by the MM server.
Master EAR
	Location and name of the master EAR. This is the location used by the MM server.

Deployment Unit Settings

 

Table 156 Site Topology — Deployment Unit Settings 

Property	Notes
Deployment Unit Name
	Name of the deployment unit. Name must be unique. 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’s also a good idea to put the host name in the DU name. Note  Paths in different operating systems are specified using different tokens. Even if the DUs are identical in all other respects, you must create different DUs for different operating systems. The 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 in the remote host to where MM server will deploy the copy of the master CDD referred by this DU.
Deployed EAR
	Absolute file path to the location where the MM server will deploy the copy of the master EAR used by this DU.
Processing Unit Configurations
	Displays a list of processing unit configurations.

Processing Unit Settings

 

Table 157 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 property setting. The name must be unique within a DU. The processing units settings are configured in the CDD.
Use As Engine Name
	Check this check box to use the value of the Processing Unit Configuration Name field as the engine name. It is recommended that you use the same choice across all processing units in the cluster.
Processing Unit
	Select the processing unit 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.

 

Host Settings

The host settings are defined under <host-resources> tag by the following variables:

 

Table 158 Site Topology — Host Settings 

Property	Notes
General Settings
hostname
	Name of the computer hosting the TIBCO API Exchange Gateway deployment (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. You can use 127.0.0.1 (localhost loop back IP address) for engines running on the same machine as the MM server.
username
	User name to log onto the host machine. The user credentials are used for remote deployment and execution, including starting a process unit. At runtime, a dialog box pops up to authenticate the user, for example when deploying a PU. If you provide a username and password here, then the dialog is prepopulated with these values. You can enter different values at runtime 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 SSH utility, you specify the username you use for SSH utility.
password
	Password of the user referenced in the User Name field. The password is encrypted. See notes in User Name section.
os-type
	Operating system of the host machine. See the product readme for a list of supported platforms.
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 username and password for the remote machines are required for MM to connect (see notes for User Name and Password fields). See Install and Configure Software for Remote Start and Deployment for details on each option. The default value is SSH. Default SSH port number is 22.

 

 

Copyright © Cloud Software Group, Inc. All Rights Reserved