30 Adding Content Task Flows and Document Components to a Portal Page

Oracle WebCenter provides several ways to integrate content into a WebCenter Portal application. For more information, see Chapter 25, "Introduction to Integrating and Publishing Content."

In a WebCenter Portal application, you can add content from one or more connected content repositories to the application, using Content Presenter or the Documents service task flows to display the content in a variety of ways. As you develop your WebCenter portal application, you can view, edit, and manage that content as you add content task flows to the application, in the same way that end users of the application will do. For information about viewing, editing, and managing content in content task flows, see "Working with Content" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

This chapter describes how to add content to a page in a WebCenter Portal application using the content task flows and document components in the following sections:

30.1 Understanding the Content Presenter Task Flow

Content Presenter enables you to precisely customize the selection and presentation of content in a WebCenter Spaces application.

The Content Presenter task flow is available only when the connected content repository is Oracle Content Server and your WebCenter Spaces administrator has completed the prerequisite configuration.

See Also:

The Content Presenter task flow allows you to select an Oracle Site Studio file, a single item of content, multiple content items, query for content, or select content based on the results of a WebCenter Personalization Conductor scenario, and then select a template to render the content on a page in a WebCenter Spaces application.

Content Presenter has no dependency on the Documents service for adding or managing the content it displays.

To add the Content Presenter task flow to a page, see Section 30.4, "Adding a Selected Folder or File to a Page" and Section 30.5, "Adding a Content Task Flow to a Page."

30.2 Understanding the Documents Service Task Flows

The Documents service task flows provide a variety of formats to display folders and files on a page in a WebCenter Spaces application. You can choose the task flows appropriate for your application to provide features for accessing, adding, and managing folders and files; configuring and viewing file and folder properties; and searching file and folder content in the connected content repositories.

The Documents service task flows are available when the connected content repository is Oracle Content Server, Oracle Portal, or SharePoint, and your WebCenter Spaces administrator has completed the prerequisite configuration. If the content repository is Oracle Content Server, you can use both the Documents service task flows and the Content Presenter task flow to add and preview Oracle Site Studio files.

To add a Documents service task flow to a page in a WebCenter Portal application, you must first integrate the Documents service into the application by establishing a content repository connection, as described in Chapter 29, "Integrating the Documents Service."

Table 30-1 provides an overview of the Documents service task flows, which offer different ways to display folder and file listings to add and manage content in the connected content repository, or to display individual files in Oracle WebCenter.

Table 30-1 Documents Service Task Flows


 Folder and File Listings Individual Folders Individual Files

Document Explorer task flow. Displays folders and files in two panes, combining the functionality of the Document Navigator and Folder Viewer task flows. It provides in-place previewing and editing, and robust management capabilities

X

X

  

Document List Viewer task flow. Displays folders and files in a single pane as a flat listing. It provides preview and editing in separate window, and some management capabilities.

X

X

  

Document Manager task flow. Displays folders and files as specified by its Layout property: Explorer, Table, or Tree Table

X

X

  

Document Navigator task flow. Displays a simple listing of folders and files in a single pane, providing expand/collapse on folders to show the full hierarchy.

X

X

  

Folder Viewer task flow. Displays the contents of a folder in a single pane as a flat listing, providing in-place preview and editing, and robust management capabilities.

X

X

  

Recent Documents task flow. Displays a list of the files most recently created or modified in the current folder.

X

    

Document Viewer task flow. Displays a preview of a file, or file properties for files that do not support a preview.

  

XFoot 1 

X

Document Mini Properties task flow. Displays the Basic properties of a file in a read-only view.

  

X1

X

Document Properties task flow. Displays both Basic and Advanced properties of a file, along with an Edit button to allow you to modify property values.

  

X1

X

Rich Text Editor task flow. Displays an HTML or wiki document in the Rich Text Editor.

  

X

X

Document Upload task flow. Displays the Upload dialog to allow users to upload new documents to the page.

  

X

X

Document Version History task flow. Displays a list of versions of a file, allowing for deletion of a selected version.

    

X

AutoVue task flow. Displays AutoVue markup for a file in a table of hyperlinked markup names (see "Collaborating on Documents Using AutoVue" in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces).

    

X

Footnote 1 To show folder information in a Document Viewer, Document Mini Properties, or Document Properties task flow, you can set the task flow's resourceID property to the ID of the target folder. See Section 30.7, "Content Task Flow Parameters."

For more information about each Documents service task flow, refer to the following sections in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces:

To add a Documents service task flow to a page, see Section 30.4, "Adding a Selected Folder or File to a Page" and Section 30.5, "Adding a Content Task Flow to a Page."

30.3 Understanding Document Components

The Documents service provides the features for adding document components to a portal page. Document components enable you to display an individual file in a connected content repository in a variety of ways, depending on the file type:

  • A Link displays the name of a selected file as a link, which end users can click to display the file content in its native application.

  • An Inline Frame displays the content of a selected file as a preview on the page.

  • An Image displays a selected file as an image on the page.

