Top Method Summary
Options Name Purpose
Progress.Json.ObjectModel.JsonArray GetConnectedDatabases () Returns a JSON array with the logical names of all connected databases Notes : Uses num-dbs and ldbname() @return JsonArray containing the connected database names */
Progress.Json.ObjectModel.JsonArray GetDatabaseRelations (character) Returns SmartRelation records related to a database table Notes : Loads SmartRelation records where ParentTableName or ChildTableName matches the full table name (Database.Table) @param pcFullTableName The full table name in the format DatabaseName.TableName @return JsonArray containing relation metadata objects */
Progress.Json.ObjectModel.JsonObject GetDatabaseTableDetails (character, character) Returns details about a database table (fields and indexes)
Progress.Json.ObjectModel.JsonArray GetDatabaseTables (character) Returns a JSON array with details about all non-hidden tables of a connected database Notes : The result includes the frameworks view on the table (TableDatasetModel) as a nested "smartTable" object @param pcDatabaseName The logical database name @return JsonArray containing one JsonObject per table */
Progress.Json.ObjectModel.JsonArray GetFieldDetails (handle) Builds field metadata for a buffer Notes : Returns one JsonObject per field including name, label, dataType and optional extent @param hBuffer The buffer handle for the database table @return JsonArray containing field metadata objects */
Progress.Json.ObjectModel.JsonArray GetIndexDetails (handle) Builds index metadata for a buffer Notes : Returns one JsonObject per index including name, fields and index flags @param hBuffer The buffer handle for the database table @return JsonArray containing index metadata objects */
Progress.Json.ObjectModel.JsonObject GetTableSummary (character, character, character, TableDatasetModel) Builds the summary of a database table: the identity of the table, the database description, the effective key fields and the SmartTable registration Notes : Positions the TableDatasetModel on the SmartTable record of the table. The "KeyFields" property is the UniqueKeyFields of the SmartTable record when available, and the fields of the primary (or first) unique index of the database table otherwise @param pcDatabaseName The logical database name @param pcTableName The database table name @param pcDescription The description of the table from the database schema (_File._Desc) @param poTableDatasetModel The TableDatasetModel to read the SmartTable record with @return JsonObject describing the table */
Progress.Json.ObjectModel.JsonArray SearchDatabaseTables (character) Searches for database tables across all connected databases Notes : A table is included when its name or description matches the filter, or when the framework description matches @param pcFilter Filter text used in a MATCHES pattern @return JsonArray containing one JsonObject per matching table */


Method Detail
Top

Progress.Json.ObjectModel.JsonArray GetConnectedDatabases ()

Purpose: Returns a JSON array with the logical names of all connected databases
Notes : Uses num-dbs and ldbname()

Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing the connected database names
Top

Progress.Json.ObjectModel.JsonArray GetDatabaseRelations (character)

Purpose: Returns SmartRelation records related to a database table
Notes : Loads SmartRelation records where ParentTableName or ChildTableName matches the full table name (Database.Table)

Parameters:
pcFullTableName CHARACTER
The full table name in the format DatabaseName.TableName
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing relation metadata objects
Top

Progress.Json.ObjectModel.JsonObject GetDatabaseTableDetails (character, character)

Purpose: Returns details about a database table (fields and indexes)
Notes: Includes the complete SmartTable registration ("smartTable") and the
SmartRelation records of the table ("databaseRelation")

Parameters:
pcDatabaseName CHARACTER
The logical database name
pcTableName CHARACTER
The database table name
Returns Progress.Json.ObjectModel.JsonObject
JsonObject containing a "fields" and "indexes" JsonArray
Top

Progress.Json.ObjectModel.JsonArray GetDatabaseTables (character)

Purpose: Returns a JSON array with details about all non-hidden tables of a connected database
Notes : The result includes the frameworks view on the table (TableDatasetModel) as a
nested "smartTable" object

Parameters:
pcDatabaseName CHARACTER
The logical database name
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing one JsonObject per table
Top

Progress.Json.ObjectModel.JsonArray GetFieldDetails (handle)

Purpose: Builds field metadata for a buffer
Notes : Returns one JsonObject per field including name, label, dataType and optional extent

Parameters:
hBuffer HANDLE
The buffer handle for the database table
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing field metadata objects
Top

Progress.Json.ObjectModel.JsonArray GetIndexDetails (handle)

Purpose: Builds index metadata for a buffer
Notes : Returns one JsonObject per index including name, fields and index flags

Parameters:
hBuffer HANDLE
The buffer handle for the database table
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing index metadata objects
Top

Progress.Json.ObjectModel.JsonObject GetTableSummary (character, character, character, TableDatasetModel)

Purpose: Builds the summary of a database table: the identity of the table, the
database description, the effective key fields and the SmartTable
registration
Notes : Positions the TableDatasetModel on the SmartTable record of the table.
The "KeyFields" property is the UniqueKeyFields of the SmartTable record
when available, and the fields of the primary (or first) unique index
of the database table otherwise

Parameters:
pcDatabaseName CHARACTER
The logical database name
pcTableName CHARACTER
The database table name
pcDescription CHARACTER
The description of the table from the database schema (_File._Desc)
poTableDatasetModel Consultingwerk.SmartFramework.System.TableDatasetModel
The TableDatasetModel to read the SmartTable record with
Returns Progress.Json.ObjectModel.JsonObject
JsonObject describing the table
Top

Progress.Json.ObjectModel.JsonArray SearchDatabaseTables (character)

Purpose: Searches for database tables across all connected databases
Notes : A table is included when its name or description matches the filter, or when the framework description matches

Parameters:
pcFilter CHARACTER
Filter text used in a MATCHES pattern
Returns Progress.Json.ObjectModel.JsonArray
JsonArray containing one JsonObject per matching table


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