Registering Reference Files with a Doclet

There is a two-part process for registering a reference file with a checked-out doclet, and then, separately, embedding the available content as needed throughout a doclet.

The procedure in this topic covers registering content from a reference file with a checked-out doclet. See Embedding Reference File Content in a Doclet for instructions on embedding contemt from the registered reference file.

Note:

Before you begin, you should have established ranges in the target reference file, using Excel's Name Manager feature, as described in Defining Named Ranges in Reference Files. The file should be closed when performing the procedure below.

You can also register available content and then embed the content in one procedure. For more information, see Adding Content from Reference Files to Doclets.

To register a reference file with a doclet:

  1. Open the report package.
  2. Open, and then check out the Word doclet to which you want to register a reference file.

    If the Word doclet is already checked out, you can also select the Word doclet in the report package panel, and then click View Properties to open the Properties dialog box.

  3. Click Inspect in the Performance Reporting ribbon to open the Properties dialog box.


    Inspect button in the Performance Reporting ribbon

  4. In Properties , click the Embedded Content tab, Embedded Content tab, and then click the Available Files link.
  5. On Available Files, click Add button for registering a reference file to a doclet, looks like a plus sign, and then on Add Embedded Content File, click The Choose File button.
  6. Navigate to the Excel file to register as a reference file, select it, and click Open.

    The Add Embedded Content File dialog box lists the content "registered" with the doclet in order to be made available for embedding. For example, in Figure 18-20, the Excel file that was selected as a reference file contained three named ranges; therefore, these three named ranges can be registered as available content with the doclet.

    Figure 18-20 The Add Embedded Content File Dialog Box Listing Available Content Items

    The Add Embedded Content File dialog box, showing three ranges from the selected reference file can be registered as available content with the doclet.

    Remember, the available content is content that you specified as named ranges, as described in Defining Named Ranges in Reference Files.

  7. Click the range names that you want to make available for embedding in the doclet.

    The check mark that appears next to the range name shows that the range is now registered with the doclet. For example, in Figure 18-21, we selected all three available ranges to register them with the doclet.

    Figure 18-21 The Add Embedded Content File Dialog Box After Registering Ranges

    The Add Embedded Content File dialog box, showing the three available ranges selected to register them with the doclet
  8. Click Close to close the Add Embedded Content File dialog box.

    You are returned to the Embedded Contents tab of the Properties dialog. The reference file is now registered with the doclet, as shown in

    Figure 18-22 Properties Dialog, Embedded Content Tab, Showing Registered Reference File

    The Properties dialog, Embedded Content tab, listing the reference file that just registered with the doclet

    Note that you can choose to embed content in the doclet at this point, from this dialog box. But this procedure is looking at registering content only. See Embedding Reference File Content in a Doclet for instructions on embedding available content from the registered reference file.