Namespace: Consultingwerk.Integrations.RapidCloud
Class 
RapidCloudResponse Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Integrations.RapidCloud.RapidCloudResponse

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddBroadcastRule (character, character, character) Adds a broadcast rule to the response that makes all active RCD sessions showing the changed records refresh
AddCancel (character) Adds a cancellation result to the response
AddError (character) Adds an error message to the response
AddError (character, character) Adds an error message naming the control to highlight to the response
AddError (Error) Adds the messages of the given error to the response
AddInfo (character) Adds an informational message to the response
AddNextRowId (character, character) Adds the paging continuation token to the response
AddResponseParameter (character, character) Adds an out-of-band response parameter to the response
AddResult (character, character) Adds a result row of the given type to the response
AddResults (handle) Adds the result rows of the given ttResult shaped buffer to the response
AddRule (character, character, character, integer) Adds a UI rule to the response
AddWarning (character) Adds a warning message to the response
CloseCurrentProgram () Requests closing the current program after the result messages were shown
CreateActionRule (JsonObject, integer) Adds an action rule (frontend trigger) to the response
CreateResponseDataset (handle, dataset-handle) Creates the response ProDataset with the given data buffer followed by the response envelope (ttResult and ttRules)
CreateResponseDataset (handle[], dataset-handle) Creates the response ProDataset with the given data buffers followed by the response envelope (ttResult and ttRules)
CreateResponseDataset (dataset-handle) Creates the response ProDataset with the response envelope (ttResult and ttRules)
CreateRule (character, character, character, integer) Creates a rule setting a field or object property
CreateRule (character, character, date, integer) Creates a rule setting a field or object property from a date value
CreateRule (character, character, datetime, integer) Creates a rule setting a field or object property from a datetime value
CreateRule (character, character, datetime-tz, integer) Creates a rule setting a field or object property from a datetime-tz value
CreateRule (character, character, decimal, integer) Creates a rule setting a field or object property from a decimal value
CreateRule (character, character, integer, integer) Creates a rule setting a field or object property from an integer value
CreateRule (character, character, logical, integer) Creates a rule setting a field or object property from a logical value
CreateRuleTarget (character, character, character, JsonArray, integer) Creates a rule writing a frontend data source
CreateRuleTargetTabText (character, character) Creates a rule updating the program tab text
FocusField (character) Creates a rule setting the cursor (focus) to the given field
CHARACTER GetFieldProperty (character, character) Returns the value of a form field property
LoadFormFields (handle) Loads the form state sent by the frontend into the response
CHARACTER MergeEntryList (character, character) Merges two comma-delimited lists without duplicates
INTEGER NextSequence (integer) Returns the next execution sequence
OpenApp (character, logical) Requests opening another app (PORTAL/OpenProgram)
OpenUrl (character) Requests opening a URL (PORTAL/OpenURL)
PublishResponseParameters () Publishes the response parameters of this response to the RCD web handler
CHARACTER ResponseParameterValue (character) Returns the value of the given response parameter
HANDLE ResultBuffer () Returns the buffer of the result table
HANDLE RulesBuffer () Returns the buffer of the rules table

Top Property Summary
Options Name Purpose
CHARACTER DatasetName
LOGICAL HasErrors


Method Detail
Top

AddBroadcastRule (character, character, character)
Purpose: Adds a broadcast rule to the response that makes all
active RCD sessions showing the changed records refresh
Notes: Server-side the broadcast is an ordinary rule row - the
RCD frontend rule engine performs the actual websocket
broadcast. Follows the record-changed event shape of the
Organi reference implementation: the row id list is
deduplicated, lower cased and merged with an already
added broadcast rule of the same source and change type

Parameters:
pcChangeType CHARACTER
The type of the change (refresh or delete)
pcRowIdData CHARACTER
The comma-delimited list of record identity tokens of the changed records
pcSource CHARACTER
The source of the change (AppId/CtrlName, may be empty)
Top

AddCancel (character)
Purpose: Adds a cancellation result to the response
Notes: The RCD frontend treats the cancel result type as an
aborted operation (e.g. a delete the user did not confirm)

Parameters:
pcMessageText CHARACTER
The message text
Top

AddError (character)
Purpose: Adds an error message to the response
Notes: Error results cause the RCD web handler to respond with
HTTP status 400

Parameters:
pcMessageText CHARACTER
The error message text
Top

AddError (character, character)
Purpose: Adds an error message naming the control to highlight to
the response
Notes: Used for Business Entity validation errors that carry a
field name (DatasetHelper:AddErrorString) - the RCD
frontend highlights the control of that name

Parameters:
pcMessageText CHARACTER
The error message text
pcControlName CHARACTER
The name of the control (field) to highlight, may be empty
Top

AddError (Error)
Purpose: Adds the messages of the given error to the response
Notes: Only the error messages are transported - the ABL call
stack is never part of the response