To add a document component to a page in a WebCenter Portal application, you must first integrate the Documents service into the application by establishing a connection to a content repository, as described in Chapter 29, "Integrating the Documents Service."

Table 30-2 shows the content types that support each of these document components.

Table 30-2 Components for Folders and FIles

Content Type Document Components

Folder

Link (ADF Go Link)

Documents of various types (XML, PDF, JAVA, TXT, DOC, XLS, HTM)

Link (ADF Go Link)

Documents that can be rendered in a browser (HTML, flash, PDF and image)

Inline frame (ADF Inline Frame)s

Images (PNG, JPG, GIF)

Link (ADF Go Link)

Inline frame (ADF Inline Frame)

Image (ADF Image)

To display a folder or file using one of these document components, see Section 30.4, "Adding a Selected Folder or File to a Page."

30.4 Adding a Selected Folder or File to a Page

You can display an individual folder or file from a connected content repository on a page in any of the containers shown in Table 30-3:

Table 30-3 Adding Individual Folders and Files to a Page

Root Folder For Folders For Individual Files

  • Document Explorer

  • Document List Viewer

  • Document Manager

  • Document Navigator

  • Folder Viewer

  • Recent Documents

  • Document ViewerFoot 1 

  • Document Mini Properties1

  • Document Properties1

  • Document Upload

  • Rich Text Editor

  • Content Presenter

  • Document Explorer

  • Document List Viewer

  • Document Manager

  • Document Navigator

  • Folder Viewer

  • Document Viewer1

  • Document Mini Properties1

  • Document Properties1

  • Document Upload

  • Rich Text Editor

  • Content Presenter

  • Document Viewer

  • Document Mini Properties

  • Document Properties

  • Rich Text Editor

  • Document Upload

  • Document Version History

  • AutoVue

  • Link component

  • Inline Frame component

  • Image component

Footnote 1 To show folder information in a Document Viewer, Document Mini Properties, or Document Properties task flow, you can set the task flow's resourceID parameter to the ID of the target folder. See Section 30.7, "Content Task Flow Parameters."

For more information, see Section 30.1, "Understanding the Content Presenter Task Flow", Section 30.2, "Understanding the Documents Service Task Flows", and Section 30.3, "Understanding Document Components."

Note:

When an item that is stored in a content repository is dropped onto a page, the WebCenter application instructs the browser to check whether the content is up-to-date before a cached copy, if available, displays in the browser. The default content validation process supports collaboration use cases that require real-time content exchange.

For static content or content that does not change frequently, content validation checks incur an unnecessary performance overhead. For static content, Oracle recommends the following:

  • Oracle Content Server: use Content Presenter to display static content stored in Oracle Content Server. Content Presenter shows only the latest released version of content; it does not show any unreleased content that is in workflow

  • Other content repositories, such as SharePoint: ask your administrator to override the default content cache setting by editing the Web Tier mod_wl_ohs configuration file (mod_wl_ohs.conf). This is fully explained in "Setting the Cache-Control Response Header" in the white paper "Integrating the SharePoint 2007 Adapter with WebCenter Spaces" available from Oracle Technology Network at http://www.oracle.com/technetwork/middleware/webcenter/overview/index.html.

To add a selected folder or file to a page:

  1. Follow the steps in Section 7.2.1, "How to Prepare Your Application to Consume Services" to implement security.

  2. If you want to add a Documents service task flow, create a content repository connection to add the Documents service to your application (see Chapter 29, "Integrating the Documents Service.").

  3. Create or open a page in your application where you want to add the task flow (see Section 5.2.2, "Adding Pages to the Portal").

  4. First, consider whether or not you want to allow end users of your application to edit the task flow that displays the folder or file:

  5. In the Application Resources panel, navigate to Connections, then Content Repository.

  6. Locate the name of your connection, then expand it if desired to navigate to a specific folder or file.

  7. Drag the folder or file to the page, and release the mouse button to display a menu of available task flows and document components, as shown in Figure 30-1 (root folder), Figure 30-2 (subfolder), and Figure 30-3 (individual file).

    Figure 30-1 Adding Content Repository Root Folder to Portal Page

    Adding Content Repository Root Folder to JSF Page
    Description of "Figure 30-1 Adding Content Repository Root Folder to Portal Page"

    Figure 30-2 Adding Subfolder to Portal Page

    Adding Subfolder to JSF Page

    Figure 30-3 Adding File to Portal Page

    Adding File to JSF Page

  8. Choose the content task flow or document component that you wish to use. If the folder or file you are adding to your page does not support a particular task flow, the task flow does not display in this menu.

    Note:

    The Content Presenter task flow is available only when the connected content repository is Oracle Content Server. When you select the Content Presenter task flow, the folder or file displays in a default display template for its type.

  9. In the Edit Task Flow Binding dialog that displays when you select a task flow, click OK to accept the default task flow parameters, or modify the parameters as desired. For more information, see Section 30.7, "Content Task Flow Parameters."

  10. Save your page and the page definition file, then run your page to your browser by right-clicking the page (not the page definition file) and choosing Run.

