Skip to main content

User Interface Components for Internal Data Transfer 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.

  • 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.

For details of the common elements of the user interface components, see Common UI Elements for Internal Data Transfer Tasks.

Object on screen

Value of name attribute

Visible

Enabled

Promote

Value

Other child elements

Period Option

-

-

-

-

-

<multiselect>

<multiselectvalues>

<multiselectvalue>

Conversion Table Drop-Down List on Target Options Tab

conversiontable

1 (false)

1 (false)

*)

1

 

Replace Target Data Check Box

targetcleardata

1 (true)

1 (true)

*)

1 (no)

 

Delete Source Data Check Box

targetremovesourcedata

1 (true)

1 (true)

*)

1 (no)

 

Do Not Create Automatic Counter Entries Check Box

ignoreace

1 (true)

1 (true)

*)

1 (no)

 

Factor Field

targetscalingfactor

1 (true)

1 (true)

*)

-

 

Target Year Drop-Down List

targetyear

1 (true)

1 (true)

*)

-

 

Target Data Type Drop-Down List

targetdatatype

1 (true)

1 (true)

*)

-

 

Periodical Option

targetdatatypeperiod

1 (true)

1 (true)

*)

-

 

Cumulative Option

targetdatatypeaccumulated

1 (true)

1 (true)

*)

-

 

*) This setting has no effect on the Clausion Web Client.

Common UI Elements for Internal Data Transfer Tasks

This section describes the common elements of the <component> element, which are in use for the most of the user interface components of internal data transfer tasks.

Elements, attributes and possible values

<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

Period Option

Elements, attributes, and possible values

<multiselect>

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

Used for selecting several periods for a transfer.

The <multiselect> settings for period selection can be used only for the Internal Data Transfer task, not for input template and reporting tasks. For the general period option settings, see Period Drop-Down List.

Attributes

enabled: Defines whether users can select several periods for the Internal Data Transfer task. When the value is 'true', the period tree component is displayed on the Source Options 1 tab. If the value is 'false' or the setting is not used at all, the Period drop-down list is used instead of the tree component.

Possible values:

  • true

  • false (default)

If the <listperiods> setting is used, only the periods defined in the <listperiod> settings are available.

<multiselectvalues>

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

<multiselectvalue>

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

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

Possible values:

  • period ID

Conversion Table Drop-Down List

Elements, attributes, and possible values

<component>

Conversion Table Drop-Down List - path: <outlook><components><component>

Used for selecting a conversion table for internal data transfer. The conversion table drop-down lists are listed in the order they have been added to the task settings depending on the setting of the <visible> element.

Attributes

name: Defines the name of the conversion table drop-down list component.

Possible values:

  • conversiontable

id: Defines the ID of the conversion table drop-down list component.

Possible values:

  • account

  • voucherserie

  • period

  • dimnn (nn=00-09)

<value>

Conversion Table Drop-Down List - path: <outlook><components><component><value>

Defines the default value for the component.

Possible values:

  • The IDs of the conversion tables added in the system. The conversion tables can be added to the system in the Conversion Tables view (refer to Clausion Administrator's Online Help).

  • None (default)

Replace Target Data Check Box

Elements, attributes, and possible values

<component>

Replace target data check box - path: <outlook><components><component>

Attributes

name: Defines the name of the Replace target data check box component.

Possible values:

  • targetcleardata

cleartype: Defines the type of the data.

Possible values:

  • account

  • dimnn (dimensions available in the system)

<value>

Replace target data check box - path: <outlook><components><component><value>

Defines whether the check box is selected by default.

Possible values:

  • yes

  • no (default)

Delete Source Data Check Box

Elements, attributes, and possible values

<component>

Delete source data check box - path: <outlook><components><component>

Attributes

name: Defines the name of the Delete source data check box component.

Possible values:

  • targetremovesourcedata

<value>

Delete source data check box - path: <outlook><components><component><value>

Defines whether the check box is selected by default.

Possible values:

  • yes

  • no (default)

Do Not Create Automatic Entries Check Box

Elements, attributes, and possible values

<component>

Do not create automatic counter entries check box - path: <outlook><components><component>

Attributes

name: Defines the name of the Do not create automatic counter entries check box component.

Possible values:

  • ignoreace

<value>

Do not create automatic counter entries check box - path: <outlook><components><component><value>

Defines whether the check box is selected by default.

Possible values:

  • yes

  • no (default)

If the component is not included in the task settings, the check box is visible in the view but not selected.

Factor Field

Field shown on the Target Options tab.

Elements, attributes, and possible values

<component>

Factor field - path: <outlook><components><component>

Attributes

name: Defines the name of the Factor field component.

Possible values:

  • targetscalingfactor

Target Year Drop-Down List

Drop-down list shown on the Target Options tab.

Elements, attributes, and possible values

<component>

Target year drop-down list - path: <outlook><components><component>

Attributes

name: Defines the name of the Target year drop-down list component.

Possible values:

  • targetyear

Target Data Type Drop-Down List

Drop-down list shown on the Target Options tab.

Elements, attributes, and possible values

<component>

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

Attributes

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

Possible values:

  • targetdatatype

Periodical Option

Option shown on the Target Options tab.

Elements, attributes, and possible values

<component>

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

Attributes

name: Defines the name of the Periodical option component.

Possible values:

  • targetdatatypeperiod

Cumulative Option

Option shown on the Target Options tab.

Elements, attributes, and possible values

<component>

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

Attributes

name: Defines the name of the Cumulative option component.

Possible values:

  • targetdatatypeaccumulated

Was this article helpful?

We're sorry to hear that.