project BLF > class Report Component > method GetTableCustomFields

Description

Defines the tables from which the end user can select the custom fields when running the report.
In this method, the temp-table tTableCustomField is filled in with records pointing to tables from which the report can expose the custom fields


Parameters


tTableCustomFieldoutputtemp-tabletcTableName
This is the name of the physical table, as it is known in the datamodel.
tcBusinessComponent
This is the short name of the business component that is owner of the table specified in tcTableName.
tcResultTable
This is the name of the result table as defined in the report dataset that will host the custom fields.
tcKeyFields
This is a "," separated list of fields of the result table (tcResultTable) that represent the values for the key field combination in the database table that holds the custom fields (tcTableName).
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


BLF
method BResource.GetReportCBF
method breport.GetSelectedCustomFields


program code (program3/breport.p)

/*Example:

create tTableCustomField.
assign tTableCustomField.tcTableName = 'item':U
       tTableCustomField.tcBusinessComponent = 'BItem':U
       tTableCustomField.tcResultTable = 'tqItemListReport':U
       tTableCustomField.tcKeyFields = 'tiItem_ID':U.*/


Sample code: how to call this method through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "breport".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "GetTableCustomFields".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.