|Oracle Syndication Server User's and Administrator's Guide
Part Number A88787-01
This chapter describes the basic installation and configuration Oracle Syndication Server.
The installation requires that the person installing this software have sysadmin privileges, is a database administrator, and has application development skills.
After you have completed the installation steps described in this chapter, you will have an understanding of the system requirements needed to install Syndication Server, you will have installed the Syndication Server schema, and you can begin using Syndication Server to syndicate content to subscribers.
To understand how to manage Syndication Server, you must first configure and run the OSSAdmin utility as described in Chapter 3. Then you can manage subscribers, manage affiliates or content providers, manage subscriptions, and do Syndication Server system administration operations, which are all described in Chapter 5.
The primary steps necessary to install and configure Oracle Syndication Server software are as follows:
The following are the system requirements:
Be sure you have a full installation of Oracle9i Standard Edition or Enterprise Edition Release 1 (9.0.1) (a full installation in this case includes a typical Oracle9i Standard Edition or Enterprise Edition Release 1 (9.0.1) installation. Follow Oracle9i installation instructions to complete a full installation.
In Section 2.2 and Section 2.3, directory paths often show only the UNIX path "/" specification. If you are installing on a Windows NT system, the path specification is "\" and you must make this change, as needed, for the installation to be successful.
For release 9.0.1, Oracle Syndication Server is distributed as a zip archive file. Future distributions will be packaged with the Oracle Universal Installer. Unzip the archive file in the syndication directory within your <ORACLE_HOME> directory. The distribution contains the subdirectories shown in Table 2-1.
Contains a collection of SQL scripts.
Dynamic Services Gateway SQL scripts,
Contains the OSSAdmin command-line utility for managing subscribers, affiliates, and subscriptions and system monitoring. Also contains the Syndication Server services configuration script.
Contains the sample Syndication Server client.
Contains the documentation about Dynamic Services including the README.txt file, the Oracle Dynamic Services FAQ file (syndfaq.txt), and the JavaDoc API (syndclientapi.zip), which contains those classes that are necessary for developers to build and run Syndication Server.
Contains the Syndication Server properties file.
Contains a properties file.
Contains the services needed for Syndication Server and the configuration files.
Contains the jar files of the Syndication Server and Syndication Client code and the Syndication Server properties file.
Contains the Dynamic Services Gateway jar (dsgw.jar) file.
Unless otherwise specified, all relative directory paths used in this document start from the
Before you install Oracle Syndication Server, make sure your servlet engine can access your Oracle Dynamic Services library.
The following libraries from Oracle9i Standard Edition or Enterprise Edition Release 1 (9.0.1) are required by Oracle Syndication Server:
/lib/classgen.jar-- Oracle Class Generator
/lib/xmlparserv2.jar-- Oracle XML Parser (version 126.96.36.199 or later)
/jdbc/lib/classes12.zip-- Oracle JDBC Driver (compliant with JDK 1.2 (version 9.0.1))
/ds/lib/ds.jar-- Oracle Dynamic Services Library
/syndication/lib/redist/dsgw.jar-- Oracle Dynamic Services Gateway Library
/syndication/lib/syndserver.jar-- Oracle Syndication Server Library
The first three libraries are installed upon installing the Oracle9i Standard Edition or Enterprise Edition. The
ds.jar library is installed with an Oracle Dynamic Services installation and the
syndserver.jar libraries are installed with the Oracle Syndication Server installation. If you are using Apache Jserv, you must put these libraries into your
jserv.properties file specified as wrapper.classpaths.
Oracle Syndication Server works with any servlet engine behind any Web listener, for example, it works with Apache Jserv installed with Oracle9i Standard Edition or Enterprise Edition Release 1 (9.0.1). The following steps assume you are using the Apache Jserv servlet engine:.
/Apache/Jserv/etcto add a virtual path
syndserverby adding the following lines to the ApJservMount area:
For example, if you are using iAS Apache, modify the
jserv.properties file located in
/Apache/Jserv/etc and add the zone of
syndserver, if your servlet engine permits, for example:
You must also add a property file to the zones as follows:
syndserver.properties, which is located in
The Syndication Server library is located as:
For example, using iAS Apache, the repository is:
Create an alias, for example, "OSS" and point it to the class in the zone's property file as follows:
/Apache/Jserv/jserv.propertiesfile and include the wrapper classpath for the Dynamic Services Gateway jar (
dsgw.jar)file as follows:
/admin/redist/and run the
dsgatewayinstall.sqlfile as user dba. For example,
/admindirectory, then connect as DSGATEWAY/DSGATEWAY and run the SQL script,
By default, running the PL/SQL script
ossinstall.sql under the
/admin directory creates the tables and packages for the database schema
DSGATEWAY for exclusive use by Syndication Server and makes DSGATEWAY the basis of communication for the OSS servlet.
Each Dynamic Services Gateway Context defines the properties for establishing an Oracle Dynamic Services Connection for the purposes of services execution. You must create one for Syndication Server.
/admindirectory by entering your database tnsname for
thindriver for where your Dynamic Services (DS) engine is installed. For example:
ossinit.sqlscript as user
DSGATEWAY/<DSGATEWAY-password> to create the new gateway context for Oracle Syndication Server.
There is a list of parameters that must be added to the Aliased Servlet Init Parameters section that the servlet picks up to configure a database connection to the Gateway Context that was created in Step 6.
The parameters are:
<gwctx-db-url> is either jdbc:oracle:oci8:@
<your-TNS-NAME-ENTRY> or jdbc:oracle:thin:@
<gwctx-db-username> is the user DSGATEWAY,
<gwctx-db-password> is the password for user DSGATEWAY,
<gwctx-db-pool> is the gateway context connection pool parameter value, and
<gwctx-push-gateway-context-id> is the gateway context entry you created in Step 6,
For example, if you are using the Apache Web server, restart Apache.
To restart Apache on UNIX systems, execute the commands shown as follows:
On Windows NT, restart the Apache server from the Start bar. For Oracle9i 9.0.1, start from your Oracle home, select Oracle HTTP Server, then Start HTTP Server powered by Apache.
You should see on the resulting page that your Syndication Server is up and running.
For example, if you are using the Apache Web server, inspect the contents of the
error_log file in the
/Apache/Apache/logs directory as well as the contents of the
mod_jserv.log files in the
Oracle Syndication Server has an extensibility layer for the content providers that feed into it. This is achieved through the Oracle Dynamic Services integration. Packaged with the default installation of Oracle Syndication Server, are three sample content providers that communicate with Oracle Syndication Server through the Oracle Dynamic Services framework.
The first sample content provider "eShop" is a demonstration of how a set of database-based Oracle Dynamic Services services can be used to provide content to Oracle Syndication Server.
The second sample content provider "File" is a demonstration of how a set of file-based Oracle Dynamic Services services can be used to provide content to Oracle Syndication Server.
The third sample content provider "Web" is a demonstration of how a set of Web-based Oracle Dynamic Services services can be used to provide content to Oracle Syndication Server.
These three sample content providers have been provided with the package, and can be registered and readily used, provided the appropriate properties are configured for your installation as follows:
Naturally, for the database-based Oracle Dynamic Services set of services to function, there must be a schema sitting somewhere in some database instance containing the information for which the service is asking. This is done by running the
eShop_init.sql script in any schema (user) on any database instance that you have running. For example, you can use the
scott sample schema. Read the SQL script before running it and make sure that there are no table name conflicts. For future reference, remember which schema or database on which this schema is installed because you will need this information during configuration of the services in Step 3.
Refer to Chapter 10 Managing Job Queues in Oracle9i Database Administrator's Guide to make sure that you have enabled processes for executing jobs. The two issues to be concerned about are:
Because both of these initialization parameters are dynamic, any changes you make will take effect immediately without having to stop and restart the database instance.
install.dss,which is located in
To add the categories and register the services needed for the three sample content providers, you must run the Dynamic Services DSAdmin utility script
Change the directory to the Oracle Syndication Server home directory at
<SYNDICATION_HOME> and execute the following command on UNIX:
Or, execute the following command on Windows NT:
<DS_PASSWORD> are the Oracle Dynamic Services username/password pair that is needed to connect to an Oracle Dynamic Services engine when running the DSAdmin utility.
<DS_NICKNAME> is comparable to a TNS_NAME_ENTRY for Oracle Dynamic Services (see Oracle Dynamic Services User's and Administrator's Guide for more information on how to run the DSAdmin utility).
Usually, this task should be delegated to an Oracle Dynamic Services Administrator (which may be synonymous to the Oracle Syndication Server Administrator). After this step, the services necessary for the three sample content providers are installed.
To configure the services for these sample content providers to make them usable, you must edit a configuration file before proceeding.
Or, on Windows NT:
The fields you must modify in this file are (using the XPath (XML Path Language) convention):
The DSUser DSSYS, is the Oracle Dynamic Services consumer name that you want to have all Oracle Dynamic Services connections using. This should correspond to the Oracle Dynamic Services user name specified in your gateway context (see the contents of the
ossinit.sql file in Step 6 in Section 2.3 to check for the presence of the DSSYS DSUser name).
This is the database URL to connect to for the database-based Oracle Dynamic Services service "eShop". Refer to Step 1 in this section for this information.
The database user name to connect to the URL mentioned previously is:
The database password to connect to the URL mentioned previously is:
This is the path to start traversing from for all File "Catalog" listings.
There is no //OSSConfig/Services/Web section. This is because the Web content provider does not need to be configured.
After you have made all necessary modifications to this file, save it.
configure.bat(Windows NT) file with the input file,
config_sample.xml. For example, on UNIX:
Or, on Windows NT:
Running this configuration file and its associated input file adds the necessary properties to the Oracle Dynamic Services user that your installation of Oracle Syndication Server uses.
If you are running this script for the first time, you will see some error messages, such as "object not found". You can ignore these error messages.
You are now ready to start syndicating content to your subscribers using Oracle Syndication Server by using the sample content providers to help you get started.
After the installation is complete, you can begin using Syndication Server to syndicate content to subscribers. To understand how to manage Syndication Server, you must first configure and run the OSSAdmin utility as described in Chapter 3. Then you can manage subscribers, manage affiliates, manage subscriptions, and do Syndication Server system administration operations. In addition, you can also begin to develop your own content provider adaptors, which is described in Chapter 4.