Content Acquisition System Installation Guide

Content Acquisition System Installation Guide
Version 11.3
April 2017
Document build ID: 2017-04-20T14:58:39-04:00
Content Acquisition System Installation Guide
Product version: 11.3
Release date: 4-28-17
Copyright © 2003, 2017, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are
protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy,
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any
means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please
report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government,
the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the
hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and
adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or
documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended
for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or
hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures
to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in
dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are
trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or
registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties.
Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party
content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and
its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or
services, except as set forth in an applicable agreement between you and Oracle.
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/
topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support: Oracle customers that have purchased support have access to electronic support through My Oracle Support. For
information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.
Table of Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Who should use this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Conventions used in this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Contacting Oracle Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
1. Before you install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview of the Content Acquisition System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Prerequisite Oracle Commerce components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
CAS Document Conversion Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Recommended reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Getting Started Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Migration Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Installing the Content Acquisition System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Creating a user for the Oracle Commerce services on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installing CAS on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing CAS silently on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Updating the Deployment Template to use the WSDL client stubs and the CAS Deployment
Template component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installing CAS on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Adding the CAS service to inittab on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installing only the CAS Console on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Installing CAS silently on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Integrating CAS with the Deployment Template on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Web Crawler installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Package contents and directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Required installer file permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
About changing the role used for the CAS Console extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3. Uninstalling the Content Acquisition System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Uninstalling CAS on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Uninstalling CAS Console on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Uninstalling CAS on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Uninstalling a plug-in from CAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Uninstalling CAS Console if its extension configuration was changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Content Acquisition System Installation Guide
iii
iv
Content Acquisition System Installation Guide
Preface
Oracle Commerce Guided Search is the most effective way for your customers to dynamically explore your
storefront and find relevant and desired items quickly. An industry-leading faceted search and Guided
Navigation solution, Guided Search enables businesses to influence customers in each step of their search
experience. At the core of Guided Search is the MDEX Engine™, a hybrid search-analytical database specifically
designed for high-performance exploration and discovery. The Oracle Commerce Content Acquisition System
provides a set of extensible mechanisms to bring both structured data and unstructured content into the MDEX
Engine from a variety of source systems. The Oracle Commerce Assembler dynamically assembles content from
any resource and seamlessly combines it into results that can be rendered for display.
Oracle Commerce Experience Manager enables non-technical users to create, manage, and deliver targeted,
relevant content to customers. With Experience Manager, you can combine unlimited variations of virtual
product and customer data into personalized assortments of relevant products, promotions, and other content
and display it to buyers in response to any search or facet refinement. Out-of-the-box templates and experience
cartridges are provided for the most common use cases; technical teams can also use a software developer's kit
to create custom cartridges.
About this guide
This guide describes how to install the Content Acquisition System and set up CAS components after installation
on Windows and UNIX.
Note
Unless otherwise indicated, whenever this document specifies UNIX, it applies to Linux and Solaris.
Who should use this guide
This guide is intended for application developers who are building applications using the CAS components and
are responsible for installation tasks.
Preface
v
Conventions used in this guide
This guide uses the following typographical conventions:
Code examples, inline references to code elements, file names, and user input are set in monospace font. In the
case of long lines of code, or when inline monospace text occurs at the end of a line, the following symbol is
used to show that the content continues on to the next line: ¬
When copying and pasting such examples, ensure that any occurrences of the symbol and the corresponding
line break are deleted and any remaining space is closed up.
Contacting Oracle Support
Oracle Support provides registered users with answers to implementation questions, product and solution help,
and important news and updates about Guided Search software.
You can contact Oracle Support through the My Oracle Support site at https://support.oracle.com.
vi
Preface
1
Before you install
This section provides an overview of the Content Acquisition System, system requirements, and other
information you need to know before installing.
Related links
• Overview of the Content Acquisition System (page 1)
• Prerequisite Oracle Commerce components (page 1)
• System requirements (page 1)
• CAS Document Conversion Module (page 2)
• Recommended reading (page 2)
Overview of the Content Acquisition System
The Oracle Commerce Content Acquisition System is a set of components that add, configure, and crawl data
sources for use in an Oracle Commerce application. Data sources include file systems, Content Management
System crawls, Web servers, and custom data sources. The Oracle Commerce Content Acquisition System crawls
data sources, converts documents and files to Endeca records and processes them for use in an MDEX Engine.
Prerequisite Oracle Commerce components
CAS Console depends on Oracle Commerce Workbench. Tools and Frameworks, which includes Workbench,
must be installed on the machine where you install the CAS Console.
System requirements
See the Oracle Commerce Supported Environments Matrix document in the My Oracle Support knowledge
base at https://support.oracle.com/ for information on supported operating systems and Web browsers.
1 Before you install
1
Hard disk capacity must be sufficient to store the records written to the Record Store or to record output files.
Please contact your Oracle representative if you need more information on hardware sizing.
Minimum hardware requirements:
• x64 processor, minimum 1.8 GHz
• 2 GB of RAM
• At least an 80 GB hard drive, depending on the size of your application data set
CAS Document Conversion Module
In CAS 3.0.1 and later, the CAS Document Conversion Module is installed and enabled as part of the CAS
installation.
For a list of supported file formats, see "Appendix B File Formats Supported by the CAS Document Conversion
Module" in the Oracle Commerce CAS Developer's Guide.
Recommended reading
Before installing, Oracle recommends that you read the following documents for important information about
the release.
Getting Started Guide
The Oracle Commerce Getting Started Guide gives an overview of Oracle Commerce components and includes
information about configuration scenarios. After installing all the components in your deployment, read this
guide for information on verifying your installation. You can download the Oracle Commerce Getting Started
Guide from the Oracle Technology Network.
Release Notes
Refer to the release notes for information about known issues for this release. You can download the Oracle
Commerce Guided Search and Experience Manager Release Notes from the Oracle Technology Network.
Migration Guide
Refer to the Oracle Commerce CAS Migration Guide for information about migrating your implementation from
a previous version of Oracle Commerce software. You can download the Oracle Commerce CAS Migration Guide
from the Oracle Technology Network.
2
1 Before you install
2
Installing the Content Acquisition
System
This section contains installation procedures and describes the contents of the installation directory. Although
the CAS Console extension for Oracle Commerce Workbench is distributed in a single package with the CAS
Server, it can be installed without installing the CAS Server.
Related links
• Installing on Windows (page 3)
• Installing on UNIX (page 7)
• ???
• Web Crawler installation (page 12)
• Package contents and directory structure (page 12)
• About changing the role used for the CAS Console extension (page 17)
Installing on Windows
This section provides instructions for installing CAS on Windows.
Creating a user for the Oracle Commerce services on Windows
You must run the Oracle Commerce services as a specified user, for which you can control permissions.
Oracle recommends that you create a user account called endeca that has the proper file and directory
permissions to access all necessary files for your application, and that you set up your Oracle Commerce
Workbench Service to run under this account. However, you can use any user that you prefer, as long as it meets
these requirements.
To create the user endeca:
1. Ensure that you have administrator privileges on the local machine.
2. From the Windows Control Panel, select Computer Management → Administrative Tools.
2 Installing the Content Acquisition System
3
3. In the tree pane of the Computer Management window, select System Tools → Local Users and Groups.
4. Right-click Users and select New User.
5. In the New User dialog box, do the following:
a. Enter endeca for both the User name and the Full name.
b. Optionally, enter a description.
c. Set a password for user endeca.
Note
The user must have a non-blank password, because the installer will not accept a blank password
for the services user.
d. Uncheck User must change password at next logon.
6. Click Create to create the new user, and then Close to exit the dialog box.
7. Close the Computer Management window, but do not exit Administrative Tools.
8. From Administrative Tools, do the following:
a. Open Local Security Policy.
b. In the Local Security Settings window, select Local Policies → User Rights Assignments.
c. From the list of policies on the right, open Log on as a Service.
d. Add user endeca to the list of users that can register a process as a service.
e. Close the dialog box and exit Administrative Tools.
Installing CAS on Windows
Before installing, ensure that you have met the following pre-requisites:
• Ensure you have administrator privileges on the local machine.
• Close all running programs and, if you previously had CAS installed on this machine, refer to the "Upgrading"
section of the CAS Migration Guide for information on migration procedures.
• If you are installing CAS Console, the ENDECA_TOOLS_ROOT and ENDECA_TOOLS_CONF environment variables
must be set on the machine running Oracle Commerce Tools and Frameworks before running the CAS
installation program. Setting these variables happens automatically when you restart the machine that has
Oracle Commerce Tools and Frameworks installed.
Note
Even if you are installing on a drive other than the C drive, you should have approximately 400 MB of
space available on the system drive before installing. This space is needed temporarily for the installer
4
2 Installing the Content Acquisition System
files that are unpacked on the C drive during the installation regardless of the drive you specified for
your installation. The space is cleared after the installation process completes.
To install CAS on Windows:
1. Download the Content Acquisition System package from the Oracle Software Delivery Cloud.
2. Extract the Content Acquisition System package to a local directory.
The name of the extracted installer file is OCcas-<version>-win32.exe.
3. Double-click the installer file OCcas-<version>-win32.exe to start the wizard.
4. Select your preferred language, and click OK.
5. In the Introduction screen, click Next to begin the installation process.
6. Accept the terms of the license agreement and click Next.
7. In the Choose Install Folder screen, accept the default location of C:\Endeca\CAS and then click Next.
8. In the Choose Product Features screen, select required program features and click Next.
9. In the Get User Input screen, accept the default values for the CAS Server port(8500) and CAS Server
shutdown port (8506).
10.In the Get User Input for Tools and Frameworks Variables screen, verify that the values for
ENDECA_TOOLS_ROOT and ENDECA_TOOLS_CONF are correct.
ENDECA_TOOLS_ROOT
C:\Endeca\ToolsAndFrameworks\11.3.0
ENDECA_TOOLS_CONF
C:\Endeca\ToolsAndFrameworks\11.3.0\server\workspace
11.In the Pre-Installation Summary screen, review the settings you have selected and click Install.
12.In the Install Complete screen, click Done to exit the wizard.
The CAS Service starts automatically after installation.
After CAS is installed, set the CAS_ROOT environment variable to the location where you installed CAS, for
example, C:\Endeca\CAS\11.3.0.
Related links
• Installing CAS silently on Windows (page 5)
• Updating the Deployment Template to use the WSDL client stubs and the CAS Deployment Template
component (page 7)
• Creating a user for the Oracle Commerce services on Windows (page 3)
Installing CAS silently on Windows
The silent installer is useful if you want to add the CAS installation to an install script, or push out the installation
on multiple machines. The silent installer is not interactive.
2 Installing the Content Acquisition System
5
To launch the silent installer on Windows:
1. From a command prompt, navigate to the directory where you downloaded the installer.
2. Create a response file with the appropriate properties.
Guided Search property Name
Description
INSTALLDIR
Required. Specifies the absolute path to the
directory to install CAS (e.g., C:\\Endeca\\CAS).
Keep in mind that you cannot install the software in
a directory with spaces in its name.
Note
If you do not use the default location, and
you are installing more than one Guided
Search product on the same machine,
ensure that you install each product to a
separate location.
CASPORT
Required. The port on which the CAS Service listens.
The default is 8500.
CASSHUTDOWNPORT
Required. The shutdown port for the CAS Service.
The default is 8506.
ENDECA_TOOLS_ROOT
Required. C:\\Endeca\\ToolsAndFrameworks\
\11.3.0
ENDECA_TOOLS_CONF
Required. C:\\Endeca\\ToolsAndFrameworks\
\11.3.0\\server\\workspace
Example:
INSTALLDIR=C:\\Endeca\\CAS
CASPORT=8500
CASSHUTDOWNPORT=8506
ENDECA_TOOLS_ROOT=C:\\Endeca\\ToolsAndFrameworks\\11.3.0
ENDECA_TOOLS_CONF=C:\\Endeca\\ToolsAndFrameworks\\11.3.0\\server\\workspace
3. Issue a command of the following form:
OCcas-<version>-win32.exe -i silent -f cas_response.properties
When the CAS installation is complete, the CAS Service starts automatically.
After CAS is installed, set the CAS_ROOT environment variable to the location where you installed CAS, for
example, C:\Endeca\CAS\11.3.0.
6
2 Installing the Content Acquisition System
Updating the Deployment Template to use the WSDL client stubs and the CAS
Deployment Template component
This task is optional. It may be necessary if you did not integrate the CAS Deployment Template component into
the Deployment Template during the installation process and then later found that you need the Deployment
Template to manage crawling operations.
To update the Deployment Template:
1. Copy the new CAS Deployment Template component into the Deployment Template:
• On Windows, copy <install path>\CAS\<version>\lib\cas-dt\casStubs.jar to <install
path>\ToolsAndFrameworks\<version>\deployment_template\app-templates\common\
config\lib\java and replace the existing JAR file.
• On UNIX, copy <install path>/CAS/<version>/lib/cas-dt/casStubs.jar to <install path>/
ToolsAndFrameworks/<version>/deployment_template/app-templates/common/ config/lib/
java.
Both the WSDL client stubs and the CAS Deployment Template component (the
ContentAcquisitionServerComponent class) are packaged in casStubs.jar.
For details on upgrading applications deployed for a previous version of CAS, see the Oracle Commerce CAS
Migration Guide.
Installing on UNIX
This section provides instructions for installing CAS on UNIX.
Installing CAS on UNIX
The Oracle Commerce software is distributed as a self-extracting bin file and install script.
CAS unpacks to approximately 400 MB. Because multiple versions may be stored, a destination in a large
partition is recommended.
To install CAS on UNIX:
1. Stop the Endeca Tools Service.
2. In your local environment, locate the CAS installation package that you downloaded from the Oracle
Software Delivery Cloud. The name of the installation file is as follows:
• For Intel Linux 64-bit: OCcas<version>-linux64.bin
• For SPARC Solaris: OCcas<version>-solaris.bin
2 Installing the Content Acquisition System
7
3. Determine where you will install CAS. Verify that the target directory where you plan to install has enough
available disk space and has write permissions (is not read-only). For example, in this procedure we assume
that the target directory is /usr/local and that you have write permissions for it. If you do not set these
permissions, the install script will not run.
4. From the /downloads directory, start the installation with the following command:
./OCcas11.3.0-linux64.bin
or
./OCcas11.3.0-solaris.bin
5. Select a locale.
6. In the Introduction screen, press Enter to continue.
7. Accept the terms of the license agreement.
8. In the Choose Install Folder screen, enter /usr/local as the installation location.
9. In the Choose Product Features screen, enter the number for the program features to be installed. The default
is Typical.
Product Features
Description
Content Acquisition System
Oracle Commerce Web Crawler and CAS Server, and
a rich set of packaged adapters
CAS Samples
Examples of CAS usage. These examples contain
code and configuration files.
CAS Console as a Workbench Extension
Web-based application used to crawl various
data sources including file systems and content
management systems
CAS Deployment Template Integration
Integrates CAS with the Tools and Frameworks
Deployment Template. The integration enables you
to control CAS operations using the Deployment
Template.
10.Enter the CAS Server port.
11.Enter the CAS Server Shutdown port.
12.Enter the fully qualified CAS Server host name.
13.If ENDECA_TOOLS_ROOT or ENDECA_TOOLS_CONF is not set in the environment, the installer prompts you for
these values.
14.In the Pre-Installation Summary screen, review the settings you have selected and press Enter to continue.
8
2 Installing the Content Acquisition System
15.In the Ready to Install screen, press Enter to start the installation.
The Installation Complete message displays at the completion of the installation.
16.Press Enter to exit the installation.
Following installation:
• To start the CAS Service, navigate to /usr/local/endeca/CAS/<version>/bin and run the following
script: cas-service.sh
• If you chose to install the CAS Console, you must restart the Oracle Tools Service.
• Set the CAS_ROOT environment variable to the location where you installed CAS, for example, /usr/local/
endeca/CAS/11.3.0.
Related links
• Installing CAS silently on UNIX (page 10)
• Updating the Deployment Template to use the WSDL client stubs and the CAS Deployment Template
component (page 7)
Adding the CAS service to inittab on UNIX
In a UNIX development environment, the CAS Service can be started from the command line. In a UNIX
production environment, however, Oracle recommends starting it from inittab.
In UNIX you run the CAS Server using cas-service.sh, located in usr/local/endeca/CAS/<version>/bin.
You can write a script that calls cas-service.sh and is referenced in inittab.
When writing your script, it is recommended as a best practice that you run the CAS Service as a user other than
root.
This sample script (named start_cas_service.sh) sets the ENDECA_USER variable to the “endeca” user and
then issues an su command to change to the “endeca” user:
#!/bin/sh
ENDECA_USER=endeca
CAS_ROOT=/usr/local/endeca/CAS/<version>
CAS_WORKSPACE=/usr/local/endeca/CAS/workspace
# change to user endeca
su $ENDECA_USER -c "cd $CAS_ROOT/bin; \
$CAS_ROOT/bin/cas-service.sh >> $CAS_WORKSPACE/logs/cas-service-wrapper.log 2>&1"
The start_cas_service.sh script is then referenced in inittab with an entry similar to this example:
ecas:2345:respawn:/usr/local/endeca/CAS/<version>/bin/start_cas_service.sh
When writing your startup script, keep in mind that it is server-specific, and therefore its details (such as paths
and user names) depend on the configuration of your server.
2 Installing the Content Acquisition System
9
Installing only the CAS Console on UNIX
Use the configure_tools_and_frameworks_integration.sh script to install only the CAS Console:
• If you installed CAS but did not install the CAS Console as a Workbench extension (using the -skip_console_installation flag).
• If you intend to install the CAS Console with more than one instance of Workbench
• If you intend to run the CAS Service on a separate machine from the one that hosts the CAS Console
Workbench Extension
To install only the CAS Console on UNIX:
1. Stop CAS Service.
2. Open a command-line and issue the following:
/usr/local/endeca/CAS/<version>/bin/configure_tools_and_frameworks_integration.sh -skip_dt_integration
[--endeca_tools_root full path to the Tools root directory]
[--endeca_tools_conf full path to the Tools /conf directory]
This registers the CAS Console with the specified Workbench installation.
Note
You may omit the flags for --endeca_tools_root and --endeca_tools_conf if these variables
are already set as environment variables.
3. Start CAS Service.
Installing CAS silently on UNIX
The silent installer is useful if you want to add the CAS installation to your own install script, or push out the
installation on multiple machines.
The silent installer is not interactive.
To run the silent installer:
1. From a command prompt, navigate to the directory where you downloaded the installer.
2. Create a response file with the appropriate properties. for example, cas_response.properties, and
specify the response value for each prompt on its own line, in the order in which they appear in the
interactive installer.
10
2 Installing the Content Acquisition System
Guided Search property Name
Description
INSTALLDIR
Required. Specifies the absolute path to the
directory to install CAS (e.g., C:\\Endeca\\CAS).
Keep in mind that you cannot install the software in
a directory with spaces in its name.
Note
If you do not use the default location, and
you are installing more than one Guided
Search product on the same machine,
ensure that you install each product to a
separate location.
CASPORT
Required. The port on which the CAS Service listens.
The default is 8500.
CASSHUTDOWNPORT
Required. The shutdown port for the CAS Service.
The default is 8506.
CASHOST
Required. Specifies the CAS server host.
ENDECA_TOOLS_ROOT
Required. C:\Endeca\ToolsAndFrameworks
\11.2.0
Required. C:\Endeca\ToolsAndFrameworks
ENDECA_TOOLS_CONF
\11.2.0\server\workspace
Example:
INSTALLDIR=C:/Endeca/CAS
CASPORT=8500
CASSHUTDOWNPORT=8506
ENDECA_TOOLS_ROOT=C:/Endeca/ToolsAndFrameworks/11.2.0
ENDECA_TOOLS_CONF=C:/Endeca/ToolsAndFrameworks/11.2.0/server/workspace
Note
You must specify a value for each prompt. Even if you want to use the default, you must specify that
value to the installer.
3. Issue a command of the following form:
OCcas<version>-linux64.bin -i silent -f cas_response.properties
Following installation:
2 Installing the Content Acquisition System
11
• Start the CAS Service. Navigate to CAS/<version>/bin and run the following command: cas-service.sh
• Restart the Oracle Commerce Workbench Service.
Integrating CAS with the Deployment Template on UNIX
Use the configure_tools_and_frameworks_integration.sh script to integrate the CAS component into
the Deployment Template. This may be necessary if you installed CAS but did not integrate the CAS component
into the Deployment Template and then later found that you need the Deployment Template to manage
crawling operations.
To integrate CAS with the Deployment Template on UNIX:
1. Stop CAS Service.
2. Open a command-line and issue the following:
/usr/local/endeca/CAS/<version>/bin/configure_tools_and_frameworks_integration.sh -skip_console_integration
[--endeca_tools_root full path to the Tools root directory]
[--endeca_tools_conf full path to the Tools /conf directory]
Note
You may omit the flags for --endeca_tools_root and --endeca_tools_conf if these variables
are already set as environment variables.
3. Start CAS Service.
Web Crawler installation
The Oracle Commerce Web Crawler is installed as part of the CAS installation.
The Web Crawler startup script is in <install path>\CAS\<version>\bin (and in the equivalent path on
UNIX). The Web Crawler configuration files are in <install path>\CAS\conf\web (and in the equivalent path
on UNIX). See the Oracle Commerce Web Crawler Guide for details and usage.
Package contents and directory structure
The CAS directory is the root directory for the Content Acquisition System.
After installing the Content Acquisition System, you see this directory structure:
CAS
<version>
bin
...
12
2 Installing the Content Acquisition System
workspace
The contents of the CAS directory are described here in detail.
Directory
Contents
version\bin
• Scripts to start the CAS Service (cas-service.sh for UNIX and
cas-service.bat for Windows).
• Scripts to run the CAS Server Command-line Utility (cas-cmd.sh for
UNIX and cas-cmd.bat for Windows).
• Scripts to run the Component Instance Manager Command-line
Utility (component-manager-cmd.sh for UNIX and componentmanager-cmd.bat for Windows).
• Scripts to run the Record Store Command-line Utility
(recordstore-cmd.sh and recordstore-cmd.bat).
• Scripts to run the Web Crawler (web-crawler.sh for UNIX systems
and web-crawler.bat for Windows).
• Scripts to shut down the CAS Service (cas-service-shutdown.sh
for UNIX and cas-service-shutdown.bat for Windows).
• The executable that runs the CAS Service as a Windows service
(cas-service-wrapper.exe).
• Script to install CAS Console on UNIX
(configure_tools_and_frameworks_integration.sh)
version\console
• The casconsole.war file, which is the CAS Console application.
• The casconsole.xml file, which is the context file for the CAS
Console.
• The casconsole.properties file, which is the configuration file
for the CAS Console.
These files are copied to the Oracle Commerce Workbench installation
and used from that location.
version\doc
• The reference documentation (Javadoc) for the CAS Server, the
Component Instance Manager, the Record Store, the CAS Extension
API, the CAS Deployment Template Component, and the Web
Crawler.
• The Licensing Guide.
version\doc\wsdl
2 Installing the Content Acquisition System
The Web Service (WSDL) files for the CAS Server, the Component
Instance Manager, and the Record Store.
13
Directory
Contents
version\java
The JDK used to run the CAS components (except CAS Console, which
runs in the Oracle Commerce Workbench Service).
version\lib
• Libraries for the CAS command-line utilities including: the CAS
Server utility, the Component Instance Manager utility, the Record
Store utility.
• Libraries for the CAS APIs including: the CAS Server API, the
Component Instance Manager API, the Record Store API, and the
CAS Extension API.
version\lib\cas-dt
CAS WSDL client stub files for the Deployment Template.
version\lib\cas-serverplugins
Libraries for CAS plug-ins including CMS connectors and custom
extensions (if applicable).
version\lib\oit-sx
The CAS Document Conversion Module libraries.
version\lib\recordstore forge-adapter
The library for the Forge Record Store adapter.
version\lib\web-crawler
The Web Crawler libraries.
version\sample
Directories for the sample applications and sample extensions. The
sample applications are documented in the CAS Developer's Guide and
also in the CAS Extension API Guide.
version\webapps
The root.war file, which is the CAS Server and Component Instance
Manager applications.
version\workspace_template
The template for the workspace directory that contains configuration
files.
workspace
The working directory for the CAS Server and the Web Crawler.
workspace\conf
• The commandline.properties file, which contains the CAS Service
settings necessary for the CAS command-line utilities to run.
• Three logging configuration files (casservice.log4j.properties for the CAS Service, recordstorecmd.log4j.properties for the Record Store, and cascmd.log4j.properties for the Command-line Utility).
• The Jetty configuration files.
14
workspace\conf\web- crawler
\default
The default configuration files for the Web Crawler, including the
log4j.properties logging configuration file.
workspace\conf\web- crawler
\non-polite-crawl
Sample crawl configuration files for non-polite crawls. As with the
polite version, the settings in these files will override the default
settings.
2 Installing the Content Acquisition System
Directory
Contents
workspace\conf\ web-crawler
\polite-crawl
Sample crawl configuration files for polite crawls. The settings
in site.xml will override the same property settings in the
default.xml file, while the crawl-urlfilter.txt file will also
override the default version of the file.
workspace\logs
The cas-service.log file, which contains the CAS Service log
output, and includes log messages from all crawls managed by the CAS
Server.
workspace\output
Default destination directory for the crawl output from the Web
Crawler. The output directory is not present upon installation. It is
created when the Web Crawler writes to output records for a crawl.
workspace\state
State files for the CAS Service components. State files can include
Record Store instances, state directories for data source extension
information, and state directories for manipulator extension
information.
Note
There is no logs directory for the Web Crawler, because by default the Web Crawler sends its standard
output to the console. However, you can modify the log4j.properties file to send the output to a
file.
Required installer file permissions
The CAS installer creates directories and files set to the permissions required by Oracle Security standards.
All directories created by the installer are assigned the 550 permission (r-x r-x ---). Shell files are also assigned 550
permission, while all other files are assigned 640 permission (rw- r-- --- ).
Note
Do not alter these directory and file permissions.
Directory
Permission
CAS/<version>/bin (all .sh files)
550
CAS/<version>/java/bin
550
CAS/<version>/sample/cas-extensions/build.xml
640
CAS/<version>/sample/cas-extensions/data
640
CAS/<version>/sample/cas-extensions/data/document-db
640
CAS/<version>/sample/cas-extensions/data/documents
640
2 Installing the Content Acquisition System
15
16
Directory
Permission
CAS/<version>/sample/cas-extensions/src/* (all the files but not
directories)
640
CAS/<version>/sample/cas-server-java-client/build.xml
640
CAS/<version>/sample/cas-server-java-client/log4j.properties
640
CAS/<version>/sample/cas-server-java-client/src
640
CAS/<version>/sample/custom-web-crawler-plugin/plugin.xml
640
CAS/<version>/sample/custom-web-crawler-plugin/src
640
CAS/<version>/sample/forge-to-recordstore/*.sh
550
CAS/<version>/sample/forge-to-recordstore/forge-config/*
640
CAS/<version>/sample/forge-to-recordstore/forge-input-data/*
640
CAS/<version>/sample/forge-to-recordstore/forge-partial-inputdata/*
640
CAS/<version>/sample/forge-to-recordstore/recordstoreconfiguration.xml
640
CAS/<version>/sample/multiple-recordstore-to-forge/*.sh
550
CAS/<version>/sample/multiple-recordstore-to-forge/forge-config/*
640
CAS/<version>/sample/multiple-recordstore-to-forge/forge-outputdata/*
640
CAS/<version>/sample/multiple-recordstore-to-forge/forge-partialoutput-data/*
640
CAS/<version>/sample/recordstore-java-client/*.sh
550
CAS/<version>/sample/recordstore-java-client/build.xml
640
CAS/<version>/sample/recordstore-java-client/conf/*
640
CAS/<version>/sample/recordstore-java-client/src/*
640
CAS/<version>/sample/recordstore-to-forge/*.sh
550
CAS/<version>/sample/recordstore-to-forge/forge-config/*
640
CAS/<version>/sample/recordstore-to-forge/forge-output-data/*
640
CAS/<version>/sample/recordstore-to-forge/forge-partial-outputdata/*
640
CAS/<version>/sample/webcrawler-to-recordstore/*.sh
550
2 Installing the Content Acquisition System
Directory
Permission
CAS/<version>/sample/webcrawler-to-recordstore/*.xml
640
CAS/<version>/sample/webcrawler-to-recordstore/conf/*
640
About changing the role used for the CAS Console
extension
By default, only users with administrative rights can view the CAS Console extension in Oracle Workbench.
However, you can also make this extension visible to non-administrative users.
See the Oracle Commerce Guided Search Administrator's Guide for details on changing the visibility of the CAS
Console extension for different user roles.
Note
If you change a user role in Workbench, you must manually remove the CAS Console extension if you
choose to unregister it.
Related links
• Uninstalling CAS Console if its extension configuration was changed (page 21)
2 Installing the Content Acquisition System
17
18
2 Installing the Content Acquisition System
3
Uninstalling the Content
Acquisition System
This section contains the procedures for uninstalling the Content Acquisition System.
Related links
• Uninstalling CAS on Windows (page 19)
• Uninstalling CAS Console on UNIX (page 20)
• Uninstalling CAS on UNIX (page 20)
• Uninstalling a plug-in from CAS (page 20)
• Uninstalling CAS Console if its extension configuration was changed (page 21)
Uninstalling CAS on Windows
Follow these steps to uninstall the Content Acquisition System from your Windows machine.
The installer creates a timestamped backup of your workspace prior to uninstalling the Content Acquisition
System
To uninstall the Content Acquisition System from a Windows machine:
1. Stop Endeca Tools Service and Endeca CAS Service.
2. From the Windows Control Panel, select Uninstall a program.
3. Select the Oracle Commerce Content Acquisition System from the list of installed software.
4. Click Uninstall.
3 Uninstalling the Content Acquisition System
19
Uninstalling CAS Console on UNIX
Follow this procedure to remove the CAS Console from Oracle Commerce Workbench without uninstalling the
Content Acquisition System.
To remove the CAS Console from Oracle Commerce Workbench:
1. Open a command-line prompt and run the following command:
/endeca/CAS/<version>/bin/configure_tools_and_frameworks_integration.sh -uninstall_console --uninstall_dt_integration
2. If you do not have ENDECA_TOOLS_ROOT and ENDECA_TOOLS_CONF set in the environment, do one of the
following:
• Enter the value for each at the prompt.
• Run the /endeca/CAS/<version>/bin/configure_tools_and_frameworks_integration.sh -uninstall_console script with the flags --endeca_tools_root full path to the Tools root
directory --endeca_tools_conf full path to the Tools /conf directory
3. Restart the Oracle Commerce Workbench Service
Uninstalling CAS on UNIX
Follow these steps to uninstall the Content Acquisition System from a UNIX machine.
Before you begin the uninstall process, back up any files that you want to retain from the CAS directory.
You must uninstall CAS Console for Oracle Commerce Workbench prior to uninstalling the CAS.
To uninstall the CAS from a UNIX machine:
1. Shutdown CAS Service by navigating to /usr/local/endeca/CAS/<version>/bin and running the
following command: cas-service-shutdown.sh.
2. In a command prompt, issue an rm command as in this example:
rm -rf endeca/CAS/<version>
Uninstalling a plug-in from CAS
Follow these steps to uninstall a plug-in from the Content Acquisition System.
Before you begin the uninstall process, back up any plug-in JAR files that you want to retain from the CAS
\version\lib\cas-server-plugins directory.
20
3 Uninstalling the Content Acquisition System
To uninstall a plug-in from the CAS:
1. Stop CAS Service.
2. Navigate to <install path>\CAS\<version>\lib\cas-server-plugins.
3. Delete the plugin-name/ subdirectory for each plug-in.
For example: <install path>\CAS\<version>\lib\cas-server-plugins\JDBCDataSourceExt
4. Repeat the steps above as necessary for multiple plug-ins.
5. Start CAS Service.
Uninstalling CAS Console if its extension configuration
was changed
If you need to uninstall the CAS Console extension for Oracle Oracle Commerce Workbench and you have
manually edited its extension configuration (for example to assign the extension to a role other than "admin"),
you must manually uninstall the CAS Console as an Oracle Commerce Workbench extension.
To manually remove the CAS Console extension to Workbench:
1. Navigate to %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF/conf (on UNIX).
2. In ws-extensions.xml, remove the <extension> element with the id "casconsole".
3. In ws-mainMenu.xml, remove the <menuitem> element with the id "casconsole".
4. Delete casconsole.properties.
5. From %ENDECA_TOOLS_CONF%\conf\Standalone (on Windows) or $ENDECA_TOOLS_CONF/conf/
Standalone (on UNIX), delete casconsole.xml.
6. From %ENDECA_TOOLS_ROOT%\server\webapps (on Windows) or $ENDECA_TOOLS_ROOT/server/
webapps (on UNIX), delete casconsole-version.war.
7. Restart the Oracle Commerce Workbench Service
Related links
• About changing the role used for the CAS Console extension (page 17)
3 Uninstalling the Content Acquisition System
21
22
3 Uninstalling the Content Acquisition System
Download PDF
Similar pages