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“. display = The string “Process Control”.
<events> also contains an <event> tag. |
event | Represents the process management actions and the users to be notified. <event> contains the following attributes: sid = The user’s security identifier. user = The user’s username. time = The date and time of the process management action. action= A string describing the new review level. newState = The ID of the new review level for the action’s first process unit. 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. display = The string used in the subject of the e-mail sent to the user who changed the process unit. scenarioLabel = The label of the Scenario dimension member for the action’s first process unit. yearLabel = The label of the Year dimension member for the action’s first process unit. periodLabel = The label of the Period dimension member for the action’s first process unit. entityLabel = The label of the Entity dimension member for the action’s first process unit.
<event> also contains <comment> and <target> tags, as well as one <item> tag per process unit. Note: The user who performed the action is represented by the <target> tag that is a child of <event>, and the users to be notified are represented by the <target> tags that are children to the <item> tags. |
comment | Contains the comment for the process management action. |
target | Represents the user who performed the process management action. and contains the following attributes: |
item | Represents a process unit for which a notification is being generated, as well as the users to be e-mailed. <item> contains the following attributes: Represents the process unit and 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. display = The string used in the subject of the e-mail sent to the user who changed the process unit.
<item> also contains one <target> tag for each user to be notified. |
target | Represents a user to be notified, and contains the following attributes: |