Oracle® Fusion Middleware

WebCenter Sites Property Files Reference

11g Release 1 (11.1.1.8.0)

E35342-02

October 2013

Oracle Fusion Middleware WebCenter Sites Property Files Reference, 11g Release 1 (11.1.1.8.0)

E35342-02

Copyright © 2012, 2013 Oracle and/or its affiliates. All rights reserved.

Primary Author:  Tatiana Kolubayev

Contributing Author:  Melinda Rubenau

Contributor:  Kannan Appachi, Hareesh Kadlabalu, Ravi Khanuja, Vipin Kumar, Yogesh Khubchandani, Cory Lum

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 RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

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 on 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. 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.

Contents

Preface

- Audience

- Documentation Accessibility

- How This Guide Is Organized

- Related Documents

- Conventions

What's New in This Guide

- New Properties for Oracle WebCenter Sites Version 11g Release 1 (11.1.1.8.0)

- Deprecation Notice

1 Introduction

- 1.1 Overview of the Property Editor

- 1.2 Starting the Property Editor

- 1.3 Setting Properties

- 1.4 Adding Properties

- 1.5 Deleting Properties

Part I Oracle WebCenter Sites

2 assetframework.ini

- 2.1 User Defined Tab

3 batch.ini

- 3.1 Configuration Tab

- 3.2 Debug Tab

- 3.3 Results Tab

- 3.4 Security Tab

- 3.5 User Defined Tab

4 catalog.ini

- 4.1 Catalog Tab

- 4.2 User Defined Tab

5 commons-logging.properties

- 5.1 AsyncLog Tab

- 5.2 Factory Tab

- 5.3 Loggers Tab

- 5.4 Traditional Log Tab

- 5.5 User Defined Tab

6 CSPortletRequest.properties

- 6.1 User Defined Tab

7 dir.ini

- 7.1 Attribute Names Tab

- 7.2 Compatibility Tab

- 7.3 Global Data Tab

- 7.4 Interface Implementations Tab

- 7.5 JNDI SPI Env Tab

- 7.6 Naming Syntax Tab

- 7.7 Schema Defaults Tab

- 7.8 Search Controls Tab

- 7.9 User Defined Tab

8 fatwire_settings.properties

- 8.1 User Defined Tab

9 futuretense.ini

- 9.1 App Server Tab

- 9.2 Authentication Tab

- 9.3 Basic Tab

- 9.4 Blob Server Tab

- 9.5 Cluster Tab

- 9.6 Compatibility Tab

- 9.7 Content Tables Tab

- 9.8 Database Tab

- 9.9 Debug Tab

- 9.10 Email Tab

- 9.11 Export/Mirror Tab

- 9.12 JSP Tab

- 9.13 Misc Tab

- 9.14 Page Cache Tab

- 9.15 ResultSet Cache Tab

- 9.16 Satellite Server Tab

- 9.17 Search Tab

- 9.18 User Defined Tab

10 futuretense_xcel.ini

- 10.1 Analytics Tab

- 10.2 Asset Default Tab

- 10.3 Authorization Tab

- 10.4 CoS Tab

- 10.5 Debug Tab

- 10.6 Directories Tab

- 10.7 Element Override Tab

- 10.8 Preference Tab

- 10.9 Publishing Tab

- 10.10 Transformer Tab

- 10.11 xcelerate Tab

- 10.12 User Management Tab

- 10.13 User Defined Tab

11 gator.ini

- 11.1 Gator Tab

- 11.2 User Defined Tab

12 log4j.properties

13 logging.ini (Deprecated)

- 13.1 Global Data Tab

- 13.2 Message Resources Tab

- 13.3 User Defined Tab

14 omii.ini

- 14.1 omproduct.ini

15 satellite.properties

- 15.1 Caching Tab

- 15.2 Configuration Tab

- 15.3 Remote Host Tab

- 15.4 Sessions Tab

- 15.5 Compatibility Tab

- 15.6 User Defined Tab

16 ServletRequest.properties

- 16.1 Request Encoding Tab

- 16.2 Request Threshold Tab

- 16.3 URI Assembler Tab

- 16.4 User Defined Tab

17 visitor.ini

- 17.1 Visitor Data Tab

- 17.2 User Defined Tab

Part II Oracle WebCenter Sites Applications

18 Oracle WebCenter Sites: Analytics, Engage, and Satellite Server Properties

- 18.1 Oracle WebCenter Sites: Analytics Properties

- 18.2 Oracle WebCenter Sites: Engage Properties

- 18.2.1 ms.ini

- 18.3 Oracle WebCenter Sites: Satellite Server Property Files

Part III Third-Party Libraries and Applications

19 HTTP Client Access

- 19.1 Apache Commons HttpClient

- 19.2 Integration with WebCenter Sites

- 19.2.1 Implementation

- 19.3 HTTPClient Parameters and WebCenter Sites Properties

Index

Preface

This guide contains information about Oracle WebCenter Sites property files and their properties. They are used to specify operating parameters for Oracle WebCenter Sites and its applications.

Audience

This guide is written for WebCenter Sites installation engineers, developers, and administrators of WebCenter Sites systems.

Documentation Accessibility

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 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.

How This Guide Is Organized

The introductory section explains the importance of using the Property Editor to modify property files and provides instructions on using the Property Editor.

Part I, "Oracle WebCenter Sites" covers properties for WebCenter Sites and its page caching application Satellite Server.

Part II, "Oracle WebCenter Sites Applications" covers the property files of the WebCenter Sites: Engage application and remotely installed Satellite Server.

Part III, "Third-Party Libraries and Applications" explains how WebCenter Sites integrates with third-party libraries.

At the end of this reference is an index to help readers find topics and properties in this guide.

Related Documents

For more information, see the following documents in the Oracle WebCenter Sites 11gR1 (11.1.1.8.0) documentation set:

- Oracle WebCenter Sites Certification Matrix

- Oracle WebCenter Sites Release Notes

- Oracle Fusion Middleware WebCenter Sites Developer's Guide

- Oracle Fusion Middleware WebCenter Sites Administrator's Guide

- Oracle Fusion Middleware WebCenter Sites User's Guide

- Oracle WebCenter Sites Tag Reference

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Monospace bold

Monospace bold type indicates a command.

What's New in This Guide

This preface introduces the new properties that have been added to Oracle WebCenter Sites for version 11g Release 1 (11.1.1.8.0), and provides pointers to additional information.

New Properties for Oracle WebCenter Sites Version 11g Release 1 (11.1.1.8.0)

The following changes have been made to the futuretense_xcel.ini file for Oracle WebCenter Sites version 11g Release 1 (11.1.1.8.0):

- Added the CoS tab to the futuretense_xcel.ini file which holds the properties for the Oracle WebCenter Sites: Community-Gadgets integration with Oracle WebCenter Sites. The properties contained within the CoS tab are:

- cg.management.url

- cg.production.url

- cos.hostname

- cos.portnumber

- fwblogs.cos.enabled

For information about the properties in the CoS tab, see Table 10-4 in Section 10.4.

- Added the following Community-Gadgets related properties to the User Defined tab for the futuretense_xcel.ini file:

- cos.protocol

- cos.contextroot

For more information about the new properties in the User Defined tab, see Table 10-13 in Section 10.13.

- If the Oracle Real-Time Decisions (RTD) engine is integrated with Oracle WebCenter Sites, the following properties must be added to the futuretense.ini file's User Defined tab:

- rtd.choiceId.pattern

- rtd.host

- rtd.inline.service.name

For information about these properties, see Table 9-17 in Section 9.18.

Deprecation Notice

The following features are deprecated in WebCenter Sites 11g Release 1 (11.1.1.8.0):

- SOAP-based web services. This feature is replaced by REST services.

- Mirror publishing. This feature is replaced by RealTime publishing.

- Static publishing

- Page debugging

- Oracle WebCenter Sites Desktop

- Oracle WebCenter Sites DocLink

1 Introduction

Many of your configuration tasks for Oracle WebCenter Sites and its applications require you to set or modify values for properties that are specified in property files. These files have either the .ini or .properties suffix.

A set of property files, along with the "Property Editor" utility, is provided with WebCenter Sites. At least one property file is associated with each component of WebCenter Sites, such as WebCenter Sites: Analytics, WebCenter Sites: Engage, and WebCenter Sites: Satellite Server.

This introduction describes the Property Editor and summarizes the property files that are presented in the rest of this reference.

This introduction contains the following sections:

- Section 1.1, "Overview of the Property Editor"

- Section 1.2, "Starting the Property Editor"

- Section 1.3, "Setting Properties"

- Section 1.4, "Adding Properties"

- Section 1.5, "Deleting Properties"

1.1 Overview of the Property Editor

The Property Editor is used to set the values of properties in the Oracle WebCenter Sites property files. We recommend that you always use the Property Editor to set values, because using other editors can create problems. For example, the JumpStart Kit renames property files; launching the Property Editor ensures that the correct file will be displayed for modification. The Property Editor is also capable of encrypting password fields; modifying the fields outside the Property Editor can corrupt the property values. In addition, the Property Editor ensures that the files are correctly formatted; specifically, the correct property separator characters are used. Furthermore, the Property Editor organizes properties by function on tabs, and provides descriptive information about the properties, as well as default or possible values.

1.2 Starting the Property Editor

Execute the following scripts at the command line prompt or in a UNIX shell:

- Windows: propeditor.bat, typically located in <cs_install_dir>/

- Solaris: propeditor.sh, typically located in $HOME/<cs_install_dir>

1.3 Setting Properties

To set properties for WebCenter Sites and its applications

1. Start the Property Editor, as described in Section 1.2, "Starting the Property Editor"

2. Select File and then select Open.

3. Browse to the property file that you need to modify and then select it.
The Property Editor opens the file. For example, this is what the futuretense.ini file looks like when it is first opened in the Property Editor:

- The tabs (on the left-hand side) group properties by function.

- The Items pane lists the properties in the selected tab.

- The Value pane lists the current value for the selected property, a brief description of the property, and acceptable values for the property.

4. Select the tab representing the functional group that contains the property you want to configure.

The Property Editor displays the properties from that tab in the Items pane.

5. Select the property from the Items pane.
The Property Editor displays the value that is currently set for that property and provides a brief description of the property in the Values pane.

6. In the Values pane, enter the value for the property in the text field at the top.

7. Click Accept.

8. Repeat steps 4 through 7 for each property you want to configure.

9. When you are finished, select File and then select Save.

10. Select File and then select Close.

11. Stop and restart the application server so the new values can take effect.

1.4 Adding Properties

Some configuration tasks require you to add new, custom properties for your system. For example, when you implement resultset caching, you can create up to three properties for any WebCenter Sites database table for which you want to set caching values. (For information about resultset caching, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.)

To add a property to the WebCenter Sites database

1. Start the Property Editor, as described in Section 1.2, "Starting the Property Editor."

2. Select File > Open.

3. Browse to the property file in which you need to add a property.

4. (Optional) Select the User Defined tab. (This step is optional because any property that you create is displayed on the User Defined tab the next time you open this property file in the Property Editor no matter which tab you select.)

5. In the Values pane, just under the text entry field, click New.

The Property Editor displays the WebCenter Sites Properties dialog box:

6. Click in the Name field and enter the name of the new property.

7. Click in the Value field and enter the value for the new property.

8. Click OK.
The new property appears in the Items pane and the value appears in the Values pane.

Note:

If you did not select the User Defined tab in step 4, the new property might appear on the tab that was selected when you clicked New in step 5. This is temporary. The next time that you open this ini file in the Property Editor, the property is displayed on the User Defined tab.

9. Select File > Save.

1.5 Deleting Properties

It is unlikely that you will ever have to delete a property. However, if you do have to delete a property, refer to the steps below.

To delete a property

Caution:

Never delete a required property.

1. Start the Property Editor. (See Section 1.2, "Starting the Property Editor.")

2. Select File and then select Open.

3. Browse to and select the property file containing the property you want to delete.

4. Select the tab representing the functional group that holds the property you want to delete.

5. Take note of the current value for this property just in case you need to restore it for any reason.

6. In the Values pane, under the text entry field, click Delete.

7. The Property Editor displays a confirmation message. Click Yes.
The property is deleted from the property file.

8. Select File and then select Save.

Part I

Oracle WebCenter Sites

Part I lists the property files that are installed and used by WebCenter Sites, including its user manager plug-ins and co-resident Satellite Server. The Property Editor is used to set properties in WebCenter Sites property files.

This part contains information about the following property files:

- assetframework.ini

- batch.ini

- catalog.ini

- commons-logging.properties

- CSPortletRequest.properties

- dir.ini

- futuretense.ini

- futuretense_xcel.ini

- gator.ini

- logging.ini (Deprecated)

- log4j.properties

- omii.ini

- omproduct.ini

- satellite.properties

- ServletRequest.properties

- visitor.ini

2 assetframework.ini

The assetframework.ini file holds properties that determine the storage locations of files that hold information about flex asset history and publishing.

This file has a single tab, named "User Defined," in the Property Editor.

2.1 User Defined Tab

Table 2-1 Properties assetframework.ini: User Defined Tab

Property

Description

afk.historydata

Specifies the directory that holds history data.

Default value: c:/futuretense/history/

afk.publishdata

Specifies the directory that holds publish data.

Default value: c:/futuretense/publish/

3 batch.ini

The batch.ini file provides configuration information for batch processes, which are used in the background by WebCenter Sites for various reasons (publishing, for example).

Properties in batch.ini are organized by function on the following tabs in the Property Editor:

- Configuration Tab

- Debug Tab

- Results Tab

- Security Tab

- User Defined Tab

3.1 Configuration Tab

The Configuration tab holds properties that are used to configure settings for the threads that are used by the batch processes.

Table 3-1 Properties in batch.ini: Configuration Tab

Property

Description

thread.count

Specifies the number of dispatcher threads to allocate and manage in the pool.

Default value: 32

thread.growcache

Specifies whether additional dispatcher threads (in excess of the number specified by thread.count) can be allocated to the pool if they are needed.

Possible values: true | false

Default value: false

thread.idle

Applies only when thread.growcache is set to true.

Specifies the number of seconds a dispatcher thread can remain idle before it is released by the pool.

Default value: 10

thread.wait

Applies only when thread.growcache is set to false.

Specifies the number of seconds that a batch process waits for a free dispatcher thread before it reports an error because it cannot complete its task.

Default value: 15

3.2 Debug Tab

Table 3-2 Properties in batch.ini: Debug Tab

Property

Description

debug

Specifies whether debugging for batch processes is enabled or disabled. If you set this value to true, messages about the status of batch processes are written to the WebCenter Sites log file.

Default value: false

3.3 Results Tab

Table 3-3 Properties in batch.ini: Results Tab

Property

Description

request.folder

Specifies the location of the file that stores information about the results of batch processes. For example, the WebCenter Sites publishing system uses this directory to hold the publishing log files.

Default value: /dispatcher/

3.4 Security Tab

Table 3-4 Properties in batch.ini Security Tab

Property

Description

security.class

Specifies the name of the class file that is used for security checks. The default is provided for reference only:

com.openmarket.Batch.DefaultSecurity

Do not change the value of this property

3.5 User Defined Tab

Table 3-5 Properties in batch.ini: User Defined Tab

Property

Description

This tab, by default, holds no properties.

N/A

4 catalog.ini

The catalog.ini file holds properties that WebCenter Sites uses to configure the shopping cart.

Properties in catalog.ini are organized by function on the following tabs in the Property Editor:

- Catalog Tab

- User Defined Tab

4.1 Catalog Tab

Table 4-1 Properties in catalog.ini: Catalog Tab

Property

Description

mwb.cartsetdir

Specifies the directory path (including the terminating slash character) where cartset data files are stored.

This value is set by the installation. It points to the /gator/cartset directory in the installation directory.

Do not change the value of this property.

4.2 User Defined Tab

Table 4-2 Properties in batch.ini: User Defined Tab

Property

Description

This tab, by default, holds no properties.

N/A

5 commons-logging.properties

The commons-logging.properties file is used to specify the WebCenter Sites logging system via the org.apache.commons.logging.Log property. Newly installed WebCenter Sites systems use Apache log4j, which is specified as follows:

org.apache.commons.logging.Log=com.fatwire.cs.core.logging.Log4JLogger

More information about Apache log4j is available in Chapter 12, "log4j.properties."

A large variety of other loggers are available in the public domain. You can also write your own loggers if the features sought are not present in any available loggers. If you choose to use Commons Logging with loggers other than log4j, you can still use the Property Editor to view and change log settings.

If the need arises to switch back to the previous Content Server 7.6 Commons Logging system, you will have to manually set org.apache.commons.logging.Log to one of the class names listed below:

- TraditionalLog
com.fatwire.cs.core.logging.TraditionalLog

This logger writes all log messages to the WebCenter Sites log file for each server. TraditionalLog supports log file rolling, custom formatting, date-stamping, and a variety of other features. Optionally, TraditionalLog supports browser-based log retrieval by filtering log messages based on the client's IP address.

- StandardLog
com.fatwire.cs.core.logging.StandardLog

This logger also supports custom formatting, date-stamping, and so on, but it sends messages to the standard output and standard error streams; in other words, it sends messages to the java console instead of the WebCenter Sites log file. While StandardLog does not support browser-based log retrieval, it offers another useful feature: It allows developers running a JumpStart Kit or running WebCenter Sites in an IDE debugger to see all of the log messages in the most obvious place. Using StandardLog is good practice for all template developers, because it alerts you to errors by default, as opposed to sending an error to the WebCenter Sites log file, where it requires some effort to be viewed. StandardLog is similar to Apache's default SimpleLog.

- StandardTraditionalLog com.fatwire.cs.core.logging.StandardTraditionalLog
This logger supports the features and output methods of TraditionalLog and StandardLog.

The commons-logging.properties file lists the logging properties that can be modified for WebCenter Sites. The properties are organized by function on the following tabs in the Property Editor:

- Factory Tab

- Loggers Tab

- Traditional Log Tab

- User Defined Tab

5.1 AsyncLog Tab

Properties on this tab are deprecated.

Table 5-1 Properties in commons-logging.properties: AsyncLog Tab

Property

Description

logging.interval

Deprecated.

Specifies the time interval (in milliseconds) between writes to the log file.

Default value: 5000

5.2 Factory Tab

Table 5-2 Properties in commons-logging.properties: Factory Tab

Property

Description

org.apache.commons.logging.Log

Specifies the class name implementing the org.apache.commons.logging.Log interface that the default commons-logging log factory will use as the logger.

Default value: com.fatwire.cs.core.loggingTraditionalLog

The default value names a WebCenter Sites enhanced logger that supports additional features not necessarily supported by other loggers, including browser-based retrieval of the log file, rolling logs, and timestamps.

Note: Before modifying the value, consult the commons-logging documentation.

org.apache.commons.logging.LogFactory

Enables a special publishing logger that prints the pubsessionid in each log message when a publishing event is in progress. Use this logger to analyze publishing failures.

This property must be manually added to commons-logging.properties.

Legal values: com.fatwire.cs.core.logging.ContextAwareLogFactory

Note: Enabling this logger automatically disables per-client logging (the value of the logging.per-client-log property is ignored).

5.3 Loggers Tab

Table 5-3 Properties in commons-logging.properties: Loggers Tab

Property

Description

com.fatwire.logging.cs

Specifies the log severity for the generic WebCenter Sites logger. Messages written to this logger relate to the core WebCenter Sites functionality, or they have not been assigned a more appropriate logger.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.auth

Specifies the log severity for user authentication and user authorization messages. Messages written to this logger relate to user login, user ACLs and user roles.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.blobserver

Specifies the log severity for BlobServer debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites page caches.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.cache.page

Specifies the log severity for page cache debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites page caches.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.cache.resultset

Specifies the log severity for resultset cache debug messages. Messages written to this logger relate to the addition, retrieval, and modification of data in WebCenter Sites resultset caches.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.core.http.HttpAccess

Logger used by the HttpAccess API to record errors and warnings encountered during HTTP access. This log produces HTTP Request and Response information, including headers, parameters, and body content. DEBUG generally produces large amounts of log messages.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.core.uri.assembler

Logger used by the URI assembler engine and all assemblers.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.core.uri.definition

Logger used by URI definitions and related implementations.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.db

Specifies the log severity for database access messages. Messages written to this logger relate to database access, queries and statement execution. It can be very helpful to use this logger to debug database queries that are not behaving as expected.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.errno

Logger used to display information related to setting an error number. Messages written by this logger relate to the values set for the Variables.errno and Variables.errdetail WebCenter Sites variables. For more information about setting error numbers, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide and the Oracle WebCenter Sites Tag Reference.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.event

Specifies the log severity for WebCenter Sites event engine messages. Messages written to this logger relate to the invocation of events by WebCenter Sites.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.export

Specifies the log severity for WebCenter Sites page export engine messages. Messages written to this logger relate to the invocation of events by WebCenter Sites.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.filelock

Specifies the log severity for file locking messages.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.firstsite.filter

Logger for FirstSite II filters.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.install

Specifies the log severity for the WebCenter Sites installer's messages. Messages are only written to this log during installation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.jsp

Specifies the log severity for WebCenter Sites jsp element debug information. Messages written to this logger relate to the invocation of JSP elements by WebCenter Sites.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.realtime

Logs operations that take place during the RealTime publishing process.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.request

Specifies the log severity for request processing messages.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.satellite

Generic logger for Satellite Server. Messages logged with this logger pertain to system configuration.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.satellite.cache

This logger for Satellite Server deals with information relating to the parsing of objects that can be cached, as well as their life cycle in the cache.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.satellite.host

This logger for Satellite Server is dedicated to logging information that relates to communication between Satellite Server and its host WebCenter Sites.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.satellite.request

This logger for Satellite Server is dedicated to logging information that relates to processing requests from the client.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.session

Specifies the log severity for the WebCenter Sites session logger. Messages written to this logger relate to session creation, modification, and access.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.sync

Specifies the log severity for WebCenter Sites cluster synchronization messages. Messages written to this logger relate to cluster sync behavior of WebCenter Sites.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.sysinfo

Specifies the log severity for capturing system information on the WebCenter Sites installation. This logger is used by the System Tools utility, which is available on the Admin tab, in the WebCenter Sites administrator's interface. For more information about System Tools, see "System Tools" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.time

Specifies the log severity for WebCenter Sites time and performance debug information. Messages written to this logger include information that can be used to tune the performance of pages and of WebCenter Sites in general.

To log the execution time for pages and pagelets, set this property to DEBUG. When the pages and pagelets are executed, a message similar to the following will be returned:

"Execute page OpenMarket/Xcelerate/Util/getCurrentUser Hours: 0 Minutes: 0 Seconds: 0:002"

Note: Pages are executed only if they are not found in cache.

Possible value: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.visitor.object

Logger for tracking the visitor object life cycle.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.visitor.ruleset

Logger for rule set compilation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate

Logger for Xcelerate.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate.advantage.recommendation

Logger for recommendation processing.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate.approval

Logger for asset approval processing.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate.asset

Logger for generic asset processing.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate.assetmaker

Logger for assetmaker processing.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xcelerate.publish

This logger captures publishing logs.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

Note: DEBUG and TRACE settings produce a large quantity of logs and can severely impact performance.

com.fatwire.logging.cs.xcelerate.template

Logger for Template, CSElement, and SiteEntry asset processing.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.cs.xml

Specifies the log severity for WebCenter Sites XML element debug information. Messages written to this logger relate to the parsing and evaluation of XML elements. It should be noted that enabling this debug flag will cause WebCenter Sites to use a validating XML parser instead of the default non-validating parser. This can have effects on rendered pages. Consult the documentation for details.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.search.asset

Logger used by asset-related search.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http

Top-level logger used by HttpComponents library. For more information, see Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http.client

This logger is used by the HttpComponents library for context logging. For more information, see Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http.impl.client

This logger is used by the HttpComponents library for context logging. For more information, see the Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http.impl.conn

This logger is used by the HttpComponents library for connection management. For more information, see the Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http.headers

This logger is used to log only the http headers. For more information, see the Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

org.apache.http.wire

This logger is used to log all data transmitted to and from servers when executing HTTP requests. This logger should be enabled only for debugging, as it will produce an extremely large amount of log data, some of it in binary format. For more information, see the Apache HttpComponents documentation.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

5.4 Traditional Log Tab

The table below lists properties that are specific to TraditionalLog, the default logger specified in the property org.apache.commons.logging.Log. TraditionalLog supports numerous features that other loggers might not support. In your Spark installation, you may choose to use a different logger with your own set of properties.

Table 5-4 Properties in commons-logging.properties: Traditional Log Tab

Property

Description

logging.file

Specifies the full path to the log file. It is required and should be set to a different value for each VM to avoid conflicts.

Note: This value must be specified or logging will fail.

logging.format

Specifies the java.text.SimpleDateFormat that will be used in timestamps that are written to the log file. Consult the API documentation for java.text.SimpleDateFormat for syntax information. If not specified, the default SimpleDateFormat will be used.

logging.maxlogsize

Specifies the maximum size of the log file in bytes. Once the log file grows to the size specified, it will either be rolled or deleted. Set it to -1 to allow the log to grow indefinitely.

Default value: 10MB

logging.per-client-log

Specifies whether a log file will be kept for each distinct IP address that requests data from WebCenter Sites. This property allows the use of CatalogManager to retrieve the log file from a web browser.

