Documentation:HTCC:Dep:StartHTCC:8.5.2DRAFT

Starting and Testing Workspace Web Edition & Web Services

After you install and configure Workspace Web Edition & Web Services, you should start the nodes in the following order:

1. Start the syncNode. This is the node you configured in Step 2 of Modifying the Server Settings.
2. 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

1. 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.
   Important

   The 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

1. 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 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

1. 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

Enter the credentials for any of the previously created agents. Note that the user must be of the agent type.

After clicking Log In, Workspace Web Edition displays the agent desktop view and the agent is ready to work.

End