SubmitClientNotification request message
- Last UpdatedSep 06, 2023
- 3 minute read
The SubmitClientNotification request message contains the following sections:
-
Credentials
-
Content
-
ViewFilter
-
Filters
Request parameters: Credentials section
The Credentials section contains the security details for authentication. You can provide the Username and Password values to use the Basic security method. If you do not provide explicit security values, Web services will attempt to use Integrated authentication. You must provide either Basic credentials, Integrated credentials, or a Session ID.
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
|
Parameter |
Description |
|---|---|
|
Username |
The login name of the AVEVA™ Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Password |
The password that is associated with the AVEVA Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Session |
A GUID string value that identifies the session. This is a string value. Mutually exclusive with Username and Password. |
Request parameters: Content section
The Content section contains the subject and body of the message.
<Subject>Subject</Subject>
<Body>Body</Body>
<Priority>Normal</Priority>
<ExpiryDateTime>2019-03-19T11:00:00</ExpiryDateTime>
|
Parameter |
Description |
|---|---|
|
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. If not provided, the default is Normal. |
|
ExpiryDateTime |
(Required) Specifies when the notification message is no longer valid and will no longer display in the Notification panel. This value must be in UTC format. The maximum time is one year. |
Request parameters: ViewFilter section
The ViewFilter section specifies parameters for a specific view to display in Production Analyst. For example, opens the Downtime Standard view. These parameters give location context to the notification message. This section is optional.
<ViewFilter>
<Module>Metrics</Module>
<Location>Enterprise.Coal Site 1</Location>
<View>Standard View</View>
<Period>Day</Period>
</ViewFilter>
|
Parameter |
Description |
|---|---|
|
Module |
Any valid 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. |
Request parameters: Filters section
The Filters section specifies filters to apply to the data results in the view. This section is optional.
Filtering supports general filtering rules; however, special syntax is required for greater than and less than. For more information, see Example filter operators for XML.
<Filters>
<Filter>
<Name>Sample Period</Name>
<Value>> 2019-01-01T01:00:00Z</Value>
</Filter>
<Filter>
<Name>Record Identifier</Name>
<Value>923465</Value>
</Filter>
</Filters>
|
Parameter |
Description |
|---|---|
|
Filters |
Contains the set of filters. |
|
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 XML convention. |