Registering users for alerts
The information in this topic is applicable only for on-premises deployments.
The AR System Alert User Registration form is installed with . Entries in this form identify each alert user and the method or methods by which they receive alerts. Users can have multiple entries in this form, as long as each entry represents a different alert destination.
The AR System Alert User Registration form
The Alert User Registration form contains all the information maintained by the server in earlier releases, as well as new fields to support sending alerts through the web services plug-in or any other alert plug-in. (The Alert User Registration form replaces the internal alert_user table of alert users that the maintained in earlier releases. An upgrade routine transfers the existing information from the server table to this form at the first server start up after upgrading. After the data has been transferred to the form, the server table is no longer used.)
The alert method is determined by the value in the Plugin Name field. When the Web Services Plugin Name is specified, you provide the end point URL for the Web service to which the alert will be sent in the Plugin Values field. You must define the Web service using the WSDL installed with . In this case, sends alerts to the plug-in server for processing by a specified plug-in. For information about sending alerts by Web services, see Using-Web-services-with-alerts.
You can configure other applications to register and deregister alert users by using C or Java API calls, by using a Web service, or by creating and deleting entries manually. (To deregister users through a Web service, you must use one of the deregister operations described in Registering and deregistering users by web service.)
The following table describes the fields in the Registration tab of the Alert User Registration form:
Registration tab fields
Field name | Description |
|---|---|
Registered User | The AR System login name of the user being registered for alerts. |
Registered Time | The time that the user registered. This is the Modified Date core field and represents the time when the entry was created or modified. AR System uses this field to determine if the user registration has expired and to identify unsent alerts. |
Expiration Time (secs) | The time, in seconds, after which the user's alert registration should expire. If the value is zero, there is no time limit. An escalation runs every 10 minutes to delete expired entries. If an entry has expired but the escalation has not yet run, the user continues to receive alerts. |
Short Description | Used for optional supporting information. If you do not need to use this field, leave the default value N/A in the field. |
Plugin Name | Defines the way alerts are sent for this user registration. The drop-down field menu takes its entries from the AR System Alert Delivery Registration form. Two methods are installed with AR System :
To use the Web Service plug-in, you must create a web service using the installed AR System Alert Web service WSDL. See Using-Web-services-with-alerts. |
Plugin Values | Defines the destination to which alerts are sent for this user registration.
|
Encrypt Plugin Values | Used to store a value that must be encrypted. For, example if a plugin requires a password, store the password in this field. |
ReRegister | A display-only field that allows the entry to be modified with a new expiration time. This field is only used when resetting the Expiration Time in a browser. If the Expiration Time must be set back to its previous value, then the browser will not send the data to the AR System server . The ReRegister check box allows the data to get dirty so that the browser can send the data to the AR System server . For Web services, you use the Reregister method to reset the Registration Time. See Using-Web-services-with-alerts. |
Update Sent Flag | An optional status field that controls whether or not to update the Sent Successfully field on the Alert Events form when an alert is successfully delivered. Updating the Sent Successfully field for all Alert Events entries can have a performance impact on a busy server, so this field allows you to manage performance by controlling whether the Sent Successfully field is used. |