Technology Services Quick Reference for COMPanion Products
From COMPanion
Here we provide a quick reference for technicians integrating and supporting COMPanion's Alexandria and Textbook Tracker products at their site. Alexandria and Textbook Tracker are completely self-contained and can be installed and run from both “Server” and “Desktop” versions of Microsoft Windows and Macintosh OSX. Depending upon what services are used, the internet security of your site should be configured to allow communications on certain ports for specific domains. Several existing support documents detail the features of these products; use this reference as a starting point to help identify any issues that pertain to your specific site or to quickly find links to more detailed information in our online Wiki.
Part of understanding how Alexandria and Textbook Tracker works is understanding our terminology. We call our Alexandria/Textbook Tracker Server the Data Station. The application that librarians and operators use is called a Workstation. There is also a web-based interface for librarians and operators called the Web Librarian—for the time being, it has less functionality than an installed client workstation. For finding books in the library, your patrons use the web Researcher, where all searching is done via a web-based interface.
It is noteworthy to mention that our web clients are Web 2.0+ applications that require modern internet browsers (i.e. HTML 5) for the best user experience. At this time, COMPanion will continue to provide support for Internet Explorer 8, but it may have limited functionality.
Also, please note that our standard report format is PDF; all operators will need a PDF reader to view reports and some notices—on both the Data Station and any associated Workstations.
Getting Started ~ IT Technology Support Services
System Requirements
- These are COMPanion's “minimum” and “recommended” system requirements; often a guideline as opposed to an absolute rule. Recommended requirements are almost always of a significantly higher level that the minimum requirements, and represent the ideal situation in which to run our software. Generally speaking, the “recommended” is a better guideline than “minimum” system requirements in order to have a fully usable and enjoyable experience with our software.
Installation
- Installation and setup guides for all of our products can be found here. Follow these guides to learn our current hardware and software requirements along with initial step-by-step installation instructions. If you have questions or problems during installation, contact COMPanion's Technical Support Service at (800) 347-4942 or (801) 943-7277, by fax at (801) 943-7752, by toll-free fax at (888) 515-3883, or by email via: support@companioncorp.com.
Scheduled Maintenance
- The Data Station performs routine maintenance between 12:00-4:00AM; therefore, it should remain running at all times for optimum performance.
Scheduled Events: Backups & Archives
- You should have a backup strategy in place; use our built-in Archive functionality to create copies of your data, then backup these folders from the machine being used as the Data Station.
- Need to know what to backup? Click here.
Ports & IP Addresses
Since the Data Station acts as a server for a wide range of services, it requires a static IP address. If you want access outside of your network, it should have an external IP address, otherwise you can use a private static IP address. Most of our customers use an external IP address.
To fully optimize or guarantee performance, improve latency, and/or increase usable bandwidth for our web services, it may be necessary to implement bandwidth management and traffic shaping software/hardware; this way you can control, limit, or direct the traffic on your network and determine the allowed bandwidth consumption for our software.
Ports for Core Communications
- The Data Station communicates with Workstations via port 30427 (for Alexandria) or 30467 (for Textbook Tracker). Your network security should allow communications between Workstations and the Data Station over this port.
- The Data Station has an integrated Web Service that is initially configured for port 80. This can be changed in your Web Settings System Preferences, but we strongly recommend you leave it at port 80. Additionally, the machine the Data Station is running on shouldn't have any other program using port 80 or Alexandria's web service can not be activated.
- To send support email to COMPanion open port 25 from the Data Station and use mail.companioncorp.com.
- To use our Title Assistant capabilities, you'll need to allow open communications between the computer performing the search and various Z39.50 servers around the country via ports 210, 2200, and 7090.
- Our online help documentation requires open access to port 80 at www.companioncorp.com/ (i.e. 209.210.70.4).
- Use the following URL to search for help-related topics: http://www.companioncorp.com/mediawiki/index.php/Main_Page
- Instructional videos require open access to 69.89.29.89 (i.e. bluehost) for operators who want to view our training materials.
Ports for Registration, Validation, Analytics, Crash Log, and Cover Art Services
- License verification requires you to allow port 80 access to:
- Amazon S3: s3.amazon.com
- Update Server: updateserver.companioncorp.com (209.210.70.29).
- Automatic crash log reporting requires access on port 80 to: s3.amazon.com.
- Allow communications with Google Analytics via port 80 to google-analytics.com/ so we can better understand how our features are used.
- To support sending of data files for support analysis via FTP, open port 21 to address ftp.companioncorp.com (209.210.70.4).
- Alexandria and Textbook Tracker automatically attempt to fetch cover art from various sources; in order to make sure this service works for your librarians and operators, you should allow port 80 communications with these domains: aws.amazon.com and images.amazon.com.
Features Requiring IT Technology Support Assistance
The following features of Alexandria and Textbook Tracker are those that even extremely knowledgeable librarians or operators may have trouble configuring without help from their IT Technology Support Services department.
SMTP Services / Email
- Simple Mail Transfer Protocol (SMTP) is an internet standard for electronic mail (email) transmission across TCP/IP networks. Alexandria and Textbook Tracker can communicate with your SMTP server for email services; some of our software features may not work if you haven't defined a SMTP server.
- If you would like Alexandria / Textbook Tracker to use a built-in or external mail service in order to send email notifications or scheduled reports, you need to configure the email settings, as documented here:
LDAP: Lightweight Directory Access Protocol
- Alexandria and Textbook Tracker support user authentication using existing log-on credentials maintained on a separate directory server. This support allows our software to be integrated into existing Active Directory or Open Directory environments by leveraging the benefits of the Lightweight Directory Access Protocol (i.e. LDAP).
- LDAP is an application protocol for querying and modifying directory services running over an Internet Protocol (IP) network. At this time, Alexandria and Textbook Tracker support querying an LDAP server for the purpose of authenticating operator and patron access.
- If you plan on using LDAP at your location, please review the following information:
SIP2: Standard Interchange Protocol
- The Standard Interchange Protocol (SIP2) is a proprietary standard for communication between library computer systems and self-service circulation terminals; it allows you to utilize SIP2 hardware (e.g. Checkpoint, 3M, etc.) by supporting the SIP2 protocol, making your library more efficient with enhanced inventory and security features.
- To configure self-service systems using SIP2 protocols, please review the following documentation:
SIF: Schools Interoperability Framework
- The Schools Interoperability Framework (SIF) is an industry-supported technical protocol that ensures that diverse primary and secondary (K-12) instructional and administrative software applications share information (data formats) and work together seamlessly. When different third party software applications communicate with each other, access one another's database, resources, and tools, a school district can more effectively serve the needs of its patrons.
- If you would like to configure SIF to work with our software, please review the following section:
SSL Communications
- Secure Sockets Layer (SSL), are cryptographic protocols that provide communication security over the internet. SSL encrypts segments of network connections using asymmetric cryptography for key exchange, symmetric encryption for privacy, and a keyed message authentication code for message reliability.
- If you would like to learn how to enable Alexandria and Textbook Tracker to only accept communications from secure web ports via SSL, please look here:
Scheduled Events: Imports & Exports
- You are allowed to schedule automatic data imports and exports from a local folder or an FTP site.
- Read about how to schedule these events here:
Scheduled Events: Reports & Utilities
- If required, you can schedule automatic reports and utilities; scheduled operation notices can be emailed to operators, including a link to download the report—in PDF format—or other generated data. Scheduled reports can also be sent to an FTP location. Please note that our standard report format is PDF; all operators will need a PDF reader to view reports and some notices.
- Read about how to schedule these events here:
SmartMARC
- SmartMARC is COMPanion's MARC/MicroLIF maintenance and retrieval software. With SmartMARC, operators can easily clean and update their library database by searching from a number of different on-line and off-line sources to further complete their bibliographic records.
- If you are using SmartMARC in conjunction with Alexandria or Textbook Tracker, please review this section:
Web Router
- The Web Router allows an operator to configure a single machine as a web-based access point for a group of Data Stations. Queries for individual sites are performed based upon requests from the Web Router to the connected Data Station which use the Web Router’s efficient and secure communications protocols.
- Read more about the Web Router here:
Patron Server
- The Patron Server consists of a single database which contains all imported patron data and uses ports that other Data Stations do not, so there is no conflict when running the Patron Server on the same machine as an existing Alexandria or Textbook Tracker Data Station.
- The Patron Server requires port 80 and port 30703 to send/receive patron records to Alexandria and Textbook Tracker Data Stations.
- Read more about the Patron Server here:
Optional and Additional Services
Lexiles
- Developed by MetaMetrics, Inc.®, lexiles have become the most widely accepted reading measurement in use today; a scientifically-based reading measurement that can be used to match a patron's reading ability to the overall difficulty of a specified text.
- If using lexiles, connect to our hosted lexile server at 209.210.70.70 on port 30427 (Alexandria) or 30467 (Textbook Tracker).
Search All
- SearchALL can access several different informational sources, which may then be searched simultaneously with a single patron query and displayed in a simple, organized results window.
- Auto‑Graphics, Inc. works directly with those wanting to set up SearchAll and can be contacted anytime at (800) 852-8686, 8:00am-8:00pm (Eastern Time).
Sneak Peek
- Sneak Peek allows your patrons to enjoy title reviews written by trusted publications, title summaries, and cover art—all from Alexandria's search interfaces.
- The server that Sneak Peek connects to is www.syndetics.com (208.111.148.6); the protocol is HTTP.
netTrekker
- netTrekker is a trusted search engine for schools, providing fast and easy access to high-quality, pre-screened, and educationally-relevant K-12 online resources. If you're licensed to use netTrekker, you should have received an introductory email from either COMPanion or netTrekker containing an access URL for your site; be sure to configure your firewall to allow access to:
- school.nettrekker.com
- If you'd like to set up your site so that access to netTrekker doesn't require a username or password, IP-access is an option for district-wide subscriptions only and will require you to provide netTrekker with your site's valid IP address(es). If needed, you can contact netTrekker using one of the following methods:
- Email: crm@nettrekker.com
- Phone: (877) 517-1125 (toll-free)
- Fax: (866) 886-3409 (toll-free)
Capstone
- If you're using any of our Capstone Publishers services, please configure your firewall to allow access to:
Capstone Interactive - www.mycapstonelibrary.com
Capstone PebbleGo -
Capstone Publishers - www.capstoneinteractivelibrary.com
NoveList Select
- NoveList Select is a comprehensive online readers' advisory tool. When a student searches for a title via Alexandria, NoveList Select will return reading recommendations based on that title—and based on titles that the site owns.
- If you're using NoveList Select, be sure to configure your firewall to allow access to imageserver.epnet.com through port 80.
OverDrive
- OverDrive is a leading full-service digital distributor of eBooks, audiobooks, and other digital content.
- OverDrive makes use of some of our SIP2 standards; to configure OverDrive to work using SIP2 protocols, please review the following documentation:
Mitinet
- Mitinet offers MARC data software tools and services, the focus being to making your records orderly, your shelves tidy, your books easy to find and cleaning up, organizing and optimizing your database and information management systems. This leaves you free to focus on the most important job of all: helping children meet their educational goals.
- Mitinet is composed of MARC on Demand, MARC Defender (formerly MARC Firewall), and Mechanic Express.
- AccessMARC - This is Mitinet's subscription-based Z39.50 server. Customers will be unable to access records on the server unless they have a valid username and address received in your paperwork from either COMPanion or Mitinet. Along with your username and password, FTP access is granted using the z3950.accessmarc-db.com address on port 210.
Vendors
- If you're using any of our additional vendor services, please allow firewall access for the following URLs:
- Baker and Taylor - schoolselection.btol.com
- Mackin - www.mackin.com
- Perma-Bound - www.perma-bound.com/Alexandria
- Capstone Publishers - www.capstoneinteractivelibrary.com
- Bound to Stay Bound (BTSB) - www.btsb.com
- EBSCO - www.ebscomags.com
- Safari Montage - safarimontage.com/
Technology Services Cheat Sheet
In order to use all of our software's services and built-in functionality, you should configure your firewall to allow access to the following ports and addresses. However, depending on the required internet security at your site, you may only want to enable firewall access for the services that you use.
Shown below is a list of addresses you should allow in your firewall's access control list.
|
Name |
Ports |
IP Address |
URL/Web Address | |
|---|---|---|---|---|
|
Alexandria Data Station/Workstation |
30427 | |||
|
Textbook Tracker Data Station/Workstation |
30467 | |||
|
Amazon S3 |
80 |
s3.amazon.com | ||
|
COMPanion FTP Support |
21 |
209.210.70.4 |
ftp.companioncorp.com | |
|
COMPanion Cover Art Services |
aws.amazon.com | |||
|
Google Analytics |
80 |
google-analytics.com | ||
|
Title Assistant |
210 | |||
|
COMPanion Online Help |
80 |
209.210.70.4 |
www.companioncorp.com/mediawiki/ | |
|
COMPanion Support Email |
25 |
mail.companioncorp.com | ||
|
COMPanion Update Server |
209.210.70.29 | |||
|
COMPanion Web Service |
80 | |||
|
Lexiles |
30427 | |||
|
Mitinet's AccessMARC |
210 |
z3950.accessmarc-db.com | ||
|
netTrekker |
school.nettrekker.com | |||
|
NoveList |
80 |
imageserver.epnet.com | ||
|
Sneak Peek |
208.111.148.6 |
www.syndetics.com | ||
|
Baker and Taylor |
schoolselection.btol.com | |||
|
Bound to Stay Bound (BTSB) |
www.btsb.com | |||
|
Capstone Publishers |
www.capstoneinteractivelibrary.com | |||
|
EBSCO |
www.ebscomags.com | |||
|
Mackin |
www.mackin.com | |||
|
Perma-Bound |
www.perma-bound.com/Alexandria | |||
|
SAFARI Montage |
safarimontage.com |
Troubleshooting Checklist
- Sometimes, when Alexandria or Textbook Tracker are behaving abnormally, there may be conflicts on your end caused by blocked ports, aggressive emails filters, etc.
- Here's a quick troubleshooting list of things to check before placing the blame on Alexandria and Textbook Tracker:
- Does your machine have a network filter turned on?
- Does your network have filters turned on that are blocking Alexandria or Textbook Tracker communications?
- Does your network block communications outside your network?
- Do you have an email firewall that is blocking or filtering Alexandria or Textbook Tracker messages?
