Copyright © Cloud Software Group, Inc. All Rights Reserved

Application Element

The next diagram shows the application element. The elements included in the application element are explained in this section.

Figure 3 Application Element Diagram

 

Table 3 Application Element Description

Attribute or Element	Description
name	The name assigned to the application in TIBCO Designer.
repoInstanceName	This element corresponds to the Deployment Name field that is displayed in the Edit Application Configuration panel in the TIBCO Administrator GUI. The element’s value is the <administration-domain>-<application> name.
description	Information about the application that is stored in this file.
contact	Name of the person responsible for this application.
NVPairs	See NVPairs Element.
repoInstances	See RepoInstances Element.
services	See services Element.
plugins	Currently not used.

NVPairs Element

The next diagram shows the element.

Figure 4 NVPairs Element Diagram

 

Table 4 NVPairs Element Description

Attribute or Element	Description
name	Name assigned to an NVPairs element.
NVPair	One or more NVPair elements, each with a name, value and optional description. An NVPair element is typically used to define global variables.

The NVPairs element is used to display the global variables set in the enterprise archive file for an application. The following global variables are predefined by default:

•	DirLedger — Used by the system when defining the path name of the TIBCO Rendezvous certified messaging ledger file. The default is the root installation directory.

•	DirTrace — Used by the system to partially create the path name for log file used by the adapter. The default is the root installation directory.

•	HawkEnabled — Used by the system to indicate whether TIBCO Hawk is used to monitor the adapter. True indicates that a Hawk microagent is defined for the adapter. False indicates the microagent is not to be used. Default is False.

•	JmsProviderUrl — A JMS provider URL tells applications where the JMS daemon is located. Setting this value mostly makes sense in early stages of a project, when only one JMS daemon is used.

•	JmsSslProviderUrl — Specifies where the JMS server, running in the SSL mode, is located. Setting this value mostly makes sense in the early stages of a project, when only one JMS server is used.

•	RemoteRvDaemon — Used by the system to identify the TIBCO Rendezvous routing daemon. See TIBCO Rendezvous Administration for details about specifying the routing daemon name.

•

RvDaemon — Used by the system to identify the TIBCO Rendezvous daemon parameter. The parameter instructs the transport object about how and where to find the Rendezvous daemon and establish communication. The default value is 7500, which is the default value used by the Rendezvous daemon. See TIBCO Rendezvous Concepts for details about specifying the daemon parameter.

•

RvNetwork — Used by the system to identify the TIBCO Rendezvous network parameter. Every network transport communicates with other transports over a single network interface. On computers with more than one network interface, the network parameter instructs the TIBCO Rendezvous daemon to use a particular network for all outbound messages from this transport. See TIBCO Rendezvous Concepts for details about specifying the network parameter.

•

RvService — Used by the system to identify the TIBCO Rendezvous service parameter. The Rendezvous daemon divides the network into logical partitions. Each transport communicates on a single service; a transport can communicate only with other transports on the same service. See TIBCO Rendezvous Concepts for details about specifying the service parameter. Default is 7500

•	RvaHost — Used by the system to identify the computer on which the TIBCO Rendezvous agent runs. See TIBCO Rendezvous Administration for details about specifying the rva parameters.

•	RvaPort — Used by the system to identify the TIBCO Rendezvous agent TCP port where the agent listens for client connection requests. See TIBCO Rendezvous Administration for details about specifying the rva parameters. Default is to 7501.

•	TIBHawkDaemon — Used by the system to identify the TIBCO Hawk daemon parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is the value that was set during domain creation (7474 by default).

•	TIBHawkNetwork — Used by the system to identify the TIBCO Hawk network parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is an empty string.

•	TIBHawkService — Used by the system to identify the TIBCO service parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is 7474.

•

