Oracle® Fusion Middleware

Property Files Reference for Oracle WebCenter Sites

12c (12.2.1)

E49200-02

March 2016

This reference describes the property files and the properties they contain that govern WebCenter Sites and its component Satellite Server. It also describes how to use the Property Management Tool and the Import/Export Utility to manage these properties.

Oracle Fusion Middleware Property Files Reference for Oracle WebCenter Sites, 12c (12.2.1)

E49200-02

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

Primary Author:  Melinda Rubenau

Contributor:  Kannan Appachi, Chandra Busireddy, Hareesh Kadlabalu, Ravi Khanuja, Yogesh Khubchandani, Osman Saleh, Mingtao Zhang

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, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Audience

- Documentation Accessibility

- How This Guide Is Organized

- Related Documents

- Conventions

What's New in This Guide

Part I Oracle WebCenter Sites JSON Property File

1 Managing JSON File Properties

- 1.1 About the WebCenter Sites JSON File

- 1.1.1 Overview of the Property Management Tool

- 1.1.2 Overview of the Import/Export Utility

- 1.2 Viewing Property Values in the WebCenter Sites JSON File

- 1.3 Using the Property Management Tool

- 1.3.1 Accessing the Property Management Tool

- 1.3.2 Setting Properties

- 1.3.3 Adding Properties

- 1.3.4 Deleting Properties

- 1.4 Using the Import/Export Utility to Manage WebCenter Sites Properties

2 A/BTest Properties

- 2.1 About the Properties in the A/BTest Category

- 2.2 Properties in the A/BTest Category

3 Cache Properties

- 3.1 About the Properties in the Cache Category

- 3.1.1 Blob Server Properties

- 3.1.2 Page Cache Properties

- 3.1.3 Resultset Caching Properties

- 3.1.4 Cluster Properties

- 3.1.5 Compatibility Properties

- 3.1.6 Satellite Server Properties

- 3.1.7 Asset Default Properties

- 3.1.8 Security and Session Timeout Properties

- 3.2 Properties in the Cache Category

4 CAS Properties

- 4.1 About the Properties in the CAS Category

- 4.2 Properties in the CAS Category

5 Cluster Properties

- 5.1 About the Properties in the Cluster Category

- 5.2 Properties in the Cluster Category

6 Connector Properties

- 6.1 About the Connector Category

- 6.2 Properties in the Connector Category

7 Core Properties

- 7.1 About the Properties in the Core Category

- 7.2 Properties in the Core Category

8 CORS Properties

- 8.1 About the Properties in the CORS Category

- 8.2 Properties in the CORS Category

9 Engage Properties

- 9.1 About the Properties in the Engage Category

- 9.2 Properties in the Engage Category

10 Installer Properties

- 10.1 About the Properties in the Installer Category

- 10.2 Properties in the Installer Category

11 Publish Properties

- 11.1 About the Publish Category

- 11.2 Properties in the Publish Category

12 Satellite Properties

- 12.1 About the Properties in the Satellite Category

- 12.2 Properties in the Satellite Category

13 Security Properties

- 13.1 About the Properties in the Security Category

- 13.2 Properties in the Security Category

14 ServletRequest Properties

- 14.1 About the Properties in the ServletRequest Category

- 14.2 Properties in the ServletRequest Category

15 SiteCapture Properties

- 15.1 About the Properties in the SiteCapture Category

- 15.2 SiteCapture Properties

16 Oracle WebCenter Sites: Visitor Services Properties

- 16.1 About the Properties in the Visitor Services Category

- 16.2 Properties in the Visitor Services Category

17 UI Properties

- 17.1 About the Properties in the UI Category

- 17.2 Properties in the UI Category

18 User Properties

- 18.1 About the Properties in the User Category

- 18.2 Properties in the User Category

19 WebCenter Sites User Defined Properties

- 19.1 About WebCenter Sites User Defined Properties

- 19.2 User Defined Properties for WebCenter Sites

Part II Satellite Server JSON File

20 Managing Satellite Server JSON File Properties

- 20.1 About the Satellite Server JSON File

- 20.2 Overview of the Satellite Server Import/Export Utility

- 20.3 Using the Import/Export Utility to Manage Satellite Server Properties

- 20.4 Adding Properties to the Satellite Server JSON File

21 Core Properties in the Satellite Server JSON File

- 21.1 About the Core Properties in the Satellite Server JSON File

- 21.2 Properties in the Core Category in the Satellite Server JSON File

22 CORS Properties in the Satellite Server JSON File

- 22.1 About the CORS Properties in the Satellite Server JSON File

- 22.2 Properties in the CORS Category in the Satellite Server JSON File

23 Satellite Properties in the Satellite Server JSON File

- 23.1 About the Satellite Category in the Satellite Server JSON File

- 23.2 Satellite Properties in the Satellite Server JSON File

24 ServletRequest Properties in the Satellite Server JSON File

- 24.1 About the ServletRequest Properties in the Satellite Server JSON File

- 24.2 Properties in the ServletRequest Category in the Satellite Server JSON File

25 Satellite Server User Defined Properties

- 25.1 About Satellite Server User Defined Properties

- 25.2 User Defined Properties for Satellite Server

Part III Credential Store Properties

26 Managing the Properties in the Credential Store

- 26.1 About the Credential Store

- 26.2 Managing the WebCenter Sites Properties in the Credential Store

- 26.3 Managing Satellite Server Properties in the Credential Store

27 WebCenter Sites Properties in the Credential Store

28 Satellite Server Properties in the Credential Store

Part IV Oracle Diagnostic Logging (ODL) Property File

29 About the logging-config.xml File

30 Oracle Diagnostic Logging (ODL) Configurations

- 30.1 Adding Loggers

- 30.2 Changing Logger Levels

Part V Third-Party Libraries and Applications

31 HTTPClient Access

- 31.1 Apache Commons HTTPClient

- 31.2 About the HTTPClient Integration with WebCenter Sites

- 31.2.1 About the HTTP Client Implementation

- 31.3 HTTP Client 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 that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

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.

Oracle WebCenter Sites JSON Property File covers properties for WebCenter Sites and its page caching application Satellite Server.

Oracle Diagnostic Logging (ODL) Property File covers the WebCenter Sites Logging property files.

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 Oracle WebCenter Sites documentation:

- Oracle WebCenter Sites Release Notes

- Oracle Fusion Middleware Developing with Oracle WebCenter Sites

- Oracle Fusion Middleware Administering Oracle WebCenter Sites

- Oracle Fusion Middleware Using Oracle WebCenter Sites

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 features of WebCenter Sites 12c (12.2.1) and provides pointers to additional information. This preface also lists deprecated features.

Oracle WebCenter Sites 12c (12.2.1) includes the following new features related to properties and property files:

Feature

Description

See These Sections

New and Updated Properties

A large number of new properties have been added and existing properties updated in this release. Refer to Administering Oracle WebCenter Sites and Developing with Oracle WebCenter Sites for a list of new features and links to relevant property descriptions.

- Administering Oracle WebCenter Sites

- Developing with Oracle WebCenter Sites

Property Management Tool / Properties Migrated to JSON Format

Properties that govern the behavior of WebCenter Sites and its component applications are now stored in JSON format and are managed using the new Property Management Tool in the Admin interface.

- Using the Property Management Tool

- Oracle WebCenter Sites JSON Property File

- Satellite Server JSON File

Configuration Import/Export Utility

WebCenter Sites now ships with the Configuration Import/Export Utility, which allows you to bulk-export and bulk-import property values in WebCenter Sites and Satellite Server wcs_properties.json files.

- Using the Import/Export Utility to Manage WebCenter Sites Properties

- Using the Import/Export Utility to Manage Satellite Server Properties

Oracle Diagnostic Logging Replaces log4j

The legacy log4j logging mechanism has been replaced with the more robust Oracle Diagnostic Logging solution.

Satellite Server JSON File

The following features have been deprecated in this release:

- WebCenter Sites Gadgets and Gadget Server

- WebCenter Sites Native authentication in Community/Gadgets

- WebCenter Sites Analytics

- WebCenter Sites Content Integration Platform - EMC Documentum

- WebCenter Sites Content Integration Platform Filesystem

- WebCenter Sites Content Integration Platform Sharepoint

- WebCenter Sites Janrain Integration

- WebCenter Sites Netomat Mobility Server

- SOAP-based web services

- Page Debugger

Note:
Use IDE integration for JSP debug capabilities. DebugServlet is not deployed.

- Sites Desktop

- Sites DocLink

Part I Oracle WebCenter Sites JSON Property File

The following topics list the properties in the wcs_properties.json file that are installed and used by WebCenter Sites, including its user manager plug-ins and co-resident Satellite Server. The Property Management Tool is used to set properties in the wcs_properties.json file.

This part contains information about the categories in the wcs_properties.json file and the properties associated with those categories:

- Managing JSON File Properties

- A/BTest Properties

- Cache Properties

- CAS Properties

- Cluster Properties

- Connector Properties

- Core Properties

- CORS Properties

- Engage Properties

- Installer Properties

- Publish Properties

- Satellite Properties

- Security Properties

- ServletRequest Properties

- SiteCapture Properties

- Oracle WebCenter Sites: Visitor Services Properties

- UI Properties

- User Properties

- User Defined Properties for WebCenter Sites

1 Managing JSON File Properties

This chapter provides information about using the Property Management Tool and the Import/Export Utility to manage Oracle WebCenter Sitesproperties stored in JSON files.

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 the WebCenter Sites and Satellite Server JSON files (wcs_properties.json).

To manage properties, WebCenter Sites provides the Property Management Tool and the Import/Export Utility. Most properties are located in the wcs_properties.json file for WebCenter Sites and Satellite Server, while other properties, such as zookeeper properties are stored in individual property files. This introduction describes the wcs_properties.json files, the Property Management Tool, and the Import/Export Utility.

This introduction contains the following sections:

- About the WebCenter Sites JSON File

- Viewing Property Values in the WebCenter Sites JSON File

- Using the Property Management Tool

- Using the Import/Export Utility to Manage WebCenter Sites Properties

1.1 About the WebCenter Sites JSON File

Most WebCenter Sites properties are located in the WebCenter Sites wcs_properties.json file. The WebCenter Sites JSON file is located in the <domain_home>/wcsites/wcsites/config directory of your WebCenter Sites installation.

WebCenter Sites provides two ways to manage the properties in the WebCenter Sites wcs_properties.json file:

- Property Management Tool which is accessible from the WebCenter Sites Admin interface. For information, see Accessing the Property Management Tool.

- Import/Export Utility which you access by running a command line prompt for propertiesUtility.bat (for Windows) and propertiesUtility.sh (for Unix). For instructions, see Using the Import/Export Utility to Manage WebCenter Sites Properties.

The following topics provide overview information about the tools used to manage the WebCenter Sites wcs_properties.json file:

- Overview of the Property Management Tool

- Overview of the Import/Export Utility

1.1.1 Overview of the Property Management Tool

When WebCenter Sites is running, use the Property Management Tool to set the values of properties in the WebCenter Sites wcs_properties.json file. It is recommended to always use the Property Management Tool to set values for the properties in this file.

The Property Management Tool ensures that property values are correctly formatted; specifically, the correct property separator characters are used. Furthermore, the Property Management Tool provides descriptive information about the properties, as well as default or possible values. In addition, since properties in the WebCenter Sites wcs_properties.json file are organized by category, the Property Management Tool enables users to search for properties by category and subcategory.

1.1.2 Overview of the Import/Export Utility

When WebCenter Sites is not running, use the Import/Export utility to make changes to the properties in the WebCenter Sites wcs_properties.json file.

The Import/Export Utility enables users to extract the properties from the WebCenter Sites wcs_properties.json file into a property file format (.ini or .properties) to their local system. Once you update the desired properties, you then run an import command to import the changes into the WebCenter Sites wcs_properties.json file. When the WebCenter Sites system is restarted, your property changes are updated on all WebCenter Sites instances.

1.2 Viewing Property Values in the WebCenter Sites JSON File

To view all the properties and their values configured on your system:

1. Log in to WebCenter Sites, select a site name, and access the Admin interface.

2. In the navigation pane, select the General Admin section, and then expand Admin.

3. In the Admin tree, expand System Tools, then System Information, and then double-click Sites Info.
The Sites Information form opens.

4. In the Sites Properties Available list box, select wcs_properties.json file and then click Add.

5. Click Show Results.
The Sites Properties form opens and displays the name of the wcs_properties.json file.

6. Expand the wcs_properties.json node to view a list of all the properties and their current values (shown in Figure 1-1).

Figure 1-1 Sites Properties

1.3 Using the Property Management Tool

The following topics provide instructions for working with the Property Management Tool:

- Accessing the Property Management Tool

- Setting Properties

- Adding Properties

- Deleting Properties

1.3.1 Accessing the Property Management Tool

The Property Management Tool is located in the WebCenter Sites Admin interface.

1. Log in to WebCenter Sites with administrator credentials, select the name of a site, and then select the Admin interface icon.

2. In the Admin tree, expand the System Tools node.

3. Under the System Tools node, double-click Property Management.

The Property Management Tool opens, as shown in Figure 1-2:

Figure 1-2 Property Management Tool

1.3.2 Setting Properties

This section provides instructions about setting properties for WebCenter Sites and its applications.

1. Open the Property Management Tool, as described in Accessing the Property Management Tool.

2. Search for the property you want to configure. Enter values for the following fields:

- Name: Enter the full or partial name of the property you want to view.

- Category: (Optional) select the name of the category associated with the property.

- SubCategory: (Optional) If a category is selected from the Category field, the subcategories associated with that category are shown in this drop-down menu. Select the name of the subcategory associated with the property.

- Global: Select one of the following options:

- All: All properties with the specified name and category are shown in the results.

- True: Only properties where the Global flag is set to true are shown in the results.

- False: Only properties where the Global flag is set to false are shown in the results.

3. Click Search.

The properties that match your search criteria are listed under the Properties section of the page.

4. Click the name of the property whose value you want to modify.

The property details are displayed as follows:

- Category: shows the category under which this property is listed.

- Valid Values: lists the possible values for the property.

- SubCategory: shows the subcategory of the property.

- Default Value: the recommended value of the property.

- Description: provides information about the property.

- Value: the actual value of the property.

