Cluster Deployment Descriptor Reference : Agents Tab Settings and Properties

Agents Tab Settings and Properties
Different sections in the table below deal with different types of agent classes.
See Using Properties at Different Levels to understand the effect of using agent class properties at the cluster level and at the processing unit level to widen the scope of the property.
 
Enter a name that is unique across the cluster. Use the NSName standard as in all names in the CDD.
Inference  Used with all OM types. This agent class has additional functionality with Cache OM than other OM types.
Cache  Used with Cache OM to provide cache storage and other services.
Query  Used with queries, part of the TIBCO BusinessEvents Event Stream Processing add-on product.
Dashboard  Used with the TIBCO BusinessEvents Views add-on product.
Monitoring & Management  Used only by the Monitoring and Management component. See Chapter 6, Basic MM Configuration.
Specifies the maximum number of objects (entities) in each agent’s L1Cache (inference agent) or local cache (query agent). The L1 cache is a local cache used by the inference agent for local access to recently used objects. It is used to optimize access to objects.
The query local cache is used in a way similar to the inference agent L1Cache. The query agent’s local cache stores cache data locally for efficient reuse. The local cache listens to and synchronizes the locally stored entity instances with those in the main cache, so that the local cache stays up-to-date.
Note  Age resets each time an entity is accessed by a query engine.
If this project will integrate with a TIBCO ActiveMatrix BusinessWorks project, enter the Repo URL for the ActiveMatrix BusinessWorks project repo URL here.
See Task A, Add the Repo URL for BusinessWorks to the CDD in Chapter 21, ActiveMatrix BusinessWorks Integration of TIBCO BusinessEvents Developer’s Guide for more details about the value to use.
If checked, this agent runs concurrent run to completion (RTC) cycles. Use of the concurrency features affects project design. See TIBCO BusinessEvents Architect’s Guide for more on this and other concurrency features.
Used only for inference agents and query agents. If set to true, the agent is used for storing cache data and in other respects acts like a cache agent, in addition to its other purposes.
Note: Set to true use for test deployments only. Not recommended in production.
Agent.AgentClassName.maxActive
Specifies the maximum number of active instances of the agent. This value is used for fault tolerance. Deployed agents that are acting as standbys can take over from active instances that fail. In many cases, there is no need to keep standby instances.
See Load Balancing and Fault Tolerance of Inference Agents in TIBCO BusinessEvents Architect’s Guide for more details.
Agent.AgentClassName.recoveryPageSize
For example, if you set the value to 10,000, then the engine loads handles in blocks of 10,000, instead of trying to load them in a single batch. Smaller batch sizes result in slower recovery. Experiment with batch size to establish the best batch size to use for your environment.
Agent.AgentClassName.checkDuplicates
By default, TIBCO BusinessEvents checks if the external IDs (@extId) of entities are unique within the agent. If you want to check for uniqueness of external IDs across the cluster, set this property to true. Performing this check affects performance.
Agent.AgentClassName.cacheTxn.updateCache
If set to true: When a rule action changes the value of any entity’s properties, then the entity instance is evicted from the cache. (Updates are saved in the backing store.)
Used in $CacheWriter thread tuning
Agent.AgentClassName.threadcount
Tip  This property is also used to define the number of Recovery threads (used for recovering Cache Plus Memory entity handles at inference engine startup).
Used in $DBWriter thread tuning
Agent.AgentClassName.dbthreadcount
Agent.AgentClassName.dbOpsQueueSize
Agent.AgentClassName.dbOpsBatchSize
The prefetch feature improves performance, but CPU and memory usage increases as a result of the aggressive prefetching. You may have to try different values till you find the optimal settings for your environment.
Query agents that perform event stream processing only can be deployed in a standalone mode. Such agents do not use cache objects and do not require cache configuration properties.
(For more details see TIBCO BusinessEvents Query Developer’s Guide available with the TIBCO BusinessEvents Event Stream Processing add on product.)
be.engine.cacheServer.channel.disable
By default cache servers connect to channels. In most cases, however, cache servers do not need to connect to channels. To prevent cache servers from connecting to channels, set this property to true.