Namespace: Consultingwerk.Integrations.BuildOne.Swat
Class 
SwatService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DataServiceInterface.AbstractDataService
Consultingwerk.Integrations.BuildOne.Swat.SwatService

Inherits: Consultingwerk.OERA.DataServiceInterface.AbstractDataService


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



Top Method Summary
Options Name Purpose
AddSortField (character, character, handle, character, character) Validates a sort field and direction and adds them to the lists of sort fields and directions
ApplyFieldList (JsonObject, character) Removes all fields not contained in the given field list from the serialized dataset rows
Progress.Json.ObjectModel.JsonObject BuildDatasetErrorResponse (handle) Builds the Build.One SWAT error response envelope from the validation errors of the given dataset
Progress.Json.ObjectModel.JsonObject BuildErrorResponse (Error) Builds the Build.One SWAT error response envelope for the given error
CollectBufferErrors (handle, JsonArray) Collects the ERROR-STRING values of all rows of the given buffer into the messages array
DeactivateUnrequestedParentRelations (handle, character) Deactivates the data-relations of the given dataset whose child buffer was requested while the parent buffer was not
CHARACTER DefaultOrderBy (handle, character) Returns the default order-by phrase (without the BY keyword) for the given buffer, based on its unique key fields
EnsureTableArrays (JsonObject, handle) Ensures that the serialized dataset carries an (empty) array for every dataset table
EnsureTableArrays (JsonObject, handle, character) Ensures that the serialized dataset carries an (empty) array for every requested dataset table
Progress.Json.ObjectModel.JsonObject Fetch (JsonObject) Processes a Build.One SWAT fetch request (query interface)
Progress.Json.ObjectModel.JsonObject GetObjectProperty (JsonObject, character) Returns the value of an optional object property of a request
CHARACTER GetOrderByProperty (JsonObject) Returns the value of the orderBy property of a fetch request
CHARACTER GetRequestTables (JsonObject, handle, character) Returns the comma-delimited list of buffer names requested through the tableRef and viewTables properties of a fetch request
CHARACTER GetSortDirection (JsonObject, character, integer) Returns the sort direction of an akQuery.sort entry
Progress.Json.ObjectModel.JsonArray GetSortProperty (JsonObject) Returns the akQuery.sort array of a fetch request
Progress.Json.ObjectModel.JsonObject Invoke (JsonObject) Processes a Build.One SWAT invoke request (calls a published method of a Business Entity or Business Task)
CHARACTER OrderByFromRequest (JsonObject, handle, character) Returns the order-by phrase (without the BY keyword) for the queried table of a fetch request
ParseOrderBy (character, handle, character, character) Parses the orderBy string of a fetch request
ParseSort (JsonArray, handle, character, character) Parses the akQuery.sort array of a fetch request
CHARACTER PrepareRequest (JsonObject) Assigns the AccessToken property from the request payload and returns the validated entityName property
Progress.Json.ObjectModel.JsonObject Update (JsonObject) Processes a Build.One SWAT update request (creates, updates and deletes)
WriteDatasetToJson (JsonObject, handle, logical) Adds the given dataset to the datasets JsonObject of an invoke result

Top Property Summary
Options Name Purpose
CHARACTER AccessToken


Method Detail
Top

AddSortField (character, character, handle, character, character)
Purpose: Validates a sort field and direction and adds them to the
lists of sort fields and directions
Notes: SCL-6102. The field name is resolved against the buffer
(serialize-names are supported), the direction defaults to asc

Parameters:
pcField CHARACTER
The field name from the request
pcDirection CHARACTER
The sort direction from the request (asc, desc or empty)
phBuffer HANDLE
The buffer handle of the queried table
pcFields CHARACTER
INPUT-OUTPUT The comma-delimited list of sort fields
pcDirections CHARACTER
INPUT-OUTPUT The comma-delimited list of sort directions (asc, desc)
Top

ApplyFieldList (JsonObject, character)
Purpose: Removes all fields not contained in the given field list from
the serialized dataset rows
Notes: The generic id and seq fields are always kept, as they carry
the record identity for the Build.One SWAT frontend

Parameters:
poData Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized dataset
pcFieldList CHARACTER
The comma-delimited list of fields to keep
Top

Progress.Json.ObjectModel.JsonObject BuildDatasetErrorResponse (handle)
Purpose: Builds the Build.One SWAT error response envelope from the
validation errors of the given dataset
Notes: Collects the ERROR-STRING values of the after- and before-image
rows of every dataset table. Validation messages carry the
affected field and table name when available (as registered by
DatasetHelper:AddErrorString) AddErrorString)

Parameters:
phDataset HANDLE
The handle of the dataset carrying validation errors
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the error response envelope
Top

Progress.Json.ObjectModel.JsonObject BuildErrorResponse (Error)
Purpose: Builds the Build.One SWAT error response envelope for the
given error
Notes: The error structure is returned instead of the data property:
success = false, error with message, type and messages array

