ProcessFlowGetInfo

Returns a variety of process management-related information for the specified cell.

Tip:

To return this process management information as an XML string, use ProcessFlowGetInfoAsXML. To return the names and paths of document attachments with this type of information, use ProcessFlowGetInfo2.

Syntax

<HFMwDataGrid>.ProcessFlowGetInfo lRow, lCol, pvarbstrScenario, pvarbstrYear, pvarbstrPeriod, pvarbstrEntity, pvarbstrParent, pvarbstrValue, pvarbstrUserName, pvaravarbAccessRightsToProcessFlowRoles, pvarlSecurityClassAccessRightsToSubCube, pvarlCompleteAccessRightsToSubCube, pvarsProcessState, pvaravardTime, pvaravarbstrUser, pvaravarsAction, pvaravarsNewState, pvaravarbstrAnnotation

Argument

Description

lRow

The index (0-based) that identifies the cell’s row.

Input argument. Long subtype.

lCol

The index (0-based) that identifies the cell’s column.

Input argument. Long subtype.

pvarbstrScenario

Returns the name of the cell’s scenario.

Output argument.

pvarbstrYear

Returns the name of the cell’s year.

Output argument.

pvarbstrPeriod

Returns the name of the cell’s period.

Output argument.

pvarbstrEntity

Returns the name of the cell’s child entity.

Output argument.

pvarbstrParent

Returns the name of the cell’s parent entity.

Output argument.

pvarbstrValue

Returns the name of the cell’s Value dimension member.

Output argument.

pvarbstrUserName

Returns the username of the currently connected user.

Output argument.

pvaravarbAccessRightsToProcessFlowRoles

Returns an array of Booleans indicating the connected user’s access rights for the various process management roles.

The array contains an item for each process management-related role. The HFMConstants type library constants that represent roles are listed in Role Constants.

An array item returns TRUE if the user has access to the role, FALSE otherwise.

Output argument.

pvarlSecurityClassAccessRightsToSubCube

Returns the connected user’s access rights to the security class that applies to the cell. Access rights are represented by the HFMConstants type library constants listed in Access Rights Constants.

Output argument.

pvarlCompleteAccessRightsToSubCube

Returns the connected user’s access rights to the cell’s process unit. Access rights are represented by the HFMConstants type library constants listed in Access Rights Constants.

Output argument.

pvarsProcessState

Returns the current process management state of the cell. The following list shows the numbers that represent process management states:

  • 1 = Not Started

  • 2 = First Pass

  • 3 = Review Level 1

  • 4 = Review Level 2

  • 5 = Review Level 3

  • 6 = Review Level 4

  • 7 = Review Level 5

  • 8 = Review Level 6

  • 9 = Review Level 7

  • 10 = Review Level 8

  • 11 = Review Level 9

  • 12 = Review Level 10

  • 13 = Submitted

  • 14 = Approved

  • 15 = Published

Output argument.

pvaravardTime

Returns an array of DateTimeStamps for the cell’s process management actions.

Output argument.

pvaravarbstrUser

Returns an array of the usernames who performed the cell’s process management actions.

Output argument.

pvaravarsAction

Returns an array of the cell’s process management actions. The valid return values are represented by the HFMConstants type library constants listed in Data Explorer Process Management Constants.

Output argument.

pvaravarsNewState

Returns an array of the states that resulted from the cell’s process management actions.

Output argument.

pvaravarbstrAnnotation

Returns an array of the comments for the cell’s process management actions.

Output argument.