Projects.Procedures.OperationalProcedureChecklistTemplates

Mapping: which checklist templates are used by a procedure (and in what order).

General

Namespace: Projects.Procedures
Repository: Projects.Procedures.OperationalProcedureChecklistTemplates
Base Table: Op_Operational_Procedure_Checklist_Templates
Introduced In Version: 26.2.1.35
API access: ReadWrite

Visualization

Display Format: {OperationalProcedure.Code}
Search Members: OperationalProcedure.Code
Name Member: OperationalProcedure.Code
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.Procedures.OperationalProcedures
Aggregate Root:
Projects.Procedures.OperationalProcedures

Attributes

Name	Type	Description
Notes	string (max) nullable	Notes for the template. Filter(like)
SeqNo	int32	Order of inclusion. Required Filter(eq) ORD

References

Name	Type	Description
ChecklistTemplate	ChecklistTemplates	Checklist template which to include in the procedure. Required Filter(multi eq)
OperationalProcedure	OperationalProcedures	Owner procedure. Required Filter(multi eq) Owner

System Attributes

Name	Type	Description
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.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

Notes

Notes for the template. Filter(like)

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

SeqNo

Order of inclusion. Required Filter(eq) ORD

Type: int32
Category: System
Supported Filters: Equals
Supports Order By: True
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.OperationalProcedure.ChecklistTemplates.Select( c => c.SeqNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
obj.SetSeqNo( obj.OperationalProcedure) ( obj.OperationalProcedure.ChecklistTemplates.Select( c => c.SeqNo).DefaultIfEmpty( 0).Max( ) + 10)

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, 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

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

Reference Details

ChecklistTemplate

Checklist template which to include in the procedure. Required Filter(multi eq)

Type: ChecklistTemplates
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

OperationalProcedure

Owner procedure. Required Filter(multi eq) Owner

Type: OperationalProcedures
Indexed: True
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

• priority
  The notification priority.
  Type: Systems.Core.NotificationsRepository.Priority
  Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
  Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

  Value	Description
  Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
  Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
  Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
  High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
  Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

  Optional: True
  Default Value: Normal

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

• R39484 Operational Procedure Checklist Template - Set Seq No (Recalc)

API

Domain API Entity Set: Projects_Procedures_OperationalProcedureChecklistTemplates

Domain API Entity Type: Projects_Procedures_OperationalProcedureChecklistTemplate

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

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