1/23
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
1
Introduction
1.1
About the Site Studio Technical Reference
1.2
Scope of the Technical Reference
2
Site Asset Relationships and File Structure
2.1
About Site Assets
2.2
Templates
2.2.1
Page Templates
2.2.2
Subtemplates
2.2.3
Region Templates
2.3
Definitions
2.3.1
Placeholder Definitions
2.3.2
Region Definitions
2.3.3
Element Definitions
2.4
Relationship Between Templates and Definitions
2.5
Serving Web Pages
2.6
Conversions Definitions
2.7
Contribution Mode
2.7.1
Key Command
2.7.2
Query String
2.7.3
Session Cookie
2.7.4
Process from Consumption Mode to Contribution Mode
3
Site Studio Metadata
3.1
About Metadata
3.2
Metadata Fields
3.2.1
xWebsiteObjectType
3.2.2
xWebsiteSection
3.2.3
xWebsites
3.2.4
xDontShowInListsForWebsites
3.2.5
xRegionDefinition
4
Link Formats
4.1
About Link Formats
4.2
Using Path-Based Links
4.3
Using Server-Side Script Links
4.3.1
wcmUrl
4.3.2
ssLink
4.3.3
ssNodeLink
4.3.4
ssWebLayoutUrl
4.4
Using Token Links
4.4.1
ssLINK
4.4.2
ssNODELINK
4.4.3
Token Links Generated From Returned Server-Side Links
4.5
Using JavaScript Links
5
Site Studio Runtime Generated Files
5.1
About Runtime Generated Files
5.2
Runtime Auto-Generated Files
5.2.1
sitenavigation.js
5.2.2
sitenavigationfunctions.js
5.2.3
sitenavigation.xml
5.2.4
sitenavigation.hda
5.2.5
sitenavigation_co.hda
5.3
wcm.toggle.js
6
Fragments
6.1
About Fragments
6.2
Fragment Libraries
6.3
Read-Only Fragment Libraries
6.4
Fragment Inclusion Using wcmFragment
6.5
Fragment Snippets and the ssIncludeXml()
6.6
Fragments That Use Custom Section Properties
6.6.1
Client-Side JavaScript
6.6.2
Server-Side Idoc Script
6.7
The Fragment Definition File
6.7.1
<fragments>
6.7.2
<fragment>
6.7.3
<parameter>
6.7.3.1
<option>
6.7.3.2
<querytext>
6.7.3.3
<validate>
6.7.3.4
<convert>
6.7.3.5
<customgui>
6.7.4
<snippet>
6.7.5
<designview>
6.7.6
<element>
6.8
Fragment Instance Structure in the <ssinfo> XML Data Island
7
Native Documents and Conversion
7.1
About Native Documents
7.2
wcmDynamicConversion
7.3
Document Conversion in the Properties Pane
7.4
Common Errors Using Native Documentation
8
Custom Elements
8.1
About Custom Elements
8.2
Element API
8.2.1
Loading the Element API
8.2.2
Element API Dependent Scripts
8.3
Custom Elements within Contributor
8.3.1
Communication from a Contributor Form to a Custom Element
8.3.2
Communication from a Custom Element to a Contributor Form
8.4
Legacy Custom Element Compatibility
8.4.1
Detecting Legacy Custom Element Forms
8.4.2
Upgrading Legacy Custom Elements
9
Idoc Script Extensions
9.1
About Idoc Script Extensions
9.2
wcmPlaceholder
9.3
wcmElement
9.4
wcmListStart
9.5
wcmListEnd
9.6
wcmListElement
9.7
wcmListRowCount
9.8
wcmDynamicList
9.9
wcmIncludeElement
9.10
wcmDynamicConversion
9.11
wcmGetListAsResultSet
9.12
wcmFragment
9.13
wcmUrl
9.14
ssIncludeXml
9.15
ssGetDocInfo
9.16
ssGetXmlNodeCount
9.17
ssIncDynamicConversion
9.18
ssIncDynamicConversionByRule
9.19
ssIncDynamicConversionByRulesEngine
9.20
ssIncInlineDynamicConversion
9.21
ssIsNativeDoc
9.22
ssRandom
9.23
ssGetNodeProperty
9.24
ssGetWebsiteNodeType
9.25
ssGetCoreMajorVersion
9.26
ssSplitString
9.27
ssGetWebsiteName
9.28
ssGetSiteProperty
9.29
ssGetFirstNodeId
9.30
ssGetRelativeNodeId
9.31
ssLoadSiteNavResultSet
9.32
ssGetServerRelativeUrl
9.33
ssGetServerRelativePath
9.34
ssGetUrlPageName
9.35
ssGetNodeLabel
9.36
ssGetNodeLabelPath
9.37
ssGetAllSites
9.38
ssLink
9.39
ssNodeLink
9.40
ssWeblayoutUrl
10
Idoc Script Variables
10.1
About Idoc Script Variables
10.2
HttpWebsitesRoot
10.3
HttpRelativeWebsitesRoot
10.4
HttpFragmentsRoot
10.5
HttpRelativeFragmentsRoot
10.6
SS_SERVER_NAME
10.7
HttpASPPath
10.8
ssServerRelativeSiteRoot
11
Site Studio Services
11.1
About Site Studio Services
11.2
Services Related to Contributor
11.3
Services Related to Designer
11.4
Services Related to Manager
11.5
Services Related to Switch Content
11.6
Services Related to Link Wizard
11.7
List of Services
11.7.1
SS_ADD_NODE
11.7.2
SS_ADD_WEBSITE_ID
11.7.3
SS_BATCH_DECODE_LINK
11.7.4
SS_CHECKIN_FRAGMENT_LIBRARY
11.7.5
SS_CHOOSE_WEBSITE_SECTION
11.7.6
SS_CHOOSE_WEBSITES
11.7.7
SS_CLEAR_PREVIEW
11.7.8
SS_CLEAR_REGION_ASSOCIATIONS
11.7.9
SS_CLEAR_WEBSITE_ID
11.7.10
SS_COMMIT_SITE_CHANGES
11.7.11
SS_CREATE_NEW_SITE_EX2
11.7.12
SS_CREATE_SITE_NAV_JS
11.7.13
SS_DECODE_LINK
11.7.14
SS_DELETE_NODE
11.7.15
SS_DOC_INFO_LATEST
11.7.16
SS_EDIT_NATIVE_DOCUMENT
11.7.17
SS_GET_ADMIN_PAGE
11.7.18
SS_GET_ALL_CUSTOM_NODE_PROP_DEFS
11.7.19
SS_GET_ALL_NODE_PROPERTIES
11.7.20
SS_GET_ALL_SITE_DOMAINS
11.7.21
SS_GET_ALL_SITE_PROPERTIES
11.7.22
SS_GET_ALL_SITES_EX2
11.7.23
SS_GET_CONFIG_INFO
11.7.24
SS_GET_CONTRIBUTOR_CONFIG
11.7.25
SS_GET_CONTRIBUTOR_STRINGS
11.7.26
SS_GET_DC_RULES
11.7.27
SS_GET_DOCUMENT_LABELS
11.7.28
SS_GET_DOCUMENT_USAGE
11.7.29
SS_GET_ENVIRONMENT_PROPERTY_NAMES
11.7.30
SS_GET_FIRST_NODE_ID
11.7.31
SS_GET_FRIENDLY_URL
11.7.32
SS_GET_LINK
11.7.33
SS_GET_LINK_MANAGEMENT_REPORT
11.7.34
SS_GET_LINK_WIZARD_CONFIG
11.7.35
SS_GET_LINK_WIZARD_CONFIG_WITH_SITE
11.7.36
SS_GET_NODE_LINK
11.7.37
SS_GET_NODE_PROPERTY
11.7.38
SS_GET_PAGE
11.7.39
SS_GET_PLACEHOLDER_SWITCH_CONTENT_CONFIG
11.7.40
SS_GET_REGION_ASSOCIATIONS
11.7.41
SS_GET_REGION_DEFINITION_ELEMENTS
11.7.42
SS_GET_RELATIVE_NODE_ID
11.7.43
SS_GET_SEARCH_RESULTS
11.7.44
SS_GET_SITE_AS_XML_EX2
11.7.45
SS_GET_SITE_ASSET_CATEGORIES
11.7.46
SS_GET_SITE_CHANGE_MONITOR_TOKEN
11.7.47
SS_GET_SITE_DEFINITION
11.7.48
SS_GET_SITE_DEFINITION_FOR_USER
11.7.49
SS_GET_SITE_DOMAINS
11.7.50
SS_GET_SITE_FRAGMENT_ASSET_REPORT
11.7.51
SS_GET_SITE_INFO
11.7.52
SS_GET_SITE_PROPERTY
11.7.53
SS_GET_SITE_PUBLISH_REPORT
11.7.54
SS_GET_SITE_REPORT
11.7.55
SS_GET_SWITCH_CONTENT_CONFIG
11.7.56
SS_GET_UNIQUE_NODE_SITE_ID
11.7.57
SS_GET_VERSION
11.7.58
SS_GET_WEBLAYOUT_URL
11.7.59
SS_IS_JS_NAV_OUT_OF_DATE
11.7.60
SS_MAP_FRIENDLY_NAME
11.7.61
SS_MOVE_NODE
11.7.62
SS_PARSE_FRIENDLY_URL
11.7.63
SS_PREPARE_PREVIEW
11.7.64
SS_PUBLISH_THIS_PAGE
11.7.65
SS_REMOVE_WEBSITE_ID
11.7.66
SS_SET_ALL_CUSTOM_NODE_PROP_DEFS
11.7.67
SS_SET_ELEMENT_DATA
11.7.68
SS_SET_ENVIRONMENT_PROPERTY_NAMES
11.7.69
SS_SET_NODE_PROPERTY
11.7.70
SS_SET_NODES_PROPERTIES
11.7.71
SS_SET_PREVIEW_ELEMENT_DATA
11.7.72
SS_SET_SITE_ASSET_CATEGORIES
11.7.73
SS_SET_SITE_DOMAINS
11.7.74
SS_SET_SITE_PROPERTIES
11.7.75
SS_SET_SITE_PROPERTY
11.7.76
SS_SWITCH_REGION_ASSOCIATION
11.7.77
SS_VALIDATE_WEBSITE_OBJECT
11.7.78
WCM_PLACEHOLDER
11.7.79
WCM_EDIT_DATA_FILE
11.7.80
WCM_BEGIN_EDIT_SESSION
12
Site Studio Configuration Flags
12.1
About Site Studio Flags
12.2
DisableSiteStudioContribution
12.3
ShowSiteStudioMissingDataFileErrors
12.4
SiteStudioValidateElementDefinitions
12.5
SiteStudioValidateRegionDefinitions
12.6
SiteStudioValidatePlaceholderDefinitions
12.7
SiteStudioValidateConversionsDefinitions
12.8
SiteStudioValidateDataFiles
12.9
SiteStudioValidateProjects
12.10
SSAccessDeniedHeader
12.11
SSAccessDeniedReplacementHeader
12.12
SSAccessDeniedUserAgentExceptions
12.13
SSAccommodateWelcomeFile
12.14
SSAdditionalNavResultSetFields
12.15
SSAddSecurityIDValues
12.16
SSAfterProjectLoadedProperties
12.17
SSAllowDynamicDefinitions
12.18
SSAllowEmptyUrlPageName
12.19
SSAllowNotModifiedHeader
12.20
SSAltTagFieldName
12.21
SSAlwaysRecordServerConfig
12.22
SSAssumeXmlIsUtf8
12.23
SSAutoCheckinBusyTimeout
12.24
SSBackupCollectionName
12.25
SSCacheControlOverride
12.26
SSCanGenerateUniqueDataFiles
12.27
SSChangeAccessDeniedHeaders
12.28
SSCheckAssignedContentAccess
12.29
SSCheckBrowserForSiteRoot
12.30
SSCheckWebsiteObjectSecurity
12.31
SSClearDefinitionArchiveWebsites
12.32
SSCompressorArguments
12.33
SSCompressorCommand
12.34
SSCompressorDir
12.35
SSCompressorJar
12.36
SSCompressorMainClass
12.37
SSCompressorTimeout
12.38
SSCompressorTimerInterval
12.39
SSCompressorWaitForever
12.40
SSContributorSourceDir
12.41
SSCustomNodePropertyDefsPermissions
12.42
SSDefaultDocumentsFields
12.43
SSDefaultEditor
12.44
SSDefaultExternalDocNamePrefix
12.45
SSDefaultExternalDocNameSuffix
12.46
SSDefaultExternalServerRelativeSiteRoot
12.47
SSDefaultExternalUrlPrefix
12.48
SSDefaultExternalUrlSuffix
12.49
SSDefaultPlaceholderDefinition
12.50
SSDefaultRegionTemplate
12.51
SSDefaultUrlPageName
12.52
SSDetectIncludeFileEncoding
12.53
SSDICPlaceholderDefinition
12.54
SSDirectDeliveryExtensions
12.55
SSDirectDeliveryOverrideProperty
12.56
SSDirectDeliveryProperty
12.57
SSDirectDeliveryRequiredExtensions
12.58
SSDisableDeferredNodeExpansion
12.59
SSDisableIncludeXmlCache
12.60
SSDisableLinkResolutionSiteLocking
12.61
SSDisableProjectDeferredNodeExpansion
12.62
SSDomCacheDefaultFileSizeFactor
12.63
SSDomCacheFileSizeFactors
12.64
SSDomCacheLowerBound
12.65
SSDomCacheMultiplier
12.66
SSDomCacheNodeMultiplier
12.67
SSDomCacheStringMultiplier
12.68
SSDomCacheStringOverhead
12.69
SSDomCacheUseDOM
12.70
SSDomCacheUseFileSize
12.71
SSEditorDebugLevel
12.72
SSEnableASPSupport
12.73
SSEnableDirectDelivery
12.74
SSEnableExtranetLookCompatibility
12.75
SSEnableFolioEditing
12.76
SSEnableFormEditing
12.77
SSEnableJavaScriptCompressor
12.78
SSEnableUpperCaseColumnsCheck
12.79
SSGenerateUniqueNodeIds
12.80
SSHidePrimaryFileInContributor
12.81
SSHttpAbsoluteHelpRoot
12.82
SSHttpLayerManager
12.83
SSIdocMarker
12.84
SSIgnoreMaxAgeNodeProperties
12.85
SSIgnoreNoProjectDefaultMetadataMessage
12.86
SSIgnoreReadyToReplicate
12.87
SSImportOnlyLatestRevs
12.88
SSIncludeInactiveNodesInNavResultSet
12.89
SSIncludeInactiveNodesInNavXML
12.90
SSIncludeRegionTemplatesInDefinitionBundles
12.91
SSIncludeXmlTransformFormat
12.92
SSIncludeXmlTransformIndent
12.93
SSJavaExecutablePath
12.94
SSJSONContentType
12.95
SSLoadCustomElementsWithOnDemandEditors
12.96
SSLoadProjectsAtStartup
12.97
SSLoadUncompressedFckSource
12.98
SSManuallyValidateNodeIdUniqueness
12.99
SSMaxNodeIdLength
12.100
SSMaxSiteIdLength
12.101
SSMaxSitesMenuItems
12.102
SSMaxTemplateEvaluationStack
12.103
SSMigrationCollectionName
12.104
SSOmitFragmentLibrariesInArchiverQueries
12.105
SSOnDemandEditorsThresholdCount
12.106
SSPrefillUrlDirNamesDuringUpgrade
12.107
SSProjectAutoCheckinInterval
12.108
SSProjectLoadFailureTracingSection
12.109
SSProjectReleaseSleepTime
12.110
SSProjectReleaseWaitTime
12.111
SSQuickDiffDefaultRegionTemplate
12.112
SSShowAssignmentTooltips
12.113
SSSQLUseContains
12.114
SSStoppedSiteResponsePageDocName
12.115
SSSuppressAddToWebsite
12.116
SSSuppressLargeCssOptimization
12.117
SSTempProjectLifetime
12.118
SSTitleTagFieldName
12.119
SSTrackContentAccess
12.120
SSTrackFragmentAccess
12.121
SSUrlFieldName
12.122
SSUrlFixupExceptions
12.123
SSUrlPageNames
12.124
SSUseAbsoluteRedirects
12.125
SSUseCallbackTrackingForASP
12.126
SSUseDefaultDocNamePrefix
12.127
SSUseDefaultServerRelativeSiteRoot
12.128
SSUseDefaultUrlPrefix
12.129
SSUseMissingLinkTargetFallback
12.130
SSUseOnDemandContributionModeMenus
12.131
SSUseUrlSegmentSessionInfo
12.132
SSValidateCustomElements
12.133
SSWebFilterIgnoreList
12.134
SSWeblayoutUrlUsesDocNames
12.135
SSWelcomeFile
12.136
SSWelcomeFileReplacement
13
Site Studio Performance Tuning
13.1
About Site Studio Performance
13.2
On-Demand Web Site Management
13.3
On-Demand Contributor Editors
13.3.1
About Configuration Flags
13.3.2
Configuration Flags used for On-Demand Editors
13.3.2.1
SSOnDemandEditorsThresholdCount
13.4
Optimizing Contributor Code
13.4.1
Optimization Requirements
13.4.2
The Build Process
13.4.3
Building the Optimized Code
13.4.4
Debugging the Build Script
13.4.5
Configuring Site Studio to Use Optimized Code
13.4.6
Customizations and the Build Process
13.5
Memory Usage
13.5.1
Flags for Memory Size in XML DOMs
13.5.2
Flags for Size of Items in the DOC_INFO Cache
13.5.3
Flags for Controlling the SSXPathCacheEntry Cache
14
JSON and Contributor
14.1
About JSON
14.2
Passing Configuration To and From Contributor
15
Contributor Console Window
15.1
About the Contributor Console Window
15.1.1
Logging Window
15.1.2
Command Window
15.1.3
Contributor Console Window User Interface
15.2
Installing the Contributor Console Window
15.3
Launching the Contributor Console Window
15.4
Using the Contributor Console Window
15.4.1
Contributor Console Window Context
15.4.2
Ensuring the Contributor Console Window is Root
15.4.3
Practical Use of the Contributor Console Window
15.4.4
Orphaned Console Windows
15.5
Logging Syntax
15.6
Time Profiling
15.7
Command Window Helper Functions
15.8
Keyboard Commands
16
Manager Settings File
16.1
About the Manager Settings File
16.2
<ssm:settings> Tag
16.3
<ssm:general> Tag
16.4
<ssm:addSection> Tag
16.5
<ssm:removeSection> Tag
16.6
<ssm:moveSection> Tag
16.7
<ssm:setErrorHandler> Tag
16.8
<ssm:editProperties> Tag
16.9
<ssm:editCustomProperties> Tag
16.10
<ssm:primaryLayout> Tag
16.11
<ssm:secondaryLayout> Tag
16.12
<ssm:sectionOverride> Tag
16.13
Example Manager Settings File
17
Content Tracker Integration
17.1
Tracked Data
17.2
Configuration Flags
A
Configuring Oracle Content Server 10gR3 for Use with Site Studio 11gR1
A.1
Installing Site Studio 11gR1 on Oracle Content Server 10gR3
A.2
Downloading Components
A.3
Obtaining Site Studio Designer 11gR1
A.4
Setting Default Project Document Information
A.5
Configuring Apache Web Server
A.6
Configuring Sun ONE Web Server
A.7
Configuring Zone Fields
A.8
Enabling JavaServer Pages on the Content Server
B
Upgrading Pre-7.5 Web Sites
B.1
Introduction
B.2
What the Automated Upgrade Does
B.3
Upgrading Your Content Servers
B.3.1
Upgrading Sites on a Single Content Server Instance
B.3.2
Upgrading Sites on Multiple Content Server Instances
B.3.3
Performing a Full Upgrade
B.3.4
Performing a Minimal Upgrade
B.4
Performing Additional Steps Manually
B.4.1
Updating the Site Navigation
B.4.2
Rebuilding the Content Server Index
B.4.3
Updating Your Custom Fragments
B.4.3.1
Modifying Links That Rely on the <base> Tag
B.4.3.2
Modifying Obsolete SS_GET_PAGE / JavaScript Links
B.4.3.3
Updating GET_SEARCH_RESULTS
B.4.4
Updating Your Custom Elements
B.4.5
Assigning a Web Site Section to Your Folders
B.4.6
Updating JSP Code
Index
Scripting on this page enhances content navigation, but does not change the content in any way.