Notification and Transport Configuration

method

Which HTTP method is used to send SMS. Currently, "get" and "post" are supported. If not specified, "get" is assumed.

since 3.7.1

urlExpression

Expression that returns URL used to send SMS.

since 3.7.1 (up to 3.7, this item was called url)

headersExpression

Expression that returns HTTP request headers. The expression should return 0, 1 or more string values that will be used as request HTTP headers. Each value is in the form of "name: value", i.e. a header name followed by colon, space and a header value. If one header has to have more values, such name-value pair should be present more times for the given header name.

since 3.7.1

bodyExpression

Expression that returns request body used to send SMS (as a string).

since 3.7.1

bodyEncoding

Encoding to be used for the message body. ISO 8859-1 is the default. Note that if you use any other encoding, your responsibility is to provide appropriate Content-Type header (see headersExpression item). This requirement might change in the future.

since 3.7.1

username, password

How to authenticate to the SMS gateway.

since 3.7.1

redirectToFile

Instead of opening HTTP connection, writes the URL and other parameters to this file. Useful for debugging.

logToFile

In addition to executing the expression, writes all messages to a file. Useful for debugging.

since 3.7.1

from

The message sender: Either message.from, smsConfiguration.defaultFrom or an empty string (in that order).

to

List of message recipients.

messageText

Message text (body).

encodedFrom

URL-encoded version of the from variable.

encodedTo

URL-encoded version of the to variable.

encodedMessageText

URL-encoded version of the messageText variable.

message

The whole message (com.evolveum.midpoint.notifications.api.transports.Message).

name

String

0..1

Name of the notifier - just a help to the administrator in order to increase readability of the configuration.

description

String

0..1

Description of the notifier - also just a help to the admin.

recipientExpression

ExpressionType

0..1

Recipient(s) that should get the notifications. (TODO: Exact form is to be determined yet, but here may be mail addresses, phone numbers, etc. We need to think how to distinguish these kinds of destinations.) Default: mail address of the requestee - user that is being dealt with by repository object change or within a workflow; or account owner, if the e-mail address is not empty.

ccExpression

ExpressionType

0..1

Recipient(s) that should get the notifications (as Cc). Only for mail transport.

bccExpression

ExpressionType

0..1

Recipient(s) that should get the notifications (as Bcc). Only for mail transport.

subjectExpression

ExpressionType

0..1

How to construct the subject of the message that is to be sent.

subjectPrefix

String

0..1

Simpler alternative to subjectExpression: the subject itself will be constructed by the notifier (applicable to concrete kinds of notifiers, like e.g. userPasswordNotifier), but it will be prefixed by value specified here.

bodyExpression

ExpressionType

0..1

How to construct the body (text) of the message that is to be sent.

watchAuxiliaryAttributes

Boolean

0..1

Whether to send a notification when only auxiliary attributes (namely: validityStatus, validityChangeTimestamp, effectiveStatus, disableTimestamp, modifyChannel, modifyTimestamp, modifierRef and maybe others) are modified. Default value: false. This setting also influences the list of modifications that is shown within the notification when using simpleUserNotifier and simplePasswordNotifier - if set to false, modifications of auxiliary attributes are not listed among account/user modifications.

showModifiedValues

Boolean

0..1

Whether to show modified values (or only names of changed attributes). Default: true. (NOT IMPLEMENTED YET. THE NAME MIGHT CHANGE.) Applies to concrete notifiers, not to the general one.

showTechnicalInformation

Boolean

0..1

Whether to show technical information (e.g. model context or account operation details) in the notification. Applies to concrete notifiers, not to the general one.

transport

String

0..N

To what transport(s) should the message be sent.

notificationSendingStrategy

String

0..1

Defines how to send notification to individual recipients.

Possible values: sameNotificationToAllRecipients (a notification message is generated once, and sent to all the recipients in the same form); separateNotificationToEachRecipient (the default value, a notification message is generated and sent to every recipient separately, taking into account such individual settings as local).

watchSynchronizationAttributes

Boolean

0..1

Whether to send a notification when only auxiliary attributes related to synchronization situation (synchronizationSituationDescription, synchronizationSituation) are modified. Default: false.

modelEvent

event instanceOf ModelEvent && event.isUserRelated()

Event connected to a user object in repository.

resourceObjectEvent

event.isAccountRelated() (TODO: change this in code and in docs)

Event connected to an object on a resource.

workItemEvent

event.isWorkItemRelated()

Start/completion of a work item.

workflowProcessEvent

