ARSetEscalationToXML

Description

Saves information about an escalation in an XML document.

Privileges

All users.

Synopsis

#include "arextern.h"

int ARsetEscalationToXML(
ARControlStruct *control,
  ARXMLOutputDoc *xmlOutputDoc,
  ARBoolean xmlDocHdrFtrFlag,
  ARNameType escalationName,
  AREscalationTmStruct *escalationTime,
  ARWorkflowConnectStruct *workflowConnect,
  unsigned int *enabled,
  ARQualifierStruct *query,
  ARFilterActionList *ifActionList,
  ARFilterActionList *elseActionList,
  ARAccessNameType owner,
  ARAccessNameType lastModifiedBy,
  ARTimestamp *modifiedDate,
  char *helpText,
  char *changeHistory,
  ARPropList *objPropList,
  unsigned int *arDocVersion,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user, sessionId, and server fields are required.

xmlOutputDoc

The XML document output source.

xmlDocHdrFtrFlag

The header and footer flag for the XML document output source. If there is only one object in the XML document, set this value to (0).

escalationName

The name of the escalation. Each escalation name must be unique.

escalationTime

The time specification for evaluating the escalation condition. This parameter can take one of two forms: a time interval that defines how frequently the server checks the escalation condition (in seconds) or a bitmask that defines a particular day (by month or week) and time (hour and minute) for the server to check the condition. Specify NULL for this parameter if you do not want to retrieve this value.

workflowConnect

The list of form names the escalation is linked to. The escalation must be associated with a single form or a list of forms that currently exists on the server. Specify NULL for this parameter if you do not want to retrieve this value.

enabled

A flag that specifies whether the escalation is disabled (0) or enabled (1). Specify NULL for this parameter if you do not want to retrieve this value.

query

A query operation performed when the escalation is executed that determines the set of entries to which the escalation actions (defined by the actionList parameter) are applied. The system returns 0 (AR_COND_OP_NONE) if the escalation has no qualification. Specify NULL for this parameter if you do not want to retrieve this value.

ifActionList

The set of actions performed for each entry that matches the criteria defined by the query parameter. This list can contain from 1 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

elseActionList

The set of actions performed if no entries match the criteria defined by the query parameter. This list can contain from zero to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve this value.

owner

The escalation owner.

lastModifiedBy

The user who last modified the escalation.

modifiedDate

The date that the escalation was last modified.

helpText

The help text associated with the escalation. Specify NULL for this parameter if you do not want to retrieve the help text (which is useful if you are calling this function to verify whether an instance of this object exists).

changeHistory

The change history of the escalation.

objPropList

The object properties of the escalation.

arDocVersion

The XML document version.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.