Skip to main content
OCLC Support

SIP2 Manager

Find login instructions, information about menus, and how to create, edit, and delete a listener in Amlib SIP2 Manager.

Login Instructions

  1. Launch the Amlib SIP2 Manager client – the Amlib Login with Connection Details window will display:
  2. Enter a valid Amlib User Name and Password (not case-sensitive)
  3. Select a Database – this should be the same Live database you use for Amlib
  4. Click the OK button – the Please select a location window will display:
  5. Choose a login location and click the OK button (by default, the Location setup for your Username in the Amlib Installation settings will be highlighted).

    Note: A different Location can be used for gathering Statistics for the Self Check Issues. This is set up on the Listeners Window – in the Location for Stats section
  6. The first time the login occurs, The Amlib SIP2 Manager dialogue box will display. It will be necessary to enter a code for the Number of Licences the site is configured to use. If you do not have the code it will be needed before the setting up of the Manager can go any further. Contact Amlib Support to obtain the relevant code
  7. Click OK
  8. The Enter Licence Code dialogue box will display
  9. Enter the licence code and press OK
  10. The Amlib SIP2 Manager confirmation box will appear showing the No of licences applied

    **Ensure that the Maximum Number of Concurrent connections configured in the Configuration Manager is equal to or greater than the No of Licences
  11. Click OK
  12. The SIP2 Manager box displays to give the information about initialising the SIP2 system before use. It is possible to Convert existing DIY parameters to initialise the system.
  13. Click OK to continue
  14. The Create SIP2 Master Message and/or convert DIY Parameters Dialogue box will display
  15. Click the Convert from DIY parameters if a conversion is required from the parameters set in DIY (suggested). See Convert DIY
  16. At the finish, a message will display

Note: The licences are set up as a range:

  • 1 user
  • 2-5 users
  • 6-10 users
  • 11-20 users
  • 21- Unlimited

Menus

File Menu

Properties

Displays the Paths for the Getting Started Manual and Procedure Manuals.

Please Note: It is possible to customise both the Getting Started guide and the full Procedures Manual – see: Appendix A: Modifying & Linking Your Own Manual in the Amlib SIP2 Manager Client

A full Help system is available within the Amlib SIP2 Manager client. From the menu, select Help Help – the Help guide will display.

Context sensitive Help is available on each screen by clicking the F1 Function key on the screen Window on which Help is required.

In addition, a Getting Started guide and the full Procedures Manual (both in PDF) can be accessed from the Help menu.

Exit

Closes the Amlib SIP2 Manager

Note: The SIP2 Manager can also be closed by clicking the X on the top far right Corner of the SIP2 Manager Window

Instances Menu

Instances

Displays the Instances currently defined.

From this Window it is possible to select buttons for the following:

  • New: Create a New Instance
  • Edit: Edit the Instance to change the description of an Existing Instance
  • Edit Messages: All the Messages will display for the existing Instance. It is then possible to Add, Edit or Delete Messages – See more information in separate section
  • Edit Parameters: All the Messages will display for the existing Instance. It is then possible to Add, Edit or Delete Parameters - See more information for Edit Parameters
  • Delete: Delete Instances to remove them from the SIP2 Manager. Instances cannot be deleted if they are being used by a Listener

Convert DIY

Create SIP2 Master Messages and, if selected, Convert DIY Parameters to SIP2 Parameters. This Process will create a New Instance which can then be further modified if required

Enter Licence Code

Allows the entry a new code to update the Number of Licences the site is configured to use.

Help Menu

Getting Started Manual

Displays the Getting Started Manual from the path as shown in the Properties

Procedure Manual

Displays the Procedures Manual from the path as shown in the Properties

Help

Displays the full SIP2 Help Contents

About

Displays the Version number and Copyright details

Main Window

The SIP2 Main window displays any configured Listeners. A Listener defines an incoming TCP/IP connection to the SIP2 Server, the instance it will use for the SIP2 messages, an Amlib logon to load circulation parameters and a location for statistics. from SIP2 devices via TCP/IP connections. It is possible to have different Listeners connect to a single Instance. When defining the Listener an IP Address or Host Name can be used

Create a New Listener

  1. Click the New Button - the New Button will be disabled if the number of Listeners configured is equal to the No of Licences
  2. Select the Instance from the Drop-down list of Instances (If no Instances display, these need to be set up first from the Instances Menu – See Create a New Instance)
  3. Enter the Client Address of the Self Check device which must be either the IP or Host Name. This is used to load the SIP2 parameters of the instance after an incoming connection is received
  4. If the details listed are the IP address ensure the Checkbox for IP Address is ticked
  5. Select the Amlib Login Username from the Drop-down list of valid Usernames. The Username is used to get the Login Location and Circulation Parameters etc
  6. Enter the Location for where the Circulation statistics will be posted to for reporting.


    This could be the same as the Login Location or a different Location if separate statistics is required for just the Self Check device. A new Location could be created in Amlib and used just for the collection of statistics for the Device. This is most relevant for Returns type devices.
  7. Click Apply to save the settings or Cancel Edit to discontinue with the editing

Edit a Listener

To change any details for the Listener

  1. Highlight the Listener on the Listeners Table (from the Main Window of the Amlib Sip2Manager )
  2. Click the Edit Button
  3. The entries for each field displays
  4. Change the Instance if required
  5. Change the Client Address – IP Address or Host Name if required
  6. Change the Location for the collection of Statistics if required
  7. Click Apply to save the settings or Cancel Edit to discontinue with the editing

Delete a Listener

  1. Highlight the Listener on the Listeners Table (from the Main Window of the Amlib SIP2 Manager )
  2. Click the Delete Button
  3. A confirmation message will display
  4. Select Yes to delete the Instance or No to cancel out of the deletion process