GetCalcStatusSummaryAsXML

Returns an XML string summarizing the calculation statuses of the grid’s entities that intersect the grid’s scenario, year, and periods. For each period, the XML string consists of one element per calculation status; each element contains the number of entities that have that calculation status.

The counts for each status are based upon the grid’s top Entity dimension member and the Entity dimension’s member list. If no member list is specified for the grid, then the [Hierarchy] member list is used.

If Organization by Period is enabled for the grid, only information for active entities is returned.

Tip:

To specify a grid’s Organization by Period setting, use SetOrgByPeriodFilteringInfo.

Syntax

<HFMwDataGrid>.GetCalcStatusSummaryAsXML pvarbstrXML

Argument

Description

pvarbstrXML

Returns an XML string that summarizes the entities’ calculation statuses. The XML string is described in Table 4.

Output argument.

The following table describes the XML string returned by GetCalcStatusSummaryAsXML.

Table 4. GetCalcStatusSummaryAsXML XML String

Element

Description

CALCSUMMARY

Root element.

PERIOD

Specifies the period for which status information is returned; the period label is included in the name attribute. Each <PERIOD> tag contains the calculation tags described in the following rows.

OK

The number of entities that have the OK status.

OKSC

The number of entities that have the OKSC status.

NODATA

The number of entities that have the NODATA status.

CH

The number of entities that have the CH status.

CN

The number of entities that have the CN status.

TR

The number of entities that have the TR status.

OKND

The number of entities that have the OKND status.

CHND

The number of entities that have the CHND status.

CNND

The number of entities that have the CNND status.

TRND

The number of entities that have the TRND status.

LOCKED

The number of entities that have the LOCKED status.