General.Activities.ActivityTemplates Entity

Templates for automatical generation of activity from any document. Entity: Cm_Activity_Templates

Renames

Old name: General.Contacts.ActivityTemplates
New name: General.Activities.ActivityTemplates
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Id}: {RouteId}
Default Search Members:
__
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Tree

General.Activities.ActivityTemplates

Attributes

Name	Type	Description
ActivitySubjectMask	string (max) nullable	A mask that uses fields from the header table of the source document in the specified route and is used to fill the Subject of the generated activity.
AdditionalDays	int32	The number of days that will be added to the date in the Header_Date_Field. The result value is set to Start_Time of the activity. `Required` `Default(0)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
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.
ReminderTime	time nullable	The time of the day for the reminder. `Filter(ge;le)`
SourceDateField	string (64)	A name of a field from the header or the document table of the source document in the specified route, that will be used along with Additional_Days to set the Start_Time of the generated activity. `Required`
StartTime	time	The time of the day when the activity starts. `Required` `Filter(ge;le)`

References

Name	Type	Description
ResponsibleParty	Parties (nullable)	If Null the user that starts the generation route is responsible party of the activity. `Filter(multi eq)`
Route	Routes	The route that uses this template. `Required` `Filter(multi eq)`

Attribute Details

ActivitySubjectMask

A mask that uses fields from the header table of the source document in the specified route and is used to fill the Subject of the generated activity.

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

AdditionalDays

The number of days that will be added to the date in the Header_Date_Field. The result value is set to Start_Time of the activity. Required Default(0)

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

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

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

ReminderTime

The time of the day for the reminder. Filter(ge;le)

Type: time nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( obj.StartTime > FromMinutes( 30)), ( obj.StartTime - FromMinutes( 30)), obj.StartTime)

SourceDateField

A name of a field from the header or the document table of the source document in the specified route, that will be used along with Additional_Days to set the Start_Time of the generated activity. Required

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

StartTime

The time of the day when the activity starts. Required Filter(ge;le)

Type: time
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

ResponsibleParty

If Null the user that starts the generation route is responsible party of the activity. Filter(multi eq)

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

Route

The route that uses this template. Required Filter(multi eq)

Type: Routes
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

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

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST