Skip to main content
OCLC Support

Configure SIP2

  1. Last updated
  2. Save as PDF
Discover how SIP2 is configured in OLIB.

►System Administration> Server Process Configuration

View configuration

SIP Server Process Configuration is normally carried out by OCLC (UK) Technical Services. You can view the configuration as follows.

Server Process Configuration details

Go to System Administration> Server Process Configuration to view details for the SIP Server Program.

On the Configuration sheet for this program, ensure that the Port value is set to 2500. It should be set to this by default during the installation process.

If you require a log file while you are testing the SIP2 Server, ensure that the LogFile, LogLevel and LogSQL values are set accordingly.

Server Process Configuration hitlist

If the SIP Server’s Program Status is set to Started and Enabled set to Yes, restart the service by checking the Actions box and selecting the Restart option. If Enabled is set to No (in which case the Program Status will be set to Stopped), select the Enable option. Refresh the search until Enabled is set to Yes and Program Status changes to Started.

The OLIB SIP2 Server connects to port 2500. You will need to refer to your self-issue unit supplier for assistance in configuring your self-issue unit to connect to it and communicate with it.

Circulation message override

Issue screen pop-up messages will display and will need to be over-ridden at point of issue.

It is possible to specify whether a circulation trap should allow or prevent a SIP issue, renewal, return or reservation transaction separately from whether the same trap should allow or prevent the issue, renewal, return or reservation in OLIB Web, WorldView or WebView. You can also define the message that is returned to the SIP client separately from the message that is returned to other circulation clients.

Go to Circulation Reference Data> Circulation Messages.

The SIP Settings appear at the bottom of the Circulation Messages record for each message. For example a typical setting for the User is banned message can be applied.

It is also possible to define these parameters differently for different Locations.

For example, one location can allow an issue transaction through SIP if the user has overdue items, whereas other locations may want to stop an issue transaction through SIP under the same circumstances. Each location can have a different message returned to the SIP client for each trap condition.

SIP payment codes

If you wish to enable payments through SIP2, then check that the following codes are present in Circulation Reference Data> Payment/Waive Types: 00 - Cash; 01 - Visa; 02 - Credit card. These are provided by default.

SIP return date format

The standard SIP date format that is passed back to the SIP client cannot always be converted to a more readable format. The SIP Date Format field can therefore be defined in OLIB. This can be set at system level in OLIB Defaults or at Location level (Location takes precedence where both are used).

  • System Administration> OLIB Defaults> User/Circulation Defaults: SIP Date Format
  • User Management> Locations> Circ Details> Issue/Renewal/Return Parameters: SIP Date Format

In the SIP Date Format field, select from the list of valid date formats. These are all valid Oracle format dates. If the format you require is not included you can add your own in System Administration> Date Formats - this must be a valid Oracle date format. The Example field is refreshed with today's date in the format you entered and can then be saved. If the ' invalid date format' error message is displayed you will have to modify the format until it is accepted.

Stop SIP circulation transactions

This feature allows you to specify whether the self-service machine should allow or stop transactions being performed on a particular copy, user or title. It is set in the domains where you set traps - Library Defined Trap Messages:

Circulation> Traps - Copies; Traps -Titles; Traps -Users

Enter trap details as normal and set Stop SIP Circ Transactions to Yes so that any SIP circulation transaction attempted for this user/title/copy will be rejected. Setting it to No means the transaction will be processed as normal.

Patron authentication

The OLIB SIP Server supports patron authentication. If you supply the user’s password in the AD field, it is validated to ensure that it matches the password stored in the password field of the user record with the matching barcode. You can configure OLIB so that a password in the AD field is mandatory, i.e. if a Patron Status or Patron Information request message is supplied without an AD field or with a blank AD field, the corresponding response message indicates that an invalid password has been supplied.

If a password is passed to the OLIB SIP Server in the AD field of a Patron Status request message (23) or a Patron Information request message (63), the password is validated against the password field in the record in the borrowers table that matches the barcode supplied in the AA field. The Patron Status Response message (24) and the Patron Information Response message (64) include a CQ field that is set to Y or N depending on whether the password matches or not.

Configuration

  1. Go to System Administration> OLIB Defaults.
  2. Opene User/Circulation Defaults in modify mode.
  3. Set Mandatory Password (SIP)to Yes.

A CQ field will be included in the Patron Status Response and Patron Information Response messages with a value of N if an AD field was not supplied or if a blank AD field was supplied in the corresponding request message.

If Mandatory Password (SIP) = No or if it is not set, the OLIB SIP Server does not test for the absence of an AD field or the presence of a null AD field in the Patron Status and Patron Information request messages.

Renew items via SIP

You can define which users can issue/return/renew items via self-service circulation machines. A setting is present in Circulation Reference Data - Loan Terms and User Categories:

  1. For example, go to Circulation Reference Data> User Categories.
  2. Set Allow Iss/Ren/Res via SIP? to Yes/No as required.

If set to No, the user will not be able to issue or renew an item using a self-service circulation machine. Instead, the SIPUCATNOISSRENRES or SIPLTNOISSRENRES message will be included in the response message that the OLIB SIP Server returns to the SIP client.