Start2

Performs a start action for the specified process units and optionally attaches documents. The vbApplyToAllPeriods argument determines whether the action applies to one or to multiple process units.

Syntax

<HFMwManageProcess>.Start2 (bstrScenario, bstrYear, bstrPeriod, bstrEntity, bstrParent, bstrValue, vbApplyToAllPeriods, bstrComment, varabstrPaths, varabstrFiles)

Argument

Description

bstrScenario

The label of the Scenario dimension member for the process units.

Input argument. String subtype.

bstrYear

The label of the Year dimension member for the process units.

Input argument. String subtype.

bstrPeriod

The label of the Period dimension member for the process units.

Input argument. String subtype.

bstrEntity

The label of the Entity dimension member for the process units.

Input argument. String subtype.

bstrParent

The label of the parent of the entity specified in the bstrEntity argument.

Input argument. String subtype.

bstrValue

The label of the Value dimension member for the process units.

Input argument. String subtype.

vbApplyToAllPeriods

Specifies whether the action should be applied to process units for all input periods that intersect the other specified dimension members. Pass TRUE to apply the action to all these process units, FALSE to apply the action to only the specified process unit.

Input argument. Boolean subtype.

bstrComment

A user comment for the action, or an empty string if there is no comment.

Input argument. String subtype.

varabstrPaths

An array of strings containing the paths in which the documents to be attached have been loaded. Folders in paths are delimited by backslashes ( \ ).

This array has a one-to-one correspondence with the varabstrFiles argument’s array of filenames.

Input argument.

varabstrFiles

An array of strings containing the file names of the documents to attach.

Note:

Files must be loaded in the folder specified by the corresponding item in the varabstrPaths argument’s array, otherwise an error will be thrown.

Input argument.

Return Value

Returns a number that represents the review level. Valid values are represented by the constants listed in Process Management Review Level Constants. Long subtype.

Tip:

You can obtain a string that represents the review level by passing the return value to MapReviewLevelToString.

Example

The following example starts the specified process unit and attaches two files.

Dim iState, saPaths(1), saNames(1)
saPaths(0) = "docs"
saPaths(1) = "docs"
saNames(0) = "Audit.txt"
saNames(1) = "Comments.txt"
'cHFMProcMan is an HFMwManageProcess object reference
iState = cHFMProcMan.Start2("Budget", "2004", "August", "NewYork", _ 
  "UnitedStates","<EntityCurrency>", False, "see attachments", _ 
  saPaths, saNames)