LSPS documentation logo
LSPS Documentation
Quickstart

We will create a Document, and a Process that will display your form. From the form, we will create a new shared Record instance.

Prerequisites

Before you can start working with form definitions, you will need to:

  1. Run Designer.
  2. Open the Modeling perspective.
  3. Create a GO-BPMN project with a GO-BPMN module.
  4. Create the data module with a Data Type definition: insert a shared Record with at least one Field into the definition.
    quickstartSharedRecordProperties.png
    Shared Record
  5. Create the quickstart module and import the data module into it.
  6. Remove the ui module from module imports.

Form

Important: Before you create your form, make sure you have removed the ui module import from your module. Having both, the ui module and the forms module, imported in a module could cause exceptions on forms in runtime.

To create the form, do the following:

  1. Import the forms Module into your Module:
    1. In the GO-BOMN Explorer, expand the Module and double-click its Module Imports node.
    2. On the Imports tab of the Properties dialog, click Add.
    3. In the Add New Import dialog, double-click the Standard Library > forms Module.
  2. Create a Form Definition:
    1. Right-click your Module > New > Form Definition
    2. Enter the form name and select Use FormComponent-based UI
      quickstartFormDefProperties.png
      Creating a form definition
    3. Click Finish.
  3. In the Form editor, create a grid that will display a list of users in a tabular manner:
    1. Right-click the canvas, go to Insert Component > Container Components > Vertical Layout.
    2. Right-click the Vertical Layout, go to Insert Component > Output Components > Grid.
    3. Open the Properties view of the Grid and define the following:
      • ID unique within the form
      • data source as Type and insert the name of the shared Record so the table will use as its data source a list of all shared Records of the type.
        quickstartGrid.png
    4. Create a Grid Column with the user name:
      1. In the palette, click Grid Column and then click into the Grid.
      2. In the Column's Property view, under Value Provider select Property path and enter the property path to the name below.
        quickstartColumn1.png
        Column with record field
    5. Create another Grid Column with the date of birth:
      1. Insert another Grid Column into the Grid.
      2. Set Value Provider to Property path with the value User.dob.
      3. Set Renderer to LocalDate.
  4. Create a popup for entering new user data:

    1. Insert the Popup component from the Container Components palette section below the Grid.
    2. Define its ID and Method signature for its factory call.

      We will call the method as a button action to create and display the popup.

      quickstartPopup.png
      Popup
    3. From the Outline view, create local variables on the popup:
      • variable for a record proxy set of type RecordProxySet with the initial value createProxySet(null)
      • variable for the proxy of the new user of type User with the initial value recProxySet.proxy(data::User)

    Proxy sets with proxies exist "above" the records: this makes sure that the user data is not persisted before the user confirms that the user should be created. The aim of proxy sets and proxies is also to allow us to discard the user data without having to clean up any transient data (for further information, refer to the modeling guide).

  5. Design the popup content:
    1. Insert a Vertical Layout into the Popup: select the Margin and Spacing options in its properties.
    2. Insert a Form Layout into the Vertical Layout.
    3. Insert a Text Field into the Form Layout with its binding set to Reference and its value to the name property of the user variable.
      quickstartPopupTextField.png
      Text field with user name Binding
    4. Insert a Local Date Field into the Form Layout with its binding set to Reference and its value to the dob property of the User object.
    5. Insert the Create button and define the create logic as its click action:
      • The Proxy newUser object merges: a "proper" User object is created.
      • The table refreshes so that the new user appears in the table.
      • The Popup closes.
        {  click ->
           recProxySet.merge(false);
           userGrid.refresh();
           userDetailsPopup.hide()
        }
        
  6. Below the Grid, create a button that will open the popup:
    1. Insert a Button component under the Grid.
    2. Define its Click Listener expression to open a popup: { click -> openUserDetails().show()}
  7. Finally, we want to add the option to submit the form on button click: add a Button to the form and call { c -> Forms.submit()} from its click listener.
    quickstartSubmitButton.png
    As we will demonstrate next, a form can be used by a User Task or a Document:
  • When used by a User Task, on submit the execution of the User Task finishes and the process execution continues.
  • When used by a Documents, the system navigates away: under the hood, the server creates a model instance whenever you open a document and finishes the instance when you submit the form.

Using the Form in a Document

To create a Document with your Form, do the following:

  1. Create a document definition:
    1. Right-click your Module > New > Document Definition; enter name and click Finish
    2. In the document definition, click Add.
    3. Define the document properties and its UI definition.
      quickstartDocumentDefinition.png
      Document definition that will display our Form as its content
      Open the document:
  2. Make sure you are connected to an LSPS server or run the LSPS Embedded Server: go to Server Connections > LSPS Embedded Server > Start.
  3. In GO-BPMN Explorer, right-click your Module, go to Upload As > Model.
  4. Open a browser and go to your application URL (for the Embedded Server by default http://localhost:8080/lsps-application/ui)
  5. After you log in, go to Documents and click the document.
    quickstartOpeningDocument.png
    Opening Document
  6. Create new users in the document.
  7. When finished, click Submit.
quickstartSubmittingDocument.png
Submitting a filled-in document

Using the Form in a User Task

Create a Process with a User Task with your Form:

  1. Create a process definition: right-click your Module > New > Process Definition; enter name and click Finish
  2. In the process editor, right-click the canvas and go to New > Task.
  3. In the Select Task Type dialog, select User from the human module.
  4. On the Parameters tab in its Properties view, define the Task properties with its UI definition set to create an instance of the form.
    quickstartTaskDefinition.png
    User task that will display your Form
    To check the document and process and display the form, do the following:
  5. Make sure you are connected to an LSPS server or run the LSPS Embedded Server (go to Server Connections > LSPS Embedded Server > Start).
  6. In GO-BPMN Explorer, right-click your Module, go to Run As > Model.
  7. Open a browser and go to your application URL (for the Embedded Server by default http://localhost:8080/lsps-application/ui)
  8. After you log in, go to the To-Do List and open the to-do.
    quickstartOpeningTodo.png
    Opening To-Do
  9. Create new users in the document.
  10. When finished, click Submit.