Setup On-Complete Notifications

On-complete notifications can be used to keep you informed about the sync process. These notifications are sent after the sync process has finished and they can include information about the process, such as the employees that were processed, and any relevant messages or changes that were applied.

  • An on-complete notification can be sent when the sync job has completed with errors or warnings.
  • An on-complete notification can be sent to show all the inserted, updated, or disabled employees.

Lets create an on-complete notification that is only sent if the sync process has not completed or if any errors or warnings were encountered.

Start by navigating to Notifications > On Complete > Add a new notification.

on-complete - add new notification.png

This action will create a new on-complete notification. Open the new notification, and configure it to meet our requirements.

Remember, all notifications can be customized to fit your needs!

Change the To and Subject to meet your message requirements.

on-complete - modify to and subject.png

Next, we are going to change the send condition so that the message is only sent if the sync process did not complete or if there were any errors or warnings.

Modify the notification Send Condition, set it to IsIncompleteOrHasErrorsOrWarnings.

on-complete - set send condition to IsIncompleteOrHasErrorsOrWarnings.png

The IsIncompleteOrHasErrorsOrWarnings constant returns a true value if the sync process did not complete or if there were any errors or warnings.

Next, we'll want to include information in the message body to show what went wrong with the sync process.

We can use a few different constants to show the details of the sync process.

Set the expression for the body to any one of these constants below:

  • DetailReport will show the process results in an HTML report, including all processed employees and related errors and warnings.
  • SummaryReport will show the process results in an HTML report, and will only include summary information, including process errors and warnings.
  • ToHTMLDetail will show the process results in an (unstyled) HTML report, including all processed employees and related errors and warnings.
  • ToHTMLSummary will show the process results in an (unstyled) HTML report, and will only include summary information, including process errors and warnings.
  • ToJson will show the process results in Json, including all processed employees and related errors and warnings.
  • ToCSV will show the process results in CSV, including all processed employees and related errors and warnings.
on-complete - modify body.png

Please go ahead and apply and save the work we've just completed.

The next time the sync process does not complete or if it encounters errors or warnings, a notification will be sent.

on-complete - message sent.png

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.