Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter
11g Release 1 (11.1.1.4.0)
E10148-12
  Go To Documentation Library
Library		 Go To Product List
Product		 Go To Table Of Contents
Contents		 Go To Index
Index
Previous
Previous 		 Next
Next		  

28 Creating Content Presenter Display Templates

The Content Presenter task flow allows authorized users to retrieve content from an Oracle Content Server and display it in a WebCenter application in real time, without assistance from an IT Department or software developers. For example, you might want to display a list of the most recent Press Releases so users can browse them and click one to read it. You can place images (a photograph or a chart, for example) or add textual content to the portal.


Note:

Content presenter can only be used with Oracle Content Server based content. No other repository connection types are supported.

Content Presenter renders content using a selected display template. The primary focus of this chapter is creating Content Presenter display templates. You can create a Content Presenter template to satisfy your particular content rendering requirements or to handle your own custom content properties.

This chapter includes these topics:

28.1 Adding Content Presenter to an Application

You can add a Content Presenter task flow at design time or runtime. For details on adding Content Presenter at design time (using JDev), see Chapter 30, "Adding Content Task Flows and Document Components to a Portal Page." For details on adding and using Content Presenter at runtime, see "Displaying Content Using the Content Presenter Task Flow" in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

28.2 What Is a Content Presenter Display Template?

A Content Presenter display template is a JSFF file (JSF page fragment) that defines how Content Presenter renders content items on a WebCenter portal page. WebCenter provides several out-of-the-box display templates to get you started, and you can create your own templates.


Tip:

You can find sample display templates in $ORACLE_HOME/jdeveloper/webcenter/samples/contentpresenter. These sample files were installed as part of the WebCenter extension bundle.

Display templates can use the full set of Rich ADF components, so you can quickly and easily create robust and attractive templates to display your content. Note, however, that you are not required to use these components in your template.

A Content Presenter display template can handle either single content items, multiple content items, or combinations of the two. For example, a multiple content item template might render tabs for each item and then call a single item template to render the details of a selected item.

Each content item is associated with a specific content type defined in the Oracle Content Server repository. A content type defines the properties of the content item. Content types can map to Content Server profile definitions and Site Studio Region Definitions. Types are created on the Content Server. As a Content Presenter display template developer, you need to know the names of the properties defined for the associated content type so that you can define how to display the selected content item(s) on the page.


Tip:

One way to determine the properties for the existing content types defined in Oracle Content Server is to use the Content Presenter Configuration dialog in WebCenter Spaces. For a detailed description of this technique, see Section 28.4.5, "Discovering Content Type Property Names."

At runtime, an authorized end user can choose a display template in the Content Presenter Configuration dialog.

28.3 Using the Out-of-the-Box Display Templates

WebCenter provides several out-of-the-box Content Presenter display templates. These pre-built templates provide options for displaying single content items and multiple content items.

For example, the Default Document Details View template displays detailed information about any single content item including creation date, modification date, created by username, modified by username, path and any comments. Figure 28-0 shows a content item displayed at runtime with this template.

Figure 28-1 Default Document Details View Display Template

Description of Figure 28-1 follows
Description of "Figure 28-1 Default Document Details View Display Template"

Several options are provided for displaying multiple content items, such as the Accordion View, which Displays multiple content items in an accordion format. In this format, each item can be expanded to display its details, as shown in Figure 28-2.

Figure 28-2 Accordion View Display Template

Description of Figure 28-2 follows
Description of "Figure 28-2 Accordion View Display Template"

For a complete list of out-of-the-box display templates, see Section 30.7.1, "Content Presenter Task Flow Parameters and Out-of-the-Box Display Templates."


Tip:

If you intend to create a Content Presenter display template, a good practice is to copy one of the out-of-the-box templates and modify it.

28.4 Creating Content Presenter Display Templates

If the out-of-the-box display templates (see Section 28.3, "Using the Out-of-the-Box Display Templates") do not meet your needs, you can define custom Content Presenter templates.

This section discusses these topics:

28.4.1 Overview

Depending on your needs, the approach you take to defining Content Presenter display templates will vary. Typically, you define display templates for specific single items of content, then define a multiple content item display template that includes calls to the single item display templates.

Template definitions can include calls to other display templates in any of the following ways:

  • A single content item display template can call another single content item display template.

  • A multiple content item display template can call a single content item display template (as shown in the examples below).

  • A multiple content item display template can call another multiple content item display template.

The basic tasks for creating Content Presenter display templates include:

28.4.2 Defining Single-Item Display Templates

Examples of single content items for which you may want to create Content Presenter display templates are:

  • Individual items to display with a specific look and feel on a page.

  • Different views of a specific type of item (such as short and detailed views of an article).

  • Different versions of a similar item (such as Press Releases that may be formatted differently for different groups, using a different set of properties).

The definition of a single content item display template uses the JSP tags listed in Table 28-1.

Table 28-1 Content Display Template Tags for Single Content Items

