Skip to main content
  • Subscribe by RSS
  • ExLibris Dev

    Self-Check Machines

    To configure a self-check type of integration profile, you must have the following role:
    • General System Administrator
    To associate a self-check profile with a circulation desk, you must have the following role:
    • Fulfillment Administrator
    Learn about Self-Check machines in the Integration with Self-Service Systems video (23:24 mins).
    Alma receives and acts upon received SIP messages from SIP 2.0 self-check machines and returns responses to these machines. For details on the integration with self check systems, see
    To configure the communication between Alma and a self-check machine, you must perform the following actions:
    1. Configure a self-check type of integration profile (see the procedure below).
    2. Associate the self-check profile with a circulation desk (see the procedure below). The self-check machine will be able to provide services only to locations that are serviced by this circulation desk. (Note that a circulation desk, if defined as a primary circulation desk, can service other libraries – see Configuring Fulfillment Relationships).
      If your institution is in the implementation phase, you cannot perform this step. Contact your Ex Libris project manager to perform this for you.
    3. Configure a secure transmission between Alma and the self-check machine, following the instructions located in the Ex Libris developers network: These procedures should be performed after you configure a self-check integration profile in Alma.
      A separate self-check profile and corresponding certificate (see step 5) are required for each group of self-check machines that have different capabilities (for example, one for machines that support fee payments and another for machines that support only check-in/checkout). A separate profile is also mandatory for each machine that is linked to a separate circulation desk, as each profile can be linked to only one circulation desk. Note that the certificate you obtain is valid as long as the integration profile exists, regardless of any changes made to the profile.
      The format of dates for self-check machine messages is determined by the system_time_format parameter (Administration > General Configuration > Configuration Menu > Other Settings). If this parameter contains the z symbol, the time zone is included in the date sent in self-check machine messages.
    To configure a self-check type of integration profile:
    1. On the Integration Profiles List page (Administration > General Configuration > Configuration Menu > External Systems > Integration Profiles), click Add Integration Profile. The first page of the integration profile wizard opens.
    2. Perform the following actions on this page:
      1. In the Code and Name fields, enter a code and name (respectively) for the profile you are defining.
      2. From the Integration type drop-down list, select Self-check.
      3. In the System (for Ex Libris’ informational purposes) field, indicate the type of self-check system with which you are integrating. Note that this is mandatory.
      4. Optionally, in the Description field, enter a description of the integration you are configuring
        Self-Check Machine Integration Profile Definition – Page 1
    3. Click Next. The second page of the wizard opens.
    4. Under General Information, perform the following actions:
      • In the SC Identifier field, enter any string.
      • Select whether you want the self-check machine to send the following to Alma:
        • Error correction – Select Yes for Alma to send/receive sequence numbers and checksums as part of the relevant messages. If this capability is enabled on the self-check machine, it must be enabled here as well. If you do not want to use this option, select No and turn it off also on the self-check machine.
        • Alert messages
        • Item transfer messages (not currently supported)
      • From the SC language drop-down list, select the language in which Alma and the self-check machine communicate.
      • In the Retries allowed and Timeout period fields, enter the number of times you want Alma or the self-check machine to try to send a message following a failure of the first message to reach its destination, and the amount of time, in seconds, between each retry.
        Note that the recommended number of retries allowed is 2-5 and the recommended timeout period is 5-7.
      • Select the actions to be supported (Yes/No) between Alma and the self-check machine. (Note that Return message is not currently supported.)
        If you are using a 3M self-check machine, the checkin option must be set to Yes, due to a 3M requirement for enabling initial communication. If you do not want the check-in action to be allowed, ensure that you block it when configuring your 3M self-check machine.
      • From the Extension type drop-down list, select Extended fines and fees (Extended check-in is not currently supported) to enhance your self-check messages (SIP2) with additional fields. This option includes the following elements for each open charge in the SIP2 Patron Information Response message and allows self-check users to view this information (if available) when requested:
        • EB - Barcode of the item that is linked to the charge (such as for an overdue/lost item)
        • ET - Title of the item that is linked to the charge
        • EC - Cash transaction type code
        • ED - Cash transaction type description
        • EF - Sum
        • EK - Fee ID
        • BZ - Payment transaction number
        Not all self-check machines support this option. This option should not be selected for self-check machines that handle only loans and returns (and not payment).
      • From the Item Identifier drop-down list, select the type of ID—Barcode, Call number, or Item ID—used to match physical items when incoming messages contain item IDs.
      • Under Authentication required, select Yes if you want the patron to be required to supply a password. (Note that the PIN code can be updated by the patron in Primo only if the use_pincode_for_selfcheck_machine parameter is set to true in the User Management Configuration > Configuration Menu > Other Settings Customer Parameters table.)
      • For a secure TCP connection, click Download Certificate to download and save the certificate so that it can be used when configuring Stunnel (see step 3 in the introductory section above).
        Self-Check Integration Profile Definition – Page 2
    5. Click Save. The profile you configured appears in the Integration Profile List.
    To associate a self-check profile with a circulation desk:
    1. Open the Circulation Desks List page (Fulfillment > Fulfillment Configuration > Configuration Menu > (ensure you have selected the correct library in the location drop down list) > Library > Circulation Desk).
      Circulation Desks List Page
    2. Select Actions > Edit for the circulation desk you want to associate with the previously defined self-check profile, or click the Add Circulation Desk button to create a new circulation desk with which you want to associate the self-check profile.
    3. On the Circulation Desk – General Information page, under Self-Check Information, select the Has self-check check box and select a previously defined self-check profile from the Integration profile drop-down list. The password for the self-check machine is automatically listed in the Terminal password field. (For information on the other fields on this page, see Configuring Circulation Desks.)
      Self-Check Information Section
      Verify that the Circulation Desk associated with the self-check profile does not have the Reading Room Desk checkbox selected. Otherwise, items that are checked out via self-check at this desk will not get desensitized.
    4. Click Save to store your changes to the circulation desk.
    // feedback widged