WebSphere brand IBM WebSphere Sensor Events, Version 6.2

System Properties

Use this page to set system properties. System properties are unique and predefined.

You can edit the properties on this page. Click Save to save the changes.

The following system properties are used:

Table 1. Default system properties
Name Type Default Description
LasVersion String current version number Shows the Location Awareness Services for WebSphere® Sensor Events version that is installed. This property is read-only.
AllEventsGroup String All events Name of the events group that holds all Location Awareness Services for WebSphere Sensor Events events.
BIRTViewerURL String http://localhost:9080/birt-viewer/frameset?__report= Use this URL to view BIRT reports. If WebSphere Application Server was installed using different ports or if the BIRT engine was installed on a different WebSphere Application Server system, modify the value of this URL to point to the correct location.
BatteryExhaustedAlertAction String Event Alert action if the battery of a tag is completely exhausted. The alert generates an event.

Valid values are:

  • Event
  • Display
  • Event, Display
  • Display, Event

The battery icon displays in the Spatial Management Client.

BatteryLowAlertAction String Event Alert action if the battery of a tag is low. The alert generates an event. When the alert is triggered, you will not receive another alert unless the battery rises above the threshold and then triggers it again.

Valid values are:

  • Event
  • Display
  • Event, Display
  • Display, Event

The battery icon displays in the Spatial Management Client.

Independent of the BatteryLowAlertAction property setting, low battery conditions are indicated by a low battery icon that is added to the tag icon.

BatteryThreshold Integer 1 Battery threshold that triggers an alert when the battery is underrun. The battery status can be:
  • 3, which is full or completely charged
  • 2, which is high or sufficiently charged
  • 1, which is low or somewhat charged
  • 0, which is empty or not charged
ContainerSupportOn Boolean The box is not checked, which means No Turns container processing on during runtime processing, meaning you can add an item to a container. The box can either be checked to mean Yes or not checked to mean No. Use this property in scenarios with containers equipped with active tags and content items without active tags. Once entered to a container, the content items should inherit the container position.
Note: This property should not be selected at the same time as DynamicContainerSupportOn. If it is, the ContainerSupportOn property will be ignored.
CurrentSVGDir String .//svg

Holds the area definitions during replay and normal processing, when running the Spatial Management Client.

DefaultDateFormat String MM/dd/yyyy Format used to display dates and accept date input in Location Awareness Services for WebSphere Sensor Events.
By specifying MM/dd/yyyy as the pattern for data pertaining to dates,
  • Input to the GUI, such as 01/12/2008, will be interpreted as January 12, 2008 (not December 1, 2008).
  • Output from the GUI will be displayed in the specified pattern format, for example 01/12/2008.

For detailed information on time format syntax, refer to the Java™ API for SimpleDateFormat.

DynamicContainerSupportOn Boolean The box is checked, which means Yes Turns on dynamic container processing. The box can either be checked to mean Yes or not checked to mean No. With this flag set, Location Awareness Services for WebSphere Sensor Events is able to detect by position whether a tag is near a container (using its edge length) and will add an item to or remove an item from a container. Use this property if both the container and the content items are equipped with active tags. Each item can be tracked individually. This is also prerequisite for the escorting and association rule.
Notes:
  • If you have a lot of container items, this setting will have an impact on performance. Enable this option only if you use this kind of dynamic container assignment often, or if you have defined escorting rules.
  • When the content item is not seen by the RTLS system, it will not inherit the container position but will stay on the last seen position. To force inheritance of the container position, see ContainerSupportOn.
  • This property should not be selected at the same time as ContainerSupportOn. If it is, the ContainerSupportOn property will be ignored.