For information about viewing, editing, and managing content in content task flows, see "Working with Content" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

30.5 Adding a Content Task Flow to a Page

You may want to add an "empty" content task flow to a page, containing no folders or files. For example, in cases where you do not have a content repository connection, or want to use an EL expression as a parameter to dynamically bind to a target item.

See Chapter 25, "Introduction to Integrating and Publishing Content" for information about each content task flow to help you select the task flow most appropriate for your needs.

To add a content task flow to a page in your WebCenter Portal application:

  1. Follow the steps in Section 7.2.1, "How to Prepare Your Application to Consume Services" to implement security.

  2. If you want to add a Documents service task flow, add the Documents service to your application (see Chapter 29, "Integrating the Documents Service.").

  3. Create or open a page in your application where you want to add the task flow (see Section 5.2.2, "Adding Pages to the Portal").

  4. Before you add a task flow to your page, consider whether or not you want to allow end users of your application to edit the task flow:

  5. In the Resource Palette, expand My Catalogs, then WebCenter Services Catalog. Under Task Flows, select the desired content task flow and drag it onto your page (Figure 30-4).

    Figure 30-4 Adding Standalone Documents Service Task Flow to JSF Page

    Adding Documents Service Task Flow to JSF Page

    Note:

    To allow end users of your application to customize a Content Presenter or Document List Viewer task flow using the Edit action, drag the task flow inside a Show Detail Frame Component (see Section 19.1.6, "How to Enable Component Customization Using Show Detail Frame Components").

    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."

  6. From the menu that displays, choose Region to open the Edit Task Flow Binding dialog (Figure 30-5).

    Figure 30-5 Specifying Parameters for Document Explorer Task Flow

    Specifying Parameters for Content Presenter Task Flow

  7. In the Edit Task Flow Binding dialog, click OK to accept the default task flow parameters, or modify the parameters as desired. For more information, see Section 30.7, "Content Task Flow Parameters."

  8. Save your page and the page definition file, then run your page to your browser by right-clicking the page (not the page definition file) and choosing Run.

After you add a content task flow to a page, you can subsequently modify the parameters if required. See Section 30.6, "Modifying Content Task Flow Parameters".

For information about viewing, editing, and managing content in content task flows, see "Working with Content" in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

Note:

For information about adding custom actions to task flows, see Section 21.3.2, "How to Enable Custom Actions on a Show Detail Frame Enclosing a Task Flow."

Note:

By default, the task flow displays as full screen at runtime. You can use ADF layout components to modify this layout. To learn more about ADF layout components, refer to the Oracle Fusion Middleware Web User Interface Developer's Guide for Oracle Application Development Framework.

30.6 Modifying Content Task Flow Parameters

To modify the parameters of a content task flow after you have created the region:

  1. Go to the Bindings view of your page (click the Bindings tab next to the Source tab).

  2. Under Executables, you'll see the task flow you added. Select this task flow. Figure 30-6 shows an example of a Document List Viewer task flow in the Executables section.

    Figure 30-6 Document List View Task Flow in the Bindings View

    Document List View Task Flow in the Bindings View
    Description of "Figure 30-6 Document List View Task Flow in the Bindings View"

  3. Next to the Executables heading, click the pencil icon to display the Edit Task Flow Binding dialog.

  4. In the Edit Task Flow Binding dialog, specify parameter settings for the task flow. For more information, see Section 30.7, "Content Task Flow Parameters."

    Note:

    For a Content Presenter task flow:

    • If you want to allow end users of your application to select the content and display template using the Content Presenter Configuration dialog at runtime, you can leave all parameter values blank except for taskFlowInstId. Enter a task flow instance ID that is unique to your application (for example, contentPresenterInstance1).

    • If you specify the content and a display template, note that Content Presenter does not support non-ASCII characters in files that are encoded using the non-UTF-8 character encoding. When users preview such files in Content Presenter, non-ASCII characters appear garbled.

    Figure 30-7 Task Flow Binding Parameters

    Task Flow Binding Parameters
    Description of "Figure 30-7 Task Flow Binding Parameters"

  5. Click OK to add the parameters.

30.7 Content Task Flow Parameters

Each content task flow has its own set of parameters. You configure these values when you add the task flow to a page.

The following sections describe the parameters for the content task flows:

30.7.1 Content Presenter Task Flow Parameters and Out-of-the-Box Display Templates

The Content Presenter task flow is available when the connected content repository is Oracle Content Server. This task flow displays selected documents in out-of-the-box or custom display templates.

See Also:

Table 30-4 describes the Content Presenter task flow parameters. Table 30-5 and Table 30-6 describe the out-of-the-box display templates for single and multiple content items, which can be specified as values for the templateView and templateCategory parameters.

Note:

When you specify the content and a display template, note that Content Presenter does not support non-ASCII characters in files that are encoded using the non-UTF-8 character encoding. When users preview such files in Content Presenter, non-ASCII characters appear garbled.