Parameters:
poError Progress.Lang.Error
The error to add to the response
Top

AddInfo (character)
Purpose: Adds an informational message to the response
Notes:

Parameters:
pcMessageText CHARACTER
The message text
Top

AddNextRowId (character, character)
Purpose: Adds the paging continuation token to the response
Notes: The RCD frontend passes the token back as the NextRowId
parameter of the next GridData request

Parameters:
pcTableName CHARACTER
The name of the (database) table the token belongs to
pcContext CHARACTER
The paging context of the query
Top

AddResponseParameter (character, character)
Purpose: Adds an out-of-band response parameter to the response
Notes: Response parameters (e.g. path, tablename, recordcount and
the List-specific types) are published to the RCD web
handler through its Set-WebResponse-Param procedure when
the response dataset is created. Setting a parameter type
again overwrites the previous value

Parameters:
pcParameterType CHARACTER
The type of the response parameter (e.g. path, tablename, recordcount)
pcValue CHARACTER
The value of the response parameter
Top

AddResult (character, character)
Purpose: Adds a result row of the given type to the response
Notes:

Parameters:
pcResultType CHARACTER
The RetType value of the result (error/info/warning)
pcMessageText CHARACTER
The message text
Top

AddResults (handle)
Purpose: Adds the result rows of the given ttResult shaped buffer
to the response
Notes: Used to echo the inbound ttResult rows of a write request
back to the frontend (client-side validation short
circuit)

Parameters:
phResultBuffer HANDLE
The buffer of the ttResult shaped temp-table to copy the rows of
Top

AddRule (character, character, character, integer)
Purpose: Adds a UI rule to the response
Notes: Rules are executed by the RCD frontend rule engine the
moment the response is received

Parameters:
pcFieldName CHARACTER
The name of the target field/control of the rule
pcPropertyName CHARACTER
The name of the property to set (e.g. Value, Hidden, ReadOnly) or "Action"
pcPropertyValue CHARACTER
The value of the property (a JSON structure for actions)
piExecutionSeqNr INTEGER
The order in which the rules are executed by the frontend
Top

AddWarning (character)
Purpose: Adds a warning message to the response
Notes:

Parameters:
pcMessageText CHARACTER
The message text
Top

CloseCurrentProgram ()
Purpose: Requests closing the current program after the result
messages were shown
Notes: Sets the CloseCurrentProgramYN flag on a result row

Top

CreateActionRule (JsonObject, integer)
Purpose: Adds an action rule (frontend trigger) to the response
Notes: Action rules are not deduplicated - multiple actions are
allowed

Parameters:
poTrigger Progress.Json.ObjectModel.JsonObject
The trigger JSON (e.g. Trigger PORTAL/OpenProgram with arguments)
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateResponseDataset (handle, dataset-handle)
Purpose: Creates the response ProDataset with the given data buffer
followed by the response envelope (ttResult and ttRules)
Notes: The created dataset is fully dynamic and independent of
this instance and of the given data buffer

Parameters:
phDataBuffer HANDLE
The handle of the buffer holding the response data, ? when the response carries no data table
phDataset DATASET-HANDLE
OUTPUT The created response ProDataset
Top

CreateResponseDataset (handle[], dataset-handle)
Purpose: Creates the response ProDataset with the given data buffers
followed by the response envelope (ttResult and ttRules)
Notes: The created dataset is fully dynamic and independent of
this instance and of the given data buffers. Used for the
endpoint types whose response carries several data tables
(the portal structure endpoint, SCL-6043)

Parameters:
phDataBuffers HANDLE
The handles of the buffers holding the response data in table order (invalid handles are skipped)
phDataset DATASET-HANDLE
OUTPUT The created response ProDataset
Top

CreateResponseDataset (dataset-handle)
Purpose: Creates the response ProDataset with the response envelope
(ttResult and ttRules)
Notes: The created dataset is fully dynamic and independent of
this instance

Parameters:
phDataset DATASET-HANDLE
OUTPUT The created response ProDataset
Top

CreateRule (character, character, character, integer)
Purpose: Creates a rule setting a field or object property
Notes: Follows the reference semantics of the RCD rule engine:
a rule for the same field and property is updated instead
of duplicated; a rule that would set the value the
frontend already carries (per the loaded form state) is
suppressed; the cursor property allows a single rule only

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set (e.g. Value, Hidden, ReadOnly, Mandatory, Label)
pcValue CHARACTER
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, date, integer)
Purpose: Creates a rule setting a field or object property from a
date value
Notes: Marshalled as an ISO date (fConvDate2String convention)

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
pdaValue DATE
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, datetime, integer)
Purpose: Creates a rule setting a field or object property from a
datetime value
Notes: Marshalled as an ISO date (fConvDateTime2String convention)

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
pdtValue DATETIME
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, datetime-tz, integer)
Purpose: Creates a rule setting a field or object property from a
datetime-tz value
Notes: Marshalled as an ISO date (fConvDateTimeTz2String convention)

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
pdtValue DATETIME-TZ
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, decimal, integer)
Purpose: Creates a rule setting a field or object property from a
decimal value
Notes: Marshalled with a decimal point regardless of the session
numeric format (fConvDec2String convention)

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
pdeValue DECIMAL
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, integer, integer)
Purpose: Creates a rule setting a field or object property from an
integer value
Notes:

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
piValue INTEGER
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRule (character, character, logical, integer)
Purpose: Creates a rule setting a field or object property from a
logical value
Notes: Marshalled as true / false (JavaScript convention)

