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

    Setup and Configuration of XService?

    • Article Type: Q&A
    • Product: Voyager
    • Product Version: 8.1.2


    How to configure XService (vxws) to allow discovery layer to make API calls


    If using Tomcat WebVoyage, XService (vxws) is already configured & running.

    1. /m1/voyager/xxxdb/tomcat/conf/server.xml
      1. Check RemoteAddrValve
      2. If restricted to localhost, add any other IPs that will be communicating with XService
    2. If not already running Tomcat service for WebVoyage, see "How to configure Apache - add Tomcat and/or remove Classic" to configure Apache to run Tomcat service.
    3. Ensure local firewall(s) will allow connections to XService port (XX14) from requesting IPs.
    4. Ensure correct IPs and ports configured in System Administration > Search > Database Definitions > LOCAL for vxws, OPAC and Circ.
    5. When configuration complete, test vxws by making a simple API call from browser: http://<IP>:<vxws port>/vxws/record/<bib_id>
      • IP = address of your Voyager server
      • vxws port = port vxws runs on (typically XX14 - if xxxdb port series is 7000, then 7014)
      • bib_id = a bibliographic record ID for a bib record in xxxdb

    Additional Information

    See "WebVoyage: How to limit external access to the vxws web services"
    See also Developers Network > Voyager > APIs for more information on APIs

    Please note that Voyager Support has a very limited ability to assist with the Voyager APIs.  We can help identify the APIs that might be useful to you, and provide basic troubleshooting aid.  Voyager-L and Developer Network  are useful resources for obtaining additional assistance.

    • Article last edited: 10-Oct-2014
    • Was this article helpful?