15 Working with the Documents Service

Oracle WebCenter enables content integration through:

This chapter describes how to work with the Documents service and task flows at runtime in WebCenter applications. For more information about managing and including content in your WebCenter applications, see:

This chapter provides detailed information about the Documents service and its task flows at runtime and in Oracle Composer. It contains the following sections:

Audience

This chapter is intended for WebCenter Spaces users interested in viewing, creating, and managing task flows available through the Documents service. Much of this information also applies to custom WebCenter applications, though it is written with WebCenter Spaces users in mind. (For information about custom WebCenter applications, see "Integrating the Documents Service" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.)

Your application administrator has the authority to expose or hide task flows from a particular service. Tasks discussed in this chapter are not available to you if the relevant service is hidden.

15.1 What You Should Know About the Documents Service

The Documents service provides features for accessing, adding, and managing files and folders; configuring file and folder properties; searching file and folder content in your organization's content repositories; and displaying content from a content repository on a page in a predefined template using the Content Presenter task flow.

The Documents service allows you to manage folders and documents from your company's content repositories in two ways:

  • Add any single folder or file in a content repository to a page. Individual files can be added to a page as links, images, or inline frames (depending on the file type). For more information, see Section 7.1.3, "Adding Documents to a Page".

  • Add a Documents service task flow to a page:

    • Content Presenter task flow

    • Document Manager task flow

    • Document List Viewer task flow

    • Recent Documents task flow

    For general information about adding a task flow to a page, see Section 7.1.4, "Adding Task Flows to a Page". This chapter provides information about the Documents service task flows and how you can use them to display documents on your WebCenter application pages.

15.1.2 Accessing the Documents Service Task Flows in the Oracle Composer Catalog

In a runtime environment (the WebCenter Spaces application and deployed custom WebCenter applications), end users use the Oracle Composer Catalog to include Documents service task flows on a page. In the Oracle Composer Catalog, the Documents page includes the Documents service task flows, along with nodes to provide access to folders and files that you can add to your page in a selected Documents service task flow, as shown in Figure 15-1.

Figure 15-1 Oracle Composer Catalog in WebCenter Spaces: Documents Page in the WebCenter Spaces Application (when editing a personal space page)

Documents service task flows in WebCenter Spaces

Table 15-1 describes each entry on the Documents page of the Oracle Composer catalog:

Table 15-1 Oracle Composer Catalog Documents Page

Item Task Flow? Description and Use

All Documents

No

A virtual node that exposes a list of all files and folders to which you have access. Click Open to drill down, or enter a file name in the Search field. Click Add to display a menu where you can choose a task flow in which to display the current folder or files

Content Presenter

Yes

Displays selected documents in a predefined template. See Section 15.1.3, "Understanding the Content Presenter Task Flow."

Document List Viewer

Yes

Displays selected files, and optionally folders, to which you have access. See Section 15.1.4, "Understanding the Document List Viewer Task Flow."

Document Manager

Yes

(equivalent to Document Library task flow in WebCenter Services Catalog in Oracle WebCenter Framework)

Displays selected folders and files, with file management capabilities. See Section 15.1.5, "Understanding the Document Manager Task Flow."

(in WebCenter Spaces only)

Group Space Documents

Personal Documents

No

A shortcut that exposes a list of files and folders associated with the current group space or personal space. Click Open to drill down, or enter a file name in the Search field. Click Add to display a menu where you can choose a task flow in which to display the current folder or files.

Recent Documents

Yes

Displays a list of the files most recently created or modified in the currently selected folder. See Section 15.1.6, "Understanding the Recent Documents Task Flow."


15.1.3 Understanding the Content Presenter Task Flow

The Content Presenter task flow allows you to select a single item of content, multiple content items, or query for content, and then apply a template to render the content on a page in a WebCenter application. The content available to Content Presenter resides in an Oracle Content Server backend content repository, which must be configured by your WebCenter administrator (see "Oracle Content Server Prerequisites" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter), then a connection established to the content repository (see “How to Create a Content Repository Connection Based on the Oracle Content Server Adapter” in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter).

The template that is used to display the content may be one of the out-of-the-box templates provided with Oracle WebCenter (see Table 15-2 and Table 15-3), or a custom template designed for your organization (see “Creating Custom Templates for Displaying Content Using Content Presenter” in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter).

For the steps to add content to a page in WebCenter Spaces using the Content Presenter task flow, see Section 15.2.2, "Displaying Content Using the Content Presenter Task Flow".

Note:

Content added to a page using Content Presenter is not editable.

15.1.4 Understanding the Document List Viewer Task Flow

The Document List Viewer task flow allows you to add information from your organization's content repositories onto a page as a listing of files and, optionally, folders.

When you click Add next to Document List Viewer in the Oracle Composer Catalog, the default settings add a listing of the entire root folder of the active content repository connection to the page. You can set the Connection Name and Root Folder Path properties to change the target location (see Table 15-8), or drill down to the target location in the Oracle Composer catalog then click the corresponding Add link and choose Document List Viewer. Additionally, the Document List Viewer task flow can be configured to display or hide any subfolders.

When you add a Document List Viewer task flow to a page, the name of the folder that contains the displayed content appears above the viewing area. For example, in Figure 15-2, the name of the folder is Root Folder.

Figure 15-2 Document List Viewer Task Flow for All Documents for the Topmost Folder in the Content Repository in the WebCenter Spaces Application (Show Folders property set to true)

All Documents topmost folder

Figure 15-3 Document List Viewer Task Flow for All Documents for a Subfolder in the Content Repository in the WebCenter Spaces Application (Show Folders property set to true)

All Documents subfolder

Figure 15-4 Document List Viewer Task Flow for Group Space Documents Displayed on a Group Space Page in the WebCenter Spaces Application

Document List Viewer task flow for group space documents

The Document List Viewer task flow includes a View menu, which you can use to personalize the display of the columns in the task flow (Figure 15-5).

Figure 15-5 View Menu on the Document List Viewer Task Flow

View menu on the Document List Viewer task flow

For more information about working with the files and folders on a page, see Section 15.2, "Working with the Documents Service Task Flows."

15.1.5 Understanding the Document Manager Task Flow

The Document Manager task flow allows you to display a list of all the folders and files in a selected folder, with file management capabilities. Use this task flow to create, upload, and manage folders and files; to manage file versions; and to check files out and in.

When you click Add next to Document Manager in the Oracle Composer Catalog, a Document Manager task flow for the default or current folder is added to the page. In WebCenter Spaces, the default folder is your personal folder if working with a page in your personal space, and the group space folder if working with a page in a group space (identical to the folder exposed on the Documents page). In custom WebCenter applications, the default folder is the root of the active content repository connection. You can also set the Connection Name and Start Folder Path properties to change the target folder (see Table 15-7), or drill down to the target location in the Oracle Composer catalog then click the corresponding Add link, and choose Document Manager.

In the Document Manager task flow, the target folder is the current location, displayed in the status bar (in the lower right hand area) of the Document Manager task flow (Figure 15-6).

Figure 15-6 Current Location Displayed In Document Manager Task Flow Status Bar

Current location in status bar

The current location is where any uploaded files, newly created HTML files, or pasted files and folders are placed. Selecting a single folder in the Document Manager task flow makes that folder the current location. In a Document Manager task flow that includes multiple folders, clicking a folder name to display the folder as the top-level folder in the task flow makes that folder the current location.

In WebCenter Spaces, your personal space and all group spaces have a Documents page, which is simply a page that is dedicated to the Document Manager task flow. By default, a group space displays a tab for its Documents page. However, your personal space does not display the Documents page by default, so you have to display it yourself, as follows:

  1. Click the Personal Space tab to display your personal space.

  2. Click Page Actions, then select Manage Pages.

  3. In the Manage Pages dialog, in the row for the Documents page, click Show Page.

  4. Click Close to display the Documents page for your personal space, listing all of the documents available to you (Figure 15-7).

Figure 15-7 A Documents Page in a WebCenter Spaces Personal Space

A Documents page in a personal space

The Document Manager task flow provides features for supporting and maintaining your content. These include:

  • The File menu for convenient access to file and folder features (Figure 15-8).

    Figure 15-8 Document Manager File Menu

    Document Manager task flow File menu
  • The View menu for setting your document display preferences (Figure 15-9).

    Figure 15-9 Document Manager View Menu

    Document Manager task flow View menu
  • An easy-access toolbar (Figure 15-10).

    Figure 15-10 Document Manager Toolbar

    Document Manager task flow toolbar

    Use the Document Manager toolbar for quick access to frequently-used document functions, such as folder creation, file creation and upload, cutting, copying, editing, and deleting. Additionally, you can use icons on the toolbar to access file and folder properties and to adjust your view of repository content.

    Note:

    Actions available on the toolbar are also available on the menus; keep in mind that there is more than one way to accomplish your Document Manager tasks.
  • Context menus for convenient access to document functions. Right-click a folder or file icon to display the context menu (Figure 15-11 and Figure 15-12).

    Figure 15-11 Document Manager Folder Context Menu (WebCenter Spaces Application)

    Document Manager task flow Folder context menu

    Figure 15-12 Document Manager File Context Menu (WebCenter Spaces Application)

    Document Manager task flow File context menu
  • A dedicated file search.

    The Documents service provides its own search tool, offering both basic and advanced searches. The document search feature stands apart from the Search service by searching only content provided through the Documents service. (For more information about the Search service, see Chapter 25, "Working with the Search Service.")

    For more information, see Section 15.2.7, "Running Document Searches."

  • In-place creation and revision of HTML

    Launch the Rich Text Editor (RTE) to create and edit HTML files, and save them directly to the content repository.

    For more information, see Section 15.2.4.2, "Creating and Editing Rich Text Documents."

Note:

The Document Manager task flow offers document review and collaboration features through integration with Oracle AutoVue. For more information, see Section 15.2.5.9, "Reviewing and Collaborating on Documents."

15.1.6 Understanding the Recent Documents Task Flow

The Recent Documents task flow allows you to add a listing of your most recently created or modified files onto a page (Figure 15-13).

Figure 15-13 Recent Documents Task Flow Displayed on a Group Space Page in WebCenter Spaces

Recent Documents task flow

When you click Add next to Recent Documents in the Oracle Composer Catalog, the default property settings add a listing of the most recently created or modified files in the entire root folder of the active content repository connection to the page. See Section 15.4, "Setting Documents Service Task Flow Properties" to modify the property settings for the Recent Documents task flow.

When a Recent Documents task flow is added to a page, you can position your cursor over a document in the task flow, and document details are displayed (Figure 15-14).

Figure 15-14 Displaying Detailed Information About a Recent Document

Recent document information popup

You can also add a Recent Documents task flow for the recently created or modified in only the current group space: click Add next to Group Space Documents in the Oracle Composer Catalog, then choose Recent Documents from the menu.

In WebCenter Spaces, the Recent Documents task flow appears in the WebCenter Spaces Sidebar by default (Figure 15-15), where you can click a file link in the list to open the file.

Figure 15-15 Recent Documents Task Flow in the WebCenter Spaces Sidebar

Recent Documents in the Sidebar

15.2 Working with the Documents Service Task Flows

The Documents service task flows provide convenient access to different groups of files in your organization's content repositories. Additionally, the Documents task flow provides a rich set of tools for adding, revising, versioning, and otherwise managing that content.

This section describes how to use those tools. It discusses document management features universally, as opposed to within the context of a particular task flow. All of the features discussed in this section are available through the Document task flow (see Section 15.1.5, "Understanding the Document Manager Task Flow"). Each subsection includes information about which additional task flows provide access to the features described.

This section includes the following subsections:

15.2.1 Adding a Task Flow to a Page at Runtime

For the steps to add a task flow to a page from the Oracle Composer Catalog at runtime, including any of the Documents service task flows, see Section 7.1.4, "Adding Task Flows to a Page."

15.2.2 Displaying Content Using the Content Presenter Task Flow

The Content Presenter task flow provides a way to display any type of content in your organization's content repositories on a page, displayed in a selected template. The template may be either one of the out-of-the-box templates provided with WebCenter (see Table 15-2 and Table 15-3), or a custom template that has been designed specifically for the type of content or for your organization. For more information, see Section 15.1.3, "Understanding the Content Presenter Task Flow".

To display content on a page using the Content Presenter task flow in a WebCenter application:

  1. As with any Documents service task flow, open the page in Oracle Composer (see Section 7.1.2.1, "Opening a Page in Oracle Composer"), then click the Add Content button on the region in which to add content to open the Oracle Composer Catalog.

  2. Next to Documents, click Open (Figure 15-16).

    Figure 15-16 Opening the Documents Section the Oracle Composer Catalog

    Oracle Composer Catalog: Open Documents
  3. Select the content you want to display in one of two ways:

    • Next to Content Presenter, click Add (Figure 15-17).

      Figure 15-17 Adding a Content Presenter Task Flow to a Page

      Oracle Composer Catalog: Add Content Presenter task flow

      A new empty region is added to your page (Figure 15-18).

      Figure 15-18 Adding a Content Presenter Task Flow to a Page

      Content Presenter empty region
    • Or, drill down in the Oracle Composer Catalog: Next to All Documents (or, in WebCenter Spaces, Group Space Documents or Personal Space Documents), click Open to drill down to the folder or file you want to display on the page. When you locate the target content, click Add, and choose Content Presenter from the menu (Figure 15-19). Your selection displays in a default template on the page.

      Figure 15-19 Adding Content in Content Presenter Task Flow

      Add Content Presenter task flow
  4. To further configure the Content Presenter task flow to select or change content, or choose a different template, click the Edit (wrench) icon (Figure 15-20).

    Note:

    You can also specify content and a display template by clicking the properties Edit (pencil) icon and specifying parameters on the Parameters tab of the Component Properties dialog. However, specifying parameters in this way is generally intended for use at design time by developers creating a custom application, or for advanced users who want to bind a parameter to an EL expression. If you modify a property value in the Component Properties dialog, the new value overrides the value specified in the Content Presenter Configuration dialog, and that value cannot subsequently be changed through the Content Presenter Configuration dialog. The steps in this section describe the use of the Content Presenter Configuration dialog; for information about Content Presenter task flow parameters, see Section 15.4.1, "Setting Content Presenter Task Flow Properties on the Parameters Tab."

    Figure 15-20 Editing a Content Presenter Task Flow

    Edit Content Presenter task flow

    The Content Presenter Configuration dialog displays (Figure 15-21).

    Figure 15-21 Content Presenter Configuration Dialog

    Content Presenter Configuration dialog

    A green check mark alongside each item indicates that the required information is complete and valid.

  5. Click Select Content or the Content tab to display the Content page.

  6. On the Content page, select the Content Source (Figure 15-22):

    Figure 15-22 Selecting the Content Source

    Selecting content source
    • Single Content Item allows you to select a specific item to display on the page. Click Browse to locate the item.

      Figure 15-23 Selecting a Single Content Item

      Single content item selection UI
    • Contents Under a Folder allows you to select a folder to display its contents on the page (in the order stored in the folder). Click Browse to locate the folder.

      Figure 15-24 Selecting Content Under a Specified Folder

      Content under a Folder selection UI
    • Results of a Query allows you to enter query criteria to select content and define the order that the content displays on the page (Figure 15-25).

      Note:

      The query is stored and rerun to retrieve the latest content each time you view the Content Presenter instance.

      Figure 15-25 Selecting Content by the Results of a Query

      Results of a Query selection UI
    • List of Items allows you to browse or search for any number of items to add to a list, and delete or reorder the items before adding the list to the page (Figure 15-26).

      Figure 15-26 Selecting a List of Content Items

      List of Items selection UI
  7. Click Select Template or the Template tab to display the Template page.

  8. On the Template page:

    • If the Content Source selected on the Content page is a single content item, select the Template (Figure 15-27):

      Figure 15-27 Selecting the Display Template (for Single Content Items)

      Selecting the template

      The Default templates in the list are out-of-the-box templates for single content items (see Table 15-2). Other selections that may be available in the list are custom display templates developed specifically for your WebCenter application.

      Note:

      The selections available reflect the entries specified by your organization's template developer in templates-registry.xml under <content-templates>. For more information, see “Creating Custom Templates for Displaying Content Using Content Presenter” in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.
    • If the Content Source selected on the Content page is a multiple content item (Contents Under a Folder, Results of a Query, or List of Items), select the Template Category (Figure 15-28), then the Template (Figure 15-29).

      Figure 15-28 Selecting the Template Category (for Multiple Content Items)

      Selecting the template category

      Figure 15-29 Selecting the Display Template (for Multiple Content Items)

      Selecting the multiple content item template

      By default, there is only one category: Default Templates. This selection defines the collection of out-of-the-box templates available for multiple content items (see Table 15-3).

      Other selections that may be available are custom template categories and display templates developed specifically for your WebCenter application.

      Note:

      The selections available reflect the entries specified by your organization's template developer in templates-registry.xml under <content-list-templates>. For more information, see “Creating Custom Templates for Displaying Content Using Content Presenter” in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.

    Table 15-2 Out-of-the-Box Templates for Displaying Single Content Items

    Single Content Item Templates View ID in templates-registry.xml 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) or as a link that downloads the associated file when clicked.

    Default List Item View for Folders

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

    Not available for selection in the Content Presenter Configuration dialog, but used by other multiple content item templates to display folders as they process their content nodes. Displays a single line with a folder icon and the folder name.


    Table 15-3 Out-of-the-Box Templates for Displaying Multiple Content Items

    Multiple Content Item Templates View ID in templates-registry.xml 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 with Content Source set to Contents Under a Folder 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.


  9. To see a preview of your content before adding it to the page, click Preview or the Preview tab to display the Preview page.