JSP Tag Description Example

contentTemplateDef

Required. Defines a single content item template.

Attributes:

var - Specifies the content node that will be rendered by this display template. In the template definition code, you can use the EL expressions described in Section 28.4.4.1, "Retrieving Basic Information About a Content Item" to retrieve required information about the node.

 
<dt:contentTemplateDef var="node">
  <af:outputText value="#{node.name}" />
</dt:contentTemplateDef>

renderProperty

Optional. Retrieves and renders the string value(s) of the specified node property inline.

Attributes:

id - Identifies this component. This value must be unique within the closest parent component that is a naming container.

name - Specifies the name of the property to get. If this is a system property (cm_createdBy, cm_createdDate, cm_modifiedDate, and cm_path) then the value on the node will be used. If not specified, then the primaryProperty will be used if defined.

node - Specifies the node to use. This value can either be a bound attribute to a managed bean, or a request attribute variable.

blockSize - Specifies the size of the blocks in bytes, to read the bytes of a binary property. Default is 2048 bytes.

startIndex - Specifies the index (from 0) in the document's bytes at which to start printing. Defaults to 0.

endIndex - Specifies the index (from 0) in the document's bytes at which to stop printing. Defaults to value of blockSize.

rendered - Specifies whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value is true.

 
<!--
  Handling of text-based primary
  properties (HTML, text, etc.).
-->
<dt:contentTemplateDef var="node">
    <cmf:renderProperty id="rp1" 
     name="#{node.primaryProperty.name}" 
     node="#{node}"/>
</dt:contentTemplateDef>

contentTemplate

Optional. Nested under contentTemplateDef.

Calls another single item template.

Attributes:

node - Required. Specifies the content repository node that should be displayed.

nodesHint - Optional. When the display template is called in an iterating component, allows the pre-inclusion of all possible templates. This attribute is not needed when contentTemplate is used inside a contentTemplateDef tag.

view - Optional. Specifies the target view name.

id - Optional. Specifies the JSF component ID.

rendered - Optional. Specifies whether the component should be rendered.

 
<dt:contentTemplateDef var="node">
  <af:outputText value="#{node.name}" >
  <dt:contentTemplate node="#{node}" 
     view="templates.pressrelease.item" 
     />
  </af:outputText>
</dt:contentTemplateDef>

To define a display template for a single content item:

  1. In JDeveloper, create a JSFF file:

    1. From the File menu, choose New.

    2. In the New Gallery dialog, expand Web Tier, select JSF, then JSF Page Fragment.

    3. Click OK.

    4. In the Create New JSF Page Fragment dialog, enter a name for the display template file.

    5. Set the Directory field to point to the oracle/webcenter/portalapp/pages folder of your portal web project. This directory must be set from the correct root path. In JDeveloper, the root path is PROJECT_NAME > Web Content. On the filesystem, the root path is PROJECT_ROOT/public_html. For example: PROJECT_ROOT/public_html/oracle/webcenter/portalapp/pages. A good practice is to first create a subfolder in pages and store the JSFF in the subfolder.

  2. Select View, then Component Palette to open the Component Palette.

  3. From the dropdown list at the top of the Component Palette (Figure 28-3):

    • Select WebCenter Content Display Templates for a list of display template tags.

    • Select WebCenter Content Management Faces for the renderProperty tag.

    Figure 28-3 Content Display Template Tags in Component Palette

    list of display template tags
    Description of "Figure 28-3 Content Display Template Tags in Component Palette"

  4. In Source view, drag and drop the required display template tags from the Component Palette onto the page to define your template. Refer to Table 28-1 for information about each tag and required parameter values.

Example 28-1 and Example 28-2 show sample single content item display template definitions. These examples illustrate a use case where a certain kind of document (a press release) is produced by two different departments inside a company, and each department has defined its own content type and properties. These sample Content Presenter display templates allow these two different content types to be displayed in a consistent manner.

The template shown in Example 28-1 handles a Press Release that uses a property named xHeading to describe the heading of the Press Release document, and xDestinationUrl to describe the location of the document. To learn how you can obtain these property names for a given content type, see Section 28.4.5, "Discovering Content Type Property Names."

Example 28-1 Sample Content Presenter Display Template for a Press Release Document

<?xml version = '1.0'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" 
          version="2.1" 
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich" 
          xmlns:dt="http://xmlns.oracle.com/webcenter/content/templates">
   <dt:contentTemplateDef var="node">
      <af:goImageLink text="#{node.propertyMap['xHeading'].value}" 
                      id="gil1" 
                      icon="#{node.icon.smallIcon}" 
                      destination="#{node.propertyMap['xDestinationUrl'].value}"
                      targetFrame="_blank">
      </af:goImageLink>
   </dt:contentTemplateDef>
</jsp:root>

The template shown in Example 28-2 handles a Press Release that uses a property named dDocTitle to describe the heading of the Press Release document, and xLinkUrl to describe the location of the document.

