Idoc Script Extensions 9-9
Code Example Links to sections; by default these links end with index.htm.
--wcmUrlnodelink,nodeId-- --wcmUrlnodelink,nodeId,siteId--
Links to content; by default these links end with a contentId. --wcmUrllink,dDocName--
--wcmUrllink,dDocName,nodeId-- --wcmUrllink,dDocName,nodeId,siteId--
Links to weblayout static resources; for example, images. --wcmUrlresource,dDocName--
--wcmUrlresource,groupspublicdocumentsadacctmydocname.jpg-- See also
Section 9.40, ssWeblayoutUrl. Links to a DAM rendition:
--wcmUrlrendition, dDocName, smallimage--
9.14 ssIncludeXml
Description This script extension is a core Site Studio method that allows any element within a
managed XML file to be extracted and returned in an Idoc string variable, which can be placed directly on a web page as an HTML snippet. The content of the XML node
that is being extracted will be further evaluated in the scope of the current layout page and therefore can include further server-side Idoc Script, if necessary.
Parameters
■
dDocName : The dDocName of XML data file.
■
expression : XPath expression to identify a specific node or nodes of the XML data
file.
Returns The content of the element listed in the Xpath.
Code Example --ssIncludeXmldDocName, expression--
--ssIncludeXmldDocName, wcm:portalwcm:element[name = eleName]node--
9.15 ssGetDocInfo
Description This script extension retrieves a DOC_INFO result set for the named dDocName.
Parameters
■
dDocName : the identifier of the document whose DOC_INFO should be retrieved.
9-10 Oracle Fusion Middleware Technical Reference Guide for Site Studio
Returns A boolean value indicating the success of the operation.
Code Example --ssGetDocInfoMyDocName--
--if ssGetDocInfoMyDocName-- --endif--
9.16 ssGetXmlNodeCount
Description This script extension returns a count of the number of repeating instances of a given
element within a managed XML file. This is used primarily in the implementation of static list fragments to display a set of repeating contribution elements.
Parameters
■
dDocName : The dDocName of XML data file.
■
expression : XPath expression to identify a specific node or nodes of the XML data
file.
Returns The integer value of the number of rows in the list.
Code Example --ssGetXmlNodeCountdDocName, expression--
--ssGetXmlNodeCountdDocName, ’wcm:portalwcm:element[name = eleName]’--
9.17 ssIncDynamicConversion
Description This script extension can be used to perform a dynamic conversion of a native
document where the resulting HTML is returned in an Idoc string variable that can be placed directly on a web page in the form of an HTML snippet. This method allows
the caller to specify the managed conversion template and conversion layout to be used.
Parameters
■
dDocName1 : dDocName of native document to convert.
■
dDocName2 : dDocName of template to use in conversion.
■
dDocName3 : dDocName of layout template to use in conversion.
■
dcPageNum : The page number of the document to convert optional.
Returns An HTML string snippet of the document conversion.
Code Example --ssIncDynamicConversiondDocName1, dDocName2, dDocName3, 3--
Idoc Script Extensions 9-11
9.18 ssIncDynamicConversionByRule
Description This script extension, like the ssIncDynamicConversion extension, can be used to
perform a dynamic conversion of a native document where the resulting HTML is returned in an Idoc string variable that can be placed directly on a web page, in the
form of an HTML snippet.
Unlike ssIncDynamicConversion, this extension uses a specified rule from the Dynamic Converter rules engine in order to decide which conversion template to use.
It therefore does not require the caller to specify a managed conversion template or conversion layout.
Parameters
■
dDocName : The dDocName of native document to convert.
■
rule : The name of Dynamic Converter rule to use.
■
dcPageNum : The page number of the document to convert optional.
Returns An HTML string snippet of the document conversion.
Code Example --ssIncDynamicConversionByRuledDocName, rule, 1--
9.19 ssIncDynamicConversionByRulesEngine
