Jump to: navigation, search
(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 =
 
__TOC__
 
__TOC__
After you install and configure Workspace Web Edition & Web Services, you should start the nodes in the following order:
+
After you install and configure Web Services, you should start the nodes in the following order:
  
 
<ol>
 
<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 [[HTCCConfigurationOptionsReference#syncNode|syncNode]]. 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>
 
<li>Start the remaining nodes.</li>
 
</ol>
 
</ol>
  
==Starting the Workspace Web Edition & Web Services Node==
+
==Starting the Web Services nodes==
Complete the following steps for each Workspace Web Edition & Web Services node, starting with the {{#ppin:{{SectionTransclusion|HTCCConfigurationOptionsReference|syncNode}}|syncNode|||500|200}}.<br/><br/>
+
Complete the following steps for each Web Services node, starting with the [[HTCCConfigurationOptionsReference#syncNode|syncNode]].<br/><br/>
 
'''Start'''
 
'''Start'''
 
<ol>
 
<ol>
Line 22: Line 22:
 
*<tt>[jetty port]</tt> &mdash; The Jetty port. For example, <tt>8080</tt>.
 
*<tt>[jetty port]</tt> &mdash; The Jetty port. For example, <tt>8080</tt>.
 
*<tt>[jetty log dir]</tt> &mdash; The log directory for Jetty. For example, '''/var/log/jetty'''.
 
*<tt>[jetty log dir]</tt> &mdash; The log directory for Jetty. For example, '''/var/log/jetty'''.
*<tt>[config dir]</tt> &mdash; 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.
+
*<tt>[config dir]</tt> &mdash; The path to theWeb Services config directory you created in Step 6 of [[DeployWebApp|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.
 
*<tt>[jetty dir]</tt> &mdash; The home directory for Jetty. For example, '''/opt/jetty'''.
 
*<tt>[jetty dir]</tt> &mdash; 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.}}
+
{{NoteFormat|The memory allocation <tt>-Xmx4096m, -Xms4096m, -XX:MaxPermSize, -XX:PermSize</tt> is mandatory for the Web Services node.}}
  
 
For example, your command line might look like the following:
 
For example, your command line might look like the following:
Line 37: Line 37:
 
'''End'''
 
'''End'''
  
==Testing the Workspace Web Edition & Web Services Node==
+
==Testing Web Services==
Complete the steps below to verify each Workspace Web Edition & Web Services node is up and running.<br/><br/>
+
Complete the steps below to verify each Web Services node is up and running.<br/><br/>
 
'''Start'''
 
'''Start'''
 
<ol>
 
<ol>
 
<li>Type the following URL into a web browser: <br>
 
<li>Type the following URL into a web browser: <br>
<tt>http://''wwews_host'':''wwews_port''/api/v2/diagnostics/version</tt><br/>
+
<tt>http://''ws_host'':''ws_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>''ws_host''</tt> &mdash; The host name or IP address for the Web Services node.
*<tt>''wwews_port''</tt> &mdash; The port for the Workspace Web Edition & Web Services node.
+
*<tt>''ws_port''</tt> &mdash; The port for the 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 is printed in the browser: </li>
 
If the request is successful, the version is printed in the browser: </li>
 
<source lang="text">
 
<source lang="text">
{
+
{"statusCode":0,"version":"8.5.200.96"}
    statusCode: 0
 
    version: "gws-x.x.xxx.xx"
 
}
 
 
</source>
 
</source>
 
</li>
 
</li>
Line 58: Line 55:
  
 
== Testing Workspace Web Edition==
 
== 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/>
+
Complete the following steps for each Web Services node to confirm that Workspace Web Edition is working.<br/><br/>
 
'''Start'''
 
'''Start'''
 
<ol>
 
<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>
+
<li>Launch Workspace Web Edition by navigating to <tt>http://''ws_host'':''ws_port''/ui/ad/v1/index.html</tt> in a web browser.</li>
*<tt>''wwews_host''</tt> &mdash; The host name or IP address for the Workspace Web Edition & Web Services node.
+
*<tt>''ws_host''</tt> &mdash; The host name or IP address for the Web Services node.
*<tt>''wwews_port''</tt> &mdash; The port for the Workspace Web Edition & Web Services node.
+
*<tt>''ws_port''</tt> &mdash; The port for the 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/>
 
For example, the URL might be <tt><nowiki>http://192.0.2.20:8080/ui/ad/v1/index.html</nowiki></tt><br/><br/>
  
Line 70: Line 67:
 
</ol>
 
</ol>
 
'''End'''
 
'''End'''
<!--
 
=== Workspace Web Edition Supervisor Desktop ===
 
  
 +
== Testing Gplus Adapter for Salesforce==
 +
Complete the following steps for each Web Services node to confirm that Gplus Adapter for Salesforce is working.<br/><br/>
 +
''Start'''
 
<ol>
 
<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>Launch Gplus Adapter for Salesforce by navigating to <tt>http://''ws_host'':''ws_port''/ui/crm-adapter/index.html</tt> in a web browser.</li>
<li>Enter the credentials for any of the previously created agents. Note that the user must be of the supervisor type.</li>
+
*<tt>''ws_host''</tt> &mdash; The host name or IP address for the Web Services node.
<li>After clicking Log In, the Workspace Web Edition agent desktop view is displayed and the agent is ready to work.</li>
+
*<tt>''ws_port''</tt> &mdash; The port for the Web Services node.
 +
For example, the URL might be <tt><nowiki>http://192.0.2.20:8080/ui/crm-adapter/index.html</nowiki></tt><br/><br/>
 +
 
 +
<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''', Gplus Adapter for Salesforce displays in the web browser. For details about how to deploy the adapter in Salesforce, see [[DeployGplusSalesforce|Gplus Adapter for Salesforce]] in this guide.</li>
 
</ol>
 
</ol>
-->
+
'''End'''
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Revision as of 19:57, January 22, 2016

Starting and testing

After you install and configure 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 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 -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:
  2. {"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

  • 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

    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

  • Enter the credentials for any of the previously created agents. Note that the user must be of the agent type.
  • 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

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