If you want to allow end users of your application to select the content and display template using the Content Presenter Configuration dialog at runtime, you can leave all parameter values blank except for taskFlowInstId. Enter a task flow instance ID that is unique to your application (for example, contentPresenterInstance1).

At runtime, the parameters of a Content Presenter task flow on an editable page can be edited in two ways by end users with appropriate permissions:

  • Click the configuration Edit icon for the task flow to display the Content Presenter Configuration dialog, where they can specify content and a display template. For end user information about the Content Presenter Configuration dialog, see the "Publishing Content Using Content Presenter" chapter in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

  • Click the properties Edit icon for the task flow to display the Component Properties dialog where they can set and modify task flow parameters. Parameters set in this way are generally intended for use at design time by developers creating a WebCenter Portal application, or for advanced users who want to bind a parameter to an EL expression. If an end user modifies a parameter value in the Component Properties dialog, the new value overrides the value specified in the Content Presenter Configuration dialog.

Table 30-4 Content Presenter Task Flow Parameters

Parameter Description

datasource

The data source of the content. The value depends on the value of datasourceType:

  • When datasourceType=dsTypeSingleNode, set datasource to a single document node identifier in the format:

    connection_name#dDocName:content_id

    Example: myconnection.us.oracle.com#dDocName:STAN_IDC-007619

  • When datasourceType=dsTypeFolderContents, set datasource to a single folder node identifier in the format:

    connection_name#dCollectionID:collection_id

    Example: myconnection.us.oracle.com#dCollectionID:45535

  • When datasourceType=dsTypeQueryExpression, set datasource to a CMIS search expression.

    Examples:

    select * from cmis:document where cmis:name like \'test%\'

    connectionName=connection_name#select * from cmis:document where cmis:createdBy = \'weblogic\'

    Note: If connectionName is not specified, then the primary connection will be used.

    For more information about how to format the query and for more examples, see Oracle Fusion Middleware Content Management REST Service Developer's Guide.

  • When datasourceType=dsTypeMultiNode, set datasource to a set of comma-delimited document node identifiers in the format:

    connection_name#dDocName:content_id, connection_name#dDocName:content_id, ...

    Example: myconn#dDocName:DOCUMENT_ID_12345,myconn#dDocName:DOCUMENT_ID_56789

  • When datasourceType=dsTypeScenarioResults, set datasource to point to a scenario in the format:

    conductor-connection-name=conductor_conn_name,namespace=scenario_namespace,scenario-name=scenario_name,inputparm1=value1,inputparm2=value2, ...

    Example:

    conductor-connection-name=ConductorServiceLocal,namespace=CPNamespace,scenario-name=GetRelatedDocsScenario,topic=outdoors,interests=hiking

    For information about the WebCenter Personalization Conductor and scenarios, see Chapter 66, "Personalizing WebCenter Applications."