event.isWorkflowProcessRelated()

Start/completion of a workflow process instance.

workflowEvent

event.isWorkflowRelated()

workItemEvent or workflowProcessEvent

success

event.isSuccess()

All modifications were carried out successfully.*

The operation was successful.

The request was approved.

alsoSuccess

event.isAlsoSuccess()

At least one modification was carried out successfully.*

onlyFailure

event.isOnlyFailure()

All modifications failed.**

The operation was unsuccessful.

The request was denied.

failure

event.isFailure()

At least one modification failed.**

inProgress

event.isInProgress()

At least one modification is in progress.***

The operation is in progress.

The result of request is not known.

add

event.isAdd()

User/account is created.

Work item or process instance is started.

modify

event.isModify()

User/account is modified.

N/A

delete

event.isDelete()

User/account is deleted.

Work item or process instance has been competed.

focusType

event.getFocusType()

event.getFocusTypeName()

Type of the processed object, e.g. RoleType.

Type of the processed object without suffix, e.g. Role

event.channel

$event.channel

event.getChannel()

$event.getChannel()

Returns the channel for the event

event.id

$event.id

event.getId()

$event.getId()

Returns randomly generated event ID

event.requestee

$event.requestee

event.getRequestee()

$event.getRequestee()

Returns the entity that is the object of this event or the owner of the object (e.g. account) of this event

event.requesteeName

$event.requesteeName

event.getRequesteeName()

$event.getRequesteeName()

Returns requestee’s name property.

event.requesteeDisplayName

$event.requesteeDisplayName

event.getRequesteeDisplayName()

$event.getRequesteeDisplayName()

Returns requestee’s "display name", e.g. user’s fullName property if it exists.

event.requesteeObject

$event.requesteeObject

event.getRequesteeObject()

$event.getRequesteeObject()

Returns the entity that is the object of this event or the owner of the object (e.g. account) of this event

event.requesteeOid

$event.requesteeOid

event.getRequesteeOid()

$event.getRequesteeOid()

Returns requestee’s oid.

event.requester

$event.requester

event.getRequester()

$event.getRequester()

Returns the entity that requested the operation that resulted in the event being generated.

event.statusAsText

$event.statusAsText

event.getStatusAsText()

$event.getStatusAsText()

Returns the status of the event converted to text and uppercased, e.g. SUCCESS

event.success

$event.success

event.isSuccess()

$event.isSuccess()

Returns true if the event resulted in success

event.failure

$event.failure

event.isFailure()

$event.isFailure()

Returns true if the event resulted in failure

event.changeType

$event.changeType

event.getChangeType()

$event.getChangeType()

Returns change type (ADD, MODIFY, DELETE) from the event

event.contentAsFormattedList

$event.contentAsFormattedList

event.getContentAsFormattedList()

$event.getContentAsFormattedList()

Returns formatted list of changes for this event. NOTE: The content is rendered in plain text and will not use any HTML formatting.

event.focusPassword

$event.focusPassword

event.getFocusPassword()

$event.getFocusPassword()

Returns focal object password if known (e.g. during password generation)

event.changeType

$event.changeType

event.getChangeType()

$event.getChangeType()

Returns change type (ADD, MODIFY, DELETE) from the event

event.contentAsFormattedList

$event.contentAsFormattedList

event.getContentAsFormattedList()

$event.getContentAsFormattedList()

Returns formatted list of changes for this event. NOTE: The content is rendered in plain text and will not use any HTML formatting.

event.plaintextPassword

$event.plaintextPassword

event.getPlaintextPassword()

event.getPlaintextPassword()

Returns resource object password if known (e.g. during password generation)

event.caseName

$event.caseName

event.getCaseName()

$event.getCaseName()

Returns the case name

event.statusAsText

$event.statusAsText

event.getStatusAsText()

$event.getStatusAsText()

Returns the case outcome (Approved or Rejected).

event.workItemId

$event.workItemId

event.getWorkItemId()

$event.getWorkItemId()

event.workItemUrl

$event.workItemUrl

event.getWorkItemUrl()

$event.getWorkItemUrl()

Returns the URL which can be used as a direct link to act on this workitem. Very useful for notifications. The URL is composed using midpoint.createWorkItemCompletionLink() method.

event.cause.type

$event.cause.type

event.getCause().getType()

$event.getCause().getType()

For timed actions (workitem with a deadline defined): returns TIMED_ACTION

event.operationKind

$event.operationKind

event.getOperationKind()

$event.getOperationKind()