Parameters:
poError Progress.Lang.Error
The error to build the response envelope for
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the error response envelope
Top

CollectBufferErrors (handle, JsonArray)
Purpose: Collects the ERROR-STRING values of all rows of the given
buffer into the messages array
Notes: Multiple error strings per row are separated by CHR(3); a
single error string entry optionally consists of the message,
the field name and the buffer name separated by CHR(4) (see
DatasetHelper:AddErrorString) AddErrorString)

Parameters:
phBuffer HANDLE
The buffer (after- or before-image) to collect the errors of
poMessages Progress.Json.ObjectModel.JsonArray
The JsonArray to add the error messages to
Top

DeactivateUnrequestedParentRelations (handle, character)
Purpose: Deactivates the data-relations of the given dataset whose child
buffer was requested while the parent buffer was not
Notes: SCL-6072. WRITE-JSON writes the child rows of an active NESTED
relation into their parent rows only - when only the child table
is requested, the parent table is empty and the child rows
would be missing in the response

Parameters:
phDataset HANDLE
The handle of the dataset to serialize
pcTables CHARACTER
The comma-delimited list of the requested buffer names
Top

CHARACTER DefaultOrderBy (handle, character)
Purpose: Returns the default order-by phrase (without the BY keyword)
for the given buffer, based on its unique key fields
Notes: A deterministic sort order is required for the stateless
skip/top paging of the Build.One SWAT frontend

Parameters:
phBuffer HANDLE
The buffer handle of the primary table
pcBufferName CHARACTER
The name of the primary table buffer
Returns CHARACTER
The order-by phrase or an empty string when the buffer has no unique key
Top

EnsureTableArrays (JsonObject, handle)
Purpose: Ensures that the serialized dataset carries an (empty) array
for every dataset table
Notes: WRITE-JSON omits tables without records - the Build.One SWAT
frontend however expects the table array to be present in
every response (e.g. an empty batch or the response of a
delete operation)

Parameters:
poData Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized dataset
phDataset HANDLE
The handle of the serialized dataset
Top

EnsureTableArrays (JsonObject, handle, character)
Purpose: Ensures that the serialized dataset carries an (empty) array
for every requested dataset table
Notes: SCL-6072. WRITE-JSON omits tables without records - the
Build.One SWAT frontend however expects the table array to be
present in every response. Tables that were not requested are
not added. WRITE-JSON writes the SERIALIZE-NAME of the dataset
and its tables

Parameters:
poData Progress.Json.ObjectModel.JsonObject
The JsonObject with the serialized dataset
phDataset HANDLE
The handle of the serialized dataset
pcTables CHARACTER
The comma-delimited list of the requested buffer names (empty for all tables)
Top

Progress.Json.ObjectModel.JsonObject Fetch (JsonObject)
Purpose: Processes a Build.One SWAT fetch request (query interface)
Notes: Expected request properties: accessToken, entityName, akQuery
(fieldlist, filters), skip, top and the optional tableRef and
viewTables (SCL-6072). The optional sort order is passed either
as the orderBy string or as the akQuery.sort array (SCL-6102).
Returns the success envelope with the data property containing
the serialized ProDataset

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT fetch request
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response envelope
Top

Progress.Json.ObjectModel.JsonObject GetObjectProperty (JsonObject, character)
Purpose: Returns the value of an optional object property of a request
Notes: SCL-6114. Returns ? (unknown value) when the property is missing
or null

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT request
pcProperty CHARACTER
The name of the property
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject value of the property or ?
Top

CHARACTER GetOrderByProperty (JsonObject)
Purpose: Returns the value of the orderBy property of a fetch request
Notes: SCL-6102. Returns an empty string when the property is missing,
null or blank

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT fetch request
Returns CHARACTER
The trimmed value of the orderBy property
Top

CHARACTER GetRequestTables (JsonObject, handle, character)
Purpose: Returns the comma-delimited list of buffer names requested
through the tableRef and viewTables properties of a fetch
request
Notes: SCL-6072. Names and semantics follow the JSON Filter Parameter
of the JSDO Generic Service: tableRef is the table the request
is for (filters, sort order, top and skip apply to it),
viewTables an optional comma-delimited list of further tables
to return. Both refer to the SERIALIZE-NAME of the tables.
Returns an empty string when the request has no tableRef (all
tables are fetched then)

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT fetch request
phDataset HANDLE
The handle of the dataset (schema) of the Business Entity
pcEntityName CHARACTER
The name of the Business Entity (for the error message)
Returns CHARACTER
The comma-delimited list of buffer names, the tableRef buffer first
Top

CHARACTER GetSortDirection (JsonObject, character, integer)
Purpose: Returns the sort direction of an akQuery.sort entry
Notes: SCL-6102. Returns an empty string when the property is missing
or null