- Global: indicates that the value of this property is to be shared across all cluster nodes.

- Restart Required: indicates whether the application server must be restarted so the new value can take effect.

5. In the Value field, enter a value for this property.

6. Click Save.

7. Repeat steps 2 through 6 for each property you want to configure.

8. If the property you saved has restart_required set as true, stop and restart the application server so the new values can take effect.

1.3.3 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 Working with Resultset Caching and Queries in Developing with Oracle WebCenter Sites.) All custom properties are added to the wcs_properties.json file.

To add properties to your WebCenter Sites system, follow the steps below:

1. Open the Property Management Tool, as described in Accessing the Property Management Tool.

2. Click Add.

The new property form opens under the Properties section of the Property Management Tool.

3. Enter values for the new property in the following fields:

- Key: enter the name of the property you need to add.

- Valid Values: enter any possible values for the property.

- Category: Custom. This value is shown in the property's Category parameter in the wcs_properties.json file.

- Default Value: enter the recommended value for this property.

- SubCategory: enter a sub category for this property (if any).

- Value: set the value of the property.

- Description: enter a description of this property.

- Global: select this checkbox to indicate that the property and its value must be shared across all cluster nodes.

- Restart Required: select this checkbox if the application server must be restarted for the new property and value to take effect.

4. Click Save.

5. If you set the restart_required flag to true, stop and restart the application server so the new property can take effect.

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

Caution:

You can only delete custom properties. Never delete a required property.

1. Open the Property Management Tool. (See Accessing the Property Management Tool.)

2. Search for the property you want to configure (for search information, see step 2).

The properties that match your search criteria are listed under the Properties section of the page.

3. Click the name of the property you want to remove.

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

5. Click Delete.
A confirmation message is displayed.

6. Click Yes.

7. If the restart_required flag for the deleted property was set to true, stop and restart the application server so the changes can take effect.

1.4 Using the Import/Export Utility to Manage WebCenter Sites Properties

The Import/Export Utility is used to import and export the WebCenter Sites JSON file properties in a property file format (.ini or .properties) when WebCenter Sites is not running. The exported property file contains all the properties for WebCenter Sites in a key=value format. This exported property file can then be modified and the changed settings imported into WebCenter Sites.

Note:

The Import/Export utility enables you to update property values when WebCenter Sites is not running. For all other property changes, including modifying property values when WebCenter Sites is running and adding custom properties, use the Property Management Tool.

The commands for accessing the Import/Export utility are as follows:

- For Windows systems, use the propertiesUtility.bat command file. For example:
propertiesUtility.bat <sites_home> <config_folder> export <properties_file>

- For Unix systems, use the propertiesUtility.sh command file and separate each command parameter with a forward slash (/). For example:
propertiesUtility.sh /oracle/sites-home /oracle/config export /export/my_config.properties

The following instructions use the propertiesUtility.bat command file.

To run the Import/Export Utility:

1. Open a command prompt window and cd to your sites-home/bin directory.

2. Export the properties from the JSON file to a property file of your choice (.ini or .properties):

>propertiesUtility.bat <sites_home> <config_folder> export <properties_file>

For example, to export the JSON file properties to a my_config.properties file, enter the following export command:

>propertiesUtility.bat c:/oracle/sites-home C:/oracle/config export
c:/export/my_config.properties

The utility creates the property file in the directory you specified in your export command.

3. Navigate to and open the property file in a text editor. The properties are listed in a key=value format. Modify the values of the desired properties and then save the property file.

For keys that have cluster node specific values, the name of the node on which the changes should take place is appended as a suffix (---NodeName) to the key. For example, for the valid.urls key, there will be 2 entries in the property file:

- valid.urls=some_value

- valid.urls---nodeA=some_value_specific_to_nodeA

4. Import the updated properties into the JSON file:

- If WebCenter Sites is not running, use the following import command:

>propertiesUtility.bat <sites_home> <config_folder> import <properties_file>

Where <properties_file> is the path to properties file containing the updated properties and <config_folder> is the path to the config folder.

- If WebCenter Sites is running, and you want to import your updates and dynamically update all WebCenter Sites instances with your changes, append the flush flag to the import command as follows:

>propertiesUtility.bat <sites_home> <config_folder> import <properties_file>
[flush sites-url]

For example:

>propertiesUtility.bat c:/oracle/sites-home C:/oracle/config import c:/import/
my_config.properties flush http://localhost:8080/sites

The flush flag invalidates the cache in WebCenter Sites that stores the configuration settings. The flush flag requires you to specify the URL of your local WebCenter Sites instance (sites-url).

The updated property values are imported into the JSON file. If you specified arguments to dynamically update WebCenter Sites, you see your changes immediately. If the system is not running, your changes will take-hold upon startup.

2 A/BTest Properties

The following topics provide information about each property associated with the ABTest category in the wcs_properties.json file:

- About the Properties in the A/BTest Category

- Properties in the A/BTest Category

2.1 About the Properties in the A/BTest Category

Properties categorized under the A/BTest category in the WebCenter Sites wcs_properties json file, configure the WebCenter Sites A/B Test feature. They determine whether an A/B Test has been created on a content management site, on which WebCenter Sites instance A/B Tests should be delivered, and evaluate which site visitors are targeted by an A/B Test.

2.2 Properties in the A/BTest Category

Table 2-1 provides a description for each of the properties in the wcs_properties.json file that are associated with the ABTest category.

Table 2-1 A/BTest Properties

Property

Description

abtest.autosave.enabled

Specifies whether auto save operations are enabled when creating an A/B Test, to minimize prompting.

Possible values: true|false

Default value: false

abtest.delivery.enabled

Specifies whether this WebCenter Sites instance should deliver A/B Tests.

Possible values: true|false

Default value: false

abtest.minvariantvisitors

Specifies the minimum number of visitors per variant to observe before computing an A/B Test winner.

Default value: 1000

abtest.visitors.profile

Specifies the Visitor Services profile to use when evaluating visitor eligibility for an A/B Test.

abtest.analytics.provider

Specifies the analytics provider for an A/B Test. Value: GA.

abtest.ga.application.name

Specifies the application name for Google Analytics for an A/B Test.

abtest.ga.keyfile.name

Specifies the name of the keyfile (p12) for Google Analytics.

Note:
The file must be in the classpath, typically in the config folder.

abtest.ga.service.email

Specifies the service account email for Google Analytics for an A/B Test.

abtest.ga.account.id

Specifies the account Id for Google Analytics for an A/B Test.

abtest.ga.webproperty.id

Specifies the web property id for google analytics for an A/B Test.

abtest.ga.profile.id

Specifies the profile Id for Google Analytics.

3 Cache Properties

The following topics provide information about each property associated with the Cache category in the wcs_properties.json file:

- About the Properties in the Cache Category

- Properties in the Cache Category

3.1 About the Properties in the Cache Category

Properties categorized under the Cache category are used to configure the BlobServer servlet, Page caching, Resultset caching, cluster settings, backwards compatibility settings, satellite server settings, asset default settings, security settings, session timeouts, and Global Unique Identifiers used by the WebCenter Sites servlets.

The Cache category contains the following types of properties:

- Blob Server Properties

- Page Cache Properties

- Resultset Caching Properties

- Cluster Properties

- Compatibility Properties

- Satellite Server Properties

- Asset Default Properties

- Security and Session Timeout Properties

3.1.1 Blob Server Properties

Blob Server properties 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.

3.1.2 Page Cache Properties

Page caching properties 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.

For more information about page caching, see Oracle Fusion Middleware Developing with Oracle WebCenter Sites.

3.1.3 Resultset Caching Properties

ResultSet caching properties configure resultset caching for WebCenter Sites. For information about resultset caching and queries on your WebCenter Sites system, see Oracle Fusion Middleware Developing with Oracle WebCenter Sites.

ResultSet caching properties include:

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

3.1.4 Cluster Properties

Cluster properties are used by WebCenter Sites to communicate with all the servers in a cluster when a WebCenter Sites system is installed in a cluster.

3.1.5 Compatibility Properties

Compatibility properties set values necessary for backward compatibility with earlier versions of WebCenter Sites.

3.1.6 Satellite Server Properties

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

3.1.7 Asset Default Properties

Asset default properties are used to define certain default details about asset types, such as cache information, default ACLs, and whether CKEditor is present.

3.1.8 Security and Session Timeout Properties

Properties that control such things as security settings, session timeouts, Global Unique Identifiers that the WebCenter Sites servlets use, 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.

3.2 Properties in the Cache Category

Table 3-1 provides a description for each of the properties in the JSON file that are associated with the Cache category.

Table 3-1 Cache Properties

Property

Description

bs.bCacheSize

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

Default value: 1000

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

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

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

Subcategory: Blobcache

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.

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

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.

Default value: false

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.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.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.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.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 the timeout for this table)

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.

Default value: 10000

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

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

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

Subcategory: Pagecache

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.

Default value: false

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

Possible values: true | false

Default value: true

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

Note: How this property takes effect depends on the value of the bs.bCacheTimeout property.

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

This property is no longer used. When setting cacheinfo for a SiteCatalog entry, previously you had to set a property that pointed to a valid folder in order to cache items. An invalid property or an invalid folder would result in pages not being cached. This property was the default location to which pages would be cached.

Now, we do not need to specify a cs.pgcachefolder because cached pages are stored in the database. The cacheinfo column now allows a boolean value, true or false, to specify whether or not a page will be cached.

If the value is neither true nor false, it will be checked according to the previous behavior, such that it must be set to a property referring to a valid folder for caching to occur.

Until SiteCatalog cacheinfo entries have been corrected on your site, you should keep this property around and set it to a valid folder.

Typical values include:

- c:/FutureTense/pgcache

- /export/home/FutureTense/pgcache

Edit this value to match your installation requirements.

Default value: <wcsites.home>/cache

cs.pgCacheTimeout

Specifies the number of minutes that a page will exist in the page cache.

Default value: 0

cs.recordBlobInventory

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

Default value: 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

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: cc.cacheResults, cc.cacheResultsTimeout, and 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.

Possible values: true | false

Default value: true

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 Troubleshooting Using System Tools in Administering Oracle WebCenter Sites. Additional information about resultset caching is also available in Working with Resultset Caching and Queries in Developing with Oracle WebCenter Sites.

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 property, see the expiration property.

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

Possible values: true | false

Default value: false

Subcategory: Pagecache

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

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

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

For definitions of these variables and for more information about page criteria variables, see Understanding Page Design and Caching in Developing with Oracle WebCenter Sites.

xcelerate.defaultpagecriteriaSiteEntry

Default page criteria for SiteEntry asset.

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, sitepfx, seid

- rendermode indicates whether this is a preview or a live rendering.

- site indicates to which site this template applies (needed for SiteBuilder style site entries).

- sitepfx indicates the site prefix as defined in the Publication table (needed for SiteBuilder style site entries).

- seid is the SiteEntry id which will be used for cache management.

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

4 CAS Properties

The following topics provide information about each property associated with the CAS category in the wcs_properties.json file:

- About the Properties in the CAS Category

- Properties in the CAS Category

4.1 About the Properties in the CAS Category

The properties categorized under CAS in the WebCenter Sites wcs_properties.json file configure the CAS web application, including the CSSO facility.

4.2 Properties in the CAS Category

Table 4-1 provides a description for each of the properties in the JSON file that are associated with the CAS category.

Table 4-1 CAS Properties

Property

Description

wcsites.cas.host

The name of the remote host system running WebCenter Sites that the Satellite engine is caching requests for.

Default value: <wcsites.cas.host>

wcsites.cas.port

The port number for communicating with the WebCenter Sites host.

Possible values:

Default value: <wcsites.cas.port>

5 Cluster Properties

The following topics provide information about each property associated with the Cluster category in the wcs_properties.json file:

- About the Properties in the Cluster Category

- Properties in the Cluster Category

5.1 About the Properties in the Cluster Category

Properties categorized under Cluster are used to communicate with all the servers in a cluster when a WebCenter Sites system is installed in a cluster.

5.2 Properties in the Cluster Category

Table 5-1 provides a description for each of the properties in the JSON file that are associated with the Cluster category.

Table 5-1 Cluster Properties

Properties

Description

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.

Default value: mycluster

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.

Default value: <wcsites.shared>/clustersync

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: <wcsites.shared>/lock

6 Connector Properties

The following topics provide information about each property associated with the Connector category in the WebCenter Sites wcs_properties.json file:

- About the Connector Category

- Properties in the Connector Category

6.1 About the Connector Category

Properties categorized under Connector are used to optimize conditions in the WCC Connector and to troubleshoot. The WCC Connector is part of the WebCenter Content integration and enables you to set up and manage content synchronization.

For information about WebCenter Content integration, see Integrating with Oracle WebCenter Content in Administering Oracle WebCenter Sites.

6.2 Properties in the Connector Category

The table below provides a description for each property categorized under Connector in the WebCenter Sites wcs_properties.json file.

Table 6-1 Properties in the Connector Category

Property

Description

wcc.batch.autorepeat

If set to true, the Connector automatically starts to download the next batches.
Default value: true

wcc.batch.size

Specifies the number of zip files will be downloaded from the remote UCM server per each fetching.

Default value: 50

wcc.conversions

Semicolon separated list of supported UCM conversions.

Default value: html;images

wcc.download.autoclean

If set to true, contents (zip files) are deleted once processed.

Default value: true

wcc.download.dir

Specifies the name of the folder where content (zip files) from UCM is first downloaded.

wcc.keyfield

Specifies the name of the field that is used as key.

Default value: name

wcc.queuetoken

Current token that refers to a position of queue to be downloaded in the remote UCM server.

wcc.renditions

Semicolon separated list of supported UCM renditions.

Default value: pimary;web

wcc.rule.case-sensitive

Specifies whether rules are case sensitive.

Default value: true

wcc.server.password

Specifies the password to the remote UCM server.

wcc.server.url

Specifies the URL to the remote UCM server.

wcc.server.user

Specifies the name to the remote UCM server.

7 Core Properties

The following topics provide information about each property associated with the Core category in the wcs_properties.json file:

- About the Properties in the Core Category

- Properties in the Core Category

7.1 About the Properties in the Core Category

Properties categorized under Core are created by WebCenter Sites during installation. The properties include database configuration properties, installation properties, and properties that specify the type of system you are running.

