project QadFinancials > class BCInvoice > 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


unused


program code (program/bcinvoice.p)

<ANCESTOR-CODE>
if icReference = "CostAllocation":U
then do:
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-2'Currency Code':20(1002)t-2#)
           tBusinessFields.tcColumnLabel    = trim (#T-3'Curr':10(1003)t-3#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcCurrencyCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(3)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-4'Cur Number of Decimals':40(1004)T-4#)
           tBusinessFields.tcColumnLabel    = trim (#T-5'Cur No Decs':30(1005)T-5#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tiCurrencyNumberOfDecimals":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "i":U
           tBusinessFields.tcDisplayFormat  = "->,>>>,>>9":U
           tBusinessFields.tcControlType    = "NumericInt":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-6'Sub-Account Code':25(1006)T-6#)
           tBusinessFields.tcColumnLabel    = trim (#T-7'Sub-Acct':20(1007)T-7#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcDivisionCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-8'Sub-Acct Description':20(1008)T-8#)
           tBusinessFields.tcColumnLabel    = trim (#T-9'Sub-Acct Desc':40(1009)T-9#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcDivisionDescription":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(40)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-10'GL Account':20(1010)T-10#)
           tBusinessFields.tcColumnLabel    = trim (#T-11'GL Account':15(1011)T-11#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcGLCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel         = trim (#T-12'GL Account':20(1010)T-12#)
           tBusinessFields.tcColumnLabel       = trim (#T-13'GL Account':20(1010)T-13#)
           tBusinessFields.tcFcFieldName       = "GLCode":U
           tBusinessFields.tcFcFieldType       = "F":U
           tBusinessFields.tcDataType          = "c":U
           tBusinessFields.tcDisplayFormat     = "x(20)":U
           tBusinessFields.tcControlType       = "TextBox":U
           tBusinessFields.tcFcDescription     = "":U
           tBusinessFields.tcLookupQuery       = "BGLSAO.SelectGL":U
           tBusinessFields.tcLookupReturnField = "tqSelectGL.tcGLCode":U
           tBusinessFields.tcLookupFilterField = "tGL.GLCode":U.  
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-14'GL Description':40(1012)t-14#)
           tBusinessFields.tcColumnLabel    = trim (#T-15'GL Description':40(1012)t-15#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcGLDescription":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(40)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-16'GL Active':20(1013)t-16#)
           tBusinessFields.tcColumnLabel    = trim (#T-17'GL Active':20(1013)t-17#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsActive":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-18'Automatic GL Account':40(1014)T-18#)
           tBusinessFields.tcColumnLabel    = trim (#T-19'GL Auto':20(1015)T-19#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsAutomaticAccount":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-20'GL Balance Account':40(1016)t-20#)
           tBusinessFields.tcColumnLabel    = trim (#T-21'GL Balance':20(1017)T-21#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsBalanceAccount":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-22'GL Sub-Account':40(1018)T-22#)
           tBusinessFields.tcColumnLabel    = trim (#T-23'GL Sub-Acct':22(1019)T-23#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsDivisionAccount":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-24'GL Intercompany Account':40(1020)T-24#)
           tBusinessFields.tcColumnLabel    = trim (#T-25'GL Intercompany':30(1021)T-25#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsIntercoAccount":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.

        
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-26'GL Base Currency':40(1022)T-26#)
           tBusinessFields.tcColumnLabel    = trim (#T-27'GL Base Currency':30(1023)T-27#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tlGLIsLocalCurrency":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "l":U
           tBusinessFields.tcDisplayFormat  = "yes/no":U
           tBusinessFields.tcControlType    = "Bool":U
           tBusinessFields.tcFcDescription  = "":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-28'GL Type':20(1024)t-28#)
           tBusinessFields.tcColumnLabel    = trim (#T-29'GL Type':20(1024)t-29#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcGLTypeCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-30'Daybook Code':30(1025)T-30#)
           tBusinessFields.tcColumnLabel    = trim (#T-31'Daybook':20(246)T-31#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcJournalCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-32'Daybook Description':40(1026)T-32#)
           tBusinessFields.tcColumnLabel    = trim (#T-33'Daybook Description':30(1027)T-33#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcJournalDescription":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(40)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-34'Daybook Type':40(1028)T-34#)
           tBusinessFields.tcColumnLabel    = trim (#T-35'Daybook Type':30(1029)T-35#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcJournalTypeCode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.

        
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-36'Layer Code':30(1030)t-36#)
           tBusinessFields.tcColumnLabel    = trim (#T-37'Layer Code':20(1031)t-37#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcLayercode":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-38'GL Period':30(1032)T-38#)
           tBusinessFields.tcColumnLabel    = trim (#T-39'GL Pd':10(1033)T-39#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tiPeriodPeriod":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "i":U
           tBusinessFields.tcDisplayFormat  = "99":U
           tBusinessFields.tcControlType    = "NumericInt":U
           tBusinessFields.tcFcDescription  = "":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-40'Period Status':30(1034)t-40#)
           tBusinessFields.tcColumnLabel    = trim (#T-41'Period Status':30(1034)t-41#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcPeriodStatus":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(20)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-42'GL Calendar Year':30(1035)T-42#)
           tBusinessFields.tcColumnLabel    = trim (#T-43'GL Cal Year':20(173)T-43#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tiPeriodYear":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "i":U
           tBusinessFields.tcDisplayFormat  = "9999":U
           tBusinessFields.tcControlType    = "NumericInt":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-44'Business Relation (IC Posting)':50(1036)T-44#)
           tBusinessFields.tcColumnLabel    = trim (#T-45'Bus Rel (IC Posting)':50(1037)T-45#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcPostingBusinessRelationText":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(40)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.

        
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-46'Posting Date':30(1038)t-46#)
           tBusinessFields.tcColumnLabel    = trim (#T-47'Posting Date':30(1038)t-47#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.ttPostingDate":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "t":U
           tBusinessFields.tcDisplayFormat  = "99/99/9999":U
           tBusinessFields.tcControlType    = "DateTime":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-48'External Invoice Reference':55(1039)t-48#)
           tBusinessFields.tcColumnLabel    = trim (#T-49'External Inv Ref':50(1040)T-49#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tcPostingInvoiceReferenceText":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "c":U
           tBusinessFields.tcDisplayFormat  = "x(40)":U
           tBusinessFields.tcControlType    = "TextBox":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-50'SC Credit':20(1041)t-50#)
           tBusinessFields.tcColumnLabel    = trim (#T-51'SC Credit':20(1041)t-51#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineCreditCC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-52'BC Credit':20(1042)T-52#)
           tBusinessFields.tcColumnLabel    = trim (#T-53'BC Credit':20(1042)T-53#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineCreditLC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-54'TC Credit':20(1043)T-54#)
           tBusinessFields.tcColumnLabel    = trim (#T-55'TC Credit':20(1043)T-55#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineCreditTC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.

    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-56'SC Debit':20(1044)t-56#)
           tBusinessFields.tcColumnLabel    = trim (#T-57'SC Debit':20(1044)t-57#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineDebitCC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-58'BC Debit':20(1045)T-58#)
           tBusinessFields.tcColumnLabel    = trim (#T-59'BC Debit':20(1045)T-59#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineDebitLC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-60'TC Debit':20(1046)T-60#)
           tBusinessFields.tcColumnLabel    = trim (#T-61'TC Debit':20(1046)T-61#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineDebitTC":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.
    
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel      = trim (#T-62'Quantity':20(1047)t-62#)
           tBusinessFields.tcColumnLabel    = trim (#T-63'Quantity':20(1047)t-63#)
           tBusinessFields.tcFcFieldName    = "tqCostAllocation.tdPostingLineQTY":U
           tBusinessFields.tcFcFieldType    = "B":U
           tBusinessFields.tcDataType       = "d":U
           tBusinessFields.tcDisplayFormat  = "->>>,>>>,>>9.99":U
           tBusinessFields.tcControlType    = "NumericDecimal":U
           tBusinessFields.tcFcDescription  = "":U.

    <M-1 run GetBusinessfields2 (input  icReference (icReportName), 
                             output viFcReturnSuper (oiReturnStatus)) in BCInvoice>

end.
else if icReference = "ApiSelectCInvoiceByPayRef":U
then do:
    /* The system already generated tBusinessFields for this query, but we want to have it *
     * exactly the same way as for the SelectCostCentre                                    */
    empty temp-table tBusinessFields.
    run appinfo/selectcinvoiceopen_bf.p (
        input table tBusinessFields by-reference,   /* tBusinessFields */
        input {&TARGETPROCEDURE},                   /* ih_super */
        output oiReturnStatus ).                    /* oiReturnStatus */

    /* Because we call method of the ApiSelectCInvoiceByPayRef query, we have to replace name of temp table */
    repeat preselect each tBusinessFields:
        find next tBusinessFields.
        assign tBusinessFields.tcFcFieldName = replace(tBusinessFields.tcFcFieldName, "tqSelectCInvoiceOpen":U, "tqApiSelectCInvoiceByPayRef":U).        
    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 = "BCInvoice".
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.