Projects.Projects Entity

Namespace: Projects

Contains the planned, running and completed projects of the enterprises. Entity: Prj_Projects

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: CannotBeShown

Aggregate

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

Aggregate Tree

• Projects.Projects
  • Projects.ProjectParticipants
  • Projects.ProjectRisks
    • Projects.ProjectRiskDiscussion
  • Projects.ProjectWorkElements

Attributes

Name	Type	Description
Code	string (16)	Short code for identification of projects. Required Filter(eq;like) ORD
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FinishDate	date nullable	The drop dead date of the project, e.g. the date when the project should be finished. null means that the finish date is unknown. Filter(eq)
Id	guid
Name	string (254)	The name of this Project. Required Filter(eq;like)
Notes	string (max) nullable	Notes for this Project.
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.
ProjectStatus	ProjectStatus	Current project status. 0=New/Structuring, 10=Budgeting, 20=Panning, 30=Started, 40=Resolved(Completed), 45=Resolved(Cancelled), 50=Closed(Completed), 55=Closed(Cancelled). Required Default(0) Filter(multi eq)
StartDate	date nullable	Expected date, when the execution of the tasks will start. null means that the start date is still unknown. Filter(eq)

References

Name	Type	Description
BudgetingCurrency	Currencies (nullable)	The currency in which the project budget is calculated. Filter(multi eq)
ClientParty	Parties (nullable)	The external or internal client of the project. Filter(multi eq)
EnterpriseCompany	EnterpriseCompanies (nullable)	The Enterprise Company to which this Project applies, or null if it is for all enterprise companies. Filter(multi eq)
ProjectManagerPerson	Persons (nullable)	The project manager. Filter(multi eq)
ProjectType	ProjectTypes	The project type defines the basic WBS and default tasks, etc. It is also used as baseline WBS, when combining reports for many projects. Required Filter(multi eq)

Child Collections

Name	Type	Description
Participants	ProjectParticipants	List of ProjectParticipant(Projects.ProjectParticipants.md) child objects, based on the Projects.ProjectParticipant.Project(Projects.ProjectParticipants.md#project) back reference
Risks	ProjectRisks	List of ProjectRisk(Projects.ProjectRisks.md) child objects, based on the Projects.ProjectRisk.Project(Projects.ProjectRisks.md#project) back reference
WorkElements	ProjectWorkElements	List of ProjectWorkElement(Projects.ProjectWorkElements.md) child objects, based on the Projects.ProjectWorkElement.Project(Projects.ProjectWorkElements.md#project) back reference

Attribute Details

Code

Short code for identification of projects. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
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

FinishDate

The drop dead date of the project, e.g. the date when the project should be finished. null means that the finish date is unknown. Filter(eq)

Type: date nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Id

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

Name

The name of this Project. Required Filter(eq;like)

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

Notes

Notes for this Project.

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

ProjectStatus

Current project status. 0=New/Structuring, 10=Budgeting, 20=Panning, 30=Started, 40=Resolved(Completed), 45=Resolved(Cancelled), 50=Closed(Completed), 55=Closed(Cancelled). Required Default(0) Filter(multi eq)

Type: ProjectStatus
Category: System
Allowed values for the ProjectStatus(Projects.Projects.md#projectstatus) data attribute
Allowed Values (Projects.ProjectsRepository.ProjectStatus Enum Members)

Value	Description
NewOrStructuring	NewOrStructuring value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'NewOrStructuring'
Budgeting	Budgeting value. Stored as 10. Database Value: 10 Model Value: 10 Domain API Value: 'Budgeting'
Planning	Planning value. Stored as 20. Database Value: 20 Model Value: 20 Domain API Value: 'Planning'
Started	Started value. Stored as 30. Database Value: 30 Model Value: 30 Domain API Value: 'Started'
ResolvedCompleted	ResolvedCompleted value. Stored as 40. Database Value: 40 Model Value: 40 Domain API Value: 'ResolvedCompleted'
ResolvedCancelled	ResolvedCancelled value. Stored as 45. Database Value: 45 Model Value: 45 Domain API Value: 'ResolvedCancelled'
ClosedCompleted	ClosedCompleted value. Stored as 50. Database Value: 50 Model Value: 50 Domain API Value: 'ClosedCompleted'
ClosedCanceled	ClosedCanceled value. Stored as 55. Database Value: 55 Model Value: 55 Domain API Value: 'ClosedCanceled'

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

StartDate

Expected date, when the execution of the tasks will start. null means that the start date is still unknown. Filter(eq)

Type: date nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

BudgetingCurrency

The currency in which the project budget is calculated. Filter(multi eq)

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

ClientParty

The external or internal client of the project. Filter(multi eq)

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

EnterpriseCompany

The Enterprise Company to which this Project applies, or null if it is for all enterprise companies. Filter(multi eq)

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

ProjectManagerPerson

The project manager. Filter(multi eq)

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

ProjectType

The project type defines the basic WBS and default tasks, etc. It is also used as baseline WBS, when combining reports for many projects. Required Filter(multi eq)

Type: ProjectTypes
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

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

None

API

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

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