Top Method Summary
Options Name Purpose
Consultingwerk.CommonUi.EventHandlerParameter DeserializeEventHandlerParameter (JsonObject) Deserializes the EventHandlerParameter from the input JSON object Notes : Returns an initialized EventHandlerParameter instance @param poJson The JSON request @return The EventHandlerParameter instance */
Consultingwerk.CommonUi.ListFieldValueList DeserializeFieldValueLists (JsonArray) Deserializes the value lists of the combo box and multiselect fields
Consultingwerk.Framework.MessageInteraction.ListInputPrompt DeserializeInputPrompts (JsonArray) Deserializes the input prompts
Consultingwerk.Framework.MessageInteraction.ListQuestion DeserializeQuestions (JsonArray) Deserializes the questions
Consultingwerk.CommonUi.ListTabFolderStatus DeserializeTabFolderStatuses (JsonArray) Deserializes the tab folder statuses
INTEGER GetCount (JsonObject, character) Returns a count (a non-negative integer) from a numeric JSON property
CHARACTER GetMultiRowTableNames (handle, JsonObject) Returns the names of the tables the screen values carry with more than one row Notes : SCL-6180. The response returns these tables as an array of all their rows (the selected rows of a grid, SCL-6087); a table received with a single row (as an object or as a one-element array) is returned as a single row object, as before @param phDataset The handle of the ProDataset of the server-side event handler @param poScreenValues The screen values JsonObject of the request @return The comma-delimited list of the table names */
CHARACTER GetStringMember (JsonObject, character) Returns the value of a string member of a JSON object
Progress.Json.ObjectModel.JsonObject HandleEvent (JsonObject) Handles the given event by dispatching into an Application Service
ReadScreenValuesWithBeforeImage (handle, JsonObject) Reads screen values that carry a before-image ("prods:before") into the given ProDataset Notes : Wraps the screen values in a dataset envelope and reads them into the dataset in one operation (same pattern as the JsdoGenericService SubmitData). READ-JSON populates the after- and before-tables from the JSDO-style before-image data, so that event handlers can use BUFFER-COMPARE between before- and after-values @param phDataset The handle of the ProDataset to read the screen values into @param poScreenValues The screen values JsonObject including the "prods:before" property */
RenderLookupGridLayouts (ListUiAction) Assigns the grid layout of the lookup dialog to the UpdateLookupDefinitionUiActions of an SSEH response Notes : SCL-6166. Rendered from the lookup definition (LookupDescriptor) the same way SmartBusinessEntityLookupWebRendering renders the gridLayout of a lookup in the JSON layout, including the filterable columns of the LookupDialogFilterFields (SCL-6178). A grid layout assigned by the server-side event handler is kept @param poUiActions The list of UI actions of the UiControl */
ResetDatasetChangeState (handle) Resets the change-state (before-image records, row-states) of the given ProDataset Notes : The dataset returned by the (singleton) event handler service may still carry change-state from a previous event on the same session. Change-tracking is turned off and pending changes are accepted, so that only the current request populates the before-buffers @param phDataset The handle of the ProDataset to reset */


Method Detail
Top

Consultingwerk.CommonUi.EventHandlerParameter DeserializeEventHandlerParameter (JsonObject)

Purpose: Deserializes the EventHandlerParameter from the input JSON object
Notes : Returns an initialized EventHandlerParameter instance

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON request
Returns Consultingwerk.CommonUi.EventHandlerParameter
The EventHandlerParameter instance
Top

Consultingwerk.CommonUi.ListFieldValueList DeserializeFieldValueLists (JsonArray)

Purpose: Deserializes the value lists of the combo box and multiselect
fields
Notes: SCL-6251 - entries that are no JSON object or have no fieldName
are ignored, members of another JSON type than string are
ignored, an unknown valueListDisplayText member name leaves the
property unknown - so that a malformed payload does not fail the
whole event dispatch. Members are accepted in camel case and in
Pascal case

Parameters:
poJson Progress.Json.ObjectModel.JsonArray
The JSON Array with the field value lists
Returns Consultingwerk.CommonUi.ListFieldValueList
The list of field value lists
Top

