OpenEdge.BusinessRules.DecisionService
- Last Updated: January 15, 2026
- 8 minute read
- OpenEdge
- Version 12.8
- Documentation
|
Method Summary
| Options | Name | Purpose | |
|---|---|---|---|
| CacheAppDataSchema (handle) |
/** Caches the schema of the input data structure for mapping response
data to the input data.
@param handle The input dataset */
|
||
| CreateOrFindRecord (character, character) |
/* release the previous one */
|
||
| DestroyComponent () |
|
||
| GetMessages (table) |
/** Returns the messages for the most recent decision service invocation.
Idempotent - a repeated call to this method will always return the same
data. The message data is only cleared when a new InvokeService call is
made. References in the RulesMessage table are to the response data
structure used in the InvokeService()} call, which may differ from the
input application data data structure. See the InvokeService
documentation for details.
@param output table The RulesMessage table as defined in
{OpenEdge/BusinessRules/ttRulesMessage.i} */
|
||
| Initialise () |
|
||
| InvokeService (dataset-handle) |
/** Invokes the decision service with the passed-in payload. Accepts a
ProDataSet handle for passing to the decision service. Expected
usage is that this method be called BY-REFERENCE for a shallow copy. The
contents of this ProDataSert are removed and replaced by the results of
the decision service call
@param input-output dataset-handle Dataset containing the business data
for processing by the decision service. */
|
||
| InvokeService (table-handle) |
/** Invokes the decision service with the passed-in payload. Accepts a table
handle for passing to the decision service. Expected usage is that this
method be called BY-REFERENCE for a shallow copy. The contents of this
temp-table are removed and replaced by the results of the decision
service call. The temp-table passed into this method can not be part of
a ProDataSet (an AppError is thrown if it is)
@param input-output table-handle The business data passed to and from the
decision service. */
|
||
| InvokeService (dataset-handle, dataset-handle) |
/** Protected 'worker' method that performs the service call.
This method must be called BY-REFERENCE for performance reasons. The params
are defined as DATASET-HANDLE for clarity/readability; they could just
as easily be HANDLEs.
@param dataset-handle Dataset containing the business applications data
@param dataset-handle (Empty) Dataset for the service response data */
|
||
| InvokeService (dataset-handle, dataset-handle) |
/** Invokes the decision service with the passed-in payload. Accepts a
ProDataSet handle for passing to the decision service. Expected usage is
that this method be called BY-REFERENCE for a shallow copy. The results
of the decision service call are returned in the output parameter, and
the input data is not updated at all.
The output dataset is a clone of the input dataset - the intent of this
API is to allow callers to use the input data as a before-image for
comparison purposes. References in the RulesMessage table returned by
the GetMessages() call are to tables in the response ProDataSet
(important if the reference key is a ROWID).
@param dataset-handle Dataset containing the input business data for
processing by the decision service
@param output dataset-handle Dataset containing the return/response business
data from the decision service. */
|
||
| InvokeService (table-handle, table-handle) |
/** Invokes the decision service with the passed-in payload. Accepts a table
handle for passing to the decision service. Expected usage is that this
method be called BY-REFERENCE for a shallow copy. The results of the
decision service call are returned in the output parameter, and the
input data is not updated at all. The temp-table passed into this method
can not be part of a ProDataSet (an AppError is thrown if it is).
The output table is a clone of the input table - the intent of this API
is to allow callers to use the input data as a before-image for comparison
purposes. References in the RulesMessage table returned by the
GetMessages() call are to the response table (important if the reference
key is a ROWID).
@param table-handle The business data to pass to the decision service.
@param output table-handle The result/response data of the decision
service. */
|
||
| LOGICAL IsServiceAvailable () |
/** Returns true if the current Decision Service is deployed.
@return logical Whether the decision service is deployed of not. */
|
||
| LoadResponseDocument (longchar, dataset-handle) |
/** Convert XML response into application data and (linked) Rule Messages
@param longchar An XML document containing the service response
@param dataset-handle The dataset into which to load the data from the
response document. */
|
||
| SaxReaderCharactersHandler (handle, longchar, integer) |
/** CHARACTERS event handler for the SAX-READER. Method implemented as per
ABL documentation. */
|
||
| SaxReaderEndElementHandler (handle, character, character, character) |
/** END-ELEMENT event handler for the SAX-READER. Method implemented as per
ABL documentation. */
|
||
| SaxReaderStartElementHandler (handle, character, character, character, handle) |
/** START-ELEMENT event handler for the SAX-READER. Method implemented as per
ABL documentation. */
|
||
| SetDataKeyValue (character) |
/** Updates the DataKeyValue and TableName fields in the RulesMessage buffer
from the application data.
@param character The value of the return messages' entityReference href
attribute, which contains the link to the application
data */
|
Constructor Summary
| Options | Name | Purpose | |
|---|---|---|---|
| DecisionService (RulesServerConnection, character) |
/* Details shown by the private constructor doc. */
|
||
| DecisionService (RulesServerConnection, character, datetime-tz) |
/* Details shown by the private constructor doc. */
|
||
| DecisionService (RulesServerConnection, character, decimal) |
/* Details shown by the private constructor doc. */
|
||
| DecisionService (RulesServerConnection, character, decimal, datetime-tz) |
/** Private constructor for this class. Used instead of a real constructor
since some transformations have to happen before its called, and since
a constructor must be invoked first via SUPER or THIS-OBJECT, there's
no room for those transformations.
@param RulesServerConnection (mandatory) The server connection to use
@param character (mandatory) The name of the decision service
@param decimal The version of the decision service to use.
@param datetime-tz The effective date with which which to select the
decision service to use. */
|
Property Summary
| Options | Name | Purpose | |
|---|---|---|---|
| DATETIME-TZ EffectiveOn |
|
||
| CHARACTER Name |
|
||
| OpenEdge.BusinessRules.RulesServerConnection ServerConnection |
|
||
| DECIMAL Version |
|
Method Detail
CacheAppDataSchema (handle)
|
||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreateOrFindRecord (character, character)
|
||||||||||||||||||||||||||||||||||||||
DestroyComponent () |
||||||||||||||||||||||||||||||||||||||
GetMessages (table)
|
||||||||||||||||||||||||||||||||||||||
Initialise () |
||||||||||||||||||||||||||||||||||||||
InvokeService (dataset-handle)
|
||||||||||||||||||||||||||||||||||||||
InvokeService (table-handle)
|
||||||||||||||||||||||||||||||||||||||
InvokeService (dataset-handle, dataset-handle)
|
||||||||||||||||||||||||||||||||||||||
InvokeService (dataset-handle, dataset-handle)
|
||||||||||||||||||||||||||||||||||||||
InvokeService (table-handle, table-handle)
|
||||||||||||||||||||||||||||||||||||||
LOGICAL IsServiceAvailable ()
|
||||||||||||||||||||||||||||||||||||||
LoadResponseDocument (longchar, dataset-handle)
|
||||||||||||||||||||||||||||||||||||||
SaxReaderCharactersHandler (handle, longchar, integer)
|
||||||||||||||||||||||||||||||||||||||
SaxReaderEndElementHandler (handle, character, character, character)
|
||||||||||||||||||||||||||||||||||||||
SaxReaderStartElementHandler (handle, character, character, character, handle)
|
||||||||||||||||||||||||||||||||||||||
SetDataKeyValue (character)
|
||||||||||||||||||||||||||||||||||||||
Constructor Detail
DecisionService (RulesServerConnection, character)
|
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DecisionService (RulesServerConnection, character, datetime-tz)
|
||||||||||||||||||||||||||||||||
DecisionService (RulesServerConnection, character, decimal)
|
||||||||||||||||||||||||||||||||
DecisionService (RulesServerConnection, character, decimal, datetime-tz)
|
||||||||||||||||||||||||||||||||
Property Detail
DATETIME-TZ EffectiveOn
|
||||||||
|---|---|---|---|---|---|---|---|---|
CHARACTER Name
|
||||||||
OpenEdge.BusinessRules.RulesServerConnection ServerConnection |
||||||||
DECIMAL Version
|
||||||||