Adding XML Notifications
XML notifications are used to transmit information from Archer to an external system or integration in XML format. You configure the rules of an XML notification in an XML notification blueprint.
On this page
XML notification scenario example
Scenario |
The Devices Vulnerability system of the IT team needs to be automatically notified when a new vulnerability is added to correctly update user interface displays. |
---|---|
Action |
A user with administrative rights creates an XML notification blueprint. Specific fields are selected to be in the Subject line and Body of the template. The delivery frequency is Instantly, and the recipient is the email address of the Devices Vulnerability system. The filter criteria is "Vulnerability" in the Text field. |
Result |
Every time a new vulnerability is imported into Archer, a notification is sent to the Devices Vulnerability system in an XML format. |
Elements of XML notifications
Element |
Description |
---|---|
Layout |
Does not apply to XML notifications. |
Content |
Only fields are included within the Subject line and Body of the notifications. |
Recipient |
The email addresses of the recipients are entered manually. Multiple email addresses are separated by a semicolon. The email addresses specified as recipients receive all notifications generated by the notification blueprint. |
Subscription |
Recipients cannot subscribe or unsubscribe to the notifications. The subscription behavior is defined in the notification blueprint. |
Add an XML notification
-
Go to the General tab on the Manage XML Notifications page.
- From the menu, click
.
- From the Notifications list, click XML Notifications.
- From the menu, click
- Click Add New, and do 1 of the following:
- To create a new XML notification, click Create a new XML Notification from scratch.
- To create an XML notification from an existing 1, click Copy an existing XML Notification, and select the notification you want.
- Click OK.
- In the General Information section, enter the name of the notification, description, and folder in which you want to store the notification.
- Click the Content tab and add the content you want to appear in the notification.
- In the Subject line, enter the text or field you want to include as the subject of this notification.
Note: You cannot include the following fields in the subject line: Attachment, Cross-Application Status Tracking, Image, Record Permissions, Sub-Form, Questionnaire Reference, Access History, and History Log.
- In the Body field, select the fields you want to include in this notification.
-
Click the Delivery tab and enter the email properties for this notification.
- In the From Address field, enter the email address from which this notification will be sent.
- (Optional) In the From Alias Field, enter the name you want to use as the sender for the email from address.
- (Optional) In the Importance field, select the status you want to associate to this email: Normal, High, Low.
- (Optional) In Read Receipt, select whether an acknowledgment is sent after the notification is opened by the recipient. If you want to receive acknowledgment, select Enable Return Receipt.
For new notifications, you must enter complete any required fields and save the notification before you can select Enable Return Receipt. -
In the Delivery Schedule section, define the frequency and its values for sending this notification.
- In the Recurring field, select the period in which you want to send the notification. Your selection determines what you do next.
- Enter the applicable values for the frequency you selected.
The following table lists the actions for each frequency. Frequency
Action
Instantly
Go to the next step.
Daily
- In Time, set the time that you want to send the notification.
- In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Weekly
- In Day, select the day of the week that you want to send the notification.
- In Time, set the time that you want to send the notification.
- In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Monthly
- In Day, select the day of the month (1 through 31) that you want to send the notification. Because not all months have 31 days, you might want to consider 28 or before.
- In Time, set the time that you want to send the notification.
- In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Quarterly
- In Time, set the time that you want to send the notification.
- In Time Zone, select the Coordinated Universal Time (UTC) time zone.
Note: A quarterly notification is sent on the first day of January, April, July, and October.
- In Time, set the time that you want to send the notification.
- In Time Zone, select the Coordinated Universal Time (UTC) time zone.
- In Criteria, do the following:
- In Field Name, select the date field to be used for evaluating the filtering condition.
- In Operator, select the applicable operator, Equals, Does Not Equal, Less Than, or Greater Than.
- In Days, select the number of days on which to evaluate the occurrence.
- In Target, select After Date or Before Date.
- (Optional) To add another condition, click Add New and repeat the steps for adding criteria.
- (Optional) To delete a criteria row, in the Actions column, click
.
- In Digest Content Published, do one of the following for records that satisfy the specified Notification filter criteria and were generated or changed within the time period as defined by the Frequency and Time settings:
Important: If you make changes to this filter, those changes are not applied to any notifications currently in the queue.
- Select Any Version to include any records that satisfied filter criteria since the last sent digest.
- Select Current Version Only to include unsent records that met previous and new filter criteria.
-
In the Recipients section, enter the list of users or groups who will receive this notification.
Recipients can be a dynamic or static list based on the notification type. A dynamic list is based on the values of a Users and Groups list and record permissions or an email address stored in a field.
Do the following for To, CC, and BCC:
- (Optional) In Dynamic, do one or more of the following:
- Expand the Groups tree and select the groups you want to receive the notification.
- Expand the Users tree and select the users you want to receive the notification.
- Expand the Fields tree and select the fields that contain the dynamic recipient based on record permissions or email address.
- Click Apply.
- (Optional) In Dynamic, do one or more of the following:
-
Click the Filter Criteria tab, enter the filters that you want to apply to this notification.
Only the records that match the specified criteria trigger a notification to generate.
- In the Field Name field, select the field on which the evaluation is based.
-
In the Operator field, select the applicable operator for evaluating the values.
Note: Changed and Changed From operators are not supported for Reminder Notifications.
- In Value(s), select the applicable values based on the field specified and click OK.
- (Optional) To add a row for additional criteria, click Add New
, and then repeat steps a – c.
- (Optional) To add advanced operator logic, in the Advanced Operator Logic field, enter the expression.
-
Click Save or Apply.
- Click Save to save and exit.
- Click Apply to apply the changes and continue working.