StartEx

Starts a process unit, and optionally starts all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.

To attach documents when starting, use Start2.

Syntax

<HsvProcessFlow>.StartEx lScenario, lYear, lPeriod, lEntity, lParent, lValue, vbUseAllValueMembers, vbApplyToAllPeriods, bstrAnnotation, psNewProcessState

Argument

Description

lScenario

Long (ByVal). The member ID of the process unit's Scenario dimension member.

lYear

Long (ByVal). The member ID of the process unit's Year dimension member.

lPeriod

Long (ByVal). The member ID of the process unit's Period dimension member.

lEntity

Long (ByVal). The member ID of the process unit's child Entity dimension member.

lParent

Long (ByVal). The member ID of the process unit's parent Entity dimension member.

lValue

Long (ByVal). The member ID of the process unit's Value dimension member.

vbUseAllValueMembers

Boolean (ByVal). Specifies whether process units for Value dimension members related to the lValue member are to be started. Pass TRUE to start related process units, FALSE to start only the process unit for the lValue member.

vbApplyToAllPeriods

Boolean (ByVal). Specifies whether to start the process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members. Pass TRUE to start these process units, FALSE otherwise.

If you specify TRUE and an error occurs for a period, Financial Management will attempt to start the other periods.

Note:

Specifying FALSE is the same as calling Start.

bstrAnnotation

String (ByVal). The comment for the process unit.

psNewProcessState

Integer. Returns PROCESS_FLOW_STATE_FIRST_PASS, which is the level constant for the First Pass level. This value applies to the Period and Value dimension members passed in the lPeriod and lValue arguments.

Example

This example starts the specified process unit and the process units that consist of the base Period dimension members and the specified members of the other dimensions. The calls to the user-defined GetMemberID function get the process unit’s member IDs; for information on GetMemberID, see the Examples for GetItemID. These member IDs are then passed to StartEx.

Dim lScen As Long, lYear As Long, lPer As Long
Dim lEnt As Long, lPar As Long, lVal As Long
Dim cHsvProcessFlow As HsvProcessFlow, iState As Integer
lScen = GetMemberID(DIMENSIONSCENARIO, "Budget")
lYear = GetMemberID(DIMENSIONYEAR, "2000")
lPer = GetMemberID(DIMENSIONPERIOD, "October")
lEnt = GetMemberID(DIMENSIONENTITY, "Connecticut")
lPar = GetMemberID(DIMENSIONENTITY, "UnitedStates")
lVal = GetMemberID(DIMENSIONVALUE, "USD")
Set cHsvProcessFlow = m_cHsvSession.ProcessFlow
cHsvProcessFlow.StartEx lScen, lYear, lPer, lEnt, lPar, lVal, _ 
False, True, "Champions", iState