Using the Messaging JavaBean

A JavaBean is a Java class that can be easily reused and composed into JSP pages. JavaServer Pages technology directly supports using JavaBeans components with JSP language elements. You can easily create and initialize beans and get and set the values of their properties.

The Messaging JavaBean provides a way to access the necessary data to create a message in the xMatters system:

<%@ page import="com.invoqsystems.apex.web.view.messaging.*" %>
<jsp:useBean id="messageData" scope="session" class="MessagingData"/>
 

Messaging JavaBean API

The following form element names, listed in alphabetical order, are available when working with the Messaging JavaBean API:

Field Required Description
DEVICE_FILTER_FIELD_ALL Optional Send to All Devices if this field is found and set.
DEVICE_FILTER_FIELD_EMAIL Optional Send to All Email Devices if this field is found and set.
DEVICE_FILTER_FIELD_IM Optional Send to All Instant Messenger Devices if this field is found and set.
DEVICE_FILTER_FIELD_PREFIX Optional

HTTP Form prefix for each option to filter out Devices to which this message will be sent.

DEVICE_FILTER_FIELD_TEXT Optional

Send to All Text/Pager Devices if this field is found and set.

DEVICE_FILTER_FIELD_VOICE Optional

Send to All Voice/Phone Devices if this field is found and set.

HTTP_FORM_NAME   Standard name for the HTTP Form containing all the information that will make up this message.
MESSAGE_BODY_FIELD_PREFIX Mandatory (at least one) HTTP Form input name prefix for any fields that are desired to be appended together to form the Body of the message.
MESSAGE_TEXT_ID   ID for message text form widget.
RECIPIENT_FIELD_PREFIX Mandatory (at least one)

HTTP Form item name prefix for a Recipient of this message.

SUBJECT_FIELD_PREFIX Optional

HTTP Form input name prefix for any fields that are desired to be appended together to form the Subject of the message.

Method details

The following methods, listed in alphabetical order, are available when working with the Messaging JavaBean API:

getAddendumText

getAvailablePredicateList

getCompanyId

getConcatenatedMessageBody

getConcatenatedSubject

getCustomMessagingPanel

getDeviceFilterNames

getEventDomains

getFavouriteGroupList

getFavouriteGroupsIterator

getFavouritePersonList

getFavouritePersonsIterator

getGroups

getIncidentId

getMessageBodyFields

getMessageText

getNoJavascriptErrorMessage

getPersons

getPredicateIgnoreValue

getRecipients

getRecipientIterator

getRecipientTargetNames

getSelectedPredicates

getSubjectFields

getSubjectText

getTextFields

getTextFieldValue

getTextFieldValues

getWarningMessage

hasCustomMessagingPanel

hasEventDomainListPredicates

hasEventDomainPredicates

hasEventDomainTextPredicates

hasRecipients

hasWarningMessage

isDeviceFilterAll

isDeviceFilterBES

isDeviceFilterIM

isDeviceFilterTextDevices

isDeviceFilterVoiceDevices

setSelectedEventDomain

setTextFieldValue

Messaging Form Data

Custom Messaging XML Tags

Custom Subscription and Messaging Panels