Skip to main content
OCLC Support

Overview

  1. Last updated
  2. Save as PDF
Find information about the Amlib SIP2 Manager including installation instructions.

 

Overview

SIP2 (Standard Interchange Protocol, Version2) provides communication between the Amlib Library system and other SIP2 compliant computer based applications. It provides controlled access to certain information from Amlib (for example details about Patrons or Items) via a TCP/IP connection through a nominated Port.

These applications include Self-Service Circulation (DIY) terminals, accessing EBooks from Online Suppliers, managing Library Internet PC processes such as PC Reservations, electronic resources and other communications. EBook applications need to verify that a patron has proper borrowing rights before allowing downloads of EBooks.

Request messages to perform operations are sent via a connection and responses sent in return.

There are three components that comprise the SIP2 module:

  • SIP2 Server which runs the AmlibSIP2Service in Windows
  • Configuration Manager enables settings to be made in relation to:
    • Database (Database definition, Usernames and Passwords to the Database)
    • SIP2 Server settings (Database prefix, Port Number and maximum No of connections)
    • Logging settings (Enabling, Log File size and Archive Files)
  • SIP2 Manager client program which is used to maintain the SIP2 settings including:
    • Listener
    • Instance settings. These include:
      • Parameters
      • Messages, Message fields and values

Note: The SIP2 Manager requires a code to be entered at Login to set the licence configuration. This is supplied by OCLC Amlib Support

A Self Check device is the connection initiator and the SIP2 server is a TCP/IP listener

  • From Amlib Version 5.4, a multi-threaded SIP2 Server is a replacement for the existing Amlib DIY module. There can be multiple listeners using a single instance
  • The multi-threaded server supports multiple TCP/IP connections from SIP2 clients whereas the Version 5.3 and older versions of the Amlib DIY module only supported a single SIP2 client connection
  • Each instance has its own set of messages, message fields and parameters. The parameters are not dependent on SIP2 client vendor types. The new SIP2 Manager is able to customise messages, their fields and parameters to a greater degree than in the previous version

Functionality exists within the SIP2 Manager for the creation, editing or deleting of Listeners, associated Instance parameters, Instance messages and Instance message fields and values

SIP2 redevelopment includes the reorganisation of existing parameters and addition of new parameters. The new parameters will facilitate vendor independent coding. It is possible to convert

existing Amlib DIY parameters to the new SIP2 Parameters during the Version 6.1 upgrade or later using the SIP2 Manager.

Summary

The following flowchart summarises the steps involved in setting up the Amlib SIP2 Manager and SIP2 Service applications:

Install Amlib 6.1 Client

Includes reconfiguration of the Amlib SQL databases using a Changes script with new Tables stored in the Local database

↓

Install SIP2 Manager

Install the Amlib SIP2 Manager

Configure connection to the Amlib SQL database using Amlib Configuration Manager

↓

Install SIP2 Server as a Service

Install the Amlib SIP2 Service Configure connection to the

Amlib SQL database using Amlib Configuration Manager

↓

Configure SIP2 Manager

Obtain Licence to set the maximum No of Listeners Configure the parameters and Messages for the SIP2 Manager – if already converted check and alter where necessary

↓

DIY Conversion

Optional conversion of the existing DIY parameters to the new SIP2 Manager parameters

↓

Configure SIP2 Service

Set up the Amlib SIP2 Server to run as a Windows Service

Installation of the SIP2 Manager and SIP2 service

Please follow the SIP2 Manager and Service Installation Guide is available from on the OCLC website, from Downloads and Software Updates > Version 6.1 > Installation Guides > SIP2 Service to install SIP2 Manager and SIP2 Service. The Default path is Program Files\OCLC\Amlib SIP2 Manager. The Amlib SIP2 Service is installed with a startup type of Automatic but not Started. A manual start is required after configuring the database settings etc. using the Amlib Configuration Manager below.

AMLIB Configuration Manager

The Amlib Configuration Manager eliminates the need for separate .ini files for Amlib and SQL.

The Manager uses an AmlibConfig.xml file to control how the particular Amlib application or service connects the Amlib SQL databases (and the Amlib client).

Each application or service will have its own AmlibConfig.exe file in the same folder containing the program executable.

  • Please Note: This configuration automatically has the AM (Live) and TE (Test) databases defined (but no connection details set).