Skip to main content
OCLC Support

Relais web schema

Learn how some applications and web services reference various XML Schema Definition (XSD) files in Relais ILL.

Some Relais web applications and web services reference various XML Schema Definition (XSD) files.

 Caution: It is strongly recommended that customers maintain the various schema locally and configure their system to reference these local copies.

Download and save the schema

Download the version of the schema that matches the version of Relais you are currently running. For example, if you are running V2010.5 and you use the Add Request web service, then download the schema from the 2010.5 folder.  

If you are already hosting schema for other web applications then a Relais directory for clear separation may be desirable. For example:

http://www.my-domain.com/schema/Relais/2010.5/AddRequest.xsd

Relais International also suggests keeping the convention of 'release' subdirectories, to make configuration of multiple versions, e.g., test and production, easier.

Configure the schema to use

Once the local directory structure is set up and the schema saved locally, then the following updates must be made as appropriate, i.e., to point to locally hosted schema for each of the web applications/services used.

Relais Web Forms

  1. Open the .....\access\WEB-INF\relaisWeb.ini.
  2. Go to the [Relais Webservice] section.
  3. Enter the correct addresses.  
  4. Save the file.  

    For example:

    [Relais Webservice]
    WebService=N
    WebServiceUrl=http://localhost:8080/axis/services/relais
    AddRequestSchema=http://www.my-domain.com/schema/2010.5/AddRequest.xsd
    QueryRequestSchema=http://www.my-domain.com/schema/2010.5/QueryRequest.xsd
    RegisterPatronSchema=http://www.my-domain.com/schema/2010.5/RegisterPatronResponse.xsd
    AddRequestRequestSchemaVersion=2010.5.0.0
    QueryRequestRequestSchemaVersion=2010.5.0.0
    RegisterPatronRequestSchemaVersion=2010.5.0.0
     
  5. Open the .....\access\WEB-INF\relaisWeb.ini.
  6. Go to the [Multipart Requests] section.
  7. Enter the correct address.  
  8. Save the file.

    For example

    [Multipart Requests]
    MaxDays_NeedByDate=15
    AddRequest_uri_host=localhost
    AddRequest_uri_port=80
    AddRequest_uri_path=/ws/AddRequest
    AddRequestRequestSchemaVersion=2010.5.0.0
    AddRequestSchema=http://www.my-domain.com/schema/2010.5/AddRequest.xsd

Relais Web Services

  1. In the .....\relaisws\WEB-INF\conf\WSErrors.xml
  2. Update:

    <ErrorConfig version="2010.0" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation=http://www.my-domain.com.com/schema/....5/WSError.xsd>
     
  3. Open the ......\relaisws\WEB-INF\conf\relaisWS.ini.
  4. Go to the [WSFunctionsVersionSchema] section.
  5. Enter the correct addresses.
  6. Save the file.

    For example:

    [WSFunctionsVersionSchema]
    CheckAvailabilityResponseVersion=2010.5.0.0
    AddRequestResponseSchemaVersion=2010.5.0.0
    QueryRequestResponseSchemaVersion=2010.5.0.0
    RegisterPatronResponseSchemaVersion=2010.5.0.0
    ValidateLoginResponseSchemaVersion=2010.5.0.0
    UpdateProfileResponseSchemaVersion=2010.5.0.0
    CreateRoutingListResponseSchemaVersion=2010.5.0.0
    CheckAvailabilityResponseSchema=http://www.my-domain.com/schema/2010...tyResponse.xsd
    AddRequestResponseSchema=http://www.my-domain.com/schema/2010...stresponse.xsd
    QueryRequestResponseSchema=http://www.mydomain.com/schema/2010....stresponse.xsd
    RegisterPatronResponseSchema=http://www.my-domain.com/schema/2010...onresponse.xsd
    ValidateLoginResponseSchema=http://www.my-domain.com/schema/2010...inResponse.xsd
    UpdateProfileResponseSchema=http://www.my-domain.com/schema/2010...leResponse.xsd

Relais Patron Notification Response

  1. In the .....\patronResponse\WEB-INF\conf\PRErrors.xml
  2. Update:

    <ErrorConfig version="2010.0" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation=http://www.my-domain.com/schema/2010.5/WSError.xsd>
     
  3. Open the .......\patronResponse\WEB-INF\conf\relaisPR.ini.
  4. Go to the [QueryRequest] section.
  5. Enter the correct address.
  6. Save the file.

    For example:

    [QueryRequest]
    QueryRequest_uri_host=localhost
    QueryRequest_uri_port=80
    QueryRequest_uri_path=/ws/QueryRequest
    QueryRequestRequestSchemaVersion=2010.5.0.0 QueryRequestSchema=http://www.my-domain.com/schema/2010.0/QueryRequest.xsd

Relais patron SelfRegistration

  1. Open the ......\SelfRegistration\conf\registration.ini.
  2. Go to the [Web Service] section.
  3. Enter the correct addresses.
  4. Save the file.

    For example:

    [Web Service]
    UseWebService=N
    WebSerivceURL=
    OperationName=registerPatron
    RegisterPatronSchema=http://www. my-domain.com/schema/2010.5/RegisterPatron.xsd
    XMLSchemaLocation=http://www. my-domain.com/schema/2010.5/RegisterPatronResponse.xsd
    RegisterPatronRequestSchemaVersion=2010.5.0.0