Example 28-2 Sample Content Presenter Template for Another Press Release Document

<?xml version = '1.0'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" 
          version="2.1" 
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich" 
          xmlns:dt="http://xmlns.oracle.com/webcenter/content/templates">
   <dt:contentTemplateDef var="node">
      <af:goImageLink text="#{node.propertyMap['dDocTitle'].value}" 
                      id="gil1" 
                      icon="#{node.icon.smallIcon}" 
                      destination="#{node.propertyMap['xLinkUrl'].value}"
                      targetFrame="_blank">
      </af:goImageLink>
   </dt:contentTemplateDef>
</jsp:root>

28.4.3 Defining Multiple-Item Display Templates

Examples of multiple content items for which you may want to create Content Presenter display templates are:

  • A group of similar items that you want to display on a page, such as a list of books or an employee directory of pictures.

  • Query results, such as all documents modified in the last week.

  • A list of all documents in a UCM folder.

The definition of a multiple content item display template uses the JSP tags listed in Table 28-2.

Table 28-2 Content Display Template Tags for Multiple Content Items

JSP Tag Description Example

contentListTemplateDef

Required. Defines the multiple content item template.

Attributes:

var - Specifies the content node that will be rendered by this display template. In the template definition code, you can use the EL expressions described in Section 28.4.4.1, "Retrieving Basic Information About a Content Item" to retrieve required information about the node.

 
<dt:contentListTemplateDef var="nodes">
  <af:iterator value="#{nodes}" var="node">
    <af:outputText value="#{node.name}" />
  </af:iterator>
</dt:contentListTemplateDef>

contentListTemplate

Optional. Nested under contentListTemplateDef.

Calls another multiple item template.

Attributes:

nodes - Required. Provides the list of VCR nodes that should be displayed

category - Required. Specifies the target template category.

view - Required. Specifies the target view name.

id - Optional. Specifies the JSF component ID.

rendered - Optional. Specifies whether the component should be rendered.

 
<dt:contentListTemplateDef var="nodes">
<!--
  Reuse the default bulleted list view, but
  indent it with a <blockquote>
-->
  <f:verbatim>
    <blockquote>
  </f:verbatim>
  <dt:contentListTemplate nodes="#{nodes}" 
     category="oracle.webcenter.content.
         templates.default.category" 
     view="oracle.webcenter.content.
         templates.default.list.bulleted"/>
  <f:verbatim>
    </blockquote>
  </f:verbatim>
</dt:contentListTemplateDef>

contentTemplate

Optional. Nested under contentListTemplateDef.

Calls a single item template.

Attributes:

node - Required. Specifies the content repository node that should be displayed.

nodesHint - Optional. When the display template is called in an iterating component, allows the pre-inclusion of all possible templates. This attribute is usually required when contentTemplate is used inside a contentListTemplateDef tag.

view - Optional. Specifies the target view name.

id - Optional. Specifies the JSF component ID.

rendered - Optional. Specifies whether the component should be rendered.

 
<dt:contentListTemplateDef var="nodes">
  <af:iterator rows="0" var="node" 
     varStatus="iterator" value="#{nodes}">
  <dt:contentTemplate node="#{node}" 
     view="templates.pressrelease.listitem" 
     nodesHint="#{nodes}"/>
  </af:iterator>
</dt:contentListTemplateDef>

To define a display template for multiple content items:

  1. In JDeveloper, create a JSFF file and open the Component Palette, as described in Step 1 through Step 3 in Section 28.4.2, "Defining Single-Item Display Templates".

  2. In Source view, drag and drop the required display template tags from the Component Palette onto the page. Refer to Table 28-2 for information about each tag and required parameter values.

Example 28-3 shows a sample multiple content item display template definition.

Example 28-3 Sample display template definition for the display of multiple Press Releases (press-release-list-view.jsff)

This template definition iterates over the data items selected for display, and processes them according to the referenced view (view="mycorp.content.templates.pressrelease.listitem").

<?xml version = '1.0'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.1" 
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich" 
          xmlns:dt="http://xmlns.oracle.com/webcenter/content/templates">
   <dt:contentListTemplateDef var="nodes">
      <af:panelGroupLayout layout="scroll" id="nodeListPanel" valign="middle">
        <af:iterator rows="0" var="node" varStatus="iterator" value="#{nodes}">
           <dt:contentTemplate node="#{node}" 
               view="mycorp.content.templates.pressrelease.listitem" 
               nodesHint="#{nodes}"/>
        </af:iterator>
      </af:panelGroupLayout>
   </dt:contentListTemplateDef>
</jsp:root>

28.4.4 Using EL Expressions to Retrieve Content Item Information

This section describes the EL expressions that you can use in your Content Presenter display template definitions to retrieve and display specific information about content items.

Use the EL expressions described in the following tables as you define your Content Presenter display templates as explained in Section 28.4.2, "Defining Single-Item Display Templates" and Section 28.4.3, "Defining Multiple-Item Display Templates." These expressions are used with the JSP tags described in Table 28-1 and Table 28-2.

28.4.4.1 Retrieving Basic Information About a Content Item

The EL expressions listed in Table 28-3 allow you to display basic information about a content item in a display template.

Table 28-3 EL Expressions for Retrieving Basic Content Information

EL Expression Description

#{node.createdBy}

Returns the user name of the node's creator.

#{node.createdDate}

Returns the node's creation date.

#{node.hasParentNode}

Returns true if the current node has a valid parent node ID, or a node that has no parent.

#{node.icon}

Returns the icon service defined in the current web application.

#{node.id}

Returns the node's identifier.

#{node.isFolder}

Returns true if this node is associated with a folder or container.

#{node.isInherited}

Returns true if this node is inherited by another object class definition.

#{node.modifiedBy}

Returns the user name of the node's last modifier.

#{node.modifiedDate}

Returns the node's last modification date.

#{node.name}

Returns the node's name.

#{node.parentId}

Returns the parent node's identifier.

#{node.path}

Returns the node's path.

#{node.primaryProperty}

Returns the node's primary property, if available.

#{node.propertyMap}

Creates and returns a map of wrapped property objects, keyed by property name. Properties can be accessed as #{node.propertyMap['myProp']} or #{node.propertyMap.myProp}.

#{node.url}

Returns an instance of the node property URL service for the primary property of this node (if any). By default, resolves to #{node.url.renderUrl}. This is a shortcut for #{node.primaryProperty.url}.

28.4.4.2 Working with Content Item Properties and Values

Use the EL expression described in Table 28-4 and Table 28-5 to perform actions on content item node properties and property values.


Tip:

To determine the names of the properties defined for a given content type, see Section 28.4.5, "Discovering Content Type Property Names."

Table 28-4 EL Expressions for Content Item Node Properties

EL Expression Description

#{node.propertyMap['myProp']'myProp'].asTextHtml}

Returns this property as text or HTML if the type is text or HTML. If isHTML or isPlainText is true, the text or HTML is returned as a string.

#{node.propertyMap['myProp'].hasValue}

Returns true if a value is associated with this property.

#{node.propertyMap['myProp'].icon}

Returns the icon service defined in the current web application.

#{node.propertyMap['myProp'].indexedName}

Returns the indexed name of a multi-valued property. For example, if a multi-valued node property named color contains blue, red, orange, the indexed name of the red value is color[1]. The following EL expression references the color orange in this list: #{node.propertyMap['color[2]'].value.stringValue}

#{node.propertyMap['myProp'].isAudio}

Returns true if the property's mime type is 'audio/'.

#{node.propertyMap['myProp'].isBinary}

Returns true if the current property is of type Property.BINARY.

#{node.propertyMap['myProp'].isBoolean}

Returns true if the current property is of type Property.BOOLEAN.

#{node.propertyMap['myProp'].isCalendar}

Returns true if the current property is of type Property.CALENDAR.

#{node.propertyMap['myProp'].isDouble}

Returns true if the current property is of type Property.DOUBLE.

#{node.propertyMap['myProp'].isExcel}

Returns true if the property's mime type is 'application/vnd.ms-excel', 'application/excel', 'application/x-excel', or 'application/x-msexcel'.

#{node.propertyMap['myProp'].isGIF}

Returns true if the property's mime type is 'image/gif'.

#{node.propertyMap['myProp'].isHTML}

Returns true if the property's mime type is 'text/html'.

#{node.propertyMap['myProp'].isImage}

Returns true if the property's mime type is 'image/'.

#{node.propertyMap['myProp'].isJPEG}

Returns true if the property's mime type is 'image/jpeg'.

#{node.propertyMap['myProp'].isLink}

Returns true if the current property is of type Property.LINK.

#{node.propertyMap['myProp'].isLong}

Returns true if the current property is of type Property.LONG.

#{node.propertyMap['myProp'].isMSWord}

Returns true if the property's mime type is 'application/vnd.ms-word' or 'application/msword'.

#{node.propertyMap['myProp'].isMultiValued}

Returns true if this property is multi-valued.

#{node.propertyMap['myProp'].isNested}

Returns true if the current property is of type Property.NESTED.

#{node.propertyMap['myProp'].isPDF}

Returns true if the property's mime type is 'application/pdf'.

#{node.propertyMap['myProp'].isPlainText}

Returns true if the property's mime type is 'text/plain'.

#{node.propertyMap['myProp'].isPNG}

Returns true if the property's mime type is 'image/png'.

#{node.propertyMap['myProp'].isPowerPoint}

Returns true if the property's mime type is 'application/vnd.ms-powerpoint', 'application/mspowerpoint', or 'application/x-mspowerpoint'.

#{node.propertyMap['myProp'].isPrimaryProperty}

Returns true if this property is the primary property.

#{node.propertyMap['myProp'].isRequired}

Returns true if this property is required/mandatory.

