OpenAthens Questionnaire for Connector (v2)

Please select your language.

OpenAthens is a single sign-on (SSO) service that offers library end users a seamless experience and the benefit of secure SAML access. Library administrators can use OpenAthens to manage group authorizations and access, pull granular usage data, and consolidate both SAML and proxy IP authentication into a single, fully cloud-hosted solution.

This questionnaire outlines the information needed from customers to configure a connection between OpenAthens and the customer's IdP (Identity Provider) or Local User Directory to pass account information.
IT may need to coordinate with the Library for some reporting or attribute release/mapping questions.

More information can be found here as well.

1. Customer Info

Institution Name:

Institution's EBSCO Customer ID:

Name of your EBSCO Implementation Project Manager:

IT Contact Name:

IT Contact Email Address:

Other Contact info:

4. MetaData

Please provide the IdP's SAML metadata (.xml file or URL):

Upload file :

or provide a Metadata URL (if metadata is uploaded as a file instead, please indicate so below):

Once the IdP's SAML metadata is ingested into OpenAthens, EBSCO Implementation team will provide an OpenAthens SAML metadata file to be configured in the IdP settings as a relying party trust.

5. Unique Identifier

5.1 Please provide the attribute to use as 'unique user identifier':

The only data attribute that is required by OpenAthens is any data that uniquely identifies each account, such as an ID number, targetedID, or emailAddress.
Since privacy is a concern, it is important to know that OpenAthens does not require personally identifiable data.
For additional information on these parts of an OpenAthens setup and controls over data release, please see this FAQ.

5.2 Is your institution a FOLIO customer, or will it be?

YesNoUnsureFOLIO requires a fixed, transferable attribute to connect via Single-Sign-On both to OpenAthens and to EDS for Patron Empowerment. By default, OpenAthens releases to vendors only an anonymous unique identifier (Targeted User ID) which cannot be used as a match point when establishing a connection with other platforms. If you are a FOLIO customer or plan to be one, this identifier should not be used and another attribute should be released and mapped to FOLIO as unique identifier instead, whose values should match those present in the External System ID field within FOLIO.

6. Attributes to be released

Are there any other attributes that should be released and mapped?

YesNoUnsure, may provide later based on project requirementsPlease note, this list may change based on project requirements - the library may also request for other attributes to be release based on permission or reporting requirements, or to allow personalization into resources when available, that often requires releasing First Name, Last Name, and Email address.

6a. Please provide the attributes that will be released in addition to the Unique Account Identifier. Please enter how the attribute is called in the Local User Directory and appears when released to external systems. Leave blank if the attribute listed will not be released.

Display Name:

Examples: displayName, cn, name, etc.

First Name:

Examples: givenName, forenames, firstname, etc.

Last Name:

Examples: surName, surname, LastName, etc.

Email Address:

Examples: email, mail, emailAddress, etc.

Additional Attributes and their mapping use/purpose:

Other:

To be used for:

6. Evergreen ILS

6.1 Display Name:

6.2 Callback URL:

6. SirsiDynix Connector

Note:

To set-up a SirsiDynix connector, access to at least version 4 of the SirsiDynix Symphony Web Service (API) is required.

Most of the information can be found in your web service url, e.g. https://sdcatalog.yourdomain:443/symws2015.10/.

The components in this example are listed against the field names below for guidance.

Contact your SirsiDynix account manager OR log a call with their support desk if you're unsure how to answer these questions.

6.1.Server Host:

E.g. sdcatalog.yourdomain.com

6.2. Port:

E.g. 443

6.3. Endpoint URL:

E.g. /symws2015.10

6.4. Client ID field:

E.g. DS_CLIENT

6.5. Select the most appropriate option for your login page:

Username and PasswordBarcode and Pin

6.6 Administrator details:

Some required user attributes can only be retrieved with a Symphony administrator account with privileged/elevated status. Please provide an administrator login below.

Symphony Admin Username:

A temporary account from the Local User Directory is to be used by EBSCO's Implementation team for testing during configuration. This is known to make the overall setup process more efficient. EBSCO will notify you when we no longer need the credentials and the account can be disabled/deleted.

If provided a test account, EBSCO will run a SAML trace to confirm connector is functional and passing appropriate attributes.
If no test account is provided, EBSCO will require additional time or effort from you to confirm that the connection is working and releasing all necessary attributes.

Note, the test user must emulate an actual patron. It must have all attributes and permissions assigned to it to verify the connection is correct.

Symphony Admin Password:

6.1. LDAP

Server host:

Server port:

Admin Bind DN:

Admin Bind password:

Server's root certificate:

The root certificate for the LDAP server is required to establish a trusted connection. If you need assistance locating your root certificate, this document may be helpful.

Base DN:

Filter:

6.1. OIDC Connection

Configuration URL:

10. Additional Contacts

Please list email addresses for any additional contacts (including your EBSCO Implementation Project Manager) who should receive a copy of this questionnaire submission. A copy will be sent to the contact listed earlier as well.

One email per field.

11. Additional Comments

If you have any questions, comments, or concerns in regard to this form, please address them below (250 character limit):

For questions, comments, or concerns in regards to your general OpenAthens implementation, please contact your Implementation Project Manager or email SaaS Implementations.

Please upload any file that you think may be useful:

Submission

Upon submission of this form, the EBSCO Implementation team will provide the necessary information to complete the OpenAthens Connector setup.

They will then continue to work with the library to launch the service for your institution's subscriptions.

Once completed, your end users will be able to log into your library's subscribed content using OpenAthens. When they start a new browser session, they will be prompted to log in using their institutional account. A single log-in through OpenAthens will represent the beginning of their single sign-on session, so additional clicks to full text options will not require an additional log-ins.

For additional information and documentation on the OpenAthens service during this time, please reference the following:
OpenAthens documentation
OpenAthens Onboarding Guide, a reference manual for libraries approaching an OpenAthens implementation.
Virtual Learning Environment, self-led training courses for new OpenAthens administrators. Please note, an OpenAthens administrator account is required to log into the VLE; this will be provided to your library by your EBSCO Implementation team once your dashboard is available.
EBSCO-led OpenAthens training sessions are open to any participants and covering topics from administration basics to usage reporting.
EBSCO-led recorded OpenAthens Training session to view at your convenience.