HierarchicalGroups Boolean The box is checked, which means Yes Specifies whether or not to use hierarchical groups. The box can either be checked to mean Yes or not checked to mean No.
Note: When you uncheck this box to set this value to No, specifying that you do not want to use hierarchical groups, you cannot switch back to Yes. Also, once you uncheck the box, you may have to wait up to one minute for the changes in the setting to take effect.
InactivityDelay Integer 60 Time in seconds that Location Awareness Services for WebSphere Sensor Events waits before displaying a tag as inactive in the Spatial Management Client if no new position coordinates are received.
Note: The value specified for this property will be added to the value specified for the WatchdogDelay property.
IsStationaryRuleAlertAction String None Defines whether an event is generated if an item that is defined as stationary is moving.

Valid values are:

  • Event
  • Display
  • Event, Display
  • Display, Event

If a class that is defined as stationary moves twice the amount of feet defined in MaxToleratedMovement, an event is generated once every 5 minutes to avoid flooding stationary events when an item is moving.

An event could be similar to the following example:

Item with tag [00000017] with label [alabelele], defined as stationary has moved at [Tue Jan 22 22:56:56 CET 2008]. Details: Position [38.30, 38.30, 0.00], Classes: [Asset], Groups: [Laptop]
LasDirectory String C://IBMHttpServer//htdocs//en_US

Directory that holds subdirectories, such as archive, search, and SVGs for maps, that are the default values for Location Awareness Services for WebSphere Sensor Events. The subdirectories must contain the complete, running Spatial Management Client, and the specified directory must already exist.

Restriction: Do not change the value of this property.
LogHistory Boolean The box is not checked, which means No Specifies whether to save runtime data for the tags. The box can either be checked to mean Yes or not checked to mean No.

LogJSR168Default

Boolean The box is checked, which means True

Specifies how the logging target for portlet logging. The box can either be checked to mean True or not checked to mean False.

The default value is set to True, which means that some logging may go to the SystemOut.log file. Setting the value to False, enforces all logging to use log4j.

Max connection retry

Integer 20

Defines the number of retries before a socket connection to an event provider is lost. A retry is attempted every 3 seconds. The default value is 20. If you specify -1 or if the parameter does not exist, Location Awareness Services for WebSphere Sensor Events tries reconnecting forever. This parameter is valid for all socket connections.

MaxTagSignalAge Integer 10 Specifies a time frame, in seconds, for resetting the tag smoothing algorithm.

With smoothing, several location events are added and new location coordinates, X,Y and Z, are calculated. Typically every 1 or 2 seconds the systems receives a tag location event, but under specific circumstances, such as bad coverage or shadows, the read times between the location events can be extended. This parameter specifies the time to reset the tag smoothing algorithm in order to drop old location events.

For example, if this property is set to 10 seconds, and the smoothing algorithm is weighted average with a time series length of 5, then location events 1 through 5 are gathered every second. For every location event the smoothing algorithm calculates the weighted average based on the current amount of gathered events. For location event 2 the algorithm takes location events 1 and 2, for location event 3 it takes events 1, 2 and 3, and so on. If location event 6 takes 11 seconds to be sent to the system, then the smoothing algorithm is reset and location event 6 is processed the same as location event 1.

MaxToleratedMovement Integer 2 Number of feet an item can move without generating an alert when belonging to a class that is defined as stationary.

To avoid a flooding condition of stationary alerts, if an item moves twice the amount of units defined, then a stationary alert will be generated once every 5 minutes.

MaxUnrecognizedMovement Integer 1 Number of feet an item can move before it is identified as moving. Movements within the specified number of feet are not reported.

This property also affects when a tag is identified as having entered or exited a zone. A tag is considered to have entered or exited a zone if its coordinates are inside or outside of the zone by at least 50 percent of this value. For example, if this value is set to 1 and a tag's coordinates indicate that the tag is inside the zone by at least six inches, the tag is considered to have entered the zone.

MinRefreshInterval Integer 10 Time in seconds after which the tag position is updated. At least every n seconds (as specified with this parameter), the tag position is updated. If you receive updates in shorter intervals, they are used and the tag position is updated more often.
MissingReadsTolerance Integer 30 Time in seconds during which missing readings from tags are tolerated.

The value specified for this property will be added to the value specified for the WatchdogDelay property and a no TagNotResponsiveAlert is generated.

The system checks regularly for unresponsive tags, every value of WatchdogDelay seconds. Also, the system is looking for tags that have not been seen in the last value of MissingReadsTolerance seconds. So, it may take up to value of WatchdogDelay plus value of MissingReadsTolerance seconds until this condition is detected. If this function is critical, the value of WatchdogDelay should be smaller than that of MissingReadsTolerance.

NumOfBadMsgIgnored Integer 10 Time in seconds after which low quality messages are ignored when they follow good quality messages.
NumberOfEventsPerTag Boolean 50 Defines how many events are listed in the tag details window on the Spatial Management Client.

RTLSProviderAlertAction

String CEI
Specifies the behavior for diagnostic events coming from event providers. Accepted values are: CEI, CEP, None, Other
  • CEI - The events are routed as is to CEI and show up as diagnostic events, if they are not customized. For example, tagNotResponsive or battery-related events.
  • CEP - The diagnostic events are routed to the rules engine. This value is only valid if rules for diagnostic events are deployed.
  • None - The diagnostic events are ignored. This also applies to the rules that depend on diagnostic events such as tagNotResponsive or tagNotMove. For example, the Man Down Detection rule would not work.
  • Other - All diagnostic events are ignored except for tagNotResponsive or tagNotMove, so the alerts related to those events will function.
RunPerformanceTest Boolean The box is not checked, which means No Specifies whether to check performance options. Use this property when debugging. The box can either be checked to mean Yes or not checked to mean No.
SimulatorFileDirectory String C:/IBMAtlas/Simulator/ Target directory for files with recorded data.

This property is available for event providers that are connected with a LAS Socket connection.

SimulatorFileExtension String .txt The file extension of the files with recorded data. A timestamp is used in the file names.

This property is available for event providers that are connected with a LAS Socket connection.

SimulatorFileLength Integer 20 The length defines the size of the simulator file in kilobytes (KB). When the defined size is exceeded, a new simulator file is created with a new suffix. This value can be set to no more than 100.

This property is available for event providers that are connected with a LAS Socket connection.

SimulatorFileSwitchInterval Integer 10800000 Time in milliseconds after which Location Awareness Services for WebSphere Sensor Events switches to a new output file.

This property is available for event providers that are connected with a LAS Socket connection.

SimulatorRecordingOn Boolean The box is not checked, which means No Turns recording on or off. The box can either be checked to mean Yes to turn the recording on, or not checked to mean No and recording is not turned on.

This property is available for event providers that are connected with a LAS Socket connection.

TagNotResponsiveAlertAction String Event Alert action if a tag is not responsive. The alert generates an event.

Valid values are:

  • Event
  • Display
  • Event, Display
  • Display, Event

In the Spatial Management Client, the tag icon fades.

UnknownIconLabel String Unknown Tag Label of the unknown tags.
UnknownTagAlertAction String Event Alert action if an unknown tag is found. The alert generates an event.

Valid values are:

  • Event
  • Display
  • Event, Display
  • Display, Event

In the Spatial Management Client, the unknown tag icon displays.

UnknownTagIcon String unknownTag.jpg Graphical representation of the unknown tags.
WASBootstrapAddress String localhost 2809 Defines the bootstrap address for WebSphere Application Server if it is different than the default (such as 2810 in case of multiple servers on the same machine). The bootstrap address is used to retrieve and send alert events.
WatchdogDelay Integer 60 Time in seconds during which non-zone-related business rules are checked. For example, if this value is set to 60, then tags will be checked every 60 seconds, whether they are responsive or not.
Note: If another property that delays checking is set, then action will not be taken on a tag until after the accumulation of delays.

Library | Support | Terms of use

(c) Copyright IBM Corporation 2004, 2009. All rights reserved.
U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.