{"id":24322,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/installation-configuration-7\/"},"modified":"2025-02-17T10:52:43","modified_gmt":"2025-02-17T18:52:43","slug":"installation-configuration-7","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/","title":{"rendered":"Installation &#038; Configuration"},"content":{"rendered":"<p>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, <a href=\"mail_addr(\">ExtraView Support<\/a> 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:<\/p>\n<ul>\n<li>\n\t\tStart by ensuring your application server is running<\/li>\n<li>\n\t\tThe war file you download will have a name similar to <span class=\"fixedWidthFont\">evjnnnn-WS.war<\/span>, where the <span class=\"fixedWidthFont\">nnnn<\/span> is the version and build number of the file. In all the following instructions, replace the <span class=\"fixedWidthFont\">nnnn<\/span> with the actual version and build number of the file<\/li>\n<li>\n\t\tRename the <span class=\"fixedWidthFont\">evjnnnn-WS.war<\/span> file to <span class=\"fixedWidthFont\">evj-WS.war<\/span>. 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<\/li>\n<li>\n\t\tCopy the war file to the web application directory of you application server. Normally this is the directory named <span class=\"fixedWidthFont\">webapps<\/span> within your application server<\/li>\n<li>\n\t\tThe application server will expand the Web Service war file, extracting it into a directory named <span class=\"fixedWidthFont\">.\/evj-WS<\/span><\/li>\n<li>\n\t\tUsing the editor of your choice, edit the Web Service configuration file named <span class=\"fixedWidthFont\">.\/evj-WS\/WEB-INF\/classes\/ev_ws.properties<\/span>. The contents of the configuration file will be similar to the following:<\/p>\n<p>\t\t<code># (REQUIRED) The URL for the ExtraView API<br \/>\n\t\tAPI_URI=http:\/\/yourserver.yourdomain.com\/evj\/ExtraView\/ev_api.action<\/code><\/p>\n<p>\t\t<code># (OPTIONAL) The ExtraView user account and password used for PING only<br \/>\n\t\tEV_WS_USER=admin<br \/>\n\t\tEV_WS_PASSWORD=password<\/code><\/p>\n<p>\t\t<code># (OPTIONAL) Used for setting up full RAMPART secure message access to the web service SECURE_ID=service<br \/>\n\t\tSECURE_PASSWORD=apache<\/code><\/p>\n<p>\t\t<code># (OPTIONAL) The internal expected delimiter (must match the users behavior setting)<br \/>\n\t\tDELIMITER=:<\/code><br \/>\n\t\t&nbsp;<\/li>\n<li>\n\t\tIf 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<\/li>\n<li>\n\t\tYou must change the <span class=\"fixedWidthFont\">API_URI<\/span> entry to match your ExtraView server location. Replace the <span class=\"fixedWidthFont\">http:\/\/yourserver.yourdomain.com<\/span> text with the actual location of your ExtraView server<\/li>\n<li>\n\t\tAlter the <span class=\"fixedWidthFont\">EV_WS_USER<\/span> and the <span class=\"fixedWidthFont\">EV_WS_PASSWORD<\/span> entries to match those of a valid ExtraView user<\/li>\n<li>\n\t\tFor the initial installation you may ignore the <span class=\"fixedWidthFont\">SECURE_ID<\/span> and the <span class=\"fixedWidthFont\">SECURE_PASSWORD<\/span> entries<\/li>\n<li>\n\t\tSave the file<\/li>\n<li>\n\t\tYou must update the web server configuration file to include the web services and its associated WSDL file. Edit the <span class=\"fixedWidthFont\">httpd.conf<\/span> file and add the following lines:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\">JkMount \/evj-WS\/services\/* tomcat1<br \/>\n\t\tJkMount \/evj-WS\/wsdl\/* tomcat1<\/span><\/p>\n<p>\t\tAlternatively, if you are using an <span class=\"fixedWidthFont\">ev.conf<\/span> or <span class=\"fixedWidthFont\">extraview.conf<\/span> file, you add these mounts into that file. Make sure you save the file after editing<\/li>\n<li>\n\t\tRestart your application server<\/li>\n<li>\n\t\tValidate the installation works with the <span class=\"fixedWidthFont\">getPing<\/span> service. The URL to call this will be:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\">http:\/\/SERVER_NAME\/evj-WS\/services\/EVSystemService\/getPing<\/span><\/p>\n<p>\t\tA successful response will look similar to:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\">&lt;ns:getPingResponse&gt;<br \/>\n\t\t&nbsp;&nbsp;&nbsp;&lt;ns:return&gt;<br \/>\n\t\t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reply: status=SUCCESS: EV-EXTRAVIEW ALIVE, WS-EV-PROPERTIES-OK, EV-REV-UNKNOWN-OK time=94ms &nbsp;&nbsp;&nbsp;&lt;\/ns:return&gt;<br \/>\n\t\t&lt;\/ns:getPingResponse&gt;<\/span><br \/>\n\t\t&nbsp;<\/li>\n<li>\n\t\tThe WSDL files for your web services are automatically generated as part of the installation. Their URL&#8217;s are:<\/p>\n<p>\t\t<span class=\"fixedWidthFont\">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<\/span><\/li>\n<\/ul>\n<h3>\n\tSupporting a Large Number of Image Inserts<\/h3>\n<p>It is possible to run out of server memory when inserting a large number of images via web services.&nbsp; It is recommended that you provide this setting in the configuration file to increase the WSDL package size:<\/p>\n<p><code>&lt;readerQuotas maxDepth=\"2147483647\" maxStringContentLength=\"2147483647\" maxArrayLength=\"2147483647\" maxBytesPerRead=\"2147483647\" maxNameTableCharCount=\"2147483647\"\/&gt;<\/code><\/p>\n<p>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).<\/p>\n<div>\n\t<code>&nbsp; &nbsp; &lt;Connector port=\"8082\" protocol=\"HTTP\/1.1\" URIEncoding=\"UTF-8\"<\/code><\/div>\n<div>\n\t<code>&nbsp; &nbsp; &nbsp; &nbsp;connectionTimeout=\"20000\" maxPostSize=\"209715200\"<\/code><\/div>\n<div>\n\t<code>&nbsp; &nbsp; &nbsp; &nbsp;redirectPort=\"8442\" maxParameterCount=\"1000000\" \/&gt;<\/code><\/div>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>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&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24321,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24322","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Installation &amp; Configuration - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Installation &amp; Configuration - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"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...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T18:52:43+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/\",\"name\":\"Installation & Configuration - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T18:52:43+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Web Services Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Installation &#038; Configuration\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Installation & Configuration - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/","og_locale":"en_US","og_type":"article","og_title":"Installation & Configuration - Product Documentation","og_description":"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...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T18:52:43+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/","name":"Installation & Configuration - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T18:52:43+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/installation-configuration-7\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Web Services Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/web-services-interface-1\/"},{"@type":"ListItem","position":4,"name":"Installation &#038; Configuration"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24322","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24322"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24322\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24321"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24322"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}