GetPhasedSubmissionHistory

Returns arrays containing the history of a submission phase, given the member IDs of a cell in the phase. The arrays have a one-to-one correspondence.

Syntax

<HsvProcessFlow>.GetPhasedSubmissionHistory lScenario, lYear, lPeriod, lEntity, lParent, lValue, lAccount, lICP, lCustom1, lCustom2, lCustom3, lCustom4, pvaradTime, pvarabstrUser, pvarasAction, pvarasNewState, pvarabstrAnnotation
ArgumentDescription
lScenarioLong (ByVal). The member ID of the process unit's Scenario dimension member.
lYearLong (ByVal). The member ID of the process unit's Year dimension member.
lPeriodLong (ByVal). The member ID of the process unit's Period dimension member.
lEntityLong (ByVal). The member ID of the process unit's child Entity dimension member.
lParentLong (ByVal). The member ID of the process unit's parent Entity dimension member.
lValueLong (ByVal). The member ID of the process unit's Value dimension member.
lAccountLong (ByVal). The member ID of the cell’s Account dimension member.
lICPLong (ByVal). The member ID of the cell’s Intercompany Partner dimension member.
lCustom1Long (ByVal). The member ID of the cell’s Custom1 dimension member.
lCustom2Long (ByVal). The member ID of the cell’s Custom2 dimension member.
lCustom3Long (ByVal). The member ID of the cell’s Custom3 dimension member.
lCustom4Long (ByVal). The member ID of the cell’s Custom4 dimension member.
pvaradTimeVariant array. Returns an array of the submission phase's times and dates. The array is returned as a Double sub-type.

The numbers returned in this array are in a standard date format; for example, in Visual Basic you can convert an array element by passing it to CDate.

pvarabstrUserVariant array. Returns an array of the usernames that have performed actions for the submission phase. The usernames are fully qualified.

The array is returned as a String sub-type.

pvarasActionVariant array. Returns an array of the submission phase’s actions. The valid return values are listed in Table 135, CEnumProcessFlowActions Enumeration.

The array is returned as an Integer sub-type.

pvarasNewStateVariant array. Returns an array of the submission phase’s review levels. The valid return values are listed in Table 136, CEnumProcessFlowStates Enumeration.

The array is returned as an Integer sub-type.

pvarabstrAnnotationVariant array. Returns an array of the submission phase’s comments. The array is returned as a String sub-type.

Example

The following function returns the review levels that resulted from a given user's actions upon a submission phase.

Function GetUserPhaseStates(lScen As Long, lYear As Long, lPer As Long, _
    lEnt As Long, lPar As Long, lVal As Long, lAcct As Long, lIcp As _
    Long, lC1 As Long, lC2 As Long, lC3 As Long, lC4 As Long, sUser _
    As String) As Variant
Dim cProcessFlow As HsvProcessFlow, vaTimes, vaUsers, vaActions, vaStates
Dim vaNotes, vaRet(), lCounter As Long
lCounter = -1
'g_cSession represents an HsvSession instance
Set cProcessFlow = g_cSession.ProcessFlow
cProcessFlow.GetPhasedSubmissionHistory lScen, lYear, lPer, lEnt, lPar, _
   lVal, lAcct, lIcp, lC1, lC2, lC3, lC4, vaTimes, vaUsers, vaActions, _
   vaStates, vaNotes
For i = LBound(vaUsers) To UBound(vaUsers)
    If vaUsers(i) = sUser Then
        lCounter = lCounter + 1
        ReDim Preserve vaRet(lCounter)
        vaRet(lCounter) = vaStates(i)
    End If
Next i
GetUserPhaseStates = vaRet
End Function