Systems.Bpm.Processes Entity
Namespace: Systems.Bpm
Contains the business process diagrams. Entity: Wf_Processes
Renames
Old name: Systems.Workflow.Processes
New name: Systems.Bpm.Processes
Version: 24.1.5.35
Case: 35911
Default Visualization
Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
Category: SystemData
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 Tree
Attributes
Name | Type | Description |
---|---|---|
CreationTime | datetime nullable | Date and time when the Process was created. Filter(ge;le) ReadOnly |
CreationUser | string (64) nullable | Login name of the user, who created the Process. ReadOnly |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
IsLandscape | boolean | Specifies whether the process diagram is intended to be viewed in landscape mode. Required Default(true) |
Name | MultilanguageString (128) | The name of this Process. Required Filter(eq;like) |
Notes | string (2000) nullable | Notes for this Process. |
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. |
SchemaFormat | string (1) | Application specific format of the Schema Layout. Required Default("D") |
SchemaLayout | string (max) | Contains the actual presentation layout of the business process. The layout is stored in the format, specified by Schema Format. Required |
StartEvent | string (3) nullable | USR=User created; EML=Email receive (still not supported). null means that there is no starting event for this process. |
StartRoleId | guid nullable | When Start_Event='USR' then specifies the role which the user must play in order to start the process. null when Start_Event<>'USR'. Filter(multi eq) |
Thumbnail | byte[] nullable | Contains the visual thumbnail of the presentation of the business process. It is stored in bitmap (BMP) format. |
UpdateTime | datetime nullable | Date and time when the Process was last updated. Filter(ge;le) ReadOnly |
UpdateUser | string (64) nullable | Login name of the user, who last updated the Process. ReadOnly |
Attribute Details
CreationTime
Date and time when the Process was created. Filter(ge;le)
ReadOnly
Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault
CreationUser
Login name of the user, who created the Process. ReadOnly
Type: string (64) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
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
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
IsLandscape
Specifies whether the process diagram is intended to be viewed in landscape mode. Required
Default(true)
Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault
Name
The name of this Process. Required
Filter(eq;like)
Type: MultilanguageString (128)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault
Notes
Notes for this Process.
Type: string (2000) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2000
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
SchemaFormat
Application specific format of the Schema Layout. Required
Default("D")
Type: string (1)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 1
Default Value: D
Show in UI: ShownByDefault
SchemaLayout
Contains the actual presentation layout of the business process. The layout is stored in the format, specified by Schema Format. Required
Type: string (max)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
StartEvent
USR=User created; EML=Email receive (still not supported). null means that there is no starting event for this process.
Type: string (3) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 3
Show in UI: ShownByDefault
StartRoleId
When Start_Event='USR' then specifies the role which the user must play in order to start the process. null when Start_Event<>'USR'. Filter(multi eq)
Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Thumbnail
Contains the visual thumbnail of the presentation of the business process. It is stored in bitmap (BMP) format.
Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown
UpdateTime
Date and time when the Process was last updated. Filter(ge;le)
ReadOnly
Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: HiddenByDefault
UpdateUser
Login name of the user, who last updated the Process. ReadOnly
Type: string (64) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Show in UI: HiddenByDefault
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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
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: UsersnotificationClass
The notification class.
Type: stringsubject
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
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Bpm_Processes?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Bpm_Processes?$top=10