#{node.propertyMap['myProp'].isRetricted}

Returns true if this property is restricted.

#{node.propertyMap['myProp'].isRichText}

Returns true if the property's mime type is 'text/richtext'.

#{node.propertyMap['myProp'].isString}

Returns true if the current property is of type Property.STRING.

#{node.propertyMap['myProp'].isTextBased}

Returns true if this property is text-based (isHTML, isPlainText, isString, isCalendar, isBoolean, isDouble, isLong).

#{node.propertyMap['myProp'].isVideo}

Returns true if the property's mime type is 'video/'.

#{node.propertyMap['myProp'].isXML}

Returns true if the property's mime type is 'text/xml'.

#{node.propertyMap['myProp'].isZip}

Returns true if the property's mime type is 'application/zip'.

#{node.propertyMap['myRefNode'].linkAsNode}

Returns the myRefNode property as a node. where myRefNode is a link property type. Properties can be referenced in EL expressions.

Example: #{node.propertyMap['myRefNode'].linkAsNode.primaryProperty.url.renderUrl}

#{node.propertyMap['myProp'].name}

Returns the property's name.

#{node.propertyMap['myProp'].nestedProperty}

Retrieves nested properties for this single-valued property, and returns a list of properties.

#{node.propertyMap['myProp'].type}

Returns the data type of this property value. For example: String, Integer, Long, and so on.

#{node.propertyMap['myProp'].url}

Returns a URL service for this property.

#{node.propertyMap['myProp'].value}

Returns the value service for this property.

Table 28-5 EL Expressions for Content Item Node Property Values

EL Expression Description

#{node.propertyMap['myProp'].value.binaryValue}

Returns custom attributes for a binary property type or attachment. Attributes available on binaryValue are:

  • contentType – Returns the mime type of the binary content (for example, text or html).

  • name – Returns the filename of the binary content (for example, index.html).

  • size – Returns the size of the binary content, or -1 if the size is unavailable.

#{node.propertyMap['myProp'].value.booleanValue}

Returns the value of this property as java.lang.Boolean.

#{node.propertyMap['myProp'].value.calendarValue}

Returns the value of this property as java.util.Calendar.

#{node.propertyMap['myProp'].value.doubleValue}

Returns the value of this property as java.lang.Double.

#{node.propertyMap['myProp'].value.longValue}

Returns the value of this property as java.lang.Long.

#{node.propertyMap['myProp'].value.orderedPosition}

Returns the "index" of the property when the property is multi-valued.

Example: #{node.propertyMap['address[0]'].value.orderedPosition},

#{node.propertyMap['myProp'].value.stringValue}

Returns the value of this property as java.lang.String.

Example: #{node.propertyMap['firstName'].value.stringValue}

28.4.4.3 Working with Content Item Icons and URLs

Table 28-6 and Table 28-7 describe EL expressions for working with icons and URLs associated with content items and properties.

Table 28-6 EL Expressions for Content Item Node or Property Icons

EL Expression Description

#{node.icon.largeIcon}

#{node.propertyMap['myDoc'].icon.largeIcon}

Returns a URL to an image resource for a large icon.

Example: <af:image source="#{node.propertyMap['projectFolder'].largeIcon}"/>

#{node.icon.smallIcon}

#{node.propertyMap['myDoc'].icon.smallIcon}

Returns a URL to an image resource for a small icon.

Example: <af:image source="#{node.icon.smallIcon}" />

Table 28-7 EL Expressions for Content Item Node URLs

EL Expression Description

#{node.url.downloadUrl}

Creates a URL to the binary content. Forces a download, and the underlying operating system renders the content based on the content type.

Example: <af:goLink destination="#{node.url.downloadUrl}" targetFrame="_blank"/>

#{node.url.renderUrl}

Creates a URL to the binary content. Allows the browser to render the content based on the content type.

By default, #{node.url} resolves to #{node.url.renderUrl}.

Example: <af:goLink destination="#{node.url.renderUrl}" targetFrame="_blank"/>

28.4.5 Discovering Content Type Property Names

This section describes a useful technique for learning the property names of a content item's content type.


Note:

You can also use REST services to obtain content type property names. For more information see the Oracle Fusion Middleware Content Management REST Service Developer's Guide.

Each content item is associated with a specific content type defined in the Oracle Content Server repository. Content types can map to Content Server profile definitions and Site Studio Region Definitions. Types are created on the Content Server. A content type defines the properties of the content item (see Table 28-8), and is identified when you register the template.

As a Content Presenter display template developer, you will need to know the names of the properties defined for the associated content type so that you can define how to display the selected content item(s) on the page.

