Table of Contents

Projects.Classic.WorkReportMaterials Entity

Namespace: Projects.Classic

Each record contains a consumed material, reported by the related Work Report. Entity: Prj_Work_Report_Materials

Default Visualization

Default Display Text Format:
{WorkReport.EntityName}
Default Search Members:
WorkReport.EntityName
Name Data Member:
WorkReport.EntityName
Category: Definitions
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 Parent:
Projects.Classic.WorkReports
Aggregate Root:
Projects.Classic.WorkReports

Attributes

Name Type Description
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.
Quantity decimal (9, 3) The consumed quantity of the material. Required Default(0) Filter(eq;like)
QuantityBase decimal (9, 3) The equivalence of Quantity in the base measurement unit of the Material. Required Default(0) Filter(eq;like) ReadOnly

References

Name Type Description
MaterialProduct Products The consumed material. Required Filter(multi eq)
ProjectTask ProjectTasks The project task for which the materials are reported. Required Filter(multi eq)
QuantityUnit MeasurementUnits The measurement unit of Quantity. It is strongly suggested that the same unit is used for planning and usage reporting. Required Filter(multi eq)
WorkReport WorkReports The to which this WorkReportMaterial belongs. Required Filter(multi eq) Owner

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

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

Quantity

The consumed quantity of the material. Required Default(0) Filter(eq;like)

Type: decimal (9, 3)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

QuantityBase

The equivalence of Quantity in the base measurement unit of the Material. Required Default(0) Filter(eq;like) ReadOnly

Type: decimal (9, 3)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( ( obj.QuantityUnit != null) AndAlso ( obj.MaterialProduct != null)), new Quantity( obj.Quantity, obj.QuantityUnit).ConvertTo( obj.MaterialProduct.BaseUnit, obj.MaterialProduct).Value, obj.QuantityBase)

Reference Details

MaterialProduct

The consumed material. Required Filter(multi eq)

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

ProjectTask

The project task for which the materials are reported. Required Filter(multi eq)

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

Back-End Default Expression:
obj.WorkReport.ProjectTask

Front-End Recalc Expressions:
obj.WorkReport.ProjectTask

QuantityUnit

The measurement unit of Quantity. It is strongly suggested that the same unit is used for planning and usage reporting. Required Filter(multi eq)

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

WorkReport

The to which this WorkReportMaterial belongs. Required Filter(multi eq) Owner

Type: WorkReports
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification 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/Projects_Classic_WorkReportMaterials?$top=10

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