SubmitProcessStateChangeFromXML

Submits the process management changes specified in an XML string that is contained by an ASP Request object, 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 value returned by the pvarbstrXML argument to GenerateAlerts.

Syntax

<HFMwDataGrid>.SubmitProcessStateChangeFromXML (varpIRequest)

Argument	Description
varpIRequest	An ASP Request object containing an XML string that represents the process management action to be applied. The XML string is described in Table 6, Process Management XML String. Input 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, Process Unit XML String. Note: This argument returns an XML representation of process units only if e-mail alerting is enabled.

Argument

Description

varpIRequest

An ASP Request object containing an XML string that represents the process management action to be applied. The XML string is described in Table 6, Process Management XML String.

Input 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, Process Unit XML String.

Note:

This argument returns an XML representation of process units only if e-mail alerting is enabled.

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.

XML Strings for SubmitProcessStateChangeFromXML

The following table describes the XML string that represents process management actions.

Table 6. Process Management XML String

Element	Description
CHANGEPROCESSSTATE	Root element. This contains the Boolean descendants attribute, which indicates whether to apply the process management action to all descendants of the cells’ entities.
CELLS	Represents the grid cells to be processed. A <CELLS> tag contains one <CELL> tag for each cell.
CELL	Represents a cell to be processed. <CELL> contains the following attributes: row = The row number (0-based). col = The column number (0-based).
ACTION	A number that represents the action to apply. Valid values are represented by the HFMConstants type library enumeration CEnumProcessFlowActions, which is described in Process Management Action Constants.
REVIEWLEVEL	A number that represents the review level to apply. Valid values are represented by the HFMConstants type library enumeration CEnumProcessFlowStates, which is described in Process Management Review Level Constants.
COMMENT	The comment to apply to the process units.
ATTACHMENTS	Represents files to be attached to the process units. An <ATTACHMENTS> tag contains one <ATTACHMENT> tag for each file to be attached.
ATTACHMENT	Represents a file attachment, and contains the following attributes: name = The attachment’s file name. path = The attachment’s path.

The following table describes the XML string that represents successfully changed process units.

Table 7. Process Unit XML String

Element	Description
events	Root element. <events> contains the following attributes: xmlns = The namespace, which will be a URL similar to the following example: http://hyperion.com/HFM/4.1/Alerts/1.0 type = The string “ProcMgmt“. <events> also contains an <event> tag.
event	Represents the process management action and the users to be notified. <event> contains the following attributes: sid = The security identifier of the user who changed the process unit. user = The username of the user who changed the process unit. time = The date and time of the process management action. action = The label of the process management action. newState = The ID of the review level applied to the action’s process units. Review level IDs are represented by the HFMConstants enumeration CEnumProcessFlowStates, which is described in Process Management Review Level Constants. actionId = The ID of the process management action. Valid values are represented by the HFMConstants enumeration CEnumProcessFlowActions, which is described in Process Management Action Constants. <event> also contains a <comment> tag, as well as one <item> tag per process unit.
comment	Contains the comment for the process management action.
item	Represents a process unit to which the process management action has been applied. <item> contains the following attributes: scenarioLabel = The label of the process unit’s Scenario dimension member. yearLabel = The label of the process unit’s Year dimension member. periodLabel = The label of the process unit’s Period dimension member. entityLabel = The label of the process unit’s Entity dimension member. entityDesc = The description of the process unit’s Entity dimension member. action = A period-delimited string describing the process unit. Following is the string’s format: Scenario.Year.Period.Entity.OrigLevel The string’s first four items list the labels of the Scenario, Year, Period, and Entity dimensions. The last item contains the label of the process unit’s previous review level. origState = The ID of the process unit’s previous review level. newState = The ID of the process unit’s new review level.