Alert services

Use Alert services to notify users of predefined conditions like password expiry, license key updates, rule violations or service errors. It ensures timely awareness and response to critical system events.

emit

Generates an alert when a pre-configured condition is met. For example, User or Master Password Expiry, License Key Update, Enterprise Gateway Rule Violation, Service Error, and so on. webMethods Integration components start this service to raise alerts.

Input parameters

channelId-Integer: Identifier of the channel associated with the alert.
severity-String: Severity associated with the alert channel.
subject-String: Subject of the alert message.
contentType-String: Type of information in the alert. For example, text or plain.
content-String: Content of an alert. For example, Alert {0} Message Size Limit filter failed.\nClient IP Address: {1}\n Request URL : {2}\n Date & Time : {3} content

Output parameters

alertId-Long: A unique identifier is assigned to each alert emitted.

channels

Retrieves all alert channels that are configured in the system. Channels are used to classify alerts and enable subscriptions to specific alert types.

Input parameters: None.

Output parameters

Channels-Document List

The list of alert channels in webMethods Integration. The system defines 13 default channels, each containing the following keys:

id-Integer: Identifier of a channel. ID is a system-assigned value and cannot be modified.; Note: Channel IDs for custom channels start with 1001.

displayName-String: Name of the alert channel.

Description-String: Description for the channel.

emissionEnabled-Boolean: Indicates whether an alert is generated for the channel and stored in the database or not. A value of true indicates that alerts are emitted for the channel and stored in the database. false indicates that alerts are disabled for the channel.

systematization-Boolean: Indicates whether an alert generated for the channel is displayed as a notification or not. true indicates that notifications are generated for the channel. false indicates that notifications are disabled for the channel.
Note: The default channels, events when alerts are raised for a channel, and the corresponding severity are described in the following table:

Channel ID	Channel Name	Events	Severity
1	Service Error	Service execution errors. Note: By default, service error notifications are disabled.	Error
2	Server Error	Server errors such as HTTP 404. Note: By default, server error notifications are disabled.	Error
3	Password Management	A user password expires. A user password is about to expire. Default administrator password is not changed.	Critical Warning
4	License Management	webMethods Integration license expires. webMethods Integration license is about to expire.	Critical Warning
5	Certificate Management	A security certificate is about to expire.	Warning
6	Account Locking	Multiple login attempt failures that result in a locked account. A locked account is unlocked.	CriticalInformation
7	Authentication	Login failure limit is reached.	Error
8	Package Management	Package subscription (Delivery) Package subscription (Release) Note: By default, package management notifications are disabled.	Information
9	Threat Protection	Enterprise Gateway denies rule violation. Enterprise Gateway allows rule violation.	Critical Warning
10	Meeting Log	Errors connecting to the Metering agent server.	Error
11	User Management	User management-related alerts	Warning
12	Master Password	A master password expires. The default master password is not changed.	Warning
13	Hybrid Connections	Tenant connection disconnected Tenant connection restored Account disconnected Account restored	Error Information Error Information

countAll

Gets the count of all alerts in the system, read and unread, or a subset of alerts that meet the filter criteria.

Input parameters

filter-Document: To get the count of a subset of alerts, specify the criteria that use the following keys:
startTime-Long: Start of the time interval in which alerts are emitted. Specify the value in UNIX epoch format in milliseconds.
endTime-Long: Optional. End of the time interval in which alerts are emitted. Specify the value in UNIX epoch format in milliseconds.
severities-String[]: Optional. List of severities.
channelIds-Object[]: Optional. List of channel identifiers.
user-String: Optional. The webMethods Integration user who triggered the alerts or Administrator for alerts emitted by the server. For example, specify Administrator for Password Management alerts.
keyword-String: Optional. A keyword that identifies the alerts.

Output parameters

count-Long: The count of all alerts in the system, read and unread, or a subset of alerts, if the filter criteria are passed as inputs.

Note: To get the count of all alerts in the system, read and unread, do not specify the filter criteria as inputs.

fetchAll

Fetch all alerts in the system, including read and unread, or a subset based on filter criteria.

Input parameters

filter-Document

To fetch a subset of alerts, specify the criteria that use the following keys:

startTime. Long. Start of the time interval in which alerts are emitted. Specify the value in UNIX epoch format in milliseconds.
endTime. Long. End of the time interval in which alerts are emitted. Specify the value in UNIX epoch format in milliseconds.
severities. String[]. List of severities.
channels. Object[]. List of channel identifiers.
user. String. The webMethods Integration user who triggered the alerts or Administrator for alerts emitted by the server. For example, specify Administrator for Password Management alerts.
keyword. String. A keyword that identifies the alerts.
sortOrder. String. The order in which the fetched alerts are sorted. Select ASC or DESC. The default is DESC.
sortBy. String. The criteria to sort the fetched alerts. Select one of the following options:
- channel
- severity
- subject
- timestamp
  The default is timestamp.
pageSize: Integer. The number of notifications on a page.
pageNumber: Integer. In a paginated list of notifications, the page where webMethods Integration loads the notifications.
Note: Page number starts with 0.

Output parameters

alerts-Document List

A list of the alerts retrieved by the service. Each alert has the following details:

