User Interface Components for Input and Reporting Tasks

The mandatory parent element for user interface components is <components>.

The value of the name attribute of the <component> element indicates which component (= object on the screen) is in question. Dependent on this value, <component> may have various child elements. The object may be, for example, a drop-down list or a check box.

The child elements that are common to most <component> elements are the following:

• Element <visible> defines whether the component is visible on screen. If it is not visible, a fixed value may still be specified for it. This value affects on what is shown on the template.

• Element <enabled> defines whether the component is enabled, that is, whether the user is able to make selections in this object.

• Element <promote> defines whether the component is shown on the template.

  The <promote> element has no effect in the Clausion Web Client.

• Element <value> defines the default value for the component, for example the year that is preselected when opening a template.

The following table lists the objects and the values of the name attribute of the element <component>. It also indicates whether a <component> with this name is required, whether child elements <visible>, <enabled>, <promote> and <value> are required, and if other child elements exist. If the child elements <visible>, <enabled>, <promote> and <value> have default values, those are shown in parentheses.

Common UI elements for input and reporting tasks

This section describes the common elements of the <component> element, which are in use for the most of the user interface components of input and reporting tasks.

<components>

Path: <outlook><components>

The <components> element is the mandatory parent element of the various <component> elements.

<component>

Path: <outlook><components><component>

Defines the objects enabling user selections in the Input or Report Templates window.

<visible>

Path: <outlook><components><component><visible>

Defines whether the component is visible.

Possible values:

• true

• false (default)

<enabled>

Path: <outlook><components><component><enabled>

Defines whether the component is enabled.

Possible values:

• true

• false (default)

<promote>

Path: <outlook><components><component><promote>

Defines whether the component is shown on the input or report template.

Possible values:

• true

• false

Basic Options

The Basic Options tab is available if it has been defined in the task settings. The options available on the tab also depend on the task settings.

In the Clausion Web Client, there are no separate tabs for basic and advanced options. All available options are listed under the task heading.

Object on screen	Value of name attribute	Visible	Enabled	Promote	Value	Other child elements
Data Type Drop-Down List	datatype	1 (false)	1 (false)	1	0-1	<listdatatypes>
						<listdatatype>
Period Drop-Down List	periodmonth	1 (false)	1 (false)	1	0-1	<listperiods>
						<listperiod>
Year Drop-Down List	periodyear	1 (false)	1 (false)	1	0-1	<listyears>
						<listyear>
Hide Zero Rows Check Box	hidezerorows	1 (false) 1)	1 (false) 1)	1	0-1 (no)
Dimension Option	dimension	1 (false)	1 (false)	1	1	<multiselect>
						<multiselectvalues>
						<multiselectvalue>
						<structure>
						<liststructures>
						<liststructure>
Account Option	account	1	1	-	1	<multiselect>
						<multiselectvalues>
						<multiselectvalue>
						<structure>
						<liststructures>
						<liststructure>

Data Type Drop-Down List

Elements, attributes and possible values

<component>

Data type drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the Data type drop-down list component.

Possible values:

• datatype

<value>

Data type drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the data types defined in the system. If the value is missing or does not match an existing data type ID, the first value from the drop-down list is used as the default.

<listdatatypes>

Data type drop-down list - path: <outlook><components><component><listdatatypes>

Contains the settings for the the Data type drop-down list content on the Basic Options tab of an input or report template.

<listdatatype>

Data type drop-down list - path: <outlook><components><component><listdatatypes><listdatatype>

Defines which data types are shown in the drop-down list on the Basic Options tab.

Possible values:

• The IDs of the data types defined in the system. (ACT, BUD, EST).

Period Drop-Down List

For Internal Data Transfer -specific period option settings, see Period Option.

Elements, attributes and possible values

<component>

Period drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the Period drop-down list component.

Possible values:

• periodmonth

<value>

Period drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the periods defined in the system.

