Configuring the save without refresh feature in a process grid

This article describes the steps to configure the Save without refresh functionality, which enables users to save process grids without systematically refreshing their data. This functionality can only be configured via an API call and will enable the display of the Save Without Refresh button, located at the bottom of the process grid.

This is a warning message.

This feature should be enabled only in exceptional cases, because it can result in potential loss of data. Make sure to configure this feature with extreme care.

You can configure this functionality per process and per profile.

Modifying the existing saving mechanism

Use the following API method to change the saving mechanism used in the process

Saving mechanism definition method

Service	Action	Endpoint	Parameters	Output
Gateway	GET	/api/Process/GetProcessById?idProcess={Process ID}	refresh_grid_after_save true: classic behavior false: new method enabled (save without refresh)	Copy {      process: {... },     refresh_grid_after_save: Boolean     userPageSize: int }

Adding the required parameter to the database

In order to correctly configure the feature, you need to add the required parameter into the database. To do so, proceed as follows:

• Add a new column called refresh_grid_after_save to the k_m_plan_display table.

Configuring the new saving method

The purpose of the new method is to display the Save Without Refresh button. To configure the method, use the following API call:

Saving method configuration API

Service	Action	Endpoint	Body
Gateway	PUT	api/process/UpdateProcessConfiguration	Copy {     "idPlan": INTEGER,     "idProfile": INTEGER,     "refreshGridAfterSave": BOOLEAN }

Configuring the API methods

When the Save Without Refresh button is enabled, the following API methods must be executed in order to complete the save operation on the back-end side:

• Gateway, POST /api/ProcessExplorer/CheckLineItemDataValidation

• Gateway, POST /api/ProcessExplorer/SaveProcessGridValues

• Gateway, POST /api/ProcessExplorer/TryPostCustomStoredProcedureForProcess

Interacting with the user interface

After these methods have been successfully executed, when a user click on the Save Without Refresh button, the UI will return a validation as well as a warning message:

Validation and warning messages

If a user performs one of the following actions, the grid data will be automatically refreshed:

• Validate or invalidate a record

• Filter

• Sort

• Group

• Change or reset view

• Filter by level

• Change page number or page size

Managing Security

This feature is authorized only for users to whom the following permissions have been granted:

• Super Admin profile

• Owner of the process

• Members of a team with which the process is shared

Configuring attached objects refresh after a grid saving issue

You can configure a property in order to save the modifications performed in attached objects even if some invalid data were entered in the process grid. To configure this functionality, the attached_object_refresh_after_save_always parameter in the k_m_plans table must be set to true for the relevant process grid.