One way to determine the properties for the existing content types defined in Oracle Content Server is to use the Content Presenter Configuration dialog in WebCenter Spaces:

  1. Open the Content Presenter Configuration dialog. For instructions, refer to the section "Displaying Content Using the Content Presenter Task Flow" in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

  2. On the Content tab of the Content Presenter Configuration dialog, select Results of a Query to a view a list of content types.

  3. Select the Content Type for the content item that you wish to display.

  4. From the Add Fields list, select Filters to add the Additional Query Filters section to the Content page, then click Add to list all the properties that are defined for the selected content type (Figure 28-4).


    Note:

    The list of property names shown in the dropdown list (Figure 28-4) are display names only. For example, the display name Author corresponds to the actual content type property name dDocAuthor.

    To discover the actual property names that correspond to the display names, you must access them through the UCM administration console, or contact your UCM administrator.

    When referencing the actual content type properties, you must include the leading letter d or x to reference the internal Oracle Content Server property name. The prefix d identifies a system property, and the prefix x identifies a user property. For example: dDocAuthor or xCollectionID.

    Figure 28-4 Identifying Content Type Properties

    Identifying Content Type Properties
    Description of "Figure 28-4 Identifying Content Type Properties"

28.4.6 Referencing External Files in Display Templates

In some cases, a display template needs to reference an external file, like a CSS file. All such references must be either an absolute path or a path that is relative to the root of the web application. For example:

  • absolute path – http://host:port/mypath/file.css

  • relative path – /webcenter/mypath/file.css

Do not use local references to external files. Local references to external files do not work because they are not included when you upload a Content Presenter display template to a WebCenter Spaces application, as explained in Section 28.5, "Using Content Presenter Display Templates in a WebCenter Portal Application."

28.4.7 Using the Content Presenter Display Template

For information on using a display template in a Content Task flow, see Section 30.5, "Adding a Content Task Flow to a Page." See also Section 30.7.1, "Content Presenter Task Flow Parameters and Out-of-the-Box Display Templates." For information on integrating a display template into a portal application, see the following section Section 28.5, "Using Content Presenter Display Templates in a WebCenter Portal Application."


Note:

If you display a wiki page in a WebCenter Portal application using a Content Presenter display template, by default any links within that wiki page are displayed in the Document Viewer. If you want to display wiki page links using Content Presenter, you must edit the adf-config.xml file. For more information, see Section 31.3.5, "Displaying Wiki Page Links Within Content Presenter."

28.5 Using Content Presenter Display Templates in a WebCenter Portal Application

This section explains how to make a Content Presenter display template available to Content Presenter in a WebCenter Portal application.


Note:

If you are using a locally configured JDev environment to develop a WebCenter Portal application, all you need to do to use a Content Presenter display template in your application is to export it as a portal resource, as explained in Section 28.5.1, "Export a Content Presenter Display Template as a Portal Resource." You do not need to perform the upload task as explained in Section 28.5.2, "Upload the New Content Presenter Display Template to a WebCenter Portal or Spaces Application."

28.5.1 Export a Content Presenter Display Template as a Portal Resource

This section explains how to export a Content Presenter display template as a portal resource. This procedure is a prerequisite to adding a Content Presenter display template to a deployed WebCenter Spaces application and to Content Presenter at runtime.

  1. Create a Content Presenter display template, as explained previously in Section 28.4, "Creating Content Presenter Display Templates."

  2. In the Application Navigator, right-click the Content Presenter display template file (a JSFF file) and select Create Portal Resource.

  3. Fill in the Create Portal Resource dialog. This dialog differs depending on whether you are creating a single or multiple-item template. The dialog for a single-item template is shown in Figure 28-5. The dialog for a multiple-item template is shown in Figure 28-6.

    Figure 28-5 Create Portal Resource Dialog for a Single-Item Template

    Description of Figure 28-5 follows
    Description of "Figure 28-5 Create Portal Resource Dialog for a Single-Item Template"

    Figure 28-6 Create Portal Resource Dialog for a Multiple-Item Template

    Description of Figure 28-6 follows
    Description of "Figure 28-6 Create Portal Resource Dialog for a Multiple-Item Template"

    The default settings in the Create Portal Resource dialog are generally sufficient; however, you must enter a unique value in the View ID field (see the following Note). The Display Name is the name that appears in the display template drop down menu at runtime.


    Note:

    You can use the View ID to programmatically refer to one template or another. For example, a multiple content item template could render tabs for each item and also call on a single item template to be used below the selected tab to render the details of that item. Because the View ID needs to be human readable for this particular use case, the View ID is not automatically generated.

    Additional Attributes in the Create Portal Resource dialog for a single item template include:

    • Template Type – Reflects whether the template is single or multi-item template.

    • Content Repository Name – By default, the portal resource uses the repository associated with the application's default content connection. If you intend to export the portal resource for use in a WebCenter Spaces application, you must pick the repository that matches the one used by the Spaces connection name(s).

    • Content Type – Lets you pick a content type for which the template will be valid. The list of content types displayed in the menu depends on the selected content repository.

    • Content Type Default View – If set to true, specifies that the display template is the default template to use for the given combination of repository and content type.

    • View ID – A unique value that is used to refer to the template programmatically.

    Additional Attributes in the Create Portal Resource dialog for a multiple item template include:

    • Template Type – Reflects whether the template is single or multi-item template.

    • Category Name – A name given to a category of display templates. Can be any name that describes the category or you can use the Default Templates category name.

    • Category ID – An ID for the category. If you select Default Templates as the category name, this field will become read-only and populate with oracle.webcenter.content.templates.default.category. If you are creating a new category, this value can be any unique string. For example: oracle.webcenter.content.templates.pressrelease.category. If two resources have the same ID, they will be grouped together in the user interface.

    • View ID – A unique value that is used to refer to the template programmatically.


      Note:

      For more information on other fields in the Create Portal Resource dialog, see Section 16.4.4, "How to Export a Portal Resource from JDeveloper."

  4. Click OK in the dialog when you are finished.

  5. Right-click the Content Presenter display template (JSFF) file again, and this time select Export Portal Resource.

  6. In the Export Portal Resource dialog, enter or browse to a directory in which to place the exported portal resource file. You can place this file anywhere on your file system.

  7. Click OK in the Export Portal Resource dialog.

