Skip to main content
Version: ILLiad 10.0 (Pre-release) 🚧

Migrating from PatronAPI to ILLiad Basic Authentication

If your library is migrating away from the Innovative Interfaces (III) Innopac integrated library system or discontinuing use of the PatronAPI module, you will need to transition your ILLiad authentication from PatronAPI to ILLiad Basic Authentication. This guide provides step-by-step instructions for making this transition.

Overview​

When using PatronAPI authentication, ILLiad validates users against your III Innopac system during registration and login. When switching to ILLiad Basic Authentication, users will not be verified in Innopac. Staff will need to review and clear new user registrations manually.

info

For more information about how ILLiad Basic Authentication works, see ILLiad Basic: Authentication Process.

Before You Begin​

  • Backup your ILLiad database before making any configuration changes (for self-hosted users)
  • Communicate the change to your users if necessary
  • Review manual user clearance steps with staff, as new user registrations will require manual review
  • Schedule the migration during a low-traffic period if possible

Configuration Changes in Customization Manager​

1. Change Authentication Type​

Navigate to Web Interface → Authentication:

  1. Locate the WebAuthType key
  2. Change the value from PatronAPI to ILLiad
  3. Click Save

2. Disable PatronAPI Settings​

Navigate to Web Interface → Innopac:

  1. InnopacPatronAPIAddress: Clear this field completely (remove the URL)
  2. InnopacPatronAPIField: Clear this field
  3. InnopacPatronAPIExclusive: Change to No
  4. Click Save

3. Configure User Management Settings​

Navigate to Web Interface → General:

  1. AutoClearPreRegisteredUsers: Change to No
    • This ensures new users are not automatically cleared and require staff review
  2. AutoClearSendEmail: Change to No
    • This prevents automatic email notifications until staff manually clear users
  3. Click Save

4. Verify Remote Authentication Settings​

Navigate to Web Interface → Authentication:

  1. RemoteAuthSupport: Verify this is set to No
  2. Click Save if any changes were made

5. Review Web Validation Settings​

Navigate to Web Interface → Validation:

  1. Review any validation rules related to PatronAPI, such as:
    • Library card number format requirements
    • Required field validations
    • Patron type validations
  2. Modify or remove PatronAPI-specific validation rules as needed
  3. Click Save if any changes were made

Web Interface File Updates​

6. Update Registration and Login Pages​

Review and update the following web interface files to remove any PatronAPI-specific instructions or references:

  • Logon.html - Main login page
  • Logon2.html - Alternate login page
  • NewUserRegistration.html - New user registration form
  • ChangeUserInformation.html - User information update form
  • FirstTimeUsers.html - First time user information page
  • FAQ.html - Frequently asked questions page (if it references authentication)
tip

Check for any status-specific registration pages (e.g., separate pages for faculty, students, staff) that may also need updating.

Changes to Look For​

When reviewing these files, look for and update:

  • Instructions that reference logging in with library system credentials
  • Help text mentioning library card numbers or barcodes from III
  • Language indicating that accounts are validated against the library catalog
  • Patron status or type information that came from PatronAPI

Replace this information with guidance appropriate for ILLiad Basic Authentication, such as:

  • Users will create a username and password specific to ILLiad
  • New users can begin submitting requests immediately after registration
  • Accounts will be reviewed and cleared by library staff
  • Password reset is available through the ILLiad interface

Post-Migration Testing​

After making all configuration changes, perform thorough testing to ensure the new authentication method is working correctly.

7. User Registration Testing​

  1. Test new user registration:

    • Navigate to your ILLiad web interface as if you were a new user
    • Click the "First Time Users" link
    • Complete the registration form with test data
    • Submit the registration
    • Verify you can immediately log in with the credentials you created
    • Verify you can submit a test request

  2. Verify registration validation:

    • Test required field validation
    • Ensure appropriate error messages appear for invalid data

8. User Authentication Testing​

  1. Test existing user login:

    • Have an existing user attempt to log in

  2. Test password reset functionality:

    • Click "Forgot Your Password?" or equivalent link
    • Enter a valid username
    • Verify password reset email is received
    • Follow the reset link and create a new password
    • Confirm login works with the new password

  3. Verify user access:

    • Test that users can access all necessary features:
      • Submit requests
      • View request history
      • Update user information
      • Renew items (if applicable)

9. Administrative Testing​

  1. Check user management in Client:

    • Open the ILLiad Client
    • Navigate to Pre-Processing → Clear New Customers
    • Verify test users appear in the "Users to Clear" list
    • Test the Clear button to approve a user
    • Verify appropriate email is sent

  2. Review staff workflow:

    • Ensure staff understand the new user review process
    • Confirm staff can distinguish between legitimate users and spam registrations (consider adding Captcha)
    • Test the Merge function if users have duplicate accounts

  3. Monitor for several days:

    • Watch for any authentication errors
    • Review new user registrations for any patterns or issues
    • Gather feedback from users and staff

Additional Considerations​

Staff Training​

Ensure staff are trained on:

  • The new user review workflow
  • How to identify legitimate users vs. spam registrations
  • How to clear, disavow, or merge user accounts
  • Password reset assistance procedures

Transition Period Planning​

  • Consider implementing the change during a low-volume period
  • Monitor the system closely for the first few days after migration

Need Help?​

If you encounter issues during migration or have questions about this process, please contact Atlas Systems Support: