Installation Guide v1.2

 

Overview

This document contains installation and configuration instructions for the Cloudwords WebCenter Sites integration plugin.

Prerequisites

Oracle WebCenter Sites 11.1.1.8 is required. 

Third party dependencies

This integration includes the Cloudwords Client (cw-client-1.16.2.jar) library, provided by Cloudwords.This integration includes the GST Site Foundation 11.6.1 (gst-foundation-all-11.6.1.jar), licensed under the Apache 2 license.

This integration includes okapi libraries:

  • okapi-core-0.2.7.jar
  • okapi-filter-abstractmarkup-0.27.jar
  • okapi-filter-html-0.27.jar
  • okapi-xliff-0.27.jar
  • okapi-lib-tkit-0.27.jar

This integration includes a JSON library:

  • json-20120521.jar

The integration includes a parser:

  • jericho-html-3.4-dev.jar
  • snakeyaml-1.13.jar
  • stax2-api-3.1.1.jar
  • woodstox-core-lgpl-4.1.4.jar

 

Installation Instructions

Setup

  1. Unzip the cloudwords-wcs-kit-{version}.zip file

WCS Management Environment Only

This integration is designed to be installed on a management environment, not a delivery environment.  It operates on both clustered and non-clustered management environments. Installation on delivery environments is neither useful nor supported.

With WebCenter Sites Shut Down

 

  1. Overlay all files from the {kit}/install/war folder onto the WebCenter Sites web application

    Typically this is the “webapps/cs” folder in your application server, though this will vary based on your application server and the web application context root selected at the time of installation of WebCenter Sites.

    To “overlay” files, copy the files from the directories in this kit into the corresponding directories in the web application. For example, copy the js/fw/ui/document/CustomAssetDocument.js file into the existing js/fw/ui/document  Replace any files that already exist. Create new folders as needed.

  2. Create a new file inside your WebCenter Sites Home folder called ini.

    This is the folder known as the “inipath” in your xml and it always contains a file called “futuretense.ini”.


  3. Configure the integration by adding the appropriate values to the ini file. See below for details.

  4. Edit your xml file (typically located at webapps/cs/WEB-INF/web.xml)

    Add the following section above your first <context-param> fragment:
    <context-param>
        <param-name>gsf-contexts</param-name>
        <param-value>com.cloudwords.wcs.config.WebAppContext</param-value>
    </context-param>

    Add the following section above your first <listener> fragment:
    <listener>
       <listener-class>com.fatwire.gst.foundation.controller.support.WebAppContextLoader</listener-class>
    </listener>

 

Start WebCenter Sites

Start the application server to start up WebCenter Sites

 

Import Components

  1. Using CSDT, import all artifacts stored in the {kit}/install/envision folder
    1. If using Windows, refer to the CSDT documentation here: https://docs.oracle.com/cd/E29542_01/doc.1111/e29634/dt_commandlinetool.htm#WBCSD995
    2. If using Unix, run the import-csdt.sh script in the {kit}/install folder and follow the prompts

 

Import script prompts

 

Prompt

Description

WebCenter Sites web application

Enter the path into which the current running WebCenter Sites web application exists.  This folder is typically deployed in the application server’s “webapps” folder and it contains a WEB-INF directory.

WebCenter Sites Home

Enter the path to the WebCenter Sites home directory.  This is the folder that contains the futuretense.ini file.

URL to WebCenter Sites Satellite

Enter the URL that can access WebCenter Sites from the system where the script is running.

WCS admin username

Enter a user with admin privileges so that the import can be run

WCS admin password

The password for the user above

WCS Site

Enter the site into which these resources will be imported.  Currently this does not need to be set.

 

Import script example

 [root@unicorn install]# ./import-csdt.sh 

CSDT Import Utility                   

Enter the path to the WebCenter Sites web application (e.g. /opt/apache-tomcat-7.0.54/webapps/cs): /opt/apache-tomcat-7.0.54/webapps/cs

Enter the WebCenter Sites home (inipath) (e.g. /opt/sites-11.1.1.8.0): /opt/sites-11.1.1.8.0                                          

Enter the URL to WebCenter Sites Satellite (e.g. http://unicorn:80/cs/Satellite): http://unicorn:80/cs/Satellite                      

Enter WCS admin username: fwadmin                                                                                                   

Enter the WCS admin password:                                                                                                         

Enter the WCS Site name(s) (e.g. FirstSiteII,avisports): FirstSiteII                                                                  

Creating cloudwords_install_workspace                                                                                                 

Copying files to workspace                                                                                                            

Entering workspace

Importing components                                                                                                                

import @ELEMENTCATALOG FirstSiteII FirstSiteII
*** Importing batch 1417043705972                                                                                                   
...
*** Completed importing batch 1417043705972
Success
import @SITECATALOG FirstSiteII FirstSiteII
*** Importing batch 1417043706045
...
*** Completed importing batch 1417043706045 

Success
Cleaning up cloudwords_install_workspace

[root@unicorn install]#

Configuration

Create a new file inside your WebCenter Sites Home folder called cw.ini and add the following properties.  Use the format:

propertyname : property-value

Property

Description

cw.apikey

Enter the API key corresponding to your Cloudwords user account. This can be retrieved from your user profile screen on the Cloudwords system.

cw.apiver

Enter the API version.  Currently only “1.16” is supported.

cw.apiurl

Enter the URL to the Cloudwords API endpoint.  E.g. https://api-sandbox.cloudwords.com

cw.appurl

Enter the URL to the Cloudwords application.  E.g. https://app-sandbox.cloudwords.com

 

The following properties are optional. 

Property

Description

cw.batchuser

Enter the user name of the WCS user that will run background operations. If not set, the user corresponding to xcelerate.batchuser from futuretense_xcel.ini is used instead.

cw.batchpass

Enter the password corresponding to the cw.batchuser account. If cw.batchuser is set, this value is required. If cw.batchuser is not set, this value is ignored.

cw.proxy.host

Enter the host name for the proxy to be used. If not set, no proxy will be used.

cw.proxy.port

Enter the port number to use for the proxy. The default value is 80.

cw.proxy.username

Enter the username required to authenticate to the proxy, if needed. If not set, no authentication provider will be configured.

cw.proxy.password

Enter the password required to authenticate to the proxy, if needed. If not set, a null password will be sent to the proxy.

cw.enabled-sites

Comma-separated list of site names for which the Cloudwords integration is enabled. If not specified, all eligible sites are enabled.

      


Run the Installer

  1. Log in to WebCenter Sites as an administrator with UserEditor privileges
  2. Grant your user SiteGod privileges if they are not already assigned
  3. Run the installer
    1. Paste this URL into your browser, substituting your values for the value of the URL base, authusername, and authpassword
      http://unicorn/cs/ContentServer?pagename=CustomElements/Cloudwords/UI/Action/Dispatcher&action=class:com.cloudwords.wcs.action.InstallCloudwordsWCS&authusername=fwadmin&authpassword=xceladmin
    2. Upon successful installation, you should see the following message:

      Picture1.png
  4. Optionally, revoke SiteGod privileges from your user if you granted them above

 
Test the Installation

In order to test the installation, Log in to the WebCenter Sites Contributor Interface and select FirstSiteII.  The Cloudwords main menu should be clearly visible:

Picture2.png

 

If this is visible, the integration has been successfully installed.

Installation Complete

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.