General.Contacts.ActivityTimeIntervals Entity

Namespace: General.Contacts

History of work efforts for executing activities (timesheet). Entity: Cm_Activity_Time_Intervals

Default Visualization

Default Display Text Format:
{Party.PartyName:T}
Default Search Members:
Party.PartyName
Name Data Member:
Party.PartyName

Aggregate

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

Aggregate Parent:
General.Contacts.Parties
Aggregate Root:
General.Contacts.Parties

Attributes

Name Type Description
Date date The date on which the work was performed. Required Filter(eq;ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EndTime time The ending time of the time interval within 'Date'. Required Filter(ge;le)
ExecutionCompletePercent decimal (3, 2) Percent of task completed. Required Default(0) Filter(ge;le)
Id guid
Notes string (254) nullable Notes for the time interval.
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.
StartTime time The starting time of the time interval within 'Date'. Required Filter(ge;le)
State DocumentState nullable The state of the primary activity in the moment the time interval was created. null when the state is unknown.

References

Name Type Description
Activity Activities The activity for which the time interval is recorded. Required Filter(multi eq)
Party Parties The party for which the time interval is recorded. Required Filter(multi eq) Owner
UserStatus DocumentTypeUserStatuses (nullable) The user status of the primary activity in the moment the time interval was created. null when the user status is unknown. Filter(multi eq)

Attribute Details

Date

The date on which the work was performed. Required Filter(eq;ge;le)

Type: date
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False

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: ****

EndTime

The ending time of the time interval within 'Date'. Required Filter(ge;le)

Type: time
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False

ExecutionCompletePercent

Percent of task completed. Required Default(0) Filter(ge;le)

Type: decimal (3, 2)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: 0

Front-End Recalc Expressions:
IIF( ( obj.Activity.PlannedDurationMinutes == Convert( 0, Nullable1)), 0, Min( 0.9, Round( Max( 0, ( obj.Transaction.Clone( ).Query( ).Where( ti => ( ti.Activity == obj.Activity)).ToList( ).Where( ti => ( ( ti != obj) AndAlso ( ti.Date.Add( ti.EndTime) <= obj.Date.Add( obj.EndTime)))).OrderBy( ti => ti.Date.Add( ti.EndTime)).Select( ti => ti.ExecutionCompletePercent).LastOrDefault( ) + Convert( ( Convert( ( obj.EndTime - obj.StartTime).TotalMinutes, Nullable1) / Convert( obj.Activity.PlannedDurationMinutes, Nullable1)), Decimal))), 2)))`

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid

Notes

Notes for the time interval.

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

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: ****

StartTime

The starting time of the time interval within 'Date'. Required Filter(ge;le)

Type: time
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False

State

The state of the primary activity in the moment the time interval was created. null when the state is unknown.

Type: DocumentState nullable
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: NotFilterable
Supports Order By: False

Reference Details

Activity

The activity for which the time interval is recorded. Required Filter(multi eq)

Type: Activities
Category: System
Supported Filters: Equals, EqualsIn

Party

The party for which the time interval is recorded. Required Filter(multi eq) Owner

Type: Parties
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True

UserStatus

The user status of the primary activity in the moment the time interval was created. null when the user status is unknown. Filter(multi eq)

Type: DocumentTypeUserStatuses (nullable)
Category: System
Supported Filters: Equals, EqualsIn

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

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

None

Front-End Business Rules

API

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

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