Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Upgrading Voyager and also have Primo?

    • Product: Voyager
    • Product Version: All
    • Relevant for Installation Type: Dedicated-Direct; Direct; Local;


    We are upgrading our Voyager installation soon and we also have Primo. What should I do to ensure the upgrade doesn't impact interoperability?


    Review key areas in Voyager that impact Primo interoperability. Below are areas to check, a brief description of what happens to each during upgrade, and steps you can take (where xxxdb is the Voyager Database Instance):

    1. /m1/voyager/xxxdb/ini/PrimoExp-*.ini
      • Replaced on upgrade to ensure new features and fixes included
      • Files are used to define parameters for extracts.
      • Files from previous version under /m1/upgrade/<new version>/pre<new version>/voyager/xxxdb/ini -- get the previous configuration settings from these files and apply them to your new upgraded files
      1. Note particularly any customized enrichment tags and other special extract options.
      2. Update your new files with any differences from the pre-upgrade files. 
    2. /m1/voyager/xxxdb/tomcat/vxws/ini/PrimoExp.ini
      • RTA and other vxws requests use this file
      • Enrichment tags in this file must match those used in your extract .ini files
      • See #1 -- this file is also replaced on upgrade and must be updated post-upgrade with any customizations.
    3. Post-upgrade, check /m1/voyager/xxxdb/tomcat/conf/server.xml to make sure that Primo connections are allowed. An incorrect setting in this file will cause Real Time Availability (RTA) and OPAC via Primo (OvP) in Primo to behave incorrectly. In some cases, the upgrade process can overwrite customizations to this setting, so it is important to check. 

                  a. Look in the vxws section of this file for an entry that contains org.apache.catalina.valves.RemoteAddrValve . 

                  b. Make sure that any comment tags surrounding this line ("<!--" and "—>") are removed.

                  c. The "allow=" property should be set to allow connections from other servers. In Voyager 8.1.0 and higher, this entry should look like this:

      <Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1|.*"/> Note: This will allow access to the vxws service from anywhere. If you need a more restrictive setting, please contact Voyager support for assistance.

      For more information about how to configure this property, see: How to limit external access to the vxws web services .

    4. Post-upgrade, give attention to your extract logs. Review the logs daily (/m1/voyager/xxxdb/primo/Publishing/logs) and report any issues to Support right away.
    5. /m1/voyager/xxxdb/tomcat/vxws/context/vxws/ui/eng/
      • Used by vxws to respond to Primo API calls (OvP)
      1. This file is not replaced on upgrade.
      2. Replace this file with a copy of new version (from exl_default) post-upgrade
      3. Apply any customizations made to your old file to the new version of the file.
    6. If this is a server move, check firewall settings.

    Additional Information

    During the Voyager upgrade, connections to WebVoyage and Real Time Availability (RTA) from Primo will not be available.

    NOTE: TotalCare Primo does not include Voyager configuration.  You are responsible for that. 

    If you are a Primo TotalCare customer, you will still need to review these areas and update these files on the Voyager side when you upgrade Voyager.

    This is a really good time to review the  Voyager Primo Integration User's Guide.


    • Article last edited: 06-Sep-2019
    • Was this article helpful?