Product Documentation

The ExtraView Web Service module is packaged as a war file. The configuration file is held inside of this war file, and must be edited for your environment. If you do not have the download, ExtraView Support will give you the location where the file resides. Download this before starting the installation. The following instructions utilize Apache Tomcat as the application server and Apache as your web server. If you are using different servers, it is assumed you have sufficient knowledge to modify the instructions yourself. To install the Web Service:

• Start by ensuring your application server is running
• The war file you download will have a name similar to evjnnnn-WS.war, where the nnnn is the version and build number of the file. In all the following instructions, replace the nnnn with the actual version and build number of the file
• Rename the evjnnnn-WS.war file to evj-WS.war. You may use a different file name as long as its name does not override an existing file, but once again modify the following instructions to use the name you supply
• Copy the war file to the web application directory of you application server. Normally this is the directory named webapps within your application server
• The application server will expand the Web Service war file, extracting it into a directory named ./evj-WS
• Using the editor of your choice, edit the Web Service configuration file named ./evj-WS/WEB-INF/classes/ev_ws.properties. The contents of the configuration file will be similar to the following:

  # (REQUIRED) The URL for the ExtraView API
API_URI=http://yourserver.yourdomain.com/evj/ExtraView/ev_api.action

  # (OPTIONAL) The ExtraView user account and password used for PING only
EV_WS_USER=admin
EV_WS_PASSWORD=password

  # (OPTIONAL) Used for setting up full RAMPART secure message access to the web service SECURE_ID=service
SECURE_PASSWORD=apache

  # (OPTIONAL) The internal expected delimiter (must match the users behavior setting)
DELIMITER=:
   

• If your application server does not expand the war file automatically, you will need to open the war file, edit the configuration file, and re-create the war file before copying it to your application server
• You must change the API_URI entry to match your ExtraView server location. Replace the http://yourserver.yourdomain.com text with the actual location of your ExtraView server
• Alter the EV_WS_USER and the EV_WS_PASSWORD entries to match those of a valid ExtraView user
• For the initial installation you may ignore the SECURE_ID and the SECURE_PASSWORD entries
• Save the file
• You must update the web server configuration file to include the web services and its associated WSDL file. Edit the httpd.conf file and add the following lines:

  JkMount /evj-WS/services/* tomcat1
  JkMount /evj-WS/wsdl/* tomcat1

  Alternatively, if you are using an ev.conf or extraview.conf file, you add these mounts into that file. Make sure you save the file after editing

• Restart your application server
• Validate the installation works with the getPing service. The URL to call this will be:

  http://SERVER_NAME/evj-WS/services/EVSystemService/getPing

  A successful response will look similar to:

  <ns:getPingResponse>
     <ns:return>
       Reply: status=SUCCESS: EV-EXTRAVIEW ALIVE, WS-EV-PROPERTIES-OK, EV-REV-UNKNOWN-OK time=94ms    </ns:return>
  </ns:getPingResponse>
   

• The WSDL files for your web services are automatically generated as part of the installation. Their URL's are:

  http://yourserver.yourdomain.com/evj-WS/services/EVSystemService?wsdl http://yourserver.yourdomain.com/evj-WS/services/EVUserService?wsdl http://yourserver.yourdomain.com/evj-WS/services/EVItemService?wsdl http://yourserver.yourdomain.com/evj-WS/services/EVQueryService?wsdl

Supporting a Large Number of Image Inserts

It is possible to run out of server memory when inserting a large number of images via web services.  It is recommended that you provide this setting in the configuration file to increase the WSDL package size:

<readerQuotas maxDepth="2147483647" maxStringContentLength="2147483647" maxArrayLength="2147483647" maxBytesPerRead="2147483647" maxNameTableCharCount="2147483647"/>

Within your Apache Tomcat configuration, you should set the maximum size in bytes of the POST which will be handled by the container FORM URL parameter parsing. The limit can be altered by setting the following attribute to a value less than or equal to 0. If not specified, the attribute is set to 2097152 (2 megabytes).