Dashboard Agent—Settings and Property Reference

You can set configure the dashboard agents properties in the project CDD file. Many properties are for use only in exceptional cases where standard settings are not appropriate

.

As with all CDD properties you can add properties at the cluster level, to apply to all dashboard agents, or at the PU level, to apply to all agents in one engine (processing unit), or at the individual agent level. Properties applied at a more granular level override the value of the same property applied at the higher level.

Dashboard Agent Configuration Properties
Property Type Notes
Dashboard Agent Settings
Personalized Data Location
    Specifies the fully qualified path to a directory location that is available to the dashboard agent at runtime. The directory is created at runtime if it does not exist.

Dashboard users can personalize their Dashboard and the charts on it. Data about these personalization choices is stored in an internal database at the specified location.

It is strongly recommended that you specify a different directory for each TIBCO BusinessEvents project. If multiple projects share the location then personalization details are shared across those projects, which can cause issues.

For example, if two projects have charts with the same names and the same personalized data location, then the dashboard user may be able to view components for both deployed projects.

If it is required that you use the same directory for multiple projects, set the following property to specify a unique storage filename for each project:

be.agent.dashboard.mal.storage.file.dbname

Enable Stack Trace Logging
    If checked, displays the exception stack traces at run-time. Used for troubleshooting during project development. Not for use in production deployments.

Default is unchecked.

Locale, Time Zone, and Date and Time Format Properties 
be.agent.dashboard.locale
  String Specifies a locale that overrides the machine’s locale. Not currently implemented.

Default is the locale of the machine. 

be.agent.dashboard.timezone
  String Specifies a time zone using Java time zone names. The specified time zone overrides the machine’s time zone. For example the machine time zone may be IST, India Standard Time, but you want to use PST, Pacific Standard Time.

Default is the time zone of the machine. 

be.agent.dashboard.format.delimiter
  String The character to be used as the separator for multiple date/time formats.

Default is $. 

be.agent.dashboard.dateformats
  String The Java formats used to display and parse input dates.

You can add a list of formats, separated by the delimiter character, specified by be.agent.dashboard.format.delimiter.

The first format in the list is used to display dates, and the rest are used for parsing input dates.

The default is yyyy-MM-dd. 

be.agent.dashboard.timeformats
  String The Java formats used to display and parse input times. Specify the value as a format pattern that follows the Java Simple Date Format syntax.

Used in the same way as be.agent.dashboard.dateformats.

The default is HH:mm:ss.SSS. 

be.agent.dashboard.datetimeformats
  String The Java formats used to display and parse input date and time. Specify the value as a format pattern that follows the Java Simple Date Format syntax.

Used in the same way as be.agent.dashboard.dateformats.

The default is yyyy-MM-dd'T'HH:mm:ss.SSSZ.

Dashboard Resource, Personalization, and Access Properties 
be.agent.dashboard.hostname
  String The fully qualified host name of the machine running the dashboard agent. This property is generally omitted for production deployments. The Dashboard machine name is used. 
be.agent.dashboard.pullrequestport
  Integer The port on which the agent listens for pull/HTTP requests from the clients (that is, the web browsers where the dashboard is running).

Default is 8181. 

be.agent.dashboard.http.docroot
  String The directory that serves static resources. Generally does not need to be changed.

Default is BE_HOME/views/web-root. 

be.agent.dashboard.http.docpage
  String The file served as the default page (for the client). Generally does not need to be changed.

Default is index.html. 

be.agent.dashboard.configdir
  String The absolute path of the config folder. Generally does not need to be changed.

The default is BE_HOME/views/config. 

be.agent.dashboard.java.security.auth.login.config
  String Defines the login configuration to be used by JAAS.

Default is BE_HOME/views/config/jaas-config.config. 

be.agent.dashboard.mal.storage.file.dbname
  String Defines the database name for personalized file storage. If you must use the same root directory for multiple projects, you can use this property to isolate the projects (for example, using the project name). Generally does not need to be changed.

Default is beviews.

Metric Updates Queue Buffer Size Property 
be.agent.dashboard.plugin.beviews.updates.buffer.capacity
  Integer Defines the capacity of the metric updates queue. This queue holds metric updates fetched from the cache until they are processed. Each dashboard agent has one queue.

You might increase the queue size if you see warning message that updates are being dropped due to a full buffer.

Default is 1024 cache updates

Streaming Properties

See Configuration of a Streaming Mode 

be.agent.dashboard.streaming.enabled
  Boolean Allows to enable the streaming port updates. If set to false, the updates are sent over HTTP with the frequency determined by the be.agent.dashboard.updates.poll.frequency property.

Default is true. 

be.agent.dashboard.updates.poll.frequency
  Integer The interval after which the dashboard is updated over HTTP.

Default is 5000 milliseconds. 

be.agent.dashboard.streamingport
  Integer The port used by the dashboard agent for streaming data (that is, to send updates).

Default is 8787. 

be.agent.dashboard.streaming.mode
  String The mode the agent uses for streaming data. The allowable values are immediate, periodic, and steady. See Configuration of a Streaming Mode for details.

Default is steady.

For Periodic, also configure the following property:

be.agent.dashboard.periodic.streaming.period.

For steady, also configure the following properties: 

be.agent.dashboard.periodic.streaming.period
be.agent.dashboard.batch.streaming.period
be.agent.dashboard.batch.content.threshold
 
be.agent.dashboard.batch.streaming.period
  Long Used with Steady streaming mode. The interval between batch updates, in milliseconds. Defines the number of batch updates per be.agent.dashboard.periodic.streaming.period. See Configuration of a Streaming Mode for details.

Must be less than be.agent.dashboard.periodic.streaming.period.

Default is 1000 milliseconds. 

be.agent.dashboard.batch.content.threshold
  Integer Used with Steady streaming mode. The number of updates to send in one batch. See Configuration of a Streaming Mode for details.

Default is 4. 

be.agent.dashboard.periodic.streaming.period
  Long The period, in milliseconds, during which updates are gathered and coalesced. With Periodic mode, all updates are then sent in one burst. With Steady mode, updates are sent in be.agent.dashboard.batch.streaming.period batches.

Default is 5000 milliseconds. 

be.agent.dashboard.streaming.buffer.capacity
  Integer Used for Periodic and Steady streaming modes only.

The dashboard agent maintains one buffer per client, of the specified capacity. Each buffer holds updates that are streaming into it during each streaming period.

When a client’s buffer is full, any new update is dropped with a warning.

For example, a value of 512 means that during each streaming period, the buffer can hold up to 512 updates.

Default is 512.

Dashboard Chart Value Rollover Properties

Rollover is an optional daily process during which chart values are reset and recomputed.

The Rollover Process
  First all charts are unsubscribed so that no updates arrive during rollover. Then all bind parameters are updated. Then all charts are re-subscribed and the agent updates the clients with the new chart data. The update should occur at rollover time. 
be.agent.dashboard.rollover.enabled
  Boolean Enables rollover of dashboards. All other rollover properties are ignored if this property is set to false.

Default is true. 

be.agent.dashboard.rollover.timezone
  String Specifies the time zone (using Java time zone names) during which the rollover occurs. The specified time zone overrides the machine’s time zone (or the value of be.agent.dashboard.timezone, if set).

For example the machine time zone may be IST, India Standard Time, but you want to set rollover schedules using PST, Pacific Standard Time.

Default is the time zone of the machine. 

be.agent.dashboard.rollover.time
  String The time at which the rollover is to be complete (midnight by default). Specify the time using twenty-four hour time format (HH:MM).

Default is 00:00 

be.agent.dashboard.rollover.policy
  String Two policies are available, and they apply to all charts:
reset
 This policy maintains the category values and resets other values. You would use this policy, for example, if the categories are sales regions that never change.
purge
 This policy purges (resets) all chart values including category values. You would use this policy, for example, if the categories are current top performers that change each day.

The default is reset. 

