General.Contacts.Activities Entity

Namespace: General.Contacts
Inherited From: General.Documents

Generic activity. Provides task management functionality. Activity can be one of Task, Communication or Meeting. Entity: Cm_Activities

Default Visualization

Default Display Text Format:
{DocumentType.TypeName:T} {DocumentNo}{StateTagsAttribute}
Default Search Members:
DocumentNo
Code Data Member:
DocumentNo
Category: Documents
Show in UI: ShownByDefault
Object category attribute: DocumentTypeId

Aggregate

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

Aggregate Tree

• General.Contacts.Activities
  • General.Contacts.ActivityParticipants
  • General.Contacts.ActivityResources
  • General.Contacts.Reminders
  • General.DocumentAmounts
    • General.DocumentAmountReferencedDocuments
  • General.DocumentComments
  • General.DocumentDistributedAmounts
  • General.DocumentFileAttachments
  • General.DocumentFulfillments
  • General.DocumentLineAmounts
  • General.DocumentParties
  • General.DocumentPrints
  • General.DocumentStateChanges

Attributes

Name	Type	Description
AdjustmentNumber	int32	Consecutive number of the correction that this document is applying to the adjusted document. Required Default(0) ReadOnly (Inherited from Documents)
AdjustmentTime	datetime nullable	Date/time when the document last has been adjusted by corrective document. Filter(ge;le) ReadOnly (Inherited from Documents)
AdjustmentUser	string (64) nullable	The user who adjusted the document. ReadOnly (Inherited from Documents)
CompleteTime	datetime nullable	Date and time when the document was completed (State set to Completed). Filter(ge;le) ReadOnly (Inherited from Documents)
CreationTime	datetime	Date/Time when the document was created. Required Default(Now) Filter(ge;le) ReadOnly (Inherited from Documents)
CreationUser	string (64)	The login name of the user, who created the document. Required Filter(like) ReadOnly (Inherited from Documents)
DeadlineTime	datetime nullable	The deadline for the task. null if there is no deadline. Filter(ge;le)
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DocumentDate	date	The date on which the document was issued. Required Default(Today) Filter(eq;ge;le) ORD (Inherited from Documents)
DocumentNo	string (20)	Document number, unique within Document_Type_Id. Required Filter(eq;like) ORD (Inherited from Documents)
DocumentNotes	string (max) nullable	Notes for this Document. (Inherited from Documents)
DocumentVersion	int32	Consecutive version number, starting with 1. Each update produces a new version of the document. Required Default(1) Filter(eq;ge;le) ReadOnly (Inherited from Documents)
EndTime	datetime nullable	Currently planned ending time of the task. Filter(ge;le)
EntityName	string (64)	The entity name of the document header. Required Filter(eq) ORD ReadOnly (Inherited from Documents)
Id	guid
IsReleased	boolean	OBSOLETE! Do not use! True if the document is not void and its state is released or greater. Deprecated. Obsolete Required Default(false) Filter(eq) ReadOnly Obsoleted in version 22.1.6.61
IsSingleExecution	boolean	Specifies whether the document is a single execution of its order document. Required Default(false) Filter(eq) ReadOnly
Notes	string (max) nullable	Notes for this Activity.
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.
ParentDocument RelationshipType	ParentDocument RelationshipType nullable	Type of relationship between the current document and the parent document(s). Affects the constraints for execution/completion for the documents. Possible values: 'S' = 'Subtask', 'N' = 'Next task'. ReadOnly (Inherited from Documents)
PlannedDurationMinutes	int32 nullable	Total planned duration of the activity, regardless of the current execution status. Filter(ge;le)
PlanningOnly	boolean	Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned). Required Default(false) ReadOnly (Inherited from Documents)
Priority	Priority	Priority on the scale from 1 (least important) to 5 (very important). Required Default(3)
Private	boolean	True if the task is visible only to its owner; false if this is publicly visible task. Required Default(false)
ReadOnly	boolean	True - the document is read only; false - the document is not read only. Required Default(false) ReadOnly (Inherited from Documents)
ReferenceDate	datetime nullable	Indicates the date, when the event, described by the document, actually occurred. Generally, the document should be created at the date of the event. However, if the document is created later than the event, this field contains the date of the actual event. If the field is empty, this means that the document was created at the date of the actual event and Document Date is indicative of the date of the event. Contrast this with CreationTime, which indicates when the document was entered into the system. So, generally: Reference Date <= DocumentDate <= CreationTime. Default(Today) Filter(ge;le) (Inherited from Documents)
ReferenceDocumentNo	string (20) nullable	The number of the document (issued by the other party), which was the reason for the creation of the current document. The numebr should be unique within the party documents. Filter(eq;like) (Inherited from Documents)
ReleaseTime	datetime nullable	Date and time when the document was released (State set to Released). Filter(ge;le) ReadOnly (Inherited from Documents)
ReminderTime	datetime nullable	When to snooze to the owner to remind him for the task. This default reminder is copied to and managed by the Reminders entity. Filter(ge;le)
StartTime	datetime	Currently planned starting time of the task. Required Default(Now) Filter(ge;le)
State	DocumentState	The current system state of the document. Allowed values: 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required Default(0) Filter(multi eq;ge;le) ReadOnly (Inherited from Documents)
StateTagsAttribute	string	Specifies the state of the document.
Subject	string (254)	Task primary subject (required). Required Filter(eq;like)
SystemType	SystemType	T=Task; C=Communication; M=Meeting. Required
Void	boolean	True if the document is null and void. Required Default(false) Filter(eq) ReadOnly (Inherited from Documents)
VoidReason	string (254) nullable	Reason for voiding the document, entered by the user. ReadOnly (Inherited from Documents)
VoidTime	datetime nullable	Date/time when the document has become void. Filter(ge;le) ReadOnly (Inherited from Documents)
VoidUser	string (64) nullable	The user who voided the document. ReadOnly (Inherited from Documents)

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this document. null means that all users have unlimited permissions. Filter(multi eq) (Inherited from Documents)
AdjustedDocument	Documents (nullable)	The primary document, which the current document adjusts. null when this is not an adjustment document. Filter(multi eq) ReadOnly (Inherited from Documents)
AssignedToUser	Users (nullable)	The user to which this document is assigned for handling. null means that the document is not assigned to specific user. Filter(multi eq) (Inherited from Documents)
ContactPerson	Persons (nullable)	The contact person, from the side of the Target Party. Filter(multi eq)
CurrencyDirectory	CurrencyDirectories (nullable)	The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions. Filter(multi eq) (Inherited from Documents)
DocumentType	DocumentTypes	The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. Required Filter(multi eq) (Inherited from Documents)
EnterpriseCompany	EnterpriseCompanies	The enterprise company which issued the document. Required Filter(multi eq) (Inherited from Documents)
EnterpriseCompanyLocation	CompanyLocations (nullable)	The enterprise company location which issued the document. null means that there is only one location within the enterprise company and locations are not used. Filter(multi eq) (Inherited from Documents)
FromCompanyDivision	CompanyDivisions (nullable)	The division of the company, issuing the document. null when the document is not issued by any specific division. Filter(multi eq) (Inherited from Documents)
FromParty	Parties	The party which issued the document. Required Filter(multi eq) (Inherited from Documents)
MasterDocument	Documents	In a multi-document tree, this is the root document, that created the whole tree. If this is the root it is equal to Id. Required Filter(multi eq) (Inherited from Documents)
OwnerParty	Parties	The party that owns the task. Initially this is the party that has created the task. Required Filter(multi eq)
Parent	Documents (nullable)	In a multi-document tree, this is the direct parent document. If this is the root it is null. Filter(multi eq) (Inherited from Documents)
PrimeCauseDocument	Documents (nullable)	The document that is the prime cause for creation of the current document. Filter(multi eq) (Inherited from Documents)
ProjectTask	ProjectTasks (nullable)	The project task for which the work is performed. null when the activity is not related to a project task. Filter(multi eq)
ResponsibleParty	Parties	Who is responsible for executing the task. Initially this is the owner of the task. Required Filter(multi eq)
ResponsiblePerson	Persons (nullable)	The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. Filter(multi eq) (Inherited from Documents)
ReverseOfDocument	Documents (nullable)	The document which the current document is reverse of. Filter(multi eq) ReadOnly (Inherited from Documents)
Sequence	Sequences (nullable)	The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq) ReadOnly (Inherited from Documents)
SocialGroup	Groups (nullable)	Associates the activity with the specified social group. null means that this event is not related to a social group and might be publicly visible (can still be marked as private). Filter(multi eq) Introduced in version 23.1.1.3
TargetParty	Parties (nullable)	External participant or target of the task. Filter(multi eq)
ToCompanyDivision	CompanyDivisions (nullable)	The division of the company, receiving the document. null when the document is not received by any specific division. Filter(multi eq) (Inherited from Documents)
ToParty	Parties (nullable)	The party which should receive the document. Filter(multi eq) (Inherited from Documents)
UserStatus	DocumentTypeUserStatuses (nullable)	The user status of this document if applicable for this document type. null means unknown or not yet set. Filter(multi eq) ReadOnly (Inherited from Documents)

