30 Integrating the Documents Service

There are several ways to integrate content into a WebCenter Portal: Framework application. For more information, see Chapter 26, "Introduction to Integrating and Publishing Content."

This chapter describes how to integrate the Documents service into a Framework application to both add content to the application, and to provide end users with content and Documents service task flows built into the application to manage, display, and search documents at runtime.

This chapter includes the following sections:

30.1 Introduction to the Documents Service

The Documents service provides features for accessing, adding, and managing folders and files; configuring and viewing file and folder properties; and searching file and folder content in Content Server, Oracle Portal, or SharePoint content repositories. It provides these features through Documents service task flows, document components (links, inline frames, and images), wikis, and blogs.


The availability of SharePoint as a content repository requires the installation of the SharePoint adapter, as described in Section 3.6, "Installing the Oracle WebCenter Adapter for SharePoint." Administration for SharePoint is performed using WLST commands, not Oracle Enterprise Manager Fusion Middleware Control Console.

To integrate the Documents service into a Framework application, your WebCenter Portal administrator must set up a connection to the content repository that contains the documents you want to manage. If the content repository you wish to use requires authentication, ensure that you set up an external application when you configure the connection to your content repository, as discussed in Section 30.2, "Setting Up Connections."

30.2 Setting Up Connections

Before you can use the Documents service and task flows, you must first set up the connection to the Content Server, Oracle Portal, or SharePoint content repository that contains the documents you want to manage. You can reuse connections you've created or create new ones.


While you can set up the connections to back-end servers at design time in Oracle JDeveloper, you can later add, delete, or modify connections in your deployed environment using Enterprise Manager Fusion Middleware Control. For more information, refer to the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter Portal.

The choices made for application security and content repository connection authentication need to be compatible. For example, if the connection is configured to use External Application with only Public credentials defined, then there is no requirement for the application to enforce user authentication. For detailed information about connection configuration, see Section 27.2, "Configuring Content Repository Connections."

30.3 Setting Security for the Documents Service

The Documents service task flows support the same security options that are supported by the content repository connections. This service can also use an external application with dedicated user accounts to access remote content repositories, such as an Oracle Content Server or Oracle Portal. For more information about using security with content repositories, see Section 28.4, "Securing a Content Repository Data Control." For information about using external applications, see Section 69.13, "Working with External Applications."

If you are using a content repository that handles its own authentication, such as Oracle Portal or Oracle Content Server, you can associate that content repository with an external application definition to allow for credential provisioning. You can modify your connection to your content repository to use an external application without shared or public credentials. When you do this, the External Application - Change Password task flow is automatically integrated to allow your end users to provide their credentials.

To register an external application for an existing content repository connection:

  1. In the Application Resources pane, right-click your connection name and choose Properties.

  2. In the Edit Content Repository Connection dialog box, under Authentication, select External Application (Figure 30-1).

    Figure 30-1 Selecting External Application in the Content Repository Connection Dialog

    Selecting External Application
  3. Click the green + (plus) sign to start the Register External Application wizard.

  4. On the Name page, enter an Application Name and Application Display Name, (Figure 30-2) then click Next.

    Figure 30-2 Naming the External Application

    Naming the External Application
  5. On the General page, under Authentication Details, choose BASIC from the Authentication Method list (Figure 30-3), then click Next.

    Figure 30-3 Choosing the BASIC Authentication Method

    Choosing the BASIC Authentication Method
  6. On the Additional Fields page, click Next.

  7. On the Shared Credentials page, click Next.

  8. On the Public Credentials page, select Specify Public Credentials, then enter the Username and Password for the content repository (Figure 30-4).

    Figure 30-4 Specifying the Public Credentials

    Specifying the Public Credentials
  9. Click Finish. You'll notice that your connection now uses the external application for authentication (Figure 30-5).

    Figure 30-5 Using the New External Application

    Using the New External Application
  10. In the Edit Content Repository Connection dialog box, click OK. In the Application Resources panel, you'll notice the external application now displays (Figure 30-6).

    Figure 30-6 External Application in the Application Resources Panel

    External Application in the Application Resources Panel
    Description of "Figure 30-6 External Application in the Application Resources Panel"

If you do not apply security, and the content repository requires a login to access the content, the user will not be able to authenticate, and thus will see only public content at runtime.

30.4 Using the Documents Service with Other WebCenter Services

You can use the Documents service with a variety of other WebCenter services. For example, you can add tags to documents in your content repository, search across your application and retrieve documents in the results, or track recent changes to the content repository.

You can see an example of how to use the Documents service with the Tags service in Section 44.3.3, "Optional Way to Show Tags on Pages."

To learn more about how you can use these services together, refer to Section 2.4, "Introducing Oracle WebCenter Portal: Services."


When you integrate the Documents service with the Search service, the Search service returns results from all content repository connections.

30.5 Setting Parameters to Upload Files to Content Repositories

The Document Manager, Document Explorer, and Folder Viewer task flows allow you to upload files into content repositories. WebCenter Portal: Framework uses Apache MyFaces Trinidad to handle file upload from a browser to the application server.

To change the default settings of Apache MyFaces Trinidad, you can add three parameters to the web.xml file. To edit this file, open the ViewController project of your application. Under Web Content, open the web.xml file. In the Overview, navigate to Application > Context Initialization Parameters, then click the green plus sign (+) to add the parameters and their values (as described in Table 30-1) or simply update the code in the Source view. After you've made your changes, save the web.xml file, then restart Oracle JDeveloper.

Table 30-1 Apache MyFaces Trinidad Parameters

Parameter Description

The maximum amount of memory in bytes that a single file can use when uploaded.


The maximum amount of disk space in bytes that a single file can use when uploaded.


The directory in which the file being uploaded is temporarily stored.

For more information, see the Apache MyFaces Trinidad documentation at http://myfaces.apache.org/trinidad/devguide/fileUpload.html.

30.6 Using Adapters with the Documents Service

To learn more about using existing adapters for the content repository connections, see Chapter 27, "Managing Content Repository Connections."