MessageEncoding — The message encoding set for the application. The default value is ISO8859-1, which only supports English and other western European languages that belong to ISO Latin-1 character set. After the project is deployed in an administration domain, the messaging encoding set at design time is overridden by the domain's encoding property. All the TIBCO components working in the same domain must always use the same encoding for intercommunication. See TIBCO Administrator Server Configuration Guide for more information.

RepoInstances Element

The next diagram shows the element.

Figure 5 RepoInstances Element

 

Table 5 RepoInstances Element Description

Attribute or Element	Description
selected	Indicates the transport selected to be used by the deployment repository instance. Can be set to rv, http, https or local. When set to local, the application repository will be sent to the target machine. This allows the application to run independently of the administration server. When set to rv, the client application will use TIBCO Rendezvous to communicate with the administration server. The following fields become available: When set to http, the client application will use HTTP to communicate with the administration server. Note that https can only be selected if the administration server is configured to use SSL.
httpRepoInstance	See httpRepoInstance Element.
rvRepoInstance	See rvRepoInstance.
localRepoInstance	Indicates a local file (or directory of files) is used as the deployment repository instance. Depending on the type of services deployed to a machine, the local repository may be a .dat file or a multi-file project (such as is used in Designer). If there is an adapter service and a BW service you will have both types of instances installed on your local machine. The localRepoInstance element contains the encoding element. If this element is not specified, then the encoding for the admin server is used. If the admin server is not available, then the default for this element is ISO8859-1.

services Element

The next diagram shows the element.

Figure 6 services Element Diagram

 

Table 6 services Element Description

Attribute or Element	Description
name	The name assigned to the application’s service or process. Names ending in .par indicate the application is a TIBCO BusinessWorks process. Names ending in .sar indicate the application is a service, such as a TIBCO adapter.
enabled	true or false. Only enabled services are deployed. Disabling a service, effectively undeploys just that service while letting all other services in the application run as normal. For example, this can be useful when you wish to deploy an application that includes a service for which you don't have the required software.
bindings	See bindings Element.
NVPairs	See NVPairs Element.
failureCount	The value in this field defines how many restarts should be attempted before resetting the error counter to 0. See the TIBCO Administrator User’s Guide for more information about this element.
failureInterval	The value in this field defines how much time should expire before resetting the error counter to 0.
monitor	See monitor Element.

httpRepoInstance Element

The next diagram shows the element.

Figure 7 httpRepoInstance Element Diagram

 

Table 7 httpRepoInstance Element Description

Attribute or Element	Description
server	Name of the administration server under which this application is deployed.
user	User authorized for this application repository. Defaults to the user currently logged into the AppManage utility.
password	User’s password.
extraPropertyFile	Currently not used.
timeout	Amount of time in seconds allowed for completing a task, such as retrieving information from the server. Defaults to 600 seconds.
url	The URL with which the client attempts to connect to the server.

rvRepoInstance

The next diagram shows the element.

Figure 8 rvRepoInstance Element Diagram

 

Table 8 rvRepoInstance Element Description

Attribute or Element	Description
server	Name of the administration server under which this application is deployed.
user	User authorized for this application repository. Defaults to the user currently logged into the AppManage utility.
password	User’s password.
extraPropertyFile	Currently not used.
timeout	Amount of time in seconds allowed for completing a task, such as retrieving information from the server. Defaults to 600 seconds.
discoveryTimeout	Amount of time in seconds allowed for the initial connection to the administration server.
daemon	Instructs the transport object about how and where to find the TIBCO Rendezvous daemon and establish communication. The default value is 7500, which is the default value used by the Rendezvous daemon. See TIBCO Rendezvous Concepts for details about specifying the daemon parameter.
service	Used by the system to identify the TIBCO Rendezvous service parameter. The Rendezvous daemon divides the network into logical partitions. Each transport communicates on a single service; a transport can communicate only with other transports on the same service. See TIBCO Rendezvous Concepts for details about specifying the service parameter. Default is 7500.
network	Used by the system to identify the TIBCO Rendezvous network parameter. Every network transport communicates with other transports over a single network interface. On computers with more than one network interface, the network parameter instructs the TIBCO Rendezvous daemon to use a particular network for all outbound messages from this transport. See TIBCO Rendezvous Concepts for details about specifying the network parameter.
regionalSubject	TIBCO Rendezvous subject prefix used for regional read-operation in the load balancing mode. For additional information see the TIBCO Administrator Server Configuration Guide.
operationRetry	Number of times to retry after a timeout occurs.

