Framework:FKT DimGetChildIndex

Function

This function returns the position of the child element (Child_CopSysId) below its parent element (Parent_CopSysId). The index is 0 based. This means that the first child element has 0 as an index. In the case of an error (dimension/paarent element/child element not found) “-1” is returned and a warning providing information on what caused the error is written into the ServerLog.

FKT_DimGetChildIndex(<dimension name>, <Parent_CopSysId>, <Child_CopSysId>)

Parameter	Description
Dimension name	Name of the dimension from which the index of an element is looked up.
Parent_CopSysId	COPSYS_ID of the parent element
Child_CopSysId	COPSYS_ID of the child element whose index is looked up

This function belongs to server-side functions.

Result

Index (position) of the child element with regard to the parent element

Example

The index of the Jan 05 element is to be returned

FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010103) = result 0

The index of the Jun 05 element is to be returned

FKT_DimGetChildIndex(dim_sys_time, 2005010101, 2005010603) = result 5