Skip to content

Latest commit

 

History

History
252 lines (182 loc) · 8.48 KB

Applications.Fleet.MaintenancePlans.md

File metadata and controls

252 lines (182 loc) · 8.48 KB
Raw
uid
Applications.Fleet.MaintenancePlans

Applications.Fleet.MaintenancePlans Entity

Namespace: Applications.Fleet

Defines the periodic maintenance plans and the conditions for performing the next maintenance. Entity: Fleet_Maintenance_Plans

Default Visualization

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

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
CheckDays int32 nullable When not null, specifies the number of days between maintenances.
CheckMonths int32 nullable When not null, specifies the number of months between maintenances.
Code string (16) The unique code of the MaintenancePlan. Required
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsActive boolean True if the plan is active and can be selected from drop-downs. Required Default(true) Introduced in version 18.2
MileageKm int32 nullable When not null, specifies the number of kilometers that must have passed since the last maintenance, for the next maintenance to occur.
Name string (254) Maintenance plan name (Multilanguage). Required
Notes string (max) nullable Notes for this MaintenancePlan.
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.
TripCount int32 nullable When not null, specifies the number of trips that must be performed since the last maintenance, for the next maintenance to occur.

Attribute Details

CheckDays

When not null, specifies the number of days between maintenances.

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

CheckMonths

When not null, specifies the number of months between maintenances.

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

Code

The unique code of the MaintenancePlan. Required

Type: string (16)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
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

Id

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

IsActive

True if the plan is active and can be selected from drop-downs. Required Default(true) Introduced in version 18.2

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

MileageKm

When not null, specifies the number of kilometers that must have passed since the last maintenance, for the next maintenance to occur.

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

Name

Maintenance plan name (Multilanguage). Required

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

Notes

Notes for this MaintenancePlan.

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

TripCount

When not null, specifies the number of trips that must be performed since the last maintenance, for the next maintenance to occur.

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

[!list limit=1000 erp.entity=Applications.Fleet.MaintenancePlans erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Applications.Fleet.MaintenancePlans erp.type=front-end-business-rule default-text="None"]

API

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

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