Dynamic Attributes - Revision history

Vmurrell at 12:08, 10 September 2023

2023-09-10T12:08:39Z

Vmurrell at 15:21, 4 September 2023

2023-09-04T15:21:02Z

Mnelson: Mnelson moved page Dynamic Series Attributes to Dynamic Attributes

2020-10-29T20:18:35Z

Mnelson moved page Dynamic Series Attributes to Dynamic Attributes

Mnelson: /* Overview */

2020-10-29T11:20:07Z

‎Overview

Mnelson: /* Making an Attribute Dynamic */

2020-10-29T11:17:29Z

‎Making an Attribute Dynamic

Mnelson: /* Example */

2020-10-29T11:17:18Z

‎Example

Mnelson: /* Example */

2020-10-29T11:17:04Z

‎Example

Mnelson: /* Making an Attribute Dynamic */

2020-10-29T11:16:28Z

‎Making an Attribute Dynamic

Mnelson: Created page with "Category:DynamicData == Overview == A '''Dynamic Attribute''' is a series attribute defined in a Data Structure Definition where the value for the attribute is derived at..."

2020-10-29T11:15:24Z

Created page with "Category:DynamicData == Overview == A '''Dynamic Attribute''' is a series attribute defined in a Data Structure Definition where the value for the attribute is derived at..."

New page

[[Category:DynamicData]]

== Overview ==
A '''Dynamic Attribute''' is a series attribute defined in a Data Structure Definition where the value for the attribute is derived at the time the dataset is generated. The derived value may include a mixture of hard coded text and reported values from any number of Dimensions for the series.

A typical use case is to provide a ''Series Title'' giving each series a human readable description of what data the series is describing. If the series title attribute is set to be a dynamic series attribute then the text for the series title can be derived from other dimensions such as reporting country, series indicator, frequency, and so on. Therefore a derived title may look something like this:

'''Annual''' data of '''employment status''' in the '''United Kingdom'''

Where the terms '''Annual''', '''employment status''', and '''United Kingdom''' are taken from the '''Frequency''', '''Indicator''', and '''Country''' dimension respectively.

== Supported Features ==
* Dynamic Attributes can be applied to Series, Observation, and Group level attributes
* Multilingual text is supported
* Variable placeholders enable the text to contain Code Ids, Labels, and Descriptions for any coded Dimension value

== Making an Attribute Dynamic ==
To create a dynamic series attribute, add an Annotation to the Attribute with the Annotation Type of '''FR_DYNAMIC'''. The Annotation Text holds the text to output, and can be provided in each locale that requires support in the output.

Variable placeholders are supported using the syntax: $[COMPONENT_ID] for example $[FREQ], the id, name or description of the coded value can be used by adding the postfix .id, .name or .desc

Example

{| class="wikitable"
|-
! Variable Example !! Output Text Example
|-
| $[INDICATOR.id] || EMP
|-
| $[INDICATOR.name] || Employment
|-
| $[INDICATOR.desc] || Status in employment
|}

← Older revision		Revision as of 12:08, 10 September 2023
Line 1:		Line 1:
−	~~[[Category:DynamicData]]~~
	[[Category:How_To]]		[[Category:How_To]]

← Older revision		Revision as of 15:21, 4 September 2023
Line 1:		Line 1:
	[[Category:DynamicData]]		[[Category:DynamicData]]
		+	[[Category:How_To]]

	== Overview ==		== Overview ==

@@ Line 31: / Line 31: @@
 | $[INDICATOR.desc] || Status in employment
 |}
 == Example ==

@@ Line 35: / Line 35: @@
 == Example ==
-Attribute=SERIES_TITLE <br/>
+'''Attribute''' = SERIES_TITLE <br/>
-Annotation Type = FR_DYNAMIC <br/>
+'''Annotation Type''' = FR_DYNAMIC <br/>
-Annotation Text (en) = $[FREQ.name] data of $[INDICATOR.name] in the $[COUNTRY.name]
+'''Annotation Text''' (en) = $[FREQ.name] data of $[INDICATOR.name] in the $[COUNTRY.name]

@@ Line 35: / Line 35: @@
 == Example ==
-Attribute=SERIES_TITLE
+Attribute=SERIES_TITLE <br/>
-Annotation Type = FR_DYNAMIC
+Annotation Type = FR_DYNAMIC <br/>
-Annotation Text (en) =
+Annotation Text (en) = $[FREQ.name] data of $[INDICATOR.name] in the $[COUNTRY.name]

← Older revision	Revision as of 20:18, 29 October 2020
(No difference)

@@ Line 4: / Line 4: @@
 A '''Dynamic Attribute''' is a series attribute defined in a Data Structure Definition where the value for the attribute is derived at the time the dataset is generated.  The derived value may include a mixture of hard coded text and reported values from any number of Dimensions for the series.
-A typical use case is to provide a ''Series Title'' giving each series a human readable description of what data the series is describing.  If the series title attribute is set to be a dynamic series attribute then the text for the series title can be derived from other dimensions such as reporting country, series indicator, frequency, and so on.  Therefore a derived title may look something like this:
+A typical use case is to provide a ''Series Title'' giving each series a human readable description of what data the series is describing.  If the series title attribute is set to be a dynamic series attribute then the text for the series title can be derived from other dimensions such as reporting country, series indicator, frequency, and so on.  Therefore, a derived title may look something like this:
 '''Annual''' data of '''employment status''' in the '''United Kingdom'''

@@ Line 20: / Line 20: @@
 Variable placeholders are supported using the syntax: $[COMPONENT_ID] for example $[FREQ], the id, name or description of the coded value can be used by adding the postfix .id, .name or .desc
-Example
+'''Example'''
 {| class="wikitable"
 |-
@@ Line 32: / Line 31: @@
 | $[INDICATOR.desc] || Status in employment
 |}