be.agent.dashboard.rollover.offset
  Long Specifies when the rollover process begins, such that rollover is completed by rollover time (be.agent.dashboard.rollover.time). Specified in a number of milliseconds before rollover time begins.

This advanced property is available for unusual circumstances in which the default offset of 15 seconds is not long enough.

If rollover is complete before offset time is over, the rollover process sleeps until rollover time.

Default is 15000.

Dashboard Session Properties

Each search window that the dashboard user opens has its own session, similar to an HTTP session. The dashboard agent uses these sessions to maintain the data required to display the contents of the search windows. Two levels of timeout are available: a session timeout and a token timeout. You can also disable timeouts. 

be.agent.dashboard.token.timeout
  Long Defines the inactive period, in milliseconds, before a token is marked as timed out. All sessions time out when the token timeout occurs.

When set to -1, the token never times out.

Default is -1. 

be.agent.dashboard.session.timeout
  Long The period, in milliseconds, after which a session is closed and all data supporting that session is flushed from the dashboard agent.

Default is 60000. 

be.agent.dashboard.session.keeping.enabled
  Boolean If set to true then the session remains open as long as the window is open.

If set to false, then the session times out if the window is open and inactive for the be.agent.dashboard.session.timeout period.

Default is true.

Span Properties 
be.agent.dashboard.plugin.default.builder.span.adjustment.threshold
  Integer If any span (that is the width of a panel or partition) is defined as less than this threshold, the width is automatically readjusted.

(And if all spans for a page total more than 100%, then their widths are also automatically readjusted proportionately.)

Default is 1%. 

be.agent.dashboard.plugin.default.builder.classiclayout.firstpartition.span
  Integer Defines the initial width of the left-most partition, which renders the page selector in a classic layout.

Even if you use a dashboard template that doesn’t have a page selector, a default page selector displays in the dashboard when a user has access to multiple pages. The width of that default page selector is defined using this property.

Dashboard users can customize the page selector width as desired.

Default is 10%.

Data Rows Fetched and Displayed Properties 
be.agent.dashboard.plugin.beviews.max.timeresultset.fetch.count
  Integer Defines the maximum number of data rows fetched (and displayed in a chart) for a time-based dataset.

For example, suppose a time based chart is configured to show the last ten minutes of data. Even if more than the max.timeresultset.fetch.count number of rows is available in a ten minute time period, only the threshold number is fetched from the agent.

Time based charts have a time consolidation, so more data rows can be used for time based than for non-time-based charts.

Default is 1000. 

be.agent.dashboard.plugin.beviews.max.countresultset.fetch.count
  Integer Defines the maximum number of data rows fetched (and displayed in a chart) for a non-time-based dataset.

Default is 120. 

be.agent.dashboard.plugin.beviews.timeseries.max.plottable.points
  String When so many data rows are available that a time series chart would be unreadable, some abstraction is required to make the chart useful. For such cases, two properties control how to display the data.

The max.plottable.points property defines the maximum number of items that can be displayed for each of the three available chart sizes (see Chart Size for more details). A comma-separated list defines values for the one, two, and three unit wide charts, respectively.

The dashboard agent divides the available data rows by the max.plottable.points value and create that number of buckets for the available data.

For example, if 60 is the maximum plottable points for a three-unit wide time series chart and 600 data points are available for display, the agent creates 60 buckets of data each having 10 rows of data.

The visible.bucket.values property then defines what value to display for each bucket (see next).

Default is 10,30,60. 

be.agent.dashboard.plugin.beviews.timeseries.visible.bucket.values
  String To understand the role of this property, see notes for max.plottable.points.

Suppose a single bucket has 10 rows of data. What item of information do you want to display for that bucket? You can choose from the following options:

minimum, maximum, earliest, and latest

Default is latest.

Drill-down Properties 
be.agent.dashboard.plugin.beviews.drilldown.table.page.count
  Integer When you expand a row in a search page to see more data, a table displays the data. If there are very many rows to display, you can use this property to paginate them. It defines the number of rows to display in one table. Pagination controls also display at the bottom of each table: rev, next, and so on.