Now that your Content Presenter display template is exported as a portal resource, the next step is to upload it to your WebCenter Spaces application. After uploading the display template portal resource, it will be available in the list of display templates when you add a Content Presenter to your portal page.

28.5.2 Upload the New Content Presenter Display Template to a WebCenter Portal or Spaces Application

You can upload a new display template to any deployed WebCenter Portal application that includes the Resource Manager, including WebCenter Spaces. To upload a Content Presenter display template to a WebCenter Portal or Spaces application, do the following:


Note:

The repository connection names and details must be the same between the design time portal application in which you developed the Content Presenter display template and the WebCenter Spaces application.


Note:

Any references to external files in the display template must either be absolute or relative path references. See Section 28.4.6, "Referencing External Files in Display Templates."

  1. Start your WebCenter Portal or Spaces application.

  2. Navigate to the page to which you want to add the Content Presenter display template.

  3. Click Administration.

  4. Select the Resources tab.

  5. Under the Look and Layout heading (along the right side of the web page), click Content Presenter.

  6. Select Upload, as shown in Figure 28-7.

    Figure 28-7 Uploading the Display Template Portal Resource

    Description of Figure 28-7 follows
    Description of "Figure 28-7 Uploading the Display Template Portal Resource"

  7. In the Upload dialog, navigate to the portal resource file you saved on your file system.

  8. After you've selected the template file, click OK. If the operation is successful, an Information dialog appears with the message "Resource uploaded successfully."

  9. Locate your Content Presenter display template in the list view of the Resources tab and select it from the list, as shown in Figure 28-8.

    Figure 28-8 Toggling the Show/Hide State of a Template

    Description of Figure 28-8 follows
    Description of "Figure 28-8 Toggling the Show/Hide State of a Template"

  10. If the template state is currently hidden, select Show from the Edit menu. If a template is hidden, it won't be available for use in Content Presenter.

The new Content Presenter display template is now ready to be used with Content Presenter in a WebCenter Spaces application.

28.5.3 Test the New Content Presenter Display Template

This section explains how to test your Content Presenter display template with Content Presenter.

  1. If it is not currently running, start the WebCenter Spaces application to which you added a Content Presenter display template. This application must have a Content Server connection that Content Presenter can use. If you just completed the setup procedures described in the previous sections, click the Back to the Space link in the upper right corner of the Administration page.

  2. Navigate to the Space in which you want to use the new Content Presenter display template. To do this, select the Spaces tab, and then select a Space that you own or can edit.

  3. Optionally, create a new page to test the display template. Select Create a New Page from the Page Actions menu. The, select Save and Close.

  4. In the new or existing page, select Edit Page from the Page Actions menu.

  5. Select an Add Content button in the part of the page where you want to add a Content Presenter.

  6. In the Add Content dialog, open the Content Management folder, as shown in Figure 28-9.

    Figure 28-9 Opening the Document Management Folder

    Description of Figure 28-9 follows
    Description of "Figure 28-9 Opening the Document Management Folder"

  7. In the Add Content dialog, click the Add button next to Content Presenter.

  8. Close the Add Content dialog.

  9. Select the task flow Edit icon in the Content Presenter tool bar (see Figure 28-10).

    Figure 28-10 Selecting the Edit Icon

    Description of Figure 28-10 follows
    Description of "Figure 28-10 Selecting the Edit Icon"

  10. In the Content Presenter Configuration window, select the Template tab.

  11. From the Template menu, select your Content Presenter display template, as shown in Figure 28-11.

    Figure 28-11 Selecting the Content Presenter Display Template

    Description of Figure 28-11 follows
    Description of "Figure 28-11 Selecting the Content Presenter Display Template"

The Content Presenter template will be applied to the Content Presenter instance. For more information on using Content Presenter and display templates, see Section 30.2, "Understanding the Documents Service Task Flows" and Section 28.3, "Using the Out-of-the-Box Display Templates".

