Starting and testing

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

1. Start the syncNode.
2. Start the remaining nodes.

Starting the Web Services nodes

Complete the following steps for each 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 -Xmx8G -Xms8G -XX:PermSize=512m -jar [home dir]/gws.jar

   • [java dir] — The home directory for Java. For example, /usr/bin/java.
   • [home dir] — The home directory you created for your Web Services web application. For example, /web-services.
   Important

   The memory allocation -Xmx8G, -Xms8G, -XX:MaxPermSize is mandatory for the Web Services node.

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

   /usr/bin/java -Xmx8G -Xms8G -XX:PermSize=512m -jar /web-services/gws.jar

End

[+] Starting the Web Services nodes for 8.5.201.09 or earlier

Starting the Web Services nodes for 8.5.201.09 or earlier

Complete the following steps for each 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 theWeb Services config directory you created in Step 6 of Deploying the web application. For example, /opt/jetty/genconfig. 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 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 Web Services

Complete the steps below to verify each Web Services node is up and running.

Start

1. Type the following URL into a web browser:
   http://ws_host:ws_port/api/v2/diagnostics/version
   
   • ws_host — The host name or IP address for the Web Services node.
   • ws_port — The port for the 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":"8.5.200.96"}

End

Testing Workspace Web Edition

Complete the following steps for each Web Services node to confirm that Workspace Web Edition is working.

Start

1. Launch Workspace Web Edition by navigating to http://ws_host:ws_port/ui/ad/v1/index.html in a web browser.
   • ws_host — The host name or IP address for the Web Services node.
   • ws_port — The port for the Web Services node.
   For example, the URL might be http://192.0.2.20:8080/ui/ad/v1/index.html
   
   
2. Enter the credentials for a WWE agent, see Setting Up Agents On The System. Note that the user must be of the agent type.
3. After clicking Log In, Workspace Web Edition displays the agent desktop view and the agent is ready to work.

End

Testing Gplus Adapter for Salesforce

Complete the following steps for each Web Services node to confirm that Gplus Adapter for Salesforce is working.

Start

1. Launch Gplus Adapter for Salesforce by navigating to http://ws_host:ws_port/ui/crm-adapter/index.html in a web browser.
   • ws_host — The host name or IP address for the Web Services node.
   • ws_port — The port for the Web Services node.
   For example, the URL might be http://192.0.2.20:8080/ui/crm-adapter/index.html
   
   
2. Enter the credentials for any of the previously created agents. Note that the user must be of the agent type.
3. After clicking Log In, Gplus Adapter for Salesforce displays in the web browser. For details about how to deploy the adapter in Salesforce, see Gplus Adapter for Salesforce in this guide.

End