ARCreateAlertEvent

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Enters an alert event on the specified server. The BMC Remedy AR System server sends an alert to the specified, registered users.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARCreateAlertEvent(
ARControlStruct *control,
ARAccessNameType user,
char *alertText,
int priority,
ARNameType sourceTag,
ARServerNameType serverName,
ARNameType formName,
char *objectId,
AREntryIdType *entryId,
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 and server fields are required.

user

The user who receives the alert. Specify * (AR_REGISTERED_BROADCAST) to create an alert event for all users that are currently registered to receive alerts with the BMC Remedy AR System server. You cannot specify a group name for this argument.

alertText

The text that the alert contains.

priority

A relative value that represents the priority for this alert. The range of acceptable values is between 0 and 10.

sourceTag

A string that identifies the source of the alert. The BMC Remedy AR System provides two predefined values for this string:

AR — alert originated from the BMC Remedy AR System
FB — alert originated from Flashboards

serverName

The name of the server that is the source of the alert. Use @ to specify the current server. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates.

formName

The name of the form that is the source of the alert. For Flashboards, this is the name of the Flashboard that generated the alert. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates.

objectId

The identifier for the object. For BMC Remedy AR System, this value is the entry ID of the originating request. For Flashboards, this value is the name of the Flashboard alert that the user provides. Specify NULL for this parameter if the parameter is not applicable to the type of alert that this call creates. Join forms have multiple entry Ids (000000000000001|000000000000002) separated by vertical bars.

Return values

entryId

The unique identifier for the new alert (system-generated).

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.