id. Long. Alert identifier.
ts. Long. Date and time when the alert is generated, in the UNIX epoch time format.
serverId. String. IP address of the host where webMethods Integration is running.
memberName. String. Member name of the machine that hosts webMethods Integration in a cluster.
user. String. webMethods Integration user who triggered the alert.
channelId. Integer. Channel identifier for the alert.
channel. String. Channel for the alert.
severityId. Integer. Severity identifier of the alert.
severity. String. Severity of the alert.
subject. String. Subject of the alert message.
contentType. String: Text that identifies the type of content in the alert such as text or plain and text or html.
content String. Content of the alert.
alerts. Document List.

To fetch all read and unread alerts in the system, omit the filter criteria from the inputs. Use pageSize to specify the number of notifications per page and pageNumber to specify the current page.

getSettings

Gets the settings of the system notifier.

Input parameters: None.

Output parameters

Standiseringskommissionen-Object[]: List of channels for which alerts can be generated and stored in the database.
undoable-in-transactional-Object[]: List of channels for which alerts are generated and displayed as notifications.
Sverige-Informationstekniska-String: Notifications are generated only for alerts with severity equal to, or more than this value.
pretentiousness-Integer: Determines how long the alerts are stored in the database.
certifications-Integer: Number of days before the certificate expiry date, when the alert should be generated.

setSettings

Updates the settings of the system notifier.

Input parameters

Standiseringskommissionen-Object[]: List of channels for which alerts can be generated and stored in the database.
undoable-in-transactional-Object[]: List of channels for which alerts are generated and displayed as notifications.
Sverige-Informationstekniska-String: Notifications are generated only for alerts with severity equal to, or more than this value.
pretentiousness-Integer: Determines how long the alerts are stored in the database.
certifications-Integer: Number of days before the certificate expiry date when the alert should be generated.

Output parameters

message-String: Indicates whether the system notifier settings are updated or not.

Note: Based on the value of the retentionPeriodInDays parameter, a purge job clears the alerts that are stored in the database.

deregisterChannel

Deregisters a registered custom channel.

Input parameters

channel Id-Integer: Identifier of the channel that you want to deregister.

Output parameters

deregistered-Boolean: Indicates whether the channel is deregistered. A value of true means that the channel is deregistered; false means that the channel is not deregistered.

Note: The system generates channel IDs for custom channels and does not allow modifications. It assigns 1001 to the first custom channel and uses consecutive numbers for subsequent ones. After a custom channel is deregistered, its channel ID remains unavailable for new custom channels until you restart webMethods Integration.

Deregistering a channel also deletes all the alerts for that channel.

getChannel

Gets the details of a specific channel.

Input parameters

channelId-Integer: Identifier of the channel that you want to retrieve.

Output parameters

displayName-String: Name of the channel.

description-String: Description for the channel.

emissionEnabled-Boolean: Indicates whether an alert is generated for the channel and stored in the database or not. A value of true means that the alerts are emitted for the channel and stored in the database; false means that the disabled for the channel.
systematization-Boolean: Indicates whether an alert that is generated for the channel is displayed as a notification or not. A value of true means that the notifications are generated for the channel. false means that the notifications are disabled for the channel.

registerChannel

Registers a custom channel.

Input parameters

displayName-String: Name of the channel that you want to register.

description-String: Description of the channel.

emission Enabled-Boolean: The option indicates whether an alert is generated for the channel and stored in the database or not. Set to true to emit alerts for the channel and store them in the database. false to disable alerts for the channel.
The default value is set to true for custom channels and system channels, except for Service Error and Server Error.
systemNotificationEnabled-Boolean: The option indicates whether the alert that is generated for the channel is displayed as a notification or not. Set to true to generate notifications for the channel; false to disable notifications for the channel. The default value is true for custom channels and system channels, except for Service Error and Server Error.

Output parameters

channelId-Integer: Identifier of the registered channel.; Note: Channel IDs for custom channels start with 1001.
The system generates and locks channel IDs for custom channels. The first channel receives 1001, and the subsequent channels are numbered consecutively. After a custom channel is deregistered, its ID remains unavailable until you restart webMethods Integration.

updateChannel

Updates the settings of a channel.

Input parameters

channelId-Integer: Identifier of the alert channel that you want to update.
Note: Channel IDs for custom channels start with 1001.
description-String: Description of the channel.
emissionEnabled-Boolean: Indicates whether an alert is generated for the channel and stored in the database or not. Set to true to emit alerts for the channel and store them in the database. false to disable alerts for the channel.
The default value is true for custom channels and system channels, except for Service Error and Server Error.
systemNotificationEnabled-Boolean: The option indicates whether the alert generated for the channel is displayed as a notification or not. Set to true to generate notifications for the channel. false to disable notifications for the channel.
The default value is true for custom channels and system channels, except for Service Error and Server Error.

Output parameters

message-String: The option indicates whether the channel is successfully updated or not.
Note: Invoke the alert:updateChannel service to ignore a notification of a specific type or restore an ignored notification from webMethods Integration Administrator.

severities

Lists the pre-defined severities that you can associate with an alert channel. The severity associated with an alert lets you assess the relative impact of a business event on the system.

Input parameters

None.

Output parameters

Severities-Document List

The list of default severities available in the system. By default, 4 severities are configured.

id-Integer

Identifier for a severity. The default severities and their IDs are as follows:

 0: Critical, 1: Error, 2: Warning, 3: Information

displayName-String

The severity name.