Skip to main content
Help Center

Authentication Setup and Testing Checklist

Use this checklist when setting up a new authentication method or confirming that an existing connection is ready for patrons to use.

Complete the checklist for either manual authentication or automated authentication, then test the reader experience before sharing ePlatform with your wider school community.

Before you begin

Confirm which authentication method your library will use:

  • Manual authentication: Patron accounts and login details are managed directly in ePlatform.
  • Automated authentication: ePlatform connects to an existing SSO provider, directory service, Library Management System, or supported API.

If you plan to restrict titles by age or year level, make sure the selected method provides accurate year-level or date-of-birth information.

Manual authentication checklist

1. Prepare your patron data

Patron accounts can be added individually or imported in bulk using an Excel or CSV file.

For a bulk import, prepare the following information:

  • Barcode or username: Required for each patron account.
  • Password: The password the patron will use with their barcode or username.
  • Name: Optional patron information.
  • Role: Optional patron information.
  • Year level: Include this if your library uses year-level restrictions.
  • Date of birth: Include this if your library uses age restrictions.

2. Download the sample import template

  1. Sign in to ePlatform using an administrator account.
  2. Open the Admin area.
  3. Go to Patrons → Import / Update Patrons.
  4. Download the sample file from the import page.
  5. Add your patron information to the template.

3. Import the patron accounts

  1. Return to Patrons → Import / Update Patrons.
  2. Upload the completed Excel or CSV file.
  3. Complete the import using the instructions displayed on the page.
  4. Open the Patrons page and confirm that the accounts appear.

To create a single account instead, open the Patrons page and use the Add Patron option.

4. Prepare test accounts

Identify two or three imported patron accounts that can be used to test signing in and borrowing.

Automated authentication checklist

1. Confirm the connection method

Identify the system that will authenticate your patrons, such as:

  • a SAML Single Sign-On provider;
  • Google or Microsoft;
  • LDAP or Active Directory;
  • SIP2 through a Library Management System; or
  • a supported Library Management System API.

2. Confirm the required connection details

The information required depends on the selected authentication method. Examples include:

  • SSO metadata and user attributes for a SAML connection;
  • directory server details for LDAP;
  • SIP2 credentials, server address, and port supplied by your LMS provider; or
  • an API key, API secret, and endpoint URL for a supported API connection.

Use the setup guide for your selected provider in the Single Sign-On (SSO) or Library Management Systems (LMS) & MARC Records section.

3. Confirm the patron information provided

Confirm that the connected system provides the patron information required by your library.

This may include:

  • a unique patron identifier;
  • the patron’s name;
  • their role;
  • their class or form;
  • their year level; or
  • their date of birth.

Year-level or date-of-birth information is particularly important if your library uses content restrictions.

4. Complete the technical setup

Work with your IT team, system provider, and ePlatform Support to configure the connection.

Some LDAP, SIP2, or API connections may require firewall configuration before ePlatform can communicate with the connected system.

5. Prepare test accounts

Identify two or three accounts in the connected system that can be used to test signing in.

If your library uses age or year-level restrictions, include test accounts with different age or year-level information.

Test the authentication method

Complete these tests before providing sign-in instructions to all patrons:

  1. Open your library’s ePlatform sign-in page.
  2. Sign in using the first test account.
  3. Confirm that the account reaches the correct ePlatform library.
  4. Confirm that the patron can browse and search the library.
  5. Borrow an available eBook or Audiobook.
  6. Open the title and confirm that reading or playback begins.
  7. Sign out and repeat the test with the remaining accounts.
  8. If your library uses content restrictions, confirm that each test account receives access appropriate to its age or year-level information.

If testing is unsuccessful

Manual account

  • Confirm that the barcode or username matches the patron record.
  • Confirm that the correct password is being entered.
  • Open the Patrons page and confirm that the account exists.
  • Update the patron’s login details if required.

Automated connection

  • Confirm that the test account can sign in to the connected system.
  • Confirm that the required patron information is available in that system.
  • Record any error message displayed during the ePlatform sign-in attempt.
  • Contact your IT team or ePlatform Support with the test results.

Need help?

If authentication testing is unsuccessful, submit a support request or email support@eplatform.co.

Include:

  • your library name;
  • the authentication method being tested;
  • the steps completed before the problem occurred;
  • the error message displayed, if any; and
  • whether the problem affects one test account or every test account.