datasource (cont'd)

where:

  • connection_name = the name of the content repository connection.

  • content_id = the Content ID for the content specified on the content information page for the item in Oracle Content Server.

  • collection_id = the dCollectionID found in the URL for the folder information page in Oracle Content Server, or the CollectionID value on the content server.

  • conductor_connection_name = the name of the URL connection that points to the WebCenter Personalization Conductor (this name must start with Conductor). This value must match the Reference name attribute value in the connections.xml file for this URL connection. For more information, see "Configuring Content Presenter" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter and Appendix A, "Files for WebCenter Portal Applications" (for details about connections.xml).

  • namespace = the name of the namespace that contains the specified scenario.

  • scenario_name = the name of the scenario that Content Presenter will be using.

datasourceType

The data source type of the content. Valid values are:

  • dsTypeSingleNode: A single content item.

  • dsTypeFolderContents: The contents of a folder.

  • dsTypeQueryExpression: The results of a query.

  • dsTypeMultiNode: An ordered list of content items.

  • dsTypeScenarioResults: The results of the specified scenario. See Chapter 66, "Personalizing WebCenter Applications."

maxResults

The maximum number of results to display when datasourceType is dsTypeQueryExpression.

Default: 100

regionTemplate

Specifies whether the display template is a Site Studio region definition template. This value is valid only with Oracle Content Server 11g or higher:

  • Checked: display template is a Site Studio region definition template. The templateView value is used to select the region template.

  • Cleared (default): display template is not a Site Studio region definition template.

For information about creating and using Site Studio region templates, see "Publishing Content Using Content Presenter" in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces and the Oracle Site Studio documentation library.

taskFlowInstId

The unique identifier of this task flow instance, used internally to maintain the association of the task flow instance with its customization and personalization settings and to manage saved queries. The value is generated automatically when you add individual files or the content of folders to your page from the Application Resources Panel, displaying the content in a Content Presenter task flow. The value is blank when you add a Content Presenter task flow onto your page from the Resource Palette. Enter or edit this value to set the unique identifier for the task flow.

templateCategory

The display template category ID to use in rendering results for multiple content items. This ID may reference one of the out-of-the-box display templates listed in Table 30-6, or a custom display template that has been defined as described in Section 28.4, "Creating Content Presenter Display Templates".

templateView

The display template view ID to use in rendering results for single content items. Enter the view ID of a template that is configured in the Resource Manager for a specific content type, or for list-based templates by category ID. This ID may reference one of the out-of-the-box display templates listed in Table 30-5, or a custom display template that has been defined as described in Section 28.4, "Creating Content Presenter Display Templates".

The out-of-the-box display templates provided by Oracle WebCenter are listed in Table 30-5 and Table 30-6.

Table 30-5 Out-of-the-Box Templates for Displaying Single Content Items

Single Content Item Display Templates View ID Description

Default Document Details View

oracle.webcenter.content.templates.default.document.details

Displays detailed information about any single content item including creation date, modification date, created by username, modified by username, path and any comments.

Default List Item View

oracle.webcenter.content.templates.default.list.item

Used by multiple content item views to display each individual item. Displays a single line with an icon and item name as a link that either displays or downloads the item when clicked.

Default View
(default when no template is selected)

oracle.webcenter.content.templates.default.detail

Displays any single content item, either directly in the browser (images, HTML, text) or as a link that downloads the associated file when clicked.

Table 30-6 Out-of-the-Box Templates for Displaying Multiple Content Items

Multiple Content Item Display Templates View ID Description

Accordion View

oracle.webcenter.content.templates.default.list.panel.accordion

Displays multiple content items in an accordion format, where each item can be expanded to display its details.

Bulleted View

oracle.webcenter.content.templates.default.list.bulleted

Displays multiple content items in a bulleted list format. Only content items will be displayed; folder items will be omitted.

Bulleted with Folder Label View

oracle.webcenter.content.templates.default.list.bulleted.label

Displays multiple content items in a bulleted list format. The name of the folder containing the first item in the list will display as a label above the list. This template is intended to be used when datasourceType is set to dsTypeFolderContents to ensure that all items have the same parent folder. Only content items will be displayed; folder items will be omitted.

Carousel View

oracle.webcenter.content.templates.default.list.carousel

Displays multiple content items in a carousel format, where items can be browsed by moving a slider left or right.

Icon View

oracle.webcenter.content.templates.default.list.tile

Displays multiple content items in a tiled format with large icons and file names.

List View
(default when no template is selected)

oracle.webcenter.content.templates.default.list.simple

Displays multiple content items in a simple list.

List with Details Panel View

oracle.webcenter.content.templates.default.list.details.panel

Displays multiple content items in a list on the left, with a panel to the right displaying the details of a selected item.

Sortable Table View

oracle.webcenter.content.templates.default.list.tabular

Displays multiple content items in a sortable table that includes the document name, date created, and date modified.

Tabbed View

oracle.webcenter.content.templates.default.list.panel.tabbed

Displays multiple content items as tabs that can be selected to display item details. content items in a simple list.

30.7.2 Document Explorer Task Flow Parameters

The Document Explorer task flow displays a list of folders and files in two panes: the left pane shows folders, and the right pane show the contents of the currently selected folder. It is a feature-rich documents task flow for viewing, managing, and collaborating on folders and files.

See Also:

Parameters that are unique to the Document Explorer task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-7 describes the Document Explorer task flow parameters.

Table 30-7 Document Explorer Task Flow Parameters

Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

pageSize

The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

Typical scenarios where you may wish to alter this value are:

  • The majority of end users have bigger screens, allowing for the display of more rows.

  • You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

  • ${false} (default): Expose content management to users.

resourceId

The currently focused resource. This value can be a folder ID or a document ID (as shown in the properties pane of the Document Viewer task flow).

showDocuments

Specifies whether the navigation tree shows documents and folders, or folders only:

  • ${true}: Show documents and folders.

  • ${false} (default): Show folders and hide documents.

showFolders

Specifies whether the navigation tree shows documents and folders, or documents only:

  • ${true} (default): Show folders and documents.

  • ${false}: Show documents and hide folders.

startFolderPath

The name of the folder to use as the root folder in the current task flow instance.

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current Space's default root folder. But it is useful, for example, when you want the start folder to be other than a Space's default root folder and when you want to display content from another Space.

Example:

  • ${'/PersonalSpaces/monty/Public'}

  • ${'/WebCenterB5/Proj_X/Specs'}

You can specify an EL expression to set this value.

Default: The root folder of the content repository configured with the specified connection for the current Space.

treeNavCollapsed

Specifies whether to collapse or expand the panel containing the tree navigation:

  • ${true} (default): Collapse panel.

  • ${false}: Expand panel.

30.7.3 Document List Viewer Task Flow Parameters

The Document List Viewer task flow displays folders and files in a single pane as a flat listing. In this task flow, users can navigate a folder hierarchy, and customize search queries. While this task flow may be useful for a specific need, its search functionality is replicated and enhanced by the Content Presenter task flow.

See Also:

Parameters that are unique to the Document List Viewer task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-8 describes the Document List Viewer task flow parameters.

Table 30-8 Document List Viewer Task Flow Parameters

Task Flow Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

createdAfter

A filtering value to limit the display of task flow content to folders and files created after a specified date and time.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZ'}Foot 1

Example:

${'2011-03-17T18:24:36.000+01:00'}

createdBefore

A filtering value to limit the display of task flow content to folders and files created before a specified date and time.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZ'}1

Example:

${'2011-03-17T18:24:36.000+01:00'}

creator

A filtering value to limit the display of task flow content to folders and files created by a particular user. Enter the user name as specified by the user login credentials. Only one user name may be entered. If no value is entered, then content created by any user is shown.

Example: ${'monty'}

lastModifiedAfter

A filtering value to limit the display of task flow content to folders and files last modified after a specified date and time. If no value is entered, then content modified in the last three months is shown.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZD'}1

Example:

${'2011-03-17T18:24:36.000+01.00'}

lastModifiedBefore

A filtering value to limit the display of task flow content to folders and files modified before a specified date and time. If no value is entered, then the last modification date is applied.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZD'}1

Example:

${'2011-03-17T18:24:36.000+01:00'}

lastModifier

A filtering value to limit the display of task flow content to folders and files last modified by a particular user. Enter the user name as specified by the user login credentials. Only one user name may be entered. If no value is entered, then all modified documents are shown.

Example: ${'monty'}

pageSize

The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

Typical scenarios where you may wish to alter this value are:

  • The majority of end users have bigger screens, allowing for the display of more rows.

  • You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

startFolderPath

The name of the folder to use as the root folder in the current task flow instance.

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current Space's default root folder. But it is useful, for example, when you want the start folder to be other than a Space's default root folder and when you want to display content from another Space.

Example:

  • ${'/PersonalSpaces/monty/Public'}

  • ${'/WebCenterB5/Proj_X/Specs'}

You can specify an EL expression to set this value.

Default: The root folder of the content repository configured with the specified connection for the current Space.

showFolders

Specifies whether to show documents and folders, or documents only:

  • ${true}: show folders and documents

  • ${false} (default): show documents and hide folders

taskFlowInstId

The unique identifier for this task flow instance, used internally to maintain the association of the task flow instance with its customization and personalization settings and to manage saved queries. The value is generated automatically when you add individual files or the content of folders to your page from the Application Resources Panel, displaying the content in a Document List Viewer task flow. The value is blank when you add a Document List Viewer task flow onto your page from the Resource Palette. Enter or edit this value to set the unique identifier for the task flow.

Footnote 1 "TZ" is the time zone indicator. If the time being described is in UTC (Coordinated Universal Time), then the time zone indicator is "Z". If the time is from any other time zone, then TZ describes the offset from UTC of the time zone. For example, if the time is in California in December (Pacific Standard Time, PST), then the TZ indicator would be "-08:00".

30.7.4 Document Manager Task Flow Parameters

The Document Manager task flow displays folders and files as specified by its layout parameter: it may display folders and files in two panes (explorer layout), or a single pane showing only the content of the current folder (table layout), or a single pane showing the folder hierarchy starting from the root folder (treeTable layout). The Document Manager task flow provides comprehensive document management functionality, such as copying, moving, pasting, and deleting folders and files.

See Also:

Parameters that are unique to the Document Manager task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-9 describes the Document Manager task flow parameters.

Table 30-9 Document Manager Task Flow Parameters

Task Flow Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

layout

A target layout for the task flow. Select from:

  • ${'explorer'} (default): Displays folders and files in two panes; the left pane shows folders, and the right pane show the contents of the currently selected folder. This layout looks identical to the Document Explorer task flow, without the parameters showDocuments, showFolders, and treeNavCollapsed.

  • ${'table'}: Displays only the contents of the current folder in a single pane, with the capability to click a folder to drill down, refreshing the pane with the folder contents.

  • ${'treeTable'}: Displays the folder hierarchy in a single pane, beginning with the root folder, with the capability to expand and collapse folders.

pageSize

The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

Typical scenarios where you may wish to alter this value are:

  • The majority of end users have bigger screens, allowing for the display of more rows.

  • You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

  • ${false} (default): Expose content management to users.

resourceId

The currently focused resource. This value can be a folder ID or a document ID (as shown in the properties pane of the Document Viewer task flow).

startFolderPath

The name of the folder to use as the root folder in the current task flow instance.

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current Space's default root folder. But it is useful, for example, when you want the start folder to be other than a Space's default root folder and when you want to display content from another Space.

Example:

  • ${'/PersonalSpaces/monty/Public'}

  • ${'/WebCenterB5/Proj_X/Specs'}

You can specify an EL expression to set this value.

Default: The root folder of the content repository configured with the specified connection for the current Space.

30.7.5 Document Navigator Task Flow Parameters

The Document Navigator task flow displays folders and files in a single pane, with the capability to expand and collapse folders to view folder hierarchy within the current folder. There are no menu options available to the end user for this task flow.

See Also:

Parameters that are unique to the Document Navigator task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-10 describes the Document Navigator task flow parameters.

Table 30-10 Document Navigator Task Flow Parameters

Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

pageSize

The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

Typical scenarios where you may wish to alter this value are:

  • The majority of end users have bigger screens, allowing for the display of more rows.

  • You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

  • ${false} (default): Expose content management to users.

resourceId

The currently focused resource. This value can be a folder ID or a document ID (as shown in the properties pane of the Document Viewer task flow).

showDocuments

Specifies whether the navigation tree shows documents and folders, or folders only:

  • ${true} (default): Show documents and folders.

  • ${false}: Show folders and hide documents.

startFolderPath

The name of the folder to use as the root folder in the current task flow instance.

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current Space's default root folder. But it is useful, for example, when you want the start folder to be other than a Space's default root folder and when you want to display content from another Space.

Example:

  • ${'/PersonalSpaces/monty/Public'}

  • ${'/WebCenterB5/Proj_X/Specs'}

You can specify an EL expression to set this value.

Default: The root folder of the content repository configured with the specified connection for the current Space.

30.7.6 Folder Viewer Task Flow Parameters

The Folder Viewer task flow displays a listing of the contents of a folder in a single pane as a flat listing.

See Also:

Parameters that are unique to the Folder Viewer task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-11 describes the Folder Viewer task flow parameters.

Table 30-11 Folder Viewer Task Flow Parameters

Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

pageSize

The maximum number of rows to show in the task flow. If the listing of folders and files in the task flow is larger than the specified number of rows, the task flow displays a scroll bar. Default: 27

Typical scenarios where you may wish to alter this value are:

  • The majority of end users have bigger screens, allowing for the display of more rows.

  • You want to fit this task flow into a smaller area of a page.

Note: If you set pageSize to a value that is too big for the size of the screen, the end user will experience difficulty coordinating the task flow scroll bar with the application scroll bar.

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

  • ${false} (default): Expose content management to users.

resourceId

The currently focused resource. This value can be a folder ID or a document ID (as shown in the properties pane of the Document Viewer task flow).

showFolders

Specifies whether the navigation tree shows documents and folders, or documents only:

  • ${true} (default): Show folders and documents.

  • ${false}: Show documents and hide folders.

startFolderPath

The name of the folder to use as the root folder in the current task flow instance.

This is a content-scoping parameter that assists with determining the source and range of content to display in the task flow instance.

There is no need to set this value for task flows that display the content of the current Space's default root folder. But it is useful, for example, when you want the start folder to be other than a Space's default root folder and when you want to display content from another Space.

Example:

  • ${'/PersonalSpaces/monty/Public'}

  • ${'/WebCenterB5/Proj_X/Specs'}

You can specify an EL expression to set this value. See "EL Expressions Relevant to the Documents Service" in Appendix B in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

Default: The root folder of the content repository configured with the specified connection for the current Space.

30.7.7 Recent Documents Task Flow Parameters

The Recent Documents task flow displays a listing of the most recently created or modified files by the current user.

See Also:

Parameters that are unique to the Recent Documents task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-12 describes the Recent Documents task flow parameters.

Table 30-12 Recent Documents Task Flow Parameters

Parameter Description

connectionName

The name of the content repository connection. If no value is selected, the default connection specified by the application developer or administrator is used. For information about configuring content repository connections, see "Registering Content Repositories" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Default: The connection selected as default in the Create Content Repository Connection dialog box by the application developer, which can be changed by the administrator.

groupSpace

(Used in WebCenter Spaces only)
The name of a Space that is the source of the recently created or modified documents listed in the task flow. Valid values are:

  • no value or ${null} (default): Displays documents for the entire connected content repository.

  • Display name or ID of a specific Space: Displays documents in that Space.

  • ${'all'}: Displays documents from any Space, excluding non-Space documents.

lastModifiedAfter

A filtering value to limit the display of task flow content to folders and files last modified after a specified date and time. If no value is entered, then content modified in the last three months is shown.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZD'}Foot 1

Example:

${'2011-03-17T18:24:36.000+01.00'}

lastModifiedBefore

A filtering value to limit the display of task flow content to folders and files modified before a specified date and time. If no value is entered, then the last modification date is applied.

The value uses the ISO 8601 format:

${'yyyy-mm-ddThh:mm:ss.sssTZD'}1

Example:

${'2011-03-17T18:24:36.000+01:00'}

lastModifier

A filtering value to limit the display of task flow content to folders and files last modified by a particular user. Enter the user name as specified by the user login credentials. Only one user name may be entered. If no value is entered, then all modified documents are shown.

Example: ${'monty'}

maxDocuments

The maximum number of files to show. If no value is entered, then all matching files are shown.

Example: ${10}

Note that there is no single quote surrounding the value.

Default: ${null}

mostRecentFirst

Specifies the sort order of files in the task flow:

  • ${true} (default): Most recent documents listed first.

  • ${false}: Oldest documents listed first.

Footnote 1 "TZ" is the time zone indicator. If the time being described is in UTC (Coordinated Universal Time), then the time zone indicator is "Z". If the time is from any other time zone, then TZ describes the offset from UTC of the time zone. For example, if the time is in California in December (Pacific Standard Time, PST), then the TZ indicator would be "-08:00".

30.7.8 Document Viewer Task Flow Parameters

The Document Viewer task flow displays the contents of a folder or a preview of an individual file in the default template for its file type.

See Also:

Parameters that are unique to the Document Viewer task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-13 describes the Document Viewer task flow parameters.

Table 30-13 Document Viewer Task Flow Parameters

Parameter Description

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

initialSidebar

Specifies a pane to display in the sidebar of the Document Viewer. Valid values are:

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

  • ${false} (default): Expose content management to users.

resourceID

The ID of the folder or file to display in the Document Viewer.

30.7.9 Document Mini Properties Task Flow Parameters

The Document Mini Properties task flow displays the basic properties of a selected file in a read-only view. This task flow is available for all file types.

See Also:

Parameters that are unique to the Document Mini Properties task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-14 describes the Document Mini Properties task flow parameters.

Table 30-14 Document Mini Properties Task Flow Parameters

Parameter Description

resourceID

The ID of the document for which to display basic properties (as shown in the properties pane of the Document Viewer task flow)

30.7.10 Document Properties Task Flow Parameters

The Document Properties task flow displays both Basic and Advanced properties of a selected file, along with an Edit button to modify property values. This choice is available for all file types.

See Also:

Parameters that are unique to the Document Properties task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-15 describes the Document Properties task flow parameters.

Table 30-15 Document Properties Task Flow Parameters

Parameter Description

resourceID

The ID of the document for which to display basic and advanced properties (as shown in the properties pane of the Document Viewer task flow).

readOnly

Specifies whether or not to allow end user to edit document properties:

  • ${true}: Do not display Edit button in Basic and Advanced properties panes, thus disabling the ability for the end user to edit document properties.

  • ${false} (default): Display Edit button in Basic and Advanced properties panes, allowing end users to edit document properties.

30.7.11 Rich Text Editor Task Flow Parameters

The Rich Text Editor task flow displays an HTML or wiki document in the Rich Text Editor.

See Also:

Parameters that are unique to the Rich Text Editor task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-18 describes the Rich Text Editor task flow parameters.

Table 30-16 Rich Text Editor Task Flow Parameters

Parameter Description

destinationID

The currently focused resource. This value can be a folder ID to create a new document in that folder, or a document ID (as shown in the properties pane of the Document Viewer task flow) to edit an existing document.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

initialSidebar

Specifies a pane to display in the sidebar of the Document Viewer. Valid values are:

30.7.12 Document Upload Task Flow Parameters

The Document Upload task flow displays the Upload dialog to allow users to upload new documents to the page.

See Also:

Parameters that are unique to the Document Upload task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-18 describes the Document Upload task flow parameters.

Table 30-17 Document Upload Task Flow Parameters

Parameter Description

destinationID

The currently focused resource. This value specifies a folder ID to upload a document into that folder.

destinationSelectionEnabled

Specifies whether or not the destination folder can be changed:

  • ${true}: Display destination folder as an input text box along with a Browse button.

  • ${false} (default): Display destination folder as read only text.

featuresOff

A list of disabled features for the task flow. Use commas or spaces to separate items. Valid values are exposed in the JavaDoc: checkin, checkout, clipboard, close, delete, download, dnd, editwiki, editoffice, newfolder, newwiki, rename, upload, multifile-upload, profile-upload, search, advancedSearch, workflow, properties, history, comments, likes, links, tags, recommendations, autovue, title, related-items, social, sidebars, ils.

Example:

${'search, advancedSearch, clipboard, dnd, rename, newfolder, upload, newwiki, checkin, checkout, editoffice, edithtml, delete, sidebars, history'}

30.7.13 Document Version History Task Flow Parameters

The Document Version History task flow displays a list of versions of a selected file in a read-only view. This task flow is available for all file types.

See Also:

Parameters that are unique to the Document Version History task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-18 describes the Document Version History task flow parameters.

Table 30-18 Version History Task Flow Parameters

Parameter Description

resourceID

The ID of the document for which to display version history (as shown in the properties pane of the Document Viewer task flow).

readOnly

Specifies whether to disable and hide all content management operations:

  • ${true}: Disable content management.

    ${false} (default): Expose content management to users.

30.7.14 AutoVue Task Flow Parameters

The AutoVue task flow integrates the Oracle AutoVue functionality to allow users to review and collaborate on a document.

See Also:

Parameters that are unique to the AutoVue task flow are shown in the Edit Task Flow Binding dialog box when you add the task flow to a page. Table 30-19 describes the AutoVue task flow parameters.

Table 30-19 AutoVue Task Flow Parameters

Parameter Description

resourceId

The ID of the document to display in the AutoVue task flow (as shown in the properties pane of the Document Viewer task flow).