Consultingwerk.Framework.MessageInteraction.ListInputPrompt DeserializeInputPrompts (JsonArray)

Purpose: Deserializes the input prompts
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonArray
The JSON Array with input prompts
Returns Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The list of input prompts
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion DeserializeQuestions (JsonArray)

Purpose: Deserializes the questions
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonArray
The JSON Array with questions
Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of questions
Top

Consultingwerk.CommonUi.ListTabFolderStatus DeserializeTabFolderStatuses (JsonArray)

Purpose: Deserializes the tab folder statuses
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonArray
The JSON Array with tab folder statuses
Returns Consultingwerk.CommonUi.ListTabFolderStatus
The list of tab folder statuses
Top

INTEGER GetCount (JsonObject, character)

Purpose: Returns a count (a non-negative integer) from a numeric JSON
property
Notes: SCL-6087 - a fractional, negative or out of range value is
treated as 0, so that a malformed payload does not fail the
whole event dispatch

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON object of the request
pcProperty CHARACTER
The name of the numeric property
Returns INTEGER
The count
Top

CHARACTER GetMultiRowTableNames (handle, JsonObject)

Purpose: Returns the names of the tables the screen values carry with more
than one row
Notes : SCL-6180. The response returns these tables as an array of all
their rows (the selected rows of a grid, SCL-6087); a table received
with a single row (as an object or as a one-element array) is
returned as a single row object, as before

Parameters:
phDataset HANDLE
The handle of the ProDataset of the server-side event handler
poScreenValues Progress.Json.ObjectModel.JsonObject
The screen values JsonObject of the request
Returns CHARACTER
The comma-delimited list of the table names
Top

CHARACTER GetStringMember (JsonObject, character)

Purpose: Returns the value of a string member of a JSON object
Notes: SCL-6251 - looks for the member in camel case first and then in
Pascal case (first character upper case). Returns the unknown
value when the member is missing or not a JSON string

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON object
pcMemberName CHARACTER
The name of the member in camel case
Returns CHARACTER
The value of the member or the unknown value
Top

Progress.Json.ObjectModel.JsonObject HandleEvent (JsonObject)

Purpose: Handles the given event by dispatching into an Application Service
Notes:

Parameters:
poJson Progress.Json.ObjectModel.JsonObject
The JSON Request
Returns Progress.Json.ObjectModel.JsonObject
The JSON Response
Top

ReadScreenValuesWithBeforeImage (handle, JsonObject)

Purpose: Reads screen values that carry a before-image ("prods:before") into
the given ProDataset
Notes : Wraps the screen values in a dataset envelope and reads them into the
dataset in one operation (same pattern as the JsdoGenericService
SubmitData). READ-JSON populates the after- and before-tables from
the JSDO-style before-image data, so that event handlers can use
BUFFER-COMPARE between before- and after-values

Parameters:
phDataset HANDLE
The handle of the ProDataset to read the screen values into
poScreenValues Progress.Json.ObjectModel.JsonObject
The screen values JsonObject including the "prods:before" property
Top

RenderLookupGridLayouts (ListUiAction)

Purpose: Assigns the grid layout of the lookup dialog to the
UpdateLookupDefinitionUiActions of an SSEH response
Notes : SCL-6166. Rendered from the lookup definition (LookupDescriptor)
the same way SmartBusinessEntityLookupWebRendering renders the
gridLayout of a lookup in the JSON layout, including the
filterable columns of the LookupDialogFilterFields (SCL-6178).
A grid layout assigned
by the server-side event handler is kept

Parameters:
poUiActions Consultingwerk.CommonUi.ListUiAction
The list of UI actions of the UiControl
Top

ResetDatasetChangeState (handle)

Purpose: Resets the change-state (before-image records, row-states) of the
given ProDataset
Notes : The dataset returned by the (singleton) event handler service may
still carry change-state from a previous event on the same session.
Change-tracking is turned off and pending changes are accepted, so
that only the current request populates the before-buffers

Parameters:
phDataset HANDLE
The handle of the ProDataset to reset


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:17:18