Skip to main content

Creating an Integration Error Notification and Rules

You can create error notification rules for integration events that will be triggered on a configured monitoring frequency. Notifications will be sent via email. To set up an integration error notific

Updated over 2 weeks ago

You can create error notification rules for integration events that will be triggered on a configured monitoring frequency. Notifications will be sent via email.

To set up an integration error notification, access the Integration Error Notification Rules screen on the Configurations tab.

Integration Error Notification Rules screen

Integration Error Notification Rules monitor these areas within AssignmentPro:

  • API Event History

  • Import History

  • Integration Event History

  • Report Scheduler History

To create a new Integration Error Notification Rule, click on the

mceclip3.png

icon on the Integration Error Notification Rules screen and the Integration Error Notification Rule Details will appear.

Integration Error Notification Rules screen

By default, a new created rule is set to inactive.

Integration Error Notification Rules screen details

System Name: A required text field that gives a summary of the integration error notification rule.

Inactive: Disables the notification rule and no notifications will be sent by the rule until it is activated.

The Monitoring Frequency section allows you to set the schedule details of the error notification that will be delivered via email.

Monitoring Frequency

Start Date: A required field that sets the start date and time for an error notification to be sent via email. The user will also have an option to end notifications on a specific date.

Schedule Recurrence: Error notifications can be sent to a user on a recurrence schedule which can be configured to be sent by minutes, hours, or days.

API Event History

API Event History

Monitor: Enabling this will include monitoring of standard AssignmentPro API events as part of the Integration Error Notification Rule.

API Subscriber: Filters API Event error notifications by API subscriber. If you wish to check the API Subscribers on the list, you may visit API Subscriber Manager Screen.

Import History

Import History

Monitor: Enabling this will include monitoring of import errors as part of the Integration Error Notification Rule.

Source: Filters import error notifications by source. The options are Manual, Automation, File Import, and Advance Automation.

File Name Pattern: Files that match the specified search pattern will have their corresponding errors included in the notification. The pattern can contain a combination of valid literal and wildcard characters. Note, regular expressions are not supported.

  • Valid Wildcards:

    • % (percent sign): Zero or more characters in that position. To search by a literal percent sign character, use [%].

    • _ (underscore): One character in that position. To search by a literal underscore character, use [_].

Integration Event History

Integration Event History

Monitor: Enabling this will include monitoring of integration event errors as part of the Integration Error Notification Rule.

Vendor: Filter the integration event errors by vendor.

Vendor Selector

Direction: Filter the integration event errors by requests sent to AssignmentPro (Inbound) or requests from AssignmentPro (Outbound)

Report Scheduler History

Report Scheduler History

Monitor: Enabling this will include monitoring of user report scheduling errors as part of the Integration Error Notification rule.

File Name Pattern: Files that match the specified search pattern will have their corresponding errors included in the notification. The pattern can contain a combination of valid literal and wildcard characters, but it does not support regular expressions.

Notifications

To add email address that you want to receive an integration error notification click

mceclip16.png

. You can have multiple addresses in the Error Notification Email Address section.

Notifications

Error Notification Email Addresses: The integration error notifications will be sent to the email addresses specified in this field.

Subject: A mandatory text field that specifies the Subject line of the integration error notification email to be sent.

The email body introduction will appear before the list of errors in the email notification.

Body Introduction: An optional text field where you can customize the introduction of the integration error notification. The number or count of integration error notifications will proceed after the body introduction

Integration Error Notification Email

Once an Integration Error Notification has been setup and an error occurs, email notification will be sent to the specified email address. This will include the subject and body introduction that have been configured followed by the error details. It will also include the number of errors have been occurred since the last time an email was sent, and when the first error occurred.

Integration Error Notification Email

Things to Note:

  • SCIM API is not included as part of Integration Error Notifications at this time.

Did this answer your question?