Inline edits

Action-backed inline edits are validated and submitted differently than standard Actions. For standard Actions, multiple parameters need to be set in order for the Action to be valid. However, for Action-backed inline edits, every parameter is optional and defaults to the existing value of the object, so a user can make individual changes to properties one at a time.

This documentation discusses how to avoid unexpected results when using inline edits. Inline edits are available in both Workshop and Object Explorer. The configuration of the inline edit Action depends on where the Action is used.

Object Explorer inline edits

Inline edits allow users to quickly edit values of an object in the Object Explorer results view or native Object view widgets, like the property or metric cards widget.

Configuration

To set up an inline edit Action, navigate to the Properties tab of your object type and then to the Interaction tab in Ontology Manager. Select a property and navigate to Inline edit in the sidebar. In the dropdown menu, select one of the available Action types or create a new one. Creating a new one will trigger the Action type creation workflow. Each property can have only one inline edit Action type.

You can use the same Action type as an inline edit for multiple properties, or you can have separate Action types for different properties.

Action type requirements for inline edits

Not all Action types can be used as inline edit Action types. To be accepted, the Action type must meet the following requirements:

• May only modify a single object of a single object type.
• Default values must be enabled.
• Default values must come from the object reference parameter on which the inline Action is defined. As a result, properties that are being changed in the Action cannot be mapped to static values or special values like "Current User" or "Current Time".
• Visibility status and overrides can be set; however, they will be ignored if the inline edit is used in Object Explorer and Object Views.
• Side effect webhooks or side effect notifications cannot be enabled.

Workshop inline edits

No additional configuration is required to use an Action type as an inline edit in Workshop, but not all Actions are suitable for cell-level editing. For information on how to configure inline edits, see the Workshop documentation.

Background

When running a single Action, edits are validated and submitted one at a time (sequentially). Inline edits differ in that they are validated and submitted in bulk. Because of this, not all Actions are suitable for inline edits. Actions that may fail or have unexpected results due to inline edits include:

• Any Action that attempts to read data to which another Action could have written, or
• Two Actions that try to write to the same object.

Valid inline Actions

Actions must submit non-conflicting edits to be effective as Action-backed inline edits. In practice, this means multiple Actions configured in the same table edit widget must not:

• Write to the same object,
• Create the same link, or
• Attempt to keep aggregate values consistent.

Invalid inline Actions

Actions will return an error if an inline edit attempts to edit the same object twice. Also, adding or deleting join table links is not supported by inline edits and will result in a user-facing error message.

As users apply inline edits, submission criteria will be applied to each edit, but the edits will be submitted in bulk. Both parameter and global submission criteria will be evaluated for each edited object, but submission criteria that reference shared or linked objects are not compatible with inline edits. This is because when applying inline edits, cumulative submission criteria compare the edited value to the unedited values for the column. At final submission, the edits will be submitted all at once and will succeed if they all pass parameter and global submission criteria for the corresponding object.

Submission criteria on objects shared between multiple Action types or linked objects are therefore evaluated once per edit, before any edits are made.

Example: Invalid inline Actions

Imagine a Delay Flight Action that can delay a single flight by a maximum of 20 minutes at an airport that can delay all flights by a maximum of 50 minutes.

• Both submission criteria – the 20 minute requirement and the 50 minute total – will be evaluated each time a cell is updated.
  • Because no edits are yet submitted, the 50 minute total will compare the new delays to the sum of unedited delays in the column (the delays from before inline editing began).
• The second submission criteria (that all the delays at the airport sum to less than 50 minutes) relies on an aggregated value and is shared by all the objects in the column.
  • Since inline edits are submitted in bulk, this second submission criteria will not be effective in limiting the total duration of flight delays at a given airport; the resulting edits could sum to greater than the 50 allowed by the second submission criteria.
• This Action would not be suitable for table editing as it would cause inconsistent results compared to running the Action individually for each cell.