GetMonitorICTransactions

Indicates whether one or more Entity dimension members have intercompany transactions for given Scenario, Year, and Period dimension members. For the entities that have intercompany transactions, GetMonitorICTransactions returns an array that consists of the entities’ member IDs, process and locking statuses, and usernames and timestamps for the most recently modified transactions.

Syntax

<HsvICM>.GetMonitorICTransactions lScenario, lYear, lPeriod, varalEntities, lSortFilterOptions, lFromRec, lMaxRows, plTotalEntities, pvara2DMonitor

Argument

Description

lScenario

Long (ByVal). The member ID of the Scenario dimension member.

lYear

Long (ByVal). The member ID of the Year dimension member.

lPeriod

Long (ByVal). The member ID of the Period dimension member.

varalEntities

Long array (ByVal). The member IDs of the Entity dimension members.

lSortFilterOptions

Long (ByVal). Specifies filtering and sorting options for the information returned by the pvara2DMonitor argument. Valid values are represented by the HFMConstants enumeration tagICM_MONITOR_FILTER_SORT_FLAGS, which is described in Filtering and Sorting Options.

You can use the addition operator ( + ) with the enumeration’s constants to specify combinations of filtering and sorting options. The following example filters for both Started and Not Started process statuses:

ICM_MONITOR_FILTER_STARTED + ICM_MONITOR_FILTER_NOTSTARTED

lFromRec

Long (ByVal). The index of the first entity within the set of entities that match the criteria to include in the array returned by the pvara2DMonitor argument.

lMaxRows

Long (ByVal). The maximum number of transactions to include in the array returned by the pvara2DMonitor argument.

plTotalEntities

Long. Returns the number of Entity dimension members that match the criteria.

pvara2DMonitor

Variant. Returns a two-dimensional array containing information for the entities that have intercompany transactions. The first dimension consists of five elements, and the second dimension contains one element for each entity that has intercompany transactions.

The following list describes the elements in the first dimension.

  • Element 0 returns the member IDs of the entities.

  • Element 1 returns the process statuses for the entities. Valid values are represented by the HFMConstants enumeration tagICMENTITYPROCESSSTATUS, which is described in Process Status Constants.

  • Element 2 returns the process statuses for the entities. Valid values are represented by the HFMConstants enumeration tagICMENTITYSTATUS, which is described in Lock Status Constants.

  • Element 3 returns the usernames of the users who most recently modified transactions for the entities.

  • Element 4 returns the timestamps of the most recently modified transactions for the entities.