Returns a property of the given KPI.
Syntax
XL3KpiPropertyLookup( Connection, KpiName, KpiProperty )
Parameters
| Parameter | Description |
| Connection | Connection number to use. |
| KpiName | The name of the KPI to use. |
| KpiProperty | The name of the property to return. |
KPI Properties
XL3KpiPropertyLookup supports properties:
| Property name | Description |
| MEASUREGROUP_NAME | The associated measure group for the KPI. |
| KPI_NAME | The name of the KPI. |
| KPI_CAPTION | A label or caption associated with the KPI. Used primarily for display purposes. If a caption does not exist, KPI_NAME is returned. |
| KPI_DESCRIPTION | A human-readable description of the KPI. |
| KPI_DISPLAY_FOLDER | A string that identifies the path of the display folder that the client application uses to show the member. |
| KPI_VALUE | The unique name of the member in the measures dimension for the KPI Value. |
| KPI_GOAL | The unique name of the member in the measures dimension for the KPI Goal. |
| KPI_STATUS | The unique name of the member in the measures dimension for the KPI Status. |
| KPI_TREND | The unique name of the member in the measures dimension for the KPI Trend. |
| KPI_STATUS_GRAPHIC | The default graphical representation of the KPI. |
| KPI_TREND_GRAPHIC | The default graphical representation of the KPI. |
| KPI_WEIGHT | The unique name of the member in the measures dimension for the KPI Weight. |
| KPI_CURRENT_TIME_MEMBER | The unique name of the member in the time dimension that defines the temporal context of the KPI. |
| KPI_PARENT_KPI_NAME | The name of the parent KPI. |
