Content Column |
---|
tabbed-blocks | tabs |
---|
id | 1281497174 |
---|
| Content Block |
---|
| What are administration settings?The Administration settings are high-level preferences intended for network administrators, IT support departments, or operators with administrator-level permissions; in other words, they're advanced settings used to configure your main Data Station once and then be forgotten. While every operator with the proper security permissions can access the Administration module, it contains settings that most operators won't be able to configure without help. An operator's access to these settings is governed by Alexandria's security preferences. Your library's administrator can manage these settings in Tools > Preferences > Security.
- Send Data to COMPanion. If a Customer Support Representative needs your library data for troubleshooting you can easily send it to us by selecting this option and entering the Authorization Code you are provided.
Log Out. This button will log you out of Alexandria, despite if you have multiple windows open.
Quit Alexandria. This option will stop the Data Station from running and log out any active operators.
| Status | These settings allow you to perform maintenance on your library catalog and update your Alexandria program. | | Email | These settings allow you to designate an SMTP server to use for sending emails, such as Item Overdue Notices, to patrons and/or staff. | | LDAP | These settings allow you to authenticate operator and patron program access. | | Checkpoint | If your library utilizes the Checkpoint ILS security system use these setting to enhance your SIP2 protocol. |
|
Content Block |
---|
| What does the status interface do?
Column |
---|
| ![Cannot generate thumbnail for the file 'Alex Admin Status.png' attached to the content 'Administration Settings'.](/plugins/servlet/confluence/placeholder/error?i18nKey=editor.placeholder.broken.image&locale=en_US&version=2)
|
Column |
---|
It's where an operator can easily access their Alexandria registration information, perform database maintenance, run or restore from archives, and update to the latest version. It's the default interface when accessing administration settings. |
You have the ability to preserve and maintain your library catalog data by utilizing the following options through the status interface.
|
Content Block |
---|
| Web settings allow Alexandria to communicate with the outside world. Self-Hosted customers will need to configure these setting before using the web modules of the program. For a Centralized or Distributed catalog these settings will apply to all sites. A Cloud-Hosted customer doesn't have access to the web settings, because their data is hosted on a designated COMPanion server. Alexandria uses Transport Layer Security (TLS) for secure web communications. These settings allow you to configure the certificates, ports, and server domain names that Alexandria uses to communicate with web browsers. When you save changes to this window, the Data Station will apply your new settings and restart web services.
- Enter the domain name or IP address that connects to your Data Station in the Server Domain Name filed.
- Enter the port number that Alexandria uses to access the web service in the Port ID filed. This is typically port 80 or 8080.
- Uncheck the box for Allow Non-Secure Connections if you want to maintain secure web communications. (optional)
- Enter the port number used for the secure web interface in the Secure Port ID field. The default is 443.
- Enter the private key password in the Private Key field if required. (optional)
![Alex Admin Settings Web.png](/plugins/servlet/confluence/placeholder/unknown-attachment?locale=en_US&version=2)
- Enter the private password again in the Verify Private Key Password field to verify it. (optional)
- Enter the file name and location of the Data Station’s private key in the Path to Private Key field.
- Enter the file name and location of the Data Station’s public certificate in the Path to Certificate field.
Enter the file name and location of the Data Station’s chain file in the Path to Chain field. (optional)
Warning |
---|
| Expand |
---|
title | Only certificates in PEM format are recognized. |
---|
| The PEM (Privacy Enhanced Mail) is an early standard for securing electronic email. This format is not widely adapted as an internet mail standard. |
|
Enter the port number used for the SIP2 communications in the SIP2 Port ID field. The default is 6001. Check the box for Use Secure SIP2 Connection if you are using a Secure SIP2 Connection. (optional) Click Save in the upper right of the window.
Create Temporary Certificate—If clicked, a temporary private key and public certificate will be created with help from Alexandria’s registration information and saved to the default path and location specified above; they will expire 365 days after creation. Temporary certificates that Alexandria generates are always saved to the SSL folder in the Alexandria Support folder, even if the Path to Certificate that you entered is different than the SSL folder. Since we do not require certificates to exist, Alexandria does not test to see if the Path to Certificate is valid, even if the path entered is different than the default. Alexandria does not relocate certificates from any location. Generate Certificate Signing Request—If clicked, then a request for a certificate will be created. This request can be sent to a certificate authority. The Microsoft Certificate Server is not supported; you will have to use a code signing authority such as GoDaddy™, Comodo ©, or VeriSign™. |
Web settings allow Alexandria to communicate with the outside world. Self-Hosted customers will need to configure these setting before using the web modules of the program. For a Centralized or Distributed catalog these settings will apply to all sites. A Cloud-Hosted customer doesn't have access to the web settings, because their data is hosted on a designated COMPanion server. Alexandria uses Transport Layer Security (TLS) for secure web communications. These settings allow you to configure the certificates, ports, and server domain names that Alexandria uses to communicate with web browsers. When you save changes to this window, the Data Station will apply your new settings and restart web services. Enter the domain name or IP address that connects to your Data Station in the Server Domain Name filed. Enter the port number that Alexandria uses to access the web service in the Port ID filed. This is typically port 80 or 8080. Uncheck the box for Allow Non-Secure Connections if you want to maintain secure web communications. (optional)Enter the port number used for the secure web interface in the Secure Port ID field. The default is 443.Enter the private key password in the Private Key field if required. (optional) Image RemovedEnter the private password again in the Verify Private Key Password field to verify it. (optional)Enter the file name and location of the Data Station’s private key in the Path to Private Key field. Enter the file name and location of the Data Station’s public certificate in the Path to Certificate field. Enter the file name and location of the Data Station’s chain file in the Path to Chain field. (optional) Warning |
---|
| Warning |
---|
| SIP2 Port ID—Enter the port number used for the SIP2 communications. The default is 6001.Use Secure SIP2 Connection— Enable this setting if you are using a Secure SIP2 ConnectionCreate Temporary Certificate—If clicked, a temporary private key and public certificate will be created with help from Alexandria’s registration information and saved to the default path and location specified above; they will expire 365 days after creation. Temporary certificates that Alexandria generates are always saved to the SSL folder in the Alexandria Support folder, even if the Path to Certificate that you entered is different than the SSL folder. Since we do not require certificates to exist, Alexandria does not test to see if the Path to Certificate is valid, even if the path entered is different than the default. Alexandria does not relocate certificates from any location. Generate Certificate Signing Request—If clicked, then a request for a certificate will be created. This request can be sent to a certificate authority. The Microsoft Certificate Server is not supported; you will have to use a code signing authority such as GoDaddy™, Comodo ©, or VeriSign™. | |
Content Block |
---|
| Send your patrons email notificationsTo send email reminders, such as the Overdue Items Notice, you will need to configure how Alexandria communicates with your library's email server. Alexandria's email system is designed to potentially cope with hundreds of emails being sent (or resent) over many machines at the same time. Info |
---|
Expand |
---|
title | What happens if an email fails to send? |
---|
| If a send fails, the next resend time is generated by adding a random value between 3 and 9 minutes, spreading out the resend times so all the undelivered email still in the “short range” period isn't sent at the same time. If a send hasn't succeeded by the end of the “short range” period, the program will generate new send times using random values between 60 and 90 minutes. If a send still hasn't succeeded after 100 hours the email is discarded and a “return-to-sender” email will be sent. |
|
The Server 1 and Server 2 sections are used for out-bound email. Server 1 is the primary server and Server 2 can function as a back up server should server 1 fail. You only need one SMTP server to use the email functionality; for networks with a single SMTP server configure the setting in the Server 1 section. SMTP Server 1 and 2. This is the TCP/IP or DNS address of your library's mail server. Typically, this will be “ mail.” followed by your domain name. Port. Enter the port number that your email server uses. Allow Non-Secure Connections. Alexandria uses Transport Layer Security (TLS) for secure web communications, when this setting is enabled the system will use non-TLS connections if it cannot make an TLS connection. Log In. Enter the login for your email server. Password. Enter the password for your email server. Test Server. Test the SMTP Server settings by sending a test email. This email is sent to the email address listed in the Sites module. Last Tested On. This field displays the last date/time that the server test was performed. Last Test Results. This field displays whether the test was successful or not.
Setting Up Your SMTP Server Before setting up your SMTP server you will need to enter a valid email address in the sites management settings of Alexandria. - Click on Tools to the left of your Circulation window.
- Click on Sites under the Management header.
- Enter the name of your site contact (typically this will be the District or Library Administrator of Alexandria), their title, their email and their phone/fax numbers.
- Click Save in the upper right corner.
Once you have saved this information you are ready to set up the SMTP server. - Access Tools > Administration.
- Click Email on the left.
- Enter your SMTP server address and port in the available fields.
- Check the box if you want to allow non-secure connections. (optional)
- Enter the login and password for your SMTP server.
- Click Save in the upper-right corner of the window.
- Repeat steps 1-6 if you want to configure a back up server for Server 2.
Using Gmail as your SMTP ServerA Gmail account can be used as a portable SMTP server if your library's network does not already have one. Before you configure Alexandria to use Gmail, you will need to set your Gmail preferences to Allow Less Secure Apps. Info |
---|
Expand |
---|
title | Allow Less Secure Apps |
---|
| In order for the program to make contact with your Google SMTP, it's necessary that Alexandria (the App) retrieves your sign in credentials from Google. As such you must set your Google Account settings for Access for Less Secure Apps from No to Yes. This can be done by going to Account Settings or by clicking here, then apps with account access (you may need to sign in to see these settings). COMPanion Corp stores your credentials only for the purpose of utilizing Google's SMTP email service and it's stored using the most up-to-date security. It is not used by COMPanion for any other purpose. For more information about allowing less secure apps you may review Google's support page here. |
|
- Access Tools > Administration.
- Click Email on the left.
- Enter smtp.gmail.com as the SMTP Server Address.
- Enter 587 as the port.
- Check the box if you want to allow non-secure connections. (optional)
- Enter the login and password for your Gmail account.
- Click Save in the upper-right corner of the window.
- Click Test Server to ensure the Gmail account is acting as a server.
- Repeat steps 1-8 if you want to configure a back up server for Server 2.
|
Content Block |
---|
| LDAP supports user-authentication for open or active directoriesLightweight Directory Access Protocol (LDAP) is an application protocol for querying and modifying directory services running over TCP/IP. Alexandria supports user-authentication using existing log-on credentials maintained on a separate directory server. With LDAP enabled, administrators can now choose to manage these credentials on a central LDAP server as these credentials may change frequently and often need to be standardized across many different systems. A permanent record must exist locally in the Alexandria database for all patrons and operators that use the system however their log-on credentials can be managed outside of Alexandria on your LDAP server directly. Warning |
---|
| Operator usernames and barcodes must be unique. Please make sure your Alexandria patrons do not have the same barcode as an operator. |
How does it work?
The COMPanion software will send the credentials the user enters in any log-in dialog to the specified LDAP server in the form of a BIND. If the BIND is successful, the software will locate the user's record within the local database by searching the information returned in the specified Local ID field from the LDAP server. Once the record is found, the user will be logged in. Alexandria will test the credentials against the local data base if the login attempt fails.
Configuring LDAP SettingsIf you are a Centralized Catalog these setting will apply to all sites within your controller. - Navigate to Tools > Administration > LDAP.
- Check Enable LDAP.
- Enter the name of you LDAP domain, i.e. “yourdomain.com” in the LDAP Domain field. The domain name is used in conjunction with sAMAccountName to produce a complete userPrincipalName.
- Enter the full name of the LDAP server, i.e. “ldap.yourdomain.com” in the LDAP Server field. This will be the host address of the LDAP server for network communication.
Check Allow Non-Secure Connections if you would like Alexandria to use non-TLS connections when it cannot make an TLS connection. (optional) Info |
---|
Expand |
---|
| We highly recommended that you secure communications with the LDAP server by requiring TLS. TLS configuration is performed at the system level. When these settings are correctly configured for secure communications with your LDAP server, Alexandria will be able to communicate with the LDAP server securely. |
|
- Enter a DN that matches all the users, i.e. “cn=users,dc=ldap,dc=yourdomain,dc=com” in the Base DN for all LDAP users field. Multiple Base DNs can be specified if separated by semicolons i.e. “cn=staff,ou=COMPanion,dc=demo,dc=goalexandria,dc=com;cn=student,ou=COMPanion,dc=demo,dc=goalexandria,dc=com”.
![Alex Admin Settings LDAP.png](/plugins/servlet/confluence/placeholder/unknown-attachment?locale=en_US&version=2)
- Select the User ID from the dropdown menu. This is the LDAP login name; for an Open Directory, this is typically uid (i.e. “uid=yourlogin"). For an Active Directory this is typically cn, sAMAccountName, or userPrincipalName.
- Enter the LDAP database username that contains the patron username or patron barcode in Alexandria in the Local ID field. This must be one of the users' LDAP attributes; common attribute names include uid, uidNumber, givenName, cn, and others.
- Enter the Test Login.
- Enter the password for the test login in Test Password field.
- Click Test. This button initiates an attempt to log into the LDAP server using the settings and credentials you've entered.
- Click Save in the upper right corner of the window.
If configured correctly, your users should be able to log into Alexandria using the same login credentials as configured on the directory server for their account. However, sometimes difficulty arises. In these cases, verify your preferences settings and test whether the Base DN and other information you have specified is accurate to your configuration. We have found that Active Directory configurations seem to prefer binds using the user's CN while OSXs Open Directory prefers the uid (i.e. user identification). The use of ldapsearch tool is suggested. Alternately, ldp.exe can be utilized for testing in a Windows environment. Info |
---|
title | Non Secure Connection Testing |
---|
| The -ZZ parameter requires successful connection utilizing StartTLS over port 389. If you have selected to Allow Non-Secure Connections, omit this in your testing with ldapsearch as well. |
|
Content Block |
---|
name | Checkpoint |
---|
id | 1284022790 |
---|
| |
|
|