ExecuteDataExplorerProcessManagementTask3

Executes a process management task for the specified range of cells, optionally attaches documents, and, if e-mail alerting is enabled, returns a list of the process units that may require alerts.

Note:

To get information on users who should receive e-mail alerts for the process units, pass the string returned by the pvarbstrXML argument to GenerateAlerts.

Syntax

<HFMwDataGrid>.ExecuteDataExplorerProcessManagementTask3 (lProcessMgmtActionID, lRowStart, lColStart, lRowEnd, lColEnd, sPromotionLevel, bstrComments, varavarAttPaths, varavarAttFiles, pvarsNewState, pvarbstrXML)

Argument	Description
lProcessMgmtActionID	The ID of the task to be executed. These IDs are represented by the HFMConstants enumeration tagWEBOM_DATAGRID_PROCESSFLOWACTION_ENUM, which is described 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: 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 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.
varavarAttPaths	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 varavarAttFiles argument’s array of filenames. Input argument.
varavarAttFiles	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 varavarAttPaths argument’s array, otherwise an error will be thrown. Input argument.
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. Input/output argument.
pvarbstrXML	Returns an XML string representing the process units that were successfully changed. The format of the XML string is described in Table 7. Note: This argument returns an XML representation of process units only if e-mail alerting is enabled. Input/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.