{"id":28002,"date":"2017-06-16T14:16:52","date_gmt":"2017-06-16T06:16:52","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=28002"},"modified":"2026-03-10T13:27:36","modified_gmt":"2026-03-10T05:27:36","slug":"ddget","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/calculations\/ddget\/","title":{"rendered":"DDGet()"},"content":{"rendered":"\n

Format<\/h2>\n

DDGet(Hierarchy ,Depth ,Starting Entity ,Attribute [,Condition] [,Templates])<\/strong><\/p>\n

Returns<\/h2>\n

Returns the value of the specified attribute of each matching child\/parent entity in the specified hierarchy, in a single collection.<\/p>\n

It is possible to retrieve very large volumes of data through indiscriminate use of this function. Retrieving large amounts of Historian data across a slow network can affect system performance for all users of the system.<\/p>\n

Inputs<\/h2>\n

Hierarchy: <\/b>The name of the hierarchy in which to search.\u00a0
\nBehaviour: Required
\nDimensions: SingleValue
\nValid data types: String<\/p>\n

Depth<\/b>: The maximum number of levels to traverse in the hierarchy. Negative numbers indicate parent entities and positive numbers indicate child entities. E.g. 1 returns all immediate children, 2 returns all children and grandchildren, -1 returns all immediate parents, -2 returns all parents and grandparents.
\nBehaviour: Required
\nDimensions: SingleValue
\nValid data types: Integer<\/p>\n

Starting Entity<\/b>: The name of the entity at which to start the search.\u00a0
\nBehaviour: Required
\nDimensions: SingleValue
\nValid data types: String<\/p>\n

Attribute<\/b>: The attribute or attribute value to fetch for each entity. The format must follow the syntax used for fetching data objects (i.e. [TemplateName]:Attribute!AttributeValue<\/span>). The entity name is provided by the first parameter. If the [TemplateName<\/em>] is omitted, the function will assume the attribute belongs to the entity's primary template.\u00a0
\nBehaviour: Required
\nDimensions: SingleValue
\nValid data types: String<\/p>\n

Condition: <\/b>A condition which filters the list of entities to fetch data for. Attribute names can be specified in the condition using the data object fetch syntax, but without entity names as entities will be provided by metadata e.g. {[myTemplate]:myAttribute!myAttributeValue} > 15<\/span>. If the condition is omitted, the function returns the values for all entities.
\nBehaviour: Optional
\nDimensions: SingleValue
\nValid data types: String<\/p>\n

Templates<\/b>: List of template names that the returned entities must have assigned, within the time range of the fetch request. If an entity does not have one of these templates assigned, it will not appear in the results.\u00a0If the template filter is omitted, the fetch will be attempted on all entities (regardless of template) and errors will be returned if the entities don\u2019t have the attribute specified in the 4th parameter.
\nBehaviour: Optional (0..n)
\nDimensions: SingleValue
\nValid data types: String<\/p>\n

How to format data types<\/a><\/p>\n

Useful to Know<\/span><\/h2>\n

In the calculation engine, values returned by DD() functions have metadata assigned to them, such as entity name and start\/end times. Other DD() functions can use this metadata to assign additional information to values they receive. In this way, the metadata is used by nested DD() functions to reduce complexity but increase versatility. Which metadata is used and how it is used is specific to each function, and is described in the Input Values section above, where applicable.<\/p>\n

When to Use<\/span><\/h2>\n

This function can be used in place of a nested DDGetAttributes(DDGetEntities)<\/span> function.<\/p>\n