LSPS documentation logo
LSPS Documentation
Data Types

Human

PerformerABSTRACTSYSTEM

An abstract record type referring to any process performer.

name : String

Name (identifier) of the process performer.

PersonSHAREDSYSTEM extends Performer

Reference to a person (user of the application). The attribute name inherited from Performer is set to the person’s login name.

id : String

Unique identifier and the primary key of the person.

firstName : String

First name of the person.

lastName : String

Last name of the person.

email : String

E-mail address of the person.

phone : String

Phone of the person.

isEnabled : Boolean

True, if the person is enabled. False, if the person is disabled

RoleUnitABSTRACTSYSTEM extends Performer

An abstract record type used to commonly represent an organization role or an organization unit.

parameters : Map<String, String>

Map of the actual organization unit parameters or organization role parameters. Keys represent the parameter names, values represent the parameter values.

metadata : Map<String, String>

Set of metadata (key-value pairs) of the corresponding model element.

RoleSYSTEM extends RoleUnit

Reference to an organization role.

OrganizationUnitSYSTEM extends RoleUnit

Reference to an organization unit.

TodoSHAREDSYSTEM

A record used for representing a to-do.

id : Integer

Unique identifier of the to-do.

title : String

Title of the to-do.

start : Date

Issuing date of the to-do.

finish : Date

Date for finishing the to-do, whereas null is used if the to-do is not finished yet.

state : String

Name of the current execution state of the to-do. Possible values are: "ALIVE", "ACCOMPLISHED", "INTERRUPTED", and "SUSPENDED".

interruptionReason : String

Reason for interruption, if the state is "Interrupted".

task : String

Identification of the corresponding task in the process model.

modelInstanceId : Integer

Identified of the parent model instance.

allocatedToId : String

Identified of the person who allocated to-do. It is null, if the to-do is not allocated.

TodoEscalationSHAREDSYSTEM

A record used for representing the data of a signal for escalating a to-do.

id : Integer

Unique identifier of the to-do escalation.

reason : String

Description of the reason for escalation.

todoStatus : String

Name of the status of the to-do at the time of its escalation. Possible values are: "Unlocked", "Locked", "Accomplished", and "Interrupted".

time : Date

Time of escalation triggering

DocumentTypeSYSTEM

A record used for representing the type of document.

name : String

Name of the document type.

SavedDocumentSHAREDSYSTEM

A record used for representing a saved document.

id : Integer

Unique identifier of the saved document.

parameters : Map<String, Object>

Parameters of the saved document.

savedDate : Date

The date when the document was saved.

isDeleted : Boolean

If true, the saved document has been deleted. If false, the document is still saved.

UIDefinitionABSTRACT

An abstract record type used to commonly represent any kind of user interface (UI) definition, for instance, UI components or screen flows or any other UI kind defined in future.

TodoListCriteria

A record used to specify which to-dos will be used for joining of queried records with person's to-do list (Join Todo List section in query editor).

person : Person

A person of which to-dos will be used for joining.

includeSubstituted : Boolean

If true, also the to-dos from substituted persons are included. If false, only person's own to-dos

are included.

includeAllocatedByOthers : Boolean

If true, also the to-dos already allocated by other persons are included. If false, only unallocated to-dos or to-dos allocated by the specified person are included.

QueryTodoSHAREDSYSTEM

A record representing a to-do used for joining queried records with person's to-do list (Join Todo List section in query editor). The record contains information about a to-do. Instances of this record are temporary and can be used just in queries.

id : Integer

Unique identifier of the to-do.

title : String

Title of the to-do.

start : Date

Issuing date of the to-do.

finish : Date

Date for finishing the to-do, whereas null is used if the to-do is not finished yet.

state : String

Name of the current execution state of the to-do. Possible values are: "ALIVE", "ACCOMPLISHED", "INTERRUPTED", and "SUSPENDED".

interruptionReason : String

Reason for interruption, if the state is "Interrupted".

task : String

Identification of the corresponding task in the process model.

allocatedToId : String

Identifier of the person who allocated to-do. It is null, if the to-do is not allocated.

modelInstanceId : Integer

Identified of the parent model instance.

Navigation

NavigationABSTRACT

An abstract record type used to represent any navigation.

DocumentNavigation extends Navigation

Navigation to a document.

documentType : DocumentType

Type of the document to navigate to.

parameters : Map<String, Object>

Parameters of the document specified as a map containing pairs parameter name - parameter value.

SavedDocumentNavigation extends Navigation

Navigation to a saved document.

savedDocument : SavedDocument

Saved document to navigate to.

TodoNavigation extends Navigation

Navigation to a to-do. If the current user has no access rights for the to-do, the "no access rights" exception occurs.

todo : Todo

To-do to navigate to.

openAsReadOnly : Boolean

If true, the to-do is opened in read-only mode. If false, the to-do is opened in read-write mode.

AppNavigation extends Navigation

Navigation to an application page.

code : String

Code of the application page. In the Living Systems Process Application, the following codes are supported: "todoList", "documents", and "runModel". Custom applications can extend and/or change this set of codes.

UrlNavigation extends Navigation

Navigation to a web page given by URL.

url : String

URL of the page to navigate to.

HistoricalNavigationABSTRACT extends Navigation

An abstract record type used to represent any navigation in history of browsing application pages. Its concrete sub-types are created by the application and put to the navigation history.

id : String

Unique identifier of the entry in the history to navigate to.

firstDisplay : Date

Date when the application page was first displayed.

title : String

Title of the page from navigation history.

HistoricalDocumentNavigationSYSTEM extends HistoricalNavigation

Navigation to a document from the navigation history.

documentType : DocumentType

Type of the document to navigate to.

parameters : Map<String, Object>

Parameters of the document specified as a map containing pairs parameter name - parameter value.

HistoricalSavedDocumentNavigationSYSTEM extends HistoricalNavigation

Navigation to a saved document from the navigation history.

savedDocument : SavedDocument

Saved document to navigate to.

HistoricalTodoNavigationSYSTEM extends HistoricalNavigation

Navigation to a to-do from the navigation history. If the current user has no access rights for the to-do, the "no access rights" exception occurs.

todo : Todo

To-do to navigate to.

openAsReadOnly : Boolean
HistoricalAppNavigationSYSTEM extends HistoricalNavigation

Navigation to an application page from the navigation history.

code : String

Code of the application page. In the Living Systems Process Application, the following codes are supported: "todoList", "documents", and "runModel". Custom applications can extend and/or change this set of codes.