TARGET SECTION SOURCE SS_GET_PAGE

Site Studio Services 11-19 the web site. These were originally called nodes when the product was first developed, and, as such, many behind-the-scenes features like the SS_GET_PAGE service still refer to them as such. In Site Studio terminology, a node is the same as a section. Three Rules for Reusing Content When SS_GET_PAGE is used with the nodeId parameter, the service is told explicitly to display the primary page of the specified section, and no more decisions are needed. But when SS_GET_PAGE is used with the ssDocName parameter, the service must determine which section to display the document in, and this is determined by the following three rules:

1. TARGET

: If the optional ssTargetNodeId parameter is specified in the URL, then it explicitly displays the managed document in that section.

2. SECTION

: If the managed document has a value in its xWebsiteSection metadata field, then it uses that value as the section to display the managed document in.

3. SOURCE

: If the optional ssSourceNodeId parameter is specified in the URL as the current pages node, then it explicitly displays the managed document in that section. All of this allows contributors to share and reuse content contributor data files and native documents in different sections of the same site and even different sites on the same content server see Sharing region content using target sections in the Oracle Fusion Middleware Users Guide for Site Studio Designer. Once the SS_GET_PAGE service using an ssDocName parameter has determined which section to display the managed document in, it still needs to determine whether it should serve up the primary or secondary layout page. The following algorithm controls this: The above description assumes that the ssDocName parameter points to a contributor data file or native document. If the ssDocName parameter points to a layout file, then a different decision-making process occurs, whereby Site Studio walks the site hierarchy until it locates a section using that layout. However, a direct link to a managed layout is rare; it is typically used internally by Designer. In addition to nodeId, ssDocName, ssTargetNodeId, and ssSourceNodeId, the SS_ GET_PAGE service also recognizes the following optional URL parameters or cookie values: ■ SSContributor : This parameter contains a true or false value to indicate whether the web page should be displayed in contribution mode. In contribution mode, the Condition Action If ssDocName matches any of the region parameters in the sections primaryUrl property Serve up the primary page. If ssDocName matches any of the region parameters in the sections secondaryUrl property Serve up the secondary page. Else Serve up the secondary page but replace the REPLACEABLE region parameter with the ssDocName value. The REPLACEABLE region is defined by the sections secondaryUrlVariableField property. 11-20 Oracle Fusion Middleware Technical Reference Guide for Site Studio web page displays workflow versions of content items and a contribution icon for each contribution region. If necessary, this parameter will also cause a login prompt. If passed as a URL parameter, this value will automatically get set as a cookie value as well so that it is automatically propogated as the contributor navigates the site. ■ PreviewId : This parameter indicates that a temporary preview version of the web page should display instead of the latest checked-in version. It is used only by the Designer and Contributor applications in combination with the SS_GET_PAGE service to provide a preview service without checking in new versions of layout pages and contributor data files. Again, if passed as a URL parameter, this value will automatically get set as a cookie value so that it is automatically propagated as the contributor or designer navigates the site in order to remain in preview mode. You should not be using this parameter directly. The Error Handler Section An error can occur at any point during the SS_GET_PAGE service call. For example, if a REPLACEABLE region is required but has not been specified for a particular section, you may encounter an error. Normally, if these types of errors occur, they are shown within a standard content server error page, which takes the consumer out of the context of the web site. In order to show the error, but remain within the context of the web site, one section within the site can be specified as an Error Handler section in Designer. If an error occurs within the SS_GET_PAGE service, then the consumer is redirected to the primary layout page associated with the error handler section. Two Idoc variables are available for the layout page displaying error information: ■ ssErrorMessage : a text description of the error that has occurred. ■ ssErrorCode : a numeric error code to indicate what type of error has occurred so that you can present your own error description. Internally, when setting the error handler section, a site property, errorNodeId, is set to contain the nodeId of the error handler section. In Site Studio, the potential list of error codes includes: ssErrorCode ssErrorMessage -0x100 No Layout page specified for this part of the web site. -0x101 Failed to locate document information for document with content ID -0x102 Document with Content ID {1} does not match the Primary or Secondary Url at section {2} Id={3} and there is no Replaceable Region defined. -0x103 Link to Section {1} Id={2} failed because there is no Primary URL defined for the section. -0x104 Link to Section {1} Id={2} failed because there is no Secondary URL defined for the section. -0x105 The Section {1} Id={2} is not part of a Site Studio web site. -0x106 Layout with Content ID {1} is not filed in a Site Studio web site. -0x107 The Layout with Content ID {1} was not found in any section Url of any web site. -0x108 Unable to identify in which web site section to display document with Content ID {1}. Site Studio Services 11-21 ■ Description : Displays a Site Studio web page. ■ Parameters: To display the primary splash page of a section: – siteId : the identifier of the site optional. This value is computed if not specified. – nodeId : the identifier of the section required. To display a particular document in a section: – ssDocName : the dDocName of the document to display required. – ssTargetNodeId : the identifier of the section that will display the document optional. – ssTargetSiteId : the identifier of the site containing the specified ssTargetNodeId optional. This value is computed if not specified. – ssSourceNodeId : the identifier of the section that will display the document if the documents xWebsiteSection value is not available optional. – ssSourceSiteId : the identifier of the site containing the specified ssSourceNodeId optional. This value is computed if not specified. – SSContributor : indicates whether the page should be delivered in contribution mode optional. Allowed values are true and false. ■ Returns : – The Site Studio web page. ■ Security : The user must have at least read access to the documents that comprise the web site page.

11.7.39 SS_GET_PLACEHOLDER_SWITCH_CONTENT_CONFIG