Jump to: navigation, search
(Created Fix blank page For Version: HTCC:8.5.2DRAFT)
 
(Update with the copy of version: 8.5.2)
Line 1: Line 1:
−
<!-- Creation of the fix page -->
+
= Starting and Testing Workspace Web Edition & Web Services =
 +
 
 +
When the installation is complete, you must start the Workspace Web Edition & Web Services nodes in the following order:
 +
 
 +
# Start the synchronization node. This is the node you configured in Step 2 of the [[ConfigurationPremise#Modifying_the_Server_Settings|Modifying the Server Settings]] procedure. For details about the <tt>syncNode</tt> option, see the description in the [[HTCCConfigurationOptionsReference|General Configuration]] options.
 +
# Start the remaining nodes.
 +
 
 +
Complete the following steps for each Workspace Web Edition & Web Services node.
 +
 
 +
'''Start of Procedure'''
 +
<ol>
 +
<li>To start the Web Services node, enter the following command line:
 +
 
 +
<pre>[java dir]/java -Xmx4096m -Xms4096m -Djetty.port=[jetty port] -Djetty.logs=[jetty log dir]
 +
 
 +
-Dconfig.path=[config dir] -Djetty.home=[jetty dir] -Djava.io.tmpdir=/tmp
 +
 
 +
-Djava.net.preferIPv4Stack=true -jar [jetty dir]/start.jar
 +
 
 +
--pre=etc/jetty-logging.xml --daemon
 +
</pre>
 +
 
 +
*[java dir] &mdash; The home directory for Java. For example, <tt>/usr/bin/java</tt>.
 +
*[jetty port] &mdash; The Jetty port. For example, <tt>80</tt>.
 +
*[jetty log dir] &mdash; The log directory for Jetty. For example, <tt>/var/log/jetty</tt>.
 +
*[config dir] &mdash; The path to the Workspace Web Edition & Web Services config directory you created in Step 6 of the [[DeployWebApp|Deploying the Web Application]] procedure. For example, <tt>/opt/jetty/genconfig</tt>. Workspace Web Edition & Web Services reads a series of configuration files from the location that is defined by the <tt>config.path</tt> system property. To start the server, or a the server startup, the <tt>config.path</tt> is needed; otherwise, the server will not start.
 +
*[jetty dir] &mdash; The home directory for Jetty. For example, <tt>/opt/jetty</tt>.
 +
 
 +
<!-- Available styles: (default)-Important, 2-Tip, 3-Warning -->
 +
<!-- Important: equal signs (=) will not work in a note. Use the equivalent HTML code (&#61;) instead.-->
 +
{{NoteFormat|The memory allocation <tt>-Xmx4096m, -Xms4096m</tt> is mandatory for the web services node.}}
 +
 
 +
For example, your command line might look like the following:
 +
<pre>
 +
/usr/bin/java -Xmx4096m -Xms4096m -Djetty.port=80 -Djetty.logs=/var/log/jetty
 +
 
 +
-Dconfig.path=/opt/jetty/genconfig -Djetty.home=/opt/jetty -Djava.io.tmpdir=/tmp
 +
 
 +
-Djava.net.preferIPv4Stack=true -jar /opt/jetty/start.jar --pre=etc/jetty-logging.xml --daemon
 +
</pre>
 +
</li>
 +
<li>To verify that Workspace Web Edition & Web Services Server is up and running, type the following URL into a web browser: <br>
 +
<tt>http://[wwews_host]:[wwews_port]/api/v2/diagnostics/version</tt><br/>
 +
*<tt>[wwews_host]</tt> &mdash; The host name or IP address for the Workspace Web Edition & Web Services node.
 +
*<tt>[wwews_port]</tt> &mdash; The port for the Workspace Web Edition & Web Services node.
 +
For example, the URL might be <tt><nowiki>http://192.0.2.20:8080/api/v2/diagnostics/version</nowiki></tt><br/><br/>
 +
If the request is successful, the version will be printed as shown below: </li>
 +
<nowiki>{
 +
    statusCode: 0
 +
    version: "gws-x.x.xxx.xx"
 +
}</nowiki>
 +
 
 +
'''End of Procedure'''
 +
 
 +
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 18:42, April 22, 2014

Starting and Testing Workspace Web Edition & Web Services

When the installation is complete, you must start the Workspace Web Edition & Web Services nodes in the following order:

  1. Start the synchronization node. This is the node you configured in Step 2 of the Modifying the Server Settings procedure. For details about the syncNode option, see the description in the General Configuration options.
  2. Start the remaining nodes.

Complete the following steps for each Workspace Web Edition & Web Services node.

Start of Procedure

  1. To start the Web Services node, enter the following command line: 
    [java dir]/java -Xmx4096m -Xms4096m -Djetty.port=[jetty port] -Djetty.logs=[jetty log dir] 

-Dconfig.path=[config dir] -Djetty.home=[jetty dir] -Djava.io.tmpdir=/tmp 

-Djava.net.preferIPv4Stack=true -jar [jetty dir]/start.jar 

--pre=etc/jetty-logging.xml --daemon
    • [java dir] — The home directory for Java. For example, /usr/bin/java.
    • [jetty port] — The Jetty port. For example, 80.
    • [jetty log dir] — The log directory for Jetty. For example, /var/log/jetty.
    • [config dir] — The path to the Workspace Web Edition & Web Services config directory you created in Step 6 of the Deploying the Web Application procedure. For example, /opt/jetty/genconfig. Workspace Web Edition & Web Services reads a series of configuration files from the location that is defined by the config.path system property. To start the server, or a the server startup, the config.path is needed; otherwise, the server will not start.
    • [jetty dir] — The home directory for Jetty. For example, /opt/jetty.
    Important
    The memory allocation -Xmx4096m, -Xms4096m is mandatory for the web services node.

    For example, your command line might look like the following: 

    /usr/bin/java -Xmx4096m -Xms4096m -Djetty.port=80 -Djetty.logs=/var/log/jetty 

-Dconfig.path=/opt/jetty/genconfig -Djetty.home=/opt/jetty -Djava.io.tmpdir=/tmp 

-Djava.net.preferIPv4Stack=true -jar /opt/jetty/start.jar --pre=etc/jetty-logging.xml --daemon
  2. To verify that Workspace Web Edition & Web Services Server is up and running, type the following URL into a web browser:
    http://[wwews_host]:[wwews_port]/api/v2/diagnostics/version
    • [wwews_host] — The host name or IP address for the Workspace Web Edition & Web Services node.
    • [wwews_port] — The port for the Workspace Web Edition & Web Services node.
    For example, the URL might be http://192.0.2.20:8080/api/v2/diagnostics/version

    If the request is successful, the version will be printed as shown below: 
    3. {
    statusCode: 0
    version: "gws-x.x.xxx.xx"
}

    End of Procedure

Comments or questions about this documentation? Contact us for support!