bindings Element

The next diagram shows the element.

Figure 9 bindings Element Diagram

 

Table 9 bindings Element Description

Attribute or Element	Description
name	Name assigned to the binding element.
machine	The machine to which this application is bound.
product	See product Element.
container	Lists the Formflow archive name and container.
description	Information about the binding, stored in this file.
contact	Name of the person responsible for this application.
setting	See setting Element.
ftWeight	When a process joins a fault tolerance group, it specifies its weight as a parameter. Weight represents the ability of a member to fulfill its function—relative to other members of the same group. See the TIBCO Rendezvous Concepts book for information about using fault tolerance groups.
shutdown	See shutdown Element.

monitor Element

The next diagram shows the element.

Figure 10 monitor Element Diagram

 

Table 10 monitor Element Description

Attribute or Element	Description
rulebases	See rulebases Element.
events	See events Element.

product Element

The next diagram shows the element.

Figure 11 product Element Diagram

 

Table 11 product Element Description

Attribute or Element	Description
type	The product type. Do not change.
version	The product version installed.
location	The product’s directory location.

setting Element

The next diagram shows the element.

Figure 12 setting Element Diagram

 

Table 12 setting Element Description

Attribute or Element	Description
startOnBoot	Specifies that the service instance should be started whenever its machine restarts.
enableVerbose	Enables verbose tracing.
maxLogFileSize	Specifies the maximum size (in Kilobytes) a log file can reach before the engine switches to the next log file.
threadCount	Number of threads assigned. Default is 8.
NTService	See NTService Element.
java	See java Element.

shutdown Element

The next diagram shows the element.

Figure 13 shutdown Element Diagram

 

Table 13 shutdown Element Description

Attribute or Element	Description
checkpoint	When true, the process engine waits for all jobs to finish (up to the maximum timeout) before shutting down the engine, rather than removing jobs at their next checkpoint.
timeout	The maximum timeout in seconds the process engine will wait for jobs to finish before shutting down the engine. A zero (0) value means 0 seconds, which effectively turns the graceful shutdown into an immediate shutdown.

NTService Element

The next diagram shows the element.

Figure 14 NTService Element Diagram

 

Table 14 NTService Element Description

Attribute or Element	Description
runAsNT	true or false. When true, the service is run as a Microsoft Windows Service. You can then manage the engine as you would any other service, and you can specify that it starts automatically when the machine reboots.
startupType	Set to one of the service startup types, Automatic, Manual, or Disabled.
loginAs	The login account for the service, if any. The domain name must be specified. If the login account is defined on the local machine, the domain is ".". For example, user jeff on the local machine would be specified as .\jeff.
password	Password for the login account.

java Element

The next diagram shows the element.

Figure 15 java Element Diagram

 

Table 15 java Element Description

Attribute or Element	Description
prepandClassPath	The items you provide here are prepended to your CLASSPATH environment variable. You can specify a Java code editor, or the jar file from a JNDI provider if you wish to use TIBCO BusinessWorks to receive and process JMS messages.
appendClassPath	The items you provide here are appended to your CLASSPATH environment variable. You can specify a Java code editor, or the jar file from a JNDI provider if you wish to use TIBCO BusinessWorks to receive and process JMS messages.
initHeapSize	Initial size for the JVM used for the process engine. Default is 32 MB.
maxHeapSize	Maximum size for the JVM used for the process engine. Default is 128 MB.
threadStackSize	Size for the thread stack. Default is 128 KB.

rulebases Element

