6.2 Types of Data Objects
There are three main types of data objects:
- Numeric (monetary, decimal, integer, etc.)
- Date
- Text
Properties of Data Objects
When selecting a single object its properties will be displayed in the Value Editor:
It is also possible to view and modify the properties of all data objects within the segment in the Tags panel’s Data Objects view:
Data objects contain a position number based on the position that they appear in the segment. The number is dynamic meaning that if any data objects are added or deleted from an earlier position, all subsequent data objects will have their position number amended. The position numbers are useful when creating calculations and are visible in both the Value Editor panel and the Tags panel.
Numeric Data Objects
Numeric data objects can be inserted into the report by using a numeric XBRL tag or a numeric item in the automation panel. If using the metadata from an external data source, the type is assumed to be monetary.
Properties of numeric data objects:
- Adaptor - This property defines the source of the value of the data object. By default it is “Manual” meaning that a user can manually type a value in the “Source value:” property.
- Source value - For any adaptor other than manual, this field will be protected and its value determined by the Data Adaptor.
- Source scale - Use the source scale drop-down list to specify what the scale of the source data is. E.g. if “1,000” in the data source represents “1,000,000” in unit terms then set the source scale equal to “’000s (Thousands)”. The default source scale of all new data objects is set during the New Document wizard but can be changed in File – Options.
- Destination scale - Use this field to specify at what scale the data object must be displayed in the report. For monetary data objects, this value will default to the value specified in the New Document wizard when the report was first created (which can be changed in File – Option). All other numerical data objects will be defaulted to “Units”.
- Significant decimals - Use the up and down arrows to adjust the significant decimals to display. This adjusts the value which has already been scaled. Report Authority rounds the value to the significant decimals, and this value is used on the face of the report and in calculations involving the data object.
E.g. “$1.1m” and “$10.5k” will both have a significant decimal of “1”. - Rounding adjustment - The rounding adjustment property is used to adjust the Data Object’s value, typically for eliminating rounding adjustments. The adjustment will always be made to the significant decimal defined in the previous step. The actual value of the rounding adjustment is a product of both the destination scale and the significant decimals. Rounding adjustments will be cleared when the data adaptors are refreshed and the source value has changed.
E.g. if the destination scale is “’000,000s (Millions), and the significant decimals is 2, the actual value of the rounding adjustment of “1” is “10,000”. If the destination scale or significant decimal value is subsequently changed, so will the ultimate value of the rounding adjustment. - Reverse signage - The reverse signage checkbox can be used to reverse the data object’s value.
This is useful when, for example, the signage convention in the source trial balance has a negative for credit balances and it is a requirement that creditors are shown as positive values in the report.
Date Data Objects
Date data objects can be inserted into the report by using a date XBRL tag or a date item in the Automation panel.
Properties of date data objects:
- Adaptor - This property defines where the value of the adaptor will be determined. By default it is “Manual” meaning that a user can manually select a date using the calendar control. It is very common to use one of the Report Variables to automate dates such as current period closing or opening dates.
- Source value - For any adaptor other than manual, this field will be protected and its value determined by the Data Adaptor. For a Manual adaptor, a user can manually select a date using the calendar control.
- Format - The format field specifies the format that the date that will be displayed on the face of the document. This can allow, for example, the formatting of a data object as “31 December 2011” or “31/12/2011”.
Report Authority uses the computer’s defined number formats for long and short dates based on the computer’s region. To override the system default formatting, enter a custom long date formatting string in File > Options. For example the long date may be displayed as "Monday, 31 December 2020" . To override this format, enter "dd MMMM yyyy" as the long date formatting string to instead show "31 December 2020" - Do not print - Use this option to omit the date from the printed document. This is useful when the date will be manually written on a printed document, such as the date of approval.
Text Data Objects
Text data objects can be inserted into the report by using a numeric XBRL tag or a text item in the automation panel.
Properties of text data objects:
The values of text data objects are only displayed and editable in the Report panel. The content of text data objects with a Data Adaptor of Manual can be edited directly in the report.
- Adaptor - This property defines where the value of the adaptor will be determined. By default, it is “Manual” meaning that a user can manually amend the text directly in the segment editor.
- Do not print - Use this option to omit the text from the printed document. This is useful when the text is to be manually written on a printed document, such as the name of the director approving the document.
If the text data object is XBRL tagged with a tag that requires the content to match a particular pattern, the value can only be edited in the Source Value control even if its adaptor is set to Manual.
Data Object Name and Period
- Name - This field is optional and used to specify a name for the data object to make it easier to refer to in calculations (see Calculations) or validation rules (see. Validation Rules). If no specific name is given to the data object, Report Authority will automatically specify the name of the data object based on its XBRL tag (if any) and position number within the segment.
- Period - Use this field to change a data object’s period.
The period of multiple data objects can be changed at the same time if they are XBRL tagged and the Period combo box in the XBRL Tags ribbon is changed instead.