Configuring an embedded worksheet based on a Pivot Editor report

You can configure an embedded worksheet based on a Pivot Editor report. The Pivot report is a tabular report of dimensions on rows and columns and the data is displayed based on the parameters or the contextual data. The report also contains a graph (optional) below the pivot area. The application's embedded grid control, with predefined report layouts, is used to display the worksheet.

To configure embedded worksheets:

  1. Select Configuration > Common > Worksheet.
  2. Click New.
  3. Select Standard Worksheet. Specify this information:
    Name
    The name of the worksheet.
    Display Name
    The name to be displayed in the application.
    Report Source
    The source of the report based on which the worksheet is configured. Select Embedded.
    Report
    The type of report. Select Pivot Editor.
    System
    If this option is set to On, the worksheet is system-defined.
    Enabled
    If this option is set to On, you can view the worksheet in the specified module.
    Available Offline
    This option is disabled when the report is set to Pivot Editor.
    Module
    The cycle or cycle and module in which the worksheet can be viewed.
    Workbook
    Select a workbook from the selected module or specify a new workbook. The workbooks are used to group the worksheets defined for the selected module.
    Tags
    The tags for the worksheets. These are used to group common configuration elements such as calculation rules or measures.
    Users
    The users authorized to access the worksheet.
    Note: By default, the current user is selected.
    Roles
    The list of roles authorized to access the worksheet.
    Note: By default, the current user is selected, if no users or roles are defined.
  4. On the Data Parameters tab, specify this information:
    Parameter
    Select the parameters that must be set for the report. The parameters applicable for the Pivot Editor report:
    Table 1. Measure parameters
    Field Name Default Description
    rv_measure_passed Measures None Used to display the list of measures in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} must be specified.
    rv_measure_calc Measures Edit Calculations None An XML table of rules for editing the calculated measures in the worksheet. Each measure calculation exists as a row and the name of the measure code is specified. Each property is defined as a name and value pair.

    Properties:

    • targetmeasure: The measure used to receive the edited value.
    • weightmeasure_multiply: The measure used to multiply the edited difference (between the original and the new value).
    • weightmeasure_divide: the measure used to divide the edited difference (between the old and the new value).
    • measure_spread: The measure used to spread the weighted difference.
    • spread_type: Either 'delta' or 'value'. Indicates the spreading method to be used with the measure_spread; even if the 'value' is a new value, or based on the edited difference between the existing value and the new value ('delta'). Applicable where the previous value is not null. The behavior of the Delta and Value behavior is the same, when existing value is 0 or #NA. Uses 'delta', if not specified. If the rv_measure_calc is not defined, any edits made to values based on calculated cells are rejected by OLAP.
    • spread_rounding: The number of digits that can be used to round off the spread result. 0 = spread as an integer value. If spread_rounding is defined as a positive integer, the splash command is used with rounding. If not defined, or negative, the rounding is disabled. If “measure_spread” is null, the ifemptyspreadmeasure_spread_rounding parameter is applied.
    • spread_error_correction: Can be set to TRUE or FALSE. If TRUE or undefined error correction is applied on the spread result, that is, one base element can receive a rounded value to ensure the sum of all spread results equals the (aggregate) splashed value. FALSE: No error correction.
    • ifemptymeasurespread_targetmeasure: Used to specify the target measure that must be used if the measure_spread is null.
    • ifemptymeasurespread_weightmeasure_multiply: Used to specify the measure that must be used to multiply the values, if the measure_spread is null.
    • ifemptymeasurespread_weightmeasure_divide: Used to specify the measure that must be used to divide the values, if the measure_spread is null.
    • ifemptymeasurespread_measure_spread: The measure that must be used to spread the values, if the measure_spread is null.
    • Ifemptymeasurespread_spread_rounding: Used to specify the number of digits that can be used to round off the spread result, if measure_spread is null, undefined, or negative).
    • Ifemptymeasurespread_spread_error_correction: Specify TRUE or FALSE to apply error correction, if measure_spread is null (default TRUE, if undefined). If not defined, you cannot edit measure values based on calculated cells; and the edits are rejected by OLAP.
    rv_measure_editable Editable Measures rv_measure_passed The list of editable measures in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. If not set, by default all measures can be edited. To ensure that all measures in the worksheet cannot be modified, any empty set {} is passed.
    rv_measure_except Measures Hidden on Pivot None The list of measures that are not displayed on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_measure_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports MDX definition for the set. If not defined, all the measures specified in the rv_measure_passed parameter are displayed.
    rv_measure_format Measures Format None An XML table of the format and color coding for the measures, defined in the worksheet. Each measure format exists as a row and the name of the measure code is specified. Each property is defined as a name and value pair.

    Properties:

    • format: The format for the measure values. The valid format values are "0", "0.00", "0%", "0.00%", "Date","Datetime", "KPI".
    • highamber: Sets the background to amber when the scenario values >= the value for the corresponding measure.
    • highred: Sets the background to red when the scenario values >= the value for the corresponding measure.
    • lowamber: Sets the background to amber when the scenario values <= the value for the corresponding measure.
    • lowred: Sets the background to red when the scenario values <= the value for the corresponding measure.
    • highlightgreen: If TRUE, sets the background to green when scenario values are not within the amber and red range, otherwise displays the normal (white) background color. Applicable when the measure has at least one highamber, or highred, or lowamber, or lowred defined.
    • kpisize: Indicates if the measure is displayed as an equal sized KPI or a KPI that is proportional to the value. Can be set to either 'proportional' or 'equal'. When set to Proportional, a bar is displayed in the cell. The size of the bar is proportional to the value of the scenarios for the specified measure. The full column width (100%) is displayed for the largest value and scaled down accordingly, based on the proportion to this value. The highamber, highred, lowamber, lowred, and highlightgreen parameters can be utilized to display the appropriate color range (Red, Amber, and Green). If a color range is not specified, the standard chart color pallet is used. Values within the Red range are displayed as a Red bar. Values within the Amber range are displayed as an Amber bar. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a Green bar. When set to Equal, an icon is displayed (Red/Amber exclamation marks and a Green check mark). The highamber, highred, lowamber, lowred, and highlightgreen parameters must be utilized to display the appropriate icons. Values within the red range are displayed as a Red exclamation mark. Values within the amber range are displayed as an Amber exclamation mark. The highlightgreen parameter must be set to TRUE, consequently all other values are displayed as a green check mark. By default, the value is set Equal.
    • total: If TRUE, sets the values to bold. If measure is not defined on the pivot, this condition is ignored.
    • insertblank: If TRUE, a blank row (if measure is on Left Dim) or blank column (if measure is on Top Dim) is inserted, in the worksheet after the selected measure. If the measure is not defined on the pivot, the same is ignored.
    • chartnumber: (1,2, and 4); Overrides the default chart type for this measure. If the measure is included in the charted series this parameter is ignored. Where drawing multiple chart types the data must be retrieved in this order; Area, Column, Line from background to foreground to ensure that each chart type is displayed. The 3 (Pie), 5 (Bar),6 (Map heat), 7 (gauge), 8 (Funnel), 9 Map co-ordinate) chart types, are not supported . The value 0 does not impact this parameter (use rv_measure_graphhide).
      Note: The gauge properties are defined in rv_measure_format and used only when main chart is set to gauge. The chart number is not required to be set to 7.
    • secondaxis: When TRUE, the axis is automatically resized to match all the plotted series (where secondaxis = TRUE). If the measure is included in the charted series this parameter is ignored. Default = FALSE, if not defined, plotting the measure on the primary axis, except when the measure format is %, in which case the axis is defaulted to an alternate axis. Whether the % format or alternate axis for measures where secondaxis=TRUE is displayed first, is based on how the data is read when iterating through the measures for the worksheets.
    • text: Used to create calculated measures and member sets which return a value of text (for example, 1 = A, 2 = B, and so on.). Values are not numerically formatted. If not specified, the value is displayed as null, irrespective of the nullasblank property (ignored where format = text). However, the value returned by the application is a number, the value is then displayed as retrieved and is not formatted. Example: <Table> <Row name="[DPLS_INVCLASS]"> <Property name="format" value="text" /> </Row> </Table>
      Note: If the <> text format and a measure contain text values, format errors occur.
    • stackedtype: 0,1 or 2 (None, Stacked, Percentage). Overrides the default worksheet, stacked type for this measure. If Measure is not included in the charted series this measure is not considered. This is only applicable for chart types, 1,2,4,5 (Column, Line, Area, and Bar). If not defined, the default worksheet, stacked type is used.
    • nullasblank: When True, the measure is displayed as blank if the value is null/0. If False, null/0 values are displayed as 0 (zero). If state = null (undefined), by default the measure property value is applied.
      Note: This format is also applied to the charts, that is, null values are not plotted on the charts. When the Measure is of the type, Date or format property = Text (null always displayed as blank) the value is not considered.
      For example, to display null/0 values as blank cells instead of 0: 
      <Table>
