For more detailed explanations of the Master Messages please refer to the 3M Standard Interchange Protocol, Version 2.00
ACS: Automated Circulation Software which is Amlib in this context
Action: Predefined valid action that may be defined that has relevance to the Vendor . Used for Source values of Parameters. Examples include Borrower Issues Count, Item Memo Count etc.
Block Patron: Request Message that the patron card be blocked by Amlib due to a reason raised at the Self Check device due to tampering or because a card was left in the device. Request Message 01 – Response Partner is 24 Blocked Status Response
Configuration Manager: Contains the database settings and a SIP2 Server Tab with Server settings
Checkout: Request Message (Message11) used by the Self Check device to process an Issue (Loan) of an Item. Respond with Checkout Response ( Message12). This Request has a series of Amlib Parameters to Check and Parameters to Process as well as undergoing Amlib Circulation Checks (for example Loan Privileges)
Checkin: Request Message (Message9) used by the Self Check device to process a Return of an Item. Respond with Checkin Response (Request Message10). This Request has a series of Amlib Parameters to Check and Parameters to Process as well as undergoing Amlib Circulation Checks (for example Loan Privileges)
Constant: A uniform Value entered as Text that will remain the same under different circumstances. Used for Source values of Parameters. This Value is fixed
Database: Fields and Values are derived from the Tables and Columns within the Database structure. At least 2 String entry Values are needed – the actual Table name and a Column field
Fields: Standard SIP2 Message Fields contain Values that make up a Response Packet. These are defined within each Master Message and contain information such as Fee Amount, RenewalOK . They are sent as a Field ID within the packet - For example AA (Patron Identifier). The can be of varying types – Action, Constant, Database, Incoming, , Parameter, System. There are also Fields that contain Value for Parameters to Check and Parameters to Process that impact on whether the Response will be actually sent or stopped
Incoming: Source Type is determined by the Request packet and contains Field Names relevant to the Vendor in the Message being received.
Instance: Set of Parameters that can be customised by a site to suit the connection activity between Amlib and a Vendor for SIP2
IntegerValue: Number Value
Instance Messages: SIP2 communication includes a Request as well as a Response, so consists of Message pairs. Each Message pair is independent of previously sent or future Message pairs. Each Message has a standard number e.g. Checkout Response is Message 12
Instance Message Fields: The Fields and associated Values that make up a Message. For example, a Checkout Response, Message 12 may be made up of several Message Fields which contains Values
- Renewal OK, Fee Amount etc.
Listener: The Network computer that will receive messages from SIP2 devices via TCP/IP connections. It is possible to have different Listeners for each Instance. When defining the Listener an IP Address or Host Name can be used
Master Messages: The entire set of Request and Response Standard Messages and Standard Numbers supported for SIP2. These Messages contain Master fields. See Master Messages
Multi threaded SIP2: Supports multiple TCP/IP connections on a defined port from SIP2 Clients
Packet Format: Messages from and to the Client to Amlib. Each message packet starts with a command identifier, followed by field values and ending in a carriage return. Generally contains ASCII characters
Port Number: Defined Port Number which is used by the Server to “listen’ for the incoming TCP/IP connections from SIP2 clients
Request: A coded message (Message type 0) requesting information from Amlib. This can take many forms and usually results in a Response that is paired. For example a Checkout request is received and a Checkout Response packet is returned
Response: A coded message (Message type 1) responding to a Request and results in information being sent back. These can take many forms and usually results in a Response that is paired. For example a Checkout request is received and a Checkout Response packet is returned
SIP2: Standard Interchange Protocol provides communication between the Amlib Library system and other computer based applications via TCP/IP connections on defined Ports usually in range 6000 and above
SIP2 Server: Runs the SIP2 Service (AmlibSIP2Service) in Windows
SIP2 Manager: Client program which maintains the SIP2 Parameters used by the Server
Source: Source Values within the Parameters are combined with Target Values, are used with an Operator to return a True/False response. The Source Values will depend on the Type of Parameter and the column names available etc. Often it is easiest to decide on the Target Type required to limit the Source Values appropriate. For example find the Borrower Columns available in the Source Values for IntegerValues Targets
StringValue: An Alpha Numeric (Letter and/or Number) Value which can be picked up from the Database. For example Y or RM12
StringList: A List of Code Values that can be selected from the Special button (once selected it displays a list of codes to be selected by clicking the Check box of the relevant codes). One or more codes can be selected
Target: Target Values within the Parameters are combined with Source Values, are used with an Operator to return a True/False response.
Values: Information contained for the Fields. The Values are defined for the Parameters as Target Values and form the basis of the response field.