(Update with the copy of version: 8.5.2DRAFT) |
(Update with the copy of version: 8.5.2DRAFT) |
||
Line 1: | Line 1: | ||
= Starting and Testing Workspace Web Edition & Web Services = | = Starting and Testing Workspace Web Edition & Web Services = | ||
+ | __TOC__ | ||
+ | After you install and configure Workspace Web Edition & Web Services, you should start the nodes in the following order: | ||
− | + | <ol> | |
− | + | <li>Start the {{#ppin:{{SectionTransclusion|HTCCConfigurationOptionsReference|syncNode}}|syncNode|||500|200}}. This is the node you configured in Step 2 of [[ConfigurationPremise#Modifying_the_Server_Settings|Modifying the Server Settings]]. </li> | |
− | + | <li>Start the remaining nodes.</li> | |
− | + | </ol> | |
− | |||
− | |||
− | '''Start | + | ==Starting the Workspace Web Edition & Web Services Node== |
+ | Complete the following steps for each Workspace Web Edition & Web Services node, starting with the {{#ppin:{{SectionTransclusion|HTCCConfigurationOptionsReference|syncNode}}|syncNode|||500|200}}.<br/><br/> | ||
+ | '''Start''' | ||
<ol> | <ol> | ||
− | <li>To start the | + | <li>To start the node, enter the following command as one complete command line entry, replacing items in square brackets [ ] with the appropriate values as described below: |
− | < | + | <source lang="text"> |
+ | [java dir]/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -Djetty.port=[jetty port] | ||
-Djetty.logs=[jetty log dir] -Dconfig.path=[config dir] -Djetty.home=[jetty dir] -Djava.io.tmpdir=/tmp | -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 | -Djava.net.preferIPv4Stack=true -jar [jetty dir]/start.jar --pre=etc/jetty-logging.xml --daemon | ||
− | </ | + | </source> |
− | *[java dir] — The home directory for Java. For example, | + | *<tt>[java dir]</tt> — The home directory for Java. For example, '''/usr/bin/java'''. |
− | + | *<tt>[jetty port]</tt> — The Jetty port. For example, <tt>8080</tt>. | |
− | *[jetty log dir] — The log directory for Jetty. For example, | + | *<tt>[jetty log dir]</tt> — The log directory for Jetty. For example, '''/var/log/jetty'''. |
− | + | *<tt>[config dir]</tt> — The path to the Workspace Web Edition & Web Services config directory you created in Step 6 of [[DeployWebApp|Deploying the Web Application]]. For example, '''/opt/jetty/genconfig'''. Workspace Web Edition & Web Services reads a series of configuration files from the location defined by the '''config.path''' system property. To start the server, or at the server startup, you need the '''config.path'''; otherwise, the server won't start. | |
− | *[jetty dir] — The home directory for Jetty. For example, | + | *<tt>[jetty dir]</tt> — The home directory for Jetty. For example, '''/opt/jetty'''. |
− | |||
− | |||
+ | {{NoteFormat|The memory allocation <tt>-Xmx4096m, -Xms4096m, -XX:MaxPermSize, -XX:PermSize</tt> is mandatory for the Workspace Web Edition & Web Services node.}} | ||
For example, your command line might look like the following: | For example, your command line might look like the following: | ||
− | < | + | <source lang="text"> |
− | /usr/bin/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -Djetty.port=80 -Djetty.logs=/var/log/jetty | + | /usr/bin/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -Djetty.port=80 |
− | + | -Djetty.logs=/var/log/jetty -Dconfig.path=/opt/jetty/genconfig -Djetty.home=/opt/jetty -Djava.io.tmpdir=/tmp | |
− | -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 | -Djava.net.preferIPv4Stack=true -jar /opt/jetty/start.jar --pre=etc/jetty-logging.xml --daemon | ||
− | </ | + | </source> |
</li> | </li> | ||
− | < | + | </ol> |
− | <tt>http:// | + | '''End''' |
− | *<tt> | + | |
− | *<tt> | + | ==Testing the Workspace Web Edition & Web Services Node== |
+ | Complete the steps below to verify each Workspace Web Edition & Web Services node is up and running.<br/><br/> | ||
+ | '''Start''' | ||
+ | <ol> | ||
+ | <li>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> — The host name or IP address for the Workspace Web Edition & Web Services node. | ||
+ | *<tt>''wwews_port''</tt> — 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/> | 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 | + | If the request is successful, the version is printed in the browser: </li> |
− | + | <source lang="text"> | |
+ | { | ||
statusCode: 0 | statusCode: 0 | ||
version: "gws-x.x.xxx.xx" | version: "gws-x.x.xxx.xx" | ||
− | }</nowiki> | + | } |
+ | </source> | ||
+ | </li> | ||
+ | </ol> | ||
+ | '''End''' | ||
+ | |||
+ | == Testing Workspace Web Edition== | ||
+ | Complete the following steps for each Workspace Web Edition & Web Services node to confirm that Workspace Web Edition is working.<br/><br/> | ||
+ | '''Start''' | ||
+ | <ol> | ||
+ | <li>Launch Workspace Web Edition by navigating to <tt>http://''wwews_host'':''wwews_port''/ui/ad/v1/index.html</tt> in a web browser.</li> | ||
+ | *<tt>''wwews_host''</tt> — The host name or IP address for the Workspace Web Edition & Web Services node. | ||
+ | *<tt>''wwews_port''</tt> — The port for the Workspace Web Edition & Web Services node. | ||
+ | For example, the URL might be <tt><nowiki>http://192.0.2.20:8080/ui/ad/v1/index.html</nowiki></tt><br/><br/> | ||
− | '''End | + | <li>Enter the credentials for any of the previously created agents. Note that the user must be of the agent type.</li> |
+ | <li>After clicking '''Log In''', Workspace Web Edition displays the agent desktop view and the agent is ready to work.</li> | ||
+ | </ol> | ||
+ | '''End''' | ||
+ | <!-- | ||
+ | === Workspace Web Edition Supervisor Desktop === | ||
+ | |||
+ | <ol> | ||
+ | <li>Once the configuration is complete, you can launch Workspace Web Edition by navigating to <tt>/ui/ad/v1/index.html</tt>.</li> | ||
+ | <li>Enter the credentials for any of the previously created agents. Note that the user must be of the supervisor type.</li> | ||
+ | <li>After clicking Log In, the Workspace Web Edition agent desktop view is displayed and the agent is ready to work.</li> | ||
+ | </ol> | ||
+ | --> | ||
[[Category:V:HTCC:8.5.2]] | [[Category:V:HTCC:8.5.2]] |
Revision as of 18:37, April 3, 2015
Starting and Testing Workspace Web Edition & Web Services
Contents
After you install and configure Workspace Web Edition & Web Services, you should start the nodes in the following order:
- Start the syncNode. This is the node you configured in Step 2 of Modifying the Server Settings.
- Start the remaining nodes.
Starting the Workspace Web Edition & Web Services Node
Complete the following steps for each Workspace Web Edition & Web Services node, starting with the syncNode.
Start
- To start the node, enter the following command as one complete command line entry, replacing items in square brackets [ ] with the appropriate values as described below:
[java dir]/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -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, 8080.
- [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 Deploying the Web Application. For example, /opt/jetty/genconfig. Workspace Web Edition & Web Services reads a series of configuration files from the location defined by the config.path system property. To start the server, or at the server startup, you need the config.path; otherwise, the server won't start.
- [jetty dir] — The home directory for Jetty. For example, /opt/jetty.
ImportantThe memory allocation -Xmx4096m, -Xms4096m, -XX:MaxPermSize, -XX:PermSize is mandatory for the Workspace Web Edition & Web Services node.For example, your command line might look like the following:
/usr/bin/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -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
End
Testing the Workspace Web Edition & Web Services Node
Complete the steps below to verify each Workspace Web Edition & Web Services node is up and running.
Start
- 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.
If the request is successful, the version is printed in the browser:
{
statusCode: 0
version: "gws-x.x.xxx.xx"
}
End
Testing Workspace Web Edition
Complete the following steps for each Workspace Web Edition & Web Services node to confirm that Workspace Web Edition is working.
Start
- Launch Workspace Web Edition by navigating to http://wwews_host:wwews_port/ui/ad/v1/index.html in a web browser.
- 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/ui/ad/v1/index.html
End
Comments or questions about this documentation? Contact us for support!