The next diagram shows the element.

Figure 16 rulebases Element Diagram

 

Table 16 rulebases Element Description

Attribute or Element	Description
uri	Location of the rulebase file.
data	Rulebase content. Do not change.

events Element

The next diagram shows the element.

Figure 17 events Element Diagram

 

Table 17 events Element Description

Attribute or Element	Description
event	See failureEvent Element.

failureEvent Element

The next diagram shows the element.

Figure 18 failureEvent Element Diagram

 

Table 18 failureEvent Element Description

Attribute or Element	Description
restart	true or false. If true, the service instance is restarted upon failure.
description	Information that describes this operation.
actions	One of the following actions defined for a failure event: • alertAction Element • emailAction Element • customAction Element
failure	The failure element defines when the alert action should be enabled after a service instance failure. One of the following can be defined: • ANY—Any failure • FIRST—First component failure. • SECOND—Second component failure. • Subsequent—Subsequent component failures.

suspendProcessEvent Element

The next diagram shows the element.

Figure 19 suspendProcess Event Element Diagram

 

Table 19 suspendProcess Event Element Description

Attribute or Element	Description
restart	true or false. If true, the service instance is restarted upon failure.
description	Information that describes this operation.
actions	The action to perform when the policy is suspended.

logEvent Element

The next diagram shows the element.

Figure 20 logEvent Element Diagram

 

Table 20 logEvent Element Description

Attribute or Element	Description
restart	true or false. If true, the service instance is restarted upon failure.
description	Information that describes this operation.
actions	The action to perform.
match	The string in the log file to match.

alertAction Element

The next diagram shows the element.

Figure 21 alertAction Element Diagram

 

Table 21 alertAction Element Description

Attribute or Element	Description
performPolicy	The policy to perform: • Once—Generate an alert only for the first occurrence. • Always—Generate an alert for each occurrence.
enabled	true or false. If true, the action will occur when conditions for the action are true. If false, the action is not called.
level	Set the alert level. This affects the appearance of the alert in the TIBCO Administrator GUI. • High • Medium • Low
message	The message that displays when this alert is triggered.

emailAction Element

The next diagram shows the element.

Figure 22 emailAction Element Diagram

 

Table 22 emailAction Element Description

Attribute or Element	Description
performPolicy	The policy to perform: • Once—Generate an alert only for the first occurrence. • Always—Generate an alert for each occurrence.
enabled	true or false. If true, the action will occur when conditions for the action are true. If false, the action is not called.
level	Set the alert level. This affects the appearance of the alert in the TIBCO Administrator GUI. • High • Medium • Low
message	The message to send.
to	A comma-separated list of email addresses to which the message will be sent.
cc	A comma-separated list of email addresses to which copies of the message will be sent.
subject	The subject of the email message.
sMTPServer	The mail server (SMTP server) to use to send the message. Specify the host name or the host IP address.

customAction Element

The next diagram shows the element.

Figure 23 customAction Element Diagram

 

Table 23 customAction Element Description

Attribute or Element	Description
performPolicy	The policy to perform: • Once—Generate an alert only for the first occurrence. • Always—Generate an alert for each occurrence.
enabled	true or false. If true, the action will occur when conditions for the action are true. If false, the action is not called.
command	Specify the script to execute. Script files are highly recommended. Commands are possible but are limited because the command line arguments cannot accept redirection (|), multiple command (;) or append characters(> and >>). Redirection is allowed in a script. On Windows: • Use a .bat file that begins with the line @echo off to prevent the shell from exiting prematurely. • Always give the full path with "\" as the path separator. • If you use a command instead of a script, you must prefix it with cmd \c. On UNIX: • Make sure the script is executable (chmod +x). • Always give the full path with / as the path separator. If you purchased the full TIBCO Hawk product, see the TIBCO Hawk Administrator’s Guide for more information.
arguments	The list of arguments for the command.

Copyright © Cloud Software Group, Inc. All Rights Reserved