Parameters in Extensible Documents

Using Parameters

You can use parameters and substitution variables as placeholders to enhance extensible documents with selections for time period, entity, data cell values, and more.

In this example, parameters were inserted in places to obtain information from OneStream. The parameters named were created to display the input parameter for the cube view name and entity for this document. When the XF Doc is processed at run-time, it prompts you to select both values.

After selecting parameters, the document displays the desired data. Additionally, you can update content on the parameter and add more narrative to an XF Doc. You can inherit the format of a parameter from where it’s being inserted within a paragraph.

For example, you make edits to your XF Docs by making the text red, bold, and font size 18. Within OneStream Text Editor or Microsoft Word, the values display with the associated "Cube View" requested in the Document Variable field and the text entered appears with the correct font, color and boldness. The newly added Income Statement cube view appears in the report and the second value entered into the XF Doc.

 

“MERGEFORMAT” text can be removed. This simply means, if you insert this in Microsoft Word, it will take the formatting of the previous paragraph or previous range in the paragraph.

Parameter and Substitution Variable Setup in Text Editor

In a new or existing XF Doc:

  1. Within Text Editor, navigate to Insert> Quick Parts> Field.

  2. Remove all existing syntax between the first set of quotes and everything after.

  3. Copy and paste the Parameter or Substitution Variable name with surrounded by quotes; make sure to include standard object syntax.

    NOTE: Ensure to include standard object syntax covers the exclamation points and the pipes around the parameter.

  4. Enable Preserve formatting during updates.

    NOTE: This is an optional setting that will preserve formatting.

  5. Click OK.