7.2 Properties in the Core Category

Table 7-1 provides a description for each of the properties in the JSON file that are associated with the Core category.

Table 7-1 Core Properties

Property

Description

cc.attributeinheritance

A boolean that WebCenter Sites uses to determine whether attributes should be inherited from parent to child.

Default value: true

cc.bigint

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

Possible values:

- Oracle: NUMBER(38)

- SQL Server: BIGINT

- DB2: BIGINT

cc.bigtext

Specifies the SQL string for defining a large text field.

Possible values:

- Oracle: CLOB

- SQL Server: TEXT

- DB2: LONG VARCHAR

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

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

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

cc.datepicture

Specifies how WebCenter Sites creates a date/time literal.

Default value: {ts '$date'}

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

cc.double

Specifies the SQL string for defining a double field.

Possible values:

- Oracle: NUMBER(38, 10)

- SQL Server: NUMERIC(28, 10)

- DB2: FLOAT

cc.extrapath

A boolean that WebCenter Sites uses to determine if blobs should have extra path information prepended to avoid directory capacity issues on Unix.

Default value: true

cc.FiltersKey

The primary key of the Filter table, a content table that the WebCenter Sites installation creates to store flex filter assets. For information about Filter assets, see Creating Flex Filters in Developing with Oracle WebCenter Sites

Default value: name

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

cc.fullconstraint

A boolean that WebCenter Sites uses to determine if nested queries should include data from the outer query.

Possible values: true | false

Default value: true

cc.ignoreTblCase

Determines whether WebCenter Sites ignores case when assessing table names.

Possible values: yes | no

- Oracle: yes

- SQL Server: yes

- DB2: yes

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

cc.integer

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

Possible values:

- Oracle: NUMBER(10)

- SQL Server: INT

- DB2: INTEGER

cc.maxvarcharsize

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

Possible values:

- Oracle: 2000

- SQL Server: 8000

- DB2: 4000

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: extension

Do not change the value of this property.

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

cc.numeric

Specifies the SQL string for defining a numeric field.

Possible values:

- Oracle: NUMBER

- SQL Server: NUMERIC

- DB2: NUMERIC

cc.PreviewgenKey

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

Default value: name

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

cc.queryablemaxvarcharlength

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

Possible values:

- Oracle Thin: 255

- Oracle TypeII: 2000

- SQL Server: 255

- DB2: 255

Default value: 2000

cc.querystyle

A boolean that WebCenter Sites uses to determine which basic form of assetset query to generate.

Possible values: subquery, join, or intersect

Default value: subquery

Note: Setting the value of this property to intersect functions only if your database can support intersection queries.

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

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

Default value: false

cc.smallint

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

Possible values:

- Oracle: NUMBER(5)

- SQL Server: SMALLINT

- DB2: SMALLINT

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

The primary key of the StatusCode table.

Default value: statuscode

Do not change the value of this property.

cc.string

The SQL for defining a field that will contain string values.

Default value: SEARCHVARCHAR

Do not change the value without consulting your database administrator.

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'

cc.textdistinct

A boolean describing whether your database can support DISTINCT on attributes of type TEXT.

Default value: no

cc.unique

Specifies the SQL string for defining a unique field.

Default value: UNIQUE NOT NULL

cc.url

The SQL for defining a field that will contain URLs.

Default value: VARCHAR(128)

Do not change this value without consulting with your database administrator.

cc.urlattrpath

Specifies the default base path WebCenter Sites uses for URL attribute files.

Default value: <wcsites.shared>/ccurl/

cc.varchar

Specifies the SQL string for defining a VARCHAR data type.

Default value:

- Oracle: VARCHAR

- DB2: VARCHAR

- MSSQL: VARCHAR2

- SQL Server, multi-lingual Unicode: NVARCHAR

cluster.nodes

Comma separated list of all the cluster nodes in a given WebCenter Sites environment. Each node has its own name, in a node.name format. Each node name is identified by the sites.node property in the JVM system.

cos.contextroot

Specifies the name of the context root on which the Community application is installed.

cos.protocol

Specifies the name of the protocol on which the Community web application is installed.

cookieserver.invalidnames

Comma separated list of invalid names which are ignored by CookieServer.

Default value: Set-Cookie

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

Set at installation time. This property points to the location where the shared libraries are installed.

Note: Do not change the value of this property.

cs.charset

The name of the optional parameter that defines the character encoding of the input.

Default value: _charset_

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; charset=UTF-8

cs.csdtfolder

Specifies the folder used by WebCenter Sites Developer Tools imports.

Default value: <wcsites.home>/export

cs.csdtworkspace

Specifies the name of the default datastore used by Developer Tools. Works in conjunction with cs.csdtfolder.

Possible values:

Default value: cs_workspace

cs.dataindatabase

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

Default value: false

cs.dbconnpicture

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

Default value: <wcsites.database.connectionpicture>

cs.dbencoding

Specifies the character set used by the WebCenter Sites database.

Default value: UTF-8

cs.dbtype

Defines the type of database to which you are connecting.

cs.documentation

Specifies the URL of the WebCenter Sites documentation.

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

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

cs.dsn

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

cs.emailaccount

Specifies the destination email address for emails sent by the admin user.

cs.emailauthenticator

Specifies the class 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 left blank, its value reverts to the default text/plain.

cs.emailhost

Defines the SMTP (e-mail server) host:port 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.

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: <wcsites.app.protocol>://<wcsites.app.host>:<wcsites.app.port>

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

Default value: 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: /jsp/ synchronized with the WebLogic setting for cs.jsproot and is set during 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.

Default value: false.

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.

Default value: <wcsites.home>/Installation/jsp.

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

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)

cs.session

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

Possible values: true | false

Default value: false

Note: This property cannot be set to false when the cc.security property is set to true.

cs.sitepreview

This property is used to control the behavior of Site Preview functionality.

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

Possible values: disabled, contentmanagement, and 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: contentmanagement

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 Admin interface. For more information about System Tools, see "System Tools" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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

