You can find each of the strings for Extensible Document Settings in the Object Lookup dialog. There is a variety of item types that can be used in Extensible Documents, however each one needs to be configured a specific way to process correctly at run-time. An example of each item type’s configuration is provided below. For more details on how to utilize and configure these item types in an Extensible Document, see Extensible Document Framework in Presenting Data With Extensible Documents.
Insert Content Using Document Variables
Cube View Report
To insert a Cube View Report into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{CubeViewReport}{CubeViewName}"
(Optional formatting): “IncludeReportMargins=False” “IncludeReportHeader=False” “IncludeReportFooter=False” “IncludePageHeader=True” “IncludePageFooter=True”
IMPORTANT: Arguments such as the "CubeViewName" are placeholders for Cube Views, Reports, and Files that must be updated.
Example
"{XF}{Application}{CubeViewReport}{CubeViewStatement}"
Excel Sheet
To insert an Excel Sheet into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/ExcelFileName.xfDoc.xlsx}"
(Optional formatting): “ExcelSheet=Sheet1"
IMPORTANT: The specific path to the File in the File Explorer must be included and updated.
Example
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/Excel4.xfDoc.xlsx} "
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/Excel4.xfDoc.xlsx}" "ExcelSheet=Sheet1"
Excel Named Range
To insert an Excel Named Range into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/ExcelFileName.xfDoc.xlsx}"
(Optional formatting): “ExcelNamedRange=SampleNamedRange"
Example
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/Excel5.xfDoc.xlsx} "
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/Excel4.xfDoc.xlsx}" "ExcelNamedRange=NamedRange1"
Microsoft Word Document
To insert a Microsoft Word Document into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/WordFileName.docx}"
Example
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/OneStreamWordDocument.docx}"
Rich Text Document
To insert a Rich Text Document into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/RTFFileName.rtf}"
Example
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/RichTextFormatDoc.rtf}"
Text Document
To insert a Text Document into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/TextFileName.txt}"
Example
"{XF}{Application}{File}{Documents/Public/ExtensibleDocs/TextFileData.txt}"
Report
To insert a Report into an Extensible Document, the following string needs to be updated and pasted when configuring the document variables:
"{XF}{Application}{Report}{ReportComponentName}"
(Optional formatting): “IncludeReportMargins=False” “IncludeReportHeader=False” “IncludeReportFooter=False” “IncludePageHeader=True” “IncludePageFooter=True”
Example
"{XF}{Application}{Report}{Report3}"
NOTE: Parameters and Substitution Variables are not listed under Extensible Document Settings.
Insert Content Using Office Image
Chart/Chart Report
To insert a Chart or Chart Report Dashboard Component into an Extensible Document, the following string needs to be updated and pasted in the Content Control Properties dialog:
{XF}{ItemLocation}{ItemType}{ChartComponentName}
Example
{XF}{Application}{Chart}{Waterfall}
{XF}{Application}{ChartReport}{Waterfall}
NOTE:
Use this for all Chart (Advanced) Dashboard Components.
Cube View Report
To insert a Cube View Report into an Extensible Document, the following string needs to be updated and pasted in the Content Control Properties dialog when configuring the image:
{XF}{Application}{ItemType}{CubeViewName}
Example
{XF}{Application}{CubeViewReport}{BalanceSheetSummary}
Excel Sheet/Excel Named Range
To insert an Excel Sheet or Excel Named Range into an Extensible Document, the following string needs to be updated and pasted in the Content Control Properties dialo when configuring the image:
{XF}{Application}{ItemType}{FilePath}
Example
{XF}{Application}{ExcelFile}{Documents/Users/jsmith/Favorites/VarianceReport.xfDoc.xlsx}
NOTE: For Excel Named Range Item Types, the Excel Named Range Name is configured in the formatting string. (e.g., ExcelNamedRange=TotalAssets)
To insert a PDF into an Extensible Document, the following string needs to be updated and pasted in the Content Control Properties dialog when configuring the image:
{XF}{Application}{ItemType}{FilePath}
Example
{XF}{Application}{FileViaPDF}{Documents/Users/jsmith/Favorites/IS.pdf}
Report
To insert a Report Dashboard Component into an Extensible Document, the following string needs to be updated and pasted in the Content Control Properties dialog when configuring the image:
{XF}{ItemLocation}{ItemType}{ReportComponentName}
Example
{XF}{Application}{Report}{UserTaskActivity}
Rich Text
To insert Rich Text into an Extensible Document, the following string needs to be updated and pasted into the Alt Text Description Field for the specific image:
{XF}{Application}{RichText}{RichTextContent}
(Optional formatting): PageNumber=1, CropLeft=0, CropTop=0, CropWidth=0, CropHeight=0, Zoom=100, MaintainAspectRatio=True, FillMode=Width, Anchor=TopLeft, IncludeBorders=False, BackgroundColor=#FFFFFF, MeasurementUnit=Inch, PageWidth=8.5, PageHeight=11
Example
{XF}{Application}{RichText}{|!Narrative2!|} BackgroundColor=#C1E5F5, PageNumber=1, IncludeBorders=False
NOTE: "Narrative2" is a parameter containing a specific Rich Text. You can also paste the specific rich text format in the string.
Options
The following options are available when formatting Extensible Document Image Content. Each Image Type has a formatting string which is located in the Object Lookup Dialog under Extensible Document Settings|Insert Content in Office Image. The user can copy and paste the desired formatting string into the Description field when configuring the image. If changes need to be made to the string, delete the current option and replace it with the correct one. The list below covers all of the formatting options for each Image Type.
Item Location
Application, System
Item Type
Chart, ChartReport, CubeViewReport, ExcelFile, FileViaPDF, Report
FillMode Options
Width, Height, LargestSide, SmallestSide
Anchor Options
BottomCenter/Left/Right, MiddleCenter/Left/Right, TopCenter/Left/Right
Cropping Options
This allows a user to narrow in on a portion of the image before other settings are applied. The default setting is 0 which means cropping is not being used.
CropLeft, CropTop, CropWidth, CropHeight
XFCell
XFCell is a retrieve function used mainly in text documents such as Microsoft Word or PowerPoint. The specific Dimension details provided in the function obtains a single cell of data from OneStream and displays the updated value on an Extensible Document at run-time. Examples of common XFCell formulas are provided below. See Extensible Document Framework in Presenting Data With Extensible Documents for more details on how to configure XFCells in an Extensible Document.
The following example pulls data for a specific Entity and Account:
XFCell(E#US:A#Sales)
Additional Dimension Members can be added for more specific detail:
XFCell(E#US:A#Sales:T#2014)
NOTE: Any Dimensions not specified in the formula will come from the user’s POV.
Number formatting and scaling can also be added to an XFCell.
The example below is using the number format N3 with a scaling of 6
XFCell(E#US:A#Sales, NumberFormat=N3, Scale=6)
Culture Invariant is a default culture not associated with a specific country. It is typically used when users need to convert a number to a string, but do not want the result to be different if one user is running the string on a French PC and another user is using an English PC.
XFCell(E#US:A#Sales, Culture=Invariant)
Include Member Scripts in XFCells in order to retrieve data for specific Dimension Members. Culture User is based on the computer’s Windows settings and the User settings.
XFCell(Memberscript, Culture=User, NumberFormat=N3, DisplayNoDataAsZero=True, Scale=3, FlipSign=True, ShowPercentageSign=False)
Use Business Rules in Extensible Documents
Business Rules can also be referenced in an XFCell function. The following details need to be updated for this to work correctly.
BR#[BRName, FunctionName=yourFunctionName, Name1=Value1, AnotherName=[AnotherValue]]
Example
BR#[BRName=FMK_Helper, FunctionName=GetUserSetting, SolutionID=MBL, FieldName=[Period]]