15.2.3 Opening Files and Folders in a Task Flow

You can open files using the method described in this section in all Documents service task flows. Opening folders is available to all Documents service task flows except the Recent Documents task flow, which does not display folders.

This section includes the following subsections:

15.2.3.1 Opening Files

To open document files:

  1. Go to the Documents service task flow that lists the file you want to open.

  2. Click the file name.

    The next thing that happens depends on the file type:

    • If the file can be opened in a browser, that is where it opens. This applies to HTML files, text files, and image files, such as .gif and .jpg files.

    • Other types of files, such as Microsoft Word files and zip files, invoke a download dialog when you click them, which gives you the option of viewing the file in its native application, or saving the file to a local drive.

      This is browser behavior, so the way you follow through depends on the browser you use and how that browser is configured.

    For all file types, you can go right into a download operation by right-clicking directly on the document in the task flow. This opens your browser's context menu. From there, you can choose the Save Link As menu option, or your browser's comparable menu option.

15.2.3.2 Opening Folders

You can open folders in two ways:

  • Expand the folder node by clicking the Expand icon (Figure 15-30) to view a hierarchical list of the folder's content.

    Figure 15-30 Expand Icon on a Folder

    Expand node on a folder
  • Click the folder name (Figure 15-31) to display the folder as the top-level folder in the task flow (Figure 15-32), which also makes the folder the current location (see Section 15.1.5, "Understanding the Document Manager Task Flow").

    Figure 15-31 Subfolder (Public) of Root Folder (orcladmin) in a Content Repository

    A folder in a Document Library

    Figure 15-32 Subfolder Displayed as Top-Level Folder

    Subfolder displayed as a top-level folder

    Click the Show Hierarchy icon to the left of the folder (Figure 15-32) to open a selection list of folders higher up the folder hierarchy.

    Click a folder on the list to display your selection as the top-level folder. Clicking the first folder on the list (the root folder) returns you to the default folder display mode.

15.2.4 Adding Files Using the Document Manager Task Flow

You can add files to your WebCenter application by uploading them or by creating them on the spot, using the Rich Text Editor (RTE).

This section describes how to add files through the Document Manager task flow:

15.2.4.1 Uploading Files

Use the Document Manager task flow's file upload feature to import content into a content repository. Upload files from any location that is accessible from your local file system. This includes remote systems to which your local system has access.

Note:

You can upload files if you have sufficient access privileges and the connection to your underlying content repository supports it.

This section describes how to upload files to the content repository. It contains the following subsections:

15.2.4.1.1 Uploading a File Using the Toolbar

To upload a file from your file system using the toolbar:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to upload a file.

  2. Select the row of the folder into which you want to upload the file. Note that to select a folder, you should click within the folder's row and not click the folder itself.

  3. On the toolbar, click the Upload Document icon (Figure 15-33).

    Figure 15-33 Upload Document Icon on Toolbar

    Upload Document icon

    The Upload Document screen opens (Figure 15-34). All fields requiring a value are marked with an asterisk (*).

    Figure 15-34 Upload Document Screen

    Upload Document page
    Description of "Figure 15-34 Upload Document Screen"

  4. Click Browse next to the Document to Upload field, and then navigate to and select the file you want to upload.

  5. Optionally, provide a description of the file in the Description field.

    Note:

    The Destination field, which appears below the Description field, shows the directory path to the folder where the uploaded document will be stored.
  6. Click Upload to complete the transaction.

    Where versioning is supported, a Confirm New Version screen opens when you upload a file with the same name as another file in the same folder (Figure 15-35).

    Figure 15-35 Confirm New Version Screen

    Confirm New Version screen

    You are given the option to save the new file as a new, current version or to cancel the file upload.

15.2.4.1.2 Uploading a File Using a Menu

The Document Manager task flow includes a File menu and context (right-click) menus for performing file and folder actions on the spot. Both the File menu and the folder context menu provide commands for uploading files. This section describes how to use them.

To upload files using the File menu or the folder context menu:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to upload a file.

  2. Select the target folder where you want to upload a file.

  3. From either the File menu or the folder context menu (right-click the folder), select New and then Upload Document.

    The Upload Document screen opens (Figure 15-34). All fields requiring a value are marked with an asterisk (*).

  4. Click Browse next to the Document to Upload field, and then navigate to and select the file you want to upload.

  5. Optionally, provide a description of the file in the Description field.

    Note:

    The Destination field, which appears below the Description field, shows the directory path to the folder where the uploaded document will be stored.
  6. Click Upload to complete the transaction.

    Where versioning is supported, a Confirm New Version screen opens when you upload a file with the same name as another file in the same folder (Figure 15-35).

    You are given the option to save the new file as a new, current version or to cancel the file upload.

15.2.4.2 Creating and Editing Rich Text Documents

In addition to file upload, you can add content to a content repository through file creation. The Rich Text Editor (RTE) is a fully-integrated HTML text editor, which you can use to create your own HTML documents and edit HTML documents contained in the content repository.

The RTE provides basic styling features, such as selectors for font type, size, and color. It includes features for adding links, bulleted and numbered lists, and special text effects, such as subscript, superscript, strikethrough, and underline. It provides two modes—Rich Text Editing mode and Source Code mode. Use the Rich Text Editing mode to create and revise content in a WYSIWYG environment. Use the Source Code mode to enter your own HTML.

In the Documents service, the RTE is available through the Document Manager task flow.

Note:

The RTE ignores the following types of tags because they are irrelevant or redundant within the RTE context:
  • script tags

  • form elements, such as input, select, textarea, and form

  • frame/frameset

  • document tags, such as html, head, body, meta, and title

  • unknown tags, for example, <foo></foo>

This section describes how to create and edit files using the RTE. It contains the following subsections:

15.2.4.2.1 Creating HTML Documents with the Rich Text Editor

