Checking Out Doclets

This topic applies to Office-based doclets of all types, including reference and supplemental. Unless otherwise noted, the term doclets refers to all Office-based doclet types.

When you check out a doclet, reference doclet, or Office-based supplemental doclet, it is locked so that nobody else can modify it.

Note:

In Oracle Smart View for Office, you can only download non-Office-based supplemental doclets. To check out non-Office supplemental doclets, use the Oracle Enterprise Performance Reporting Cloud web interface.

Before you begin this procedure, you should have already launched an Office application, connected to Oracle Enterprise Performance Reporting Cloud, and opened a report package, as described in Connecting to Enterprise Performance Reporting in Smart View.

To check out a doclet, reference doclet, or supplemental doclet:

  1. In the Report Center, select the doclet to check out.

    Only doclets, reference doclets, and Office-based supplemental doclets can be checked out.

    The Word-based report package shown in Figure 18-9 contains a variety of doclet types, including doclets, Excel-based reference doclets, Word-, Excel-, and PowerPoint-based supplemental doclets, and supplemental doclets of type TXT, PDF, and ZIP. Note the following icons in the Report Center:

    • Icon for doclet indicates a doclet

    • Icon for reference doclet indicates a reference doclet

    • Icon for supplemental doclet indicates a supplemental doclet

    Figure 18-9 Report Package Containing Doclets, Reference Doclets, and Supplemental Doclets


    An example report package containing a mix of doclets, Excel-based reference doclets, Office-based supplemental doclets, and supplemental doclets of file type TXT, ZIP, and PDF
  2. Double-click the doclet name to open.

    The Performance Reporting ribbon is displayed in the Office application when you open:

    • A doclet

    • A reference doclet

    • An Office-based supplemental doclet

    Figure 18-10 shows the Performance Reporting ribbon for the author phase, in the initial state, before the doclet is checked out.

    Figure 18-10 Performance Reporting Ribbon for Doclet in Author Phase in Initial Unchecked-Out State


    Performance Reporting ribbon for doclet during the Author phase in the initial, unchecked-out state.

    Note:

    The availability of buttons in the Performance Reporting ribbon depends on the permissions that are assigned to you; the phase that you are in—authoring, review, or sign off; and the operation you are performing.

  3. Click Check Out.

    Note:

    If an Office-based doclet of any type is already checked out by another user, then the Check Out button is disabled.

    The selected doclet is now locked for your use. You can work with it directly in Smart View while connected to Oracle Enterprise Performance Reporting Cloud.

    In the doclet responsibilities list in the Smart View Panel, a lock icon and the user name are displayed for the doclet or supplemental doclet that is checked out.


    Doclet in a doclet responsibilities list in the Smart View Panel, showing a lock on the doclet icon, and the name of the user who has checked out the doclet.

    In the Performance Reporting ribbon, the Check Out button is replaced with the Cancel Checkout button, and the Embed button is added.

    Figure 18-11 shows the Performance Reporting ribbon for the author phase, after the doclet is checked out.

    Figure 18-11 Performance Reporting Ribbon for Doclet in Author Phase in Checked-Out State


    Performance Reporting ribbon for doclet during the Author phase in the checked-out state.

    Next steps for working with the checked-out doclets in Oracle Enterprise Performance Reporting Cloud:

    • You can undo, or cancel, the checkout if you want to remove your lock on the doclet. Undoing the checkout allows other users to check out and update the doclet. See Undoing Checkouts.

    • If you must close Office before you are finished with your authoring changes, you do not need to check in the doclet, but you must upload it to retain the changes in progress. See Uploading and Working with Page Attributes and Slide Masters.

    • You can download the Office-based file and work with it offline, as described in Working with Doclets Locally.