Oracle® Fusion Middleware Technical Reference Guide for Site Studio 11g Release 1 (11.1.1) Part Number E10615-01 |
|
|
View PDF |
This section covers the following topics:
Site Studio supports configuration flags that can be used to customize the operation of Site Studio. These flags allow you to finely control the operation of Site Studio both on the Oracle Content Server as well as for designers and contributors.
Whenever you change a flag, you should restart the Content Server.
Perform these steps to add configuration parameters for Oracle UCM:
Log in to Oracle Content Server as an administrator at the following URL:
http://Host_Name:Port/cs
The default protocol for Oracle Content Server is http, and cs is the default http relative web root for Oracle Content Server. The default port number is 16200.
Open the Administration page, and then choose Admin Server. The Content Admin Server page is displayed.
Click General Configuration on the left. The General Configuration page is displayed.
In the Additional Configuration Variables box, add or change the parameter or parameters as needed.
Click Save and restart the content server.
Flags that have no default value must be added to the configuration file, they are not included in the config.cfg file when shipped.
This flag prevents pages from opening in contribution mode. All methods of switching to contribution mode are blocked. This can be useful when creating production or read-only Web sites.
Values
Boolean
Default
no
This flag is used to control if a message is shown in contribution regions with empty data file assignments.
Values
Boolean
Default
no
This flag is used to control if element definition files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to control if region definition files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to control if placeholder definition files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to control if conversion definition files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to control if data files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to control if project files are validated against the XSD schema.
Values
Boolean
Default
yes
This flag is used to define a header string to search for in http responses. If found, this will be replaced with the value of the flag SSAccessDeniedReplacementHeader (see "SSAccessDeniedReplacementHeader").
Values
String
Default
401 Access denied
This flag is used to define a header string to use as the replacement for the value of SSAccessDeniedHeader (see "SSAccessDeniedHeader").
Values
String
Default
499 Oracle SSO
This flag is used to set a comma-separated list of values that, if found in the HTTP-USER-AGENT header, will nullify the SSChangeAccessDeniedHeaders flag (see "SSChangeAccessDeniedHeaders") for the particular request.
Values
CSV String
Default
No default value.
This flag is used to control if the <welcome-file>
mechanism of WLS-based content server is accommodated.
Values
Boolean
Default
yes
This flag is used to specify a comma-separated list of additional section properties to add to the standard set of properties in the SiteStudioNavNodes ResultSet used with the ssLoadSiteNavResultSet
Idoc function (see "ssLoadSiteNavResultSet" for more information).
Values
CSV String
Default
No default value.
This flag is used to specify if a dID value of 0 is placed in the ResultSet used to check user access to sections. This was needed for operability with some early versions of Records Management.
Values
Boolean
Default
no
This flag is used to specify a comma-separated list of site properties to send to the SSAfterProjectLoaded PluginFilter used with Site Studio for External Applications.
Values
CSV String
Default
siteLabel,siteType,isExternal
This flag is used to enable or disable Idoc evaluation of definition files loaded from disk.
Values
Boolean
Default
yes
This flag is used to specify if a landing page is delivered for an incoming URL with an empty value for Url Page Name. In previous versions of Site Studio, the behavior was to do a redirect in these circumstances to generate the full landing page URL. Set the option false to restore that old behavior.
Values
Boolean
Default
yes
This flag is used to override customized behavior for Site Studio Publisher Utility. The SSPETag flag is used to return a 304 to indicate that the result from a GET_FILE URL has not changed. Use the SSAllowNotModifiedHeader flag to disable this behavior on >= 7.2 servers.
Values
Boolean
Default
yes
This flag is used to specify the name of the metadata field to use for alt tag tags on images inserted via Contributor.
Values
String
Default
dDocTitle
This flag is used to specify whether or not to record the "server config" in a backup archive.
Values
Boolean
Default
no
This flag is used to determine if the content of files with the extension ".xml" are encoded in UTF-8 format. With the flag set to "yes", making this assumption speeds the processing of XML files by avoiding the inspection of the encoding declaration in the file itself.
Values
Boolean
Default
yes
This flag is used to set the minimum time duration (in seconds) before the auto check-in mechanism attempts a check-in of a project file. This prevents two nodes from trying to check the project file in at the same time.
Values
Integer
Default
30
This flag is used to override the name of the Site Studio backup collection used with Archiver.
Values
String
Default
No default value.
This flag is used to provide the same cache-control header on every response. It replaces anything that would be provided by the maxage
and maxagesecondary
node properties. See also "SSIgnoreMaxAgeNodeProperties".
Values
String
Default
No default value.
This flag is used as a global override for the Generate Unique Data Files option in the Region Menu in Design mode. When set to yes
, the option is available for Design mode.
Values
Boolean
Default
yes
This flag is used to control whether 401 responses will be changed to 499 responses for use with Oracle SSO.
Values
Boolean
Default
no
This flag is used to check the dDocNames assigned to the primary or secondary url for security access. This check happens during the actions part of SS_GET_PAGE, so the error page can be shown.
Values
Boolean
Default
no
This flag is used to indicate whether or not to produce server relative site root values with respect to the browser URL. If set to no
, the server-relative URL prefix will be generated from the default site address.
Values
Boolean
Default
yes
This flag is used to activate security checking for website objects. Normally, since *use* of a website object by the component/server while delivering a page doesn't really constitute end-user "access" to the resource, there are no security checks on these objects. Setting this flag to true
will activate security checking for each website object.
Values
Boolean
Default
no
This flag is used to forcibly remove the existing xWebsites values when importing a definition archive.
Values
Boolean
Default
no
This flag is used for additional arguments passed to the JavaScript compressor's process.
Values
String
Default
No default value.
This flag is used as a command-line replacement to launch the JavaScript compressor's process.
Values
String
Default
No default value.
For more information on the string value that would be used, see the README file located in the wcm\tools\yui-compressor\doc\
folder on the Oracle Content Server.
This flag is used as an override for the JavaScript compressor's implementation location.
Values
String
Default
<weblayout>/resources/wcm/tools/optimize
This flag is used as an override for the JavaScript compressor's Rhino jar file location.
Values
String
Default
<weblayout>/resources/wcm/tools/rhino/rhino1_7R2/js.jar
This flag is used as an override for the JavaScript compressor's main class.
Values
String
Default
org.mozilla.javascript.tools.shell.Main
This flag is used to override the JavaScript compressor's minimum amount of time allowed (in seconds) for the process to complete.
Values
Integer
Default
900
This flag is used to override the length of the JavaScript compressor's process sleep interval (in seconds).
Values
Integer
Default
10
This flag is used to override the JavaScript compressor's file lock wait duration.
Values
Boolean
Default
no
This flag is used to determine the directory within the <weblayout>/resources directory where the Contributor JavaScript code is referenced.
Values
String
Default
wcm
This flag is used to determine the default permission a user needs to access custom node properties.
The values are one of the following four:
1 = Read Permission
2 = Write Permission
4 = Delete Permission
8 = Admin Permission
Values
Integer
Default
2
This flag is used to override the default documents fields. Enter the default documents fields to use.
Values
CSV String
Default
No default. Values entered are field names.
This flag is used to specify the base editor for the Contributor application.
Values
String
Default
fck
This flag is used to specify a string (possibly a partial URL) to prefix evaluated wcmUrl
links of type resource
that have a dDocName
parameter. This is used when delivering content through the WCM_PLACEHOLDER service where there might be a need to alter the URLs produced.
Values
String
Default
The evaluation of <$HttpAbsoluteWebRoot$>
This flag is used to specify a string (possibly a URL Query segment) to affix to evaluated wcmUrl
links of type resource
that have a dDocName
parameter. This is used when delivering content through the WCM_PLACEHOLDER service where there might be a need to alter the URLs produced.
Values
String
Default
No default
This flag is used to specify a string to use when evaluating <$ssServerRelativeSiteRoot$>. This is used when delivering content through the WCM_PLACEHOLDER service where there might be a need to alter the URLs produced.
Values
String
Default
No default
This flag is used to specify a string (possibly a partial URL) to prefix evaluated wcmUrl
links of type resource
that have a partial weblayout path parameter. This is used when delivering content through the WCM_PLACEHOLDER service where there might be a need to alter the URLs produced.
Values
String
Default
The evaluation of <$HttpAbsoluteWebRoot$>
This flag is used to SPECIFY a string (possibly a URL Query segment) to affix to evaluated wcmUrl
links of type resource
that have a partial weblayout path parameter. This is used when delivering content through the WCM_PLACEHOLDER service where there might be a need to alter the URLs produced.
Values
String
Default
No default
This flag is used to override the placeholder definition.
Values
String
Default
SS_DEFAULT_PLACEHOLDER_DEFN
This flag is used to override the default region template.
Values
String
Default
SS_DEFAULT_REGION_TEMPLATE
This flag is used to change the value of the default url page name. This allows files other than those named index.htm
to be the default page for a section of a Web site.
The flag SSUrlPageNames (see "SSUrlPageNames") allows additional url page names to be used to deliver the primary page.
Values
String
Default
No default value.
This flag is used to specify if the encoding of Web site objects have their encoding determined or not.
Values
Boolean
Default
no
This flag is used to specify a default Placeholder Definition name to be used in Doc Info Contribution.
Values
String
Default
SS_DEFAULT_PLACEHOLDER_DEFN
This flag is used to specify which file extensions are delivered directly. If the flag is not listed in config.cfg, then PDF files will still pass via direct delivery, and other native documents will follow conversion rules.
When the flag is present, all file types listed here (by filename extension) will be delivered directly. File types not specifically listed will be displayed via conversion. This includes pdf files, if the flag is present but pdf files are not listed.
Values
CSV String
Default
pdf
This flag is used to specify which custom section property is used to override the global values of the section. The property named in the flag should use a boolean value indicating if the global values should be overridden or not.
Values
String
Default
OverrideDirectDeliveryExtensions
This flag is used to specify the name of a custom section property. This property identifies the file extensions to deliver directly from this particular section.
The file extensions listed here will override the global list in SSDirectDeliveryExtensions (see "SSDirectDeliveryExtensions").
Values
String
Default
DirectDeliveryExtensions
This flag is used to specify file types that are always to be delivered by direct delivery. The file extensions listed here are not overridden by those listed in SSDirectDeliveryProperty (see "SSDirectDeliveryProperty").
Values
CSV String
Default
pdf
This flag is used to enable or disable deferred node expansion. The Xerces parser's deferred node expansion feature is known to be a very inefficient feature for small DOMs, so setting this flag to no
might impede performance.
Values
Boolean
Default
yes
This flag is used to control if extracted content from data files is cached. This cache makes retrieval of content from data files much faster.
Values
Boolean
Default
no
This configuration flag is used to reduce site lock contention during page assembly. When the flag is set to yes
, it prevents the Idoc script extensions ssLink and ssNodeLink, as well as the wcmUrl equivalents wcmUrl('link'... and wcmUrl('nodelink'..., from synchronizing their accesses of internal web site information structures. This can improve performance by reducing lock contention, which then allows multiple requests to process simultaneously. However, this comes at the risk of producing inaccurate links in a changing web site.
Setting the flag to yes
is most useful when the Oracle Content Server is run under the following conditions:
The Site Studio web sites change infrequently; it is largely a read-only environment.
The web pages contain numerous ssLink or ssNodeLink calls to produce links.
The server is typically sufficiently loaded to cause lock contention inside Site Studio.
Values
Boolean
Default
no
This flag is used to control whether DOM nodes will be expanded in memory during the loading of XML files, or if the node content will be loaded on-demand.
Values
Boolean
Default
yes
This flag specifies the default file size value to multiply the file size by to obtain a cache size.
Values
Numeric
Default
2.0
This flag defines a comma-separated list of file sizes and multipliers that control the computed cache size.
For example, the following string
1000,6.0,10000,2.7,50000,2.1,100000,1.9,300000,1.6
multiplies files sized [0..999] by 6.0,
multiplies files sized [1000..9999] by 2.7,
multiplies files sized [10000..49999] by 2.1,
multiplies files sized [50000..99999] by 1.9,
multiplies files sized [100000..299999] by 1.6,
Files outside the range above are multiplied by the value of SSDomCacheDefaultFileSizeFactor (see "SSDomCacheDefaultFileSizeFactor").
Values
CSV string
Default
No default value.
This flag is used to define a lower bound on the reported cache size.
Values
Numeric
Default
6000
This flag is used to set a multiplier on the computed cache size to arrive at a final value reported to the cache. The cache will then multiply the reported value by 10 in its computations.
Values
Numeric
Default
0.1
This flag specifies the number of bytes to count per DOM node.
Values
Numeric
Default
12
This flag specifies the number of bytes to multiply string lengths in the DOM by to produce the string size.
Values
Numeric
Default
2
This flag specifies the number of bytes to add per string in the DOM.
Values
Numeric
Default
24
This flag is used to compute a cache size based on an enumeration of the XML DOM.
Values
Boolean
Default
no
This flag is used to compute a cache size based on the size of the file.
Values
Boolean
Default
yes
This flag is used to override the Ephox editor's debug level.
The available values are http, debug, info, warn, error, and fatal.
Values
String
Default
No default value.
This flag is used to enable ASP support in Site Studio 11gR1 and above. In the 11gR1 component and later, ASP support is disabled by default.
Values
Boolean
Default
no
This flag is used to control direct delivery. Direct delivery alows you to link to a native document content file for download, rather than having it display in the page using conversion rules.
For more information, see the User's Guide for Site Studio Designer.
Values
Boolean
Default
no
This flag is used to allow interoperability with the ExtranetLook component, as well as to preserve friendly URLs when certain Single Sign On (SSO) systems are used.
Values
Boolean
Default
no
This flag allows Folios assigned to a Site Studio region or placeholder to be edited.
Values
Boolean
Default
no
This flag is used to override including the Form Editor option in the Region Menu. Setting the flag to yes
includes the Form Editor in the menu.
Values
Boolean
Default
no
This flag enables the JavaScript compression from the Site Studio Administrator pages in the Oracle Content Server.
Values
Boolean
Default
yes
This flag is used to ensure that xRegionDefinition has the same case-preserving aspects as dDocName.
Values
Boolean
Default
yes
This flag is used to ensure that nodeIds are unique server-wide. If set to boolean no
, the nodeId only be unique within each project. This latter action mimics older Site Studio behavior.
Values
Boolean
Default
yes
This flag is used to hide the filename field when creating a new web asset. This helps to avoid modifying the the name to something inappropriate.
Values
Boolean
Default
no
This flag is used to direct Site Studio Contributor to the help file location.
Values
String
Default
<$HttpWebRoot$>help/
This flag is used as an alternate HttpLayerManager. Using this can be useful with some implementations with Ephox.
Valid values for Ephox include default
and sun
.
Values
String
Default
No default value.
This flag is used to set the value that determines if a Web site object contains Idoc Script code or not, and thus if it is a candidate for Idoc parsing and evaluation.
Values
String
Default
!--$
This flag is used to override the maxage and maxagesecondary node properties.
While you might want these properties to generate cache-control headers on your live system, it could be desirable to disable that behavior on the development environment. See also: "SSCacheControlOverride".
Values
Boolean
Default
no
This flag is used to override any errors caused with default project metadata. Normal behavior is to throw an exception if the default project metadata has not been set. Override that by setting this option to boolean yes
.
Values
Boolean
Default
no
This flag is used to override section level settings for Ready to Replicate. Setting the flag to yes
will cause all sections to be replicated regardless of section level setting.
Values
Boolean
Default
no
This flag is used to import only the latest revision when importing an archive. The default behavior when importing an archive is to import everything.
Values
Boolean
Default
no
This flag is used to include inactive nodes in the ssNavNodes result set. By default the ssNavNodes result set does not include inactive nodes.
Values
Boolean
Default
no
This flag is used to include inactive nodes in the navigation XML file. By default the navigation XML does not include inactive nodes.
Values
Boolean
Default
no
This flag is used to determine if region templates are included in definition bundles. The default behavior is to include Region Templates in a definition bundle. Omit them by setting this option false.
Values
Boolean
Default
yes
This flag is used to set the file type that data files are transformed into when transformed. The transformation can be specified as xml, xhtml or html.
Results may change considerably by modifying this flag.
Values
String
Default
HTML
This flag is used to format the XML file to include indentations. This allows the XML code to be printed in an indented format, rather than as a single line.
Values
Boolean
Default
no
This flag is used to override what Java executable to use for the JavaScript compressor implementation. This flag should be used when the default (java.home environment variable) should not be used.
The default variable for this flag should be changed if you intend to use the flag.
Values
String
Default
java.home env variable
This flag is used to override the JSON content type.
Values
String
Default
application/jsonrequest
This flag allows custom elements to be fully loaded when all standard elements are loaded on demand. Custom elements provide their own UI so if they are loaded on demand they will have no preview. In general custom elements load more quickly than standard elements so allowing these to load fully should not have a large impact on the load time performance of the Contributor form.
Values
Boolean
Default
yes
This flag is used to override the loading of projects at startup. If there are a substantial number of projects in the system, this could prevent the Oracle Content Server service from starting as a service under Windows.
Values
Boolean
Default
yes
This flag is used to load uncompressed FCK Editor source code. This is a debugging aid to FCK Editor.
Values
Boolean
Default
no
This flag is used to override the use of the XML parser to validate unique nodeIds. Certain implementations will validate large projects slowly when using the XML parser, so the default value is to not use it.
Values
Boolean
Default
yes
This flag is used to override the maximum node ID value length.
Values
Integer
Default
30
This flag is used to override the maximum site ID value length.
Values
Integer
Default
30
This flag is used to set the maximum number of Web sites that can be displayed in the websites menu.
Values
Integer
Default
No default value.
This flag is used to override the maximum number of Placeholder nestings.
Values
Integer
Default
200
This flag is used to set he name of the collection that will be used for backup archives.
Values
String
Default
The value of the content server "Instance Name
"
.
This flag is used to omit the fragment libraries in a backup archive. The default setting is to include them.
Values
Boolean
Default
no
This flag is used to set the number of elements that must be present in a contribution to cause the elements to load on demand in Contributor.
Values
Integer
Default
6
This flag is used to generate and populate values for the Url Dir Name section property with Site Studio Web sites before version 7.5.
Values
Boolean
Default
yes
This flag is used to set the time interval (in seconds) the project file is automatically checked in.
Values
Integer
Default
600
This flag is used to specify a NAME of a tracing section to be used to dump diagnostics when a project load error occurs. By default these exceptions will always be dumped. Use this flag to selectively dump them when you enable the specified trace section.
Values
String
Default
No default value
.
This flag is used to set the time in seconds to sleep while waiting for project release. Also see "SSProjectReleaseWaitTime"
Values
Integer
Default
3
This flag is used to set the time in seconds to wait for a newly committed project file to become "released" during an archive operation. Also see "SSProjectReleaseSleepTime".
Values
Integer
Default
30
This flag is used to set the template used as the Quick Diff's region template.
Values
String
Default
SS_DEFAULT_REGION_TEMPLATE
This flag is used to enable or disable the Assignment tooltip while in Contributor mode. When set to yes
, the tooltip will display when hovering over the region marker.
Values
Boolean
Default
no
This flag is used to control the query in SQL searches. When the SQL contains
operator is not available for the xWebsites or xDontShowInListsForWebsites columns.
Setting this flag to no
uses the like
query; setting it to yes
uses the contains
query.
Additionally, there can be problems for some queries used by Site Studio if Site Id values contain the "_" character. These problems are caused by the fact that the "_" is used as a word break character at indexing time and as a wildcard character at query time.
To avoid these issues Site Studio can be told to not use a contains
query but to instead use a four-part like
query.
Values
Boolean
Default
no
This flag is used to set the dDocName of a content item defining a page to be returned if you try to access a website that has been stopped.
Values
String
Default
No default value.
This flag is used to prevent images that are linked to from being marked as part of the current Web site. When linking to an image, Site Studio normally marks that image as part of the current Web site, which requires write permission on the image. Use this flag to not mark the image.
Note that this image will not be picked up by site archives if this is used.
Values
Boolean
Default
no
This flag is used to enable or disable the CSS optimization calculation. The optimization calculation happens in Contributor mode, rather than when the Contributor form is being rendered so that the Contributor form loads faster.
When this flag is set to yes
, the calculation will be used.
Values
Boolean
Default
no
This flag is used to override for the time (in seconds) to leave temp project files after they have been checked in to the content server.
You must use extreme caution if you change this.
Values
Integer
Default
120
This flag is used to set which metadata field is used for title tags.
Values
String
Default
dDocTitle
This flag is used to specify the name of the metadata field to use for title tags on images inserted via Contributor.
Values
Boolean
Default
yes
This flag is used as an override to enable tracking of fragments with Tracker.
Values
Boolean
Default
no
This flag is used as an override to specify a metadata field name to be used instead of dDocName when producing the page identifier in URLs. Specifiy a name without the leading x
, for instance Foo
, not xFoo
.
Values
String
Default
No default value.
This flag defines a list of regular expressions applied during link fixup to determine if this link should not be fixed up.
Values
String, values separated by 'pipes': |
Default
No default value.
This flag is used to nominate other allowable URL page names that will deliver the primary page. This is helpful if there are existing data files with path-based links using the previous default URL page name.
The default URL page name is whatever is specified in each section property, otherwise, it is index.htm
. The related flag SSDefaultUrlPageName (see "SSDefaultUrlPageName") allows you to specify a default file that is not index.htm
.
Values
CSV string
Default
No default value.
This flag is used to override to restore previous Site Studio versions behavior of redirects. The current default and recommended value is to redirect to a relative URL. When this flag is set to Boolean yes
, all redirects will use absolute URLs.
Values
Boolean
Default
no
This flag is used to determine if ASP uses the callback type of reporting content access for tracker. The default is to enable content access tracking. To enable the callback type that is potentially more accurate, but much slower, then enable this flag.
Values
Boolean
Default
no
This flag is used to determine default value for the SSDefaultExternalDocNamePrefix
configuration entry if it is not specified.
Values
Boolean
Default
yes
This flag is used to determine if the default value for the SSDefaultServerRelativeSiteRoot
configuration entry if it is not specified.
Values
Boolean
Default
yes
This flag is used to determine if the default value for the SSDefaultUrlPrefix
configuration entry if it is not specified.
Values
Boolean
Default
yes
This flag is used to generate a tokenized link in the cases where a computeUrl function does not have a target. If the target dDocName or the target nodeId no longer exist, then a replacement URL will not be generated. The default action of the flag computes a tokenized link to avoid script extension errors.
Values
Boolean
Default
yes
This flag controls the creation of the menus in Contributor. When a page has multiple placeholders, a lot of DOM manipulation is required to construct the popup menus for each placeholder marker. When using Internet Explorer this process can take a long time and cause the CPU to spike to 100%. When this flag is set to yes, the creation of the menus is delayed until the user actually clicks on the icon.
Values
Boolean
Default
yes
This flag allows the URL to determine which mode you are in by including an extra path segment. (For example: contributor/design/preview<previewId>)
Values
Boolean
Default
no
This flag is used to determine whether or not a custom element validates the compatibility of a custom element form. This feature was intended for notifying users to upgrade their legacy custom element forms. This flag should be set to false for performance reasons.
Values
Boolean
Default
no
This flag is used to specify which folders to have the web server filter plugin ignore. This allows domain based sites to address resources external to the Oracle Content Server.
Values
String
Default
No default value.
This flag is used to allow dDocNames to be used in place of weblayout paths with ssWeblayoutUrl and corresponding wcmUrl('resource' ...) links.
Values
Boolean
Default
no
This flag is used to specify the welcome file, a URL suffix automatically generated by WLS. This will typically be portal.htm
, which will not match any of Site Studio's URLs.
Values
String
Default
/portal.htm