<Row name="[SOP_ERRPER]"> 
<Property name="format" value="0%" /> 
<Property name="highamber" value="0.2" />
<Property name="highred" value="0.4" />
<Property name="highlightgreen" value="TRUE" />
<Property name="nullasblank" value="TRUE" />
</Row>
</Table>
    • trendmeasure: The measure that must be used as the trend measure for the current measure. Only applicable if the default chart type = 7 (Gauge). If the measure is not included in the charted series, the trend measure is not considered.
    rv_measure_spreadlike Measures Spread Like Cycle.Period Spread Measure Used by default, when spreading the new values (cells = 0) to the base level elements. A single element [element1] is required. If no value is passed, the default period spread measure is used.
    Table 2. Item/Location parameters
    Field Name Default Description
    rv_item_passed Items Passed No The list of items that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} must be defined. Overrides the main item data context (for the module) for this worksheet. The MDX definition for the set is supported. If not defined the data context of the specified module is used.
    rv_item_except Items Hidden on Pivot None The list of items that are not displayed on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of rv_item_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports MDX definition for the set. If not defined, all items specified in the rv_item_passed parameter are displayed.
    rv_item_main_attr Additional Item Attributes None A list of item attributes from OLAP that must be displayed, as additional header columns or rows, with each item element in the worksheet. A comma-separated list of up to 3 attributes is used. If the number of attributes is more than 3, the attributes are not considered. The attributes are displayed on the right of the items column (if on the left dimension) or below the items header row (if on the top dimension). If the items are not included on the pivot (left or right dimension), the parameter is ignored. The attribute list is validated during run-time and the attributes must be included in OLAP.
    Note: These attributes are not required to be pivot attributes.
    Note:Attributes that are not validated are not included, and the additional column or header is not displayed.
    rv_item_attr1 Item Attribute 1 Passed Full hierarchy The list of the item 1 attributes that must be displayed in the worksheet, if defined. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_item_attr1_except Item Attribute 1 Hidden None The list of the item 1 attributes that are hidden on the pivot report and subsequently on the chart,when the worksheet is uploaded. This is a subset of v_item_attr1 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_item_attr1 parameter are visible.
    rv_item_attr2 Item Attribute 2 Passed Full hierarchy The list of the item 2 attributes that must be displayed in the worksheet, if defined. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_item_attr2_except Item Attribute 2 Hidden None The list of the item 2 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of v_item_attr2 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_item_attr2 parameter are visible.
    rv_item_attr3 Item Attribute 3 Passed Full hierarchy The list of the item 3 attributes that must be displayed in the worksheet, if defined. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_item_attr3_except Item Attribute 3 Hidden None The list of the item 3 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of v_item_attr3 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_item_attr3 parameter are visible.
    rv_item_attr4 Item Attribute 4 Passed Full hierarchy The list of the item 4 attributes that must be displayed in the worksheet, if defined. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_item_attr4_except Item Attribute 4 Hidden None The list of the item 4 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of v_item_attr4 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_item_attr4 parameter are visible.
    rv_item_attr5 Item Attribute 5 Passed Full hierarchy The list of the item 5 attributes that must be displayed in the worksheet, if defined. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_item_attr5_except Item Attribute 5 Hidden None The list of the item 5 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of v_item_attr5 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_item_attr5 parameter are visible.
    rv_location_main_attr Additional Location Attributes None A list of location attributes from OLAP that must be displayed, as additional header columns or rows, with each location element in the worksheet. A comma-separated list of up to 3 attributes is used. If the number of attributes is more than 3, the attributes are not considered. The attributes are displayed on the right of the location column (if on the left dimension) or below the items header row (if on the top dimension). If the items are not included on the pivot (left or right dimension), the parameter is ignored. The attribute list is validated during run-time and the attributes are included in OLAP.
    Note: These attributes are not required to be pivot attributes.
    Attributes that are validated are not included and the additional header is also not included for that attribute.
    rv_location_passed Location Passed None The list of locations that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} must be defined. Supports the MDX definition for the set. Overrides the main location data context (for the module) for this worksheet.
    rv_location_except Locations Hidden on Pivot None The list of locations that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all elements specified of the rv_location_passed parameter are displayed.
    rv_location_attr1 Location Attribute 1 Passed Full hierarchy The list of the location 1 attributes that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_location_attr1_except Location Attribute 1 Hidden None The list of the location 1 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_attr1 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_location_attr1 are displayed.
    rv_location_attr2 Location Attribute 2 Passed Full hierarchy The list of the location 2 attributes that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_location_attr2_except Location Attribute 2 Hidden None The list of the location 2 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_attr2 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_location_attr2 are displayed.
    rv_location_attr3 Location Attribute 3 Passed Full hierarchy The list of the location 3 attributes that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_location_attr3_except Location Attribute 3 Hidden None The list of the location 3 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_attr3 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_location_attr3 are displayed.
    rv_location_attr4 Location Attribute 4 Passed Full hierarchy The list of the location 4 attributes that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_location_attr4_except Location Attribute 4 Hidden None The list of the location 4 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_attr4 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_location_attr4 are displayed.
    rv_location_attr5 Location Attribute 5 Passed Full hierarchy The list of the location 5 attributes that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, the entire hierarchy is used.
    rv_location_attr5_except Location Attribute 5 Hidden None The list of the location 5 attributes that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_location_attr5 parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_location_attr5 are displayed.
    Table 3. Period parameters
    Field Name Default Description
    rv_period_passed Period Passed No The list of periods that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} must be defined. If not defined the data context of the specified module is used.
    rv_period_drilldown Periods Show Children True Indicates if both the passed period element and the children are displayed in the worksheet when uploaded, wherein the period selection is a single element or a set, and the period dimension exists on the pivot (not the slicers). For example, Passing [FY 2014] displays the period FY 2014 and the child level quarters: FY14 Qtr1, FY14 Qtr2, FY14 Qtr3, FY14 Qtr4 on the pivot. Default = True. When False only the selected passed period is displayed. When a set of elements is passed for the selected period, the elements of the set are displayed on the pivot, irrespective of the parameter value. When the period dimension is within the slicer (extension of a pivot table) area, only the passed element or default member in the selection is displayed; irrespective of the parameter value.
    rv_period_except Periods Hidden on Pivot None The list of periods that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_period_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is considered. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_period_passed are displayed.
    rv_period_lock Periods Edit Lock None The list of periods that are locked. The ascendants or descendants of the periods are also locked. This is a subset of rv_period_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is required. Supports the MDX definition for the set. For example, rv_period_lock = [FY 14 Qtr1] locks: Ascendants: FY 2014 and "Monthly Calendar" (calendar name / aggregate). Descendants: FY14 M01, FY14 M02, FY14 M03. If not defined, all the elements in rv_period_passed parameter can be edited.
    Table 4. Scenario parameters
    Field Name Default Description
    rv_scenario_passed Scenarios Passed Data Context The list of scenarios that must be displayed in the worksheet. A single element [element1] or a set in the form: {[element1],[element2]} must be defined. If not defined, the data context of the specified module is used.
    rv_scenario_except Scenarios Hidden on Pivot None The list of periods that are hidden on the pivot report and subsequently on the chart, when the worksheet is uploaded. This is a subset of the rv_scenario_passed parameter. A single element [element1] or a set in the form: {[element1],[element2]} is considered. Supports the MDX definition for the set. If not defined, all the elements specified for the rv_scenario_passed are displayed.
    Table 5. Layout Parameters
    Field Name Default Description
    rv_left_dim Left dimensions (rows) L, M The Left dimensions on the pivot report, that must be displayed in the rows. The values can be I, IAx, L, LAx, P, M, S, and H, and each dimension is separated by a comma. The specified dimensions cannot be displayed in the 'top' dimension variable; that is, each dimension parameter value must be unique. If not defined, by default, the Locations and Measures values are used.
    Note: Supersedes the rv_left1_dim and rv_left2_dim to support layouts more than the 2 x 2 dimension.
    rv_top_dim Top dimensions (columns) I, P The Top dimensions on the pivot report, that must be displayed in the columns. The values can be I, IAx, L, LAx, P, M, S, or H, and each dimension is separated by a comma. The specified dimensions cannot be displayed in the 'left' dimension variable; that is, each dimension parameter value must be unique. If not defined, by default, Items and Period value is used.
    Note: Supersedes the rv_top1_dim and rrv_top2_dim to support layouts more than the 2 x 2 dimension.
    rv_column_width Column Widths 90 Specifies the width of the columns (in pixels) for the embedded pivot. Specified in the format - data_cell_width[:left_dim1_width:left_dim2_width:…:left_dimN_width] (left1, left2 dim only initially). For example, 80:90:180 represents 80px for the data columns, 90 for the left1 dimension, 180 for the left2 dimension. A value of 90 is equal to 90px for the data columns and the default width for any dimension columns.
    rv_mdx_with MDX with None The WITH clause of the MDX statement is used to build member sets that can be used in the MDX SELECT statement. If populated and enabled, the parameter value is added at the start of the worksheet MDX query (prior to the SELECT). Adds the flexibility of the MDX report to the functionality and usability of the pivot editor.
    rv_context_full Show Full Context FALSE Indicates if the worksheet is initially displayed with the context (slicer) area extended to show the dimensions, but not on the pivot with the related current element selection (=TRUE), or if the slicer context must be displayed as a single header line of text (=FALSE).
    rv_filter_left Filter Left Dimensions None If this field is used with rv_filter_left_condition and rv_filter_left_value which uses optimized OLAP filtering, a single element is selected. An MDX express can be used which results an element/tuple.

    If used without rv_filter_left_condition and rv_filter_left_value, an MDX expression containing dimension elements and a filter condition must be specified.

    rv_filter_left_condition Filter Left Condition None Determines the corresponding optimized OLAP filter command and is used in conjunction with rv_filter_left and rv_filter_left_value, else not considered. Must be populated with >, <, = , >= or <=.
    Note: rv_filter_left_value must be included when this field is defined
    rv_filter_left_value Filter Left Value None
    Determines the value to be applied to the filter the rows in the worksheet against the specified value. This is used only in conjunction with rv_filter_left and rv_filter_left_condition, else not considered.
    Note: rv_filter_left_condition must be included when this field is defined.
    rv_filter_top Filter Top Dimensions None If this field is used with rv_filter_top_condition and rv_filter_top_value which uses optimized OLAP filtering, a single element is selected. An MDX expression can be used which results an element/tuple.

    If used without rv_filter_top_condition and rv_filter_top_value, an MDX expression containing dimension elements and a filter condition must be specified.

    rv_filter_top_condition Filter Top Condition None Determines the corresponding optimized OLAP filter command and is used in conjunction with rv_filter_top and rv_filter_top_value, else not considered.
    Must be populated with >, <, =, >= or <=.
    Note: rv_filter_left_value must be included when this field is defined.
    rv_filter_top_value Filter Top Value None Determines the value to be applied to filter the rows in the worksheet against the specified value. This is used only in conjunction with rv_filter_top and rv_filter_top_condition, else not considered.
    Note: rv_filter_top_condition must be included when this field defined.
    rv_forecast_settings Forecast Settings None An XML table used to define the default forecast engine for the worksheet and the hierarchy levels, to generate the forecast. The default engine exists as a row with the name "default" (only 1 engine supported per worksheet currently). Each property for the engine is defined as a name and value pair.

    Properties:

    • engine: The name of the forecast engine.
    • itemlevel: The item level used to calculate the forecast. Must be at the level of the selected passed item, or a lower level. If not defined, the forecast engine settings are used.
    • locationlevel: The location level to calculate the forecast. Must be at the level of the selected passed location or a lower level. If not defined, the forecast engine settings are used.
    rv_hide_zero_left Hide Zero Left Dimensions FALSE Used to determine if the left dimensions (rows), where all values are empty for the row (element combinations for all left dimensions), must be hidden. Supersedes rv_hide_zero_left2 (mapped to the new parameter for backward compatibility).
    rv_hide_zero_top Hide Zero Top Dimensions FALSE Used to determine if the dimensions (columns), where all values are empty for the column (element combinations for all top dimensions), must be hidden. Supersedes rv_hide_zero_top2 (mapped to new parameter for backward compatibility).
    rv_slicers_hide Hide Slicers None A comma-separated list of dimensions that must not be included in the slicer area of the worksheet. By default, all the dimensions are displayed in the slicer area. However, the user can define some dimensions that must not be displayed, if not applicable to the worksheet or to prevent a change of the selection from the worksheet. In this case, the default element is passed to the worksheet but the dimension and element are hidden in the slicer area. For example, P, S, IA2: hide periods, scenarios and item attribute 2 from the slicers area. Default = False. If not defined, all dimensions are displayed.
    rv_sort_options Sort Options Hierarchized = TRUE, Sorttype = ASC, Sorton = TRUE (except Measures and Periods). An XML table is used to define the process to sort dimensions in an ascending or descending order, in the hierarchy. Each dimension exists as a row, and the name of the dimension is displayed. Each property is defined as a name and value pair. The measures dimension is not applicable for the sort options.

    Properties:

    sorton: If the dimension is sorted (TRUE), if not (FALSE).

    Note: 
    • hierarchized: The dimension is displayed in a hierarchy; each child level is displayed indented (TRUE) or flat (FALSE). You can expand or collapse the child elements of an aggregated element.
    • sorttype: The dimension is sorted in an ascending (ASC) or descending (DESC) order. This is applicable only if sorton=TRUE. If not defined, the default sort option is used.
    Table 6. History parameters
    Field Name Default Description
    rv_enable_history Enable History FALSE Used to determine if the access to history cube must be enabled. If not defined, set to False.
    rv_history_passed History Passed FALSE The list of history periods. A single element [element1] or a set in the form: {[element1],[element2]} is required. Used in conjunction with the rv_enable_history parameter, if the enable history is False, the parameter is ignored. If the parameter is not defined, the default value is the cycle period, set in the H dimension.
    Value
    Specify the data that must be included in the report for the selected parameter.
    Enabled
    If this check box is selected, the parameter is used in the worksheet.
  5. On the Charting tab, specify the chart options for the worksheet:
    Parameter
    Select the parameters that must be set for the report.

    See Charting parameters.

    Value
    Specify the data that must be included in the report for the selected parameter.
    Enabled
    If this check box is selected, the parameter is used in the worksheet.
  6. Click Submit and Back to List.
Parent topic: Worksheets overview