1. User's Guide
  2. Smart View and Narrative Reporting
  3. Authoring Doclets
  4. About the Author Phase Process
  5. About Doclets and Variables

About Doclets and Variables

Report packages are comprised of subcomponents called doclets, reference doclets, reference files, and supplemental doclets. Additionally, variables can be sourced from reference doclets and reference files.

  • Doclets

    Doclets (sometimes referred to as regular doclets) contain the content you require for the report that you’re creating with an Narrative Reporting report package. A report package can consist of one or more doclets. Word-based report packages contain Word-based doclets; PowerPoint-based report packages contain PowerPoint-based doclets. PDF-based report packages contain Word- and Excel-based doclets, along with PDF files; however, only the Word and Excel doclets can be authored.

    Word and PowerPoint documents stored in folders in the Narrative Reporting library can be added to report packages as linked regular doclets. A linked regular doclet maintains a persistent link to the source library document. When the library document is updated, Narrative Reporting automatically updates all doclets linked to the library document. Narrative Reporting continues to update the doclet file until the doclet link is deactivated.

    Doclets participate fully in report package workflow, including all author phases, review phases, sign off, and report publishing.

  • Reference doclets

    Reference doclets can be used as containers to store content such as named ranges from an Excel file, or charts and graphs created from Reports, which are consumed by one or more doclets in a report package.

    Excel-based reference doclets are Excel files that serve as supporting files with content such as Oracle Smart View for Office grids or forms, or static Excel content, that you can register and then embed directly into Word-based doclets. You specify the embeddable content using Excel's Name Manager, then register the named ranges in Smart View.

    Reports-based reference doclets consist of tables and charts created and registered as available content in the Narrative Reporting web interface.

    You can then embed content from either type of reference doclet directly into Word-based doclets. Using the embedding process, the layout and format of the content is maintained in the target doclet just as in the source reference doclet.

    Both Excel- and Reports-based reference doclets can be included in Word-based report packages. Embedded content is merged in the combined report and can be commented on during the review phase.

    In Smart View, Excel-based reference doclets support the content management and workflow features of the author phase as follows:

    • Reference doclets can be checked out, modified, uploaded, checked in, submitted for approval, and approved or rejected.

    • Word-based doclets containing embedded content can be checked out, modified, uploaded, checked in, submitted for approval, and approved or rejected.

    • Embedded content can be synced with updates made to named ranges in the reference doclet.

    • Embedded content can be refreshed.

    The workflow for Reports-based reference doclets is maintained in the Narrative Reporting web interface; however, these content management and workflow features of the author phase are supported in Smart View as follows:

    • Word-based doclets containing embedded content can be checked out, modified, uploaded, checked in, submitted for approval, and approved or rejected.

    • Embedded content can be synced with updates made to named ranges in the reference doclet.

    • Embedded content can be refreshed.

    Note that reference doclets themselves are not available for commenting in the review or sign off phase; however, in a doclet, you can comment on the embedded content that was sourced from reference doclets, and the embedded content is part of the final published report.

  • Reference files

    Reference files are Excel workbooks that contain report content that you can embed into a Word doclet. The reference file is not listed as part of the report package in the same way that doclets, reference doclets, and supplement doclets are. Instead, when you embed content from a reference file into a Word doclet, that reference file becomes part of the properties of the doclet. When you check out the target Word doclet, Narrative Reporting tracks any changes you make to the reference file. You can then refresh the content you have embedded in the target Word doclet.

    Note that reference files themselves are not available for commenting in the review or sign off phase; however, in a Word doclet, you can comment on the embedded content that was sourced from reference files, and the embedded content is part of the final published report.

  • Supplemental doclets

    Supplemental doclets are documents which assist in the development of the overall report, such as source and supporting files. Supplemental doclets can be of Office file types, such as Excel, Word, or PowerPoint; or of non-Office file types, such as PDF, TXT, or ZIP. Content from supplemental doclets is not merged into the combined report.

    Supplemental doclets of any file type can be included in both Word-based and PowerPoint-based report packages. For example, Word-based supplemental doclets can be included in Word- or PowerPoint-based report packages.

    In Smart View, supplemental doclets support the content management and workflow features of the author phase as follows:

    • Office-based supplemental doclets can be checked out, modified, uploaded, checked in, submitted for approval, and approved or rejected.

    • For supplemental doclets of non-Office file types, Smart View gives assigned authors easy access to download and view files. However, any other interactions with the files, such as checkout, upload, and checkin, must be performed through the Narrative Reporting web interface.

    Note that supplemental doclets of any file type are not available for commenting in the review or sign off phase, and they are not part of the final published report.

  • Variables

    Report Package variables provide centralized maintenance of common text, numbers, dates, and data that are displayed in doclets throughout a report package. Variables can also be used to reference content between doclets, such as inserting Excel data from a reference doclet into a Word doclet.

    Two types of variables are available:

    • Static variables use static input that is defined by the user, such as a date labels or a set value, which can be used throughout the report package. These static variables can be easily updated, and all doclet instances of the variable value reflect the change. The static variables help to centrally maintain common dates, numbers and text across the Report Package document content.

    • Reference variables are created by referencing another doclet within the report package as the source, and selecting the value for the variable, such as text in a Word paragraph or an Excel cell value. If the source document is subsequently updated, those changes are automatically updated in the inserted instances of the variable in the report package. Reference variables can be used to insert Excel cell values into a paragraph in a Word doclet, or to create Excel formulas to implement cross-footing rules for increased data accuracy, or to create directional words for the report narrative, such as "an increase" or "a decrease".