• %GLOBAL PERIOD%: The value of the %GLOBAL PERIOD% parameter can be set using the Parameters custom template (refer to Global Parameters in Clausion Administrator's Online Help). All tasks that use the % GLOBAL PERIOD% parameter then open with this period selected by default, and it is not necessary to set the value for every task separately. For example, if the GLOBAL PERIOD parameter has the value 2, which is usually February, all tasks that use the %GLOBAL PERIOD% parameter open with February selected by default. For the next month's reporting, the period value needs to be changed only in the global parameter settings for all tasks to open with March by default.

If the value is missing or does not match an existing period ID, the first value from the drop-down list is used as the default.

<listperiods>

Period drop-down list - path: <outlook><components><component><listperiods>

Contains the settings for the Period drop-down list content on the Basic Options tab of an input or report template.

Attributes

type: Defines the type of the <listperiod> element values.

Possible values:

• udid: the values are period IDs

• periodtype: the values are period types (opening period, normal period, or extra period).

<listperiod>

Period drop-down list - path: <outlook><components><component><listperiods><listperiod>

Defines which periods are shown in the drop-down list on the Basic Options tab.

Possible values:

• For <listperiods type=udid>:

  • Valid period udids found in the database (for example, 1, 2, 3)

• For <listperiods type=periodtype>:

  • 1: Opening period

  • 2: Normal periods

  • 3: Extra periods

Year Drop-Down List

Elements, attributes and possible values

<component>

Year drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the Year drop-down list component.

Possible values:

• periodyear

<value>

Year drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the years defined in the system.

• %GLOBAL YEAR%: The value of the %GLOBAL YEAR% parameter can be set using the Parameters custom template (refer to Global Parameters in Clausion Administrator's Online Help). All tasks that use the %GLOBAL YEAR% parameter then open with this year selected by default, and it is not necessary to set the value for every task separately.

If the value is missing or does not match an existing year ID, the first value from the drop-down list is used as the default.

<listyears>

Year drop-down list - path: <outlook><components><component><listyears>

Contains the settings for the Year drop-down list content on the Basic Options tab of an input or report template.

<listyear>

Year drop-down list - path: <outlook><components><component><listyears><listyear>

Defines which periods are shown in the drop-down list on the Basic Options tab.

Possible values:

• Valid year udids found in the database (for example, 2007, 2008, 2009).

Hide Zero Rows Check Box

Elements, attributes and possible values

<component>

Hide zero rows check box - path: <outlook><components><component>

Attributes

name: Defines the name of the Hide zero rows check box component.

Possible values:

• hidezerorows

<value>

Hide zero rows check box - path: <outlook><components><component><value>

Defines the default value for the component.

• yes

• no (default)

Dimension Option

Elements, attributes and possible values

<component>

Dimension option - path: <outlook><components><component>

Attributes

id: Defines the ID of the dimension component.

Possible values:

• 0-n (n=1-9)

name: Defines the name of the dimension component.

Possible values:

• dimension

<value>

Dimension option - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the units defined in the system.

  If the value does not match an existing unit ID, the dimension check box is not selected. If a user selects the check box, a message is displayed about the invalid unit. When the message is closed, the first unit from the unit tree is selected by default.

<multiselect>

Dimension option - path: <outlook><components><component><multiselect>

Settings for defining whether users can select several units for the dimension. This setting is dimension-specific. The function is available for generation templates with 'generatetype' definitions selected, branch and input. The setting can also be used for the input template calculation and report bundle functions.

%DIMnn CODES% is needed in the template column definitions for passing multiple values. For more information, refer to Clausion Input and Report Template Parameters.

Attributes

enabled: Defines whether users can select several units for the input or report template.

Possible values:

• true

• false (default)

<multiselectvalues>

Dimension option - path: <outlook><components><component><multiselect><multiselectvalues>

<multiselectvalue>

Dimension option - path: <outlook><components><component><multiselect><multiselectvalues><multiselectvalue>

Defines the units that are selected in the Basic Options view of the task.

The value of the 'enabled' attribute of the <multiselect> element must be set as 'true'.

Possible values:

• unit ID

<structure>

Dimension option - path: <outlook><components><component><structure>

Defines the default hierarchy for the dimension component.

Possible values:

• The IDs of the hierarchies defined in the system

<liststructures>

Dimension option - path: <outlook><components><component><liststructures>

Defines the list of hierarchies that users can select for the dimension on the Basic Options tab.

The dimension component for which the <liststructures> settings are added must have an ID (see <component>).

<liststructure>

Dimension option - path: <outlook><components><component><liststructures><liststructure>

Possible values:

• The IDs of the hierarchies defined in the system.

  If there are several <liststructure> elements and some have invalid values, the invalid values are ignored and only the valid values are shown in the hierarchy list on the Basic Options tab. If no valid values are defined, all hierarchies are shown.

Account Option

Elements, attributes and possible values

<component>

Account option - path: <outlook><components><component>

Used for selecting accounts from which data is transferred or reported, or for which data is entered.

Attributes

name: Defines the name of the account component.

Possible values:

• account

<value>

Account option - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the accounts in the system

• None

<multiselect>

Account option - path: <outlook><components><component><multiselect>

Used for selecting several accounts.

Attributes

enabled: Defines whether users can select several accounts to be transferred by internal data transfer, or to be passed as values in template headers or generation, if the %ACCOUNT CODE% parameter is included in template definitions. When the value is 'true', it is possible to select several accounts.

Possible values:

• true

• false

<multiselectvalues>

Account option - path: <outlook><components><component><multiselect><multiselectvalues>

<multiselectvalue>

Account option - path: <outlook><components><component><multiselect><multiselectvalues><multiselectvalue>

Defines the accounts that are selected on the Source Options 1 tab. Note that the value of the 'enabled' attribute of the <multiselect> element must be set as 'true'.

Possible values:

• account ID

<structure>

Account option - path: <outlook><components><component><structure>

Defines the default hierarchy for the account component.

Possible values:

• The IDs of the hierarchies defined in the system.

<liststructures>

Account option - path: <outlook><components><component><liststructures>

Defines the list of account hierarchies that users can select on the BasicOptions tab.

<liststructure>

Account option - path: <outlook><components><component><liststructures><liststructure>

Possible values:

• The IDs of the account hierarchies defined in the system

  If there are several <liststructure> elements and some have invalid values, the invalid values are ignored and only the valid values are shown in the hierarchy list on the Basic Options tab. If no valid values are defined, all hierarchies are shown.

Advanced Options

The Advanced Options tab is available if it has been defined in the task settings. The options available on the tab also depend on the task settings. See Advanced Options Tab.

In the Clausion Web Client, there are no separate tabs for basic and advanced options. All available options are listed under the task heading.

Document Options

Object on screen	Value of 'name' attribute	Visible	Enabled	Promote	Value	Other child elements
Document Drop-Down List	voucher	1 (false)	1 (false)	1	0-1
Document Range Option	radiomaxmin	1 (false)	1 (false)	1 (false)	0-1 (no)
Document Series Option	radioselecseries	1 (false)	1 (false)	1 (false)	0-1 (no)
Lower Limit Drop-Down List	voucherseriesmin	1 (false)	1 (false)	1	0-1
Upper Limit Drop-Down List	voucherseriesmax	1 (false)	1 (false)	1	0-1
Document Series List	listselecvoucherseries	1 (false)	1 (false)	1	0-1	<listseries>

Document Drop-Down List

Elements, attributes and possible values

<component>

Document drop-down list - path: <outlook><components><component>

When this component is used, all data columns must have the same document series definitions.

Attributes

name: Defines the name of the Document drop-down list component.

Possible values:

• voucher

<value>

Document drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• The IDs of the documents or document series defined in the system. If the value does not match an existing document ID, an error message is shown.

A user interface task with task ID CardSheet can only have a type 6 document series as the value of the voucher component.

Document Range Option

Elements, attributes and possible values

<component>

Document range option - path: <outlook><components><component>

Attributes

name: Defines the name of the Document range component.

Possible values:

• radiomaxmin

If the document range option and document series option settings are in conflict or missing, the document series option will be used.

<value>

Document range option - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

Document Series Option

Elements, attributes and possible values

<component>

Document series option - path: <outlook><components><component>

Attributes

name: Defines the name of the Document series component.

Possible values:

• radioselecseries

If the document range option and document series option settings are in conflict or missing, the document series option will be used.

<value>

Document series option - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

Lower Limit Drop-Down List

Elements, attributes and possible values

<component>

Lower limit drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the document range Lower limit drop-down list component.

Possible values:

• voucherseriesmin

<value>

Lower limit drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• for example, 10001

Upper Limit Drop-Down List

Elements, attributes and possible values

<component>

Upper limit drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the document range Upper limit drop-down list component.

Possible values:

• voucherseriesmax

<value>

Upper limit drop-down list - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• for example, 79999

Document Series List

Elements, attributes and possible values

<component>

Document series list on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Defines the name of the Document series list component.

Possible values:

• listselecvoucherseries

<value>

Document series list on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component.

The value may be given as comma separated list of document series codes, one series code, or you may use environment specific global parameter, when value of the parameter must be a series code or a list of codes.

Possible values:

• for example, 10000,20000,70000

<listseries>

Document series list on Advanced Options tab - path: <outlook><components><component><listseries>

Contains the settings for the Document Series drop-down list content on the Advanced Options tab of an input or report template.

Attributes

type: Defines the type of the <listseries> element values.

Possible values:

• udid: the values are document series IDs

  • For <listseries type=udid>:

    • Valid document series udids found in the database (for example, 10000, 20000, 30000 etc.).

• seriestype: the values are document series types (1=Basic unit input, 2=Internal transactions input, 23= Internal transactions automatic adjustment for proportional consolidation, 3=Automatic consolidation entries, 4=Elimination of inventories internal margin, 6=Eliminations with basic transaction data affecting future periods, 7=Other entries). <listserie>

  • For <listseries type=seriestype>:

    • 1: Basic unit input

    • 2: Internal transactions input

    • 23: Internal transactions automatic adjustment for proportional consolidation

    • 3: Automatic consolidation entries

    • 4: Elimination of inventories internal margin

    • 6: Eliminations with basic transaction data affecting future periods

    • 7: Other entries

This element can have one value or multiple comma separated values. A user defined global parameter containing document series udid(s) or seriestype number(s) may also be used as value.

Other Options

Object on screen	Value of name attribute	Visible	Enabled	Promote	Value
All Entries Allocated to Unit	allentriesallocated	1 (false)	1 (false)	1	0-1 (no)
All Internal Transactions for Unit	allinternaltransactions	1 (false)	1 (false)	1	0-1 (no)
Periodical Option for Type of Data	datatypeperiod	1 (false)	1 (false)	1 (false)	0-1 (no)
Cumulative Option for Type of Data	datatypeaccumulated	1 (false)	1 (false)	1 (false)	0-1 (no)
Scaling Factor Check Box	usescalingfactor	1 (false)	1 (false)	1 (false)	0-1 (no)
Scaling Field	scalingfactor	1 (false)	1 (false)	1 (false)	0-1
Currency Drop-Down List	currency	1 (false)	1 (false)	1	1
Show All Drill-Down Input Rows Check Box	displaydrilldown	1 (false)	1 (false)	1	0-1 (no)
XBRL Taxonomy Template Version Drop-Down List	templateversion	1 (true)	1 (true)	1 (true)	1

All Entries Allocated to Unit

Elements, attributes and possibl'e values

<component>

All entries allocated to unit - path: <outlook><components><component>

Attributes

name: Defines the name of the All entries allocated to unit component (check box in the Advanced Options tab and drop-down list on the report template).

• allentriesallocated

<value>

All entries allocated to unit - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

All Internal Transactions for Unit

Elements, attributes and possible values

<component>

All internal transactions for unit - path: <outlook><components><component>

Attributes

name: Defines the name of the All internal transactions for unit component (check box in the Advanced Options tab and drop-down list on the report template).

Possible values:

• allinternaltransactions

<value>

All internal transactions for unit - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

Periodical Option for Type of Data

Elements, attributes and possible values

<component>

Periodical option for Type of Data on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Defines the name of the Periodical radio button component (used in the Type of Data options on the Advanced Options tab of the report task).

Possible values:

• datatypeperiod

If the periodical and cumulative option settings are in conflict or missing, the periodical values will be used.

<value>

Periodical option for Type of Data on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes (default)

• no

Cumulative Option for Type of Data

Elements, attributes and possible values

<component>

Cumulative option for Type of Data on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Defines the name of the Cumulative radio button component (used in the Type of Data options on the Advanced Options tab of the report task).

Possible values:

• datatypeaccumulated

If the periodical and cumulative option settings are in conflict or missing, the periodical values will be used.

<value>

Cumulative option for Type of Data on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

Scaling Factor Check Box

Elements, attributes and possible values

<component>

Scaling factor check box on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Defines the name of the Scaling factor check box component.

Possible values:

• usescalingfactor

<value>

Scaling factor check box on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

Scaling Field

Elements, attributes and possible values

<component>

Scaling field on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Name of the Scaling text box component (field).

Possible values:

• scalingfactor

<value>

Scaling field on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• Numeric values.

  If the value is missing or invalid, the scaling field will be empty in the user interface and 1 will be used as the default value.

Currency Drop-Down List

Elements, attributes and possible values

<component>

Currency drop-down list on Advanced Options tab - path: <outlook><components><component>

Attributes

name: Defines the name of the Currency drop-down list component.

Possible values:

• currency

<value>

Currency drop-down list on Advanced Options tab - path: <outlook><components><component><value>

Defines the default value for the component:

Possible values:

• Group currency (default)

• Unit currency

• Currency ID of any currency added to the system.

If value is missing or invalid, the default value (group currency) will be used.

Show All Drill-Down Input Rows Check Box

Elements, attributes and possible values

<component>

Show All Input Drill-Down Rows Check Box on Advanced Options Tab - path: <outlook><components><component>

This component has an effect only on templates which include the account statement (drill-down) input function. Sum account levels are not opened automatically, and this option does not have an effect on other drill-down functions (viewing sub-account data and drilling down to figures).

Attributes

name: Defines the name of the Show all drill-down rows check box component.

Possible values:

• displaydrilldown

<value>

Show All Input Drill-Down Rows Check Box on Advanced Options Tab -path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• yes

• no (default)

XBRL Taxonomy Template Version Drop-Down List

Elements, attributes and possible values

<component>

Template version path: <outlook><components><component>

This component has an effect on XBRL report.

Attributes

name: Defines the name of the Template Version drop-down list component.

Possible values:

• templateversion

<value>

Template version path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• taxonomy template version, for example, SBR-2020-01-07-PWD,Version#1

Default Unit Extra Field Settings

The Extra Fields tab is available if it has been defined in the task settings. The options available on the tab also depend on the task settings. See Extra Fields Tab.

These settings have no effect on the Clausion Web Client, because extra field filtering is not available in the Web Client.

Object on screen	Value of name attribute	Visible	Enabled	Promote	Value	Other child elements
Default Unit Extra Field Settings on Extra Fields Tabs	dimextrafields	1 (false)	1 (false)	-	0-1	<extrafieldid>
						<operator>

Elements, attributes and possible values

<component>

Default unit extra field settings on Extra Fields tabs - path: <outlook><components><component>

Defines the default settings for an extra field on the Extra Fields tabs (see Extra Fields Tab).

Attributes

name: Defines the name of the component.

Possible values:

• dimextrafield

dimid: Defines the dimension for which the default extra field settings are defined.

Possible values:

• 0-n

<extrafieldid>

Default unit extra field settings on Extra Fields tabs - path: <outlook><components><component><extrafieldid>

Defines the extra field for which the settings are defined.

Possible values:

• field ID

If a dimension component with an extra field value has been removed, the extra field default value does not show on the Extra Fields tab. If the dimension component has the settings visible=true and promote=true, the extra field default value shows correctly.

<operator>

Default unit extra field settings on Extra Fields tabs - path: <outlook><components><component><operator>

Defines the default operator for the extra field.

Possible values:

• The operators available for the extra field in question.

<value>

Default unit extra field settings on Extra Fields tabs - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

• Depends on the operator. For example, two values for 'between', one for 'equals', multiple for 'contains'. Multiple values can be separated with a semicolon (;). For check box type extra fields, the values can be entered using the position numbers of the options (see Dimensions > Unit Extra Fields, the Options list of a check box type field).