User notifications for reports configuration

The default behavior for user notifications for reports is to send a notification when the report is created and to send a notification when the report generation fails. You can modify this default behavior in two ways, depending on whether report distribution groups are used.

If a report distribution group is used, you can suppress the user notifications sent for the creation of the report through the Suppress User Notification field in the report distribution profile. A notification is still sent if there is a failure.

For cases where a report distribution group is not used, the default behavior for user notifications is modified by setting the DocGenUseAsyncNotifyType configuration parameter to true and the user specifying a request notification type of Never or On Failure. In this case, no user notification is sent when the report document is created. If the DocGenUseAsyncNotifyType configuration parameter is not defined or is set to false, a success notification is sent when a user report is created.

Note: The DocGenUseAsyncNotifyType setting does not apply to the standard Java-built reports, static Java reports. These reports still result in a notification when the report is created unless a report distribution group is used and specifies the suppression of user notifications.

If you use the DocGenUseAsyncNotifyType configuration parameter to cause the request notification type to affect the user notifications for reports, these are the standard features associated with async notification types:

  • The async.notificationtype.default configuration parameter provides a default for the notification type for scheduled requests. Users can override the default when scheduling the request.
  • When a request is saved without a specified notification type, the system checks for the provided email address. If the user specified an email address, then the notification type defaults to On Failure. If no email was specified, then it defaults to the value of the async.notificationtype.default parameter.
  • These are the valid notification types:
    • Never: Does not send notifications in any case.
    • On Failure: Sends notification if the action fails.
    • Always: Send notification if the action completes or fails.
    • Action Group: Sends notification when all actions in the group completes or fails.