28.6 What Happens at Runtime?

This section includes these topics:

28.6.1 Runtime Overview

After you have defined a Content Presenter display template, you can add a Content Presenter task flow to a page in your application, specifying the content and display template in the Content Presenter task flow parameters (see Section 30.6, "Modifying Content Task Flow Parameters" and Section 28.3, "Using the Out-of-the-Box Display Templates").

If you integrate the Documents Service in your application (see Chapter 29, "Integrating the Documents Service"), end users of your application can select content and your Content Presenter display templates in the Content Presenter Configuration dialog to include content on editable pages of the application, as described in "Displaying Content Using the Content Presenter Task Flow" in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces. To understand how Content Presenter identifies which display templates to expose in the Content Presenter Configuration dialog, see Section 28.6.2, "Identifying Display Templates for Selected Content Items."

28.6.2 Identifying Display Templates for Selected Content Items

At runtime, after a user selects content in the Content Presenter Configuration dialog, Content Presenter checks the Resource Manager to identify the display templates that are suitable for the selected content item(s), then exposes the list of valid templates on the Template page in the Content Presenter Configuration dialog for the user to select. See also Chapter 16, "Adding and Using the Resource Manager."

For single content item templates, Content Presenter generates a list of valid templates using the following precedence order:

  1. Check the Resource Manager for template definitions matching the content item's content repository and content type.

  2. Add template definitions matching the default content repository (*) and specified content type.

  3. Add template definitions matching inherited content types.

  4. Add template definitions matching the default content repository (*) and default content type (*).

For multiple content item templates, Content Presenter generates a list of valid templates using the following precedence order:

  1. Check the Resource Manager for template definitions associated with the selected template category.

  2. Add template definitions associated with the default category (*).

For example, if the user selects multiple content items (such as the children of a folder, or the results of a search), the Content Presenter Configuration dialog shows a list of categories and the list of templates associated with that category and the default category, based on the repository of the content items.


Note:

When a user selects a template in the Content Presenter Configuration dialog, that template is used to display the selected content item(s) in the running application. If that template is later deleted from the Resource Manager for any reason, Content Presenter will automatically select a "closest match" template to display the content item(s) using the precedence order above.

28.7 Performance Considerations for Content Presenter Display Templates

When content nodes are retrieved for display in a Content Presenter display template, most content item node property values are retrieved immediately along with the node, but some are loaded later only if needed. Other than the performance difference, the selective loading of node property values is transparent to the user or developer.

As a Content Presenter display template developer, you can optimize performance of your template if you are aware when different property values are loaded. For example, a typical list display template will render faster if you refer only to properties that are immediately loaded when the node is first retrieved and avoid properties that are loaded later when needed.

A secondary consideration is dependent on how the node is retrieved: through search versus fetched by parent ID. A property that may be loaded immediately on node retrieval for searches (such as "Results of a Query") may be loaded later for other retrieval methods (such as "Contents Under a Folder"). Table 28-8 shows whether or not node properties are loaded immediately upon node retrieval, by retrieval mechanism.

For information about the node properties listed in Table 28-8, see Idoc Script Reference Guide, available at http://download.oracle.com/docs/cd/E14571_01/doc.1111/e10726/toc.htm.

Table 28-8 Loading of Node Properties By Node Retrieval Mechanism

OCS Global Profile Properties Loaded When Node Is First Retrieved?
GET BY PARENT ID ("Contents Under a Folder") SEARCH ("Results of a Query") GET BY UUID ("Single Content Item" and "List of Items")

VaultFileSize

N

Y

Y

dCheckoutUser

Y

N

Y

dCreateDate

Y

Y

Y

dDocAccount

Y

Y

Y

dDocAuthor

Y

Y

Y

dDocName

Y

Y

Y

dDocTitle

Y

Y

Y

dDocType

Y

Y

Y

dFormat

Y

Y

Y

dID

Y

Y

Y

dInDate

Y

Y

Y

dIsCheckedOut

Y

N

Y

dOutDate

Y

Y

Y

dReleaseDate

Y

N

Y

dReleaseState

Y

N

Y

dRevClassID

Y

N

Y

dRevLabel

Y

Y

Y

dRevRank

Y

N

Y

dRevisionID

Y

Y

Y

dSecurityGroup

Y

Y

Y

dStatus

Y

N

Y

dWebExtension

Y

Y

Y

dWorkflowState

N

N

Y

idcPrimaryFile

Y

Y

Y

idcRenditions

N

N

Y

xCollectionID

Y

Y

Y

xComments

Y

Y

Y

xForceFolderSecurity

Y

Y

Y

xHidden

Y

Y

Y

xInihibitUpdate

Y

Y

Y

xReadOnly

Y

Y

Y

  Previous
Previous 		 Next
Next
  Go To Documentation Library
Library		 Go To Product List
Product		 Go To Table Of Contents
Contents		 Go To Index
Index