LSPS documentation logo
LSPS Documentation
Data Types

Human

PerformerABSTRACTSYSTEM

An abstract record type referring to a process performer. Since it is the supertype of RoleUnit and Person, performers can be defined as either or both of these.

name : String

Name of the process performer

PersonSHAREDSYSTEM extends Performer

An application user

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 that represents both, an organization role or an organization unit.

parameters : Map<String, String>

map of organization-unit parameters or organization-role parameters

metadata : Map<String, String>

metadata key-value pairs of the role or role unit

RoleSYSTEM extends RoleUnit

organization role

OrganizationUnitSYSTEM extends RoleUnit

organization unit

TodoSHAREDSYSTEM

A to-do

id : Integer

unique identifier of the to-do

title : String

title of the to-do

start : Date

issue date of the to-do

finish : Date

date when the to-do finished;

null if the to-do is not finished yet

state : String

current execution state of the to-do;

Possible values: "ALIVE", "ACCOMPLISHED", "INTERRUPTED", and "SUSPENDED"

interruptionReason : String

Reason for interruption if in the state "INTERRUPTED"

task : String

user task that generated the todo

modelInstanceId : Integer

parent model instance

allocatedToId : String

person who the to-do is allocated to; null if not allocated

TodoEscalationSHAREDSYSTEM

signal of to-do escalation

id : Integer

unique identifier of the to-do escalation

reason : String

reason for the escalation

todoStatus : String

status of the to-do at escalation;

Possible values: "Unlocked", "Locked", "Accomplished", and "Interrupted"

time : Date

time of escalation

DocumentTypeSYSTEM

The document type

name : String

name of the document type

SavedDocumentSHAREDSYSTEM

Saved document

id : Integer

identifier of the saved document

parameters : Map<String, Object>

parameters of the saved document

savedDate : Date

date when the document was saved

isDeleted : Boolean

True if the saved document has been deleted; False if the document is still saved.

UIDefinitionABSTRACT

An abstract record type used to represent any kind of user interface definition, for instance, UI components or screen flows or custom UI.

TodoListCriteria

Criteria that a to-do returned by a query with to-do join must meet.

person : Person

person whose to-dos will be included included in the result

includeSubstituted : Boolean

includes to-dos of substitutes; If false or null, only person's own to-dos

are included

includeAllocatedByOthers : Boolean

includes to-dos allocated by other persons are included; If false or null,

only unallocated to-dos or to-dos allocated by the specified person are included

includeRejected : Boolean

includes rejected to-dos

includeAllStates : Boolean

includes todos in interrupted, accomplished, suspended state

QueryTodoSHAREDSYSTEM

To-do used in join of queried records with person's to-do list;

Instances of this record are temporary and can be used only in queries.

id : Integer

identifier of the to-do

title : String

title of the to-do

start : Date

issue date of the to-do

finish : Date

finish date of the to-do; null if the to-do is not finished

state : String

current execution state of the to-do;

Possible values: "ALIVE", "ACCOMPLISHED", "INTERRUPTED", and "SUSPENDED".

interruptionReason : String

reason for interruption for to-do in state "Interrupted"

task : String

corresponding user task in the process model

allocatedToId : String

person who has the to-do allocated; null if the to-do is not allocated

modelInstanceId : Integer

identifier of the parent model instance

Navigation

NavigationABSTRACT

An abstract record type that represents any navigation.

openNewTab : Boolean

Determines whether the link will be opened in new tab. Works in Chrome and Edge. Blocked by popup blocker in Firefox, user have to allow it. After they allow it, Firefox opens new window instead of new tab.

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 of name-value pairs

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; the following codes are supported: "todoList", "documents", and "runModel"

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 that represents any navigation in history of browsing the application pages. Its sub-types are created by the application and put to the navigation history.

id : String

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 of name-value pairs.

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

opens the to-do as read-only

HistoricalAppNavigationSYSTEM extends HistoricalNavigation

Navigation to an application page from the navigation history

code : String

code of the application page; the following codes are supported by default: "todoList", "documents", and "runModel"