To create HTML documents using the RTE:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to create an HTML document.

  2. Click the Create a new HTML document icon (Figure 15-36).

    Figure 15-36 Create a New HTML Document Icon on Toolbar

    Create a New HTML Document icon

    The RTE opens (Figure 15-37).

    Fields that require a value are marked with an asterisk (*).

  3. In the File Name field, enter a name for the file.

    The editor appends the extension .htm., unless .htm or .html is already specified.

  4. Optionally, enter a description of the file in the Description field.

    Note:

    The Destination field, which appears below the Description field, shows the directory path to the folder where the uploaded document will be stored.
  5. Using the editor, add text, formatting, styling, and links.

    Table 15-4 lists and describes RTE controls.

    Table 15-4 Rich Text Editor Controls

    Control Description

    Select font drop-down menu

    The Font dropdown menu. Select a font, and enter text; or highlight text, and select a font.

    Font Size drop-down menu

    The Font Size selector. Select a size, and enter text; or highlight text, and select a size. Click the up arrow to increase font size. Click the down arrow to lower font size.

    Undo icon

    Ctrl-z

    The Undo icon. Click this icon to back out of the previous change. Change history is cleared when you click Create.

    Redo icon

    Ctrl-y

    The Redo icon. Click this icon to restore the previous change. Change history is cleared when you click Create.

    Clear Styling icon

    The Clear Styling icon. Select text and click the Clear Styling icon to remove all styling, such as font types, font sizes, font weights, and font colors. Note that formats, such as bulleted and indented are not affected.

    Rich Text Editing Mode icon

    The Rich Text Editing Mode icon. Use this control to toggle the editor to Rich Text editing mode. In this mode, you can use the style controls at the top of the editor to design your HTML's look and feel.

    Source Code Editing Mode icon

    The Source Code Editing Mode icon. Use this control to toggle the editor to the source code editing mode. In this mode, you can enter all of your own HTML manually. This includes entering source code for the insertion of images. Source code editing mode assumes you will enter all HTML code manually; therefore, most style controls at the top of the text box are not available in this mode.

    Font Color picker

    Foreground Color selector. Use the selector to apply color to text. Pick a color, and enter text; or highlight text, and select a color.

    Background Color picker

    Background Color selector. Use the selector to highlight text. Select a color, and enter text; or select text and then a color to highlight.

    Bold icon

    The Bold icon. Highlight text, and click this icon; or click this icon, and enter text. Click this icon again to exit Bold.

    Italic icon

    The Italic icon. Highlight text, and click this icon; or click this icon, and enter text. Click this icon again to exit Italic.

    Underline icon

    The Underline icon. Highlight text, and click this icon; or click this icon, and enter text. Click this icon again to exit Underline.

    Subscript icon

    The Subscript icon. Highlight text, and click this icon to convert it to a subscript character (see icon's numeral 2 for example); or click this icon, and enter text. Click this icon again to exit Subscript.

    Superscript icon

    The Superscript icon. Highlight text, and click this icon to convert it to a superscript character (see icon's numeral 2 for example); or click this icon, and enter text. Click this icon again to exit Superscript.

    Strikethrough icon

    The Strikethrough icon. Highlight text, and click this icon to drawn a horizontal line through the middle of text, or click this icon and enter text. Click this icon again to exit Strikethrough.

    Justify Left icon

    The Justify Left icon. To align text left, highlight it and click this icon. You can also click the icon and enter text.

    Justify Center icon

    The Justify Center icon. To center text, highlight it and click this icon. You can also click the icon and enter text.

    Justify Right icon

    The Justify Right icon. To align text right, highlight it and click this icon. You can also click the icon and enter text.

    Justify Full icon

    The Justify Full icon. To align text on both the right and left, highlight it and click this icon. You can also click the icon and enter text.

    Bulleted List icon

    The Bulleted List icon. To create a bulleted list, start a new line, click this icon, and enter text. You can also highlight lines of text and click the icon. Start a new line, and click this icon again to exit. Alternately, exit bullet mode by clicking Enter twice at the end of the last item.

    Numbered List icon

    The Numbered List icon. To create a numbered list, start a new line, click this icon, and enter text. You can also highlight lines of text and click the icon. To exit bullet mode, start a new line and click this icon again. Alternately, exit numbered mode by clicking Enter twice at the end of the last item.

    Outdent icon

    The Outdent icon. To move a block of text left, select it and click this icon.

    Indent icon

    The Indent icon. To move a block of text right, select it and click this icon.

    Link icon

    The Link icon. Copy the target URL, and then click this icon and paste or enter a web address in the resulting dialog. Click OK in the dialog to save the link.

    Remove Link icon

    The Remove Link icon. Highlight linked text and click this icon to remove the link.

    Ctrl-x

    Use this key combination to delete highlighted selections. You can also press the Backspace and Delete keys on your keyboard.


  6. Click Create to save your changes and exit the editor.

15.2.4.2.2 Editing HTML Documents with the Rich Text Editor

You can use the RTE to edit any HTML document that is available in a content repository. The editor is available to the files it was used to create as well as files created with other HTML authoring tools.

Note:

To use the RTE to edit files created with other HTML authoring tools, the HTML files must be well formed (that is, have no unclosed tags) and contain no JavaScript.

The editor recognizes the file extensions htm and html.

In the Documents service, the RTE is available in the Document Manager task flow.

To edit an HTML document using the RTE:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) that contains the HTML document you want to edit.

  2. Check the HTML document out (see Section 15.2.5.5.1, "Checking a File Out"). The document must be checked out before it can be edited to ensure that your work does not conflict with others who may be editing the same file.

  3. Select the HTML document by clicking in its row, and click the Edit with Rich Text Editor icon on the toolbar (Figure 15-38). This icon is inactive until after the file is checked out.

    Figure 15-38 Edit with Rich Text Editor Icon on Toolbar

    Edit with Rich Text Editor icon

    The file opens in the RTE (Figure 15-37). The editor recognizes the file extensions htm and html.

  4. Use the RTE controls (see Table 15-4) to revise the document, or edit the document in Source Code mode to revise the HTML source.

  5. When you complete your revisions, click Check-in and close (Figure 15-39) to save your changes and exit the RTE. To discard your changes, click Cancel and check the file back in.

Figure 15-39 Checking in Edited File and Closing Rich Text Editor

Rich Text Editor: check in file and close

15.2.4.3 Copying and Pasting Files

The Documents service provides three options for copying and pasting files:

  • Toolbar options

  • Menu options

  • Drag-and-drop

    • Dragging and dropping files is equivalent to "move" or "cut/paste".

    • Dragging and dropping while pressing the Ctrl key is equivalent to "copy/paste".

This section describes how to accomplish file copying and pasting using menus and buttons. It contains the following subsections:

15.2.4.3.1 Copying and Pasting Files Using the Toolbar

To copy and paste one or multiple files using the toolbar:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) that contains the file(s) you want to copy.

  2. Locate and select the file(s) you want to copy.

    To select one file without opening it, click within the file row. To select multiple files, Ctrl-click the file rows.

  3. On the toolbar, click the Copy icon (Figure 15-40).

    Figure 15-40 Copy and Paste Icons on Toolbar

    Copy icon
  4. Select the folder where you want to paste the copied file(s).

    To select a folder, click in the folder's row. Clicking on the folder name produces a different result (see Section 15.2.3.2, "Opening Folders").

  5. On the toolbar, click the Paste icon (Figure 15-40).

    The copied file(s) are added to the selected folder.

15.2.4.3.2 Copying and Pasting Files Using a Menu

There are two menus to choose from when copying and pasting: the File menu and a context (right-click) menu.

To copy and paste files using the File menu or a file or folder context menu:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) that contains the file(s) you want to copy.

  2. Locate and select the file(s) you want to copy.

    To select one file without opening it, click in the file row. To select multiple files, Ctrl-click the file rows. Clicking on the file name opens the file (see Section 15.2.3.1, "Opening Files").

  3. Open the File menu and choose Clipboard and then Copy (Figure 15-41).

    Figure 15-41 Copy Command on File Menu

    Copy command on the File menu

    As an alternative, right-click a file icon or in a file row and select Copy (Figure 15-42).

    Figure 15-42 Copy Command on File Context Menu

    Copy command on the file context menu
  4. Select the folder where you want to paste the copied file(s).

    Select a folder by clicking its icon or in its row. Clicking a folder name provides a different result (see Section 15.2.3.2, "Opening Folders").

  5. From the File menu, choose Clipboard and then Paste (Figure 15-43).

    Figure 15-43 Paste Command on File Menu

    Paste command on the File menu

    As an alternative, right-click the target folder icon or in the target folder's row, and select Paste (Figure 15-44).

    Figure 15-44 Paste Command on Folder Context Menu

    Paste command on the folder context menu

    The copied file(s) are added to the selected folder.

15.2.5 Managing Files and Folders

The Documents service provides useful features for managing files and folders. These include tools for navigating the folder hierarchy, creating folders and subfolders; renaming, rearranging, and deleting files and folders; and checking files out and in.

This section discusses the Documents service file and folder management features. It contains the following subsections:

15.2.5.1 Navigating in the Document Manager Task Flow

The Document Manager task flow provides navigational features to assist you in accessing files and folders. For example, you can make a subfolder display as the top-level folder, and then easily navigate back up the folder hierarchy or instantly return to default view.

This section describes how to use the Document Manager task flow navigational features in the following subsections:

15.2.5.1.1 Making a Subfolder the Top Folder

Using task flow navigation features, you can temporarily make a folder of interest the top folder in the folder hierarchy. This enables you to focus more easily on a folder of interest.

When you make a nondefault folder the top folder in the folder hierarchy, all folders that are not contained in the new top folder are hidden. Returning the task flow to its default view or navigating back up the folder hierarchy is easy (see Section 15.2.5.1.2, "Moving Up the Folder Hierarchy").

To make a folder display as the top folder:

  1. Go to the Document Manager task flow, or go to the Documents page (in a personal space or group space), where you want to display a subfolder as the top-level folder.

  2. Locate the folder you want to make the top folder, and click the folder's display name (Figure 15-45).

    Figure 15-45 Meetings Folder Below Main Group Space Folder (WebCenter Spaces)

    Functional Specs folder under the main group space folder
    Description of "Figure 15-45 Meetings Folder Below Main Group Space Folder (WebCenter Spaces)"

    The selected folder is listed as the top-level folder (Figure 15-46). All other folders outside the selected folder are no longer listed.

    Figure 15-46 Meetings Folder Listed as Top Folder (WebCenter Spaces)

    Functional Specs folder listed as top folder
    Description of "Figure 15-46 Meetings Folder Listed as Top Folder (WebCenter Spaces)"