Default value: false

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: 900 (15 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.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.

Default value: false

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

cs.webreference.conflicts

This property specifies how WebCenter Sites handles URL conflicts during save operations.

Possible values:

- _FAIL_: Causes the save to fail.

- _OVERWRITE_: Deletes the old URL and saves the new one.

- _IGNORE_: Keeps the old URL and ignores the new one.

- Any other alphanumeric value will be used as a suffix to edit old URLs.

Default value: _IGNORE_

cs.wrapper

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

Default value: false.

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

cs.xmlfolder

Specifies the working directory for HTML filtering.

Default value: <wcsites.home>/xmltemp

cs.xmlHeader

This is the XML Header streamed out for SOAP responses.

Default value: <?xml version=\"1.0\" encoding=\"UTF-8\"?>

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

/sites/ – in http servlet application environments.

ft.contentserver

Defines the Global Unique Identifier (GUID) for the ContentServer servlet.

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

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

ft.treemanager

Defines the Global Unique Identifier (GUID) for the Treemanager servlet.

Default value: {1903F070-96C9-11D2-B5E2-0010A4FD534E}

Note: Do not modify this value.

ft.version

Specifies the version number of the WebCenter Sites application.

Do not modify this value.

HttpServletResponseBufferSize

Specifies the size of the buffer for responses sent to remote Satellite Server.

Default value: -1

product.installation.type

Indicates the name of the installation. This property is set during installation.

Do not modify the value of this property.

Possible values: Sites or RSS (Remote Satellite Server).

regen.servers

The port number for communicating with the WebCenter Sites host.

Default value: <wcsites.app.protocol>://<wcsites.app.host>:<wcsites.app.por>/<wcsites.app.contextroot>/ContentServer

secure.CatalogManager

Specifies whether the DefaultReader user can access the CatalogManager servlet.

Possible values: true | false

Default value: 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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

security.keys.created

Indicates whether security keys are created. When security keys are created, this property is set to true automatically.

Do not modify the value of this property.

Default value: false

sites.environment

This property identifies the environment for the Vanity URL generation and resolution. Absolute Vanity URL will be generated based on Virtual root URL defined for this environment. If this value is empty, then the Root URL property of the WebRoot will be used for URL generation and resolution.

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.

secure.TreeManager

Specifies whether the DefaultReader user can access the TreeManager servlet.

Default value: true

For more information, see "Setting Up External Security" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

security.checkpagelets

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

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

site.prefix

Comma separated list of unique site prefixes required for resolving vanity URLs using the rewriter filter. By default, this list contains a unique prefix for each sample site installed on your system.

For information about the rewriter filter, see Administering Oracle WebCenter Sites

Default value: fsii, avi

transformer.imgdir

This property is set to the fully qualified path indicating where WebCenter Sites should store image files after transforming a document.

Default value: <wcsites.shared>/remoteimages/

transformer.imgurl

This property is set to the prefix that should be added to the SRC attribute of IMG tags generated by the WebCenter Sites document transformer.

Default value: /futuretense_cs/remoteimages/

valid.urls

Specifies the trusted URLs users are permitted to use to access WebCenter Sites.

Default value: <wcsites.app.protocol>://<wcsites.app.host>:<wcsites.app.port>/<wcsites.app.contextroot>/*

wcsites.app.admin.user

Specifies the user name of the WebCenter Sites application administrator.

wcsites.app.contextroot

Specifies the WebCenter Sites context root. For example: /sites/.

wcsites.app.host

Specifies the WebCenter Sites host name.

wcsites.app.port

The port number for communicating with the WebCenter Sites host.

wcsites.app.protocol

The communication protocol between the Satellite Server host and the WebCenter Sites host.

wcsites.database.connectionpicture

Specifies the JNDI URI for accessing the datasource in WebLogic.

wcsites.database.datasource

Specifies the datasource name used for WebCenter Sites.

wcsites.forgot.password

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

wcsites.home

Specifies the location of the WebCenter Sites home directory.

wcsites.shared

Specifies the location of the shared file system. This can either be a directory or a reference to a database location.

wcsites.system.admin.user

Specifies the user name of the WebCenter Sites system administrator.

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

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

Default value: 64

Note:
The maximum value is also the same value as the default value, that is 64.

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: c:/Fatwire/elements/OpenMarket/Xcelerate

- Unix: /export/home/Fatwire/elements/OpenMarket/Xcelerate

xcelerate.charset

Specifies the character encoding used by the editorial pages, and should be changed only when a browser does not support UTF-8.

Default value: UTF-8

Changing this property from the default value may limit the characters that are supported.

xcelerate.ckeditor.basepath

CKEditor basepath; that is, the location of the CKEditor files in the WebCenter Sites application.

Default value: /<wcsites.app.contextroot>/ckeditor/

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

Specifies the default language.

Default value: en_US

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 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.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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

xcelerate.imageeditor.basepath

Online Image Editor (OIE) basepath; that is, the OIE archive location (relative URL), file name, and version.

Default value: /<wcsites.app.contextroot>/ImageEditor/OIE.cab#version=3,0,1,12

xcelerate.imageeditor.clarkii.basepath

Path to the Clarkii Online Image Editor files in the WebCenter Sites application.

Default value: /<wcsites.app.contextroot>/ImageEditor/clarkii/

xcelerate.imageurl

Specifies the webroot for all image URLs used by the applications.

Default values: Xcelerate

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.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: <wcsites.shared>/savedsearch

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: <wcsites.shared>/tempobjects

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: <wcsites.shared>/thumbnails

xcelerate.transformpath

Set at installation time. This property sets the path to the directory where Microsoft Word files are stored before WebCenter Sites transforms those files into assets.

Default value: <wcsites.home>/xmltemp/

Note: Do not change the value of this property.

xcelerate.useidmapping

System property used for WebCenter Sites runtime.

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.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: <wcsites.shared>/workflow

Note: If you change the value from the default, be sure that directory exists.

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

Note: Do not change the value of this property.

8 CORS Properties

The following topics provide information about the properties in the wcs_properties.json file that configure the Cross-origin resource sharing (CORS) mechanism:

- About the Properties in the CORS Category

- Properties in the CORS Category

8.1 About the Properties in the CORS Category

The properties that configure the Cross-origin resource sharing (CORS) mechanism for WebCenter Sites are categorized under the CORS category. These properties allow WebCenter Sites resources to be requested from domains outside of the WebCenter Sites domain.

When a request from a domain outside of WebCenter Sites is made for a WebCenter Sites resource, the browser "preflights" the request by soliciting supported domain methods from WebCenter Sites with an HTTP OPTIONS request header. Upon approval from WebCenter Sites, CORS sends the request with the HTTP request method. WebCenter Sites can also notify clients whether "credentials" (including Cookies and HTTP Authentication data) should be sent with requests.

The CORS properties enable you to restrict domains, methods, and so on. When you modify these properties using either the Property Management Tool or the Import/Export Utility does not require you to restart the server for the changes to take effect. For descriptions of the properties categorized under CORS in the wcs_properties.json file, see Properties in the CORS Category.

8.2 Properties in the CORS Category

Table 8-1 provides a description for each of the properties in the JSON file that are associated with the CORS category.

Table 8-1 Cors Properties

Property

Description

cors.allowCredentials

Specifies whether user credentials (cookies) in cross origin requests.

Default value: false

cors.allowOrigin

Comma-separated list of origins (in the format: <scheme>://<host>:<port>) that are allowed to access WebCenter Sites resources from a domain other than the WebCenter Sites domain.

Default value: * which allows any domain to access WebCenter Sites resources.

cors.maxAge

Use this property to specify an integer that indicates the maximum amount of time the results of a preflight request can be cached by the client.

cors.supportedMethods

Defines the cross domain request HTTP methods supported by WebCenter Sites.

Default value: GET, HEAD, POST, OPTIONS

9 Engage Properties

The following topics provide information about each property associated with the Engage category in the wcs_properties.json file:

- About the Properties in the Engage Category

- Properties in the Engage Category

9.1 About the Properties in the Engage Category

Engage is a WebCenter Sites marketing component that enables WebCenter Sites users to create assets that collect visitor data, define visitors into segments, recommend products and content to visitors based on segments, and run promotions that apply to all or specific segments. Properties categorized under the Engage category enable administrators to manage the visitor data collected by Engage assets, and configure the options marketers can choose from when creating Engage assets.

9.2 Properties in the Engage Category

Table 9-1 provides a description for each of the properties in the JSON file that are associated with the Engage category.

Table 9-1 Engage Properties

Properties

Description

mwb.cartsetdir

Specifies the directory path (including the terminating slash character) where cartset data files are stored. Be sure to end the directory with a /.

This value is set by the installation.

Do not change the value of this property.

Default value: /gator/cartset directory in the installation directory

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

Default value: false

mwb.externalattributes

Specifies a Boolean value that WebCenter Sites uses to determine if forms should allow users to define external attributes.

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

mwb.commerceuserclass

Specifies the name of the class that supplies the services for commerce user management.

Default value: com.openmarket.catalog.cart.CommerceUser

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

Specifies the name of the class that supplies the services for search state management.

Default value: com.openmarket.searchstate.SearchState

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

Specifies the name of the class that supplies the services for commerce engine management.

Default value: com.openmarket.cscommerce.txcart.TransactEngine

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

Specifies the default attribute asset name for WebCenter Sites to use when creating assetsets.

Default value: blank

mwb.path

Specifies the directory where WebCenter Sites is installed. Be sure to end the directory with a forward slash (/).

Default value: <wcsites.home>

Do not change the value of this property.

mwb.searchdir

Specifies the directory where WebCenter Sites places rich-text indexes. Ensure to end the directory with a forward slash (/).

Default value: <wcsites.shared>/gator/searchdir/

Do not change the value of this property.

ms.enable

Set to true by the WebCenter Sites installation process, to enable Oracle WebCenter Sites: Engage.

Default value: true

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

Default value: <wcsites.shared>/classes/

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. Otherwise, set to false.

Default value: true

vis.compileclasspath

Comma separated list of name prefixes for jars used to build the CLASSPATH to compile rules.

This value is set during the installation and should not be changed after that point.

Default value: sites-cs, sites-core, sites-app

vis.path

Specifies the directory where WebCenter Sites is installed. Be sure to end the directory with a /.

Default value: <wcsites.home>/

Do not change the value of this property.

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

The role attached to all tables that a standard visitor editor can access and edit.

Default value: Visitor

Do not change the value of this property.

vis.rulesetxmlpath

Specifies the default storage directory for the XML versions of the rule sets.

This value is set during installation.

Default value: <wcsites.shared>/ruleset/

Do not change the value of this property.

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.

Default value: NUMERIC(20, 3)

vis.urlpath

Specifies the default storage directory for binary visitor and history attributes.

Default value: <wcsites.shared>/visurl/

vis.sessiondata

Specifies the default storage directory for storing visitor session data.

This value is set during installation.

Do not change the value of this property.

10 Installer Properties

The following topics provide information about each property associated with the Installer category in the wcs_properties.json file:

- About the Properties in the Installer Category

- Properties in the Installer Category

10.1 About the Properties in the Installer Category

The properties categorized under Installer in the wcs_properties.json file are set during the WebCenter Sites installation.

10.2 Properties in the Installer Category

Table 10-1 provides a description for each of the properties in the JSON file that are associated with the Installer category.

Table 10-1 Installer Properties

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

Default value: info

tx.numStores

The number of stores to be configured. This integer determines the number and names of properties necessary in the 'Overrides for Tx Store X' categories.

There may be a set of properties in the form of tx.store_X.propName where X is an integer between 0 and tx.numStores - 1.There must be at least 1 store defined.

Default value: 2

tx.store_0.storeID

Transact's identifier for the Store to use for purchases.

Possible values: Typically an integer greater than 400000.

Default value: 0

tx.store_1.storeID

Transact's identifier for the Store to use for purchases.

Possible values: Typically an integer greater than 400000.

Default value: 1

11 Publish Properties

The following topics provide information about each property associated with the Publish category in the wcs_properties.json file:

- About the Publish Category

- Properties in the Publish Category

11.1 About the Publish Category

Properties categorized under Publish in the WebCenter Sites wcs_properties.json file configure the WebCenter Sites publishing system.

11.2 Properties in the Publish Category

Table 11-1 provides a description for each of the properties in the JSON file that are associated with the Publish category.

Table 11-1 Publish Properties

Property

Description

afk.historydata

Specifies the directory that WebCenter Sites uses to store history data.

Default value: <wcsites.shared>/history/

afk.publishdata

Specifies the directory that WebCenter Sites uses to store publish data.

Default value: <wcsites.shared>/publish/

cs.batchtimeout

Specifies the time (in seconds) between WebCenter Sites requests before the application server invalidates the batch session, typically used by publishing. A negative time indicates that the session should never timeout.

Legal values: Between -2147483648 and 2147483647.

Default value: 360000

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.

Default value: dloginpassword -or- {AES}13971775C4B32520C2FFBA59200EE17E

For information, see "The Mirror to Server Publishing Process" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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.

Default value: 80

For information, see "The Mirror to Server Publishing Process" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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.

Default value: mirroruser

For information, see "The Mirror to Server Publishing Process" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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.

Default value: <wcsites.home>/export

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

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: <wcsites.shared>/dispatcher/

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.

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

xcelerate.approval.dependency.chunksize

This property defines the chunk size used in approval dependency. (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.)

Possible values: any integer between 1 and 1000.

Default value: 250

Note: For backwards compatibility, it is recommended to set the value of this property to 1.

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.

Default value: <hostName>:<portNumber>

xcelerate.batchloadsizeonpublish

Controls the batch size of assets loaded during a mirror publishing event. Larger batches are more sufficient, but require more memory.

Default value: 250

xcelerate.batchmode

Defines the batch publishing mode.

Possible values:

- single: batch host is a dedicated IP address.

- multiple: batch host is a cluster IP address.

Default value: single

xcelerate.batchpass

Specifies the password for the batch user.

Default value: xceladmin

Note: Change this value after you create the batch user for this WebCenter Sites system. For information, see Oracle Fusion Middleware Administering Oracle WebCenter Sites.

xcelerate.batchprotocol

The communication protocol between the Satellite Server host and the WebCenter Sites host.

Default value: <wcsites.app.protocal>

xcelerate.batchsavesizeonpublish

Specifies the number of assets to deserialize and save at one time during mirror publishing. Larger batches are more efficient but require more memory. The value of this property applies only to the target system.

Default value: 250

xcelerate.batchuser

This property specifies the username of the batch user for scheduled publish on the system. This property must be configured in order for the Scheduled Publish to run.

Default value: fwadmin

Note: Change this value after you create the batch user for this WebCenter Sites system. For information, see Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

xcelerate.concurrenttransportunpacker

Specifies whether the RealTime Publishing dispatcher should launch Transporter and Unpacker in parallel. If false, Unpacker starts after Transporter completes.

Default value: <wcsites.concurrent.transport.unpacker>

xcelerate.donotregenerate

This property specifies cached pages not to be regenerated after a publish operation.

Possible values:

- blank, (no value): all the pages in the cache that were affected by the publish session are regenerated.

- unknowndeps: all pages in which the render.unknowndeps tag is used will not be regenerated after publish.

- * (asterisk): none of the pages in the cache are regenerated. The affected pages are regenerated only when a visitor requests the page.

Default value: blank

Caution: When using this property on the delivery system, any cached pages not generated after publish are generated on the next visitor request and can result in a slower response for the visitors.

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

Default value: 4096

xcelerate.mirrorini

Specifies the wcs_properties.json file which is the property file that is used when logging in to the mirror target, (using the cs.mirroruser and cs.mirrorpassword properties), during the mirror publish operation and when creating the URLs on the mirror destination.

Do not modify this value to include additional property files without consulting Oracle support personnel.

xcelerate.objpubdir

Specifies the path to the directory (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: <wcsites.shared>/objpubdir

xcelerate.pageref

Specifies the name of the class that manages publish references for pages.

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

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

Default value: PresaveElement

xcelerate.pubabortelt

Specifies the name of the element called on the mirror target if the publish fails. Use PubAbortElement for standard mirror publishing.

Default value: PubAbortElement

xcelerate.pubcleanupelt

Specifies the name of the element called during the cleanup phase of a mirror publish. Use PubCleanupElement for standard mirror cache regeneration.

Default value: PubCleanupElement

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: <wcsites.shared>/pubkeys

xcelerate.publishallassettypes

Specifies whether to publish all asset types on mirror publish, thus guaranteeing that all asset type tables exist on the publish destination.

Possible values: true | false

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

Default value: true

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.

xcelelem.publishfactors

The name of the element to use to provide additional publishing control factors. This property can be left empty.

Default value: OpenMarket/Xcelerate/Actions/Publish/OverrideFactor

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.

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

Defines the query style to use when getting a list of assets approved for publishing.

Possible values: subquery, join

Default value: subquery

xcelerate.pubsetupelt

Specifies the name of the element that the publishing system uses during the setup phase of a mirror publish. Use PubSetupElement for standard mirror cache invalidation.

Default value: PubSetupElement

xcelerate.remotecall

Specifies the pagename which supports remote mirror element execution. Use this property to support mirroring to a remote server.

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

12 Satellite Properties

The following topics provide information about each property associated with the Satellite category in the wcs_properties.json file:

- About the Properties in the Satellite Category

- Properties in the Satellite Category

12.1 About the Properties in the Satellite Category

Properties categorized under Satellite in the WebCenter Sites wcs_properties.json file 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 has a Satellite Server wcs_properties.json 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 Server wcs_properties.json file.) For information about the properties in that file, see Satellite Server JSON File.

12.2 Properties in the Satellite Category

Table 12-1 provides a description for each of the properties in the JSON file that are associated with the Satellite category.

Table 12-1 Satellite Properties

Properties

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.

Default value: /<wcsites.app.contextroot>/BlobServer

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.

Default value: 1000000

contentserver.installation.folder

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.

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.

Default value: <wcsites.home>

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.

Default value: JSESSIONID;WebLogicSession;GX_SESSIONID

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.

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

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.

Default value: action=\"ContentServer\"

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.

Default value: false

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.

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.

Default value: action=\"Satellite\"

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.

Default value: <wcsites.app.protocal>://

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.

Default value: /<wcsites.app.contextroot>/ContentServer

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

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 (that is, 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.

Default value: SS_X_

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.

Default value: true

ss.password

The password for the Satellite Server user, on the Satellite Server side. This is encrypted, using a two-way hash function.

Default value: <wcsites.satelliteserver.password>

ss.username

The username for the Satellite Server user, on the Satellite Server side. This must match the value for the wcsites.satelliteserver.username property.

Default value: <wcsites.satelliteserver.username>

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.

Default value: text/.*|.*xml.*

wcsites.satelliteserver.password

The password for the Satellite Server user, on the WebCenter Sites system. This is encrypted using a two-way hash function.

Default value: <wcsites.satelliteserver.password>

wcsites.satelliteserver.username

Specifies the Satellite Server username on the WebCenter Sites system.

Default value: satteliteserver

13 Security Properties

The following topics provide information about each property associated with the Security category in the wcs_properties.json file:

- About the Properties in the Security Category

- Properties in the Security Category

13.1 About the Properties in the Security Category

Properties in the Security category determine how security is configured on both the management and the delivery systems. Before developers design the online site or make changes to the user interface on the management system, you must implement your security protocols using the Security properties in the WebCenter Sites wcs_properties.json file.

Additionally, Security properties with the sub category Content Security allow you to configure content security protection for websites developed through WebCenter Sites. Content Security is a standard which enables you to determine whether pages returned by the browser can be embedded inside an iframe of some other website. For detailed information about Content Security, see the specification documentation about the Content Security Policy.

13.2 Properties in the Security Category

Table 13-1 provides a description for each of the properties in the JSON file associated with the Security category.

Table 13-1 Security Properties

Property

Description

connect-src

List of URIs the protected resource can load using script interfaces.

Subcategory: Content Security

contentsecurity.enabled

Set the value to true to enable Content Security protection.

Default value: false

Subcategory: Content Security

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.

Default value: password

default-src

Comma-separated source list of default directives. For example: child-src,connect-src,img-src,object-src,script-src,style-src.

Subcategory: Content Security

frame-ancestors

Allowed hosts for embedding protected resource in iframes.

Possible values:

- self blank: the pages from the current site can be embedded either by an ancestor frame that has the src attribute as about:blank or the current site itself.

- about:blank: Required for WebCentrer Sites to work because pages are made of frames that have #about:blank as src.

Subcategory: Content Security

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.

Default value: REMOTEPASS;pubtgt:factors;factors

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.

img-src

Restricts from where the protected resource can load images.

Subcategory: Content Security

object-src

Restricts from where the protected resource can load plugins.

Possible values:

- self

- blank

Subcategory: Content Security

script-src

Restricts which scripts the protected resource can execute.

Subcategory: Content Security

xcelelem.manageuserpub

Defines the element used for managing the roles that users fulfill on sites in WebCenter Sites.

Default value: OpenMarket/Xcelerate/Actions/Security/AccessUserPublication

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,checkout,copy,edit,delete,rollback,approve

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

Contains a comma-separated list of roles that are not allowed to create a site navigation by copying and pasting an existing site navigation in the SitePlan tree.

Default value: blank

xcelerate.deny.placepage

Contains a comma-separated list of roles that are not allowed to place Page 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 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 is available in the View menu when you have an asset open in the Oracle WebCenter Sites: Contributor interface. The Status page shows workflow and publishing information about the open asset. If the user belongs to one of the roles that is being denied the privilege to view the Status page, the Status option will be grayed out in the View menu.

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: The Show versions icon is not displayed on the asset's toolbar 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: 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 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 Page assets in the SitePlan tree.

Default value: blank

xcelerate.grant.preview

Contains a comma-separated list of roles that are 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 an 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 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 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 is available in the View menu when you have an asset open in the Contributor interface. The Status page shows workflow and publishing information about the open asset. If the user belongs to one of the roles that is being granted the privilege to view the Status page, the Status option will be grayed out in the View menu.

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 Show versions icon is displayed on the asset's toolbar if the user belongs to one of the roles that is granted the privilege.

Default value: blank

14 ServletRequest Properties

The following topics provides information about each property categorized under ServletRequest in the WebCenter Sites wcs_properties.json file:

- About the Properties in the ServletRequest Category

- Properties in the ServletRequest Category

14.1 About the Properties in the ServletRequest Category

ServletRequest properties specify configurations for certain types of requests (for example, a portal request or a Satellite Server request).

14.2 Properties in the ServletRequest Category

Table 14-1 lists all of the ServletRequest properties in the JSON file.

Table 14-1 ServletRequest Properties

Property

Description

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: UTF-8

cs.srequest.charset

This property defines the CS forms character encoding parameter.

Default value: _charset_

cs.srequest.contenttype

The default content type string used when streaming text.

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

cs.srequest.disksize

Specifies the amount of data Satellite Server can store to memory before it stores the results on Disk.

Default value: 102400

path.BlobServer

The servlet context path for the Blob Server servlet.

Default value: /<wcsites.app.contextroot>/BlobServer

path.CacheServer

The servlet context path for the Cache Server servlet.

Default value: /<wcsites.app.contextroot>/CacheServer

path.CatalogManager

The servlet context path for the Catalog Manager servlet.

Default value: /<wcsites.app.contextroot>/CatalogManager

path.ContentServer

The servlet context path for the ContentServer servlet.

Default value: /<wcsites.app.contextroot>/ContentServer

path.CookieServer

The servlet context path for the Cookie Server servlet.

Default value: /<wcsites.app.contextroot>/CookieServer

path.DispatchManager

The servlet context path for the Dispatch Manager servlet.

Default value: /<wcsites.app.contextroot>/DispatchManager

path.PageDispatchServer

The servlet context path for the Page Dispatch Server servlet.

Default value: /<wcsites.app.contextroot>/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.

Default value: /<wcsites.app.contextroot>/Satellite

path.SeedDispatchServer

The servlet context path for the Seed Dispatch Server servlet.

Default value: /<wcsites.app.contextroot>/SeedDipatchServer

path.SyncSeedDispatchServer

The servlet context path for the Sync Seed Dispatch Server servlet.

Default value: /<wcsites.app.contextroot>/SyncSeedDispatchServer

path.TreeManager

The servlet context path for the Tree Manager servlet.

Default value: /<wcsites.app.contextroot>/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.QueryAssembler 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.

Default value: com.fatwire.cs.core.uri.QueryAssembler

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.

Default value: query

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.

Default value: com.fatwire.firstsite.uri.FSIIAssembler

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.

Default value: fsii

15 SiteCapture Properties

The following topics provides information about each property associated with the SiteCapture category in the WebCenter Sites wcs_properties.json file.

- About the Properties in the SiteCapture Category

- SiteCapture Properties

15.1 About the Properties in the SiteCapture Category

The properties in the WebCenter Sites wcs_properties.json file categorized under SiteCapture are set during the WebCenter Sites: SiteCapture installation. These properties specify information such as the URL of the Site Capture application and the user name and password of the WebCenter Sites general administrator.

15.2 SiteCapture Properties

Table 15-1 provides a description for each of the properties in the JSON file that are associated with the SiteCapture category.

Table 15-1 SiteCapture Properties

Property

Description

sitecapture.url

For a single-server installation, specify the URL of the Site Capture application. For a clustered installation, specify the URL of the Site Capture load balancer.

Possible value: <sitecapture_protocol>://<sitecapture_host>:<sitecapture_port>/__admin

Default value: http://localhost:80/__admin

sitecapture.cas.url

Specifies the CAS application the Site Capture application points to.

Possible value: <sitecapture_cas_protocol>://<sitecapture_cas_host>:<sitecapture_cas_port>/__admin

Default value: http://localhost:80/__admin

sitecapture.cs.username

Specifies the user name of the WebCenter Sites general administrator exactly as it was specified during the Site Capture installation process.

Possible value: RestAdmin user

Default value: fwadmin

sitecapture.cs.password

Specifies the WebCenter Sites general administrator password exactly as it was specified during the Site Capture installation process.

Possible value: Password for the RestAdmin user

Default value: xceladmin

16 Oracle WebCenter Sites: Visitor Services Properties

The following topics provide information about each property associated with the Oracle WebCenter Sites: Visitor Services category in the WebCenter Sites wcs_properties.json file.

- About the Properties in the Visitor Services Category

- Properties in the Visitor Services Category

16.1 About the Properties in the Visitor Services Category

Oracle WebCenter Sites: Visitor Services is a component that identifies website visitors by assigning each visitor a unique ID, gathers and enriches visitor profiles from multiple channels based on the visitor’s identity, merges raw visitor profiles into an aggregated profile based on aggregation rules, and makes these profiles available for targeting, testing, and analysis.

The properties in the WebCenter Sites wcs_properties.json file categorized under Visitor Services specify values for the configuration parameters required by the Visitor Services component.

16.2 Properties in the Visitor Services Category

Table 16-1 provides a description for each of the properties in the JSON file that are associated with the Visitor Services category.

Table 16-1 Visitor Services Properties

Property

Description

wcsites.visitors.auth.password

The password which the Visitor Services application uses for basic authentication protection. See the visitors.rest.authtype property.

wcsites.visitors.auth.user

The user name which the Visitor Services application uses for basic authentication protection. See the visitors.rest.authtype property.

visitors.rest.authalias

Defines the Visitor Services authentication alias which is used to connect to Visitor Services with LDAP.

visitors.rest.authheader

Defines the header used when using LDAP to connect to Visitor Services.

visitors.rest.authtype

Defines the authentication type required to connect to Visitor Services.

visitors.rest.url

The URL to Visitor Services. For example, http://localhost:7080/visitorapp

17 UI Properties

The following topics provide information about each property associated with the UI category in the WebCenter Sites wcs_properties.json file:

- About the Properties in the UI Category

- Properties in the UI Category

17.1 About the Properties in the UI Category

Properties categorized under UI in the WebCenter Sites wcs_properties.json file control the appearance of and components displayed in the WebCenter Sites Contributor and Admin interfaces.

17.2 Properties in the UI Category

Table 17-1 provides a description for each of the properties in the JSON file that are associated with the UI category.

Table 17-1 UI Properties

Property

Description

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

- Oracle WebCenter Sites: 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 Oracle 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

cs.disableSWFFlashUploader

This property is used to enable and disable the Flash uploader.

Default value: false

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

Possible 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 Contributor interface.

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

fckeditor.showIncludedElementInSpan

This property should only be set to true if the included assets in the FCKEditor field should be shown in span tag. If set to false, FCKEditor determines between span and div tag implicitly after validating the content of the included asset.

Default value: false

form.defaultMaxValues

Default maximum values for multi valued attributes in the asset forms.

Default value: -1

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

Possible Values: Any defined ACL

Default value: xceladmin

Note: 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.asset.shareToAllAllowed

Specifies whether assets can be shared to all sites.

Possible values: true | false

Default value: true

xcelerate.crosssiteassign

Specifies whether users from more than one site can participate in the same workflow process.

Possible values: true | false

Default value: true

xcelerate.defaultpreviewurlgenerator

Set to the preview generator name to generate URLs for preview, if no site-specific one is described.

Default value: Standard

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

Default value: Satellite

xcelerate.previewurlpagename

Set to the name of page to generate URLs for preview.

Default value: OpenMarket/Xcelerate/UIFramework/ShowPreviewFrames

Note: Do not change the value of this property.

xcelerate.restrictSiteTree

Specifies whether users, other than administrators, 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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

xcelerate.searchResultCols

Specifies which columns are shown in the search results and publishing screens in the Admin interface. It does not control the order in which the columns are displayed.

Default value: name,modified,locale,startDate,endDate,assetType

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

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 "/" in the asset name. Each "/" in the asset name represents one hierarchy level. For example, /AssetName is the top level, //AssetName is the next level, and so on.

Default value: SiteEntry,CSElement,Template,Recommendation

xcelerate.treetabmanagerclass

The class that implements ITreeTabManager to provide tree tab descriptions for WebCenter Sites.

Default value: com.openmarket.xcelerate.treetab.TreeTabManager

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

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 Oracle Fusion Middleware Administering Oracle WebCenter Sites.

xcelerate.treeType

Specifies the kind of tree that is used in the WebCenter Sites Admin interface.

Possible values: DojoTree or a value that specifies a customized replacement tree.

Default value: DojoTree

Do not change this property without first consulting Oracle support personnel.

xcelerate.enableinsite

Enables or disables Web Mode (in the Contributor interface) for this WebCenter Sites system. A value of true enables Web Mode.

Default value: true

Do not enable Web Mode on your WebCenter Sites delivery system.

cc.useLegacyInputNames

Specifies the boolean that WebCenter Sites 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

cc.attrDisplayStyle

The field to display (name or description) to describe attributes on a FlexAsset or FlexGroup ContentForm or ContentDetails form.

Possible values: name or description

Default value: description

18 User Properties

The following topics provide information about each property associated with the User category in the wcs_properties.json file:

- About the Properties in the User Category

- Properties in the User Category

18.1 About the Properties in the User Category

Properties categorized under User in the WebCenter Sites wcs_properties.json file are related to implementing WebCenter Sites users. This includes creating and registering user names with LDAP and the WebCenter Sites database tables. For information about the WebCenter Sitesproperties categorized under User in the wcs_properties.json file, see Properties in the User Category.

18.2 Properties in the User Category

Table 18-1 provides a description for each of the properties in the JSON file that are associated with the User category.

Table 18-1 User Properties

Properties

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: o=ContentServer

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.

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.

Default value: javax.naming.directory.BasicAttribute

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.

Default value: javax.naming.directory.BasicAttributes

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

Default value: com.openmarket.directory.cs.CSDir

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.

Default value: com.openmarket.directory.common.Factory

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

Default value: com.openmarket.directory.cs.CSName

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

Default value: com.openmarket.directory.cs.CSDir

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.

Default value: javax.naming.CompundName

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

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.

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

Default value: cn

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 wcs_properties.json file which contains properties specific to the user or ACL management being used. For example, if you specify cs.manageUser, cs.manageACL, or cs.manageUserAccess.

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 which user manager plug-in to use with this WebCenter Sites system.

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

Default value: com.fatwire.wem.sso.cas.cs.plugin.SSOValidatorPlugin

defaultGroupAttrs

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

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

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.

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

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

groupparent

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

Possible values:

- WebCenter Sites and Windows Server: ou=groups

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

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

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.

Default value: com.sun.jdni.ldap.LdapCtxFactory

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>

Default value: ldap://localhost:389

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.

Default value: true

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.

Default value: false

jndi.poolsize

Indicates the size of the pool.

Default value: 20

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

ldap.caseAware

Specifies whether the LDAP Server is case sensitive for the queries.

Default value: false

loginattribute

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

Default value: uid

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

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.

Default value: Browser

ntlogin.DefaultReaderID

NT user manager plug-in only.

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

Default value: 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.

Default value: 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

objectclass

Systemn property used for WebCenter Sites runtime.

objectclassGroup

Specifies the name of the base object that signifies a WebCenter Sites group.

Possible values:

- WebCenter Sites: groupofuniquenames

- LDAP, iPlanet: groupofuniquenames

- LDAP, Active Directory: group

Default value: groupofuniquenames

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.

Default value: person

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: userPassword

- LDAP, Active Directory: password

Be sure to change the username and password from the defaults.

Default value: password

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: cn=people,dc=<companyname>,dc=com

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

Default value: ou=People

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.

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 until the network timeout limit ends the wait.

Default value: 0

singlesignon

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

Default value: true

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

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

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: right_to_left

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 ',', '+', '-', ';', and so on, in DN, you cannot use \ as an escape string.

Default value: \\

syntax.ignorecase

Specifies whether strings are case-sensitive.

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 set the cleandns property 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

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

Default value: uniquemember

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

Default value: username

xcelerate.displayablenameattr

The name of the user attribute that specifies 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: locale

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 a value is not set, the UserPublication table 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.

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 xcelerate.pubrolesattr property to determine a user's access rights in the WebCenter Sites interfaces.

By default, this value is blank, which means that information about a user's roles is stored in the UserPublication table.

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.

If there is a value specified for this property, the xcelerate.usermanagerclass and xcelerate.sitenameattr properties must also be configured correctly.

xcelerate.timezoneattr

Specifies the name of the user attribute that identifies the timezone set for your WebCenter Sites system.

Default value: timezone

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.

Default value: userimage

19 WebCenter Sites User Defined Properties

User defined properties are properties added by WebCenter Sites users (usually administrators or developers) to the WebCenter Sites wcs_properties.json file.

The following topics provide information about user defined properties:

- About WebCenter Sites User Defined Properties

- User Defined Properties for WebCenter Sites

19.1 About WebCenter Sites User Defined Properties

WebCenter Sites user defined properties are properties that can be manually added to the WebCenter Sites wcs_properties.json file to enable optional WebCenter Sites features.

Certain WebCenter Sites features require properties that are not available in the WebCenter Sites wcs_properties.json file by default. In these cases, an administrator or developer must create the property in the wcs_properties.json file, using the Property Management Tool in the WebCenter Sites Admin interface. 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 adding properties to the WebCenter Sites wcs_properties.json file, see Adding Properties.

19.2 User Defined Properties for WebCenter Sites

The table below provides a description for each user defined property you can add to the WebCenter Sites wcs_properties.json file.

Table 19-1 WebCenter Sites User Defined Properties

Property

Description

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 the WebCenter Sites wcs_properties.json file).

If you wish to switch back from approval locking per target to default behavior (that is, global lock), remove the cs_target column from the ApprovalQueue table, and then set cs.approvalLockStriping to false (or remove this property, as by default it is false).

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 WebCenter Sites wcs_properties.json 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.childfoldercount

Specifies the maximum number of child folders that WebCenter Sites can generate in parent folders under subdirectories of <wcs_shared>/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 <wcs_shared>/Shared/ccurl.

If you wish to use this property, you must add it to WebCenter Sites wcs_properties.json file. 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.parentfoldercount

Specifies the maximum number of parent folders that WebCenter Sites can generate in subdirectories of <wcs_shared>/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 <wcs_shared>/Shared/ccurl (where flex assets are stored).

If you wish to use this property, you must add it to the WebCenter Sites wcs_properties.json file. 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.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 WebCenter Sites wcs_properties.json file and its value is set to 5. To change the value of this property, you must manually add this property to the WebCenter Sites wcs_properties.json file.

cc.tablenameKey

To add a key for a new table in the WebCenter Sites database, add this property to the WebCenter Sites wcs_properties.json file, where tablename is the name of the new table.

ft.servletoutputstream

Default value: false

rtd.choicIdpattern

If the Oracle Real-Time Decisions (RTD) engine is integrated with WebCenter Sites, add this property to the WebCenter Sites wcs_properties.json 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 WebCenter Sites wcs_properties.json 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 WebCenter Sites wcs_properties.json file and set the value as the name of the Oracle RTD inline service.

vis.useSessionVisitorConnection

This property determines whether Engage visitors will be tracked through 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 the WebCenter Sites wcs_properties.json file, in which case its value is understood to be false (that is, 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.

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 (that is, for multilingual support), do the following to prevent your delivery system from unnecessarily querying the Dim and DimP tables: Add this property to the WebCenter Sites wcs_properties.json file and set it to false. Then, set -Dcs.disable.dimensions.in.ui for the JVM to true in the application server startup script.

Part II Satellite Server JSON File

The Satellite Server wcs_properties.json file is made available when you install Satellite Server with WebCenter Sites. The properties in the Satellite Server wcs_properties.json file mirror the values set for the Satellite properties in the WebCenter Sites wcs_properties.json file. The Satellite Server Import/Export Utility is used to set properties in the Satellite Server wcs_properties.json file.

The following topics provide information about each property in the Satellite Server wcs_properties.json file and instructions for using the Satellite Server Import/Export Utility to modify the values of these properties:

- Managing Satellite Server JSON File Properties

- Core Properties in the Satellite Server JSON File

- CORS Properties in the Satellite Server JSON File

- Satellite Properties in the Satellite Server JSON File

- ServletRequest Properties in the Satellite Server JSON File

- Satellite Server User Defined Properties

20 Managing Satellite Server JSON File Properties

Satellite Server properties are located in the Satellite Server wcs_properties.json file. The Satellite Server wcs_properties.json file is located in the Satellite Server config directory (specified during installation). To manage the properties in the Satellite Server wcs_properties.json file, WebCenter Sites provides the Satellite Server Import/Export Utility.

The following topics provide information and instructions about managing the Satellite Server JSON file properties using the Import/Export Utility:

- About the Satellite Server JSON File

- Overview of the Satellite Server Import/Export Utility

- Using the Import/Export Utility to Manage Satellite Server Properties

- Adding Properties to the Satellite Server JSON File

20.1 About the Satellite Server JSON File

WebCenter Sites provides the Satellite Server wcs_properties.json file which contains all the properties required by Satellite Server. The Satellite Server JSON file is located in the Satellite Server config directory (specified during installation). To manage the properties in the Satellite Server JSON file, WebCenter Sites provides the Satellite Server Import/Export Utility.

To access the Satellite Server Import/Export Utility, you must run a command line prompt by invoking the COM.FutureTense.Properties.Key/ValueStoreImportExport class. For instructions, see Using the Import/Export Utility to Manage Satellite Server Properties.

20.2 Overview of the Satellite Server Import/Export Utility

The Satellite Server Import/Export Utility is used to update property values in the Satellite Server wcs_properties.json file.

The Import/Export Utility enables users to extract the properties from the Satellite Server wcs_properties.json file into a property file format (.ini or .properties) to their local system. Once you update the desired properties, you then run an import command to import your changes into the Satellite Server wcs_properties.json file. When the WebCenter Sites system is restarted, your property changes are updated on all Satellite Server instances.

20.3 Using the Import/Export Utility to Manage Satellite Server Properties

To update Satellite Server properties, invoke the COM.FutureTense.Properties.KeyValueStoreImportExport class to run the import and export commands for Satellite Server properties. The instructions below provide commands for Windows systems only. If you are running the commands on a Unix system, the commands are identical, however, the path separators are colons instead of semicolons.

Note:

The Satellite Server Import/Export Utility does not support the following functions:

- Flush flag.

- Adding custom properties to the Satellite Server JSON file. For instruction on adding custom properties, see Adding Properties to the Satellite Server JSON File.

1. Open a command prompt window.

2. Export the Satellite Server properties with the following command:

>java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport export <path_to_properties_file>

Where <path_to_properties_file> is the name of the properties file (.ini or .properties) to which you want to export the Satellite Server properties in a key=value pair format.

The utility creates the property file in the directory you specified in the export command.

3. Navigate to and then open the property file in a text editor. The properties are listed in a key=value format. Modify the values of the desired properties and then save the property file.

4. Import the updated properties into the Satellite Server JSON file with the following command:

>java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport import <path_to_properties_file>

The properties you modified are updated in the Satellite Server wcs_properties.json file.

20.4 Adding Properties to the Satellite Server JSON File

To enable certain Satellite Server features, you must manually add properties to the Satellite Server wcs_properties.json file. For example, if inCache is enabled, you can add the propagatecache property to the wcs_properties.json file to enable page propagation among cluster nodes.

To add properties to the Satellite Server wcs_properties.json file:

1. Navigate to the Satellite Server config directory (specified during installation), and open the wcs_properties.json file in a text editor.

2. Add the property to the Satellite Server wcs_properties.json file in the following format:

{
"key":"<property name>",
"value":"<property value>",
"valid_values":[""],
"defaultValue":"<property value>",
"category":"Satellite",
"subcategory":"",
"global":true,
"hide":false,
"readonly":false,
"deprecated":false,
"description":"Description of property"
}

3. Save and close the Satellite Server wcs_properties.json file.

4. Restart Satellite Server for your changes to take affect.

21 Core Properties in the Satellite Server JSON File

The following topics provide information about the Core category and the properties categorized under Core in the Satellite Server wcs_properties,json file:

- About the Core Properties in the Satellite Server JSON File

- Properties in the Core Category in the Satellite Server JSON File

21.1 About the Core Properties in the Satellite Server JSON File

The Core property in the Satellite Server wcs_properties.json file reflects the value set for the site.prefix Core property in the WebCenter Sites wcs_properties.json file.

21.2 Properties in the Core Category in the Satellite Server JSON File

The table below provides a description for each of the properties categorized under the Core category in the Satellite Server wcs_properties.json file.

Table 21-1 Core properties in the Satellite Server JSON File

Property

Description

site.prefix

Comma separated list of unique site prefixes required for resolving vanity URLs using the rewriter filter. By default, this list contains a unique prefix for each sample site installed on your system.

For information about the rewriter filter, see Oracle Fusion Middleware Administering Oracle WebCenter Sites.

Default value: fsii, avi

22 CORS Properties in the Satellite Server JSON File

The following topics provide information about the CORS category and the properties categorized under CORS in the Satellite Server wcs_properties.json file:

- About the CORS Properties in the Satellite Server JSON File

- Properties in the CORS Category in the Satellite Server JSON File

22.1 About the CORS Properties in the Satellite Server JSON File

The CORS properties in the Satellite Server wcs_properties.json file correlate to the CORS properties in the WebCenter Sites wcs_properties.json file.

The properties that configure the Cross-Origin Resource Sharing (CORS) mechanism for Satellite Server are categorized under the CORS category. These properties allow resources to be requested from domains outside of the WebCenter Sites domain.

When a request from a domain outside of WebCenter Sites is made for a WebCenter Sites resource, the browser "preflights" the request by soliciting supported domain methods from WebCenter Sites with an HTTP OPTIONS request header. Upon approval from WebCenter Sites, CORS sends the request with the HTTP request method. WebCenter Sites can also notify clients whether "credentials" (including Cookies and HTTP Authentication data) should be sent with requests.

22.2 Properties in the CORS Category in the Satellite Server JSON File

The following table provides a description for each CORS-related property in the Satellite Server wcs_properties.json file.

Table 22-1 Properties in the CORS Category in the Satellite Server JSON File

Property

Description

cors.allowCredentials

Specifies whether user credentials, such as cookies, HTTP authentication, or client-side certificates are supported in cross origin requests (CORS).

Default value: false

cors.allowOrigin

Comma-separated list of origins (in the format: <scheme>://<host>:<port>) that are allowed to access WebCenter Sites resources from a domain other than the WebCenter Sites domain.

Default value: * which allows any domain to access WebCenter Sites resources.

cors.maxAge

Use this property to specify an integer that indicates the maximum amount of time the results of a preflight request can be cached by the client.

cors.supportedMethods

Defines the cross domain request HTTP methods supported by WebCenter Sites.

Default value: GET, HEAD, POST, OPTIONS

23 Satellite Properties in the Satellite Server JSON File

The following topics provide information about the properties categorized under Satellite in the Satellite Server wcs_properties.json file:

- About the Satellite Category in the Satellite Server JSON File

- Satellite Properties in the Satellite Server JSON File

23.1 About the Satellite Category in the Satellite Server JSON File

Properties categorized under Satellite in the Satellite Server wcs_properties.json file describe how the Satellite servlets communicate with WebCenter Sites.

Satellite Server is installed by default on the server that hosts your WebCenter Sites application. Properties categorized under Satellite configure the local Satellite servlet.

23.2 Satellite Properties in the Satellite Server JSON File

Table provides a description for each of the properties categorized under Satellite in the Satellite Server wcs_properties.json file.

Table 23-1 Satellite Properties in the Satellite Server JSON File

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.

Default value: /<wcsites.app.contextroot>/BlobServer

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

Default value: 1000000

contentserver.installation.folder

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.

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.

Default value: <wcsites.home>

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.

Default value: JSESSIONID;WebLogicSession;GX_SESSIONID

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.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 in the cs.satellitepassword property.

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 WebCenter Sites wcs_properties.json 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 though 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

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.

Default value: action=\”ContentServer\”

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.

Default value: false

hidden.encrypted

Default value: false

host

The name of the remote host system running WebCenter Sites that the Satellite engine is caching requests for.

modify.passwords

Enables you to modify passwords in Remote Satellite Server. The value of this property must be set to true to enable password modification.

Default value: false

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.

Default value: action=\"Satellite\"

oracle.wcsites.satelliteserver.registered

Specifies whether Satellite Server is registered with WebCenter Sites.

Default value: false

port

The port number for communicating with the WebCenter Sites host.

Default value: 80

product.installation.type

Defines the name of the installation.

Possible values: Sites or RSS (Remote Satellite Server)

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 ensure secure communications. You still need to get a certificate.

security.keys.created

Indicates whether security keys are created. When security keys are created, this property is set to true automatically.

Do not modify the value of this property.

Default value: false

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.

Default value: /<wcsites.app.contextroot>/ContentServer

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

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

Default value: SS_X_

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.

Default value: true

ss.username

The username for the Satellite Server user, on the Satellite Server side. This much match the value for the wcsites.satelliteserver.username property.

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.

Default value: text/.*|.xml.*

username

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

Possible values:

- WebCenter Sites and NT: uniquemember

- LDAP, iPlanet: uid

- LDAP, Active Directory: sAMAccount

24 ServletRequest Properties in the Satellite Server JSON File

The following topics provide information about the properties categorized under ServletRequest in the Satellite Server wcs_properties.json file:

- About the ServletRequest Properties in the Satellite Server JSON File

- Properties in the ServletRequest Category in the Satellite Server JSON File

24.1 About the ServletRequest Properties in the Satellite Server JSON File

ServletRequest properties specify configurations for certain types of requests (for example a portal request or a Satellite Server request.

24.2 Properties in the ServletRequest Category in the Satellite Server JSON File

Table provides a description for each of the properties categorized under the ServletRequest category in the Satellite Server wcs_properties.json file.

Table 24-1 ServletRequest Properties in the Satellite Server JSON File

Property

Description

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: UTF-8

cs.srequest.charset

Defines the CS forms character encoding parameter.

cs.srequest.contenttype

The default content type string used when streaming text.

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

cs.srequest.disksize

Specifies the amount of data Satellite Server can store to memory before it stores the results on Disk.

Default value: 102400

path.BlobServer

The servlet context path for the Blob Server servlet.

path.CacheServer

The servlet context path for the Cache Server servlet.

path.CatalogManager

The servlet context path for the Catalog Manager servlet.

Default value: /<wcsites.app.contextroot>/CatalogManager

path.ContentServer

The servlet context path for the ContentServer servlet.

path.CookieServer

The servlet context path for the Cookie Server servlet.

path.DispatchManager

The servlet context path for the Dispatch Manager servlet.

Default value: /<wcsites.app.contextroot>/DispatchManager

path.PageDispatchServer

The servlet context path for the Page Dispatch Server servlet.

Default value: /<wcsites.app.contextroot>/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.

path.SeedDispatchServer

The servlet context path for the Seed Dispatch Server servlet.

path.SyncSeedDispatchServer

The servlet context path for the Sync Seed Dispatch Server servlet.

path.TreeManager

The servlet context path for the Tree Manager servlet.

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

Default value: com.fatwire.cs.core.uri.QueryAssembler

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.

Default value: query

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.

Default value: com.fatwire.firstsite.uri.FSIIAssembler

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.

Default value: fsii

25 Satellite Server User Defined Properties

Certain Satellite Server features require a user (usually and administrator or developer) to add properties to the Satellite Server wcs_properties.json file.

The following topics provide information about the Satellite Server user defined properties:

- About Satellite Server User Defined Properties

- User Defined Properties for Satellite Server

25.1 About Satellite Server User Defined Properties

Certain Satellite Server features require properties that are not available in the Satellite Server wcs_properties.json file by default. In these cases, an administrator or developer must add the property manually to the Satellite Server wcs_properties.json file.

For instructions on adding properties to the Satellite Server wcs_properties.json file, see Adding Properties to the Satellite Server JSON File.

25.2 User Defined Properties for Satellite Server

The table below provides a description for each user defined property you can add to the Satellite Server wcs_properties.json file.

Table 25-1 Satellite Server User Defined Properties

Property

Description

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 Server wcs_properties.json 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 Server wcs_properties.json file).

Default value: 2

Part III Credential Store Properties

In Oracle WebCenter Sites, system password properties for WebCenter Sites and Satellite Server are encrypted and stored in a Credential Store.

The following topics provide information about the system and user properties that are encrypted and stored in the Credential Store:

- Managing the Properties in the Credential Store

- WebCenter Sites Properties in the Credential Store

- Satellite Server Properties in the Credential Store

26 Managing the Properties in the Credential Store

The Credential Store for your WebCenter Sites system is created by your installation engineers. All system passwords created for WebCenter Sites and Satellite Server are encrypted and stored here.

The following topics provide information about the Credential Store and instructions for managing the WebCenter Sites and Satellite Server properties stored in the Credential Store:

- About the Credential Store

- Managing the WebCenter Sites Properties in the Credential Store

- Managing Satellite Server Properties in the Credential Store

26.1 About the Credential Store

Oracle WebCenter Sites encrypts and stores all WebCenter Sites and Satellite Server system password properties in the Credential Store. System properties are created during installation.

The Credential Store is an OPSS schema that your WebCenter Sites installation engineers create using the Repository Creation Utility (RCU) provided by WebLogic Server. When your installation engineers create a JRF domain, it provides the required security artifacts the domain uses to connect to the OPSS schema (the Credential Store). Each WebLogic JRF domain has a Credential Store attached to it. Any password property that you create for WebCenter Sites or Satellite Server is encrypted and then stored in the Credential Store on your system’s domain. For more information about Credential Stores, see Configuring Credential Store Properties.

During the WebCenter Sites and Satellite Server installations, initial system passwords are encrypted and stored in the Credential Store.

26.2 Managing the WebCenter Sites Properties in the Credential Store

Use the Property Management Tool in the Admin interface to modify the values of the WebCenter Sites properties stored in the Credential Store. Any changes you make to a WebCenter Sites Credential Store property from the Property Management Tool is automatically stored back in the Credential Store when you save your changes.

To manage the WebCenter Sites properties stored in the Credential Store:

1. Log in to WebCenter Sites with administrator credentials, select the name of a site, and then select the Admin interface icon.

2. In the General Admin tree, expand Admin, and then expand System Tools.

3. Under the System Tools node, double-click Property Management.
The Property Management Tool opens.

4. In the Name field, enter the name of the WebCenter Sites property stored in the Credential Store whose value you want to modify/view. For a list of WebCenter Sites properties stored in the Credenital Store, see WebCenter Sites Properties in the Credential Store.

5. Click Search.

6. Click the name of the property whose value you want to modify.
The property details open.

7. In the Value field, enter a new value for the property.

8. Click Save.

9. Restart the managed server so the new value is updated in the Credential Store.

26.3 Managing Satellite Server Properties in the Credential Store

Use the Satellite Server wcs_properties.json file to manually modify Satellite Server properties stored in the Credential Store.

To manage Satellite Server properties in the Credential Store:

1. Navigate to the Satellite Server config directory (specified during installation), and open the wcs_properties.json file for Satellite Server in a text editor.

2. Find the modify.passwords property and change its value to true.

3. Manually add the Satellite Server Credential Store properties, whose values you want to modify, to the wcs_properties.json file of Satellite Server, in the following format:

"key":"<name of Satellite Server property>",
"value":"<enter value here>",
"valid_values":[""],
"defaultValue":"<enter value here>",
"category":"",
"subcategory":"",
"global":"true",
"hide":true,
"readonly":false,
"restart_required":false,
"deprecated":false,

In the value parameter, enter the new value for the property. For information about the Satellite Server properties in the Credential Store, see Satellite Server Properties in the Credential Store.

4. Save the Satellite Server wcs_properties.json file.

5. Restart the managed server for your changes to take effect.

27 WebCenter Sites Properties in the Credential Store

The table below provides a description for each WebCenter Sites property in the Credential Store.

Table 27-1 WebCenter Sites Properties in the Credential Store

Property

Description

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

Default value: dloginpassword -or- {AES}13971775C4B32520C2FFBA59200EE17E

For information, see "The Mirror to Server Publishing Process" in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

cs.privpassword

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

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.

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.

sitecapture.cs.password

Specifies the WebCenter Sites general administrator password exactly as it was specified during the Site Capture installation process.

Possible value: Password for the RestAdmin user

Default value: xceladmin

ss.password

The password for the Satellite Server user, on the Satellite Server side. This is encrypted, using a two-way hash function.

wcsites.app.admin.password

Specifies the password for the WebCenter Sites application administrator.

wcsites.satelliteserver.password

The password for the Satellite Server user, on the WebCenter Sites system. This is encrypted using a two-way hash function.

wcsites.system.admin.password

Specifies the password for the WebCenter Sites system administrator.

xcelerate.batchpass

Specifies the password for the batch user.

Default value: xceladmin

Note: Change this value after you create the batch user for this WebCenter Sites system. For information, see Oracle Fusion Middleware Administering Oracle WebCenter Sites.

28 Satellite Server Properties in the Credential Store

The table below provides a description for each Satellite Server property in the Credential Store.

Table 28-1 Satellite Server Properties in the Credential Store

Property

Description

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 (in the Satellite Server wcs_properties.json file).

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: userPassword

- LDAP, Active Directory: password

Be sure to change the username and password from the defaults.

Default value: password

Note: This property must have the same value as the ss.password property. Otherwise, the password will not be updated on the server.

ss.password

The password for the Satellite Server user, on the Satellite Server side. This is encrypted, using a two-way hash function.

Note: This property must have the same value as the password property. Otherwise, the password will not be updated on the server.

Part IV Oracle Diagnostic Logging (ODL) Property File

The logging-config.xml file specifies the Oracle Diagnostic Logging (ODL) system which is the default logging system for Oracle WebCenter Sites.

The following topics provide information about the logging-config.xml file:

- About the logging-config.xml File

- Oracle Diagnostic Logging (ODL) Configurations

29 About the logging-config.xml File

Oracle Diagnostic Logging (ODL) is used as the logging system in the WebCenter Sites 12c installations. The logging-config.xml file enables you to identify your loggers, set default log levels, and add new loggers for your WebCenter Sites system. Your changes to this file take effect when you restart WebCenter Sites.

30 Oracle Diagnostic Logging (ODL) Configurations

When ODL is set up, the WebCenter Sites Admin interface displays the Configure Log ODL tool, under System Tools, in the Admin node, in the General Admin tree. The Configure Log ODL tool enables general administrators to view current loggers, temporarily change logger levels, and add new loggers directly from the Admin interface. Changes made from the Admin interface remain in effect only until WebCenter Sites is restarted. They will persist upon restart only if you manually add the loggers to the logging-config.xml file. (Changes that are made directly in the logging-config.xml file will not be applied to WebCenter Sites until the system is restarted.)

The following topics provide information about configuring the logging-config.xml file:

- Adding Loggers

- Changing Logger Levels

30.1 Adding Loggers

To add new loggers to the ODL framework in your WebCenter Sites system, manually add them to the logging-config.xml file.

1. Open the logging-config.xml file (<sites-shared>/config/).

2. Add the new loggers to the logging-config.xml file in the following format:

<logger name='<name of logger>' level='<logger level>'
useParentHandlers='<false|true>'
<handler name='<name of handler>' />

Note:

Do not name any handler odl-handler. This will cause a conflict with WebLogic.

3. Save the logging-config.xml file and restart the WebCenter Sites system.

30.2 Changing Logger Levels

The logging-config.xml file enables you to permanently change logger levels. The changes you make to loggers in the logging-config.xml file take effect when WebCenter Sites is restarted. You can also configure loggers to inherit verbosity levels from the root logger or a parent logger. To temporarily change logger levels during a session, use the Configure ODL tool in the Admin interface.

Note:

- For information about changing logger levels from the Admin interface, see Changing Logger Levels in Oracle Fusion Middleware Administering Oracle WebCenter Sites.

- Log4j log levels set by users cannot be migrated to ODL logs. Users must set these levels manually after the upgrade.

To change logger levels in the logging-config.xml file:

1. Open the logging-config.xml file (<sites-shared>/config/).

2. Navigate to the logger whose level you want to change and enter one of the following values into the level attribute:

- ERROR:1

- WARNING:1

- NOTIFICATION:1

- TRACE:16

- TRACE:1

- OFF

For example, if you changed the oracle.wcsites.search logger’s level to TRACE:1, the logger would look as follows in the logging-config.xml file:

<logger name='oracle.wcsites.search' level='TRACE:1'
useParentHandler='false'>
<handler name='wcsites-odl-handler' />
</logger>

3. If you want a logger to use the same logging level as its parent handler, do the following:

a. Remove the child logger’s level attribute and value.

b. Change the value of the child logger’s useParentHandler attribute to true.

For example, if you wanted the oracle.wcsites.visitorservices.rest logger to share the same logging level as its parent logger (oracle.wcsites.visitorservices), the child logger would look as follows in the logging-config.xml file:

<logger name='oracle.wcsites.visitorservices.rest
useParentHandler='true'>
<handler name='visiors-odl-handler' />
</logger>

4. Save the logging-config.xml file and then restart WebCenter Sites for your changes to take effect.

Part V Third-Party Libraries and Applications

This part contains information about third-party libraries, as well as applications, and how Oracle WebCenter Sites integrates with them.

This part contains the following chapter:

- HTTPClient Access

31 HTTPClient Access

This chapter describes the Apache Commons HTTPClient library and how WebCenter Sites integrates with this library.

For more information about HTTPClient access, see the following topics:

- Apache Commons HTTPClient

- About the HTTPClient Integration with WebCenter Sites

- HTTP Client Parameters and WebCenter Sites Properties

31.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 About the HTTPClient 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 31-1, along with descriptions (duplicated from the site named above). Changes to parameters and their functionality as defined by HttpClient are not automatically supported.

31.2 About the HTTPClient 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 31-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.

31.2.1 About the HTTP Client 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.

31.3 HTTP Client Parameters and WebCenter Sites Properties

Table 31-1 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 31-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 and so on) 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

- abtest.autosave.enabled 1

- abtest.delivery.enabled 1

- abtest.minvariantvisitors 1

- abtest.visitors.profile 1

- advancedUI.enableAssetForms 1

- afk.historydata 1

- afk.publishdata 1

B

- baseDN 1

- bs.bCacheSize 1

- bs.bCacheTimeout 1

- bs.invalidheadernames 1

- bs.security 1

- bservice 1 , 2

C

- cache_folder 1 , 2

- cache_max 1 , 2

- cc.AssetTypeCSz 1

- cc.attrDisplayStyle 1

- cc.attributeinheritance 1

- cc.bigint 1

- cc.bigtext 1

- cc.blob 1

- cc.BlobServerCacheCSz 1

- cc.BlobServerTimeout 1

- cc.cacheNoSync 1

- cc.cacheResults 1

- cc.cacheResultsAbs 1

- cc.cacheResultsTimeout 1

- cc.CategoryCSz 1

- cc.char 1

- cc.ComparatorsKey 1

- cc.contentkey 1

- cc.datepicture 1

- cc.datetime 1

- cc.double 1

- cc.ElementCatalogCSz 1

- cc.ElementCatalogTimeout 1

- cc.extrapath 1

- cc.FiltersKey 1

- cc.forcelower 1

- cc.fullconstraint 1

- cc.ignoreTblCase 1

- cc.integer 1

- cc.maxvarcharsize 1

- cc.MimeTypeKey 1

- cc.money 1

- cc.null 1

- cc.numeric 1

- cc.PreviewgenKey 1

- cc.primary 1

- cc.queryablemaxvarcharlength 1

- cc.querystyle 1

- cc.rename 1

- cc.security 1

- cc.SiteCatalogCSz 1

- cc.SiteCatalogTimeout 1

- cc.smallint 1

- cc.SourceKey 1

- cc.StatusCodeCSz 1

- cc.StatusCodeKey 1

- cc.string 1

- cc.stringpicture 1

- cc.SystemACLCSz 1

- cc.SystemACLTimeout 1

- cc.SystemInfoCSz 1

- cc.SystemInfoTimeout 1

- cc.SystemPageCacheCSz 1

- cc.SystemPageCacheTimeout 1

- cc.SystemUsersCSz 1

- cc.SystemUsersTimeout 1

- cc.tablenameKey 1

- cc.textdistinct 1

- cc.unique 1

- cc.url 1

- cc.urlattrpath 1

- cc.useLegacyInputNames 1

- cc.varchar 1

- className.Attribute 1

- className.Attributes 1

- className.IDir 1

- className.IFactory 1

- className.IName 1

- className.IUserDir 1

- className.JNDIName 1

- cleandns 1

- cluster.nodes 1

- cn 1

- connect-src 1

- contentsecurity.enabled 1

- contentserver.installation.folder 1 , 2

- cookieprefix 1 , 2

- cookieserver.invalidnames 1

- cors.allowCredentials 1 , 2

- cors.allowOrigin 1 , 2

- cors.maxAge 1 , 2

- cors.supportedMethods 1 , 2

- cos.contextroot 1

- cos.protocol 1

- cs.alwaysusedisk 1

- cs.approvalLockStriping 1

- cs.barEqualsSlash 1

- cs.batchtimeout 1

- cs.binarypath 1

- cs.charset 1

- cs.childfoldercount 1

- cs.contenttype 1

- cs.contenttype.UTF-8 1 , 2

- cs.cookievariables 1

- cs.csdtfolder 1

- cs.csdtworkspace 1

- cs.dataindatabase 1

- cs.dbconnpicture 1

- cs.dbencoding 1

- cs.dbtype 1

- cs.disableSWFFlashUploader 1

- cs.disksize 1

- cs.documentation 1

- cs.dsn 1

- cs.emailaccount 1

- cs.emailauthenticator 1

- cs.emailcharset 1

- cs.emailcontenttype 1

- cs.emailhost 1

- cs.emailpassword 1 , 2

- cs.emailreturnto 1

- cs.eventhost 1

- cs.expireonly 1

- cs.freezeCache 1

- cs.HTTP_HOST 1

- cs.HTTP_PROTOCOL 1

- cs.httpvariables 1

- cs.IItemList 1

- cs.invalMemWindow 1

- cs.jspclear 1

- cs.jsppath 1

- cs.jsprefresh 1

- cs.jspresponsewrapper 1

- cs.jsproot 1

- cs.jspwork 1

- cs.manage.expired.blob.inventory 1

- cs.manageACL 1

- cs.manageproperty 1

- cs.manageUser 1

- cs.manageUserAccess 1

- cs.manageUserSystem 1

- cs.mirrorhttpversion 1

- cs.mirrorpassword 1 , 2

- cs.mirrorproxyserver 1

- cs.mirrorproxyserverport 1

- cs.mirrorrowsperpost 1

- cs.mirrorthreads 1

- cs.mirroruser 1

- cs.nocache 1

- cs.parentfoldercount 1

- cs.PastramiEngine 1

- cs.pgcachefolder 1

- cs.pgCacheTimeout 1

- cs.pgexportfolder 1

- cs.privpassword 1 , 2

- cs.privuser 1

- cs.recordBlobInventory 1

- cs.requiresessioncookies 1

- cs.satellitehosts 1 , 2

- cs.satellitepassword 1 , 2 , 3

- cs.satelliteusers 1 , 2

- cs.selfmodify 1

- cs.session 1

- cs.sitepreview 1

- cs.srequest.charset 1 , 2

- cs.srequest.contenttype 1 , 2

- cs.srequest.disksize 1 , 2

- cs.ssovalidator 1

- cs.sysinfo 1

- cs.TempObjectsDaysToKeep 1

- cs.timeout 1

- cs.tree.defaultFunction.child 1

- cs.tree.defaultFunction.parent 1

- cs.uniqueidpoolsize 1

- cs.urlfilerollup 1

- cs.use.short.jsp.names 1

- cs.validheadernames 1

- cs.webreference.conflicts 1

- cs.wrapper 1

- cs.xmlfolder 1

- cs.xmlHeader 1

- cs.xmlHeaderAutoStream 1

D

- debug 1

- defaultGroupAttrs 1

- defaultPeopleAttrs 1

- defaultReaderACLs 1

- default-src 1

E

- expiration 1 , 2

F

- fckeditor.showIncludedElementInSpan 1

- file_size 1 , 2

- form.defaultMaxValues 1

- formaction 1 , 2

- frame-ancestors 1

- ft.approot 1

- ft.catalogmanager 1

- ft.cgipath 1

- ft.contentserver 1

- ft.debugport 1

- ft.filecheck 1

- ft.servletoutputstream 1

- ft.suppressPasswordName 1

- ft.suppressPasswords 1

- ft.sync 1

- ft.treemanager 1

- ft.usedisksync 1

- ft.version 1

G

- globally_replace_contentserver 1 , 2

- groupparent 1

H

- hidden.encrypted 1

- host 1 , 2

- http.authentication.preemptive 1

- http.connection.stalecheck 1

- http.connection.timeout 1

- http.connection-manager.class 1

- http.connection-manager.max-per-host 1

- http.connection-manager.max-total 1

- http.connection-manager.timeout 1

- http.dateparser.patterns 1

- http.default-headers 1

- http.method.multipart.boundary 1

- http.method.response.buffer.warnlimit 1

- http.method.retry-handler 1

- http.protocol.allow-circular-redirects 1

- http.protocol.content-charset 1

- http.protocol.cookie-policy 1

- http.protocol.credential-charset 1

- http.protocol.element-charset 1

- http.protocol.expect-continue 1

- http.protocol.head-body-timeout 1

- http.protocol.max-redirects 1

- http.protocol.reject-head-body 1

- http.protocol.reject-relative-redirect 1

- http.protocol.single-cookie-header 1

- http.protocol.status-line-garbage-limit 1

- http.protocol.strict-transfer-encoding 1

- http.protocol.unambiguous-statusline 1

- http.protocol.version 1

- http.protocol.warn-extra-input 1

- http.socket.linger 1

- http.socket.receivebuffer 1

- http.socket.sendbuffer 1

- http.socket.timeout 1

- http.tcp.nodelay 1

- http.useragent 1

- HttpServletResponseBufferSize 1

I

- img-src 1

J

- java.naming.factory.initial 1

- java.naming.security.authentication 1

- jndi.baseURL 1

- jndi.connectAsUser 1

- jndi.custom 1

- jndi.login 1

- jndi.password 1 , 2

- jndi.poolConnections 1

- jndi.poolsize 1

L

- ldap.caseAware 1

- log.Directory.messages 1

- log.filterLevel 1

- loginattribute 1

M

- memberof 1

- modify.passwords 1

- ms.enable 1

- mwb.assetsetclass 1

- mwb.cartclass 1

- mwb.cartsetclass 1

- mwb.cartsetdir 1

- mwb.commercecontextclass 1

- mwb.commerceengineclass 1

- mwb.commerceuserclass 1

- mwb.conservativedependencies 1

- mwb.defaultattributes 1

- mwb.externalattributes 1

- mwb.path 1

- mwb.promotioncutoff 1

- mwb.searchdir 1

- mwb.searchstateclass 1

- mwb.segmentcutoff 1

N

- newformaction 1 , 2

- ntlogin.DefaultACL 1

- ntlogin.DefaultReaderACL 1

- ntlogin.DefaultReaderID 1

- ntlogin.DefaultReaderPW 1

- ntlogin.LogFile 1

- ntlogin.Logging 1

O

- objectclass 1

- objectclassGroup 1

- objectclassPerson 1

- object-src 1

- oracle.wcsites.satelliteserver.registered 1

P

- password 1 , 2

- path.BlobServer 1 , 2

- path.CacheServer 1 , 2

- path.CatalogManager 1 , 2

- path.ContentServer 1 , 2

- path.CookieServer 1 , 2

- path.DispatchManager 1 , 2

- path.PageDispatchServer 1 , 2

- path.SatelliteServer 1 , 2

- path.SeedDispatchServer 1 , 2

- path.SyncSeedDispatchServer 1 , 2

- path.TreeManager 1 , 2

- peopleparent 1

- port 1 , 2

- product.installation.type 1 , 2

- propagatecache 1

- protocol 1 , 2

R

- regen.servers 1

- request.folder 1

- requiredGroupAttrs 1

- requiredPeopleAttrs 1

- rsCacheOverInCache 1

- rtd.choiceIdpattern 1

- rtd.host 1

- rtd.inline.service.name 1

S

- satellite.blob.cachecontrol.default 1

- scratch.cleanup.schedule 1

- script-src 1

- search.returnLimit 1

- search.scope 1

- search.timeoutVal 1

- secure.CatalogManager 1

- secure.TreeManager 1

- security.checkpagelets 1

- security.class 1

- security.keys.created 1 , 2

- service 1 , 2

- servlet 1 , 2

- sessionid.cookie.prefix 1 , 2

- sharesession 1 , 2

- singlesignon 1

- site.prefix 1 , 2

- sitecapture.cas.url 1

- sitecapture.cs.password 1 , 2

- sitecapture.cs.username 1

- sitecapture.url 1

- sites.environment 1

- ss.flushall 1

- ss.password 1 , 2 , 3

- ss.username 1 , 2

- syntax.beginquote 1

- syntax.beginquote2 1

- syntax.custom 1

- syntax.direction 1

- syntax.endquote 1

- syntax.endquote2 1

- syntax.escape 1

- syntax.ignorecase 1

- syntax.separator 1

- syntax.separatorava 1

- syntax.separatorypeval 1

- syntax.trimblanks 1

T

- thread.count 1

- thread.growcache 1

- thread.idle 1

- thread.wait 1

- transformer.imgdir 1

- transformer.imgurl 1

- transparent.content-type.pattern 1 , 2

- tx.numStores 1

- tx.store_0.storeID 1

- tx.store_1.storeID 1

U

- uniquemember 1

- uri.assembler.1.classname 1 , 2

- uri.assembler.1.shortform 1 , 2

- uri.assembler.2.classname 1 , 2

- uri.assembler.2.shortform 1 , 2

- uri.assembler.3.classname 1

- uri.assembler.3.classname@ 1

- uri.assembler.3.shortform 1

- uri.assembler.3.shortform@ 1

- username 1 , 2

V

- valid.urls(Default Para Font> 1

- vis.adminrole 1

- vis.compileclasspath 1

- vis.editrole 1

- vis.genclasspath 1

- vis.money 1

- vis.path 1

- vis.rulesetxmlpath 1

- vis.sessiondata 1

- vis.update 1

- vis.url 1

- vis.urlpath 1

- vis.useSessionVisitorConnection 1

- visitors.rest.authalias 1

- visitors.rest.authheader 1

- visitors.rest.authtype 1

- visitors.rest.url 1

W

- wcc.batch.autorepeat 1

- wcc.batch.size 1

- wcc.conversions 1

- wcc.download.autoclean 1

- wcc.download.dir 1

- wcc.keyfield 1

- wcc.queuetoken 1

- wcc.renditions 1

- wcc.rule.case-sensitive 1

- wcc.server.password 1

- wcc.server.url 1

- wcc.server.user 1

- wcsites.app.admin.password 1

- wcsites.app.admin.user 1

- wcsites.app.contextroot 1

- wcsites.app.host 1

- wcsites.app.port 1

- wcsites.app.protocal 1

- wcsites.cas.host 1

- wcsites.cas.port 1

- wcsites.database.connectionpicture 1

- wcsites.database.datasource 1

- wcsites.forgot.password 1

- wcsites.home 1

- wcsites.satelliteserver.password 1 , 2

- wcsites.satelliteserver.username 1

- wcsites.shared 1

- wcsites.system.admin.password 1

- wcsites.system.admin.user 1

- wcsites.visitors.auth.password 1

- wcsites.visitors.auth.user 1

- wem.enabled 1

X

- xcelelem.manageuserpub 1

- xcelelem.publishfactor 1

- xcelerate.adminacl 1

- xcelerate.adminrole 1

- xcelerate.approval.dependency.chunksize 1

- xcelerate.asset.shareToAllAllowed 1

- xcelerate.asset.sizeofnamefield 1

- xcelerate.authorizefunctions 1

- xcelerate.base 1

- xcelerate.batchhost 1

- xcelerate.batchloadsizeonpublish 1

- xcelerate.batchmode 1

- xcelerate.batchpass 1 , 2

- xcelerate.batchprotocol 1

- xcelerate.batchsavesizeonpublish 1

- xcelerate.batchuser 1

- xcelerate.BlobRef 1

- xcelerate.bulkapprovechunk 1

- xcelerate.charset 1

- xcelerate.ckeditor.basepath 1

- xcelerate.concurrenttransportunpacker 1

- xcelerate.crosssiteassign 1

- xcelerate.defaultacl 1

- xcelerate.defaultbase 1

- xcelerate.defaultcscacheinfo 1

- xcelerate.defaultcsstatus 1

- xcelerate.defaultlang 1

- xcelerate.defaultpagecriteria 1

- xcelerate.defaultpagecriteriaSiteEntry 1

- xcelerate.defaultpreviewurlgenerator 1

- xcelerate.defaultsscacheinfo 1

- xcelerate.deny.abstainfromvoting 1

- xcelerate.deny.approve 1

- xcelerate.deny.authorize 1

- xcelerate.deny.build 1

- xcelerate.deny.checkout 1

- xcelerate.deny.copy 1

- xcelerate.deny.delegate 1

- xcelerate.deny.delete 1

- xcelerate.deny.edit 1

- xcelerate.deny.inpect 1

- xcelerate.deny.pastesitenavigation 1

- xcelerate.deny.placepage 1

- xcelerate.deny.preview 1

- xcelerate.deny.removefromgroup 1

- xcelerate.deny.removefromworkflow 1

- xcelerate.deny.rollback 1

- xcelerate.deny.setExportData 1

- xcelerate.deny.setnestedworkflow 1

- xcelerate.deny.setparticipants 1

- xcelerate.deny.setprocessdeadline 1

- xcelerate.deny.setstepdeadline 1

- xcelerate.deny.share 1

- xcelerate.deny.showparticipants 1

- xcelerate.deny.showstatus 1

- xcelerate.deny.showversion 1

- xcelerate.displayablenameattr 1

- xcelerate.domain 1

- xcelerate.donotregenerate 1

- xcelerate.editrole 1

- xcelerate.emailattr 1

- xcelerate.emailnotification 1

- xcelerate.enableinsite 1

- xcelerate.exportmaxfilename 1

- xcelerate.grant.abstainfromvoting 1

- xcelerate.grant.approve 1

- xcelerate.grant.authorize 1

- xcelerate.grant.build 1

- xcelerate.grant.checkout 1

- xcelerate.grant.copy 1

- xcelerate.grant.delegate 1

- xcelerate.grant.delete 1

- xcelerate.grant.edit 1

- xcelerate.grant.inspect 1

- xcelerate.grant.placepage 1

- xcelerate.grant.preview 1

- xcelerate.grant.removefromgroup 1

- xcelerate.grant.removefromworkflow 1

- xcelerate.grant.rollback 1

- xcelerate.grant.setExportData 1

- xcelerate.grant.setnestedworkflow 1

- xcelerate.grant.setparticipants 1

- xcelerate.grant.setprocessdeadline 1

- xcelerate.grant.setstepdeadline 1

- xcelerate.grant.share 1

- xcelerate.grant.showparticipants 1

- xcelerate.grant.showstatus 1

- xcelerate.grant.showversion 1

- xcelerate.imageeditor.basepath 1

- xcelerate.imageeditor.clarkii.basepath 1

- xcelerate.imageurl 1

- xcelerate.localeattr 1

- xcelerate.lockdir 1

- xcelerate.mirrorini 1

- xcelerate.objpubdir 1

- xcelerate.pageref 1

- xcelerate.presaveelt 1

- xcelerate.previewhost 1

- xcelerate.previewservlet 1

- xcelerate.previewurlpagename 1

- xcelerate.pubabortelt 1

- xcelerate.pubcleanupelt 1

- xcelerate.pubkeydir 1

- xcelerate.publishallassettypes 1

- xcelerate.publishinvalidate 1

- xcelerate.publishquerystyle 1

- xcelerate.pubrolesattr 1

- xcelerate.remotecall 1

- xcelerate.restrictSiteTree 1

- xcelerate.rolemanagerclass 1

- xcelerate.saveSearchdir 1

- xcelerate.searchResultCols 1

- xcelerate.showSiteTree 1

- xcelerate.sitenameattr 1

- xcelerate.sitesattr 1

- xcelerate.sitesroot 1

- xcelerate.templatedefault 1

- xcelerate.tempobjectsdir 1

- xcelerate.thumbnaildir 1

- xcelerate.timezoneattr 1

- xcelerate.transformpath 1

- xcelerate.treehierassettype 1

- xcelerate.treeMaxNodes 1

- xcelerate.treetabmanagerclass 1

- xcelerate.treeType 1

- xcelerate.useDimensionAssets 1

- xcelerate.useidmapping 1

- xcelerate.userimageattr 1

- xcelerate.usermanagerclass 1

- xcelerate.workflowdir 1

- xcelerate.workflowengineclass 1