Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Production Management

Client Notification command properties

  • Last UpdatedFeb 20, 2024
  • 2 minute read

Refer to the following tables for the key configurable properties for Client Notification.

Connection properties

Property

Description

Valid values

Durable

By default, this property is set to True. If the queue specified in your configuration item is not durable, you need to change this property to False; otherwise, you may encounter an error due to durability mismatch and your configuration item will not start until this is fixed.

True, False

Password

The password that is associated with the user account for the message broker.

Password

Uri

The uniform resource identifier (URI) that is the source for receiving Client Notifications commands. You must enter the appropriate URI for the software you are using.

We suggest that you use a naming convention that includes the version information of the Service Bus Client Notification message schema.

The schema version appears in the header of the message text.

<xmlns="http://schemas.ampla.com/ServiceBus/Command/ClientNotification/2019/02">

Note: The URI for RabbitMQ cannot contain the slash (/) character or spaces in the name of the queue.

amqp://ampla.commands.submitclientnotification.v201902

Username

(Required) The user name to connect to the message broker.

Note: The default Client Notification command item that appears will not come with authentication details. These empty values will produce a validation error, unless you supply user authentication details.

User account

Message properties

Property

Description

Valid values

MessageFormat

Specifies whether to use XML format or JSON format for the message scheme.
If a message does not match the message type, the message is not processed; an error is logged and the message moves to the Dead Letter Queue. See, Dead Letter Queues.

XML, JSON

MessageSchema

An editable message schema where its format depends on the selected message format.

You can open the MessageSchema Editor if you need to edit the schema.

For more information, see Client Notification command schema

RunAsUser

The AVEVA™ Production Management basic user to submit this notification. Only users of BasicUser type are available for selection.

You can specify the user from the picker dialog box.

We recommend that you create AVEVA Production Management users that are specific for submitting notifications. The user will require Submit Notification security permission.

User account

Transport properties

Property

Description

Valid values

Certificate Thumbprint

Choose an available certificate for transport. This is required when you are using the secure AMQPS scheme in the URI property.

For more information about using RabbitMQ with secure transport, see https://www.rabbitmq.com/ssl.html.

To verify whether connection is working, see Test the connection.

Hexadecimal string

TitleResults for “How to create a CRG?”Also Available in