General.DocumentTypeNotifications Entity

Namespace: General

Provides notification addresses to be notified upon occurrence of different document events. Entity: Gen_Document_Type_Notifications

Default Visualization

Default Display Text Format:
{DocumentType.EntityName}
Default Search Members:
DocumentType.EntityName
Name Data Member:
DocumentType.EntityName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
General.DocumentTypes
Aggregate Root:
General.DocumentTypes

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DocumentEvent	string (254)	The event which will trigger the notification. `Required` `Default("StateChanging")` `Filter(eq)`
FilterXML	string (max) nullable	Filtering condition for the document. Only documents which match the filter will trigger the event.
Id	guid
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
StateBitMask	int32	The document states that will trigger the event. `Required` `Default(0)`
StatusChangeDirection	StatusChangeDirection	Direction of status change. Positive when the new status is greater than the previous. Applicable values: Positive '+', Negative '-', No change '0', Any change ''. `Required` `Default("")`
ToEmailAddressList	string (2048)	List of email addressess to be notified. `Required`

References

Name	Type	Description
DocumentType	DocumentTypes	The document type for which this notification is set. `Required` `Filter(multi eq)` `Owner`
UserStatus	DocumentTypeUserStatuses (nullable)	When not null, specifies that the event will be triggered only on this user status. `Filter(multi eq)`

Attribute Details

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

DocumentEvent

The event which will trigger the notification. Required Default("StateChanging") Filter(eq)

Type: string (254)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 254
Default Value: StateChanging
Show in UI: HiddenByDefault

FilterXML

Filtering condition for the document. Only documents which match the filter will trigger the event.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

StateBitMask

The document states that will trigger the event. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

StatusChangeDirection

Direction of status change. Positive when the new status is greater than the previous. Applicable values: Positive '+', Negative '-', No change '0', Any change '*'. Required Default("*")

Type: StatusChangeDirection
Category: System
Allowed values for the StatusChangeDirection(General.DocumentTypeNotifications.md#statuschangedirection) data attribute
Allowed Values (General.DocumentTypeNotificationsRepository.StatusChangeDirection Enum Members)

Value	Description
AnyChange	AnyChange value. Stored as ''. Database Value: '' Model Value: 0 Domain API Value: 'AnyChange'
NoChange	NoChange value. Stored as '0'. Database Value: '0' Model Value: 1 Domain API Value: 'NoChange'
PositiveChange	PositiveChange value. Stored as '+'. Database Value: '+' Model Value: 2 Domain API Value: 'PositiveChange'
NegativeChange	NegativeChange value. Stored as '-'. Database Value: '-' Model Value: 3 Domain API Value: 'NegativeChange'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: AnyChange
Show in UI: HiddenByDefault

ToEmailAddressList

List of email addressess to be notified. Required

Type: string (2048)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2048
Show in UI: ShownByDefault

Reference Details

DocumentType

The document type for which this notification is set. Required Filter(multi eq) Owner

Type: DocumentTypes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

UserStatus

When not null, specifies that the event will be triggered only on this user status. Filter(multi eq)

Type: DocumentTypeUserStatuses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST