1. User's Guide
  2. Smart View and Narrative Reporting
  3. Authoring Doclets
  4. Working with Embedded Content from Reference Doclets
  5. Embedding Content in a Doclet

Embedding Content in a Doclet

Now that Excel- and Reports-based reference doclets are added to a report package, report content has been created and named ranges defined, and available content has been identified, this content can be embedded. You can embed content in Word or PowerPoint doclets. For example, among the available content in the report package, there may be a chart, grid, Note, or Text box that an author wants to add to a doclet.

Note:

Before you begin, ensure that the doclet author phase is initiated.

To embed content in a doclet:

  1. Open the doclet and check it out.
    We'll call the doclet our "target" doclet.
  2. Place the cursor at the point in the target doclet where the embedded content should be inserted.

    In Figure 22-21, the solid green arrow shows the insertion point for the embedded content in a Word doclet.

    Figure 22-21 Example Target Word Doclet with Cursor at Insertion Point

    A portion of a Word doclet, showing an arrow pointing at a paragraph marker. This is where the content will be embedded.

    In a PowerPoint slide, depending on the slide format, you may be embedding a table or graph onto a slide containing no other text or graphics. In that case, you can simply click anywhere in the slide. If your embedded content must be inserted at a certain point in a slide within text, then position the cursor at the insertion point, as shown in Figure 22-22

    Figure 22-22 Example Target PowerPoint Doclet with Cursor at Insertion Point


    A portion of a PowerPoint doclet, showing the cursor with an arrow pointing at it. This is where the content will be embedded.
  3. From the target doclet, click the Embed button in the Narrative Reporting ribbon.
    embed button in the Performance Reporting ribbon

    The Embed Contents dialog box is launched.

  4. Optional: Select a filter option to narrow the list of available content:
    • All—The default. Shows all available content.
    • Current Doclet—Displays available content from any reference files that are registered with the current doclet.

    • Reference Doclets—Displays available content from all reference doclets in the report package.

    • Hide Embedded—Hides available content that has already been embedded in the current doclet.

    The Embed Contents dialog showing the filtering options, All, Current Doclet, Reference Doclets, and Hide Embedded
  5. Optional: Enter a term in the Search field and click the magnifying glass icon to narrow the list of available content.

    Note:

    Wildcards are not required. Narrative Reporting searches for the term any where in the available content name.


    The Embed Contents dialog with the term, sum, entered in the search field and the magnifying glass icon displayed

    In the above example, we entered the term, sum. Narrative Reporting searches for and returns all available content that contains sum anywhere in the content name.

    Note that when you click the magnifying glass icon, it changes to an X:


    Search field dislayiing the X icon

    Use the X icon in the Search field to clear the search term and return the list of available content to the original state.

    Note:

    You can also use the filtering options (described in the previous step) on the search results.

  6. In Embed Contents, select the available content to embed.

    Optionally, click the Show Preview button to view a preview of the selected available content, as described in Previewing Available Content

    In the example in Figure 22-23, we see both Excel- and Reports-based content in the list. We'll select Summary Income Statement, which happens to be Reports-based content.

    Figure 22-23 Embed Contents Dialog Box

    The Embed Contents dialog box with Summary Income Statement selected.
  7. Click OK.

    The selected available content is inserted, or embedded, into the doclet.

    Note:

    In PowerPoint, you can relocate and resize the embedded content on the slide. Once resized, the revised height of the image on the slide is retained on refresh, and the refreshed image will have the same aspect ratio as the source object.

    An example of embedded content in a Word doclet is shown in Figure 22-24. This figure assumes that in the Home ribbon in Word, the Show/Hide button in the Paragraph group is enabled.

    Figure 22-24 Example Target Doclet After Embedding Content

    The selected available content is embedded in the doclet

    Note any extra blank paragraph markers before and outside of the embedded content. You can delete any extra markers to give the doclet a more polished look, if required.

  8. Optional: Select an embedded content on the doclet to view its available content name, as described in Viewing Available Content Name in Doclets.
  9. Repeat the steps above for all content you want to embed in the currently opened and checked-out target doclet.

    Note:

    Embedded content must not overlay or overlap other instances of embedded content.

  10. When your work is completed in the current doclet, upload it, and then check it in.
  11. To refresh embedded content, see Refreshing Embedded Content in a Doclet.

Note:

Word:

  • If you place embedded content at the beginning of a Word doclet (the first line and first space of the Word document), you cannot embed content before the already-embedded content. You may embed content immediately after the already-embedded content, but not before it. To work around this:

    • Delete the embedded content and then re-embed the content in the correct order. To delete the embedded content, add a blank line after the embedded content, then select the blank line along with the embedded content, then right-click and select Remove Content Control from the context menu. Next, select the blank line and embedded content again, and then press Delete.

    • Place a blank line at the beginning of the Word document to ensure that, if necessary, you can insert embedded content before the first instance of embedded content.

  • If you embed content consisting of a multiple line grid at the beginning of a Word doclet (the first line and first space of the Word document), you cannot delete only the embedded content. Note that you can delete a single line grid that was embedded at the beginning of a Word doclet.

    To work around this, add a blank line after the embedded content, then select the blank line along with the embedded content, then right-click and select Remove Content Control from the context menu. Next, select the blank line and embedded content again, and then press Delete.

PowerPoint:

If you resize the embedded content, the revised height of the image on the slide will be retained on refresh, and the refreshed image will have the same aspect ratio as the source object.