When this property is set to true, WebCenter Sites creates a log file for each browser IP address. Each file is stored in the same directory as the WebCenter Sites log file and is created according to the following naming convention: futuretense.IPaddress.txt. You can then use the exportlog argument of the CATALOGMANAGER tag to retrieve the log file for the IP address of the browser that you are using.

Possible values: true | false

Note: Per-client logging is automatically disabled if the ContextAwareLogFactory publishing logger is enabled (i.e., the value of logging.per-client-log is ignored when org.apache.commons.logging.LogFactory is set to enable the ContextAwareLogFactory).

logging.roll

Specifies how many logs will be kept when rolling the log file. Previous versions will be renamed and once all available versions are used, the oldest log will be deleted. Set to 0 to disable rolling of the log file. Set it to a positive integer to specify the number of logs to keep.

Default value: 0

logging.timestamp

Specifies whether or not the timestamp will be written to the log file for each logging entry.

Possible values: true | false

Default value: true

5.5 User Defined Tab

By default, this tab contains the following properties:

Table 5-5 Properties in commons-logging.properties: User Defined Tab

Property

Description

com.fatwire.logging.ui.model

This logger is used by the user interface model components.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.ui.phase

This logger is used by DebugPhaseListener to display the phase of the JSF life cycle.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

com.fatwire.logging.ui.view

This logger is used by the user interface view components. The intended use of this logger is in debugging user interface components and their life cycle.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR and FATAL

Default value: INFO

com.fatwire.search.lucene

This logger is used by the Lucene integration.

Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: INFO

6 CSPortletRequest.properties

The CSPortletRequest.properties file holds portal configuration properties that are set by the WebCenter Sites installation program.

The following tab is displayed (in the Property Editor) for the CSPortletRequest.properties file:

- User Defined Tab

Caution:

Do not change the values of any properties on this tab.

6.1 User Defined Tab

Table 6-1 Properties in CSPortletRequest.properties: User Defined Tab

Property

Value

cs.contenttype.UTF-8

text/html; charset=UTF-8

cs.charset

_charset_

cs.contenttype

text/html; charset=UTF-8

cs.disksize

102400

7 dir.ini

The dir.ini file contains properties that are used to configure the directory services options described below.

The dir.ini file is the main configuration file for the WebCenter Sites Directory Services API. WebCenter Sites uses this API to connect to directory servers for authentication/authorization services and to provide the following options for managing user information (one of the options is configured for your WebCenter Sites system):

- The WebCenter Sites directory services plug-in, which uses the native WebCenter Sites user management tables (SystemUsers and SystemUserAttrs).

- LDAP plug-ins, which uses the directory server rather than the WebCenter Sites database to store user names and attributes.

Properties in dir.ini are organized by function on the following tabs in the Property Editor:

- Attribute Names Tab

- Compatibility Tab

- Global Data Tab

- Interface Implementations Tab

- JNDI SPI Env Tab

- Naming Syntax Tab

- Schema Defaults Tab

- Search Controls Tab

- User Defined Tab

Note:

Although the dir.ini file is the main configuration file for the directory services API, there are additional user manager/directory services properties in another property file, futuretense.ini. See Section 9.2, "Authentication Tab."

7.1 Attribute Names Tab

The Attribute Names tab holds attribute-mapping properties. You use these properties to specify how a user attribute used by WebCenter Sites is identified in the directory server.

Table 7-1 Properties in dir.ini: Attribute Names Tab

Property

Description

cn

Specifies the name of the attribute in the directory server that serves as the group name attribute.

Possible values:

- WebCenter Sites and NT: cn

- LDAP, iPlanet: cn

- LDAP, Active Directory: cn

loginattribute

Specifies the name of the attribute in the directory server that serves as the user login attribute.

Default value: uid

password

Specifies the name of the attribute in the directory server that serves as the password attribute.

Possible values:

- WebCenter Sites and NT: password

- LDAP, iPlanet: userPassword

- LDAP, Active Directory: password

uniquemember

Specifies the name of the attribute in the directory server that serves as the group assignment attribute.

Possible values:

- WebCenter Sites and NT: uniquemember

- LDAP, iPlanet: uniquemember

- LDAP, Active Directory: member

username

Specifies the name of the attribute in the directory server that serves as the user name attribute.

Possible values:

- WebCenter Sites and NT: username

- LDAP, iPlanet: uid

- LDAP, Active Directory: sAMAccount

memberof

Specifies the name of the user attribute that contains information about the user's groups.

If a user's membership in a group is specified by the uniquemember attribute on the group, leave this property blank.

If the group membership of a user is specified by an attribute of the user, specify the name of that attribute here.

Possible values:

- LDAP, WebLogic embedded LDAP: wlsmemberof

- LDAP, SunONE Identity Server: memberof

7.2 Compatibility Tab

The Compatibility tab holds properties that determine how any strings that are extracted from the directory server and stored in the WebCenter Sites database are treated.

Table 7-2 Properties in dir.ini: Compatibility Tab

Property

Description

cleandns

Specifies how the strings for distinguished names are stored in the WebCenter Sites database.

If set to true, the Directory Services API extracts distinguished names from the directory server, and then removes extra spaces from them and then changes all the upper-case letters to lower-case letters before storing the strings in the WebCenter Sites database.

Possible values: true | false

Default value: false

Note: Do not set this value to true if you are upgrading from an earlier version of WebCenter Sites. If you do, you must manually change any existing dns strings that are stored in the WebCenter Sites tables. Also, if you set it to true, you must also verify that the syntax.ignorecase property is also set to true.

7.3 Global Data Tab

The Global Data tab holds properties that determine global values for all users.

Table 7-3 Properties in dir.ini: Global Data Tab

Property

Description

baseDN

Specifies the distinguished name for the root to use by default for searches and for prepending to the names for attribute values that require a DN type.

Default value: blank

Do not change the value of this property. Because the authentication module sets the currentUser session variable to a fully qualified name, WebCenter Sites assumes that all names returned from the search are fully qualified.

groupparent

Specifies the entry to use as the parent of all WebCenter Sites entries of type Group.

Possible values:

- WebCenter Sites and NT: ou=groups

- LDAP, iPlanet: ou=groups,dc=<companyname>,dc=com

- LDAP, Active Directory: cn=groups,dc=<companyname>,dc=com

peopleparent

Specifies the entry to use as the parent of all WebCenter Sites entries of type User.

Possible values:

- WebCenter Sites and NT: ou=people

- LDAP, iPlanet: cn=people,dc=<companyname>,dc=com

- LDAP, Active Directory: cn=users,dc=<companyname>,dc=com

7.4 Interface Implementations Tab

The Interface Implementations tab holds two properties that determine which user manager module your WebCenter Sites system is using. The properties are className.IDir and className.IName. The values of the properties on the Interface Implementations tab should not be modified unless you are integrating with LDAP.

Table 7-4 Properties in dir.ini: Interface Implementations Tab

Property

Description

className.Attribute

Specifies the name of the concrete class to implement the interface Attribute.

Do not change the value of this property unless you are integrating with LDAP.

className.Attributes

Specifies the name of the concrete class to implement the interface Attributes.

Do not change the value of this property unless you integrate with LDAP.

className.IDir

With the className.IName property, specifies which user manager module your system is using.

Possible values:

- WebCenter Sites: com.openmarket.directory.cs.CSDir

- LDAP: com.openmarket.directory.jndi.JNDIDir

Do not change the value of this property unless you are integrating with LDAP.

className.IFactory

Specifies the name of the concrete class to implement the interface Ifactory.

Do not change the value of this property unless you are integrating with LDAP.

className.IName

With the className.IDir property, specifies which user manager module your system is using.

Possible values:

- WebCenter Sites: com.openmarket.directory.cs.CSName

- LDAP: com.openmarket.directory.jndi.Name Wrapper

Do not change the value of this property unless you are integrating with LDAP.

className.IUserDir

Specifies the name of the concrete class to implement interface IUserDir.

Possible values:

- WebCenter Sites: com.openmarket.directory.cs.CSDir

- LDAP: com.openmarket.directory.jndi.LDAP UserDir

Do not change the value of this property unless you are integrating with LDAP.

className.JNDIName

Specifies the name of the concrete class to implement the interface JNDIName.

Do not change the value of this property unless you are integrating with LDAP.

7.5 JNDI SPI Env Tab

The properties on the JNDI SPI Env tab are used only if your WebCenter Sites system is configured to use the LDAP user manager module.

Table 7-5 Properties in dir.ini: JNDI SPI Env Tab

Property

Description

java.naming.factory.initial

Specifies the initial factory class to use. The value of this property should be the fully qualified class name of the factory class that will create an initial context.

Do not change the value of this property.

java.naming.security.authentication

Specifies the security level to use. Its value is one of the following strings: none, simple, strong.

If this property is unspecified, the security level is determined by the service provider.

Default value: simple

jndi.baseURL

Specifies the server name and port number of the directory server.

The value uses the following format:

ldap://<hostname>:<port>

jndi.connectAsUser

Specifies whether WebCenter Sites needs a designated user account to query the directory server for user attribute information.

If set to true, jndi.connectAsUser specifies a WebCenter Sites login to the LDAP server. This means that WebCenter Sites queries the directory server for information as the user who is logged in to the WebCenter Sites system and is making the inquiry. For example, when an administrator examines user information in the WebCenter Sites Admin interface, WebCenter Sites makes the inquiry as that user (admin, for example.)

If set to false, jndi.connectAsUser specifies a direct login to the LDAP server. This means there must be a valid username/password combination specified for the jndi.login and jndi.password properties; WebCenter Sites uses that user account to make inquiries.

jndi.custom

System property.

Do not enter a value for this property.

Specifies other spi-specific variables to pass into the javax.naming.context. Syntax follows x-www-form-urlencoded format.

jndi.login

Applies only when jndi.connectAsUser is set to false.

Specifies the fully qualified, fully distinguished name of the user account that WebCenter Sites uses to query the directory server.

jndi.password

Applies only when jndi.connectAsUser is set to false.

Specifies the password of the user account that WebCenter Sites uses to query the directory server. This value is encrypted.

jndi.poolConnections

Applies only when jndi.connectAsUser is set to false.

If this property is set to true, the system will create a pool of DirContent connections.

If set to false, jndi.poolsize is ignored.

jndi.poolsize

Indicates the size of the pool.

Default value: 20

This property is ignored if jndi.poolConnections is set to false.

syntax.custom

Specifies classJNDIName-specific variables to pass into the classIName constructor. Syntax follows x-www-form-urlencoded format.

7.6 Naming Syntax Tab

The Naming Syntax tab holds properties that determine how strings for user attributes and their values are interpreted.

Table 7-6 Properties in dir.ini: Naming Syntax Tab

Property

Description

syntax.beginquote

Specifies the string that delimits the beginning of a quoted string.

Default value: '

syntax.beginquote2

Specifies an alternative to the value specified for the syntax.beginquote property.

syntax.direction

Specifies the direction in which the components in a designated name are read.

Possible values:

left_to_right
right_to_left
flat

Default value: left_to_right

syntax.endquote

Specifies the string that delimits the end of a quoted string.

Default value: '

syntax.endquote2

Specifies an alternative to the value specified for syntax.endquote.

syntax.escape

Specifies the escape string for overriding separators, escapes, and quotes.

If you are using special characters, such as ',', '+', '-', ';', etc., in DN, you cannot use \ as an escape string.

Default value: \

syntax.ignorecase

Specifies whether strings are case-sensitive or not.

Set to false if the uppercase and the lowercase version of a letter character should be considered as different characters. (That is, "admin" and "Admin" should be interpreted as different words.)

Set to true if you want the uppercase and the lowercase version of a letter character to be considered as the same character. (That is "admin" and "Admin" should be interpreted as the same string.)

Default value: true

Note: If you need to set the cleandns property on the Compatibility tab to true, you must also set this property's value to true.

syntax.separator

Specifies the separator character used between atomic name components.

This property is required unless syntax.direction is set to a value of flat.

Default value: ,

syntax.separatorava

Specifies the separator character used to separate multiple attribute/value pairs. Typically the comma character (,) is used.

Default value: ,

syntax.separatortypeval

Specifies the separator character used to separate an attribute from its value. For example, the equals symbol (=) is used.

Default value: =

syntax.trimblanks

Specifies whether spaces and whitespace characters are significant or should be ignored (trimmed) when evaluating a string.

Set to true if spaces should be ignored.

Set to false if spaces should be considered when evaluating a string.

Default value: false

7.7 Schema Defaults Tab

The Schema Defaults tab holds properties that identify the following entities to WebCenter Sites:

- The directory server attributes for which users must have values in order to be valid users

- Attribute values that are assigned to users by default (if any).

Table 7-7 Properties in dir.ini: Schema Defaults Tab

Property

Description

defaultGroupAttrs

Specifies the attribute name/value pairs that are set for every descendent of the entry specified by the groupparent property.

WebCenter Sites uses this information to create the default groups that it needs during the installation, which means that this property must be set before you install WebCenter Sites.

Values must be entered in the x-www-form-urlencoded format.

defaultPeopleAttrs

Specifies the attribute name/value pairs that are set for every descendent of the entry specified by the peopleparent property.

WebCenter Sites uses this information to create the default users that it needs during the installation, which means that this property must be set before you install WebCenter Sites.

Values must be entered in the x-www-form-urlencoded format.

defaultReaderACLs

The ACL list to be assigned to DefaultReader by Login Module.

Default value: Browser

objectclassGroup

Specifies the name of the base object that signifies a WebCenter Sites group. The DIR.GROUPMEMBERSHIPS tag uses the value set for this property to differentiate group entries from user or other entries.

Possible values:

- WebCenter Sites: groupofuniquenames

- LDAP, iPlanet: groupofuniquenames

- LDAP, Active Directory: group

objectclassPerson

Specifies the name of the base object that signifies a WebCenter Sites user (person). The DIR.LISTUSERS tag uses the value set for this property to differentiate user entries from group or other entries

Value for WebCenter Sites or LDAP: person

requiredGroupAttrs

Specifies the attributes that every descendent of the entry specified by the groupParent property must have values for.

Values must be entered in the x-www-form-urlencoded format.

requiredPeopleAttrs

Specifies the attributes that every descendent of the entry specified by the peopleParent property must have values for.

Values must be entered in the x-www-form-urlencoded format.

7.8 Search Controls Tab

The Search Controls tab holds properties that constrain the queries that the user manager plug-in makes to the directory server.

Table 7-8 Properties in dir.ini: Search Controls Tab

Property

Description

search.returnlimit

Specifies the maximum number of entries to return.

To obtain all the entries that satisfy the search criteria, set the value to 0.

search.scope

Specifies to what depth in the hierarchy a search reaches: search just the specified or current node, or search the nodes under that node.

Default value: 2 (which means search all nodes under the stated node)

search.timeoutVal

Specifies the number of seconds to wait for results before returning an error.

A value of 0 means to wait indefinitely (that is, wait until the network timeout limit ends the wait).

7.9 User Defined Tab

Table 7-9 Properties in dir.ini: User Defined Tab

Property

Description

This tab, by default, has no properties.

N/A

8 fatwire_settings.properties

The fatwire_settings.properties file holds the property that points to the e-mail address which will receive "forgotten password" notices from WebCenter Sites users.

This file has a single tab, named "User Defined," in the Property Editor.

8.1 User Defined Tab

Table 8-1 Properties: fatwire_settings.properties: User Defined Tab

Property

Description

forgotpassword

Specifies the e-mail address that should receive notices from users regarding forgotten passwords. This property sets the e-mail address for the Forgotten Password? link on the WebCenter Sites login page.

Legal value: <e-mail address>

Default value: admin@localhost

9 futuretense.ini

The futuretense.ini file is the main property file for WebCenter Sites. Its properties are organized by function on the following tabs in the Property Editor:

- App Server Tab

- Authentication Tab

- Basic Tab

- Blob Server Tab

- Cluster Tab

- Compatibility Tab

- Content Tables Tab

- Database Tab

- Debug Tab

- Email Tab

- Export/Mirror Tab

- JSP Tab

- Misc Tab

- Page Cache Tab

- ResultSet Cache Tab

- Satellite Server Tab

- Search Tab

- User Defined Tab

9.1 App Server Tab

The App Server tab holds the futuretense.ini properties that supply information to WebCenter Sites about the application server.

Table 9-1 Properties in futuretense.ini: App Server Tab

Property

Description

cs.eventhost

The host string for running the event engine on application servers. In a clustered environment, this property must be set on each cluster member and point to either the primary cluster member or to the cluster member, itself. The second option provides for failover.

Legal value: http://<hostname>:<port_number>

ft.cgipath

The web server CGI directory where WebCenter Sites objects are installed.

Used in the constructions of URLs and form actions.

Be sure the value ends with a forward slash ( / ).

Possible values:

/NASApp/CS/ – when using the Sun ONE application server (iAS); the path is defined to be the path used when installing Sun ONE.

/servlet/ – in http servlet application environments (such as WebLogic).

9.2 Authentication Tab

The Authentication tab holds user authentication properties that are configured during installation based on the user manager plug-in in use on your WebCenter Sites system. Some of these properties apply no matter which user management module you are using, while others apply only if you are using NT authentication.

See also, the main configuration file for the user manager plug-ins is the dir.ini file. See Chapter 7, "dir.ini."

Table 9-2 Properties in futuretense.ini: Authentication Tab

Property

Description

cs.manageACL

Specifies the class that replaces the default WebCenter Sites ACL name-to-privilege mask function.

Do not change the value of this property.

cs.manageproperty

Specifies the name of the appropriate property file that configures the LDAP plug-in or the NT authentication plug-in, depending on whether you are using either of these user manager modules.

- For LDAP, set the value to: dir.ini

- For NT, set the value to: futuretense.ini

cs.manageUser

Specifies which user manager plug-in to use with this WebCenter Sites system.

- If you are using the default WebCenter Sites plug-in, the value is blank. WebCenter Sites will use database authentication and authorization.

- If you are using LDAP, the value is: com.openmarket.directory.jndi.auth.JNDILogin

- If you are using NT authentication, the value is: com.FutureTense.NTUserGroups.ValidateLogin.NTUserGroupsLogin

This property is set when your WebCenter Sites system is integrated with LDAP or a different external system. Do not change its value after installation. By default, the value is blank.

Note: When this property is set, the cs.manageproperty must also be set.

cs.manageUserAccess

Specifies the class that replaces the default WebCenter Sites user-to-privilege-by-resource lookup functionality.

Do not change the value of this property.

cs.manageUserSystem

Applies only when your WebCenter Sites system is using NT authentication (that is, cs.manageUser points to the NT plug-in).

Specifies a comma-separated list of NT domain names that WebCenter Sites uses to authenticate users.

Authentication is done in the order specified by the list of domains. A user is declared a valid user if his username/password combination is found in any of those domains.

Specify the local system with a period (.) character.

If the cs.manageUser points to the NT plug-in, but there are no domain names set for this property, WebCenter Sites attempts authentication on the local NT domain only.

This value was set during installation.

cs.ssovalidator

This property points to the SSO validator plug-in.

Given that the WEM Framework is installed by default, the default value is:

com.fatwire.wem.sso.cas.cs.plugin.SSOValidatorPlugin

ntlogin.DefaultACL

NT user manager plug-in only.

A comma-separated list of any ACLs that should be assigned to all users by default.

By default, this value is blank.

ntlogin.DefaultReaderACL

NT user manager plug-in only.

The ACL list to be assigned to the account that is used as the default reader account.

By default, this value is blank.

ntlogin.DefaultReaderID

NT user manager plug-in only.

The user name to be used as the default reader account.

By default, it is set to DefaultReader.

This value can be blank.

ntlogin.DefaultReaderPW

NT user manager plug-in only.

The password for the user name that the NT authentication module uses as the default reader account. Required if there is a value for ntlogin.DefaultReaderID.

By default, it is set to SomeReader. The value is encrypted.

ntlogin.LogFile

NT user manager plug-in only.

The complete path to the file where debug information from the NT authentication module should be written. (Used only when ntlogin.Logging is set to true.)

ntlogin.Logging

NT user manager plug-in only.

Enables or disables debugging for the NT authentication module.

Possible values: true | false

singlesignon

If set to true, enables single sign-on for an authentication plug-in that supports single sign-on.

Because the WEM Framework is installed by default, this property is set to true.

9.3 Basic Tab

The Basic tab holds the futuretense.ini properties that control such things as security settings, session timeouts, and Global Unique Identifiers that the WebCenter Sites servlets use.

Table 9-3 Properties in futuretense.ini: Basic Tab

Property

Description

bs.security

Specifies whether the BlobServer servlet checks security before allowing database access and image retrieval. If security is on, images cannot be cached in memory.

If you enable BlobServer security, the BlobServer servlet serves the data only if the csblobid parameter exists in the URL and its value matches a session variable of the same name, as in the following example: <IMG SRC="BlobServer?blobtable=MovieImages&#38;blobcol=urlimage&#38;blobkey=id&#38;csblobid=SessionVariables.blobid&#38;blobwhere=25"/>

Possible values: true | false

cc.security

Specifies whether WebCenter Sites checks security before allowing database access. This property should always be set to true except in special cases.

Possible values: true | false

cs.barEqualsSlash

Specifies whether an Internet Explorer browser should interpret the bar (|) character as a forward slash (/) when it is included in a page name.

Possible values: true | false

For example, when set to true, Internet Explorer interprets pagename=folder|subfolder|page as the same page as pagename=folder/subfolder/page

Default value: false

cs.session

Specifies whether WebCenter Sites starts and maintains a browser session for each user.

Possible values: true | false

Cannot be set to false when the cc.security property is set to true.

cs.timeout

Specifies the number of seconds a connection can remain idle before the application server logs out this connection, which ends a browser session. Idle time is the time between WebCenter Sites http requests.

Default value: 300 (5 minutes)

Note: When the approval system approves assets, it is not a background process. Therefore, if you use the Approve Multiple Assets feature, be sure to set this property to a value that is greater than the amount of time it takes to approve a batch of asset so that the browser session does not time out. You will have to experiment with this setting, but you can start by setting it to 1800 seconds (30 minutes).

cs.uniqueidpoolsize

Specifies the number of unique and cluster-safe ID numbers that are cached at one time. (WebCenter Sites generates unique IDs for every row in any database table.)

Default value: 100

cs.wrapper

Deprecated. Specifies whether the WebCenter Sites HTML wrapper pages should (can) be used.

Default value: true

Set this value to false on a WebCenter Sites system in which the application server does not have HTTP access to the web server, or, if you have removed the directory that holds the wrapper pages for security reasons.

See also "Setting up External Security" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

ft.version

Specifies the version number of the WebCenter Sites application.

Do not modify this value.

secure.CatalogManager

Specifies whether the DefaultReader user can access the CatalogManager servlet.

Possible values: true | false

During installation, this property is set to false. Be sure that this value is changed to true after the installation.

For more information, see "Setting Up External Security" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

secure.DebugServer

Controls whether DefaultReader can connect to the specified servlet when security is on. If set to true, DefaultReader cannot connect.

Possible values: true | false

secure.TreeManager

Specifies whether the DefaultReader user can access the TreeManager servlet.

Default value: true

For more information, see "Setting Up External Security" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

9.4 Blob Server Tab

The BlobServer tab holds properties that configure the BlobServer servlet. BlobServer serves blobs. It gathers a blob from a table and performs all the necessary security checks. When BlobServer serves a blob, it caches it in both WebCenter Sites and Satellite Server.

Table 9-4 Properties in futuretense.ini: Blob Server Tab

Property

Description

bs.bCacheSize

Specifies the default number of blobs that can be cached (to memory).

Default value: 100

bs.bCacheTimeout

Specifies the number of seconds that a blob will remain cached in memory. Note that the memory cache is cleared whenever the BlobServer servlet is restarted.

This property affects the operation of CacheManager as follows:

When compositional dependencies are recorded against a blob in the SystemItemCache table, they are configured such that they will be removed from the table after the blob expires from the cache. This prevents excessive growth of the SystemItemCache table. However, removing the entry from the table disables CacheManager from removing the corresponding blobs from the Tier 2 cache, and users will view stale data.

Possible values: negative integer, 0, positive integer

Default value: -1

The blob will remain cached in memory forever, unless it is evicted because more recently used blobs have filled the cache.

Note: The value of this property affects cs.manage.expired.blob.inventory as follows:

- A value of 0 or less causes cs.manage.expired.blob.inventory to have no effect.

- A positive integer with cs.manage.expired.blob.inventory set to true ensures that CacheManager operates correctly, but at the cost of growth in the SystemItemCache table.

For more information, see cs.manage.expired.blob.inventory.

bs.invalidheadernames

Comma separated list of invalid headers which are ignored by BlobServer.

Default value: Set-Cookie

Note: If headers are specified as both valid (bs.validheadernames) and invalid (bs.invalidheadernames), the headers specified in bs.validheadernames take precedence.

For more information, see bs.validheadernames.

bs.validheadernames

Comma separated list of valid headers which are allowed by BlobServer.

Note: If headers are specified as both valid (bs.validheadernames) and invalid (bs.invalidheadernames), the headers specified in bs.validheadernames take precedence.

For more information, see bs.invalidheadernames.

cs.recordBlobInventory

