HsvProcessFlow Type Library Overview

The HsvProcessFlow type library contains one object, the HsvProcessFlow object. Use the HsvProcessFlow object to execute Process Management-related features such as taking actions for and getting histories of process units and submission phases.

The HsvProcessFlow object is a child of the HsvSession object. Use HsvSession’s ProcessFlow property to assign HsvProcessFlow object references as shown in the following example:

  Dim cHsvProcessFlow As HsvProcessFlow
  Set cHsvProcessFlow = cHsvSession.ProcessFlow

The following table lists the methods of the HsvProcessFlow object.

Table 29. HsvProcessFlow Object Methods

Method	Description
Approve	Approves a process unit.
Approve2	Approves a process unit, and optionally attaches documents and approves all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.
ApproveEx	Approves a process unit, and optionally approves all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.
GetGroupPhaseFromCell	Returns the IDs of the submission group and submission phase to which a given cell is assigned.
GetHistory	Returns arrays containing the dates and times, users, actions, states, and comments of a process unit.
GetHistory2	Returns arrays containing the history of a process unit; the process unit’s dates and times, users, actions, levels, comments, and names and paths of attached document are returned.
GetState	Returns the current state of a process unit.
GetPhasedSubmissionHistory	Returns arrays containing the history of a submission phase, given the member IDs of a cell in the phase.
GetPhasedSubmissionState	Returns the current review level of a given cell’s submission phase.
GetPhasedSubmissionStateUsingPhaseID	Returns the review level of a submission phase, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionApprove	Approves a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionApprove2	Approves a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionApproveEx	Approves a submission phase, and optionally applies the action to submission phases for all base periods that intersect with the specified non-Period dimension members, given the member IDs of a cell in the phase.
PhasedSubmissionGetHistory2	Returns arrays containing the history of a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionGetHistory2UsingPhaseID	Returns arrays containing the history of a submission phase, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionProcessManagementChange StateForMultipleEntities2	Applies a given process management action and attaches documents to submission phases for multiple Entity dimension members, given the member IDs of cells in the phases.
PhasedSubmissionPromote	Promotes a submission phase to a specified review level, given the member IDs of a cell in the phase.
PhasedSubmissionPromote2	Promotes a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionPublish	Publishes a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionPublish2	Publishes a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionPublishEx	Publishes a submission phase, and optionally applies the action to submission phases for all base periods that intersect with the specified non-Period dimension members, given the member IDs of a cell in the phase.
PhasedSubmissionReject	Rejects a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionReject2	Rejects a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionSignOff	Signs off on a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionSignOff2	Signs off on a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionStart	Starts a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionStart2	Starts a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
PhasedSubmissionStartEx	Starts a submission phase, and optionally applies the action to submission phases for all base periods that intersect with the specified non-Period dimension members, given the member IDs of a cell in the phase.
PhasedSubmissionSubmit	Submits a submission phase, given the member IDs of a cell in the phase.
PhasedSubmissionSubmit2	Submits a submission phase and optionally attaches documents, given either the member IDs of a cell in the phase or the phase ID.
ProcessManagementChangeStateForMultipleEntities	Applies a given process management action to process units for one or more Entity dimension members.
ProcessManagementChangeStateForMultipleEntities2	Applies a given process management action and attaches documents to process units for one or more Entity dimension members.
ProcessManagementChangeStateForMultipleEntitiesEx	Applies a given process management action and attaches documents to submission phases for multiple Entity dimension members, given the member IDs of cells in the phases.
Promote	Promotes a process unit to a specified review level.
Promote2	Promotes a process unit to a specified review level, and provides the option of attaching one or more documents.
Publish	Publishes a process unit.
Publish2	Publishes a process unit, and optionally attaches documents and publishes all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.
PublishEx	Publishes a process unit, and optionally publishes all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.
Reject	Demotes a process unit from its current state to its previous state.
Reject2	Demotes a process unit from its current level to its previous level and optionally attaches documents.
SignOff	Signs off on a process unit.
SignOff2	Signs off on a process unit and attaches documents.
Start	Starts a process unit.
Start2	Starts a process unit, and optionally attaches documents and starts all other process units that consist of the specified Scenario, Year, Entity, and Value dimension members and the other base Period dimension members.
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.
Submit	Submits a process unit.
Submit2	Submits a process unit and provides the option to attach one or more documents.

For detailed descriptions of these methods, see HsvProcessFlow Type Library.