LSPS documentation logo
LSPS Documentation
Application User Interface

The Living Systems Application User Interface is the default front-end application from which you can create model instances and participate on their execution: You can submit, reject, annotate, and save your to-dos, create model instances, search for model instances, work with documents, and define application and user settings.

Application User Interface is delivered as showcase and can be customized to meet your requirements. For further information refer to the application development documentation.

The Application User Interface environment is rendered based on multiple Vaadin components: it shows the navigation menu on the very left. On the right, pages with content are displayed based on the picked navigation menu item (by default the To-do List content is shown).

From the navigation menu you can access the following pages:

  • To-do List displays the to-do view with to-dos allocated to the logged in user.
  • Documents displays the document view with documents allocated to the logged in user.
  • Run Model displays the run view with models the logged in user can instantiate.
  • Settings are available in the context menu of the user avatar.
userInterface.png
Navigation Menu outlined on the left

Access

To access the Application User Interface, do the following:

  1. Open your Web browser and enter the Application User Interface URL, for example, http://localhost:8080/lsps-application.
  2. To log on into Application User Interface, you need to enter a valid login and password (contact your system administrator).
  3. Enter the data into the respective text fields and click Log in.

Note that once in the application, the actions you can access are restricted by your security rights: Every user of the Application User Interface is assigned a set of security rights, which define the actions the user may perform (not all users can use all features). If the user requests an action he is not allowed to perform, an error notification appears.

To-Do

A to-do is an entity that serves to get data from an end user which is required by the process instance to continue its execution. data input.

A to-do is created when the process workflow reaches a user task. This type of task generates a to-do; the to-do is in the state Alive and is assigned to a user or a set of users called initial performers.

Typically one of the performers opens the to-do in their Application User Interface. On open, a to-do becomes allocated to them and locked; only the given user can work on it. The user provides the required information and submits the to-do: The to-do becomes Accomplished; the user task becomes completed and the process workflow proceeds.

Displaying a To-do

To-Dos assigned to the currently logged-in user are displayed in the To-do List view.

To display the content of a to-do in the Default Application User Interface, do the following:

  1. Open the To-Do List page.
  2. Turn on normal mode on the To-Do List page: If the button in the right-upper corner has the Cancel label, click it to change it to Select.

    The view has two modes: normal mode and select mode. Normal mode is the default mode. In this mode you can display to-do content by clicking the to-do row. In select mode, you can select multiple to-dos and lock, unlock, reject, delegate or escalate them. To activate select mode, click the Select button. Click Cancel to activate normal mode.

  3. Click the To-Do row.

Every to-do is shown as a separate row entry with the details arranged in columns:

  • Title: title of the to-do
  • Notes: annotation text
  • Priority: to-do priority as set in annotation
  • Auth.: authorization and lock information

    The authorization icon indicates what mechanism was used to assign the to-do to the user:

    • Initial : The logged-in user is one of the initial performers, first set of users calculated from the performers parameter of the task.
    • Delegation : The logged-in user is one of the delegated performers.
    • Substitution : The logged-in user is one of the substitutes.

    If the user opened the to-do already, it has been allocated to them and the to-do is locked: This is indicated by the lock icon (see Allocating To-Dos) in the Auth. column.

  • Model Instance: ID of the model instance which generated the to-do
  • Issue Date: date when the to-do was generated

You can hide or display to-do columns by clicking the Filter arrow on the to-do list table and selecting the column to hide or display.

Allocating To-Dos

When a person opens a to-do, the to-do is allocated to them and becomes locked: only the user who opened the to-do can see it in their Application User Interface. We can that the to-do is allocated to the given person.

If the person unlocks such a to-do (unallocates the to-do), it re-appears in the to-do lists of the relevant assignees, which are the initial assignees unless delegation or escalation was applied.

To lock or unlock one or multiple to-dos from the Application User Interface, do the following:

  1. Display the To-Do List page.
  2. Click Select.
  3. Select the to-dos in the list.
  4. Click the Action arrow.
  5. In the context menu, click Lock or Unlock.
lockingTodo.png
Locking a to-do

Rejecting To-Dos

When you reject a to-do, the to-do disappears from your to-do list. The to-do remains in To-do Lists of other to-do assignees.

Note: A system administrator can undo a to-do rejection and reassign the to-do to the same front-end user. Hence a rejected to-do might reappear in your to-do list.

To reject a to-do, do the following:

  1. Display the to-do: on the To-Do List page, in the normal mode, click the to-do entry.
  2. Click the Action arrow and in the context menu, click Reject.
  3. Enter the rejection reason and click Reject.

To reject one or multiple to-dos, do the following:

  1. Display the To-Do List page and select the todos.
  2. Click the Action arrow.
  3. In the context menu, click Reject.
  4. Enter the rejection reason and click Reject.

Delegating To-Dos

When you delegate a to-do, the to-do disappears from your to-do list and to-do lists of all the assignees, and is reassigned to other users defined as your delegates.

To delegate a to-do, do the following:

  1. Display the to-do: on the To-Do List page, in the normal mode, click the to-do entry.
  2. Click the Action arrow and in the context menu, click Delegate.
  3. Select the delegates and click Delegate.

To delegate one or multiple to-dos, do the following:

  1. Display the To-Do List page and select the todos.
  2. Click the Action arrow.
  3. In the context menu, click Delegate.
  4. Select the delegates and click Delegate.

Escalating To-Dos

Important: The escalation mechanism described below is deprecated. Use the GO-BPMN escalation mechanism instead; for example, call the throwEscalation() function on a button component and process the escalation with Catch Escalation elements (refer to GO-BPMN Modeling Language Specification).

When you escalate a to-do, you trigger the escalation on the process. The to-do remains in your to-do list, while the escalation processing takes place. The actions triggered by escalation vary, depending on the underlying process. When a to-do is escalated, a signal with a certain value is sent to the Execution Engine. The signal can be caught and processed. If escalation handling and catching of the signal is not defined in any model instance, escalation takes no effect.

Annotating To-Dos

You can provide notes and priority level of your locked to-dos, that is, the to-dos allocated to you, in the to-do annotation. The annotation data is visible in the to-do itself, to-do detail and in the to-do list.

If a locked to-do with notes and priority level is unlocked, the notes remain unchanged. Only the priority level is removed.

To annotate a to-do, do the following:

  1. Display the to-do: on the To-Do List page, click the to-do entry.
  2. Click the Action arrow at the top of the to-do content and in the context menu, click Annotate.
  3. Enter the annotation data and click Annotate.

Documents

The Documents view allows you to work with the available documents. Documents are similar to to-dos; however, they do not depend on a workflow and are available as long as their parent model is on the server.

documentsTab.png
Documents View

Displaying Documents

To display a document, do the following:

  1. Open the Documents view.
  2. Click the respective link in the Document table on the right.

Working on Multiple Documents and To-dos

Every user of the Application User Interface can simultaneously work on up to 10 to-dos or documents in different Web Browser tabs.

When a user opens more than 10 to-dos or documents in different Web browser tabs, only the last ten documents and to-do remain available. The ones opened before are invalidated and an error message is shown.

Running Models

The Run Model page allows you to create a model instance of an GO-BPMN model available on the server.