15.2.5.1.2 Moving Up the Folder Hierarchy

When you have temporarily made a subfolder the top folder in the Document Manager task flow, and you want to move further up the folder hierarchy, or back to the default view, you have two options:

  • On the toolbar, click the Go Up icon (Figure 15-47).

    Figure 15-47 Go Up Icon on the Toolbar

    Go Up icon on the document library toolbar

    The task flow view advances up one folder in the folder hierarchy. You can also click the Go to Top icon to advance to the topmost folder in the folder hierarchy.

  • Click the arrow to the left of the current top folder, and select a folder on the list from the resulting pop-up (in Figure 15-48, Philatelists) to move up one folder.

    Figure 15-48 Folder Hierarchy Pop-Up

    Folder hierarchy pop-up

    The task flow view advances up one folder in the folder hierarchy.

15.2.5.2 Creating and Copying Folders

Folders provide a convenient way to organize the content exposed through the Documents service. The Document Manager and Document List Viewer task flows include the capability to display folders, but only the Document Manager task flow includes the capability of creating and copying them. This section describes how to create and copy folders in the Document Manager task flow. It contains the following subsections:

15.2.5.2.1 Creating Folders Using the Create a New Folder Icon

This section describes how to create a folder in the Document Manager task flow.

When you create a folder, it is always listed hierarchically below the folder that was selected when the new folder was created. For example, in Figure 15-49 the FinanceProject folder was selected when the Design Specs and Functional Specs folders were created. The Design Specs folder was selected when the Approved and Pending folders were created.

Figure 15-49 A Hierarchy of Folders

A hierarchy of folders in the document library

To create a folder using the Create a new folder icon:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to create a folder.

  2. Select the folder under which to create the new folder, and click the Create a new folder icon (Figure 15-50) on the toolbar.

    Figure 15-50 Create a New Folder Icon on Toolbar

    Create a new folder icon

    The Create Folder dialog opens (Figure 15-51).

    Figure 15-51 Create Folder Dialog

    Create folder dialog box
  3. In the Folder Name field, enter a name for the folder; for example, Design Specs.

  4. Click Create to create the folder and close the dialog.

The File menu also provides an option for creating a new folder, as does the folder context (right-click) menu. Choose New, then Folder (Figure 15-52).

Figure 15-52 New Folder Command on the File Menu

New Folder command on the File menu
15.2.5.2.2 Copying a Folder and Its Content

When you copy a folder that contains content, such as subfolders and files, the content is copied as well.

To copy a folder and its content:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you will copy a folder and its content.

  2. Select the folder you want to copy, and click the Copy icon (Figure 15-53) on the toolbar.

  3. Select a destination folder where you want to paste the copy, and then click the Paste icon (Figure 15-53) on the toolbar.

    Figure 15-53 Copy and Paste Icons on Toolbar

    Paste icon

    The copied folder and content display in the selected destination folder.

    Copy and Paste commands are also available on the task flow's File menu. Choose Clipboard, then Copy and/or Paste (Figure 15-54).

    Figure 15-54 Copy and Paste Commands on File Menu

    Cut and Paste commands on the File menu

    Additionally, you can find the Copy and Paste commands on the folder context (right-click) menu.

15.2.5.3 Renaming Files and Folders

You can use menus and properties to rename files and folders. For example, on the File menu and on file and folder context (right-click) menus, you can choose Rename. You can also rename a file through its properties.

This section describes how to rename files and folders using the Rename command on a context (right-click) menu and how to rename a file and revise its description through document properties. It contains the following subsections:

15.2.5.3.1 Renaming a File or Folder Through a Menu

To rename a file or folder using a context menu:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) that contains the file or folder you want to rename.

  2. Right-click the file or folder icon or within the file or folder row, and choose Rename.

  3. In the resulting dialog (Figure 15-55), enter a new name in the Name field.

    Figure 15-55 Rename Document Dialog

    Rename Document dialog box
  4. Click Rename button.

15.2.5.3.2 Renaming a File and Revising Its Description Through Properties

To rename a file or revise its description through its properties:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to rename a file or revise its description.

  2. Select a file by clicking in its row.

  3. On the toolbar, click the Properties icon (Figure 15-56).

    Figure 15-56 Properties Icon on the Toolbar

    Properties icon on the Document Library toolbar

    The Document Properties screen opens (Figure 15-57).

    Figure 15-57 Document Properties Screen

    Document Properties page
    Description of "Figure 15-57 Document Properties Screen"

  4. Revise the file name and description as desired, and click OK.

15.2.5.4 Moving Files and Folders

In the Document Manager task flow you can move files and folders into other folders by cutting-and-pasting as well as by dragging-and-dropping. You can use the Clipboard option on the File menu or the Cut and Paste options on the context (right-click) menus to cut and paste files and folders.

To move files and folders by dragging and dropping:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to move files or folders.

  2. Click and hold the object you want to move.

  3. Drag the object over the target folder (Figure 15-58).

    Figure 15-58 Dragging Coffee.png Over Public Folder

    Dragging a file to a folder
  4. Release the object onto the target folder.

15.2.5.5 Checking a File Out or In

When you want to retain exclusive use of a file—for example, when you're editing it—you must check the file out. This prevents a file you are working on from being overwritten. Users can view the file, but they cannot upload a file of the same name into the same folder while the file is checked out.

When you're ready to release the file, you can either check it back in to the content repository or cancel file check-out. Checking a file back in involves uploading the revised file. Cancelling check-out removes the file's checked-out status without requiring a file upload.

File check-out and check-in are available for all files in the Document Manager task flow.

This section describes how to check a file out, cancel file check-out, and check in a file in the following subsections:

15.2.5.5.1 Checking a File Out

To check a file out:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to check out a file.

  2. Select the file you want to check out by clicking in its row.

  3. From the File menu, choose Versioning and then Check Out (Figure 15-59).

    Figure 15-59 Check Out Option on File Menu

    Check Out option on the File menu

    In the Document Manager task flow, a Checked Out icon appears in the file's Status column. Roll your mouse pointer over the icon to see details about the user who has checked the file out (Figure 15-60).

    Figure 15-60 Checked Out Icon with Details

    Checked Out icon

    Tip:

    If the Checked Out icon does not display immediately, click the task flow's Refresh icon.
15.2.5.5.2 Canceling File Check-Out

There may be times when you want to cancel a file check-out without checking a new version of the file in.

To cancel file check-out:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to cancel a file check-out.

  2. Select the checked-out file by clicking in its row.

  3. From the File menu, choose Versioning and then Cancel Check Out (Figure 15-61).

    Figure 15-61 Cancel Check Out Option on File Menu

    Cancel Check Out on the File menu

    The file is no longer checked out. The Checked Out icon no longer appears in the file's Status column in the Document Manager task flow.

15.2.5.5.3 Checking a File In

When you edit an HTML file using the RTE (see Section 15.2.4.2.2, "Editing HTML Documents with the Rich Text Editor"), the RTE provides buttons that you click to check the changed file back in and close the RTE. Thus, for an HTML file that you have edited directly with the RTE, there is no need to separately check the file back in as you cannot exit the RTE without checking the file in, or canceling changes you have made.

On the other hand, if you want to replace the contents of a file that is checked out with the contents of a file that you have saved on your local computer, you can do so by checking the file in, specifying the name of the file that contains the changed content.

To check a file in:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to check a file in.

  2. Select the checked-out file by clicking in its row.

  3. From the File menu, choose Versioning and then Check In (Figure 15-62).

    Figure 15-62 Check In Option on File Menu

    Check In option on the File menu

    The Upload Document screen opens (Figure 15-63).

    Figure 15-63 Upload Document Screen

    Upload Document screen
  4. Click Browse, and navigate to the file that contains the content to replace the contents of the checked-out document. The file name may be different or the same as the name of the checked-out file.

    Note:

    The default maximum size for an uploaded file is 2 GB (to change this limit, see "Changing the Maximum File Upload Size" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter).
  5. Optionally, enter a description in the Description field.

  6. Click Upload.

    The document is uploaded and checked in with the revised content. The Checked Out icon no longer appears in the Status column.

15.2.5.6 Working with File Version Histories

Whenever you upload a file into a folder that already contains a file of the same name, you are given the option to either create a new version or cancel the upload altogether. Every time you or another user completes an upload, a new version is created. (For more information about file upload, see Section 15.2.4.1, "Uploading Files".)

Whenever a file has multiple versions, it also has a version history. Version histories are available for viewing in the Document Manager task flow (Figure 15-64).