Default is 25. 

be.agent.dashboard.plugin.beviews.drilldown.table.showall.limit
  Integer If pagination is used, you can use this property to enable a Show All option when the showall.limit number of rows remains to be displayed.

For example, you show 100 rows in each table. When the user is within 400 rows of the end, the Show All option appears as a pagination control. The user clicks the Show All option to show all remaining rows on the same table.

Default is 400. 

be.agent.dashboard.plugin.beviews.drilldown.table.max.count
  Integer Defines the maximum number of rows that will be displayed in a drill-down table. Pagination controls do not affect this property.

Default is 500. 

be.agent.dashboard.plugin.beviews.drilldown.page.max.count
  Integer Defines the maximum number of rows to display on a page across all drill-down tables.

When this maximum is reached, messages inform the user so he or she can collapse some tables so as to expand others.

Default is 2000. 

be.agent.dashboard.plugin.beviews.drilldown.table.default.sort
  String Defines the default sort order to be used the first time a user clicks on an unsorted column in a table (that is, to sort the table’s column).

Uses server-side sorting. Sorting also applies to all pages, if pagination is used.

Possible values are ascending and descending.

Default is descending.

Query Manager Properties

Query Manager is an optional feature available on the Dashboard Search page. 

be.agent.dashboard.plugin.beviews.querymanager.enabled
  Boolean If set to true, the Query Manager feature is available to dashboard users.

If set to false, the Query Manager feature is disabled.

Default is true. 

be.agent.dashboard.plugin.beviews.querymanager.export.default.type
  String In Query Manager, the Dashboard user can click Export Results. This property defines the default data format for exported query results.

Possible values are CSV and XML.

Default is CSV. 

be.agent.dashboard.plugin.beviews.querymanager.export.depth
  Integer Limits the number of levels of child elements Query Manager exports.

Default is 1. 

be.agent.dashboard.plugin.beviews.querymanager.export.type.count
  Integer Defines the number of data rows that the Query Manager will fetch per concept or metric (type, not instance) while exporting the query data.

Default is 100. 

be.agent.dashboard.plugin.beviews.querymanager.export.all.count
  Integer Defines the total number of rows (overall data rows) that the Query Manager will fetch for all data types while exporting the query data.

Default is 500. 

be.agent.dashboard.plugin.beviews.querymanager.include.systemfields
  Boolean Defines whether to include system fields (concept or metric attributes such as id and ExtId) when exporting the query data.

Default is TRUE.

Other Behavioral Properties 
be.agent.dashboard.http.shared.resource.ref
  String Relative path to shared HTTP connection resource for the project.

For example, if the shared HTTP connection resource is at BE_HOME\examples\views\TickerTracker\TickerTracker\SharedResources\HTTPConnection.sharedhttp then the value of the property is \SharedResources\HTTPConnection.sharedhttp. 

be.agent.dashboard.mal.missing.original.element.loading.policy
  String Defines the policy to use when a chart that dashboard users have personalized has been deleted in the project.

Allowable values are drop, retain, and exception.

See Configuration of the Missing Original Policy for Personalized Charts for an explanation of this property and its values.

Default is exception. 

be.agent.dashboard.plugin.beviews.filter.parameter.dataset.max.count
  Integer Defines the maximum size of the dataset for possible values of a parameter in a filter editor.

Used to control the number of values that can appear in the list of possible values for a group by field in a metric. For example, a string parameter could have thousands of values, too many to display usefully in a drop-down list, and impacting performance.

Default is 2000. 

be.agent.dashboard.plugin.beviews.auto.adjust.category.sort.enabled
  Boolean Defines whether to auto-adjust the sorting on a chart’s category axis to use ascending order, when sorting is not specified. Used rarely and only to correct issues of odd sorting and related behaviors.

Sorting is specified in the chart Type Options tab. See Type Options.

Default is FALSE. 

be.agent.dashboard.*.force.stacktrace
  Boolean