project BLF > class Report Component > method GetBusinessFields

Description

Returns a full description of all business fields of a business class, browse or report.


Parameters


icReferenceinputcharacter- <classname> for receiving business field information of a business class
- <classname>.<methodname> for receiving business field information of a browse or report
tBusinessFieldsoutputtemp-table
tCustomRelationoutputtemp-table
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


BLF
method BResource.GetReportCBF
method breport.GetReportLabels


program code (program/breport.p)

<ANCESTOR-CODE>

for each businessFields where
         businessFields.tcFcFieldType = "F":U and
         num-entries(businessFields.tcFcFieldName,".":U) = 2
         break by entry(1,businessFields.tcFcFieldName,".":U) on error undo, throw:
    if first-of(entry(1,businessFields.tcFcFieldName,".":U))
    then do:
        <Q-2 run GetCustomFieldsForTable (all) (Read) (Cache)
          (input entry(1,businessFields.tcFcFieldName,'.':U), (TableName)
           output dataset tqCustomFieldsForTable) in BCustomField >

        for each tqCustomFieldsForTable on error undo, throw:

            vcValueList = "".
            if tqCustomFieldsForTable.tcCustomFieldUIControlType = "ComboBox":U
            then do:
                <Q-4 run CustomFieldValues (all) (Read) (NoCache)
          (input tqCustomFieldsForTable.tcCustomFieldFieldName, (BusinessFieldName)
           input '', (Value)
           output dataset tqCustomFieldValues) in BCustomField >
                for each tqCustomFieldValues by tqCustomFieldValues.tiCustomValueSequence:
                    vcValueList = vcValueList + chr(2) + tqCustomFieldValues.tcCustomValueCode
                                              + chr(2) + tqCustomFieldValues.tcCustomValueCode.
                end.
                vcValueList = substring (vcValueList,2,-1,"CHARACTER":U).
            end.

            if not vlObjectTranslationsActive
            then do:
                /*
                <M-95 run GetTranslationForObject
                   (input  novalue (iiObjectID), 
                    input  novalue (icLanguageCode), 
                    input  'Show Usage' (icOriginal), 
                    input  novalue (icFieldName), 
                    output novalue (ocTranslation), 
                    output novalue (oiReturnStatus)) in ComponentPool>
                */
                run GetTranslationForObject 
                   (input  tqCustomFieldsForTable.tiCustomField_ID,
                    input  current-language,
                    input  "",
                    input "",
                    output vcTranslation,
                    output oiReturnStatus).
                if oiReturnStatus <> 0
                then return.
                
                if lookup ("CustomFieldSideLabel",vcTranslation,"|") > 0
                then if entry (lookup("CustomFieldSideLabel",vcTranslation,"|") + 1,vcTranslation,"|") <> ""
                then tqCustomFieldsForTable.tcCustomFieldSideLabel = entry (lookup("CustomFieldSideLabel",vcTranslation,"|") + 1,vcTranslation,"|").
                
                if lookup ("CustomFieldColumnLabel",vcTranslation,"|") > 0
                then if entry (lookup("CustomFieldColumnLabel",vcTranslation,"|") + 1,vcTranslation,"|") <> ""
                then tqCustomFieldsForTable.tcCustomFieldColumnLabel = entry (lookup("CustomFieldColumnLabel",vcTranslation,"|") + 1,vcTranslation,"|").
            end.
            
            create tBusinessFields.
            assign tBusinessFields.tcFcFieldName    = tqCustomFieldsForTable.tcCustomFieldFieldName
                   tBusinessFields.tcSideLabel      = tqCustomFieldsForTable.tcCustomFieldSideLabel
                   tBusinessFields.tcColumnLabel    = tqCustomFieldsForTable.tcCustomFieldColumnLabel
                   tBusinessFields.tcFcFieldType    = businessFields.tcFcFieldType
                   tBusinessFields.tcFcDescription  = tqCustomFieldsForTable.tcCustomFieldDescription
                   tBusinessFields.tcDataType       = tqCustomFieldsForTable.tcCustomFieldDataType
                   tBusinessFields.tcDisplayFormat  = tqCustomFieldsForTable.tcCustomFieldDisplayFormat
                   tBusinessFields.tcControlType    = tqCustomFieldsForTable.tcCustomFieldUIControlType
                   tBusinessFields.tiStoredSearch_ID = tqCustomFieldsForTable.tiStoredSearch_ID
                   tBusinessFields.tcValueList      = vcValueList.

            if businessFields.tcFcFieldType = "F":U
            then do:
                find first tBusinessFields where tBusinessFields.tcFcFieldType = "B":U.
                vcTable = entry (1,tBusinessFields.tcFcFieldName,".":U).

                create tBusinessFields.
                assign tBusinessFields.tcFcFieldName    = vcTable + ".":U + replace(substring(tqCustomFieldsForTable.tcCustomFieldFieldName,2,-1,"CHARACTER":U),".":U,"_":U)
                       tBusinessFields.tcSideLabel      = tqCustomFieldsForTable.tcCustomFieldSideLabel
                       tBusinessFields.tcColumnLabel    = tqCustomFieldsForTable.tcCustomFieldColumnLabel
                       tBusinessFields.tcFcFieldType    = "C":U
                       tBusinessFields.tcFcDescription  = tqCustomFieldsForTable.tcCustomFieldDescription
                       tBusinessFields.tcDataType       = tqCustomFieldsForTable.tcCustomFieldDataType
                       tBusinessFields.tcDisplayFormat  = tqCustomFieldsForTable.tcCustomFieldDisplayFormat
                       tBusinessFields.tcControlType    = tqCustomFieldsForTable.tcCustomFieldUIControlType
                       tBusinessFields.tiStoredSearch_ID = tqCustomFieldsForTable.tiStoredSearch_ID
                       tBusinessFields.tcValueList      = vcValueList.
            end.
        end.
    end.
end.


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 = "GetBusinessFields".
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.