Specifies whether compositional dependencies should be recorded against blobs. This property must be set to true (the default) for CacheManager to operate on blobs.

Possible values: true|false

Default value: true

9.5 Cluster Tab

The Cluster tab holds the properties that WebCenter Sites uses to communicate with all the servers in a cluster when a WebCenter Sites system is installed in a cluster.

Table 9-5 Properties in futuretense.ini: Cluster Tab

Property

Description

cc.cacheNoSync

Specifies whether the system allows the database query transaction data cached by WebCenter Sites to persist even if a cluster member updates the table.

Default value: false

You can set table-specific values for individual tables by adding a property in the following format:

cc.<sometable>CSync=<true or false>

ft.sync

An identifier or value that defines the synchronizer key for clustered servers; for example, the DSN that cluster members use for their shared database. Each cluster member must have the same ft.sync value.

When set to true or yes, sync is enabled and extra asset-level locking is in effect. This mode is intended for clustered editorial systems, as it uses an asset-locking mechanism designed for frequent changes to assets.

When set to a value other than true or yes, sync is enabled but extra asset-level locking is not in effect. This mode is intended for clustered delivery systems, as it enables an asset-locking mechanism designed for infrequent changes to assets.

Note: Oracle recommends that you specify a value for ft.sync.

Legal values: <string> | <blank>

ft.usedisksync

Specifies a shared file system folder to synchronize data across a cluster.

Set this property to a valid folder when synchronization is turned on with the ft.sync property. For example, set it to a directory where you have read/write access.

9.6 Compatibility Tab

The Compatibility tab holds properties that set values necessary for backward compatibility with earlier versions of WebCenter Sites.

Table 9-6 Properties in futuretense.ini: Compatibility Tab

Property

Description

cs.cookievariables

Specifies if cookie variables should be created for servlet request information.

Generating cookie variables can confuse page criteria for page requests and works only for outer pages.

Legal value: false

cs.dataindatabase

Specifies whether large data should be saved in the database or in the file system as an upload column.

cs.httpvariables

Deprecated.

Specifies whether the WebCenter Sites variables that contain HTTP header information are created on each page request, as was necessary in pre-4.0 versions of the product. Starting with 4.0, FatWire Content Server provides built-in variables that perform the same function.

Default values: false

For best performance, leave this value set to false. If developers need to retrieve an http variable for a site page, they can retrieve the value of the ones they need by using the built-in variables.

cs.satellitehosts

Specifies the host names of the servers that are hosting Satellite servlets that the CacheManager on this server (the one that hosts WebCenter Sites) needs to communicate with.

Enter a comma-separated list of host names. The value for each host must include the path to the WebCenter Sites servlets.

Use the following format:

http://<hostname:port>/<servlet>/

You can use https or special ports, if necessary. If required by your configuration, be sure to specify a fully-qualified domain name.

The Satellite servlet that resides on this server is listed by default.

cs.satellitepassword

Specifies the passwords for the user accounts specified by the cs.satelliteusers property. Note that the password for the Satellite servlet on this server is listed by default.

The value of this property is encrypted as a single string. Therefore, when you edit the value of this property, you must enter all the passwords for all the Satellite servlet hosts, including the comma delimiter.

Enter a comma-separated list of passwords in the order that matches the order in which you enter the corresponding users for the cs.satelliteusers property. Be sure that the order of this list also matches the order of the list of host names provided for the cs.satellitehosts property.

cs.satelliteusers

Specifies the user names for the Satellite Server hosts. Note that the user name for the Satellite servlet on this server is listed by default.

Enter a comma-separated list of user names in the order that matches the list of passwords that you specified for the cs.satellitepassword property.

cs.selfmodify

Specifies a comma-separated list of attributes that a user is allowed to modify.

Currently, only password is supported.

For complete backward compatibility, set the property to blank to ensure that the user has write privileges to the SystemUsers table.

cs.xmlHeaderAutoStream

Tells WebCenter Sites whether it should stream the XML header as defined in the property cs.xmlHeader as the first content of the response, automatically, or not.

If this property is set to true, then WebCenter Sites will automatically insert the header into the response. If it is set to false, then WebCenter Sites will not do anything. If the response is not a SOAP response, this property is ignored entirely and the header is never inserted.

Default value: false

ft.approot

Deprecated.

This property is no longer used. In some cases, it may be required for backward compatibility.

ft.catalogmanager

Defines the Global Unique Identifier (GUID) for the CatalogManager service. It is provided for reference only.

Default value: {40DD4E30-8DE2-11D1-8599-0080C7D07E91}

Do not modify this value.

ft.contentserver

Defines the GUID for the ContentServer servlet. It is provided for reference only.

Default value: {29434AD0-8DE2-11D1-8599-0080C7D07E91}

Do not modify this value.

ft.treemanager

Defines the GUID for the Treemanager servlet.

Do not modify this value.

security.checkpagelets

Specifies whether WebCenter Sites checks security before allowing a user to view a pagelet that is nested in an enclosing page.

Note that the cc.security property must also be set to true for security to be implemented.

Default value: true

If set to false, the following occurs:

- On systems with co-resident Satellite Server, security is not checked on any pages or pagelets, even with cc.security set to true.

- On systems with stand-alone Satellite Server or with WebCenter Sites only, security is checked on the first or outermost page but security is not checked on nested pagelets.

9.7 Content Tables Tab

The Content Tables tab holds a property that specifies the default primary key column for all of the content tables (as opposed to object tables) in your WebCenter Sites database.

If you or your developers create any content tables to support your online sites, you can specify that a column other than the one specified by the default is the primary key column for those content tables by creating table-specific properties. Use the following format:

cc.<name of table>Key=<name of column>

For example, when WebCenter Sites installs the Category table (which is used by basic asset types), it creates a property named cc.CategoryKey. The cc.CategoryKey property and any new property that you create appears on the User Defined tab rather than the Content Tables tab.

Caution:

Do not change the key value specified for any of the WebCenter Sites content tables.

Table 9-7 describes the property in the Content Tables tab:

Table 9-7 Properties in futuretense.ini: Content Tables Tab

Property

Descriptions

cc.contentkey

Specifies the name of the column that serves as the primary key for content tables in the WebCenter Sites database. This is a default setting that applies to any content table that does not have a table-specific property that sets a different primary key for it.Value set during installation of the WebCenter Sites content applications: id

Caution: Do not change the value of this property. If you change it, the WebCenter Sites content applications will not function. To specify a different primary key for an individual content table, create a table-specific key property as described in the paragraphs preceding this table.

9.8 Database Tab

The Database tab holds both the general database configuration properties such as database name and user access properties, and vendor-specific properties such as how the database interprets date/time values.

Database properties must be set to the same values on each of the systems in your WebCenter Sites system—development, management, and delivery—so that you can move assets and other work from one system to another.

Note:

Database properties are set during the WebCenter Sites installation process. If you need assistance with determining property values or setting them during the installation process, contact Oracle Technical Support. Do not change the values of these properties after WebCenter Sites is installed.

If you are unsure about how property values were determined, check with your database administrator or the individual who installed WebCenter Sites.

Table 9-8 Properties in futuretense.ini: Database Tab

Property

Descriptions

cc.bigint

Specifies the SQL string for defining a 64-bit integer field.

Possible values:

- Oracle: NUMBER(38)

- SQL Server: BIGINT

- DB2: BIGINT

See also the note above this table.

cc.bigtext

Specifies the SQL string for defining a large text field.

Possible values:

- Oracle: CLOB

- SQL Server: TEXT

- DB2: LONG VARCHAR

See also the note above this table.

cc.blob

Specifies the SQL string for defining a BLOB (binary large object) field.

Possible values:

- Oracle: BLOB

- SQL Server: IMAGE

- DB2: LONG VARCHAR FOR BIT DATA

See also the note above this table.

cc.char

Specifies the SQL string for defining a CHAR data type.

Possible values:

- Oracle: CHAR

- SQL Server: CHAR

- SQL Server, multi-lingual Unicode: NCHAR

- DB2: CHAR

See also the note above this table.

cc.datepicture

Specifies how WebCenter Sites creates a date/time literal.

Default values: {ts '$date'}

See also the note above this table.

cc.datetime

Specifies the SQL string for defining a date/time field.

Possible values:

- Oracle 8: DATE

- Oracle 9: TIMESTAMP

- SQL Server: DATETIME

- DB2: TIMESTAMP

See also the note above this table.

cc.double

Specifies the SQL string for defining a double field.

Possible values:

- Oracle: NUMBER(38,10)

- SQL Server: NUMERIC(28,10)

- DB2: FLOAT

See also the note above this table.

cc.forcelower

Specifies whether the column names for the tables that WebCenter Sites creates have all lowercase letters.

Possible values:

- Oracle: true

- SQL Server: false

- DB2: true

See also the note above this table.

cc.ignoreTblCase

Determines whether WebCenter Sites ignores case when assessing table names.

Possible values:

yes | no

For example, if "tablename" and "TABLENAME" would be considered different tables in your database, set this value to no.

Possible values:

- Oracle: yes

- SQL Server: yes

- DB2: yes

See also the note above this table.

cc.integer

Specifies the SQL string for defining a 32-bit integer field.

Possible values:

- Oracle: NUMBER(10)

- SQL Server: INT

- DB2: INTEGER

See also the note above this table.

cc.maxvarcharsize

Specifies the maximum size of a varchar column for your database.

Possible values:

- Oracle: 2000

- SQL Server: 8000

- DB2: 4000

See also the note above this table.

cc.null

Specifies the SQL string for defining a field which allows NULL values; this is nonstandard, though most databases support NULL.

Possible values:

- Oracle: NULL

- SQL Server: NULL

- DB2: blank

See also the note above this table.

cc.numeric

Specifies the SQL string for defining a numeric field.

Possible values:

- Oracle: NUMBER

- SQL Server: NUMERIC

- DB2: NUMERIC

See also the note above this table.

cc.primary

Specifies the SQL string that defines a primary key.

Possible values:

- Oracle: PRIMARY KEY NOT NULL

- SQL Server: PRIMARY KEY NOT NULL

- DB2: PRIMARY KEY NOT NULL

See also the note above this table.

cc.queryablemaxvarcharlength

Specifies the maximum size of a varchar column that can be queried based on the database driver in use.

- Oracle Thin: 255

- Oracle TypeII: 2000

- SQL Server: 255

- DB2: 255

cc.rename

Specifies the SQL string that renames a table in the database, as required by your database vendor.

Possible values:

- Oracle: rename %1 to %2

- SQL Server: execute sp_rename %1,%2

- DB2: rename %1 to %2

See also the note above this table.

cc.smallint

Specifies the SQL string for defining a 16-bit integer field.

Possible values:

- Oracle: NUMBER(5)

- SQL Server: SMALLINT

- DB2: SMALLINT

See also the note above this table.

cc.stringpicture

Specifies how WebCenter Sites creates a string literal.

Possible values:

- Oracle: '$string'

- SQL Server: '$string'

- SQL Server, multi-lingual Unicode: N '$string'

- DB2: '$string'

See also the note above this table.

cc.unique

Specifies the SQL string for defining a unique field.

Possible values:

- Oracle: UNIQUE NOT NULL

- SQL Server: UNIQUE NOT NULL

- DB2: UNIQUE NOT NULL

See also the note above this table.

cc.varchar

Specifies the SQL string for defining a VARCHAR data type.

Possible values: VARCHAR, for all supported databases except SQL Server, multi-lingual Unicode which is set to NVARCHAR

See also the note above this table.

cs.dbconnpicture

Specifies the format of the database connection string used by JNDI datasources:

See also the note above this table.

cs.dbtype

Defines the type of database to which you are connecting.

See also the note above this table.

cs.dsn

Contains the database JNDI data source name for connecting to your database.

See also the note above this table.

cs.privpassword

Specifies the password for the database account name used for read/write access (cs.privuser). The value is encrypted.

cs.privuser

Specifies the database account name to use for read/write access to the database. For security reasons, be sure that your system is not using the default user name/password combination.

Possible values: ftuser (set during the installation process)

9.9 Debug Tab

Note:

For information about enabling debug logging, see Chapter 5, "commons-logging.properties." See also "Error Logging and Debugging" in the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

If you enable debug logging, note the following:

- Delete or archive the WebCenter Sites log file frequently, because a large log file can affect WebCenter Sites performance.

- By default, all debug log messages go into a single log file, which can make debugging more difficult. To place debug messages into a separate log file, set the logging.per-client-log property to true. The property is defined in Table 5-4.

Table 9-9 Properties in futuretense.ini: Debug Tab

Property

Description

ft.debugport

Deprecated. Specifies the port that DebugServer uses to communicate with the template debugger utility. The port number must be greater than 1024.

Default value: 1025

ft.suppressPasswords

Prevents any input or session variables containing the strings "password" or "PASSWORD" in their names from being logged.

Default value: true

Specify false to include passwords in the log.

ft.suppressPasswordNames

Specifies variable names that are used as passwords and should be suppressed when ft.suppressPasswords is set to true.

The Cheetah installer now sets this property to: REMOTEPASS;pubtgt:factors;factors to suppress its mirror publish target passwords in the log.

9.10 Email Tab

The Email tab holds the properties that configure the WebCenter Sites e-mail system features. Note that in futuretense_xcel.ini, an additional property, xcelerate.emailnotification, on the Preference tab enables the WebCenter Sites workflow e-mail system to send notices to workflow participants when they are assigned assets through a workflow process.

Table 9-10 Properties in futuretense.ini: Email Tab

Property

Description

cs.emailaccount

Specifies the user account name to be used for sending outgoing mail. This is the account name on the SMTP server.

If SMTP authentication is required, you must set a value for this property.

cs.emailauthenticator

Specifies the class that is used as the authenticator for mail operations.

Default value: com.openmarket.framework.mail.ICSAuthenticator

cs.emailcharset

Specifies the default character set that is used for the text in the subject of an e-mail message.

Examples:

- Latin1: ISO-8859-1

- Japanese (Shift_JIS): Shift_JIS

- UTF-8: UTF-8

If this property is blank, its value reverts to the default UTF-8.

cs.emailcontenttype

Specifies the default character set that is used for the text in the body of an e-mail message.

Examples:

- Latin1: text/html; charset=ISO-8859-1

- Japanese (Shift_JIS): text/html; charset=Shift_JIS

- UTF-8: text/html; charset=UTF-8

If this property is blank, its value reverts to the default text/plain.

cs.emailhost

Defines the SMTP (e-mail server) host that is used by the ContentServer servlet to create and deliver e-mail messages.

A valid value is required to send or receive mail.

cs.emailpassword

Specifies the password for the e-mail account used by WebCenter Sites (specified by cs.emailaccount).

A valid value is required to receive mail.

cs.emailreturnto

Specifies the e-mail address from which mail is sent. That is, the e-mail address that appears in the From field of an e-mail message.

Use one of the following formats:

user@domain.com

Full Name <user@domain.com>

A valid value is required to send mail.

9.11 Export/Mirror Tab

The Export/Mirror tab holds the properties that configure the WebCenter Sites Export and Mirror APIs used by the WebCenter Sites publishing system. These properties work in conjunction with the properties located on the Publishing tab in the futuretense_xcel.ini file.

When configuring publishing operations for your WebCenter Sites systems, think of your individual systems (development, management, delivery) in the following terms:

- Source, which denotes the WebCenter Sites database that is the source for a publishing session. Because you can mirror assets and site configuration information from any WebCenter Sites system to any other WebCenter Sites system, the source is not necessarily the WebCenter Sites management system.

- Target, which denotes either the WebCenter Sites database to which you are mirroring, or the file server to which are exporting.

For more information about publishing, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

Table 9-11 Properties in futuretense.ini: Export/Mirror Tab

Property

Description

cs.mirrorhttpversion

Specifies the HTTP protocol version to use to communicate with the WebCenter Sites target databases.

Default value: 1

cs.mirrorpassword

Specifies the password for the mirror user on the target systems to which this system publishes. You set this value when you set up your WebCenter Sites system for publishing.

For information, see "The Mirror to Server Publishing Process" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

cs.mirrorproxyserver

Specifies the firewall server's IP address or name for the target system that this (source) system publishes to when the target and the source are separated by a firewall. You set this value when you set up your WebCenter Sites system for publishing.

Possible values:

your_server_name or

your_server_ip_address

For information, see "The Mirror to Server Publishing Process" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

cs.mirrorproxyserverport

Specifies the port number of the firewall server for the WebCenter Sites system that this system publishes to when the target system is separated from the source with a firewall. You set this value when you set up your WebCenter Sites system for publishing.

Possible values: port_number

For information, see "The Mirror to Server Publishing Process" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

cs.mirrorrowsperpost

Specifies the number of table rows that can be mirrored during each HTTP POST during a mirror operation

If you are mirroring data that contains URL fields, you should set this to a low number because web servers impose a limit on the size of post packets.

If you are mirroring data that contains only text, you can set this to a higher number.

Default value: 6

Note: For best performance, do not increase the value above 12. If your database is configured for UTF-8 and holds non-ASCII content, you must set this value to 4 or lower.

cs.mirrorthreads

Specifies the number of threads to allocate to a mirror operation.

Default value: 2

Note: For best performance, do not increase the value above 8.

cs.mirroruser

Specifies the name of the mirror user on the target system that this (source) system publishes to. You set this value when you set up your system for publishing.

For information, see "The Mirror to Server Publishing Process" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

cs.pgexportfolder

Specifies the base export directory for the HTML files that are created when assets are published with the Export to Disk delivery type.

- Windows NT example: c:/FutureTense/export

- Solaris example: /export/home/FutureTense/pgexport

9.12 JSP Tab

The JSP tab holds the properties that supply information that WebCenter Sites references when serving JavaServer Pages files.

Table 9-12 Properties in futuretense.ini: JSP Tab

Property

Description

cs.jspclear

Configures the WebCenter Sites engine to delete any previously deployed JSP files and clear the application server's working folder (temp and class files) when the WebCenter Sites engine executes the first JSP deployed by WebCenter Sites.

The working folder is defined by the application server.

Possible values: true | false

cs.jsppath

Specifies the virtual root (zone) for executing deployed JSP pages. This property is used in conjunction with cs.jsproot, so the two properties must be in sync.

Default value: synchronized with the WebLogic setting for cs.jsproot and is set at installation.

Note: Do not change the value of this property after installation.

cs.jsprefresh

When the WebCenter Sites engine deploys a new or changed JSP element, the application server may require special processing to complete the deployment of the JSP. In those cases, this property specifies the name of the class which completes the deployment. In other cases, it is left blank.

cs.jspresponsewrapper

Specifies whether the application server requires the PrintWriter when it runs a JSP element. The WebCenter Sites installation sets this to an appropriate value based on the type of application server you are using.

Do not change the value of this property.

cs.jsproot

Specifies the directory where the application server expects to find JSP files. Some application servers allow this value to be modified by using property settings. WebLogic defines weblogic.httpd.initArgs for its JSPServlet object.

The cs.jsproot property is used in conjunction with cs.jsppath, so the two must be in sync and both are set at installation.

Do not change the value of this property after installation.

cs.jspwork

Specifies the directory where class files are created by the application server when executing JSP pages. This is not a required property and can be left blank, but it is normally set at installation.

For more information, see cs.jspclear.

cs.use.short.jsp.names

Some file systems impose a limit on the length of absolute paths. Using long JSP names on such file systems can result in file system errors.

If you are using such a file system, set this property to true to use shortened JSP names.

When this property is set to false, the JSP name will correspond to the element name.

This property is set automatically by the WebCenter Sites installer; it should be changed only when absolutely necessary.

Default value: false

9.13 Misc Tab

The Misc tab holds miscellaneous properties such as the amount of idle time a connection can have before WebCenter Sites logs out of a connection and whether WebCenter Sites loads cache synchronization processing.

Table 9-13 Properties in futuretense.ini: Misc Tab

Property

Description

cs.charset

Specifies a variable that can be included in HTML forms as a hidden variable. The variable, which gets set by the browser, specifies the text encoding of the form data that WebCenter Sites must process.

Default value: _charset_

Do not change the value of this property.

cs.contenttype

Specifies the default character set to use for HTTP headers (streaming text).

Default value: text/html; charset=UTF-8

Specify a value that is appropriate for the online site that your WebCenter Sites system is delivering.

Examples:

- Latin1: text/html; charset=ISO-8859-1

- Japanese (Shift_JIS): text/html; charset=Shift_JIS

cs.disksize

Specifies the size limit in bytes for keeping uploaded files in memory while they are being posted. If an uploaded file is larger than the value specified, WebCenter Sites streams it to a temporary file until it is finished evaluating a page. This prevents excessive memory use and helps to prevent denial-of-service attacks.

Default value: 102400

cs.documentation

Specifies the URL of the WebCenter Sites documentation.

By default, this property is set to an Oracle documentation web site.

If you prefer, you can download the most recent documentation kit from that web site, install it somewhere on your network, and then set this property to point to that location rather than to the Oracle documentation web site.

cs.HTTP_HOST

Specifies the HTTP host for WebCenter Sites systems on which the web server does not reside on the application server machine (that is, it is a web connector installation), or in cases where an alternative web server is used to serve pages.

Use one of the following formats:

<hostname>:<port>
<IPaddress>:<port>

Default value: blank

cs.HTTP_PROTOCOL

Specifies the HTTP protocol for WebCenter Sites systems where the web server does not reside on the application server machine (that is, it is a web connector installation), or in cases where an alternative web server is used to serve pages.

Possible values: http or https or blank

Default value: blank, which means the protocol is assumed to be http.

cs.sitepreview

This property is used to control the behavior of Site Preview functionality. The value of this property determines the output of the filter tag (asset:filterassetsbydate) as explained below.

Note: To use Site Preview on a content management environment, you must set this property to contentmanagement.

Possible values: disabled, contentmanagement, delivery

- If the value is disabled:
The filter tag will not filter. It will simply return the set of input assets.

Caching will not factor in start/end dates in the expiry time calculations. Date inputs to the templates will have no effect.

- If the value is contentmanagement:
The filter tag will filter the input set of assets according to the given date. If the given date is null, the tag will use the current server date.

Pages whose rendering templates use the filter tag will not be cached.

For pages that do not use the filter tag, caching will work in the default manner and expiry time calculations will not factor in start/end dates.

- If the value is delivery:
The filter tag will ignore all dates passed to it and will use the current server date for filtering.

For pages that use the filter tag, caching will factor in start/end dates in the expiry time calculation.

For pages that do not use the filter tag, caching will work in the default manner and expiry time calculations will not factor in start/end dates.

Default value: disabled

cs.urlfilerollup

Determines how changes to the files for URL columns are tracked.

When this property is set to true, the previous versions of the related file are tracked in a name sequence. For example, if a file called filename.txt has been edited three times, filename.txt is the oldest, filename,1.txt is the next oldest version, and filename,2.txt is the current version.

When this property is set to false, the file name toggles between filename.txt and filename,0.txt on alternate updates.

cs.xmlfolder

Specifies the working directory for HTML filtering. That is, if elements on your system use the XMLFILTER tag, temporary files are written to this directory.

Default value: $HOME/FutureTense/xmltemp

cs.xmlHeader

This is the XML Header streamed out for SOAP responses.

9.14 Page Cache Tab

The Page Cache tab holds the properties that configure the page cache settings for WebCenter Sites. WebCenter Sites page caching is monitored and maintained by the CacheManager. WebCenter Sites caching enables you to cache both complete web pages and their individual components (or pagelets).

To set up page caching on a WebCenter Sites system, you configure properties for the CacheManager and the Satellite Server servlets. In addition, there are properties for configuring BlobServer, the servlet that serves blobs and caches blobs both through WebCenter Sites and the Satellite servlet.

For more information:

- Page caching – see the "Page Design and Caching" chapter in the Oracle Fusion Middleware WebCenter Sites Developer's Guide. This chapter describes how the WebCenter Sites CacheManager, the Satellite servlets, and the BlobServer servlet interact and work together.

- Satellite Server properties – see Section 9.16, "Satellite Server Tab" and Chapter 15, "satellite.properties."

- Resultset caching properties – see Section 9.15, "ResultSet Cache Tab."

- BlobServer properties – see Section 9.4, "Blob Server Tab."

Table 9-14 Properties in futuretense.ini: Page Cache Tab

Property

Description

cs.alwaysusedisk

Specifies the default cache setting for page entries in the SiteCatalog table that have no information in their cacheinfo column.

If set to yes, then each page served from WebCenter Sites is cached to disk (the database), unless the value in that page entry's cacheinfo column specifies that it not be cached.

Default value: no

cs.expireonly

Controls how outdated pages are expunged from the cache.

When this property is set to false, pages that need to be expunged from the cache are deleted immediately and synchronously, that is, the user must wait until all pages are deleted.

When this property is set to true, pages that need to be expunged from the cache are marked for deletion, taken out of service, and then deleted at a later time by a cache cleanup event.

Default value: true

Possible values: true | false

cs.freezeCache

Specifies whether a cache maintenance event should regularly remove expired pages from the cache, or whether the expiration date of a page should be checked only when that page is requested.

Set the value to yes if you do not want an event to regularly remove expired pages from the cache.

Default value: no

cs.IItemList

Defines the file that is used for the ItemList interface that is used by the CacheManager.

The IItemList interface is used to record compositional dependencies in the page cache. When this property is set to a legal class, dependency items will be recorded against a page id in the SystemItemCache table. This enables CacheManager. An illegal value results in CacheManager having no effect.

