FRExecute Syntax

The FRExecute function enables you to embed a Financial Reporting report or report section into a Microsoft Word document. You can include a report, a report type (dynamic or snapshot), or specify selected areas in the report such as a grid, chart, page, text box, text area, or cell. The FRExecute function syntax is as follows:

FRExecute(ReportName[Type={1,2};ComponentType={1,2};ComponentName={Grid1,Grid2,Chart1,Chart2,Chart3};Page={1,2,..;.}Cell=FRFormula}

where:

ReportName is the name of the report.

Type1 is a dynamic report and Type2 is a Snapshot report,

ComponentType1(optional) is a grid and ComponentType2(optional) is a chart.

ComponenentName(optional) is the grid or chart name.

Page(optional) is the page number.

Cell(optional) is the date cell formula. The cell syntax is cell=cell[row,col], or cell=[row,col]

where row is a number >=1 referring to the row in Financial Reporting Studio report designer.

where col is a letter >= A referring to the column in Financial Reporting Studio report designer. If a report has more then 26 columns, two letters are used for those columns (for example, AA, AB, AZ, AAA, AAB, and so on).

Note:

You can specify a ‘sub-tuple’ if the design time row evaluates to more then one tuple. For example, if you reference row 2, which has a member selection “Children of Market” resulting in four children (East, West, South, Central), the sum of all four tuples are returned. You can also refer to individual tuples like this: Cell[2(1),A] referring to East/ColA; Cell[2(3),A] referring to South/ColA.

Note:

To limit the size of the report, place the FRExecute function inside a Microsoft Word text box.

The following example returns the entire report with dynamic values:

FRExecute(ReportName;Type=1)

The following example returns page 2 of a dynamic report.

FRExecute(ReportName;Type=1ComponentType=1'ComponentName=Grid2;Page=2)

The following example returns a dynamic report with all pages:

FRExecute(ReportName;Type=1;ComponentName=Grid2)

The following example returns a data cell on Page 2. If page is not selected, then first page's data cell is returned.

FRExecute(reportFullName; Type=1; ComponentType=1;ComponentName=Grid2;Page=2; Cell=Cell[2,B])

FRExecute(reportFullName; Type=1; ComponentType=1;ComponentName=Grid2;Page=2; Cell=[2,B])

This example returns a chart on page 2. If page is not selected, then chart1 on all pages are returned.

FRExecute(reportFullName; Type=1; ComponentType=2;ComponentName=Chart1;Page=2)

Note:

In an html document or word document, "FRExecute" (including lower case, upper case or mixed) is the keyword of FRExecute command. "FRExecute" cannot be used in file content or as part of file name. Otherwise you might get unexpected result.

Note:

When applying layout to a Microsoft Word text box containing FRExecute, for Wrapping Style, you can select “Square”and for Horizontal alignment, you must select “Left”or “Right”only.

Note:

For illustrations of applying FRExecut and output, see Illustration of Page with Links and FRExecute and Illustration of Output Containing Links and FRExecute.