Parameters:
pcFieldName CHARACTER
The name of the target field or control
pcPropertyName CHARACTER
The property to set
plValue LOGICAL
The new property value
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRuleTarget (character, character, character, JsonArray, integer)
Purpose: Creates a rule writing a frontend data source
Notes: The action is normalized following the reference (Add,
Replace and New become set; Delete becomes clear; Update
becomes update)

Parameters:
pcAppId CHARACTER
The id of the app or PARENT
pcTarget CHARACTER
The name of the frontend data source
pcAction CHARACTER
The action (set, update or clear)
poData Progress.Json.ObjectModel.JsonArray
The data to write (JSON array of records) or ? to clear
piExecutionSeqNr INTEGER
The execution sequence, 0 for the next free sequence
Top

CreateRuleTargetTabText (character, character)
Purpose: Creates a rule updating the program tab text
Notes:

Parameters:
pcTextType CHARACTER
The tab text slot (AppText1 or AppText2)
pcValue CHARACTER
The new tab text
Top

FocusField (character)
Purpose: Creates a rule setting the cursor (focus) to the given
field
Notes: Only one cursor rule survives - the last one wins

Parameters:
pcFieldName CHARACTER
The name of the field to focus
Top

CHARACTER GetFieldProperty (character, character)
Purpose: Returns the value of a form field property
Notes: Returns the state sent by the frontend, overridden by a
rule already created for the field and property
(fGetFieldProperty reference semantics)

Parameters:
pcFieldName CHARACTER
The name of the field or control
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The property value or an empty value when unknown
Top

LoadFormFields (handle)
Purpose: Loads the form state sent by the frontend into the
response
Notes: Enables the no-change suppression of CreateRule and the
GetFieldProperty lookup. The given table must follow the
ttFormfields layout (FieldId, FieldName, PropertyName,
PropertyValue)

Parameters:
phTable HANDLE
The handle of the table carrying the form state
Top

CHARACTER MergeEntryList (character, character)
Purpose: Merges two comma-delimited lists without duplicates
Notes: Entries of the second list are appended to the first when
not already present

Parameters:
pcList CHARACTER
The base list
pcNewEntries CHARACTER
The entries to merge into the list
Returns CHARACTER
The merged list
Top

INTEGER NextSequence (integer)
Purpose: Returns the next execution sequence
Notes: A zero sequence is replaced with the highest sequence
below the cursor sequence 9999 plus one (reference
semantics)

Parameters:
piExecutionSeqNr INTEGER
The requested sequence or 0
Returns INTEGER
The execution sequence to use
Top

OpenApp (character, logical)
Purpose: Requests opening another app (PORTAL/OpenProgram)
Notes:

Parameters:
pcAppName CHARACTER
The name of the app to open
plModal LOGICAL
Open the app as a modal dialog
Top

OpenUrl (character)
Purpose: Requests opening a URL (PORTAL/OpenURL)
Notes:

Parameters:
pcUrl CHARACTER
The URL to open
Top

PublishResponseParameters ()
Purpose: Publishes the response parameters of this response to the
RCD web handler
Notes: The RCD web handler exposes the Set-WebResponse-Param
internal procedure through a session procedure (the RCD
super procedure). Outside an RCD web request - e.g. in a
unit test session - no such procedure exists and the
response parameters remain accessible through
ResponseParameterValue only

Top

CHARACTER ResponseParameterValue (character)
Purpose: Returns the value of the given response parameter
Notes: Returns the unknown value when the parameter has not been
added to the response

Parameters:
pcParameterType CHARACTER
The type of the response parameter
Returns CHARACTER
The value of the response parameter or the unknown value
Top

HANDLE ResultBuffer ()
Purpose: Returns the buffer of the result table
Notes: Supports assertions and refinements not covered by the
typed methods

Returns HANDLE
The buffer handle of the ttResult table
Top

HANDLE RulesBuffer ()
Purpose: Returns the buffer of the rules table
Notes: Supports assertions and refinements not covered by the
typed methods

Returns HANDLE
The buffer handle of the ttRules table


Property Detail
Top

CHARACTER DatasetName

Returns CHARACTER
Top

LOGICAL HasErrors

Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:23:23