Field Element for Protocol/Fields (ADF)
Provides a location for defining one protocol header field.
Syntax
<NotificationClasses>
<NotificationClass>
...
<Protocols>
<Protocol>
<Fields>
<Field>
Element Characteristics
Characteristic | Description |
---|---|
Data type |
None. |
Default value |
None. |
Occurrence |
Required once or more per Fields element. |
Updates |
Can be added and deleted when updating the application. |
Element Relationships
Relationship | Elements |
---|---|
Parent element |
|
Child elements |
FieldName Element for Protocol/Fields/Field (ADF) –and– SqlExpression Element for Protocol/Fields/Field (ADF) –or– |
Remarks
A Field element contains a FieldName element and either a SqlExpression element or a FieldReference element. The FieldName and SqlExpression combination enables you to use a Transact-SQL expression to define the protocol field value. The FieldName and FieldReference combination enables you to use a value from the notification as the protocol field value.
The following field names are reserved by Notification Services:
- DeliveryChannelName
- DeliveryStatusCode
- DeviceAddress
- DeviceName
- DeviceTypeName
- DistributorWorkItemId
- ExpirationTime
- LinkNotificationId
- NotificationId
- NotificationBatchId
- SentTime
- SubscriberId
- SubscriberLocale
The NotificationId, SubscriberId, DeviceName, DeviceTypeName, DeviceAddress, and SubscriberLocale fields are exposed by Notification Services, and can be used in the Transact-SQL expressions for protocol fields.
Example
The following example shows how to use a Transact-SQL expression as the value for the Subject
field. The Transact-SQL expression creates a string containing the current date.
<Field>
<FieldName>Subject</FieldName>
<SqlExpression>'Your notification for : ' +
CONVERT(NVARCHAR(30), GETDATE())</SqlExpression>
</Field>
The following example shows how to use a field reference as a protocol field value.
<Field>
<FieldName>StockSymbol</FieldName>
<FieldReference>StockSymbol</FieldReference>
</Field>
See Also
Reference
Application Definition File Reference
Other Resources
Specifying the Delivery Protocol Name and Fields
Updating Instances and Applications