View a file's version history to track when a file was last revised, to determine which user revised it, and to delete a particular file version. This section contains the following subsections:

15.2.5.6.1 Viewing a File Version History

To view a file's version history:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to view a file's version history.

  2. Select the file by clicking in its row.

  3. From the File menu, choose Versioning and then Version History (Figure 15-64).

    Figure 15-64 Version History Option Under Versioning on File Menu

    Version History option on the File menu

    The Version History screen opens (Figure 15-65).

    Figure 15-65 Version History Screen

    Version History screen

    To view a particular version, click its ID number in the Version ID column. Depending on both the file and browser type, the file opens on a new browser tab or you will be given the opportunity to download the file.

  4. Click OK to exit the screen and return to the Document Manager task flow.

15.2.5.6.2 Deleting a File Version

When you view Version History, you can also select to delete one or more file versions.

To delete a file version:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to delete a file version.

  2. Select the file by clicking in its row.

  3. From the File menu, choose Versioning and then Version History (Figure 15-64).

    The Version History screen opens (Figure 15-65).

  4. Select the version you want to delete by clicking in its row, and then click Delete (Figure 15-66).

    Figure 15-66 Delete Button on the Version History Screen

    Delete button on the Version History screen
  5. Click OK to exit the screen and return to the Document Manager task flow.

15.2.5.7 Viewing File and Folder Properties

File and folder properties provide access to informational details about a selected file or folder. You can use file properties to rename a file, provide or revise a file description, or obtain a reusable link to the file. Additionally, both file and folder properties provide read-only information about location, type, and create and modification dates. File and folder properties also provide contact points to the users who created or last modified the file or folder.

To view file and folder properties:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to view file and folder properties.

  2. Select the file or folder whose properties you want to view, and click the Properties icon on the toolbar (Figure 15-67).

    Figure 15-67 Properties Icon on Toolbar

    Document Properties icon

    The Document Properties (Figure 15-68) or Folder Properties screen opens:

    Figure 15-68 Document Properties Screen

    Document Properties page
    Description of "Figure 15-68 Document Properties Screen"

  3. Click OK to exit the Document Properties or Folder Properties screen and return to the Document Manager task flow.

15.2.5.8 Deleting Files and Folders

When you delete a folder, all the subfolders and files the folder contains are also deleted in the content repository. You can use both the toolbar and menu options in the Document Manager task flow to delete files and folders. This section describes how to delete files and folders using the Delete icon on the toolbar.

Note:

The root folder of the task flow cannot be deleted.

To delete files and folders:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to delete files and folders.

  2. Select the file or folder you want to delete by clicking its icon or in its row.

    To make multiple selections, Ctrl-click each selection.

  3. On the toolbar, click the Delete icon (Figure 15-69).

    Figure 15-69 Delete Icon on Toolbar

    Delete icon
  4. Click Delete in the confirmation dialog.

    Your selection is deleted.

The File menu and the file and folder context (right-click) menus also provide a Delete option.

15.2.5.9 Reviewing and Collaborating on Documents

Oracle AutoVue, packaged separately from WebCenter Spaces, integrates easily with an Oracle Content Server back-end to provide document review and collaboration features. When AutoVue is installed on Oracle Content Server, it is exposed through the Document Manager task flow as an icon in the Document Manager toolbar (Figure 15-70).

Figure 15-70 AutoVue Icon

AutoVue icon

Additionally, options appear on both the File menu and the file context menu.

Select a file, and click the AutoVue icon (or from the File menu, select AutoVue) to open the file in the AutoView file viewer, where you can provide comments and individualized mark-up.

AutoVue supports a wide range of file types, including Word, Excel, PDF, as well as 2D and 3D CAD file types. For more information about Oracle AutoVue, see http://www.oracle.com/applications/autovue/index.html.

15.2.6 Sharing Content

Making content available to multiple users allows for sharing and collaboration. In the context of the WebCenter Spaces application, or custom WebCenter applications, this is easy to accomplish.

To share content:

  1. Add the content to a page:

  2. Make the page containing the task flow available to other users (see Section 5.7, "Setting and Revoking Page Access Permissions").

  3. Notify users with valid permissions that they can update the file by checking it out and in (see Section 15.2.5.5, "Checking a File Out or In").

15.2.7 Running Document Searches

In addition to the WebCenter Search service, which searches a particular space or across the entire application (see Chapter 25, "Working with the Search Service"), the Documents service provides its own search engine for file searches. A Documents service search saves time and increases the relevancy of results by narrowing the scope of a search to files.

In WebCenter Spaces, the document search searches within a specific group or personal space root folder. Within a custom WebCenter application, the document search searches through all files to which you have access.

The document search feature is exposed in the Document Manager task flow. It provides two levels of search: Basic and Advanced. This section contains the following subsections:

15.2.7.1 Running a Basic Document Search

A basic document search searches by full or partial names of files. For information about including file content in a search, see Section 15.2.7.2, "Running an Advanced Document Search."

To perform a basic document search:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to search for a particular file.

  2. Enter a search term in the search field (Figure 15-71).

    Figure 15-71 Document Manager Task Flow Search Field

    Document Library Search field

    For example, enter a full or partial name of a file.

  3. Click the Search icon.

    Results of matching file names display on the search results screen, with Displaying Search Results indicated at the bottom (Figure 15-72).

    Figure 15-72 Search Results in Document Manager Task Flow

    Document search results

    Look in the Location column to determine where a file or folder is located. Alternatively, click the file display name to open it from the search results screen.

  4. Click Reset to clear the search field and return to the Document Manager task flow default display.

15.2.7.2 Running an Advanced Document Search

The advanced document search goes further than the basic search by including searches against file content, dates, and users. Additionally, you can narrow your search to a particular folder.

