Client Notification command schema elements

Subject

(Required) The subject line of the notification message. There is a 128 character limit.

Body

(Required) The body text of the notification message.

Priority

The message priority: low, normal, high. This is not case sensitive. This value is optional.

ExpiryDateTime

(Required) Specifies when the notification message is no longer valid and will no longer display in the Notification panel. This must be in UTC format. The maximum time is one year.

Module

Any valid AVEVA™ Production Management module. For example, Downtime, Inventory.

Location

A location in the project hierarchy. To specify a particular reporting point, you must use the parent location. For example, if the full path is Enterprise1.Site1.Crusher.DowntimeRP1, then specify Enterprise1.Site1.Crusher.

View

The name of a valid view for the selected module. For example, Standard view. Valid options are the ones returned by the GetViews method of the Data web service.

Period

This element applies only when the selected module is Metrics. It specifies a defined time period, such as day or month.

Filters

Contains the set of filters. Filtering supports general filtering rules; however, special syntax is required for greater than and less than. See, Filter operators section below.

Filter

Contains a name value pair to filter the view of data in the results grid. Invalid filters will be ignored.

Name

The name of a filterable field. For example, Record Identifier.

Value

The value of the selected filterable field. For example, to filter on Record Identifier = 923467, the value would be 923467. If the field is a datetime, the value must be in UTC format.

Be sure to escape characters according to the selected language: XML or JSON.