<< Click to display table of contents >>
Figure 18: Generates element
Path: <definitioncolumns><generates> Contains the definitions of a row generation template. Attributes reportsheet: Defines the type of the input or report template. Possible values: •dynamic: The input or report template is generated while it is opened. •static: The account, unit, and dimension combinations are already in the workbook, not generated while the input or report template is opened (see Creating Static Generated Templates in Clausion Financial Performance Management Administrator's Guide). |
Path: <definitioncolumns><generates><settings> Note! The 'fittopages' and 'pagebreakblocks' attributes are used together. See the examples for 'fittopages' in the following table. Contains the settings of a row generation template. Attributes removeemptyblocks: Defines whether all account, unit, and dimension combinations are shown in the generated template, or only those for which data has been entered. Possible values: •true: Only those combinations for which data has been entered are shown. •false: All combinations are shown (default value). fittopages: The number of pages to which the generated report or input template printout must fit. Possible values: •0 (default) The 'fittopages' and 'pagebreakblocks' attributes are used together. If the 'fittopages' value is defined (the value is greater than 0), the 'pagebreakblocks' value must also be defined. Note! If a print area is not defined in the workbook, the 'pagebreakblocks' and 'fittopages' definitions are not applied. Examples: fittopages = 0, pagebreakblocks = 3: Page breaks are added after 3 blocks, the sheet level 'fit to pages' setting is ignored (see <fittopages>). fittopages = 1, pagebreakblocks = 0: Not a useful combination as this has no effect. The sheet level 'fit to pages' setting is used if it is defined. fittopages = 1, pagebreakblocks = 1: 1 block is fit to one page. fittopages = 1, pagebreakblocks = 2: 2 blocks are fit to one page. fittopages = 2, pagebreakblocks = 6: 6 blocks at the most are fit to two pages wide and two pages tall. Note! When the 'fittopages' and 'pagebreakblocks' settings are used, it can cause multiple print jobs and the order of the jobs is random. No Print dialogue box is shown in this case. pagebreakblocks: Defines the number of blocks after which a page break is set in generated templates. Possible values: •0 (default) |
Path: <definitioncolumns><generates><generateitem> Note! The following descriptions also apply to the <dimensionselector> parameter used in the input task parameters for input calculation. For more information about input calculation, refer to Clausion Financial Performance Management Administrator's Guide. Contains the settings of one item (dimension, account, account component, data type, financial year, financial period, document series) for which data is generated. When creating an input or report template, remember to take the dimension and data type connections into consideration. For more information, refer to Clausion Financial Performance Management Administrator's Guide. Attributes dimensiontype: Defines the item for which data is generated. Possible values: •dim[nn] •codim00 •account •datatype •finyr •finper •documentseries generatetype: Defines how data is generated for the dimension or the account or account component. Possible values: Note! Data is always retrieved from those units for which the user has the required rights. •next: In input templates data is retrieved from input units and accounts, and rows are generated for sum accounts and components starting from the next level below the selected level. If entering data to consolidation units is allowed (AllowConsolidationInput=True), data is retrieved also from consolidation units (for more information, refer to Allowing Input to Consolidation Units in Clausion Financial Performance Management Administrator's Guide). In reports data is retrieved from all units, accounts, and account components (input and consolidation units, sum accounts, parent components) starting from the next level below the selected level. The level attribute defines how many levels down from the selected or defined level is retrieved. The selected or defined dimension unit can be defined with the <udid> element(s) (see <udid>). •input: Data is retrieved only from unit and account input levels regardless of the value of the AllowConsolidationInput parameter (refer to Allowing Input to Consolidation Units in Clausion Financial Performance Management Administrator's Guide). Used in input templates and reports. The selected/defined dimension unit can be defined with the <udid> element(s) (see <udid>). If an input unit is selected or defined, data is generated for it. •selected: Data is retrieved from specific units, accounts, account components, data types, years, periods, or document series defined with <udid> element(s) (see <udid>) regardless of the value of the AllowConsolidationInput parameter (refer to Allowing Input to Consolidation Units in Clausion Financial Performance Management Administrator's Guide). Use this option always for static generated templates (refer to Static Row Generation in Clausion Financial Performance Management Administrator's Guide). •branch: In input templates data is retrieved from all input units and accounts, and rows are generated for sum accounts and components under the selected level. If entering data to consolidation units is allowed (AllowConsolidationInput=True), data is retrieved also from consolidation units (for more information, refer to Allowing Input to Consolidation Units in Clausion Financial Performance Management Administrator's Guide). In reports data is retrieved from all units, accounts, and account components (input and consolidation units, sum accounts, parent components) under the selected level. The selected or defined dimension unit can be defined with the <udid> element(s) (see <udid>). If an input unit is selected or defined, data is generated for it. •all: In input templates data is retrieved from all input units, accounts, data types, years, and periods, and rows are generated for sum accounts. If entering data to consolidation units is allowed (AllowConsolidationInput=True), data is retrieved also from consolidation units (for more information, refer to Allowing Input to Consolidation Units in Clausion Financial Performance Management Administrator's Guide). In reports data is retrieved from all units, accounts, data types, years, periods, and document series. Note! The 'all' generation also includes the 'BwNonAllocatedItem' unit. All values are available for dimension types 'dim[nn]', 'codim00' and 'account'. For 'datatype', 'finyr', 'finper', and 'documentseries' only selected and all can be used. Data is retrieved to the input or report template according to the user's rights. To input templates, data is retrieved for those units that the user has 'read and write' rights. For reports, 'read' rights are required. level: Defines how many levels down in the hierarchy data is retrieved. Required with 'generatetype' attribute value next. Note! The hierarchy and levels refer to the actual hierarchy tree of the system, not the hierarchy tree of the user based on the user's rights. hierarchy: Defines the hierarchy according to which the units are generated on the input or report template. Not needed for account and account component generation. Possible values: •Hierarchy ID: The units are generated according to this specific hierarchy. •Variable %DIMnn HIERARCHY%: The units are generated according to the hierarchy selected by the user in the input/report template options view. sourcedatatype: Defines the data type according to which accounts and/or units are generated. When creating an input or report template, remember to take the dimension and data type connections into consideration. For more information, refer to Clausion Financial Performance Management Administrator's Guide. Possible values: •Data type code •Variable %DATA TYPE CODE%: The accounts/units will be generated according to the connections of the data type selected by the user in the input or report template options view. •Empty or not defined: All accounts/units are used in generation. The data type connections of the accounts/units are not checked. sourceyear: Defines the financial year according to which units are generated. Possible values •Year code •Variable %YEAR CODE%: The units will be generated according to the financial year selected by the user in the input or report template options view. •Empty or not defined: All units of the selected or defined year are used in generation. The data type connections of the units are not checked. includeselected: Defines whether the unit or account selected is also included in the generation. Possible values: •true: The selected unit/account is included in the generated items and shows on template •false: The selected unit/account is not included in the generated items. Note! 'includeselected' has no effect if the generation settings also include element "showselectedunit". It is recommended to use 'showselectedunit' instead of 'includeselected'. generateorder: Defines the order in which the parent level and lower level accounts/units are shown in the generated template. Possible values: •parentfirst (default): Accounts/units are generated as in the account chart/unit hierarchy (parent accounts/parent units first, lower level accounts/units after the parent). •childfirst: Parent level accounts/units are generated after lower level accounts/units. static: Defines the use of static generation (template created in excel, and data shown based on matching combination of definition columns with presentationproperty=udid) of a dimension or accounts within a dynamically (rows created based on data and generateitems settings) generated area. Enables the combination of dynamic and static generation within the same area and is only relevant when the generate area has been defined as being dynamic (area > definitioncolumns > generates > reportsheet=dynamic). Only applies to generation of units, dimensions and accounts. Possible values: •false (default): The dimension/units or accounts are generated dynamically. •true: The dimension/units or accounts are generated statically. |
Path: <definitioncolumns><generates><generateitem><settings> Defines the settings of one generate item (dimension). Attributes showselectedunit: Defines whether the data of the selected unit/account is retrieved to the template. Possible values: •no: The data of the selected unit or account is not retrieved to the template (default value). •first: The data of the selected unit or account is shown first in the template. •last: The data of the selected unit or account is shown last in the template. |
Path: <definitioncolumns><generates><generateitem><udid> Defines the selected or defined dimension unit used for the generation settings (with generatetype='next', 'branch', and 'input'), or the specific unit, account, data type, year, period, or document series to be generated (with generatetype=”selected”). You can also use the %ACCOUNT CODE%, %DIMnn CODE% and %DIMnn CODES% variables: •%ACCOUNT CODE%: the accounts selected by the user in the input or report template options view is used. Task settings allows several accounts to be selected, if 'multiselect' function in use. For more information about the 'multiselect' function, refer to Clausion Financial Performance Management User Interface Task Parameters. •%DIMnn CODE%: the unit selected by the user in the input or report template options view is used. •%DIMnn CODES%: When the 'multiselect' function is in use, the dimension units that a user selects on the Basic Options tab are opened on the template. When the 'multiselect' function is not in use, %DIMnn CODES% functions in the same way as %DIMnn CODE%. For more information about the 'multiselect' function, refer to Clausion Financial Performance Management User Interface Task Parameters. In all other cases, the selected level defined with the <udid> element is stronger than the user's selection in the user interface. |
Path: <definitioncolumns><generates><generateitem> <groupbyitems> Note! Groupbyitems can be used only for dimension types DIM00 and CODIM00, and with generatetype input. Contains the settings for presenting retrieved data on consolidated levels. When creating an input or report template, remember to take the dimension and data type connections into consideration. For more information, refer to Clausion Financial Performance Management Administrator's Guide. Groupbyitems is most useful with selection All internal transactions for reconciliation of internal transactions. It enables reconciliation against other consolidated levels. Groupbyitem inherits hierarchy, sourcedatatype, and sourceyear settings from the generateitem element under which it is. Attributes groupbytype: Defines the list of consolidated levels to be used for presentation. Possible values: Note! Data is always retrieved only from those units for which the user has the required rights. •next: Data is retrieved from all units starting from the next level below the selected level. The level attribute defines how many levels down from the selected or defined level is retrieved. The selected or defined dimension unit can be defined with the <groupbyudid> element(s) (see <groupbyudid>). •selected: Data is retrieved from specific units defined with <groupbyudid> element(s) (see <groupbyudid>). level: Defines how many levels down in the hierarchy data is retrieved. Required with 'groupbytype' attribute value next. Note! The hierarchy and levels refer to the actual hierarchy tree of the system, not the hierarchy tree of the user based on the user's rights. |
Path: <definitioncolumns><generates><generateitem><groupbyitems><groupbyudid> Defines the selected or defined dimension unit used for the groupby settings (with groupbytype='next'), or the specific units to be used (with groupbytype=”selected”). The groupbyudid should always be consolidated level. Also groupbyudid is case sensitive, thus use the same upper/lower case as defined in unit management. You can also use the %DIMnn CODE% and %DIMnn CODES% variables: •%DIMnn CODE%: the unit selected by the user in the input or report template options view is used. •%DIMnn CODES%: When the 'multiselect' function is in use, the dimension units that a user selects on the Basic Options tab are opened on the template. When the 'multiselect' function is not in use, %DIMnn CODES% functions in the same way as %DIMnn CODE%. For more information about the 'multiselect' function, refer to Clausion Financial Performance Management User Interface Task Parameters. In all other cases, the selected level defined with the <groupbyudid> element is stronger than the user's selection in the user interface. |