Self Issue Client: Configuration

Various aspects of the software, including aspects of teh user iterface, its behaviour, and connections to other systems, can be configured by editing the XML confugration file.

The RTSI client is configured using the file located at

<root>/resources/com/ceridwen/rtsi/client/config/config.xml

This file should conform to the schema at <root>/resources/com/ceridwen/rtsi/client/config/config.xsd

N.B. When editing this file, be careful to ensure that the file is valid XML. RTSI will fail to start with an error if the file is not valid XML.

The root element of config.xml is RTSI; this has five sub-elements: UI, Systems, Modes, CommandInterface, Logging

UI section This section determines various properties of the user interface including visual and audio elements. It has seven sub-elements: SelfIssue, PatronPanel, BookPanel, Messages, Audio, Validation, Control

SelfIssue

Systems section This section configures the connections for the various external communications. It has five sub-elements: Printer, SIP, Security, Loggers, Spooler.

Printer This allows optional receipt printing

SIP This contains the connection details for the 3M SIP server (NISO CIP to be supported in a future version). Currently supports 3M SIP over telnet

Host: IP address of 3M SIP server Port: IP Port of 3M SIP Server Username: Telnet username Password: Telnet password (encrypted use java -cp lib/rtsi.jar com.ceridwen.rtsi.EncodePassword <password> to generated encrypted version) LoggedOnText: Text to look for to confirm logon ConnectionTimeout: Time (seconds) to wait during initial connection MessagingTimeout: Time (seconds) to wait when awaiting response to a transaction RetryAttempts: Number of reconnection attempts if initial connection fails RetryWait: Time (ms) to wait between connection retries

Security This allows optional support for local security tagging and gates (currently only Intellitag RFID support)

Loggers The RTSI client will need to communicate to local library staff in certain circumstances. This contains Logger section defining how to communicate to staff (currently supports a single SMTP Logger)

Logger (class="com.ceridwen.rtsi.client.log.MailLogger") EventMask: Indicates which events generate messages to library staff. Logical OR of the following values: 0x0101: E-Mail with subject "RTSI Checkout Report: Checkout Success Notification (no action required)" will be sent whenever a checkout is successfully performed on the 3M server (and reported to the user). It is anticipated that this would normally be suppressed unless a full record of activity is needed.

0x0102: E-Mail with subject "RTSI Checkout Report: Checkout Failure Notification (no action required)" whenever a checkout cannot be completed and the user is informed that the checkout has failed. This would normally be suppressed, but might be required to be recorded if there is a danger that the user would attempt to remove the item anyway.

0x0104: E-Mail with subject "RTSI Checkout Report: Checkout Pending Notification (no action required)". An item has been issued to an user when the 3M system was unavailable, and the checkout request has been spooled for an abnormally long amount of time (Systems/Spooler/...). This is a warning message that there may be a problem with the RTSI clients communication with the 3M server, the 3M server has been unavailable for an abnormal amount of time, or there is a network problem. No action is required as the client will continue to attempt to commit the checkout, but these warning should be kept in case of a synchronisation mismatch (e.g. if the patron returns the item before the checkout can be committed)

0x0108: E-Mail with subject "RTSI Checkout Report: Manual Intervention Required (action required)" is generated if an item has been issued to an user, but the RTSI client was unable to commit the checkout to the 3M server. This can occur in two cases: (i) the user would not normally be allowed to checkout the item but the RTSI client is running in Trust Mode or Offline Mode when the item was checked out; (ii) the item was spooled in Offline mode, but the 3M server has not been available for the designated maximum life an item can be kept in the spooler (Systems/Spooler/...)

ReplayPeriod: Messages may be spooled if the SMTP relay is not available. This indicates how often the spool is checked for stored messages (minutes) To: Address to send messages to From: Address from which messages are sent from Relay: SMTP relay Spool: Directory to store spooled messages

Spooler

ReplayPeriod: Time (minutes) to replay spooler OverdueAgeWarn: Time (hours) item can remain in spooler before generating warning message OverdueAgeExpire: Time (hours) item can remain in spooler before generating manual intervention message Spool: directory to store spooled requests

Modes section This section configures the behaviour of the RTSI client software. It has six sub-elements: TrustMode, AllowOffline, UseNoBlock, RetryPatronWhenError, RetryItemWhenError, AllowRenews

TrustMode When false, an item will only be reported issued if the 3M server allows the item to be issued; if the 3M server fails the issue the reason will be reported to the end user.

When true [explain rationale], an item will always be reported issued. If the issue cannot be committed by the client to the 3M server (e.g. if the borrower has too many items out), a message is sent to the librarian (using the method specified in the Systems/Loggers section) requesting manual intervention.

AllowOffline Applies only if not in Trust Mode (AllowOffline is always true when in Trust Mode).

When AllowOffline is false (and TrustMode is false), any attempts to issue an item when the 3M server is unavailable will be refused with a "network error" message to the user.

When AllowOffline is true, any attempt to issue an item when the 3M server is unavailable will result in the item being reported issued to the user. These transactions are spooled on the client and then played back to the 3M server when it is available again (any items which cannot be committed automatically will generate a message to the librarian using the method specified in Systems/Loggers for manual intervention).

UseNoBlock Can be set to true if the 3M server supports NoBlock when running in Trust or Offline modes - in this case the 3M server is responsible for reporting cases where manual intervention is required rather than the RTSI client.

RetryPatronWhenError If running in Trust Mode or Offline Mode the RTSI client may not be able to confirm that the patron id is valid. If RetryPatronWhenError is false, the RTSI client will assume that the entered patron id is always valid; if true the RTSI client will request the patron id to be re-entered if it cannot confirm validity and only continue if the patron id is entered identically twice.

RetryItemWhenError If running in Trust Mode or Offline Mode the RTSI client may not be able to confirm that the item id is valid. If RetryItemWhenError is false, the RTSI client will assume that the entered item id is always valid; if true the RTSI client will request the item id to be re-entered if it cannot confirm validity and only continue if the item id is entered identically twice.

AllowRenews If false the 3M server will return an error if an attempt is made to issue an item already checked out to that patron; if true the 3M server will be told to interpret the check-out as a renewal request.

CommandInterface section

AllowConnectionTest: Allows *Test Connection¦ command in the patron panel (tests SIP connectivity)

AllowSystemsCheck: Allow *Check Systems¦ command in the patron panel (indicates current modes, memory and spool use)

AllowLogTest: Allow *Test Crash¦ command in the patron panel (tests unexpected error handling)

AllowSystemShutdown: Allow *Shutdown System¦ command in the patron panel (closes RTSI client after password check)

SystemShutdownPassword: Password for shutting down RTSI (encrypted use java -cp lib/rtsi.jar com.ceridwen.rtsi.EncodePassword <password> to generated encrypted version)

Logging section