Parameters:
poEntry Progress.Json.ObjectModel.JsonObject
The JsonObject with the sort descriptor
pcProperty CHARACTER
The name of the direction property (direction, dir)
piEntry INTEGER
The position of the entry in the akQuery.sort array (for the error message)
Returns CHARACTER
The value of the direction property
Top

Progress.Json.ObjectModel.JsonArray GetSortProperty (JsonObject)
Purpose: Returns the akQuery.sort array of a fetch request
Notes: SCL-6102. Returns ? (unknown value) when the property is
missing, null or an empty array

Parameters:
poAkQuery Progress.Json.ObjectModel.JsonObject
The akQuery JsonObject of the Build.One SWAT fetch request
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray with the sort descriptors or ?
Top

Progress.Json.ObjectModel.JsonObject Invoke (JsonObject)
Purpose: Processes a Build.One SWAT invoke request (calls a published
method of a Business Entity or Business Task)
Notes: SCL-6114. Expected request properties: accessToken, entityName
(the name of the Business Entity or Business Task), methodName
and the optional parameter (the JSON of the parameter object)
and datasets (one property per input dataset, named after the
SERIALIZE-NAME of the dataset). Only methods published with the
@InvokeMethod annotation (Business Entities) or through
IBusinessTaskCatalogInfo (Business Tasks) can be invoked. The
data property of the response carries the parameter and the
datasets property

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT invoke request
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response envelope
Top

CHARACTER OrderByFromRequest (JsonObject, handle, character)
Purpose: Returns the order-by phrase (without the BY keyword) for the
queried table of a fetch request
Notes: SCL-6102. The sort order is specified either by the orderBy
string (comma-delimited, "Field [asc|desc]") or by the
akQuery.sort array ({ "field": ..., "direction": ... }), never
by both. The unique key fields are always appended as the
tie-breaker, so the stateless skip/top paging stays
deterministic. Without a sort order the DefaultOrderBy is
returned

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT fetch request
phBuffer HANDLE
The buffer handle of the queried table
pcBufferName CHARACTER
The name of the queried table buffer
Returns CHARACTER
The order-by phrase or an empty string
Top

ParseOrderBy (character, handle, character, character)
Purpose: Parses the orderBy string of a fetch request
Notes: SCL-6102. A comma-delimited list of entries "Field [asc|desc]",
the direction defaults to asc

Parameters:
pcOrderBy CHARACTER
The value of the orderBy property
phBuffer HANDLE
The buffer handle of the queried table
pcFields CHARACTER
INPUT-OUTPUT The comma-delimited list of sort fields
pcDirections CHARACTER
INPUT-OUTPUT The comma-delimited list of sort directions (asc, desc)
Top

ParseSort (JsonArray, handle, character, character)
Purpose: Parses the akQuery.sort array of a fetch request
Notes: SCL-6102. Every entry is an object with the field and the
optional direction property (asc, desc - default asc); dir is
accepted as an alias of direction

Parameters:
poSort Progress.Json.ObjectModel.JsonArray
The JsonArray with the sort descriptors
phBuffer HANDLE
The buffer handle of the queried table
pcFields CHARACTER
INPUT-OUTPUT The comma-delimited list of sort fields
pcDirections CHARACTER
INPUT-OUTPUT The comma-delimited list of sort directions (asc, desc)
Top

CHARACTER PrepareRequest (JsonObject)
Purpose: Assigns the AccessToken property from the request payload and
returns the validated entityName property
Notes: Shared by the Fetch, Update and Invoke methods

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT request
Returns CHARACTER
The name of the Business Entity from the request
Top

Progress.Json.ObjectModel.JsonObject Update (JsonObject)
Purpose: Processes a Build.One SWAT update request (creates, updates
and deletes)
Notes: Expected request properties: accessToken, entityName, record
(the serialized ProDataset with the before-image
representation). The operation per row is derived from the
prods:rowState rowState / prods:before annotations. On success the
response mirrors the fetch envelope with the saved rows
(including trigger- or backend-assigned values); Business
Entity validation errors yield the error response envelope

Parameters:
poRequest Progress.Json.ObjectModel.JsonObject
The JsonObject with the Build.One SWAT update request
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject with the response envelope
Top

WriteDatasetToJson (JsonObject, handle, logical)
Purpose: Adds the given dataset to the datasets JsonObject of an invoke
result
Notes: SCL-6114. Adds an (empty) array for every table without
records, as in the fetch and update responses

Parameters:
poDatasets Progress.Json.ObjectModel.JsonObject
The JsonObject with the output datasets
phDataset HANDLE
The handle of the dataset to serialize
plWriteBeforeImage LOGICAL
Logical value indicating if the before-image representation is written


Property Detail
Top

CHARACTER AccessToken

Returns CHARACTER


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