Handling data changes in client-side human services
In instance details and task UIs, data can be changed both locally by the user or remotely by another user or service. The remote changes must be propagated to the user's browser to keep the data in the UI current. However, the user might have unsaved changes that need to be reconciled with incoming server updates. Use a data change event handler to react to and handle remote data changes.
About this task
- At regular intervals that are based on the settings for the system timer. For more information, see Changing custom properties for Process Portal.
- Explicitly by a user if the data change event handler is bound to a view, for example, Refresh Button.
When the execution of the data event handler finishes, control is returned to the coach that was running when the event handler was started.
Human services for process UIs automatically include a default data change handler. If you generated the client-side human service for the instance UI from the Instance Details UI Service template, the service contains a data change handler with a reference implementation. You can customize the reference implementation that is provided by the template, for example, so that the instance UI refreshes when the user clicks a Refresh button. For more information about the template, see Instance Details UI Service template.
Human services for BPDs (deprecated) and case types from Business Automation Workflow V8.5.5 and earlier do not contain data change event handlers. You can upgrade the human services to handle data changes by adding and implementing a data change event handler.
Procedure
The following procedure describes how to add a data change event handler to a human service. If one of the following situations apply, follow all the steps in the procedure:
- You are creating a new data change handler implementation, for example, because you didn't generate the process instance UI from the template.
- You are upgrading a client-side human service from Business Automation Workflow V8.5.5 or earlier.