ExecuteDataExplorerProcessManagementTask

Executes a process management task for the specified range of cells.

To attach documents while executing a process management task, use ExecuteDataExplorerProcessManagementTask2. To attach documents and return an XML string that can be passed to GenerateAlerts, use ExecuteDataExplorerProcessManagementTask3.

Syntax

<HFMwDataGrid>.ExecuteDataExplorerProcessManagementTask (lProcessMgmtActionID, lRowStart, lColStart, lRowEnd, lColEnd, sPromotionLevel, bstrComments, pvarsNewState)

Argument

Description

lProcessMgmtActionID

The ID of the task to be executed. These IDs are represented by the HFMConstants type library constants listed in Data Explorer Process Management Constants.

Input argument. Long subtype.

lRowStart

The index (0-based) that identifies the first row in the range of cells.

Input argument. Long subtype.

lColStart

The index (0-based) that identifies the first column in the range of cells.

Input argument. Long subtype.

lRowEnd

The index that identifies the last row in the range of cells.

Input argument. Long subtype.

lColEnd

The index that identifies the last column in the range of cells.

Input argument. Long subtype.

sPromotionLevel

Indicates the level to which to promote. This argument applies only if the method is promoting. Promotion levels are represented by the numbers in the following list:

  • 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

    Note:

    For tasks other than promoting, you must pass an integer, but the value passed will have no effect.

Input argument. Integer subtype.

bstrComments

The comment for the task.

Input argument. String subtype.

pvarsNewState

Returns the number that identifies the level to which the process unit has been promoted. If the promotion succeeds, this should be equal to the number passed in the sPromotionLevel argument.

Output argument.

Return Value

Returns an HRESULT – 0 indicates success, a non-zero value indicates an error. You should always check the return value for a non-zero HRESULT.

Tip:

You can use the HsvResourceManager object to obtain more information on non-zero return values. For details, see HsvResourceManager Object Methods.