Child Collections

Name	Type	Description
Comments	DocumentComments	List of DocumentComment(General.DocumentComments.md) child objects, based on the General.DocumentComment.Document(General.DocumentComments.md#document) back reference (Inherited from Documents)
DistributedAmounts	DocumentDistributedAmounts	List of DocumentDistributed<br />Amount(General.DocumentDistributedAmounts.md) child objects, based on the General.DocumentDistributedAmount.Document(General.DocumentDistributedAmounts.md#document) back reference (Inherited from Documents)
DocumentAmounts	DocumentAmounts	List of DocumentAmount(General.DocumentAmounts.md) child objects, based on the General.DocumentAmount.Document(General.DocumentAmounts.md#document) back reference (Inherited from Documents)
FileAttachments	DocumentFileAttachments	List of DocumentFileAttachment(General.DocumentFileAttachments.md) child objects, based on the General.DocumentFileAttachment.Document(General.DocumentFileAttachments.md#document) back reference (Inherited from Documents)
Fulfillments	DocumentFulfillments	List of DocumentFulfillment(General.DocumentFulfillments.md) child objects, based on the General.DocumentFulfillment.Document(General.DocumentFulfillments.md#document) back reference (Inherited from Documents)
LineAmounts	DocumentLineAmounts	List of DocumentLineAmount(General.DocumentLineAmounts.md) child objects, based on the General.DocumentLineAmount.Document(General.DocumentLineAmounts.md#document) back reference (Inherited from Documents)
Participants	ActivityParticipants	List of ActivityParticipant(General.Contacts.ActivityParticipants.md) child objects, based on the General.Contacts.ActivityParticipant.Activity(General.Contacts.ActivityParticipants.md#activity) back reference
Parties	DocumentParties	List of DocumentParty(General.DocumentParties.md) child objects, based on the General.DocumentParty.Document(General.DocumentParties.md#document) back reference (Inherited from Documents)
Prints	DocumentPrints	List of DocumentPrint(General.DocumentPrints.md) child objects, based on the General.DocumentPrint.Document(General.DocumentPrints.md#document) back reference (Inherited from Documents)
Reminders	Reminders	List of Reminder(General.Contacts.Reminders.md) child objects, based on the General.Contacts.Reminder.Activity(General.Contacts.Reminders.md#activity) back reference
Resources	ActivityResources	List of ActivityResource(General.Contacts.ActivityResources.md) child objects, based on the General.Contacts.ActivityResource.Activity(General.Contacts.ActivityResources.md#activity) back reference
StateChanges	DocumentStateChanges	List of DocumentStateChange(General.DocumentStateChanges.md) child objects, based on the General.DocumentStateChange.Document(General.DocumentStateChanges.md#document) back reference (Inherited from Documents)

Attribute Details

AdjustmentNumber

Consecutive number of the correction that this document is applying to the adjusted document. Required Default(0) ReadOnly (Inherited from Documents)

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

AdjustmentTime

Date/time when the document last has been adjusted by corrective document. Filter(ge;le) ReadOnly (Inherited from Documents)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

AdjustmentUser

The user who adjusted the document. ReadOnly (Inherited from Documents)

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

CompleteTime

Date and time when the document was completed (State set to Completed). Filter(ge;le) ReadOnly (Inherited from Documents)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

CreationTime

Date/Time when the document was created. Required Default(Now) Filter(ge;le) ReadOnly (Inherited from Documents)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: HiddenByDefault

CreationUser

The login name of the user, who created the document. Required Filter(like) ReadOnly (Inherited from Documents)

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

DeadlineTime

The deadline for the task. null if there is no deadline. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
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

DocumentDate

The date on which the document was issued. Required Default(Today) Filter(eq;ge;le) ORD (Inherited from Documents)

Type: date
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDate
Show in UI: ShownByDefault

DocumentNo

Document number, unique within Document_Type_Id. Required Filter(eq;like) ORD (Inherited from Documents)

Type: string (20)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 20
Show in UI: ShownByDefault

DocumentNotes

Notes for this Document. (Inherited from Documents)

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

DocumentVersion

Consecutive version number, starting with 1. Each update produces a new version of the document. Required Default(1) Filter(eq;ge;le) ReadOnly (Inherited from Documents)

Type: int32
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 1
Show in UI: HiddenByDefault

EndTime

Currently planned ending time of the task. Filter(ge;le)

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

EntityName

The entity name of the document header. Required Filter(eq) ORD ReadOnly (Inherited from Documents)

Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: True
Maximum Length: 64
Show in UI: CannotBeShown

Id

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

IsReleased

OBSOLETE! Do not use! True if the document is not void and its state is released or greater. Deprecated. Obsolete Required Default(false) Filter(eq) ReadOnly Obsoleted in version 22.1.6.61

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault

IsSingleExecution

Specifies whether the document is a single execution of its order document. Required Default(false) Filter(eq) ReadOnly

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault

Notes

Notes for this Activity.

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

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

ParentDocumentRelationshipType

Type of relationship between the current document and the parent document(s). Affects the constraints for execution/completion for the documents. Possible values: 'S' = 'Subtask', 'N' = 'Next task'. ReadOnly (Inherited from Documents)

Type: ParentDocument
RelationshipType nullable
Category: System
Relationship between parent and child documents
Allowed Values (General.ParentDocumentRelationshipType Enum Members)

Value	Description
Subtask	The child document is a sub-task of the parent document. (Complete child to complete parent) Database Value: 'S' Model Value: 0 Domain API Value: 'Subtask'
NextTask	The child document is next task of the parent document. (Complete parent to complete child) Database Value: 'N' Model Value: 1 Domain API Value: 'NextTask'
IndependentTask	The document is not dependent of neither child nor parent document. Database Value: 'I' Model Value: 2 Domain API Value: 'IndependentTask'

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

PlannedDurationMinutes

Total planned duration of the activity, regardless of the current execution status. Filter(ge;le)

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

PlanningOnly

Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned). Required Default(false) ReadOnly (Inherited from Documents)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault

Priority

Priority on the scale from 1 (least important) to 5 (very important). Required Default(3)

Type: Priority
Category: System
Generic enum type for Priority properties
Allowed Values (General.Priority Enum Members)

Value	Description
Lowest	Lowest value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'Lowest'
Low	Low value. Stored as 2. Database Value: 2 Model Value: 2 Domain API Value: 'Low'
Medium	Medium value. Stored as 3. Database Value: 3 Model Value: 3 Domain API Value: 'Medium'
High	High value. Stored as 4. Database Value: 4 Model Value: 4 Domain API Value: 'High'
Highest	Highest value. Stored as 5. Database Value: 5 Model Value: 5 Domain API Value: 'Highest'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: 3
Show in UI: ShownByDefault

Private

True if the task is visible only to its owner; false if this is publicly visible task. Required Default(false)

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

ReadOnly

True - the document is read only; false - the document is not read only. Required Default(false) ReadOnly (Inherited from Documents)

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault

ReferenceDate

Indicates the date, when the event, described by the document, actually occurred. Generally, the document should be created at the date of the event. However, if the document is created later than the event, this field contains the date of the actual event. If the field is empty, this means that the document was created at the date of the actual event and Document Date is indicative of the date of the event. Contrast this with CreationTime, which indicates when the document was entered into the system. So, generally: Reference Date <= DocumentDate <= CreationTime. Default(Today) Filter(ge;le) (Inherited from Documents)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: HiddenByDefault

ReferenceDocumentNo

The number of the document (issued by the other party), which was the reason for the creation of the current document. The numebr should be unique within the party documents. Filter(eq;like) (Inherited from Documents)

Type: string (20) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 20
Show in UI: HiddenByDefault

ReleaseTime

Date and time when the document was released (State set to Released). Filter(ge;le) ReadOnly (Inherited from Documents)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

ReminderTime

When to snooze to the owner to remind him for the task. This default reminder is copied to and managed by the Reminders entity. Filter(ge;le)

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

StartTime

Currently planned starting time of the task. Required Default(Now) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault

State

The current system state of the document. Allowed values: 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required Default(0) Filter(multi eq;ge;le) ReadOnly (Inherited from Documents)

Type: DocumentState
Category: System
Enumeration of document system states
Allowed Values (General.DocumentState Enum Members)

Value	Description
New	New document, just created. Can be edited. (Stored as 0). Database Value: 0 Model Value: 0 Domain API Value: 'New'
Adjustment	Document which adjusts other released documents. (Stored as 5). Database Value: 5 Model Value: 5 Domain API Value: 'Adjustment'
Planned	Planned by the system for future releasing. (Stored as 10). Database Value: 10 Model Value: 10 Domain API Value: 'Planned'
FirmPlanned	Planned by operator for future releasing. (Stored as 20). Database Value: 20 Model Value: 20 Domain API Value: 'FirmPlanned'
Released	Released document. Changes can be applied only through adjustment documents. (Stored as 30). Database Value: 30 Model Value: 30 Domain API Value: 'Released'
Completed	Work has completed. (Stored as 40). Database Value: 40 Model Value: 40 Domain API Value: 'Completed'
Closed	The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50). Database Value: 50 Model Value: 50 Domain API Value: 'Closed'

Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Default Value: 0
Show in UI: HiddenByDefault

StateTagsAttribute

Specifies the state of the document.

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

Subject

Task primary subject (required). Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Back-End Default Expression:
GetSystemSubject( obj.SystemType, obj.TargetParty)

SystemType

T=Task; C=Communication; M=Meeting. Required

Type: SystemType
Category: System
Allowed values for the SystemType(General.Contacts.Activities.md#systemtype) data attribute
Allowed Values (General.Contacts.ActivitiesRepository.SystemType Enum Members)

Value	Description
Communication	Communication value. Stored as 'C'. Database Value: 'C' Model Value: 0 Domain API Value: 'Communication'
Meeting	Meeting value. Stored as 'M'. Database Value: 'M' Model Value: 1 Domain API Value: 'Meeting'
Task	Task value. Stored as 'T'. Database Value: 'T' Model Value: 2 Domain API Value: 'Task'

Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Void

True if the document is null and void. Required Default(false) Filter(eq) ReadOnly (Inherited from Documents)

Type: boolean
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: HiddenByDefault

VoidReason

Reason for voiding the document, entered by the user. ReadOnly (Inherited from Documents)

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

VoidTime

Date/time when the document has become void. Filter(ge;le) ReadOnly (Inherited from Documents)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault

VoidUser

The user who voided the document. ReadOnly (Inherited from Documents)

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

Reference Details

AccessKey

The access key, containing the user permissions for this document. null means that all users have unlimited permissions. Filter(multi eq) (Inherited from Documents)

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

AdjustedDocument

The primary document, which the current document adjusts. null when this is not an adjustment document. Filter(multi eq) ReadOnly (Inherited from Documents)

Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

AssignedToUser

The user to which this document is assigned for handling. null means that the document is not assigned to specific user. Filter(multi eq) (Inherited from Documents)

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

ContactPerson

The contact person, from the side of the Target Party. Filter(multi eq)

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

CurrencyDirectory

The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions. Filter(multi eq) (Inherited from Documents)

Type: CurrencyDirectories (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

DocumentType

The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. Required Filter(multi eq) (Inherited from Documents)

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

EnterpriseCompany

The enterprise company which issued the document. Required Filter(multi eq) (Inherited from Documents)

Type: EnterpriseCompanies
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

EnterpriseCompanyLocation

The enterprise company location which issued the document. null means that there is only one location within the enterprise company and locations are not used. Filter(multi eq) (Inherited from Documents)

Type: CompanyLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

FromCompanyDivision

The division of the company, issuing the document. null when the document is not issued by any specific division. Filter(multi eq) (Inherited from Documents)

Type: CompanyDivisions (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

FromParty

The party which issued the document. Required Filter(multi eq) (Inherited from Documents)

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

MasterDocument

In a multi-document tree, this is the root document, that created the whole tree. If this is the root it is equal to Id. Required Filter(multi eq) (Inherited from Documents)

Type: Documents
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

OwnerParty

The party that owns the task. Initially this is the party that has created the task. Required Filter(multi eq)

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

Parent

In a multi-document tree, this is the direct parent document. If this is the root it is null. Filter(multi eq) (Inherited from Documents)

Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

PrimeCauseDocument

The document that is the prime cause for creation of the current document. Filter(multi eq) (Inherited from Documents)

Type: Documents (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ProjectTask

The project task for which the work is performed. null when the activity is not related to a project task. Filter(multi eq)

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

ResponsibleParty

Who is responsible for executing the task. Initially this is the owner of the task. Required Filter(multi eq)

Type: Parties
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ResponsiblePerson

The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. Filter(multi eq) (Inherited from Documents)

Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ReverseOfDocument

The document which the current document is reverse of. Filter(multi eq) ReadOnly (Inherited from Documents)

Type: Documents (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Sequence

The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq) ReadOnly (Inherited from Documents)

Type: Sequences (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

SocialGroup

Associates the activity with the specified social group. null means that this event is not related to a social group and might be publicly visible (can still be marked as private). Filter(multi eq) Introduced in version 23.1.1.3

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

TargetParty

External participant or target of the task. Filter(multi eq)

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

ToCompanyDivision

The division of the company, receiving the document. null when the document is not received by any specific division. Filter(multi eq) (Inherited from Documents)

Type: CompanyDivisions (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

ToParty

The party which should receive the document. Filter(multi eq) (Inherited from Documents)

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

Back-End Default Expression:
obj.ObtainToParty( )

UserStatus

The user status of this document if applicable for this document type. null means unknown or not yet set. Filter(multi eq) ReadOnly (Inherited from Documents)

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

API Methods

Methods that can be invoked in public APIs.

ChangeState

Changes the document state to the specified new state (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST

Parameters

• newState
  The desired new state of the document
  Type: General.DocumentState
  Enumeration of document system states
  Allowed Values (General.DocumentState Enum Members)

  Value	Description
  New	New document, just created. Can be edited. (Stored as 0). Model Value: 0 Domain API Value: 'New'
  Adjustment	Document which adjusts other released documents. (Stored as 5). Model Value: 5 Domain API Value: 'Adjustment'
  Planned	Planned by the system for future releasing. (Stored as 10). Model Value: 10 Domain API Value: 'Planned'
  FirmPlanned	Planned by operator for future releasing. (Stored as 20). Model Value: 20 Domain API Value: 'FirmPlanned'
  Released	Released document. Changes can be applied only through adjustment documents. (Stored as 30). Model Value: 30 Domain API Value: 'Released'
  Completed	Work has completed. (Stored as 40). Model Value: 40 Domain API Value: 'Completed'
  Closed	The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50). Model Value: 50 Domain API Value: 'Closed'

• userStatus
  The desired new user status of the document. Can be null.
  Type: DocumentTypeUserStatuses
  Optional: True
  Default Value: null

The process of changing the document state is very labor intensive and includes validation, generation of sub-documents and some other document-specific tasks. The state changing process might be very time-consuming, usually ranging from 500 to 5000 milliseconds. Document states usually can only be advanced to higher states, but there are exceptions from this rule. Database settings and configuration options might affect the allowed state changes. Numerous kinds of document-specific and generic exceptions can be thrown during the process.

ProcessSingleRoute

Processes the document route. (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST

Parameters

• route

  Type: Routes

• processForLowerDocumentStates

  Type: boolean

Complete

Changes the document state to Completed with all Release-ed sub-documents (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST

Parameters

• completion
  How the sub-documents will be completed, if at all
  Type: General.DocumentCompletion
  Determines how Document will be completed
  Allowed Values (General.DocumentCompletion Enum Members)

  Value	Description
  OnlyDocument	Only the document will be completed Model Value: 0 Domain API Value: 'OnlyDocument'
  WithAllChildren	The document, along with is sub-documents, will be completed Model Value: 1 Domain API Value: 'WithAllChildren'
  WithReleasedChildren	The document, along with its Release-ed sub-documents, will be completed Model Value: 2 Domain API Value: 'WithReleasedChildren'

The process of changing the document state is very labor intensive and includes validation, generation of sub-documents and some other document-specific tasks. The state changing process might be very time-consuming, usually ranging from 500 to 5000 milliseconds. Document states usually can only be advanced to higher states, but there are exceptions from this rule. Database settings and configuration options might affect the allowed state changes. Numerous kinds of document-specific and generic exceptions can be thrown during the process.

MakeVoid

Makes the document void. The operation is irreversible. (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST

Parameters

• reason
  The reason for voiding the document.
  Type: string

• voidType
  The type of void operation to execute.
  Type: General.DocumentsRepositoryBase.VoidType
  Specifies the type of void operation
  Allowed Values (General.DocumentsRepositoryBase.VoidType Enum Members)

  Value	Description
  VoidDocument	Void only the document. If there are sub-documents, the operation might fail. Model Value: 0 Domain API Value: 'VoidDocument'
  VoidWithSubDocuments	Void the document and its non-released sub-documents. If there are released sub-documents, the operation might fail. Model Value: 1 Domain API Value: 'VoidWithSubDocuments'
  VoidWithReleased SubDocuments	Void the document and all of its sub-documents, even the released ones. Model Value: 2 Domain API Value: 'VoidWithReleased SubDocuments'

  Optional: True
  Default Value: VoidDocument

• resetParentState
  Resets the parent state of document.
  Type: boolean
  Optional: True
  Default Value: True

GetPrintout

Gets a document printout as a file. The returned value is Base64 string representation of the file contents. This method creates DocumentPrint(General.DocumentPrints.md). (Inherited from Documents)
Return Type: string
Declaring Type: Documents
Domain API Request: POST

Parameters

• fileFormat
  The file format: pdf, html, xlsx, xls, docx, txt and png. The default format is 'pdf'.
  Type: string
  Optional: True
  Default Value: pdf

• printout
  The printout defined for the document type of the document. If null the default printout of the document type is used.
  Type: Printouts
  Optional: True
  Default Value: null

Recalculate

The document and all of its owned objects will be altered to become valid. (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST

In some cases the objects in child collection of the document depend on values from other child objects. This method ensures that all child objects are properly validated. The changes are only in memory and are not committed to the server.

GetAllParentDocuments

Gets all parent documents, traversing the parent document chain by using the Parent property. (Inherited from Documents)
Return Type: Collection Of Documents
Declaring Type: Documents
Domain API Request: GET

Parameters

• includeSelf
  if set to true the current document is included.
  Type: boolean
  Optional: True
  Default Value: False

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

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  The subject.
  Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

• R28916 Activity - End Time Is After Start Time
• R31596 Activity - UpdateDefaultReminder
• R36336 Activity - Check User Rights On Activity Creation And Editing
• R36627 Activity - Notify Activity Participants Upon Assignment

Front-End Business Rules

• R30433-1 Activity - Set Reminder Time
• R30433-2 Activity - Set Responsible Person
• R30433-3 Activity - Set To Party
• R30433-4 Activity - Set System Subject
• R30433-5 Activity - Set Planned Duration Minutes
• R30433-6 Activity - Set End Time
• R30433-7 Activity - Subject Late Default
• R35923 Activity - Set Owner Party
• R35924 Activity - Set Responsible Party

Generations

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_Contacts_Activities?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Contacts_Activities?$top=10