WebSphere brand IBM WebSphere Premises Server, Version 6.1.x

Portal Controller agent

The Portal Controller agent controls and facilitates portal activity.

Properties

For the properties below, you can enter either strings or variables. If you enter a variable, the value is substituted from the database when the XML configuration file is generated. Refer to Using variables for property values for details on what variables can be substituted.

Table 1. Portal Controller agent properties
Property Description
feedback.topic.prefix The topic prefix that is used to republish the tag-read feedback
log.level The level of logging to use with this agent. If the value is empty then the system log level will be used. The Alert agent must be running in order to set this property.
matrix.properties The file with the state transitions descriptions

These matrix files are available by default with the product:

  • BDDR.properties - Basic Dock Door Receiving usage scenario
  • SDDR.properties - Standard Dock Door Receiving usage scenario
  • EDDR.properties - Enhanced Dock Door Receiving usage scenario
matrix.queue.processing.all Specifies if matrix processing happens per each event (false) or for all available events (true)
operationalmode The value can be either READER or PORTAL. If the value is reader, the amber light is activated when the reader starts scanning. If the value is portal, the amber light is activated when the portal is activated.
out.error.msg.1 The value of error message 1
out.error.msg.2 The value of error message 2
out.error.msg.3 The value of error message 3
out.error.msg.4 The value of error message 4
out.error.topic.1 Matrix action 'stateX.Y.out.error=1' publishes this topic with the corresponding value
out.error.topic.2 Matrix action 'stateX.Y.out.error=2' publishes this topic with the corresponding value
out.error.topic.3 Matrix action 'stateX.Y.out.error=3' publishes this topic with the corresponding value
out.error.topic.4 Matrix action 'stateX.Y.out.error=4' publishes this topic with the corresponding value
out.reader.onparm.1 Matrix action 'stateX.Y.out.reader=ON.1' sets this metadata before turning the reader on
out.reader.onparm.2 Matrix action 'stateX.Y.out.reader=ON.2' sets this metadata before turning the reader on
portal.id The portal ID associated with this agent
portal.initial Defines the initial portal state

portal.initial.delay

Time in milliseconds to delay before setting the portal to on

portal.name The portal name associated with this agent

portal.on.execute.matrix

Execute matrix processing when a portal on command is received

profile.id Identifies the use case to which this agent is attached
reader.activation.command.topic The topic (without prefix) that is sent to turn on the reader
reader.activation.command.value The value that is sent with the message to turn on the reader
reader.activation.signal.topic The topic (without prefix) that is sent from the reader adapter to confirm that the reader is on
reader.adapter.prefix The prefix used in all messages to the reader adapter
reader.adapter.reply.timeout Specifies how long to wait (in milliseconds) for a reply from the reader adapter before timing out
reader.deactivation.command.value The value that is sent with the message to turn the reader off
selftestmode Indicates if self-test mode is active
sensor1.initial The initial value of sensor 1
sensor1.topic The topic of the first sensor in the matrix input vector
sensor2.initial The initial value of sensor 2
sensor2.topic The topic of the second sensor in the matrix input vector
sensor3.initial The initial value of sensor 3
sensor3.topic The topic of the third sensor in the matrix input vector
sensor4.initial The initial value of sensor 4
sensor4.topic The topic of the fourth sensor in the matrix input vector
sensor5.initial The initial value of sensor 5
sensor5.topic The topic of the fifth sensor in the matrix input vector
source.id The source ID for generic events in this agent
strongchecking Logs potential problem situations with matrix processing

timer.delay

Duration in milliseconds of timer 1 and timer 2 in the matrix input vector. See Configuring the PortalControllerAgent to use flexible timer values for details on how to use this property for flexible timeout values.

timer1.delay

Duration in milliseconds of timer 1 in the matrix input vector
Note: This property is only applicable for releases prior to WebSphere® Premises Server 6.1.0.1

timer2.delay

Duration in milliseconds of timer 2 in the matrix input vector
Note: This property is only applicable for releases prior to WebSphere Premises Server 6.1.0.1
tracing Displays trace output. The Alert agent must be running in order to set this property.

Library | Support | Terms of use

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