GETENVIRONMENTINFO

Returns information about environment categories and properties. This information can be used by report designers to ensure that reports are displayed optimally in different environments, such as Dashboards and Apple Watch. The function is typically used in report load actions.

See Action modes.

The function is intended to be used with the category and property parameters specified.

These properties can be returned by GETENVIRONMENTINFO:

• HasMargin
• IsDialog
• HasTitle
• IsMing.le
• IsService
• Container Type
• Dashboard Caption
• Dashboard Name

If you do not specify the parameters of the function, it returns an XML table with two rows: Container and Global. Each row is a category.

If you specify only the category, the function returns an XML table of all properties in that category that have values.

If you specify a category and property, the function returns the value of the property.

Syntax

This syntax returns an XML table of all properties in a category, and their values:

=GETENVIRONMENTINFO("category")

This syntax returns the value of a specified property:

=GETENVIRONMENTINFO("category","property")

The function is intended to be used with a category and property specified but these parameters are not required.

This syntax returns an XML table of all categories and properties that have values:

=GETENVIRONMENTINFO()

The function ignores properties and categories that have no or empty values. For example, dashboard properties are not returned when the function is not run in Dashboards.