Skip to content

How it Works

Setting up protocol templates in Lime Admin

Protocols are defined using Lime Admin.

What the admin interface looks like

Defining actions

Under the Actions heading you define which actions should be available for each protocol answer.

Where you add actions

Add a comment

The ability (action) to add a comment to each answer comes out-of-the-box. Just add the following to the config:

Where you add actions

Under the Actions per limetype heading you add actions for a specific parent limetype, for example work orders. This is the recommended way to configure actions. These actions can also send the protocol or the protocol response to the command instead of the parent object. See Configuration for details.

Mandatory protocol items

If a protocol item is marked as mandatory, the user can't finish the work order without answering these items.

Mark an item as mandatory in Lime Admin How it looks in the web client

Using protocols in the web client

Protocols are shown in the web client as a new tab on the parent object that owns them, for example on work orders.

What the webclient looks like

The user can add several protocols and several "copies" of the same protocol. For instance, adding a security check every day.

Adding protocols

Clicking the Add button opens a dialog with two collapsible sections, each showing a count in its header:

  • Selected protocols: the protocols that will be added. Clear a checkbox to remove a protocol from the selection.
  • Available protocols: all other protocols, sorted alphabetically (numbers in titles are sorted in natural order, so "Check 2" comes before "Check 10").

Use the search field to filter the available protocols. Selected protocols stay selected while you search. Click Add to create all selected protocols at once.

Saving

Changes are saved automatically. The form debounces changes for about 1.7 seconds and saves rapid edits in a single request.

There is no manual Save button. Save feedback is shown inline, to the left of the Add button:

  • Saving... with a spinner while a save is in progress.
  • Saved directly after a successful save.
  • Saved just now and later Saved X minutes ago after successful saves.
  • No unsaved changes when the form is loaded and no changes have been saved in the current view session.
  • ⚠️ Unable to save only when saving fails and there are unsaved changes.

Adding or deleting a protocol is also treated as a successful persisted change, so the status is updated to Saved just now after those operations.

Pending changes are saved immediately, without waiting for the debounce, before the user:

  • adds or deletes a protocol,
  • uses the protocol menu,
  • navigates to another page in the web client.

If the user navigates away while there are unsaved changes, navigation waits until the save is done. If the save fails, the user stays on the page so that no answers are lost.

Browsing protocols in the desktop client

Protocols added to a parent object is shown in the desktop client in the action pad together with the answers.

What the action pad looks like