Applications.Service.ServiceObjects Entity

Namespace: Applications.Service

Contains the serviceable objects. The service objects can be covered by service agreements, serviced in service activities, etc. Entity: Srv_Service_Objects

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
SerialNumber; Name
Code Data Member:
SerialNumber
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: ServiceObjectTypeId

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 Tree

Applications.Service.ServiceObjects

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
IsActive	boolean	Indicates whether the current service object is active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 22.1.5.53`
Name	string (254)	The name of this ServiceObject. `Required` `Filter(eq;like)`
Notes	string (254) nullable	Notes for this ServiceObject.
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.
SerialNumber	string (32) nullable	The serial number of the item, that is being serviced. `Filter(like)`

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies (nullable)	The Enterprise Company to which this ServiceObject applies, or null if it is for all enterprise companies. `Filter(multi eq)`
ManagedAsset	ManagedAssets (nullable)	Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. `Filter(multi eq)` `Introduced in version 24.1.4.74`
Product	Products (nullable)	When not-null identifies the product, from which the service object was created. `Filter(multi eq)`
SerialNumberObj	SerialNumbers (nullable)	Serial number for the product, that corresponds to this service object. If there is no product, then the other field for 'Serial number' is used to specify this data. `Filter(multi eq)`
ServicedProduct	Products (nullable)	The product, which is used to physically store the service object, when it is serviced. Need to be specified, only when it is different from Product; otherwise, it is null. `Filter(multi eq)`
ServiceObjectType	ServiceObjectTypes (nullable)	When not null specifies the type of the service object. `Filter(multi eq)`

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

IsActive

Indicates whether the current service object is active. Required Default(true) Filter(eq) Introduced in version 22.1.5.53

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

Name

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

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

Front-End Recalc Expressions:
obj.Product.Name

Notes

Notes for this ServiceObject.

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

SerialNumber

The serial number of the item, that is being serviced. Filter(like)

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

Front-End Recalc Expressions:
IIF( ( obj.SerialNumberObj != null), null, obj.SerialNumber)

Reference Details

EnterpriseCompany

The Enterprise Company to which this ServiceObject 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

ManagedAsset

Link to a managed asset definition from the asset management module. It is used to manage, track and maintain the asset. Filter(multi eq) Introduced in version 24.1.4.74

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

Product

When not-null identifies the product, from which the service object was created. Filter(multi eq)

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

SerialNumberObj

Serial number for the product, that corresponds to this service object. If there is no product, then the other field for 'Serial number' is used to specify this data. Filter(multi eq)

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

Front-End Recalc Expressions:
IIF( ( obj.SerialNumber != null), null, obj.SerialNumberObj)

ServicedProduct

The product, which is used to physically store the service object, when it is serviced. Need to be specified, only when it is different from Product; otherwise, it is null. Filter(multi eq)

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

ServiceObjectType

When not null specifies the type of the service object. Filter(multi eq)

Type: ServiceObjectTypes (nullable)
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

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