To perform an advanced document search:

  1. Go to the Document Manager task flow on a page or go to the Documents page (in a personal space or group space) where you want to perform an advanced document search.

  2. Click Advanced next to the Search field.

    The Advanced Search screen opens (Figure 15-73).

    Figure 15-73 Advanced Search Screen in Document Manager Task Flow

    Advanced Search panel in the Document Library
    Description of "Figure 15-73 Advanced Search Screen in Document Manager Task Flow"

  3. Enter search terms in one or more of the default fields:

    • File Name—Enter a full or partial file name.

    • Search Content For—Enter a term to search for in the content of any files in the Document Manager task flow.

      • A term is one or more words.

      • If multiple words are specified, separated by a character space, the words are implicitly "AND'ed" together. That is, they must both appear in a given search result.

      • Terms may also be "OR'ed" with explicit use of the OR keyword. One or the other of the specified terms must appear in a given search result.

      • AND has higher precedence than OR.

      • Special characters (such as a single quotation mark ('), a double quotation mark ("), or a hyphen (-) ) are not valid in a search term.

      Table 15-5 shows examples of valid search syntax with Java Content Repositories (all supported content repositories are JCRs):

      Table 15-5 Search String Examples

      Search String Search Results Return All Occurrences of...

      Oracle

      Oracle

      Oracle WebCenter

      Oracle and WebCenter

      Oracle OR WebCenter

      Oracle or WebCenter

      Oracle WebCenter OR Spaces

      (Oracle and WebCenter) or Spaces (note the precedence rule)


    • Look In—Click the Browse icon to open a list of content repository folders. Select one of these to narrow your search to the selected folder.

  4. Optionally, select additional search criteria from the Add Fields dropdown list (Figure 15-74).

    Figure 15-74 Add Fields Dropdown List

    Add Fields drop-down list

    Add all or any of the following by selecting it from the list:

    • Dates—Adds search fields for Date Created and Date Last Modified. You can modify the dates search criteria by selecting a modifier from the Date Operators dropdown list (Figure 15-75).

      Figure 15-75 Date Operators Dropdown List

      Date Operators drop-down list

      Select to search for an exact date (is), a following date (is after), a preceding date (is before), or a date between two other dates (is between). When you select is between, an additional date field is provided for entering the second date (Figure 15-76).

      Figure 15-76 Additional Field for the is between Date Operator

      is between date operator

      Click the Select date icon to select a date in the correct format (mm/dd/yyyy), for example 6/18/2009, or enter a date manually.

    • Users—Adds search fields for Created By (user who uploaded) and Last Modified By (Figure 15-77).

      Figure 15-77 Users Search Fields

      Remove icon

      Enter a user name for the creator or modifier, or click the Browse icon to the right of each field, to select from a list of users or to search for a user name. Enter—minimally—two consecutive characters from the name of your search target (the search term do finds both condoleeza and doug). Click Search, and all names matching your search criteria appear in the results area.

      Note:

      In the WebCenter Spaces application, when you search documents in a group space, the user selection list and the user search find user names for current members of the group space.

    To remove added fields, click the Remove icon.

  5. Click Search to execute the advanced search.

    Results display in the task flow content area. Click Reset to clear the search criteria and return the Document Manager task flow to its default view.

15.3 Personalizing and Customizing Documents Service Task Flows

The Documents service supports personalizations and customizations that enable you to control task flow content and display. This section contains the following subsections:

15.3.1 What You Should Know About Personalizing and Customizing

The main difference between personalizing and customizing Documents service task flows is the scope of people affected by such changes: personalization affects only your view of a task flow instance; customization affects all users' views.

Personalization is available to the two Documents service task flows that have a View menu: the Document Manager task flow and the Document List Viewer task flow. Use personalizations to change your own view of the task flow. See Section 15.3.2, "Personalizing Documents Service Task Flows."

Customization is available to the Documents service task flows that have an Edit icon: the Content Presenter task flow and the Document List Viewer task flow, and affects the display of files and folders in all users' views. See Section 15.3.3, "Customizing Documents Service Task Flows."

15.3.2 Personalizing Documents Service Task Flows

You can personalize your own view of the Document Manager and Document List Viewer task flows by hiding or showing columns and by rearranging the list of documents according to the sort order of a particular column:

15.3.2.1 Hiding and Showing Columns

Hiding and showing one or more informational columns is useful for simplifying or expanding the details that are displayed with files and folders.

To hide or show informational columns in your unique view of a task flow:

  1. In a Document Manager or Document List Viewer task flow, open the View menu, and click Columns (Figure 15-78).

    Figure 15-78 View Menu in Document Manager Task Flow

    Document Manager task flow View menu
  2. Select or clear individual columns to show or hide them, or select Show All to display all available columns.

    If changes do not display immediately, click the task flow's Refresh content icon (Figure 15-79).

    Figure 15-79 Refresh Icon in Document List Viewer Task Flow for Group Space Documents (WebCenter Spaces Only)

    Refresh icon on Personal Documents

15.3.2.2 Reordering Columns

Reordering the informational columns is useful for prioritizing the details that are displayed with files and folders, depending on the information in which you are most interested.

To reorder the informational columns in your unique view of a task flow:

  1. In a Document Manager or Document List Viewer task flow, open the View menu, and click Reorder Columns.

    The Reorder Columns dialog opens (Figure 15-80).

    Figure 15-80 Reorder Columns Dialog

    Reorder Columns dialog box
  2. Select or clear one or more columns, then click the reorder icons to rearrange the order of the columns in the task flow.

15.3.2.3 Sorting Files and Folders

Sorting columns enables you to quickly rearrange the order of the content in a Document Manager or Document List Viewer task flow. Each task flow column provides a one-click sorting feature that you can use to instantly rearrange all task flow content according to the ascending (1, 2, 3, A, B, C) or descending (C, B, A, 3, 2, 1) order of a particular column.

To sort files and folders in your unique view of a task flow:

  1. In a Document Manager or Document List Viewer task flow, move your cursor over the header of the column you want to use to sort files and folders.

  2. Click the Sort Ascending icon to sort the column in ascending order (1, 2, 3, A, B, C, or smallest to largest), or click the Sort Descending icon to sort the column in descending order (C, B, A, 3, 2, 1, or largest to smallest) (Figure 15-81).

    Figure 15-81 Sort Ascending and Sort Descending Icons

    Sort Ascending and Descending icons
    Description of "Figure 15-81 Sort Ascending and Sort Descending Icons"

    In the Document Manager task flow, the sorting icons display by default on the Name column. For other columns, the icons display when you hover your mouse pointer over the column name.

15.3.3 Customizing Documents Service Task Flows

You can customize the display of files and folders in the Content Presenter or Document List Viewer task flows for all users by the results of an advanced document search, or specify the initial folder content to display when a user accesses the task flow.

Note:

With sufficient privileges, you can also customize Documents service task flows using task flow properties to display or hide any subfolders in the selected folder, change the target location, or add filtering criteria. For general information about setting component properties, such as task flow properties, see Section 7.5, "Setting Properties on Page Content". For specific information about setting Documents service task flow properties, refer to Section 15.4, "Setting Documents Service Task Flow Properties".

To customize the display of files and folders in all users' views:

  1. In the Content Presenter or Document List Viewer task flow, click the Edit icon in the task flow header (Figure 15-82).

    Figure 15-82 Edit Icon in a Document List Viewer Task Flow in Oracle Composer

    Edit icon on a Personal Documents task flow

    For a Content Presenter task flow, the Content Presenter Configuration dialog displays (Figure 15-20).

    Figure 15-83 Content Presenter Configuration Dialog

    Content Presenter Configuration dialog

    For a Document List Viewer task flow, customization settings display (Figure 15-84).

    Figure 15-84 Customization Settings in Document List Viewer Task Flow

    Customization settings in Document Library - List View
  2. For a Content Presenter task flow, refer to Section 15.2.2, "Displaying Content Using the Content Presenter Task Flow" for information about customizing the content shown in the Content Presenter task flow.

    For a Document List Viewer task flow, select a customization method:

    • Results of a Document Search. Enter an advanced document search, and click Save. For more information, see Section 15.2.7.2, "Running an Advanced Document Search."

      In Oracle Composer, click Save and then Close to return to page view mode and view the results in the task flow.

    • Content from a Selected Folder (folders are displayed in the task flow pane only when the task flow is configured to display folders; that is, its Show Folders property is set to true). Click the Browse icon, navigate to and select the folder with the content you want to initially display in the task flow, then click Save.

      In Oracle Composer, click Save and then Close to return to page view mode and view the content of the selected folder in the task flow.

      Click the breadcrumb links to navigate up the folder hierarchy to the root folder (Figure 15-85).

      Figure 15-85 Breadcrumb Navigation to Folders in a Document List Viewer Task Flow

      Breadcrumbs in a Personal Documents task flow

15.4 Setting Documents Service Task Flow Properties

Every task flow includes a set of configurable properties that influence the behavior, content, and look-and-feel of a given task flow instance. You can access these properties through the Component Properties dialog in Oracle Composer (Figure 15-86). The method for accessing task flow properties is the same from task flow to task flow. For more information, see Section 7.5, "Setting Properties on Page Content."

Figure 15-86 Document List Viewer Task Flow for Personal Documents Component Properties

Task flow properties in the Properties panel

Enter or select property values, or to use a dynamic computation for your property value, click the Edit icon next to a property field to open an Expression Language (EL) editor to select a preformatted EL expression or to enter any value or construct your own EL expression. For more information, see Section 7.5.5, "Using Expression Language (EL) Expressions with Component Properties."

Note:

Enter property values either unwrapped or wrapped in Expression Language syntax, for example, value or #{'value'}. If you enter value, Oracle Composer automatically wraps it in EL syntax when you save your changes.

The properties listed on the Parameters tab Component Properties dialog control the default task flow content and facilitate the wiring of the task flow to page parameters and page definition variables. Parameters are unique to the task flow type. For information about wiring pages and components, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components."

The properties unique to the Documents service are described in the following sections:

15.4.1 Setting Content Presenter Task Flow Properties on the Parameters Tab

To select the content and template for a Content Presenter task flow instance on a page, use the Content Presenter Configuration dialog (as described in Section 15.2.2, "Displaying Content Using the Content Presenter Task Flow").

The Content Presenter properties (exposed on the Parameters tab of the Component Properties dialog) are intended for use at design time by developers creating a custom WebCenter application (see "Adding Documents Service Task Flows at Design Time" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter), or for advanced users who want to bind a parameter to an EL expression. If you modify a property value in the Component Properties dialog, the new value overrides the value specified in the Content Presenter Configuration dialog, and that value becomes read-only in the Content Presenter Configuration dialog.

Table 15-6 describes the Content Presenter task flow properties on the Parameters tab of the Component Properties dialog.

Table 15-6 Content Presenter Task Flow Properties: Parameters Tab

Task Flow Parameter Type Description Default Value

Data Source

String

Optional. The data source of the content. The value depends on the value of Data Source Type:

When Data Source Type=dsTypeSingleNode: set Data Source to a single node identifier in the format: connection_name#dDocName:content_id

When Data Source Type= dsTypeFolderContents: set Data Source to a single node identifier in the format: connection_name#dCollectionID:collection_id

When Data Source Type= dsTypeQueryExpression: set Data Source to a search expression.

When Data Source Type= dsTypeMultiNode: set Data Source to a set of comma-delimited node identifiers in the format: connection_name#dDocName:content_id, connection_name#dDocName:content_id, ...

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 the Oracle Content Server.

collection_id = the dCollectionID found in the URL for the folder information page in Oracle Content Server.

Examples:

When Data Source Type=dsTypeSingleNode: myconnection.us.oracle.com#dDocName:STANL18_IDC-007619

When Data Source Type= dsTypeFolderContents: myconnection.us.oracle.com#dCollectionID:45535

When Data Source Type= dsTypeQueryExpression: cm_objectClass == \'IDC:GlobalProfile\' && dDocTitle like \'Big\'

When Data Source Type= dsTypeMultiNode: myconn#dDocName:DOCUMENT_ID_12345,myconn#dDocName:DOCUMENT_ID_56789

None

Data Source Type

String

Optional. The data source type of the content. Corresponds to the Content Source value in the Content Presenter Configuration dialog. 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.

None

Maximum Results

long

Optional. The maximum number of results to display when Data Source Type is dsTypeQueryExpression. This value can be null.

null

Task Flow Instance ID

String

The unique identifier of the selected task flow, used internally to maintain the association of the task flow instance with its customization and personalization settings. Do not edit this value.

None

Template Category ID

Long

Optional. The display template category ID to use in rendering results for multiple content items. Enter the category ID of a template that is configured in the <content-list-templates> section of templates-registry.xml. See "Creating Custom Templates for Displaying Content Using Content Presenter" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.

None

Template View ID

Long

Optional. 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 <content-templates> section of templates-registry.xml. See "Creating Custom Templates for Displaying Content Using Content Presenter" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.

None


15.4.2 Setting Document Manager Task Flow Properties on the Parameters Tab

Table 15-7 describes the Document Manager task flow properties on the Parameters tab of the Component Properties dialog.

Table 15-7 Document Manager Task Flow Properties: Parameters Tab

Task Flow Parameter Type Description Default Value

Connection Name

String

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

When you want to change the Connection Name property for a Documents service task flow, the value must be the name of one of the content repository nodes under All Documents.

Example: ${'MyContent'}

The connection selected as default in the Create Content Repository Connection dialog box by the application developer.

Start Folder Path

String

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

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

To obtain a folder path, go to the Document Manager task flow, right-click the folder icon of the folder you want to use as the start folder, and select Properties. The full path is the first piece of information at the top of Folder Properties.

Example: /Manuals

The root folder of the content repository configured with the specified connection


15.4.3 Setting Document List Viewer Task Flow Properties on the Parameters Tab

Table 15-8 describes the Document List Viewer task flow properties on the Parameters tab of the Component Properties dialog.

Table 15-8 Document List Viewer Task Flow Properties: Parameters Tab

Task Flow Parameter Type Description Default Value

Connection Name

String

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

When you want to change the Connection Name property for a Documents service task flow, the value must be the name of one of the content repository nodes under All Documents.

Example: ${'MyContent'}

The connection selected as default in the Create Content Repository Connection dialog box by the application developer.

Created After

String

Optional. Limit the display of task flow content to files and folders created after a specified date and time. If no value is entered, then no "after" filtering using the creation date is applied.

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZ

For example:

2009-11-17T18:24:36.000+01:00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Created Before

String

Optional. Limit the display of task flow content to files and folders created before a specified date and time. If no value is supplied, then no "before" filtering using the creation date is applied.

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZ

For example:

2009-11-17T18:24:36.000+01:00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Creator

String

Optional. Limit the display of task flow content to files and folders created by a particular user. Enter the user name as specified by the user's login credentials (for example, monty). If no value is entered, then documents created by any user are shown.

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

For example: ${'monty'}

None

Last Modified After

String

Optional. Limit the display of task flow content to files and folders last modified after a specified date and time.

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZD

For example:

2009-11-17T18:24:36.000+01.00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Last Modified Before

String

Optional. Limit the display of task flow content to files and folders modified before the specified date and time. If no value is entered, then no "before" filtering using the last modification date is applied.

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZD

For example:

2009-11-17T18:24:36.000+01:00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Last Modifier

String

Optional. Limit the display of task flow content to files and folders last modified by the specified user(s). Enter the user name(s) as specified by the user login credentials, separated by a space. If no value is entered, then all modified documents are shown.

For example: monty monica

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Root Folder Path

String

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

This property 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 group space's default root folder and when you want to display content from another group space.

For example

  • /PersonalSpaces/monty/Public

  • /WebCenterB5/Proj_X/Specs

The root folder of the content repository configured with the specified connection.

Show Folders

Boolean

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

  • true: folders are shown along with files

  • false (default): folders are hidden and only files appear in the task flow

false

Task Flow Instance ID

String

The unique identifier of the selected task flow, used internally to maintain the association of the task flow instance with its customization and personalization settings. Do not edit this value.

None


15.4.4 Setting Recent Documents Task Flow Properties on the Parameters Tab

Table 15-9 describes the Recent Documents task flow properties on the Parameters tab. of the Component Properties dialog.

Table 15-9 Recent Documents Task Flow Properties: Parameters Tab

Task Flow Parameter Type Description Default Value

Connection Name

String

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

When you want to change the Connection Name property for a Documents service task flow, the value must be the name of one of the content repository nodes under All Documents.

Example: ${'MyContent'}

The connection selected as default in the Create Content Repository Connection dialog box by the application developer.

Group Space

String

(used in WebCenter Spaces only) Optional. The name of a group space for which to display the documents recently modified or created.

None

Last Modified After

String

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

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZ

For example:

2009-11-17T18:24:36.000+01.00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

3 months prior to the current date

Last Modified Before

String

Optional. Limit the display of task flow content to files and folders modified before the specified date and time. If no value is entered, then no "before" filtering using the last modification date is applied.

The value requires the following format:

yyyy-mm-ddThh:mm:ss.sssTZ

For example:

2009-11-17T18:24:36.000+01:00

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Last Modifier

String

Optional. Limit the display of task flow content to files and folders last modified by any of the specified users. Enter the user name(s) as specified by the user login credentials, separated by a space. If no value is entered, then all modified documents are shown.

For example: monty monica

This property is available for contextual wiring. For more information, see Chapter 8, "Wiring Pages, Task Flows, Portlets, and UI Components".

None

Maximum Documents

Long

Optional. Limit the number of files displayed to the specified maximum. If no value is entered, then all matching files are shown.

For example: 10

null

Most Recent First

Boolean

Optional. The default sort order of files in the task flow:

  • true (default): the most recent documents are listed first.

  • false: the oldest documents are listed first.

true


15.4.5 Setting Documents Service Properties on the Display Options Tab

The properties on the Display Options tabs control the selections offered on the task flow chrome, and the display elements that surround task flow content and are common to all task flows. For more information, see Section 7.5.4, "Working with Component Display Options."

15.4.5.1 Setting Individual Document Properties

When you add a single document to a page, such as an image or an HTML document, the properties on the Display Options tab are unique to the item added to the page, as described in the following tables:

Table 15-10 Image Item Properties: Display Options

Properties Description

Image Map Type

Values for indicating the map type when the selected file is an image map. Choose from:

  • none

  • server

Long Desc URL

URL to a file containing a description of image. For example:

http://www.abc.com/image_desc.htm

Short Desc

See Table 7-1.

Source

Path to the file relative to the application root. For example:

/resources/images/cologo.gif

Show Component

See Table 7-1.


Table 15-11 Link Item Properties: Display Options

Properties Description

Title

Display name of the selected file.

Default: file name.

Destination

Path to the file relative to the application root. For example:

/resources/images/cologo.gif

Open in a new window

Select where the file opens:

  • Checked: open file in new browser tab or window.

  • Cleared: open file in current browser window.

This option is relevant only to files that open in your browser. Some files, such as Microsoft Word files, open in their native applications.

Show Component

See Table 7-1.


Table 15-12 Inline Frame (IFRAME) Item Properties: Display Options

Properties Description

Short Desc

See Table 7-1.

Source

Path to the file relative to the application root. For example:

/resources/images/cologo.gif

Show Component

See Table 7-1.


15.4.6 Setting Other Documents Service Properties

The Style and Content Style tabs display properties that define the appearance of the content. These settings override style information defined for the parent components of the selected component instance. Parent components can include a component that wraps the component instance, the page that contains the component instance, or the entire application. For more information about each property, see Section 7.5.6, "Working with Style and Content Style Properties."

The contents of the Events tab depend on the events supported by the task flow. For more information, see Section 7.5.7, "Working with Component Contextual Events"