Default value: com.openmarket.xcelerate.publish.MyItemList

Note: The default value is provided for reference only. Do not change the value of this property.

cs.manage.expired.blob.inventory

Controls whether the CacheServer servlet removes blobkey/compositional dependency mappings from the SystemItemCache table after the blobs expire from the local blobserver cache. (The CacheServer servlet is typically invoked every five minutes by the event engine.)

Possible values: true|false

- true disables the CacheServer servlet from removing blobkey/compositional dependency mappings from the SystemItemCache table when the blobs expire.

- false enables the CacheServer servlet to remove expired blob references from the SystemItemCache table when the blobs expire.

Default value: false (to support backward compatibility)

Note: How this property takes effect depends on the value of the bs.bCacheTimeout property in Table 9-4.

cs.nocache

Provides you with the ability to disable all disk-based page caching (pages will still be cached in memory). Use this property to temporarily shut down page caching when you are debugging your site, but do not leave this value set to true on a live system.

Default value: false

cs.pgCacheTimeout

Specifies the number of minutes that a page will exist in the page cache. A value of 0 (zero) disables timeout, which means pages never expire. However, no matter what the setting for this property, CacheManager refreshes a cached page if the publishing system reports that it published any of the assets on that page.

Note: For CacheManager to work properly, this property must be set to 0. Otherwise, pages will expire, making it impossible for CacheManager to remove the corresponding entries from the Satellite Server cache, and users will view stale data.

Default value: 0

cs.recordBlobInventory

Allows users to work with blob dependencies. To record blobs inventory, set the value of this property to true.

cs.requiresessioncookies

Specifies whether session ID information can be held in cookies or whether WebCenter Sites must encode session data into the links.

Set to true (the default) if WebCenter Sites expects session cookies to be enabled. This allows all pages to be cached and does not encode the session id into any links. A value of false enables URL rewriting, with a negative effect on page caching performance.

Default value: true

cc.BlobServerTimeout

Specifies the default lifetime (in minutes) of a cached blob in memory. If memory is at a premium, you may reduce the value of this property.

Default value: 1440 (that is, 24 hours)

cc.BlobServerCacheCSz

Specifies the maximum number of blobs that will be cached in memory. If memory is at a premium, you may reduce the value of this property.

Default value: 1000

cc.SystemPageCacheTimeout

Specifies the number of minutes a cached page is held in memory (cached pages are cached both to disk and to memory).

Default value: 1440 (that is, 24 hours)

cc.SystemPageCacheCSz

Specifies the maximum number of pages that can be cached in memory. Pages are cached both in memory and to disk (database). This property specifies the number of pages cached to memory, not to disk.

Note: This property must not be set to -1.

Default value: 10000

ss.flushall

Controls how Satellite Server cache is flushed.

When this property is set to false (default), only outdated pagelets are flushed from the Satellite Server cache.

When this property is set to true, the Satellite Server cache is flushed completely (when a single asset is updated).

Default value: false

Possible values: true | false

9.15 ResultSet Cache Tab

The ResultSet Cache tab holds properties that configure resultset caching for WebCenter Sites. For information about resultset caching and queries on your WebCenter Sites system, see the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

The ResultSet Cache tab holds the following properties:

- Global resultset caching properties, which are set during the WebCenter Sites installation process to enable resultset caching for all tables in the WebCenter Sites database. The same properties will be automatically applied to all tables that are subsequently created. The properties are:

- cc.cacheResults: number of resultsets to cache in memory

- cc.cacheResultsTimeout: length of time to keep resultsets cached in memory

- cc.cacheResultsAbs: method of calculating expiration time for resultsets in the resultset cache

- Table-specific resultset caching properties for system tables. These properties are automatically set during the WebCenter Sites installation process to override the global resultset caching properties named above.
For example, the following table-specific properties are set for the ElementCatalog table: cc.ElementCatalogCSz and cc.ElementCatalogTimeout. The property values can be changed, or the properties can be removed (the resultset cache for the table will then use the values of the global properties).

Note:

If you wish to override global resultset caching properties, you must do so on a per-table basis by creating the following table-specific properties in the futuretense.ini file for as many tables as necessary to implement your resultset caching strategy for each of your WebCenter Sites systems:

cc.<tablename>CSz=<number of resultsets>
cc.<tablename>Timeout=<number of minutes>
cc.<tablename>Abs=<true or false>

If an asset type is enabled for revision tracking, and you wish to cache the resultsets of asset versions, use the properties above, but add _t after <tablename>:

cc.<tablename>_tCSz=<number of resultsets>
cc.<tablename>_tTimeout=<number of minutes>
cc.<tablename>_tAbs=<true or false>

When you create resultset caching properties that are specific for any user-defined table in the WebCenter Sites database, those properties are displayed on the User Defined tab.

For information about page caching properties, see Section 9.14, "Page Cache Tab." For information about BlobServer caching properties, see Section 9.4, "Blob Server Tab."

Note:

WebCenter Sites stores resultsets within the inCache framework instead of hash tables. Both caching frameworks use Java memory. You can switch between frameworks by setting the rsCacheOverinCache property in futuretense.ini to either true or false. For more information, see "rsCacheOverinCache" in Table 9-17.

Table 9-15 provides a description for each of the properties in the ResultSet Cache tab.

Table 9-15 Properties in futuretense.ini: ResultSet Cache Tab

Property

Description

cc.cacheResults

Specifies the default number of resultsets to cache in memory. Note that this does not mean the number of records in a resultset, but the number of resultsets.

Caution: Unless you are debugging, do not set this property to 0 or -1. If you do, WebCenter Sites will fail to save assets properly. (Setting this property to 0 or -1 disables resultset caching for all tables that do not have their own caching properties configured.)

Possible values: <n> (number of resultsets)

Default value: 500

Note: To set a different value for a specific table, create a property for that table using the following format: cc.<tablename>CSz=<number of resultsets>

cc.cacheResultsAbs

Specifies how expiration time for resultsets in the resultset cache is calculated.

- If this property is set to true, the expiration time for a resultset is absolute. For example, if cc.cacheResultsTimeout is set to 5 minutes, then 5 minutes after the resultset was cached, it is flushed from the cache.

- If this property is set to false, the expiration time for a resultset is based on its idle time. For example, if cc.cacheResultsTimeout is set to 5 minutes, the resultset is flushed from the cache 5 minutes after the last time it was requested rather than 5 minutes since it was originally cached.

Note: To set expiration time for a specific table, create a property for that table using the following format: cc.<tablename>CAbs=<true or false>

cc.cacheResultsTimeout

Specifies the number of minutes to keep a resultset cached in memory.

Setting this property to -1 means that there is no timeout value for tables that do not have their own caching properties configured.

Possible values: <n> (in minutes), or -1 to disable timeout for tables that use this default property.

Default value: 5

Note: To set timeout for a specific table, create a property for that table using the following format: cc.<tablename>Timeout=<number of minutes>

cc.ElementCatalogCSz

Specifies the number of resultsets to cache against the ElementCatalog table.

For best performance this value should be set to the number of rows in the table.

Default value: 1000

cc.ElementCatalogTimeout

Specifies the number of minutes to keep idle resultsets for the ElementCatalog table in the resultset cache.

Use -1 to disable timeout.

Default value: 60

cc.SiteCatalogCSz

Specifies the number of resultsets to cache against the SiteCatalog table.

For best performance, this value should be set to the number of rows in the table.

Default value: 1000

cc.SiteCatalogTimeout

Specifies the number of minutes to keep idle resultsets for the SiteCatalog table in the resultset cache.

Use -1 to disable timeout.

Default value: 60

cc.SystemACLCSz

Specifies the number of resultsets to cache against the SystemACL table.

For best performance, this value should be proportional to the number of rows in the table.

Default value: 25

cc.SystemACLTimeout

Specifies the number of minutes to keep idle resultsets for the SystemACL table in the resultset cache.

Default value: -1 (which disables timeout for this table)

cc.SystemInfoCSz

Specifies the number of resultsets to cache against the SystemInfo table.

For best performance, this value should be set to the number of rows in the table.

Default value: 500

cc.SystemInfoTimeout

Specifies the number of minutes to keep idle resultsets for the SystemInfo table in the resultset cache.

Default value: -1 (which disables timeout for this table)

cc.SystemUsersCSz

Specifies the number of resultsets to cache against the SystemUsers table.

For best performance, this value should be proportional to the number of rows in the table.

Default value: 100

cc.SystemUsersTimeout

Specifies the number of minutes to keep idle resultsets for the SystemUsers table in the resultset cache.

Default value: -1 (which disables timeout for this table)

ft.filecheck

Specifies whether WebCenter Sites verifies the timestamp on data held in an upload field each time an item (like an element) with uploaded data is requested.

On a management or delivery system, the same items are requested repeatedly and setting this value set to yes can slow the performance of the system. Set this property to no on management or delivery systems. You can set it to yes on a development system.

Default value: no

9.16 Satellite Server Tab

The Satellite Server tab holds properties that describe how to communicate with any of the Satellite servlets (Satellite Server), whether they are running locally or on remote servers.

Additionally, because Satellite Server is installed by default on the server that hosts your WebCenter Sites application, each WebCenter Sites system also has a satellite.properties file that configures the local Satellite servlet. (Note that when Satellite Server is also running on a remote server, that server also has a satellite.properties file.) For information about the properties in that file, see Chapter 15, "satellite.properties."

The following table describes the properties on the server that hosts WebCenter Sites that support communications with all Satellite servlets.

The value for each property is a comma-separated list. The ordinal position of an item in the list is what associates the host, user name, and password for each Satellite servlet. For example, the third host named in cs.satellitehosts is accessed using the third user account named in cs.satelliteusers, giving the third password listed in cs.satellitepassword.

Table 9-16 Properties in futuretense.ini: Satellite Server Tab

Property

Description

cs.PastramiEngine

Defines the name of the implementing class of the PastramiEngine interface. Leave this property null to disable this feature entirely. The standard value for this property is: com.divine.pastrami.PushEngine

satellite.blob.cachecontrol.default

Specifies a default value for the cachecontrol parameter for the satellite.blob, and RENDER.SATELLITEBLOB tags and their JSP equivalents.

Default value: blank

Set this property to a value that is appropriate for the majority of your blobs, and then use the cachecontrol parameter with the satellite.blob and RENDER.SATELLITEBLOB tags to override this value for individual blobs.

Use the following format to set a value:

hours:minutes:seconds daysOfWeek/daysOfMonth/months

For more information about this format, see the description of the expiration property in Chapter 15, "satellite.properties."

satellite.page.cachecontrol.default

Deprecated.

Specifies a default value for the cachecontrol parameter for the satellite.page, and RENDER.SATELLITEPAGE tags and their JSP equivalents.

Default value: blank

Set this property to a value that is appropriate for the majority of your pages and pagelets, and then use the cachecontrol parameter with the satellite.page and RENDER.SATELLITEPAGE tags to override this value for individual pages and pagelets.

Use the following format to set a value:

<hours>:<minutes>:<seconds> <daysOfWeek>/<daysOfMonth>/<months>

For more information about this format, see the description of the expiration property in Chapter 15, "satellite.properties."

9.17 Search Tab

Properties on the Search tab are deprecated and unsupported.

9.18 User Defined Tab

The User Defined tab displays custom properties, which are not created by the core WebCenter Sites product but are used by WebCenter Sites and its content applications.

This tab displays the following kinds of properties:

- Two custom properties for the sample site, if the WebCenter Sites portal sample site is installed.

- Properties that specify the name of the primary key column for a content table (catalog). For information about content tables, see the "Data Design" section in the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

- Custom properties that specify resultset caching settings for individual user-defined tables in the WebCenter Sites database. For more information, see the note in Section 9.15, "ResultSet Cache Tab."

- Custom properties that specify resultset caching settings for revision-tracked, user-defined tables in the WebCenter Sites database. For more information, see the note in Section 9.15, "ResultSet Cache Tab."

The following table lists all of the properties that any of the WebCenter Sites products create in the futuretense.ini file, which means that they appear on the User Defined tab. Note that your system may have additional properties that are not included in this list.

Table 9-17 Properties in futuretense.ini: User Defined Tab

Property

Description

analysisconnector.version

Deprecated.

The version number of Analytics Bridge, if it is installed.

Do not change the value of this property.

catalogcentre.version

Deprecated.

The version number of CS-Direct Advantage, if it is installed. CS-Direct Advantage was named Catalog Centre in early versions of the product.

Do not change the value of this property.

cc.AssetTypeCSz

The number of resultsets to cache against the AssetType table, an object table that is created by the WebCenter Sites installation.

Default value: 50

cc.CategoryCSz

The number of resultsets to cache against the Category table, an object table that the WebCenter Sites installation creates for asset types.

Default value: 50

cc.ComparatorsKey

The primary key of the Comparator table, a content table that the WebCenter Sites installation creates to hold field comparator classes.

Default value: name

Do not change the value of this property.

cc.FiltersKeyXX

Default value: name

cc.MimeTypeKey

The primary key of the MimeType table, a content table that the WebCenter Sites installation creates to store the mimetypes of the documents that it handles.

Default value: mimetype

Do not change the value of this property.

cc.PreviewgenKey

Default value: name

cc.SourceKey

The primary key of the Source table, a content table that the WebCenter Sites installation creates for asset types.

Default value: source

Do not change the value of this property.

cc.StatusCodeCSz

The number of resultsets to cache against the StatusCode table, a content table that the WebCenter Sites installation creates for asset types.

Default value: 10

cc.StatusCodeKey

The primary key of the StatusCode table.

Default value: statuscode

Do not change the value of this property.

commerceconnector.version

The version number of the Commerce Connector utility, if it is installed.

Do not change the value of this property.

contentcentre.version

Deprecated.

The version number of CS-Direct, if it is installed. CS-Direct was named Content Centre in previous versions of the product.

Do not change the value of this property.

cs.approvalLockStriping

Used to specify whether approval locking is

- global and default (false) or

- per target (true), which prevents targets from competing for approval and publishing activities. Setting this property to true requires you to add a non-null column named cs_target to the ApprovalQueue table. The column's data type must match the value of the cc.bigint property (in futuretense.ini).

If you wish to switch back from approval locking per target to default behavior (i.e., global lock):

1. Remove the cs_target column from the ApprovalQueue table.

2. Set cs.approvalLockStriping to false (or remove this property, as by default it is false).

cs.parentfoldercount

Specifies the maximum number of parent folders that WebCenter Sites can generate in subdirectories of <cs_install_dir>/Shared. Parent folders are the first level of numbered folders generated by WebCenter Sites. For example, if this property is set to 500, WebCenter Sites will generate no more than 500 parent folders in <cs_install_dir>/Shared/ccurl (where flex assets are stored).

If you wish to use this property, you must add it to futuretense.ini. If it is not added, WebCenter Sites uses the default value. Note that when this property is used, the existing parent folder structure remains as is. Parent folders that are no longer used will need to be deleted manually.

Within the parent folders, WebCenter Sites generates child folders. If you wish to specify the maximum number of child folders that can be generated, use the cs.childfoldercount property.

Default value: 1024

cs.childfoldercount

Specifies the maximum number of child folders that WebCenter Sites can generate in parent folders under subdirectories of <cs_install_dir>/Shared. Child folders are numbered subfolders that WebCenter Sites generates inside the parent folders.For example, if this property is set to 300, WebCenter Sites will generate no more than 300 child folders in parent folders under <cs_install_dir>/Shared/ccurl.

If you wish to use this property, you must add it to futuretense.ini. If it is not added, WebCenter Sites uses the default value. Note that when this property is used, the existing child folder structure remains as is. Child folders that are no longer used will need to be deleted manually.

If you also need to specify the maximum number of parent folders that WebCenter Sites can generate, use the cs.parentfoldercount property.

Default value: 1024

cs.dbencoding

Default value: UTF-8

cs.invalMemWindow

This property applies to the inCache framework. It is used to define the size of the FW_InvalidationMemory table in terms of a data storage period, in seconds, for that table. The data storage period is a rolling window.

For example, if the property is set to 20000, 20,000 seconds worth of data can be accumulated in the table. As additional data continues to arrive, it is stored, while data older than 20,000 seconds is purged by the table's cleanup mechanism. For more information about the inCache framework and FW_InvalidationMemory table, see "inCache Framework" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

If you wish to use this property, add it to the futuretense.ini file and set it to your required value. If the property is not added, WebCenter Sites uses the default value.

Default value: 259200 (that is, 3 days)

cs.requestfactory

Default value: com.fatwire.cs.portals.portlet.PortletRequestFactory

cs.TempObjectsDaysToKeep

Used to specify the number of days that data is stored in the TempObjects table. For example, if you specify a value of 7 for this property, then any data stored in the TempObjects table that is older then 7 days is deleted by the CleanTempObjects event (which is specified in the SystemEvents table and runs everyday at midnight to remove old data from the TempObjects table).

Legal value: Integer > 0

Default value: 5

Note: By default, this property is not present in the futuretense.ini file and its value is set to 5. To change the value of this property, you must manually add this property to the futuretense.ini file.

ft.servletoutputstream

Default value: false

image.time

Deprecated.

