Latest revision as of 17:56, February 22, 2021

Starting and testing

Starting Web Services nodes

Perform the following for each Web Services node, starting with the syncNode.

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 -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 and -Xms8G are mandatory for the Web Services node.

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

/usr/bin/java -Xmx8G -Xms8G -jar /web-services/gws.jar

Testing Web Services

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

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"}
```

Testing Workspace Web Edition

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

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 a WWE agent, see Setting Up Agents On The System. 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.

Testing Gplus Adapter for Salesforce

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

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.

@@ Line 1: / Line 1: @@
-= Starting and Testing Workspace Web Edition & Web Services =
+= Starting and testing =
+__TOC__
+After you install and configure Web Services, you should start the nodes in the following order:
-When the installation is complete, you must start the Workspace Web Edition & Web Services nodes in the following order:
+<ol>
+<li>Start the [[HTCCConfigurationOptionsReference#syncNode|syncNode]]. </li>
+<li>Start the remaining nodes.</li>
+</ol>
+==Starting Web Services nodes==
-# Start the web services or 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.
+Perform the following for each Web Services node, starting with the [[HTCCConfigurationOptionsReference#syncNode|syncNode]].
-# Start the remaining nodes.
-Complete the following steps for each Workspace Web Edition & Web Services node.
+* 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 -Xmx8G -Xms8G -jar [home dir]/gws.jar
+</source>
+**<tt>[java dir]</tt> &mdash; The home directory for Java. For example, '''/usr/bin/java'''.
+**<tt>[home dir]</tt> &mdash; The home directory you created for your [[DeployWebApp|Web Services web application]]. For example, '''/web-services'''.
+*; {{NoteFormat|The memory allocation <tt>-Xmx8G</tt> and <tt>-Xms8G</tt> are mandatory for the Web Services node.}}
+For example, your command line might look like the following:
+<source lang="text">
+/usr/bin/java -Xmx8G -Xms8G -jar /web-services/gws.jar
+</source>
+</li>
+</ol>
+==Testing Web Services==
+Complete the steps below to verify each Web Services node is up and running.<br/><br/>
-'''Start of Procedure'''
 <ol>
-<li>To start the Web Services node, enter the following command as one complete command line entry, replacing items in square brackets [ ] with the appropriate values as described below:
+<li>Type the following URL into a web browser: <br>
-<pre>[java dir]/java -Xmx4096m -Xms4096m -XX:MaxPermSize=512m -XX:PermSize=512m -Djetty.port=[jetty port]
+<tt>http://''ws_host'':''ws_port''/api/v2/diagnostics/version</tt><br/>
--Djetty.logs=[jetty log dir] -Dconfig.path=[config dir] -Djetty.home=[jetty dir] -Djava.io.tmpdir=/tmp
+*<tt>''ws_host''</tt> &mdash; The host name or IP address for the Web Services node.
--Djava.net.preferIPv4Stack=true -jar [jetty dir]/start.jar --pre=etc/jetty-logging.xml --daemon
+*<tt>''ws_port''</tt> &mdash; The port for the Web Services node.
-</pre>
+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:
+<source lang="text">
+{"statusCode":0,"version":"8.5.200.96"}
+</source>
+</li>
+</ol>
-*[java dir] &mdash; The home directory for Java. For example, <tt>/usr/bin/java</tt>.
-*[jetty port] &mdash; The Jetty port. For example, <tt>8080</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>.
-{{NoteFormat|The memory allocation <tt>-Xmx4096m, -Xms4096m, -XX:MaxPermSize, -XX:PermSize</tt> is mandatory for the web services node.}}
+== Testing Workspace Web Edition==
+Complete the following steps for each Web Services node to confirm that Workspace Web Edition is working.<br/><br/>
+<ol>
+<li>Launch Workspace Web Edition by navigating to <tt>http://''ws_host'':''ws_port''/ui/ad/v1/index.html</tt> in a web browser.
+*<tt>''ws_host''</tt> &mdash; The host name or IP address for the 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/>
+</li>
+<li>Enter the credentials for a WWE agent, see [[Documentation:HTCC:IWWDep:SettingUpAgents|Setting Up Agents On The System]]. 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>
-For example, your command line might look like the following:
-<pre>
-/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
+== 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/>
--Djava.net.preferIPv4Stack=true -jar /opt/jetty/start.jar --pre=etc/jetty-logging.xml --daemon
+<ol>
-</pre>
+<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.
+*<tt>''ws_host''</tt> &mdash; The host name or IP address for the 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/crm-adapter/index.html</nowiki></tt><br/><br/>
 </li>
-<li>To verify that Workspace Web Edition & Web Services Server is up and running, type the following URL into a web browser: <br>
+<li>Enter the credentials for any of the previously created agents. Note that the user must be of the agent type.</li>
-<tt>http://[wwews_host]:[wwews_port]/api/v2/diagnostics/version</tt><br/>
+<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>
-*<tt>[wwews_host]</tt> &mdash; The host name or IP address for the Workspace Web Edition & Web Services node.
+</ol>
-*<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.2]]

Latest revision as of 17:56, February 22, 2021

Starting and testing

Contents

Starting Web Services nodes

Testing Web Services

Testing Workspace Web Edition

Testing Gplus Adapter for Salesforce

Contact

Genesys

Customer Care

Legal