BatchHeader.addUserAlerts Method [AX 2012]

Adds a message entry to the supplied map instance. If no map is supplied, one is created.

Syntax

public void addUserAlerts(
    UserId _userId, 
    NoYes _batchJobEnded, 
    NoYes _batchJobError, 
    NoYes _batchJobCanceled, 
    NoYes _popup, 
    NoYes _email)

Run On

Called

Parameters

  • _batchJobEnded
    Type: NoYes Enumeration
    A NoYes enumeration value that indicates whether to notify the user when the job successfully finishes.
  • _batchJobError
    Type: NoYes Enumeration
    A NoYes enumeration value that indicates whether to notify the user when the job finishes with an error.
  • _batchJobCanceled
    Type: NoYes Enumeration
    A NoYes enumeration value that indicates whether to notify the user when the job is canceled.
  • _popup
    Type: NoYes Enumeration
    A NoYes enumeration value that indicates whether to show alerts in a popup window.
  • _email
    Type: NoYes Enumeration
    A NoYes enumeration value that indicates whether to send alerts as emails.

Remarks

Only one alerts settings per UserId is saved. If this function is called two times for the same UserId, the first set of values is overwritten.

See Also

Reference

BatchHeader Class