Default value: 5:0:0 */*/*

marketingstudio.version

The version number of Engage.

Do not change the value of this property.

page.time

Deprecated.

Default value: *:0,5,10,15,20,25,30,35,40,45,50,55:0 */*/*

propagatecache

Used to enable the propagation of pages among nodes that are enabled for the inCache page caching framework. Information about inCache can be found in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

rsCacheOverinCache

Used to switch between resultset caching media. This property is set to true by default, in which case WebCenter Sites caches resultsets in the inCache framework. When this property is set to false, WebCenter Sites caches resultsets in hash tables. Both caching media use the JVM memory.

This property is set to true during the WebCenter Sites installation process. The process also completes following steps:

- Places the linked-cache.xml configuration file in the application server's classpath (WEB-INF/classes directory).

- Sets the following resultset caching properties (see Section 9.15, "ResultSet Cache Tab"): cc.cacheResults cc.cacheResultsTimeout cc.cacheResultsAbs

When the installation process is complete, the System Tools node (on the Admin tab of the Admin interface) displays the resultset over inCache tool, which provides statistical information about the caches and their contents.

Note: Resultset caching over inCache works independently of page and asset caching over inCache. Information about the inCache framework, its caching models and system tools is available in the "System Tools" chapter in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide. Additional information about resultset caching is also available in the "Resultset Caching and Queries" chapter in the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

Default value: true

Possible values: true | false

rtd.choiceId.pattern

If the Oracle Real-Time Decisions (RTD) engine is integrated with WebCenter Sites, add this property to the futuretense.ini file. You can use this property to configure how the RTD dynamic choice ID values are constructed. Choice ID values are used in the RTD Decision Center as choice labels for assets. A choice ID pattern ensures that each asset has a unique choice ID, an asset will not appear more than once in the Decision Center, and that users can easily locate an item (asset) in the user interface of the Decision Center.

Default Value:

rtd.choiceId.pattern={assettype}:{name} ({assetid}

where {assettype} is the type of asset, {name} is the name of the asset, and {assetid} is the numeric ID of the asset.

rtd.host

If the Oracle Real-Time Decisions (RTD) engine is integrated with WebCenter Sites, add this tag to the futuretense.ini file and set the value as the URL on which Oracle RTD is running.

rtd.inline.service.name

If the Oracle Real-Time Decisions (RTD) engine is integrated with WebCenter Sites, add this tag to the futuretense.ini file and set the value as the name of the Oracle RTD inline service.

soap.binaryRowsType

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.iList

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.likeConstraint

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.listRowsType

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.nestedConstraint

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.rangeConstraint

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.richTextConstraint

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.searchstate

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.standardConstraint

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.stringRowsType

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.stringVarsType

Default value: com.openmarket.basic.objects.StringVarsType

soap.urlRowsType

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

soap.URLType

A WebCenter Sites system property used to instantiate server-side objects in response to SOAP requests made by web services.

Do not change the value of this property.

10 futuretense_xcel.ini

Properties in futuretense_xcel.ini are organized by function on the following tabs in the Property Editor:

- Analytics Tab

- Asset Default Tab

- Authorization Tab

- CoS Tab

- Debug Tab

- Directories Tab

- Element Override Tab

- Preference Tab

- Publishing Tab

- Transformer Tab

- xcelerate Tab

- User Management Tab

- User Defined Tab

Note:

WebCenter Sites also inserts custom properties into the "User Defined" tab in the futuretense.ini file, as described in Section 9.18, "User Defined Tab."

10.1 Analytics Tab

The Analytics tab holds properties that are used to configure Oracle WebCenter Sites: Analytics. These properties are documented here in alphabetical order:

Table 10-1 Properties in futuretense_xcel.ini: Analytics Tab

Property

Description

analytics.datacaptureurl

URL where the Analytics data capture servlet is running.

Syntax: http://<host>:<port>/sensor/statistic

analytics.enabled

Indicates whether Analytics is installed.

Legal values: true | false

analytics.piurl

URL where the Analytics performance indicator servlet is running.

Syntax: http://<host>:<port>/analytics/PI

analytics.reporturl

URL of the Analytics user interface.

Syntax: http://<host>:<port>/analytics/Report.do

analytics.user

Pre-configured Analytics user who logs in to Analytics from WebCenter Sites.

Default value: csuser

Note: Changing the default name is not recommended.

10.2 Asset Default Tab

The Asset Default tab holds properties that are used to define certain default details about asset types, such as cache information, default ACLs, and whether CKEditor is present. These properties are documented here in alphabetical order:

Table 10-2 Properties in futuretense_xcel.ini: Asset Default Tab

Property

Description

xcelerate.asset.shareToAllAllowed

Specifies whether the assets can be shared to all sites.

Legal values: true | false

xcelerate.asset.sizeofnamefield

Specifies the length of the Name field for basic and flex asset types.

Default value: 64

xcelerate.body.length

Specifies the number of characters that are stored for the Body field in the Article table in the urlbody column.

Data entered in the Body field for an article asset (a sample site asset type) is written to the urlbody column. Because this is a URL column, that data is actually stored as a file outside of the WebCenter Sites database.

However, the first <n> number of characters, where <n> equals the value specified for this property, is also stored in the body column so that you can search for text in the body of an article asset with the search feature in the WebCenter Sites interfaces.

Default value: 1000

Maximum values: 256 for Windows NT or Windows 2000; 2000 for UNIX.

If this property is missing or is not set, WebCenter Sites uses the value from the cc.maxvarcharsize property in the futuretense.ini file instead.

xcelerate.defaultacl

Specifies an ACL that is automatically assigned to page entries in the SiteCatalog table when they are created by the creation of SiteEntry or Template assets.

Default value: blank

xcelerate.defaultbase

Specifies the default base of defdir for assets.

xcelerate.defaultcscacheinfo

Specifies the default value for the "Cache Rule (ContentServer)" field of SiteEntry and Template assets that are enabled for caching. The value is displayed when the Advanced caching option is selected; the value can be overridden.

The "Cache Rule (ContentServer)" field maps to the cscacheinfo field in the SiteCatalog table, for each entry that corresponds to a SiteEntry asset or Template asset.

Default value: true,~0

xcelerate.defaultsscacheinfo

Specifies the default value for the "Cache Rule (Satellite)" field of SiteEntry and Template assets that are enabled for caching. The value is displayed when the Advanced caching option is selected; the value can be overridden.

The "Cache Rule (Satellite)" field maps to the sscacheinfo field in the SiteCatalog table, for each entry that corresponds to a SiteEntry asset or Template asset.

Default value: true,~0

xcelerate.defaultpagecriteria

Specifies the default value for the pagecriteria column for page entries in the SiteCatalog table when they are created via a Template asset.

Default value: c, cid, p, rendermode, site, context

For definitions of these variables and for more information about page criteria variables in general, see "Page Design and Caching" in the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

xcelerate.defaultcsstatus

Specifies the default value for the csstatus column for page entries in the SiteCatalog table when they are created (for either Template or SiteEntry assets).

Do not change the value of this property.

Default value: live

xcelerate.defaultpagecriteriaSiteEntry

Specifies the page criteria variables that can be set by default for SiteEntry assets. While you can add variables to this list, do not delete any of the default values.

Default value: rendermode, site, seid, Sitepfx

xcelerate.ewebeditpro

Deprecated. Not supported.

If your developers have designed asset types that use the eWebEditPro HTML editor, this property specifies the location of the ewebeditpro.js file.

xcelerate.MaxLinks

Specifies the number of links that could be included in a linkset, an old asset type that is no longer used.

10.3 Authorization Tab

Table 10-3 Properties in futuretense_xcel.ini: Authorization Tab

Property

Description

xcelerate.authorizefunctions

Contains a comma-separated list of functions for which permissions can be generated on an asset. If the value is empty, all possible functions will be displayed. Additional system-defined functions can be added to the list of default functions.

Default value: inspect, preview, checkout, copy, edit, delete, rollback, share, approve, build

xcelerate.deny.abstainfromvoting

Contains a comma-separated list of roles that are not allowed to abstain from voting when assigned assets as part of the workflow process.

Default value: blank

xcelerate.deny.approve

Contains a comma-separated list of roles that are not allowed to approve assets for publishing.

Default value: blank

xcelerate.deny.authorize

Contains a comma-separated list of roles that are not allowed to authorize privileges on assets.

Default value: blank

xcelerate.deny.build

Contains a comma-separated list of roles that are not allowed to build Collection assets.

Default value: blank

xcelerate.deny.checkout

Contains a comma-separated list of roles that are not allowed to checkout assets explicitly from the revision tracking system.

Default value: blank

xcelerate.deny.copy

Contains a comma-separated list of roles that are not allowed to copy assets.

Default value: blank

xcelerate.deny.delegate

Contains a comma-separated list of roles that are not allowed to delegate assigned assets to other participants in the workflow.

Default value: blank

xcelerate.deny.delete

Contains a comma-separated list of roles that are not allowed to delete assets.

Default value: blank

xcelerate.deny.edit

Contains a comma-separated list of roles that are not allowed to edit assets.

Default value: blank

xcelerate.deny.inspect

Contains a comma-separated list of roles that are not allowed to inspect assets.

Default value: blank

xcelerate.deny.placepage

Contains a comma-separated list of roles that are not allowed to place assets in the SitePlan tree.

Default value: blank

xcelerate.deny.preview

Contains a comma-separated list of roles that are not allowed to preview assets with their templates.

Default value: blank

xcelerate.deny.removefromgroup

Contains a comma-separated list of roles that are not allowed to remove assets from a workflow group.

Default value: blank

xcelerate.deny.removefromworkflow

Contains a comma-separated list of roles that are not allowed to remove assets from workflow.

Default value: blank

xcelerate.deny.rollback

Contains a comma-separated list of roles that are not allowed to roll back assets to a previous version.

Default value: blank

xcelerate.deny.setExportData

Contains a comma-separated list of roles that are not allowed to set export to disk (static publishing) starting point.

These users may still be allowed to approve and publish assets if some other users set the starting point.

Default value: blank

xcelerate.deny.setnestedworkflow

Contains a comma-separated list of roles that are not allowed to set nested workflow.

Default value: blank

xcelerate.deny.setparticipants

Contains a comma-separated list of roles that are not allowed to set participants for workflow.

Default value: blank

xcelerate.deny.setprocessdeadline

Contains a comma-separated list of roles that are not allowed to set workflow process deadlines.

Default value: blank

xcelerate.deny.setstepdeadline

Contains a comma-separated list of roles that are not allowed to set a deadline on a workflow step.

Default value: blank

xcelerate.deny.share

Contains a comma-separated list of roles that are not allowed to share assets with other sites (other than the site the asset was originally created in).

Default value: blank

xcelerate.deny.showparticipants

Contains a comma-separated list of roles that are not allowed to see the participants that are set for a workflow.

Default value: blank

xcelerate.deny.showstatus

Contains a comma-separated list of roles that are not allowed to see the status screen for assets.

The status option shows up in more … drop-down box of the inspect window. The screen shows workflow, publishing, and revision tracking information about the asset that is being inspected. If the user belongs to one of the roles that is being denied the privilege, the option to view the status screen will not show.

Default value: blank

xcelerate.deny.showversion

Contains a comma-separated list of roles that are not allowed to see the list of versions for an asset.

Note: User can view the list of versions for an asset that is explicitly or implicitly checked out. The inspect form will not display a Show Versions button if the user belongs to one of the roles that is denied the privilege.

Default value: blank

xcelerate.grant.abstainfromvoting

Contains a comma-separated list of roles that are allowed to abstain from voting when assigned assets as part of the workflow process.

Default value: blank

xcelerate.grant.approve

Contains a comma-separated list of roles that are allowed to approve assets for publishing.

Default value: blank

xcelerate.grant.authorize

Contains a comma-separated list of roles that are allowed to authorize privileges on assets.

Default value: SparkAdmin, GeneralAdmin, WorkflowAdmin, SiteAdmin

xcelerate.grant.build

Contains a comma-separated list of roles that are allowed to build Collection assets.

Default value: blank

xcelerate.grant.checkout

Contains a comma-separated list of roles that are allowed to checkout assets explicitly from the revision tracking system.

Default value: blank

xcelerate.grant.copy

Contains a comma-separated list of roles that are allowed to copy assets.

Default value: blank

xcelerate.grant.delegate

Contains a comma-separated list of roles that are allowed to delegate assigned assets to other participants in the workflow.

Default value: blank

xcelerate.grant.delete

Contains a comma-separated list of roles that are allowed to delete assets.

Default value: blank

xcelerate.grant.edit

Contains a comma-separated list of roles that are allowed to edit assets.

Default value: blank

xcelerate.grant.inspect

Contains a comma-separated list of roles that are allowed to inspect assets.

Default value: blank

xcelerate.grant.placepage

Contains a comma-separated list of roles that are allowed to place assets in the SitePlan tree.

Default value: blank

xcelerate.grant.preview

Contains a comma-separated list of roles that are not allowed to preview assets with their templates.

Default value: blank

xcelerate.grant.removefromgroup

Contains a comma-separated list of roles that are allowed to remove assets from a workflow group.

Default value: blank

xcelerate.grant.removefromworkflow

Contains a comma-separated list of roles that are allowed to remove assets from workflow.

Default value: blank

xcelerate.grant.rollback

Contains a comma-separated list of roles that are allowed to roll back assets to a previous version.

Default value: blank

xcelerate.grant.setExportData

Contains a comma-separated list of roles that are allowed to set export to disk (static publishing) starting point.

Default value: blank

xcelerate.grant.setnestedworkflow

Contains a comma-separated list of roles that are allowed to set nested workflow.

Default value: blank

xcelerate.grant.setparticipants

Contains a comma-separated list of roles that are allowed to set participants for workflow.

Default value: blank

xcelerate.grant.setprocessdeadline

Contains a comma-separated list of roles that are allowed to set workflow process deadlines.

Default value: blank

xcelerate.grant.setstepdeadline

Contains a comma-separated list of roles that are not allowed to set a deadline on a workflow step.

Default value: blank

xcelerate.grant.share

Contains a comma-separated list of roles that are allowed to share assets with other sites (other than the site the asset was originally created in).

Default value: blank

xcelerate.grant.showparticipants

Contains a comma-separated list of roles that are allowed to see the participants that are set for a workflow.

Default value: blank

xcelerate.grant.showstatus

Contains a comma-separated list of roles that are allowed to see the status screen for assets.

The status option shows up in the more … drop-down box of the inspect window. The screen shows workflow, publishing, and revision tracking information about the asset that is being inspected. If the user belongs to one of the roles that is being granted the privilege, the option to view the status screen will show.

Default value: blank

xcelerate.grant.showversion

Contains a comma-separated list of roles that are allowed to see the list of versions for an asset.

Note: The user can view the list of versions for an asset that is explicitly or implicitly checked out. The inspect form will display a Show Versions button if the user belongs to one of the roles that is granted the privilege.

Default value: blank

10.4 CoS Tab

The CoS tab holds properties for the Oracle WebCenter Sites: Community-Gadgets integration with the Oracle WebCenter Sites Contributor interface.

Table 10-4 Properties in futuretense_xcel.ini: CoS Tab

Property

Description

cg.management.url

Specifies the management URL for the Community-Gadgets web application. If you wish to integrate Community-Gadgets with the Contributor interface, (which enables users to work with assets of type CGGadget, CGWidget, and CGPoll in the Contributor interface), add the management URL for the Community-Gadgets web application to the end of the futuretense_xcel.ini file.

For information about working with assets of type CGGadget, CGWidget, and CGPoll, see the Oracle Fusion Middleware WebCenter Sites User's Guide.

cg.production.url

Specifies the production URL for the Community-Gadgets web application. If you wish to integrate Community-Gadgets with the Contributor interface, (which enables users to work with assets of type CGGadget, CGWidget, and CGPoll in the Contributor interface), add the production URL for the Community-Gadgets web application to the end of the futuretense_xcel.ini file.

For information about working with assets of type CGGadget, CGWidget, and CGPoll, see the Oracle Fusion Middleware WebCenter Sites User's Guide.

cos.hostname

Specifies the name of the host on which the Community-Gadgets web application is installed.

cos.portnumber

Specifies the port number for the Community-Gadgets web application.

fwblogs.cos.enabled

Specifies whether the Community-Gadgets web application was integrated with WebCenter Sites before the Community Blogs module was integrated with WebCenter Sites.

Possible values: TRUE | FALSE

10.5 Debug Tab

The Debug tab holds properties that enable the various WebCenter Sites debugging utilities.

Table 10-5 Properties in futuretense_xcel.ini: Debug Tab

Property

Description

am.debug

Specifies whether AssetMaker logs debugging information about the asset types it makes. When this property is set to on, information about the creation of asset types is written to the WebCenter Sites log file.

Default value: off

asset.debug

Specifies whether Desktop and the Export Assets to XML publishing method log debugging information when they manipulate assets. When this property is set to on, information about the manipulation of assets is written to the WebCenter Sites log file.

Default value: off

10.6 Directories Tab

The Directories tab holds properties that enable the various WebCenter Sites directories, such as utilities. These properties are documented here in alphabetical order.

Table 10-6 Properties in futuretense_xcel.ini: Directories Tab

Property

Description

xcelerate.locallanguagedir

Specifies the directory path of the Sites Desktop client installation.

This value is set by the WebCenter Sites installation.

Default value: C:/FutureTense/futuretense_cs/xcelerate/Client/ClientInstall/CSDesktop

xcelerate.lockdir

Specifies the directory path (including the final slash) to the directory where WebCenter Sites stores information about the locks that lock data during database operations. If this WebCenter Sites system is installed on a cluster, this directory must have write permissions for and be accessible to all cluster members.

This value is set by the WebCenter Sites installation.

Default value: c:/FutureTense/lock/

xcelerate.objpubdir

Specifies the path to a directory in cluster-shared file space (including the terminating slash character) in which objects that get published are stored temporarily.

This value is set by the WebCenter Sites installation.

Default value: C:/FutureTense/objpubdir/

xcelerate.pubkeydir

Specifies the directory where the publishing system writes information about the items that have been published to the various target systems.

This value is set by the WebCenter Sites installation.

Default value: c:/FutureTense/pubkeys/

xcelerate.saveSearchdir

Specifies the defdir (default storage directory) for the SaveSearch table. This table has a URL column that holds the saved searches on a development or management system.

This value is set by the WebCenter Sites installation.

Default value: c:/FutureTense/Storage/SaveSearch

xcelerate.sePath

Specifies the directory where search indexes are stored when you are using a search engine on your WebCenter Sites system.

If you change this value, be sure to specify a directory that exists. (This property does not create the directory for you.)

Legal values:

- Windows NT or Windows 2000: c:/FutureTense/sedb

- Solaris or AIX:/export/home/FutureTense/sedb

xcelerate.tempobjectsdir

Specifies the defdir (default storage directory) for the TempObjects table, a WebCenter Sites table that stores information about objects that are uploaded or in the process of being created until they are either saved or canceled.

This value is set by the WebCenter Sites installation.

Default value: c:/FutureTense/tempobjectsdir/

xcelerate.thumbnaildir

Specifies the directory where the template asset will store thumbnail images associated with template variant thumbnails.

This value is set by the WebCenter Sites installation.

Default value: C:/FutureTense/thumbnaildir/

xcelerate.workflowdir

Specifies the name of the directory that holds files related to workflow processes.

This value is set by the WebCenter Sites installation.

Default value: C:/FutureTense/workflowdir

If you change the value from the default, be sure that directory exists.

10.7 Element Override Tab

The Element Override tab holds properties that you can use to help customize the user interface. These properties are documented here in alphabetical order:

Table 10-7 Properties in futuretense_xcel.ini: Element Override Tab

Property

Description

xcelelem.manageuserpub

Defines the element that WebCenter Sites uses to manage the roles that users fulfill on sites in WebCenter Sites.

Default value: Openmarket/Xcelerate/Actions/Security/AccessUserPublication

xcelelem.publishfactors

The name of the element used to provide additional publishing control factors. May be empty.

Default value: Openmarket/Xcelerate/Actions/Publish/OverrideFactor

xcelelem.publishoptions

This property allows customization of a portion of the common options area of the publishing form.

It is used by the Action/Publish/PublishOptions element.

If this is defined, it names an element to call which will lay out the publishing options section of all the publishing forms.

Default value: empty

xcelelem.setpubid

Deprecated.

Specifies the name of the element that sets the pubid session variable when visitors first come to your site via a dynamic URL. It is run once per visitor session.

Default value: OpenMarket/Xcelerate/Actions/Publish/SetPubid

10.8 Preference Tab

The Preference tab holds properties that you use to configure the search feature, the tree, and the character set used on your system. These properties are documented here in alphabetical order.

Table 10-8 Properties in futuretense_xcel.ini: Preference Tab

Property

Description

cs.tree.defaultFunction.child

This property allows you to specify how a child asset will open when a user double-clicks a child tree node in the WebCenter Sites Contributor interface.

Legal values: open, inspect, edit

Default value: open

Note: If this property is set to open and a user double-clicks a child that is already open in a tab, that asset is displayed in the tab, in the view in which the asset is currently displayed. If the child is not currently open in a tab, the asset opens in its Inspect view.

cs.tree.defaultFunction.parent

This property allows you to specify how a parent asset will open when a use double-clicks a parent tree node in the WebCenter Sites Contributor interface.

Legal values: browse, open, inspect, edit

Default value: browse

Note: When this property is set to browse, double-clicking a parent tree node opens a Browse tab that lists all the child assets associated with that parent asset. If this property is set to open and a user double-clicks a parent that is already open in a tab, that parent is displayed in the tab, in the view in which the parent is currently displayed. If the parent is not currently open in a tab, the parent opens in its Inspect view.

xcelerate.charset

Specifies the character set that WebCenter Sites uses to communicate with the server.

Default value: UTF-8

Changing this property from the default value may limit the characters that are supported.

xcelerate.emailnotification

Deprecated.

Specifies whether the WebCenter Sites workflow e-mail notification feature is enabled.

When this property is set to true, the workflow system sends e-mail messages to users when assets are assigned to them through a workflow process.

Default value: false

For more information, see "Enabling the Email Feature" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.restrictSiteTree

Specifies whether users other than admin users can toggle the tree on in the WebCenter Sites Admin interface when it is configured to be toggled off by default (that is, the xcelerate.showSiteTree property is set to false).

Set to true to enable only users with the xceladmin ACL to be able to toggle the tree back on.

Default value: false

For more information about this feature, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.seLimit

Specifies the maximum number of query results that should be returned from any internally conducted search engine query.

Default value: 10000

xcelerate.showSiteTree

Specifies whether the tree is displayed by default when any user logs in to the WebCenter Sites Admin interface.

Set to false if you want the tree to be toggled off by default.

Default value: true

For more information about this feature, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.treehierassettype

Enables hierarchical display mode for SiteEntry, CSElement, Template, and Recommendation assets.

The value of this property is a comma-delimited list of asset types that should be displayed in a hierarchy.

Asset types whose assets should not be displayed in a hierarchy should not be included in the list.

The hierarchical structure is based on the "/" the in the asset name. Each "/" in the asset name represents one hierarchy level, e.g. "/AssetName" is the top level, "//AssetName" is the next level, and so on.

Default value: SiteEntry,CSElement,Template,Recommendation

xcelerate.treeMaxNodes

Specifies the number of items that are displayed under a node in the tree in the WebCenter Sites Admin interface. When a node has more than this number of items, WebCenter Sites prompts the user to enter search criteria to reduce the number.

Default value: 100

For more information about this feature, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.treeType

Specifies the kind of tree that is used in the WebCenter Sites Admin interface.

Legal values: OMTree or a value that specifies a customized replacement tree

Default value: OMTree

Do not change this property without first consulting Oracle support personnel.

xcelerate.usese

Specifies whether WebCenter Sites should use an installed search engine.

Legal values: true | false

Default value: false

10.9 Publishing Tab

The Publishing tab holds the properties that provide information to the WebCenter Sites publishing system, which also uses the properties in the futuretense.ini file (Export/Mirror tab). For descriptions of the properties, see Section 9.11, "Export/Mirror Tab."

Table 10-9 Properties in futuretense_xcel.ini: Publishing Tab

Property

Description

xcelerate.batchhost

Specifies the host name and port number of the server on which the publish process will run.

Only one batch host is supported in a clustered WebCenter Sites environment. This property must be set on each cluster member to point to the same dedicated host.

Legal values: <hostName>:<portNumber>

xcelerate.batchmode

Defines the batch publishing mode.

Legal values:

- single— batch host is a dedicated IP address.

- multiple— batch host is a cluster IP address.

Default value: single

xcelerate.batchloadsizeonpublish

Controls the batch size of assets loaded during a publishing event.

Default value: 250

xcelerate.batchpass

Specifies the password for the batch user.

Default value: xceladmin

Be sure to change this value after you create the batch user for this WebCenter Sites system. For information, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.batchsavesizeonpublish

Controls the batch size of assets saved during a publishing event.

Default value: 250

xcelerate.batchuser

The WebCenter Sites publishing system runs as a background process and you must configure a batch user account for the publishing system to use. This property specifies the user name of the batch user.

Default value: admin

Be sure to change this value after you create the batch user for this WebCenter Sites system. For information, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.blobref

The name of the class that manages the publish references for blobs. The default is provided here for reference only: com.openmarket.xcelerate.publish.BlobRef.

Do not change the value of this property.

For information about published references, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.bulkapprovechunk

Specifies the number of assets to approve at the same time, in the same batch or "chunk," when someone uses the Approve Multiple Assets feature in the WebCenter Sites Admin interface.

The feature approves all the assets that are selected for approval in batches and the number of assets in each batch is set by this property.

Default value: 500

For information about the Approve Multiple Assets feature, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

xcelerate.donotregenerate

Specifies whether cached pages are regenerated after a publishing session.

Legal values:

- blank, that is, no value—means that all the pages in the cache that were affected by the publish session are refreshed.

- unknowndeps—means that cached pages that were generated from an element that used a RENDER.UNKNOWNDEPS tag are not refreshed.

- * (asterisk)—means none of the pages in the cache are refreshed. In other words, the affected pages are refreshed only when a visitor requests the page.

Default value: blank

Do not change the value of this property without first consulting Oracle support personnel.

xcelerate.exportmaxfilename

This is the maximum length of any file name generated during export publishing.

If you are running Windows NTFS, you may want to set this to a low value to make it possible to re-export, delete or rename files created by the export-to-disk publish process. NTFS has an upper limit of 255 characters for any path name.

xcelerate.mirrorini

If you have had the element identified by the xcelerate.remotecall property modified in such a way that it needs information from additional property files other than futuretense.ini, this property specifies the names of all the property files that are needed.

Default value: futuretense.ini

Do not modify this value to include additional property files without consulting Oracle support personnel.

xcelerate.pageref

Specifies the name of the class that manages publish references for pages. The default is provided here for reference only:

com.openmarket.xcelerate.publish.PageRef.

Do not change the value of this property.

xcelerate.presaveelt

Specifies the name of the element called on the mirror target during publish after the assets' primary rows have been mirrored, but prior to the deserialization and asset.save of the flex and complex assets. Use PresaveElement for standard mirror publish.

xcelerate.pubabortelt

Specifies the name of the element called on the mirror target if the publish fails.

Default value: PubAbortElement for standard mirror publish.

xcelerate.pubcleanupelt

Specifies the name of the element that the publishing system uses during the cleanup phase of a mirror publish operation.

Default value: PubCleanupElement

Do not modify this value without consulting Oracle support personnel.

xcelerate.publishallassettypes

Specifies whether to publish all asset types on mirror publish.

Legal values: true | false

Default value: true

If set to true all asset types will be published.

If set to false, only asset types of the assets involved in the publish and their dependent asset types will be published.

Note: If you want to set this property to false, you have to make sure that all asset types that exist on the source server also exist on the publish destination.

xcelerate.publishinvalidate

Specifies whether an asset is marked as changed on the destination system when an asset is published. If it is marked as changed, it must be approved on that system before it can be published from that system to a new destination.

Legal values: true | false

Default value: true

Because having the publishing system take the time to mark the assets as changed on the destination adds time to the publishing session, typically you leave this property set to true on development and management systems but change it to false on delivery systems.

xcelerate.pubsetupelt

Specifies the name of the element that the publishing system uses during the setup phase of a mirror publish.

Default value: PubSetupElement

Do not modify this value without assistance from Oracle support personnel.

xcelerate.remotecall

Specifies the pagename that is invoked on the target system during a mirror publishing session.

Default value:

Openmarket/Xcelerate/PrologActions/Publish/Mirror1/RemoteCall

Do not modify this element or change the value of this property without assistance from Oracle support personnel.

xcelerate.templatedefault

The name of the template to use if a template cannot be found to render an asset type.

Default value: Openmarket/TemplateDefault

10.10 Transformer Tab

The Transformer tab holds the properties that apply to content created in Sites Desktop, where both text and a single image are saved to the same blob attribute, and format is preserved (i.e., both the text and the image are preserved when converted to an asset). The Oracle Fusion Middleware WebCenter Sites Administrator's Guide covers the remaining scenarios, such as a blob attribute holding data of a single type, for which setting a property is not required.

Table 10-10 Properties in futuretense_xcel.ini: Transformer Tab

Property

Description

transformer.imgdir

Specifies the path to the image files that Sites Desktop will use when transforming a Word document into an asset. This property applies only to assets created in Sites Desktop, where both text and a single image are saved to the same blob attribute, and format is preserved.

Note: This property is not set by the installer. Leaving it blank will cause Sites Desktop to ignore the <transformer.imgdir> directory and therefore omit image files from the assets it creates from Word documents.

When a blob attribute in a given asset type is enabled for Sites Desktop and it supports data of mixed types, users can save text and a single image to the blob attribute when they create or edit the Word document. When the Word document is saved, its content is transformed into an asset. During transformation, the image file is written to the <transformer.imgdir> directory, while the text is stored as HTML in the URL column in the WebCenter Sites database. The HTML file has an unmanaged link to the image in the <transformer.imgdir> directory. (The asset is accessible from the WebCenter Sites user interface; the Word document remains intact and available for editing through Sites Desktop.) Blob fields containing data of mixed types require you to implement a process that regularly mirrors the <transformer.imgdir> directory to the delivery system, because the publishing system does not mirror this directory.

To set the <transformer.imgdir> path

1. Define a webroot somewhere that points to a directory in a shared file system which is accessible from all cluster members.

2. Set transformer.imgurl to be either the relative URL path (starting with /) of the webroot you defined, or the absolute URL (starting with http) of the webroot.

3. Set transformer.imgdir to the directory path that the webroot points to.

For more information about the storage of content created (or edited) in Sites Desktop, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

transformer.imgurl

This property specifies either the relative URL path or the absolute path of the webroot that Sites Desktop will use to store the image files it extracts from Word documents when converting the Word documents to assets. (The Word documents remain intact.)

Note: This property is used with the transformer.imgdir property and applies only to assets created in Sites Desktop, where both text and a single image are saved to the same blob attribute, and the format is preserved.

This property is not set by the installer. Leaving it blank will cause Sites Desktop to ignore the directory containing the image files (<transformer.imgdir>) and therefore omit image files from the assets it creates from Word documents.

For more information about the usage of this property, see transformer.imgdir.

10.11 xcelerate Tab

The xcelerate tab holds the properties that specify such things as default administrative settings, whether Web Mode (in the Site Contributor interface) is enabled, whether workflow configuration and search engine are being used, and whether LDAP is being used. These properties are documented here in alphabetical order:

Table 10-11 Properties in futuretense_xcel.ini: xcelerate Tab

Property

Description

cs.binarypath

Set at installation time. This property points to the location where WebCenter Sites and third-party binaries (shared objects) are stored.

Note: Do not change the value of this property.

wem.enabled

This is a system property. Its value must not be changed except by the silent or GUI installer.

Default value: true

(given that the WEM Framework is installed by default.)

xcelerate.adminacl

Specifies the ACL that users must be assigned so they can access administrator functions (that is, any of the functions that appear on the Admin tab in the WebCenter Sites Admin interface).

Default value: xceladmin

If you change the value of this property to a different ACL, be sure to assign that ACL to all the tables that currently have the xceladmin ACL assigned to them.

xcelerate.adminrole

Specifies an ACL that is set for all administrative tables during installation.

Default value: xceladmin

Do not change the value of this property after your system is installed.

xcelerate.approval.dependency.chunksize

This property defines the chunk size used in approval. (Chunk size is the number of assets that are processed by WebCenter Sites at a given time during approval to publish. Processing involves calculating dependencies.)

Default value: 250 (for backward compatibility)

Legal values: any integer between 1 and 1000

Recommended value: 1

xcelerate.base

Specifies the top-level (base) directory of the WebCenter Sites elements. During installation, the installer might need to edit this value to indicate where the WebCenter Sites elements are in your installation.

Default value:

- Windows NT or Windows 2000: c:/Fatwire/elements/OpenMarket/Xcelerate

- Solaris or AIX: /export/home/Fatwire/elements/OpenMarket/Xcelerate

Do not change the value of this property after your system is installed.

xcelerate.crosssiteassign

Specifies whether users from more than one site can participate in the same workflow process.

Legal values: true | false

Default value: false

xcelerate.defaultlang

Specifies the default language.

Default value: en_US

xcelerate.defaultpreviewurlgenerator

Set to the preview generator name to generate URLs for preview, if no site-specific one is described.

xcelerate.domain

Specifies the domain name of the system, not including the server (machine) name. This property is used by applications that have been integrated with WebCenter Sites and that have a browser interface.

xcelerate.editrole

Specifies an ACL that is set for editorial tables during installation.

Default value: xceleditor

Do not change the value of this property after your system is installed.

xcelerate.enableinsite

Enables or disables Web Mode (in the Sites Contributor interface) for this WebCenter Sites system. A value of true enables Web Mode.

Default value: false

Do not enable Web Mode on your WebCenter Sites delivery system.

xcelerate.imageurl

Specifies the webroot for all image URLs used by the applications.

xcelerate.previewhost

One of two properties that enable the preview host feature, this property defines the protocol, server, and port for the preview host to use.

For information about this feature, see "Maintaining Separate Browser Sessions for Preview" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

If you provide a value for this property, use the following syntax:

http://<servername>:<port>

xcelerate.previewservlet

One of two properties that enable the preview host feature, this property specifies which servlet the preview host should use.

For information about this feature, see "Maintaining Separate Browser Sessions for Preview" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

Legal values: ContentServer or Satellite

Default value: Satellite

xcelerate.previewurlpagename

Set to the name of page to generate URLs for preview.

Do not change the value of this property.

xcelerate.publishquerystyle

Defines the query style to use when getting a list of assets approved for publishing.

Legal values: subquery,join

xcelerate.rolemanagerclass

Specifies the name of the role manager class. By default, the value of this property is set to the WebCenter Sites role management system.

Default value: com.openmarket.xcelerate.roles.RoleManager

- If you are using a Sun ONE embedded Identity Server, set this property to the following value, exactly: com.openmarket.xcelerate.roles.IdentityServerRoleManager

- If you are using a WebLogic embedded LDAP, set this property to the following value, exactly: com.openmarket.xcelerate.roles.FlatLDAPRoleManager

xcelerate.searchResultCols

Specifies which columns are displayed in the search results list in the WebCenter Sites Admin interface. (Custom columns cannot be added.)

Default value: name,modified,locale,startDate,endDate,assetType

Additional values: description,status

Note: Column names are case sensitive. The column order specified in this property does not affect the actual column order in the search results list. The actual order (by column display name) is Name, Description, Type (here, Type denotes assetType), Locale, Status, Modified, Start Date, End Date.

xcelerate.systemid

Specifies the identifier for this WebCenter Sites system. It is used for generating unique identifiers for exported data.

Select a value that is different from the IDs of all other known WebCenter Sites systems. Otherwise, ID conflicts will arise.

Default value: CSSystem

Legal values: any alphanumeric string of 1–255 characters

xcelerate.transformpath

Set at installation time. This property sets the path to the directory where Sites Desktop temporarily stores the Microsoft Word files that WebCenter Sites will transform into assets.

Note: Do not change the value of this property.

xcelerate.treetabmanagerclass

The class that implements ITreeTabManager to provide tree tab descriptions for WebCenter Sites.

Default value: com.openmarket.xcelerate.treetab.TreeTabManager

The default is provided here for reference only. Do not change the value of this property.

xcelerate.usermanagerclass

The class that implements IUserManager to provide user services for WebCenter Sites.

Default value: com.openmarket.xcelerate.user.UserManager

- If you want to implement LDAP attribute-mapping for site and role names, set this property to the following value, exactly: com.openmarket.xcelerate.user. LDAPSchemaUserManager

- If you are using a WebLogic or Sun ONE Application Server embedded LDAP, set this property to the following value, exactly: com.openmarket.xcelerate.user. FlatLDAPSchemaUserManager

xcelerate.workflowengineclass

The class that implements IWorkflowEngine to provide workflow services for WebCenter Sites. The default is provided here for reference only:

com.openmarket.xcelerate.workflow.WorkflowEngine

Do not change the value of this property.

10.12 User Management Tab

The User Management tab holds the properties that specify various user attribute names, which hold different information about the user, such as the list of roles that the user has for a publication, the screen name that the user uses, and the list of sites for which the user is enabled.

Table 10-12 Properties in futuretense_xcel.ini: User Management Tab

Property

Description

xcelerate.displayablenameattr

Specifies the name of the user attribute describing the displayable name, if different from the login name.

xcelerate.emailattr

Specifies the name of the user attribute that is used to identify a user's e-mail address to your WebCenter Sites system. These attributes are kept in the SystemUserAttr table.

Default value: mail

xcelerate.localeattr

Specifies the name of the user attribute that identifies the locale that a user specifies if you have more than one language pack installed on your WebCenter Sites system.

Default value:

- Blank when one language is present.

- locale when more than one language is present.

xcelerate.pubrolesattr

Specifies the name of the user attribute that lists the roles that the user has for publication.

This property is only used if xcelerate.usermanagerclass is set to com.openmarket.xcelerate.user. LDAPAttrUserManager

This is combined with the publication id to obtain the attribute name containing the roles the user has for the publication.

If value is not set, the UserPublication table is used, or some other LDAP User Manager Plug-in is used.

xcelerate.sitenameattr

Specifies the naming attribute of the site entries.

This property is only used if xcelerate.usermanagerclass is set to com.openmarket.xcelerate.user.LDAPSchemaUserManager.

By default, this value is blank, which means that information about a user's roles is stored in the UserPublication table, or some other LDAP User Manager plug-in is used.

If there is a value specified for this property, the xcelerate.usermanagerclass, and xcelerate.sitesroot properties must also be configured correctly.

xcelerate.sitesattr

Specifies the name of the user attribute describing which publications the user has roles for.

This property is used only if xcelerate.usermanagerclass is set to com.openmarket.xcelerate.user.LDAPAttrUserManager.

If there is a value for this property, it is combined with the value of the pubid column and the value for the xclerate.pubroleattr property to determine a user's access rights in the WebCenter Sites interface.

By default, this value is blank, which means that information about a user's roles is stored in the UserPublication table, or some other LDAP User Manager plug-in is used.

xcelerate.sitesroot

Specifies the root node (dn) under which sites are located.

This property is used only if xcelerate.usermanagerclass is set to com.openmarket.xcelerate.user.LDAPSchemaUserManager.

By default, this value is blank, which means that information about a user's roles is stored in the UserPublication table, or some other LDAP User Manager plug-in is used.

If there is a value specified for this property, the xcelerate.usermanagerclass and xcelerate.sitenameattr properties must also be configured correctly.

xcelerate.userimageattr

This property points to the imagesrc attribute in the WEM Framework user's account (accessible from the WEM Admin interface). The attribute contains image data in a base 64 encoded string. This property fetches the image.

10.13 User Defined Tab

Table 10-13 Properties in futuretense_xcel.ini: User Defined Tab

Property

Description

xcelerate.ckeditor.basepath

CKEditor basepath; that is, the location of the CKEditor files in the WebCenter Sites application.

Default value: /<URI>/ckEditor/

ckeditor.showIncludedElementInSpan

Controls how CKEditor behaves when you include assets within text.

When you include assets that use <div> tags, CKEditor does not change them to <span> tags.

If you want CKEditor to change <div> tags to <span> tags, add this property and set it to true.

xcelerate.imageeditor.basepath

Online Image Editor (OIE) basepath; that is, the OIE archive location (relative URL), file name, and version.

Default value: <URI>/ImageEditor/OIE.cab#version=3,0,1,10

xcelerate.imageeditor.clarkii.basepath

Path to the Clarkii Online Image Editor files in the WebCenter Sites application.

Default value: <application_context_ root>/ImageEditor/clarkii/

xcelerate.useDimensionAssets

This property is supported only on delivery systems. This property controls whether a WebCenter Sites delivery system queries the Dim and DimP database tables for Dimension assets.

If you do not use Dimension assets (i.e., for multilingual support), do the following to prevent your delivery system from unnecessarily querying the Dim and DimP tables:

1. Add this property to futuretense_xcel.ini and set it to false.

2. Set -Dcs.disable.dimensions.in.ui for the JVM to true in the application server startup script.

advancedUI.enableAssetForms

Used to enable and disable the WebCenter Sites Admin interface for content contributors. Access to the following assets is affected:

- All flex assets and their parent assets

- All basic assets

- Engage assets, such as recommendations, segments and promotions

- Query, Collection, and Page assets

By default, this property is set to false, which disables the WebCenter Sites Admin interface for content contributors. The assets listed above cannot be created, edited, searched for, or deleted, except from the WebCenter Sites Contributor interface, where they are supported by default.

Note: In the Contributor interface, asset types and assets intended for developers are either available only for inspection or they are inaccessible. They must be accessed from the WebCenter Sites Admin interface.

Default value: false

cos.protocol

Specifies the name of the protocol on which the Community-Gadgets web application is installed.

cos.contextroot

Specifies the name of the context root on which the Community-Gadgets application is installed.

11 gator.ini

Properties in gator.ini are organized by function on the following tabs in the Property Editor:

- Gator Tab

- User Defined Tab

11.1 Gator Tab

Table 11-1 Properties in gator.ini: Gator Tab

Property

Description

cc.attrDisplayStyle

The field to display (name or description) to describe attributes on a FlexAsset or FlexGroup ContentForm or ContentDetails screen.

Possible values: name or description

Default value: name

cc.attributeinheritance

A boolean that Gator uses to determine whether attributes should be inherited from parent to child.

Default value: true

cc.extrapath

A boolean that Gator uses to determine if blobs should have extra path information prepended to avoid directory capacity issues on Unix.

Default value: true

cc.fullconstraint

A boolean that Gator uses to determine if nested queries should include data from the outer query.

Possible values: true | false

Default value: true

cc.money

The sql for defining a field that will contain monetary values. Choose the default or contact your database administrator.

Default value: NUMERIC(20,3)

Do not change this value without consulting your database administrator.

cc.querystyle

A boolean that Gator uses to determine which basic form of assetset query to generate.

Possible values: subquery, join, or intersect

Default value: subquery

Note that setting the value of this property to intersect functions only if your database can support intersection queries.

cc.string

The sql for defining a field that will contain string values.

Default value: SEARCHVARCHAR

Do not change this value without consulting your database administrator.

cc.textdistinct

A boolean describing whether your database can support DISTINCT on attributes of type TEXT.

Default value: no

cc.url

The sql for defining a field that will contain URLs.

Default value: VARCHAR(128)

Do not change this value without consulting your database administrator.

cc.urlattrpath

Specifies the default base path Gator uses for URL attribute files.

Default value: c:/futuretense/futuretense_cs/urlfiles

cc.useLegacyInputNames

Specifies the boolean that Gator uses to determine the input names of attributes on FlexAsset/Parent forms. Turn this property on if you need to support custom attribute editors that have not been updated to the new format.

Default value: false

mwb.assetsetclass

Specifies the name of the class that supplies the services for assetset management.

Default value: com.openmarket.gator.assetset.AssetSet

Do not change the value of this property. The default is provided here for reference only.

mwb.cartclass

The name of the class that supplies the services for cart management.

Default value: com.openmarket.catalog.cart.Cart

Do not change the value of this property. The default is provided here for reference only.

mwb.cartsetclass

Specifies the name of the class that supplies the services for cart set management.

Default value: com.openmarket.catalog.cartset.CartSet

Do not change the value of this property. The default is provided here for reference only.

mwb.commercecontextclass

Specifies the name of the class that supplies the services for commerce context.

Default value: com.openmarket.gator.commercecontext.CommerceContext

Do not change the value of this property. The default is provided here for reference only.

mwb.commerceengineclass

Specifies the name of the class that supplies the services for commerce engine management.

Default value: com.openmarket.cscommerce.txcart.TransactEngine

mwb.commerceuserclass

Specifies the name of the class that supplies the services for commerce user management.

Default value: com.openmarket.catalog.cart.CommerceUser

mwb.conservativedependencies

Specifies the types of dependencies between:

- flex assets and flex attributes

- flex assets and flex definitions

If you want dependencies to be exact between flex assets and flex attributes, and between flex assets and flex definitions, then set this property to true. For information about exact and exists dependencies, see "The Approval System" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

Default value: false

mwb.defaultattributes

Specifies the default attribute asset name for Gator to use when creating assetsets.

Default value: blank

mwb.externalattributes

Specifies a boolean that Gator uses to determine if forms should allow users to define external attributes.

Default value: true

mwb.path

Specifies the directory where Gator is installed. Be sure to end the directory with a forward slash ( / ).

Default value: c:/nas21/apps/

Do not change the value of this property.

mwb.promotioncutoff

Specifies the confidence rating that determines whether a visitor qualifies for a promotion.

Possible values: integers between 0 and 100, inclusive

Default value: 50

Do not change the value of this property.

mwb.searchdir

Specifies the directory where Gator places rich-text indexes. Be sure to end the directory with a forward slash ( / ).

Default value: c:/futuretense/gator/search/

Do not change the value of this property.

mwb.searchstateclass

Specifies the name of the class that supplies the services for search state management.

Default value: com.openmarket.gator.searchstate.SearchState

Do not change the value of this property. The default is provided here for reference only.

mwb.segmentcutoff

The confidence rating that determines whether to include a visitor in a segment.

Possible values: integers between 0 and 100, inclusive.

Default value: 50

Do not change the value of this property.

11.2 User Defined Tab

Table 11-2 Properties in gator.ini: User Defined Tab

Property

Description

This tab, by default, has no properties.

N/A

12 log4j.properties

Apache log4j is used as the logging system in new WebCenter Sites 11gR1 installations.

Note:

While Apache log4j is supported in the process of upgrading to WebCenter Sites 11gR1, installation engineers have the option to continue using Jakarta Commons Logging if the source system (FatWire Content Server 7.6 patch 1 or patch 2) was set to use Jakarta Commons Logging. Once a system is upgraded, switching to Apache log4j becomes a manual process, as described in "Setting Up Apache log4j" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

When Apache log4j is set up, two files are configured:

- The commons-logging.properties file, in which the property org.apache.commons.logging.Log is set to specify the Log4JLogger (its value is the class name com.fatwire.cs.core.logging.Log4JLogger).

- The log4j.properties file is created to specify how information must be logged and which type of information will be logged. The log4j.properties file contains the following entries:

- A set of appenders named FWDefaultAppender, which specify how information must be logged. For example, the property FWDefaultAppender.File specifies the WebCenter Sites log file and its location. The list of properties is available in "Configure log4j" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide. For descriptions of these and other log4j-specific properties, see the Apache log4j documentation.

- WebCenter Sites loggers, which determine the type of information that will be logged and at which severity level. The loggers are copied from the commons-logging.properties file (see Chapter 5, "commons-logging.properties") to the log4j.properties file and their names are prefaced with log4j.logger.

For example, in the commons-logging.properties file, the following logger is used to specify the log severity for messages related to database access, queries, and statement execution:

logger.com.fatwire.logging.cs.db

When copied to the log4j.properties file, the logger is named as follows:

log4j.logger.com.fatwire.logging.cs.db

For descriptions of WebCenter Sites loggers, see Chapter 5, "commons-logging.properties."

When log4j is set up, the WebCenter Sites Admin interface displays the Configure log4j tool in the System Tools node, on the Admin tab. The Configure log4j tool enables general administrators to view current loggers, temporarily change logger levels, and add new loggers directly from the administrator's interface. Changes made from the Admin interface remain in effect only until WebCenter Sites is restarted. They will persist upon restart only if the text version of the logger properties is copied from the interface to the log4j.properties file. (Changes that are made directly in the log4j.properties file will not be applied to WebCenter Sites until the system is restarted.) For more information about the Configure log4j tool, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

13 logging.ini (Deprecated)

The logging.ini file holds properties that configure the Logging module. The Logging module writes messages to the futuretense.txt file.

Note:

The Logging module is deprecated. It is used only by the Directory Services API.

Properties in the logging.ini file are organized by function on the following tabs in the Property Editor:

- Global Data Tab

- Message Resources Tab

- User Defined Tab

13.1 Global Data Tab

The Global Data tab holds one property:

Table 13-1 Properties in logging.ini: Global Data Tab

Property

Description

log.filterLevel

Deprecated.

The severity threshold that determines the amount of messages that the Logging module writes to the log.

Possible values:

- info: writes all informational, warning, error, severe, and fatal messages.

- warning: excludes informational messages; writes warning, error, severe, and fatal messages.

- error: excludes warning and informational messages; writes error, severe, and fatal messages.

- severe: excludes error, warning, and informational messages; writes severe and fatal messages.

- fatal: writes fatal messages only.

13.2 Message Resources Tab

The Message Resources tab holds properties that provide logical mappings for the message bundles that are located, delivered, and reported by the Logging Module when the module is invoked by various components of the applications.

Caution:

Do not change the values of any properties on this tab.

Table 13-2 Properties in logging.ini: Message Resources Tab

Property

Description

log.Directory.messages

Deprecated.

Java resource bundle to use for the Directory Services API.

Default value: com.openmarket.directory.DirectoryResources

Do not change the value of this property.

log.Logger.messages

Deprecated.

Java resource bundle to use for the Logging module.

Default value: com.openmarket.logging.LoggerMessageResources

Do not change the value of this property

log.transformer.messages

Deprecated.

Class that provides message resources for the Default Transformer WebMethodsEnterprise Connector Subsystem.

log.wmentconnector.messages

Deprecated.

Class that provides message resources for the WebMethodsEnterprise Connector System.

13.3 User Defined Tab

Table 13-3 Properties in logging.ini: User Defined Tab

Property

Description

This tab, by default, holds no properties.

N/A

14 omii.ini

The omii.ini file is a system-specific file. It is created during the installation of WebCenter Sites to record the installation conditions and options that are chosen for WebCenter Sites.

Caution:

The omii.ini file is used by the WebCenter Sites installer during re-installations and upgrades. Do not modify this file in any way.

14.1 omproduct.ini

The omproduct.ini file is a system-specific file. It is created during the installation of WebCenter Sites to record information about the Oracle products and sample site components that are chosen for installation with WebCenter Sites.

Caution:

The omproduct.ini file is used by the WebCenter Sites installer during re-installations and upgrades. Do not modify this file in any way.

15 satellite.properties

The satellite.properties file is created on each WebCenter Sites system because each WebCenter Sites system runs a Satellite servlet. When the Satellite servlet is running in the same virtual machine as the ContentServer servlet, it is said to be "co-resident." Otherwise, it is remote.

satellite.properties is on each server that hosts a Satellite Server application. The function of satellite.properties is to configure the Satellite servlet that it controls.

Properties in the satellite.properties file are organized by function on the following tabs in the Property Editor:

- Caching Tab

- Configuration Tab

- Remote Host Tab

- Sessions Tab

- User Defined Tab

15.1 Caching Tab

The Caching tab holds the Satellite Server cache settings.

The file_size property can significantly influence performance. To optimize performance, try to maximize the amount of memory caching. However, be sure that you do not exceed the host's memory capacity.

If you have lots of memory or a relatively small web site, Oracle recommends caching everything to memory by setting a large value. However, in calculating whether your entire web site can fit in memory, remember that expired web pages stay in memory until explicitly removed or until the cache cleaning thread removes them. Be sure to consider this fact when you set the value of the cache_check_interval property.

Table 15-1 Properties in satellite.properties: Caching Tab

Property

Description

cache_check_interval

Deprecated.

Applies to only legacy page caching. This property controls the frequency of the cache cleaner thread. Expired objects are not pruned from cache when they expire. They are pruned either when they are requested and found invalid, or when a cache cleaner thread explicitly prunes them.

In minutes, specify the pause between executions of the cache cleaner thread.

cache_folder

Applies to only legacy page caching. This property specifies the location of disk based cache data. If this property is left blank, cached data will be stored in the context's temp folder.

Default value: blank

cache_max

Applies to only legacy page caching. This property specifies the maximum number of objects to maintain in the cache. Objects are removed from the cache if the size specified is exceeded; an LRU method is used to manage cache size limits.

expiration

Applies to inCache page caching and legacy page caching. This property specifies expiration information (in the form of a COM.FutureTense.Util.TimePattern string) for all cached objects that do not have this information specified elsewhere.

The expiration information for an object can be specified in the cachecontrol attribute on the satellite.page (and related) tags. For pages, expiration information can also be specified in the SiteCatalog's sscacheinfo column. For binary objects, the default value for the cachecontrol attribute is specified in the futuretense.ini file.

Note that the outermost wrapper page of any request cannot specify an override, so this property is the only place where it can be controlled.

Default value: 5:0:0 */*/*

This means that everything in the Satellite Server cache expires every day at 5:00 a.m.

The format is as follows:

<hours>:<minutes>:<seconds> <daysOfWeek>/<daysOfMonth>/<months>

Possible values:

- <hours>: 0 through 23, where 0 is midnight

- <minutes>: 0 through 59

- <seconds>: 0 through 59

- <daysOfWeek>: 0 through 6, where 0 is Sunday

- <daysOfMonth>: 1 through 31

- <months>: 1 through 12

Other possible values:

- never, which means the page can expire only if the cache is full and it is the least recently used page

- immediate, which means to never cache the page

file_size

Applies to legacy page caching. This property specifies the size (in kilobytes) of objects that can be cached to disk. Smaller objects are retained in memory.

This value should be adjusted for system RAM, disk speed, and so on.

Default value: 250

15.2 Configuration Tab

The Configuration tab holds the properties that configure the Satellite servlet.

Table 15-2 Properties in satellite.properties: Configuration Tab

Property

Description

blocktimeout

Deprecated.

Specifies the number of seconds a request will wait when another thread is in the process of requesting the same data from the host. Waiting helps reduce load on the host server when the cache is empty at the expense of individual user response time.

Default value: 45

A value of -1 means wait until the previous thread returns. A value of 0 means never wait.

This value must be tuned based on the host performance, average request size, and network latency.

It is safe to use a large number or -1.

password

Specifies the password that the Satellite engine will require for special functions like engine restart or cache reset.

Be sure to change the username and password from the defaults.

readtimeout

Deprecated.

Specifies the socket read timeout in seconds, after which a read terminates with an error. A value of 0 leaves the timeout to the Java runtime environment. A value of 3 sets a 3-second wait time.

Default value: 45

transparent.content-type.pattern

A regular expression denoting content types that may contain nested components such as pagelets, links to other WebCenter Sites pages, or links to blobs. Pages whose content types match this pattern will be parsed by Satellite Server.

servlet

Specifies the URL pattern used to identify the Satellite Server servlet. Satellite Server will rewrite links and forms to use this URL pattern if pages are properly designed.

Default value: Satellite

username

Specifies the username that the Satellite engine will require for special functions like engine restart or cache reset.

Be sure to change the username and password from the defaults.

15.3 Remote Host Tab

The Remote Host tab holds properties that define the communications rules between Satellite Server and WebCenter Sites. These properties are documented here in alphabetical order:

Table 15-3 Properties in satellite.properties: Remote Host Tab

Property

Description

bservice

This value is the servlet path for the Blob Server servlet. It is used to tell Satellite Server where to go to resolve satellite.blob tags.

Typical values include /NASApp/cs/BlobServer for iPlanet and /servlet/BlobServer for servlet runners.

host

The name of the remote host system running WebCenter Sites that the Satellite engine is caching requests for.

This is required and there is no default.

port

The port number for communicating with the WebCenter Sites host.

Default value: 80

protocol

The communication protocol between the Satellite Server host and the WebCenter Sites host. (Generally http:// or https://).

Note that setting the protocol to https:// will not, in itself, ensure secure communications. You will still need to get a certificate.

service

This value is the servlet path for the WebCenter Sites servlet.

It is used to tell Satellite Server where to go to resolve satellite.page tags.

Typical values include /NASApp/cs/ContentServer for iPlanet and /servlet/ContentServer for servlet runners.

15.4 Sessions Tab

The Sessions tab holds properties that provide information about how the Satellite servlet should interpret a user's browser session.

Table 15-4 Properties in satellite.properties: Sessions Tab

Property

Description

contentserver.installation.folder

Replaces the path.to.futuretense.ini property.

Applies to installations in which Satellite Server and WebCenter Sites are running in the same web application and must therefore share the user's session. This property specifies the path to the WebCenter Sites installation, enabling Satellite Server to access WebCenter Sites resources, such as the system asset root and the futuretense.ini file.

Possible values:

- blank, if Satellite Server is running in a web application other than WebCenter Sites.

- <cs_installation_dir> if Satellite Server is running in the same web application as WebCenter Sites. This directory contains the futuretense.ini file.

cookieprefix

Satellite Server maintains a session between itself and the remote host on behalf of the client. Satellite Server needs to know the name of the session ID cookie the application server uses so that it can be properly tracked.

Enter the possible session cookie name prefixes here, separated by a semicolon. If left blank, a default set will be used.

path.to.futuretense.ini

Replaced with: contentserver.installation.folder.

sessionid.cookie.prefix

Users can now specify the prefix that is prepended to the session id cookie.

The session id cookie is the session id cookie for the host (i.e., WebCenter Sites). Satellite Server needs to pass the session id cookie to the client in order to maintain a session between WebCenter Sites and the client.

The cookie must be renamed, so it does not conflict with the session cookie that Satellite Server itself uses. The configurable prefix allows users who know the name of the session id cookie to construct the full cookie name. This can be used in a servlet filter or other mechanism to support custom functionality.

sharesession

Specifies whether the ContentServer servlet and the Satellite servlet share the user session.

If Satellite Server is running remotely, set this to false; if Satellite Server and ContentServer are co-resident, set this property to true.

If this property is not set appropriately, user-specific information may be inconsistent between pages.

15.5 Compatibility Tab

Table 15-5 Properties in satellite.properties: Compatibility Tab

Property

Description

formaction

The Satellite servlet converts WebCenter Sites URLs that you GET or POST to into Satellite URLs. This property specifies which string to replace in the WebCenter Sites URL to create a Satellite URL.

This value is case sensitive.

Effective in Satellite Server 6, use the new satellite.form tag for all forms.

newformaction

Specifies the replacement string in URLs to be GET'ed or POST'ed to the locally mapped servlet.

This value is case sensitive.

Effective in Satellite Server 6, use the new satellite.form tag for all forms.

globally_replace_contentserver

If this property is set to true, Satellite Server will parse through all processable pages returned from WebCenter Sites and replace all instances of the string described by the formaction property with the string described by the newformaction property. It will also replace any occurrence of ContentServer with the string described by the servlet property.

Effective in Satellite Server 6, use satellite.link or RENDER.GETPAGEURL for links and satellite.form for forms. If this is not possible, set this property to true.

Default value: false

15.6 User Defined Tab

Table 15-6 Properties in satellite.properties: User Defined Tab

Property

Description

appserverlink

Deprecated.

Value: 45

servlet-path

Deprecated.

Value: /spark/

propagatecache

Used to enable the propagation of pages among nodes that are enabled for inCache page caching. Information about inCache can be found in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

scratch.cleanup.schedule

Specifies the frequency, in minutes, of the event that runs to clean up files in the Scratch folder generated by Satellite Server caching. The frequency should be determined from the volume of pages loaded into cache and the file_size property (in the satellite.properties file).

The default location of the Scratch folder depends on the application server. The path can be configured by setting the cache_folder property (in the satellite.properties file).

Default value: 2

16 ServletRequest.properties

The ServletRequest.properties file holds properties that specify configurations for certain types of requests (for example, a portal request or a Satellite Server request).

Properties in the ServletRequest.properties file are organized by function on the following tabs in the Property Editor:

- Request Encoding Tab

- Request Threshold Tab

- URI Assembler Tab

- User Defined Tab

16.1 Request Encoding Tab

Table 16-1 Properties in ServletRequest.properties: Request Encoding Tab

Property

Description

cs.charset

The name of the optional parameter that defines the character encoding of the input.

cs.contenttype

The default content type string used when streaming text. For example:

For UTF-8: text/html; charset=UTF-8 for UTF-8

For Latin1: text/html; charset=iso-8859-1

Default value:

text/html

cs.contenttype. UTF-8

The preferred content type string used when decoding incoming http parameters. This property is designed for use with Japanese language installations, where the user intends to override shift_jis with a special encoding.

For example: In Japanese environments with encoding such as Cp943C, set the value to: cs.contenttype.shift_jis=Cp943C

Default value: set by cs.contenttype

16.2 Request Threshold Tab

Table 16-2 Properties in ServletRequest.properties: Request Threshold Tab

Property

Description

cs.disksize

Defines the maximum size of a binary blob in a page request that will be held in memory. Anything exceeding this size will be saved in a temporary file until it is needed.

16.3 URI Assembler Tab

Table 16-3 Properties in ServletRequest.properties: Request Encoding Tab

Property

Description

path.BlobServer

The servlet context path for the Blob Server servlet.

Typical values:

/cs/BlobServer

/servlet/BlobServer

path.CacheServer

The servlet context path for the Cache Server servlet.

Typical values:

/cs/CacheServer

/servlet/CacheServer

path.CatalogManager

The servlet context path for the Catalog Manager servlet.

Typical values:

/cs/CatalogManager

/servlet/CatalogManager

path.ContentServer

The servlet context path for the ContentServer servlet.

Typical values:

/cs/ContentServer

/servlet/ContentServer

path.CookieServer

The servlet context path for the Cookie Server servlet.

Typical values:

/cs/CookieServer

/servlet/CookieServer

path.DispatchManager

The servlet context path for the Dispatch Manager servlet.

Typical values:

/cs/DispatchManager

/servlet/DispatchManager

path.PageDispatchServer

The servlet context path for the Page Dispatch Server servlet.

Typical values:

/cs/PageDispatchServer

/servlet/PageDispatchServer

path.SatelliteServer

The servlet context path for the Satellite Server servlet on the host that will be most often accessed. Forced Satellite Server URIs will use this path as the servlet context path.

Typical values:

/cs/Satellite

/servlet/Satellite

path.SeedDispatchServer

The servlet context path for the Seed Dispatch Server servlet.

Typical values:

/cs/SeedDispatchServer

/servlet/SeedDispatchServer

path.SyncSeedDispatchServer

The servlet context path for the Sync Seed Dispatch Server servlet.

Typical values:

/cs/SyncSeedDispatchServer

/servlet/SyncSeedDispatchServer

path.TreeManager

The servlet context path for the Tree Manager servlet.

Typical values:

/cs/TreeManager

/servlet/TreeManager

uri.assembler.1.classname

Specifies the classname for the default URI assembler to be used by this instance of WebCenter Sites. Users may override this value and specify a different assembler that conforms to the com.fatwire.cs.core.uri.Assembler interface.

If the assembler specified by this class is unable to decode a URI, then WebCenter Sites will attempt to use the next ranked assembler to decode the URI. This process will continue until the URI is decoded.

uri.assembler.1.shortform

Specifies the short form name for the corresponding URI assembler. The short form is the name passed into getURI methods to identify which assembler to use; it is a nickname for the assembler.

uri.assembler.2.classname

Specifies the classname for the second URI assembler to be used by this instance of WebCenter Sites. Users may override this value and specify a different assembler that conforms to the com.fatwire.cs.core.uri.Assembler interface.

If the assembler specified by this class is unable to decode a URI, then WebCenter Sites will attempt to use the next ranked assembler to decode the URI. This process will continue until the URI is decoded.

uri.assembler.2.shortform

Specifies the short form name for the corresponding URI assembler. The short form is the name passed into getURI methods to identify which assembler to use; it is a nickname for the assembler.

uri.assembler.3.classname

Specifies the classname for the third URI assembler to be used by this instance of WebCenter Sites. Users may override this value and specify another assembler that conforms to the com.fatwire.cs.core.uri.Assembler interface.

If the assembler specified by this class is unable to decode a URI, then WebCenter Sites will attempt to use the next ranked assembler to decode the URI. This process will continue until the URI is decoded.

uri.assembler.3.shortform

Specifies the short form name for the corresponding URI assembler. The short form is the name passed into getURI methods to identify which assembler to use; it is a nickname for the assembler.

16.4 User Defined Tab

Table 16-4 Properties in ServletRequest.properties: User Defined Tab

Property

Description

This tab, by default, has no properties.

N/A

17 visitor.ini

The visitor.ini file is installed by WebCenter Sites. However, the properties in the file configure WebCenter Sites: Engage rather than WebCenter Sites. The properties configure the visitor data collection and other features provided by WebCenter Sites: Engage.

Properties in the visitor.ini file are organized by function on the following tabs in the Property Editor:

- Visitor Data Tab

- User Defined Tab

17.1 Visitor Data Tab

The Visitor Data tab holds the main properties in the file.

Table 17-1 Properties in visitor.ini: Visitor Data Tab

Property

Description

vis.adminrole

Specifies the ACL that Engage users need in order to work with the visitor attribute, history attribute, history type, and recommendation asset types.

Default value: VisitorAdmin

Do not change the value of this property.

vis.compileclasspath

Specifies the classpath against which to compile the rules.

This value is set during the installation and should not be changed after that point.

vis.editrole

Specifies the ACL that two kinds of Engage users need:

- Content providers who use the WebCenter Sites system to create segments and promotions.

- The visitors to your online site when you are using Engage to gather information about them for segments.

Default value: Visitor

Do not change the value of this property.

vis.genclasspath

Specifies the directory (including the final slash character) where rules-engine-generated class files for visitor data are stored.

This value is set during the installation and should not be changed after that point.

vis.money

Specifies the SQL string for defining fields that hold monetary values.

Do not change the value of this property without consulting your database administrator.

vis.path

Specifies the directory that holds the ruleset.dtd file, which is usually the installation directory. This value is set during installation.

Do not change the value of this property.

vis.rulesetxmlpath

Specifies the defdir (default storage directory) for the XML versions of the rule sets.

This value is set during installation.

Do not change the value of this property.

vis.sessiondata

Specifies the defdir (default storage directory) for storing visitor session data.

This value is set during installation.

Do not change the value of this property.

vis.update

Specifies whether every page access will update the visitor timestamp in the visitor data.

Possible values: true | false

Set to true if you want every page access to update the visitor timestamp in the visitor data; false otherwise.

Default value: true

vis.url

Specifies the SQL string for defining visitor and history attributes of type URL.

Default value: VARCHAR(128)

Do not change the value of this property without consulting your database administrator.

vis.urlpath

Specifies the defdir for binary visitor and history attributes.

Default value: /futuretense/visurl/

vis.useSessionVisitorConnection

This property determines whether Engage visitors will be tracked via the database- or memory-centric method, which improves the performance of heavily trafficked sites featuring Engage assets. In memory-centric tracking, WebCenter Sites stores visitor scalar attribute values to the add-on repository, and visitor history attribute values to its own database. All computations to determine a visitor's segments are performed in memory; results are cached.

By default, this property is not automatically included in visitor.ini, in which case its value is understood to be false (i.e., database-centric).

This property must be set on the delivery system in one of the following ways:

- If you wish to enable the database-centric method, set this property to false, leave it blank, or omit it from the file.

- If you wish to enable the memory-centric method, set this property to true and ensure that supporting template code exists on the delivery system (in its absence, Engage visitors will be incorrectly tracked). For information about required code, see "Memory-Centric Visitor Tracking" in the Oracle Fusion Middleware WebCenter Sites Developer's Guide.

On content management systems, this property must be either set to false or omitted, given that visitor attributes are created and managed only on CM systems that are enabled for database-centric tracking. Management of visitor attributes is not supported on delivery systems; the attributes must be published to the delivery systems.

17.2 User Defined Tab

Table 17-2 Properties in visitor.ini: User Defined Tab

Property

Description

This tab, by default, has no properties.

N/A

Part II

Oracle WebCenter Sites Applications

Part II lists the property files that are used by WebCenter Sites: Engage, WebCenter Sites: Analytics, and WebCenter Sites: Satellite Server.

This part contains the following chapter:

- Chapter 18, "Oracle WebCenter Sites: Analytics, Engage, and Satellite Server Properties"

18 Oracle WebCenter Sites: Analytics, Engage, and Satellite Server Properties

This chapter contains the following sections:

- Section 18.1, "Oracle WebCenter Sites: Analytics Properties"

- Section 18.2, "Oracle WebCenter Sites: Engage Properties"

- Section 18.3, "Oracle WebCenter Sites: Satellite Server Property Files"

18.1 Oracle WebCenter Sites: Analytics Properties

Oracle WebCenter Sites: Analytics requires that several properties in the futuretense_xcel.ini property file be set after Analytics is installed. These properties are described in Section 10.1, "Analytics Tab."

18.2 Oracle WebCenter Sites: Engage Properties

WebCenter Sites: Engage installs one property file, named ms.ini, which holds only the ms.enable property.

18.2.1 ms.ini

Table 18-1 Properties in ms.ini property

Property

Description

ms.enable

Set to true by the WebCenter Sites installation process, when Engage is installed and enabled.

Note:

Engage configuration properties are located in the WebCenter Sites property file named visitor.ini.

18.3 Oracle WebCenter Sites: Satellite Server Property Files

When you install Satellite Server as a stand-alone application on a remote server, the satellite.properties is present on that server. For information about properties in the file, see Chapter 15, "satellite.properties."

Part III

Third-Party Libraries and Applications

Part III contains information about third-party libraries, as well as applications, and how Oracle WebCenter Sites integrates with them.

This part contains the following chapter:

- Chapter 19, "HTTP Client Access"

19 HTTP Client Access

This section describes the Apache Commons HttpClient library and how WebCenter Sites integrates with this library.

This chapter contains the following sections:

- Section 19.1, "Apache Commons HttpClient"

- Section 19.2, "Integration with WebCenter Sites"

- Section 19.3, "HTTPClient Parameters and WebCenter Sites Properties"

19.1 Apache Commons HttpClient

WebCenter Sites uses Apache Commons HttpClient as the underlying library for all HTTP access. As of version 3, HttpClient supports the parameters that are posted at: http://jakarta.apache.org/commons/httpclient/preference-api.html

The parameters function as follows:

- HttpClient parameters change the runtime behavior of HttpClient components. For example, if you want the Post operation to have a timeout that differs from the default, you can call PostMethod.getParams().setParam("timeout", 1000) before executing it.

- HttpClient parameters can be hierarchically linked. In top-down order, the levels of the hierarchy are: global, client, host, and method. Values that are set for parameters at higher levels are overridden by the values of equivalent parameters at lower levels.

Despite its flexibility, HttpClient has a limitation; that is—parameters can be set only programmatically. No configuration file can be written where parameter values can be specified by users or automatically retrieved by the library. The WebCenter Sites integration, however, overcomes this limitation as explained in the next section Section 19.2, "Integration with WebCenter Sites."

Note:

WebCenter Sites uses the parameters that are posted at http://jakarta.apache.org/commons/httpclient/preference-api.html. The parameters are listed in Table 19-1, along with descriptions (duplicated from the site named above). Changes to parameters and their functionality as defined by HttpClient are not automatically supported.

19.2 Integration with WebCenter Sites

WebCenter Sites abstracts HttpClient functionality by allowing WebCenter Sites users to create user-configurable property files. After creating the files, users populate them with the required HttpClient parameters (that is, parameters whose values differ from the default values), and place the property files into the classpath. WebCenter Sites loads the property files from the classpath and parses the parameters according to a predefined syntax (shown in Table 19-1). The HttpAccess API retrieves the parameters and applies them at runtime.

WebCenter Sites supports a parameter hierarchy whose levels correspond directly to the levels that are defined in the HttpAccess Java API (provided in WebCenter Sites Java Docs). For each level, one or more property files can be created, depending on the implementation, and populated with any combination of HttpClient parameters. The levels and property file naming conventions are given below:

Note:

The property files must be created as text files, outside of the WebCenter Sites Property Editor. Property file names are case sensitive and must be in lower case throughout.

- HttpAccess (level 1)
Property File: httpaccess.properties. The user specifies parameters and their values in the httpaccess.properties file. This file is applied to all HttpAccess instances that are created.

Overrides: Parameter values at the HttpAccess level are overridden by the values of equivalent parameters at levels 2, 3, and 4 (described below).

- HostConfig (level 2)
Property File: <protocol>-<hostname>-<port number>.properties. The user specifies host-specific parameters in each property file. For example, for a host named targetserver accessible at port 7001, the property file would be named http-targetserver-7001.properties and would contain HttpClient parameters specific to that host.

Overrides: Parameter values at the HostConfig level override the values of equivalent parameters at the HttpAccess level.

- Request (level 3)
Property File: <request type>.properties where <request type> takes one of the following values: post, get, or login. The user specifies parameters specific to a Request. For example, post.properties specifies HttpClient parameters applicable to instances of post.

Overrides: Parameter values at the Request level override the values of equivalent parameters at the HttpAccess and HostConfig levels.

- Per host, per Request (level 4)
Property File: <request type>-<protocol>-<host name>-<port number>.properties where <request type> takes one of the following values: post, get, or login. Parameters in this property file function as Request level parameters. However, they apply to a specific host.

Overrides: Parameter values specified at the "Per host, per Request" level override the values of equivalent parameters at the HttpAccess, HostConfig, and Request levels for that particular host. The following example illustrates how an override takes effect from the "Per Host, Per Request" level. In this example, a user defines a property file named login-http-m2-7002.properties, where she specifies an http.connection.timeout of 100 seconds. The timeout applies strictly to the host machine named m2 and port 7002. The timeout value overrides all timeout values that might be specified for m2 at higher levels. For all other host machines, the timeout values remain unaffected.

WebCenter Sites supports all parameters defined by HttpClient in an externally configurable way. Furthermore, WebCenter Sites extends HttpClient functionality by enabling users to configure parameters externally and facilitating the specification of parameters at the fourth level (per host, per request).

In addition to all the parameters supported by HttpClient, the WebCenter Sites HttpAccess API defines a configuration property cs.SecureProtocolSocketFactory in httpaccess.properties. This property specifies the protocol socket factory to be used for SSL (Secure Socket Layer) connections. Three implementations are available at http://jakarta.apache.org/commons/httpclient/sslguide.html. Note that if you want to use SSL to connect to a host using self-signed certificates, you must configure the following:

cs.SecureProtocolSocketFactory=org.apache.commons.httpclient.  contrib.ssl.EasySSLProtocolSocketFactory

WebCenter Sites does not provide this EasySSLProtocolSocketFactory class. You can obtain this class at http://jakarta.apache.org/commons/httpclient/sslguide.html. Make sure to build it differently for Sun and IBM JDKs, as the Apache implementation (at the link directly above) is Sun-specific. Alternatively you can write your own Socket factory implementation based on HttpClient documentation.

Note that there are two levels—connection manager and connection—in the HttpClient hierarchy for which parameters cannot be explicitly set, as the HttpAccess API does not directly support them. However, this does not mean users cannot configure those parameters; the parameters can be specified at a lower or higher corresponding level in the HttpAccess API.

19.2.1 Implementation

How does the WebCenter Sites user configure WebCenter Sites for http access? The user simply creates property files with appropriate names and places them in the classpath. The infrastructure will retrieve and use them. This seems like a good deal of work, especially given the number of parameters. However, by default, no properties or property files need to be created. All defaults will be used, and HttpClient takes the "best guess" values, which are usually the best settings for the given system. In 95% of the cases, "best guess" values are sufficient and users need not create any property files.

In the rare cases when one needs parameter values other than defaults, the WebCenter Sites infrastructure makes it possible to implement them by allowing the user to specify configuration in property files. This gives the user the full range of configuration capabilities that HttpClient itself is built upon.

19.3 HTTPClient Parameters and WebCenter Sites Properties

The table in this section describes parameters that are supported by Apache Commons HttpClient. Descriptions in the table are duplicated from the following site:

http://jakarta.apache.org/commons/httpclient/preference-api.html

Syntax and default values are defined by Oracle, as they are specific to WebCenter Sites. Where syntax is straightforward, the "Syntax" field in the table below is left blank.

Note that changes to the parameters and their functionality are not automatically supported. Information in the table below is valid until Oracle issues an update.

In addition to supporting HttpClient parameters, WebCenter Sites defines the following property:

Property: cs.SecureProtocolSocketFactory

Usage: applicable only to the httpaccess.properties file

Description: defines the class used opening SSL Socket connections

Default: empty. The system will use the JSSE-based default implementation of HttpClient. Details are available at: http://jakarta.apache.org/commons/httpclient/sslguide.html

Table 19-1 HttpClient Parameters

Name

Description

http.authentication.preemptive

Defines whether authentication should be attempted preemptively.

Type: Boolean

Default value: <undefined>

http.connection.stalecheck

Determines whether stale connection check is to be used. Disabling stale connection check may result in slight performance improvement at the risk of getting an I/O error when executing a request over a connection that has been closed at the server side.

Type: Boolean

Default value: <undefined>

http.connection.timeout

The timeout until a connection is established. A value of zero means the timeout is not used.

Type: Integer

Default value: <undefined>

http.connection-manager.class

The default HTTP connection manager class.

Type: Class

Syntax: Fully qualified classname

Default value: SimpleHttpConnectionManager class

http.connection-manager.max-per-host

Defines the maximum number of connections allowed per host configuration. These values only apply to the number of connections from a particular instance of HttpConnectionManager. This parameter expects a value of type Map. The value should map instances of HostConfiguration to Integer s. The default value can be specified using ANY_HOST_CONFIGURATION.

Type: Map

Syntax: Specify ${<host>;<port>;<protocol>; <max connections>}

Default value: <undefined>

http.connection-manager.max-total

Defines the maximum number of connections allowed overall. This value only applies to the number of connections from a particular instance of HttpConnectionManager.

Type: Integer

Default value: <undefined>

http.connection-manager.timeout

The timeout in milliseconds used when retrieving an HTTP connection from the HTTP connection manager.

Type: Long

Default value: <undefined>

http.dateparser.patterns

Date patterns used for parsing. The patterns are stored in a Collection and must be compatible with SimpleDateFormat.

Type: Collection

Syntax: Specify the collection with each element enclosed in ${<element>}.e.g., ${EEE, dd-MMM-yyyy HH-mm- ss z}${EEE, dd MMM yy HH:mm:ss z}

Default value:

EEE, dd MMM yyyy HH:mm:ss zzzEEEE, dd-MMM-yy HH:mm:ss zzzEEE MMM d HH:mm:ss yyyyEEE, dd-MMM-yyyy HH:mm:ss zEEE, dd-MMM-yyyy HH-mm-ss zEEE, dd MMM yy HH:mm:ss zEEE dd-MMM-yyyy H:mm:ss zEEE dd MMM yyyy HH:mm:ss zEEE dd-MMM-yyyy HH-mm-ss zEEE dd-MMM-yy HH:mm:ss zEEE dd MMM yy HH:mm:ss zEEE,dd-MMM-yy HH:mm:ss zEEE,dd-MMM-yyyy HH:mm:ss zEEE, dd-MM-yyyy HH:mm:ss z

http.default-headers

The request headers to be sent per default with each request. This parameter expects a value of type Collection. The collection is expected to contain HTTP headers.

Type: Collection

Syntax: Specify each header in ${name=<header name>; value=<header value>}

Default value: <undefined>

http.method.multipart.boundary

The multipart boundary string to use in conjunction with the MultipartRequestEntity. When this property is not set, a random value will be generated for each request.

Type: String

Syntax:

Default value: <undefined>

http.method.response.buffer.warnlimit

The maximum buffered response size (in bytes) that triggers no warning. Buffered responses exceeding this size will trigger a warning in the log. If not set, the limit is 1 MB.

Type: Integer

Default value: 1

http.method.retry-handler

The method retry handler used for retrying failed methods. For details see the Exception handling guide.

Type: HttpMethodRetryHandler

Syntax: Fully qualified classname

Default value: default implementation

http.protocol.allow-circular-redirects

Defines whether circular redirects (redirects to the same location) should be allowed. The HTTP spec is not sufficiently clear whether circular redirects are permitted, therefore optionally they can be enabled.

Type: Boolean

Default value: <undefined>

http.protocol.content-charset

The charset to be used for encoding content body.

Type: String

Default value: ISO-8859-1

http.protocol.cookie-policy

The cookie policy to be used for cookie management.

Type: String

Default value: CookiePolicy.RFC_2109

http.protocol.credential-charset

The charset to be used when encoding credentials. If not defined then the value of the "http.protocol.element-charset" should be used.

Type: String

Default value: <undefined>

http.protocol.element-charset

The charset to be used for encoding/decoding HTTP protocol elements (status line and headers).

Type: String

Default value: US-ASCII

http.protocol.expect-continue

Activates "Expect: 100-Continue" handshake for the entity enclosing methods. The "Expect: 100-Continue" handshake allows a client that is sending a request message with a request body to determine if the origin server is willing to accept the request (based on the request headers) before the client sends the request body.

The use of the "Expect: 100-continue" handshake can result in noticeable performance improvement for entity enclosing requests (such as POST and PUT) that require the target server's authentication. "Expect: 100-continue" handshake should be used with caution, as it may cause problems with HTTP servers and proxies that do not support HTTP/1.1 protocol.

Type: Boolean

Default value: <undefined>

http.protocol.head-body-timeout

Sets period of time in milliseconds to wait for a content body sent in response to HEAD response from a non-compliant server. If the parameter is not set or set to -1 non-compliant response body check is disabled.

Type: Integer

Default value: <undefined>

http.protocol.max-redirects

Defines the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops.

Type: Integer

Default value: <undefined>

http.protocol.reject-head-body

Defines whether the content body sent in response to HEAD request should be rejected.

Type: Boolean

Default value: <undefined>

http.protocol.reject-relative-redirect

Defines whether relative redirects should be rejected.

Type: Boolean

Default value: <undefined>

http.protocol.single-cookie-header

Defines whether cookies should be put on a single response header.

Type: Boolean

Default value: <undefined>

http.protocol.status-line-garbage-limit

Defines the maximum number of ignorable lines before we expect a HTTP response's status code.

With HTTP/1.1 persistent connections, the problem arises that broken scripts could return a wrong Content-Length (there are more bytes sent than specified). Unfortunately, in some cases, this is not possible after the bad response, but only before the next one. So, HttpClient must be able to skip those surplus lines this way. Set this to 0 to disallow any garbage/empty lines before the status line. To specify no limit, use Integer.MAX_VALUE.

Type: Integer

Default value: <undefined>

http.protocol.strict-transfer-encoding

Defines whether responses with an invalid Transfer-Encoding header should be rejected.

Type: Boolean

Default value: <undefined>

http.protocol.unambiguous-statusline

Defines whether HTTP methods should reject ambiguous HTTP status line.

Type: Boolean

Default value: <undefined>

http.protocol.version

The HTTP protocol version used per default by the HTTP methods.

Type: HttpVersion

Syntax: <(int)major>.<(int)minor>; e.g., 1.1

Default value: HttpVersion_1_1

http.protocol.warn-extra-input

Defines HttpClient's behavior when a response provides more bytes than expected (specified with Content-Length header, for example). Such surplus data makes the HTTP connection unreliable for keep-alive requests, as malicious response data (faked headers etc.) can lead to undesired results on the next request using that connection. If this parameter is set to true, any detection of extra input data will generate a warning in the log.

Type: Boolean

Default value: <undefined>

http.socket.linger

The linger time (SO_LINGER) in seconds. This option disables/enables immediate return from a close() of a TCP Socket. Enabling this option with a non-zero Integer timeout means that a close() will block pending the transmission and acknowledgement of all data written to the peer, at which point the socket is closed gracefully. Value 0 implies that the option is disabled. Value -1 implies that the JRE default is used.

Type: Integer

Default value: <undefined>

http.socket.receivebuffer

The value to set on Socket.setReceiveBufferSize(int). This value is a suggestion to the kernel from the application about the size of buffers to use for the data to be received over the socket.

Type: Integer

Default value: <undefined>

http.socket.sendbuffer

The value to set on Socket.setSendBufferSize(int). This value is a suggestion to the kernel from the application about the size of buffers to use for the data to be sent over the socket.

Type: Integer

Default value: <undefined>

http.socket.timeout

Sets the socket timeout (SO_TIMEOUT) in milliseconds to be used when executing the method. A timeout value of zero is interpreted as an infinite timeout.

Type: Integer

Default value: <undefined>

http.socket.timeout

The default socket timeout (SO_TIMEOUT) in milliseconds which is the timeout for waiting for data. A timeout value of zero is interpreted as an infinite timeout. This value is used when no socket timeout is set in the HTTP method parameters.

Type: Integer

Default value: <undefined>

http.tcp.nodelay

Determines whether Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve bandwidth by minimizing the number of segments that are sent. When applications need to decrease network latency and increase performance, they can disable Nagle's algorithm (by enabling TCP_NODELAY). Data will be sent earlier, at the cost of an increase in bandwidth consumption.

Type: Boolean

Default value: <undefined>

http.useragent

The content of the User-Agent header used by the HTTP methods.

Type: String

Default value: <Official release name>e.g., Jakarta Commons-HttpClient/3.0

Index
A  B  C  D  E  F  G  H  I  J  L  M  N  O  P  R  S  T  U  V  W  X

A

advancedUI.enableAssetForms, 10.13

afk.historydata, 2.1

afk.publishdata, 2.1

am.debug, 10.5

analysisconnector.version, 9.18

analytics.datacaptureurl, 10.1

analytics.enabled, 10.1

analytics.piurl, 10.1

analytics.reporturl, 10.1

analytics.user, 10.1

appserverlink, 15.6

asset.debug, 10.5

B

baseDN, 7.3

blocktimeout, 15.2

bs.bCacheSize, 9.4

bs.bCacheTimeout, 9.4

bservice, 15.3

bs.invalidheadernames, 9.4

bs.security, 9.3

bs.validheadernames, 9.4

C

cache_check_interval, 15.1

cache_folder, 15.1

cache_max, 15.1

catalogcentre.version, 9.18

cc.AssetTypeCSz, 9.18

cc.attrDisplayStyle, 11.1

cc.attributeinheritance, 11.1

cc.bigint, 9.8

cc.bigtext, 9.8

cc.blob, 9.8

cc.BlobServerCacheCSz, 9.14

cc.BlobServerTimeout, 9.14

cc.cacheNoSync, 9.5

cc.cacheResults, 9.15

cc.cacheResultsAbs, 9.15

cc.cacheResultsTimeout, 9.15

cc.CategoryCSz, 9.18

cc.char, 9.8

cc.ComparatorsKey, 9.18

cc.contentkey, 9.7

cc.datepicture, 9.8

cc.datetime, 9.8

cc.double, 9.8

cc.ElementCatalogCSz, 9.15

cc.ElementCatalogTimeout, 9.15

cc.extrapath, 11.1

cc.FiltersKeyXX, 9.18

cc.forcelower, 9.8

cc.fullconstraint, 11.1

cc.ignoreTblCase, 9.8

cc.integer, 9.8

cc.maxvarcharsize, 9.8

cc.MimeTypeKey, 9.18

cc.money, 11.1

cc.null, 9.8

cc.numeric, 9.8

cc.PreviewgenKey, 9.18

cc.primary, 9.8

cc.queryablemaxvarcharlength, 9.8

cc.querystyle, 11.1

cc.rename, 9.8

cc.security, 9.3

cc.SiteCatalogCSz, 9.15

cc.SiteCatalogTimeout, 9.15

cc.smallint, 9.8

cc.SourceKey, 9.18

cc.StatusCodeCSz, 9.18

cc.StatusCodeKey, 9.18

cc.string, 11.1

cc.stringpicture, 9.8

cc.SystemACLCSz, 9.15

cc.SystemACLTimeout, 9.15

cc.SystemInfoCSz, 9.15

cc.SystemInfoTimeout, 9.15

cc.SystemPageCacheCSz, 9.14

cc.SystemPageCacheTimeout, 9.14

cc.SystemUsersCSz, 9.15

cc.SystemUsersTimeout, 9.15

cc.textdistinct, 11.1

cc.unique, 9.8

cc.url, 11.1

cc.urlattrpath, 11.1

cc.useLegacyInputNames, 11.1

cc.varchar, 9.8

cg.management.url, 10.4

cg.production.url, 10.4

ckeditor.showIncludedElementInSpan, 10.13

className.Attribute, 7.4

className.Attributes, 7.4

className.IDir, 7.4

className.IFactory, 7.4

className.IName, 7.4

className.IUserDir, 7.4

className.JNDIName, 7.4

cleandns, 7.2

cn, 7.1

com.fatwire.logging.cs, 5.3

com.fatwire.logging.cs.auth, 5.3

com.fatwire.logging.cs.blobserver, 5.3

com.fatwire.logging.cs.cache.page, 5.3

com.fatwire.logging.cs.cache.resultset, 5.3

com.fatwire.logging.cs.core.http.HttpAccess, 5.3

com.fatwire.logging.cs.core.uri.assembler, 5.3

com.fatwire.logging.cs.core.uri.definition, 5.3

com.fatwire.logging.cs.db, 5.3

com.fatwire.logging.cs.errno, 5.3

com.fatwire.logging.cs.event, 5.3

com.fatwire.logging.cs.export, 5.3

com.fatwire.logging.cs.filelock, 5.3

com.fatwire.logging.cs.firstsite.filter, 5.3

com.fatwire.logging.cs.install, 5.3

com.fatwire.logging.cs.jsp, 5.3

com.fatwire.logging.cs.realtime, 5.3

com.fatwire.logging.cs.request, 5.3

com.fatwire.logging.cs.satellite, 5.3

com.fatwire.logging.cs.satellite.cache, 5.3

com.fatwire.logging.cs.satellite.host, 5.3

com.fatwire.logging.cs.satellite.request, 5.3

com.fatwire.logging.cs.session, 5.3

com.fatwire.logging.cs.sync, 5.3

com.fatwire.logging.cs.sysinfo, 5.3

com.fatwire.logging.cs.time, 5.3

com.fatwire.logging.cs.visitor.object, 5.3

com.fatwire.logging.cs.visitor.ruleset, 5.3

com.fatwire.logging.cs.xcelerate, 5.3

com.fatwire.logging.cs.xcelerate.advantage.recommendation, 5.3

com.fatwire.logging.cs.xcelerate.approval, 5.3

com.fatwire.logging.cs.xcelerate.asset, 5.3

com.fatwire.logging.cs.xcelerate.assetmaker, 5.3

com.fatwire.logging.cs.xcelerate.publish, 5.3

com.fatwire.logging.cs.xcelerate.template, 5.3

com.fatwire.logging.cs.xml, 5.3

com.fatwire.logging.ui.model, 5.5

com.fatwire.logging.ui.phase, 5.5

com.fatwire.logging.ui.view, 5.5

com.fatwire.search.asset, 5.3

com.fatwire.search.lucene, 5.5

commerceconnector.version, 9.18

contentcentre.version, 9.18

contentserver.installation.folder, 15.4

cookieprefix, 15.4

cos.contextroot, 10.13

cos.hostname, 10.4

cos.portnumber, 10.4

cs.alwaysusedisk, 9.14

cs.approvalLockStriping, 9.18

cs.barEqualsSlash, 9.3

cs.binarypath, 10.11

cs.charset, 6.1, 9.13, 16.1

cs.childfoldercount, 9.18

cs.contenttype, 6.1, 9.13, 16.1

cs.contenttype. UTF-8, 16.1

cs.contenttype.UTF-8, 6.1

cs.cookievariables, 9.6

cs.dataindatabase, 9.6

cs.dbconnpicture, 9.8

cs.dbencoding, 9.18

cs.dbtype, 9.8

cs.disksize, 6.1, 9.13, 16.2

cs.documentation, 9.13

cs.dsn, 9.8

cs.emailaccount, 9.10

cs.emailauthenticator, 9.10

cs.emailcharset, 9.10

cs.emailcontenttype, 9.10

cs.emailhost, 9.10

cs.emailpassword, 9.10

cs.emailreturnto, 9.10

cs.eventhost, 9.1

cs.expireonly, 9.14

cs.freezeCache, 9.14

cs.HTTP_HOST, 9.13

cs.HTTP_PROTOCOL, 9.13

cs.httpvariables, 9.6

cs.IItemList, 9.14

cs.invalMemWindow, 9.18

cs.jspclear, 9.12

cs.jsppath, 9.12

cs.jsprefresh, 9.12

cs.jspresponsewrapper, 9.12

cs.jsproot, 9.12

cs.jspwork, 9.12

cs.manageACL, 9.2

cs.manageproperty, 9.2

cs.manageUser, 9.2

cs.manageUserAccess, 9.2

cs.manageUserSystem, 9.2

cs.mirrorhttpversion, 9.11

cs.mirrorpassword, 9.11

cs.mirrorproxyserver, 9.11

cs.mirrorproxyserverport, 9.11

cs.mirrorrowsperpost, 9.11

cs.mirrorthreads, 9.11

cs.mirroruser, 9.11

cs.nocache, 9.14

cs.parentfoldercount, 9.18

cs.PastramiEngine, 9.16

cs.pgCacheTimeout, 9.14

cs.pgexportfolder, 9.11

cs.privpassword, 9.8

cs.privuser, 9.8

cs.recordBlobInventory, 9.4, 9.14

cs.requestfactory, 9.18

cs.requiresessioncookies, 9.14

cs.satellitehosts, 9.6

cs.satellitepassword, 9.6

cs.satelliteusers, 9.6

cs.selfmodify, 9.6

cs.session, 9.3

cs.sitepreview, 9.13

cs.ssovalidator, 9.2

cs.TempObjectsDaysToKeep, 9.18

cs.timeout, 9.3

cs.tree.defaultFunction.child, 10.8

cs.tree.defaultFunction.parent, 10.8

cs.uniqueidpoolsize, 9.3

cs.urlfilerollup, 9.13

cs.use.short.jsp.names, 9.12

cs.wrapper, 9.3

cs.xmlfolder, 9.13

cs.xmlHeader, 9.13

cs.xmlHeaderAutoStream, 9.6

D

debug, 3.2

defaultGroupAttrs, 7.7

defaultPeopleAttrs, 7.7

defaultReaderACLs, 7.7

E

expiration, 15.1

F

file_size, 15.1

forgotpassword, 8.1

formaction, 15.5

ft.approot, 9.6

ft.catalogmanager, 9.6

ft.cgipath, 9.1

ft.contentserver, 9.6

ft.debugport, 9.9

ft.filecheck, 9.15

ft.servletoutputstream, 9.18

ft.suppressPasswordNames, 9.9

ft.suppressPasswords, 9.9

ft.sync, 9.5

ft.treemanager, 9.6

ft.usedisksync, 9.5

ft.version, 9.3

fwblogs.cos.enabled, 10.4, 10.13

G

globally_replace_contentserver, 15.5

groupparent, 7.3

H

host, 15.3

http.authentication.preemptive, 19.3

http.connection-manager.class, 19.3

http.connection-manager.max-per-host, 19.3

http.connection-manager.max-total, 19.3

http.connection-manager.timeout, 19.3

http.connection.stalecheck, 19.3

http.connection.timeout, 19.3

http.dateparser.patterns, 19.3

http.default-headers, 19.3

http.method.multipart.boundary, 19.3

http.method.response.buffer.warnlimit, 19.3

http.method.retry-handler, 19.3

http.protocol.allow-circular-redirects, 19.3

http.protocol.content-charset, 19.3

http.protocol.cookie-policy, 19.3

http.protocol.credential-charset, 19.3

http.protocol.element-charset, 19.3

http.protocol.expect-continue, 19.3

http.protocol.head-body-timeout, 19.3

http.protocol.max-redirects, 19.3

http.protocol.reject-head-body, 19.3

http.protocol.reject-relative-redirect, 19.3

http.protocol.single-cookie-header, 19.3

http.protocol.status-line-garbage-limit, 19.3

http.protocol.strict-transfer-encoding, 19.3

http.protocol.unambiguous-statusline, 19.3

http.protocol.version, 19.3

http.protocol.warn-extra-input, 19.3

http.socket.linger, 19.3

http.socket.receivebuffer, 19.3

http.socket.sendbuffer, 19.3

http.socket.timeout, 19.3, 19.3

http.tcp.nodelay, 19.3

http.useragent, 19.3

I

image.time, 9.18

J

java.naming.factory.initial, 7.5

java.naming.security.authentication, 7.5

jndi.baseURL, 7.5

jndi.connectAsUser, 7.5

jndi.custom, 7.5

jndi.login, 7.5

jndi.password, 7.5

jndi.poolConnections, 7.5

jndi.poolsize, 7.5

L

log.Directory.messages, 13.2

log.filterLevel, 13.1

logging.file, 5.4

logging.format, 5.4

logging.interval, 5.1

logging.maxlogsize, 5.4

logging.per-client-log, 5.4

logging.roll, 5.4

logging.timestamp, 5.4

loginattribute, 7.1

log.Logger.messages, 13.2

log.transformer.messages, 13.2

log.wmentconnector.messages, 13.2

M

marketingstudio.version, 9.18

memberof, 7.1

ms.enable, 18.2.1

mwb.assetsetclass, 11.1

mwb.cartclass, 11.1

mwb.cartsetclass, 11.1

mwb.cartsetdir, 4.1

mwb.commercecontextclass, 11.1

mwb.commerceengineclass, 11.1

mwb.commerceuserclass, 11.1

mwb.conservativedependencies, 11.1

mwb.defaultattributes, 11.1

mwb.externalattributes, 11.1

mwb.path, 11.1

mwb.promotioncutoff, 11.1

mwb.searchdir, 11.1

mwb.searchstateclass, 11.1

mwb.segmentcutoff, 11.1

N

newformaction, 15.5

ntlogin.DefaultACL, 9.2

ntlogin.DefaultReaderACL, 9.2

ntlogin.DefaultReaderID, 9.2

ntlogin.DefaultReaderPW, 9.2

ntlogin.LogFile, 9.2

ntlogin.Logging, 9.2

O

objectclassGroup, 7.7

objectclassPerson, 7.7

org.apache.commons.logging.Log, 5.2

org.apache.commons.logging.LogFactory, 5.2

org.apache.http, 5.3

org.apache.http.client, 5.3

org.apache.http.headers, 5.3

org.apache.http.impl.client, 5.3

org.apache.http.impl.conn, 5.3

org.apache.http.wire, 5.3

P

page.time, 9.18

password, 7.1, 15.2

path.BlobServer, 16.3

path.CacheServer, 16.3

path.CatalogManager, 16.3

path.ContentServer, 16.3

path.CookieServer, 16.3

path.DispatchManager, 16.3

path.PageDispatchServer, 16.3

path.SatelliteServer, 16.3

path.SeedDispatchServer, 16.3

path.SyncSeedDispatchServer, 16.3

path.to.futuretense.ini, 15.4

path.TreeManager, 16.3

peopleparent, 7.3

port, 15.3

propagatecache, 9.18, 15.6

protocol, 15.3

R

readtimeout, 15.2

request.folder, 3.3

requiredGroupAttrs, 7.7

requiredPeopleAttrs, 7.7

rsCacheOverinCache, 9.18

rtd.choiceId.pattern, 9.18

rtd.host, 9.18

rtd.inline.service.name, 9.18

S

satellite.blob.cachecontrol.default, 9.16

satellite.page.cache control.default, 9.16

scratch.cleanup.schedule, 15.6

search.returnlimit, 7.8

search.scope, 7.8

search.timeoutVal, 7.8

secure.CatalogManager, 9.3

secure.DebugServer, 9.3

secure.TreeManager, 9.3

security.checkpagelets, 9.6

security.class, 3.4

service, 15.3

servlet, 15.2

servlet-path, 15.6

sessionid.cookie.prefix, 15.4

sharesession, 15.4

singlesignon, 9.2

soap.binaryRowsType, 9.18

soap.iList, 9.18

soap.likeConstraint, 9.18

soap.listRowsType, 9.18

soap.nestedConstraint, 9.18

soap.rangeConstraint, 9.18

soap.richTextConstraint, 9.18

soap.searchstate, 9.18

soap.standardConstraint, 9.18

soap.stringRowsType, 9.18

soap.stringVarsType, 9.18

soap.urlRowsType, 9.18

soap.URLType, 9.18

ss.flushall, 9.14

syntax.beginquote, 7.6

syntax.beginquote2, 7.6

syntax.custom, 7.5

syntax.direction, 7.6

syntax.endquote, 7.6

syntax.endquote2, 7.6

syntax.escape, 7.6, 7.6

syntax.ignorecase, 7.6

syntax.separator, 7.6

syntax.separatorava, 7.6

syntax.separatortypeval, 7.6

syntax.trimblanks, 7.6, 7.6

T

thread.count, 3.1

thread.growcache, 3.1

thread.idle, 3.1

thread.wait, 3.1

transformer.imgdir, 10.10

transformer.imgurl, 10.10

transparent.content-type.pattern, 15.2

U

uniquemember, 7.1

uri.assembler.1.classname, 16.3

uri.assembler.1.shortform, 16.3

uri.assembler.2.classname, 16.3

uri.assembler.2.shortform, 16.3

uri.assembler.3.classname, 16.3

uri.assembler.3.shortform, 16.3

username, 7.1, 15.2

V

vis.adminrole, 17.1

vis.compileclasspath, 17.1

vis.editrole, 17.1

vis.genclasspath, 17.1

vis.money, 17.1

vis.path, 17.1

vis.rulesetxmlpath, 17.1

vis.sessiondata, 17.1

vis.update, 17.1

vis.url, 17.1

vis.urlpath, 17.1

vis.useSessionVisitorConnection, 17.1

W

wem.enabled, 10.11

X

xcelelem.manageuserpub, 10.7

xcelelem.publishfactors, 10.7

xcelelem.publishoptions, 10.7

xcelelem.setpubid, 10.7

xcelerate. emailnotification, 10.8

xcelerate.adminacl, 10.11

xcelerate.adminrole, 10.11

xcelerate.approval.dependency.chunksize, 10.11

xcelerate.asset.shareToAllAllowed, 10.2

xcelerate.asset.sizeofnamefield, 10.2

xcelerate.authorizefunctions, 10.3

xcelerate.base, 10.11

xcelerate.batchhost, 10.9

xcelerate.batchloadsizeonpublish, 10.9

xcelerate.batchmode, 10.9

xcelerate.batchpass, 10.9

xcelerate.batchsavesizeonpublish, 10.9

xcelerate.batchuser, 10.9

xcelerate.blobref, 10.9

xcelerate.body.length, 10.2

xcelerate.bulkapprovechunk, 10.9

xcelerate.charset, 10.8

xcelerate.ckeditor.basepath, 10.13

xcelerate.crosssiteassign, 10.11

xcelerate.defaultacl, 10.2

xcelerate.defaultbase, 10.2

xcelerate.defaultcscacheinfo, 10.2

xcelerate.defaultcsstatus, 10.2

xcelerate.defaultlang, 10.11

xcelerate.defaultpagecriteria, 10.2

xcelerate.defaultpagecriteriaSiteEntry, 10.2

xcelerate.defaultpreviewurlgenerator, 10.11

xcelerate.defaultsscacheinfo, 10.2

xcelerate.deny.abstainfromvoting, 10.3

xcelerate.deny.approve, 10.3

xcelerate.deny.authorize, 10.3

xcelerate.deny.build, 10.3

xcelerate.deny.checkout, 10.3

xcelerate.deny.copy, 10.3

xcelerate.deny.delegate, 10.3

xcelerate.deny.delete, 10.3

xcelerate.deny.edit, 10.3

xcelerate.deny.inspect, 10.3

xcelerate.deny.placepage, 10.3

xcelerate.deny.preview, 10.3

xcelerate.deny.removefromgroup, 10.3

xcelerate.deny.removefromworkflow, 10.3

xcelerate.deny.rollback, 10.3

xcelerate.deny.setExportData, 10.3

xcelerate.deny.setnestedworkflow, 10.3

xcelerate.deny.setparticipants, 10.3

xcelerate.deny.setprocessdeadline, 10.3

xcelerate.deny.setstepdeadline, 10.3

xcelerate.deny.share, 10.3

xcelerate.deny.showparticipants, 10.3

xcelerate.deny.showstatus, 10.3

xcelerate.deny.showversion, 10.3

xcelerate.displayablenameattr, 10.12

xcelerate.domain, 10.11

xcelerate.donotregenerate, 10.9

xcelerate.editrole, 10.11

xcelerate.emailattr, 10.12

xcelerate.enableinsite, 10.11

xcelerate.ewebeditpro, 10.2

xcelerate.exportmaxfilename, 10.9

xcelerate.grant.abstainfromvoting, 10.3

xcelerate.grant.approve, 10.3

xcelerate.grant.authorize, 10.3

xcelerate.grant.build, 10.3

xcelerate.grant.checkout, 10.3

xcelerate.grant.copy, 10.3

xcelerate.grant.delegate, 10.3

xcelerate.grant.delete, 10.3

xcelerate.grant.edit, 10.3

xcelerate.grant.inspect, 10.3

xcelerate.grant.placepage, 10.3

xcelerate.grant.preview, 10.3

xcelerate.grant.removefromgroup, 10.3

xcelerate.grant.removefromworkflow, 10.3

xcelerate.grant.rollback, 10.3

xcelerate.grant.setExportData, 10.3

xcelerate.grant.setnestedworkflow, 10.3

xcelerate.grant.setparticipants, 10.3

xcelerate.grant.setprocessdeadline, 10.3

xcelerate.grant.setstepdeadline, 10.3

xcelerate.grant.share, 10.3

xcelerate.grant.showparticipants, 10.3

xcelerate.grant.showstatus, 10.3

xcelerate.grant.showversion, 10.3

xcelerate.imageeditor.basepath, 10.13

xcelerate.imageeditor.clarkii.basepath, 10.13

xcelerate.imageurl, 10.11

xcelerate.localeattr, 10.12

xcelerate.locallanguagedir, 10.6

xcelerate.lockdir, 10.6

xcelerate.MaxLinks, 10.2

xcelerate.mirrorini, 10.9

xcelerate.objpubdir, 10.6

xcelerate.pageref, 10.9

xcelerate.presaveelt, 10.9

xcelerate.previewhost, 10.11

xcelerate.previewservlet, 10.11

xcelerate.previewurlpagename, 10.11

xcelerate.pubabortelt, 10.9

xcelerate.pubcleanupelt, 10.9

xcelerate.pubkeydir, 10.6

xcelerate.publishallassettypes, 10.9

xcelerate.publishinvalidate, 10.9

xcelerate.publishquerystyle, 10.11

xcelerate.pubrolesattr, 10.12

xcelerate.pubsetupelt, 10.9

xcelerate.remotecall, 10.9

xcelerate.restrictSiteTree, 10.8

xcelerate.rolemanagerclass, 10.11

xcelerate.saveSearchdir, 10.6

xcelerate.searchResultCols, 10.11

xcelerate.seLimit, 10.8

xcelerate.sePath, 10.6

xcelerate.showSiteTree, 10.8

xcelerate.sitenameattr, 10.12

xcelerate.sitesattr, 10.12

xcelerate.sitesroot, 10.12

xcelerate.systemid, 10.11

xcelerate.templatedefault, 10.9

xcelerate.tempobjectsdir, 10.6

xcelerate.thumbnaildir, 10.6

xcelerate.transformpath, 10.11

xcelerate.treehierassettype, 10.8

xcelerate.treeMaxNodes, 10.8

xcelerate.treetabmanagerclass, 10.11

xcelerate.treeType, 10.8

xcelerate.useDimensionAssets, 10.13

xcelerate.userimageattr, 10.12

xcelerate.usermanagerclass, 10.11

xcelerate.usese, 10.8

xcelerate.workflowdir, 10.6

xcelerate.workflowengineclass, 10.11

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2014, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

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.

License Restrictions Warranty/Consequential Damages Disclaimer

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.

Warranty Disclaimer

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.

Restricted Rights Notice

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.

Hazardous Applications Notice

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.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on 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. 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.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.