9-6 Oracle Fusion Middleware Technical Reference Guide for Site Studio
Code Example --wcmDynamicListelementName--
Example within context: --if wcmDynamicListdynamicList--
--executeServiceSS_GET_SEARCH_RESULTS-- --loop SearchResults--
--xmldDocTitle--br --endloop--
--endif--
9.9 wcmIncludeElement
Description This script allows the contents of an element to be displayed outside the context of the
region. When an element is in the context of a region that is, in a region template, then there is an implied data file association based on that region template.
With wcmIncludeElement, you can force a data file association when the element is outside the context of a region.
Parameters
■
dDocName : The dDocName for the data file.
■
expression : The XPath expression to identify a specific node or nodes of the XML
data file.
Returns The contents of the element are returned.
Code Example queryVal = --wcmIncludeElementdatafiledDocName,
wcm:rootwcm:element[name=elementName]node--
9.10 wcmDynamicConversion
Description Used to create a dynamic conversion of a native document.
Parameters
■
ruleName : The name of the rule as defined in the ConversionsDefinition file.
Required.
■
dataFileDocName : The dDocName of the native document to convert.
■
pageNum : The page number within the native document to convert.
■
conversionsDefinitionDocName : The dDocName of the conversion definition.
■
conversionType : Possible type values are simple, full, rule, engine, or command.
■
conversionTemplate : The dDocName of the template. Valid only when using
conversionType=full.
Idoc Script Extensions 9-7
■
conversionLayout : The dDocName of the layout. Valid only when using
conversionType=full.
■
conversionRuleName : The name of the rule. Valid only when using
conversionType=rule.
■
conversionCommand : A piece of Idoc Script executed in the context of the page.
Valid only when using conversionType=command.
Returns The HTML generated by the dynamic conversion based on the parameters.
Code Example Using the default:
--wcmDynamicConversionruleName-- Including a type value:
--wcmDynamicConversionruleName,dataFileDocName=dDocName,pageNum=number, conversionsDefinitionDocName=dDocName, conversionType=engine--
9.11 wcmGetListAsResultSet
Description This tag is used to retrieve the static list content, and the content available as a
ResultSet.
Parameters
■
dDocName : The dDocName name of the Contributor Data File. If this is omitted
the current data file is used.
■
listName : The name of the list element. Required.
■
resultSetName : The name of the ResultSet to create. If this is omitted, the
ResultSet name will be the same as the listName.
■
evaluateList : A boolean value indicating if Idoc expressions in the list elements
should be evaluated. The default is true.
Returns This returns a Boolean value indicating success or failure.
Code Example --wcmGetListAsResultSetdDocName,List_Element,name_of_
ResultSet,false-- --wcmGetListAsResultSetList_Element, name_of_ResultSet--
9.12 wcmFragment
Description This tag is used on templates to add a fragment. If the tag is used on a region template
or subtemplate, only the first drop-point snippet will be used.
9-8 Oracle Fusion Middleware Technical Reference Guide for Site Studio
Parameters
■
fragmentInstanceId : The ID of the fragment instance on the page. Used to
differentiate fragments that have multiple pages of returns, such as dynamic lists. The ID allows the dynamic lists to display different pages of query results. For
instance, one fragment can be on page 1 of its query results, while the other can display page 3 of its own results. If the same ID is used for both fragments, then
clicking to a particular page of results for one query will cause the other fragment to display the same page number of its own results.
■
fragmentDocName : The dDocName of the fragment library.
■
fragmentId : The ID of fragment within the named library.
■
snippetId : The ID of snippet within the named fragment.
■
tagProperties : The named value pairs of properties of the fragment.
Code Example --wcmFragmentfragmentInstanceID, fragmentDocName, fragmentID,
snippetID, ssTheme=default, ssHoverColor=, ssTextColor=, ssFocusColor=, ssShowHome=true, ssShowNext=false, ssClassName=IDocNavTabsTop--
9.13 wcmUrl
