project QadFinancials > class BPaymentSelectionReport > method GetBusinessFields

Description

This method will define all the filters for all the payment selection reports.


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/bpaymentselectionreport.p)

<ANCESTOR-CODE>
/*BE CAREFUL - USE THE SAME STRING CONSTANTS 
a) here for assigning tBusinessFields.tcFcFieldName as well as in
a) SetDataItemsBasedOnFilterTT in the case-when phrase*/

if can-do("PayList,Remittance":U, icReference)    
then do:
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-41'Payment Selection Code':40(3034)T-41#)
           tBusinessFields.tcFcDescription = trim(#T-42'Payment Selection Code':100(3035)T-42#)
           tBusinessFields.tcFcFieldName   = "PaySelCode_RANGE":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BPaymentSelectionSAO.SelectPaySel":U
           tBusinessFields.tcLookupReturnField = "tqSelectPaySel.tcPaySelCode":U
           tBusinessFields.tcLookupFilterField = "tPaySel.PaySelCode":U.                           
        
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-15'Supplier Codes':30(59458)T-15#)
           tBusinessFields.tcFcDescription = trim(#T-16'Supplier Codes':100(59459)T-16#)
           tBusinessFields.tcFcFieldName   = "CreditorCode_CANDO":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BCreditorSAO.SelectCreditor":U
           tBusinessFields.tcLookupReturnField = "tqSelectCreditor.tcCreditorCode":U
           tBusinessFields.tcLookupFilterField = "tCreditor.CreditorCode":U.
    
    /* create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-19'Customer Codes':30(56412)T-19#)
           tBusinessFields.tcFcDescription = trim(#T-20'Customer Codes':100(56413)T-20#)
           tBusinessFields.tcFcFieldName   = "DebtorCode_CANDO":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BDebtorSAO.SelectDebtor":U
           tBusinessFields.tcLookupReturnField = "tqSelectDebtor.tcDebtorCode":U
           tBusinessFields.tcLookupFilterField = "tDebtor.DebtorCode":U. */

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-53'Execution Date':30(3036)T-53#)
           tBusinessFields.tcFcDescription = trim(#T-54'Execution Date':100(3037)T-54#)
           tBusinessFields.tcFcFieldName   = "ExecutionDate_RANGE":U
           tBusinessFields.tcDataType      = "t":U
           tBusinessFields.tcControlType   = "DateTime":U
           tBusinessFields.tcDisplayFormat = "99/99/9999":U
           tBusinessFields.tcFcFieldType   = "F":U.
end.

if can-do("PayList":U, icReference)    
then do:
/*
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-43'Execution Date':30(3036)T-43#)
           tBusinessFields.tcFcDescription = trim(#T-44'Execution Date':100(3037)T-44#)
           tBusinessFields.tcFcFieldName   = "ExecutionDate_RANGE":U
           tBusinessFields.tcDataType      = "t":U
           tBusinessFields.tcControlType   = "DateTime":U
           tBusinessFields.tcDisplayFormat = "99/99/9999":U
           tBusinessFields.tcFcFieldType   = "F":U.
*/
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-66'Business Relation':30(71)T-66#)
           tBusinessFields.tcFcDescription = trim(#T-69'Business Relation':30(71)T-69#)
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldName   = "CreditorBRName_RANGE":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BBusinessRelationSAO.SelectBusinessRelation":U
           tBusinessFields.tcLookupReturnField = "tqSelectBusinessRelation.tcBusinessRelationName1":U
           tBusinessFields.tcLookupFilterField = "tBusinessRelation.BusinessRelationName1":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-68'Business Relation':30(71)T-68#)
           tBusinessFields.tcFcDescription = trim(#T-67'Business Relation':30(71)T-67#)
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldName   = "CreditorBRName_CANDO":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BBusinessRelationSAO.SelectBusinessRelation":U
           tBusinessFields.tcLookupReturnField = "tqSelectBusinessRelation.tcBusinessRelationName1":U
           tBusinessFields.tcLookupFilterField = "tBusinessRelation.BusinessRelationName1":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel    = trim(#T-21'Status':30(2514)t-21#)
           tBusinessFields.tcFcDescription  = trim(#T-22'Payment Selection Status':100(3038)t-22#)
           tBusinessFields.tcValueList         = {&PAYMENTSELECTIONSTATUS-INITIAL-TR}     + chr(2) + {&PAYMENTSELECTIONSTATUS-INITIAL}    + chr (2) +
                                                                 {&PAYMENTSELECTIONSTATUS-REGISTERED-TR}  + chr(2) + {&PAYMENTSELECTIONSTATUS-REGISTERED} + chr (2) +
                                                                 {&PAYMENTSELECTIONSTATUS-TRANSFERRED-TR} + chr(2) + {&PAYMENTSELECTIONSTATUS-TRANSFERRED}           
           tBusinessFields.tcFcFieldName   = "Status":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "ComboBox":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U.
/*
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-27'Payment Format':30(50690)T-27#)
           tBusinessFields.tcFcDescription = trim(#T-28'Payment Format':100(59460)T-28#)
           tBusinessFields.tcValueList     = trim(#T-29'Electronic':30(3045)t-29#) + chr(2) + "ELECTRONIC":U + chr(2) +
                                             trim(#T-30'Undefined':30(3046)t-30#) + chr(2) + "UNDEFINED":U
           tBusinessFields.tcFcFieldName   = "MeansOfPayment":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "ComboBox":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U.
*/           
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-47'Print Details':30(17037)T-47#)
           tBusinessFields.tcFcDescription = trim(#T-48'Print Details':100(16153)T-48#)
           tBusinessFields.tcFcFieldName   = "PrintDetails":U
           tBusinessFields.tcDataType      = "l":U
           tBusinessFields.tcControlType   = "Bool":U
           tBusinessFields.tcDisplayFormat = "yes/no":U
           tBusinessFields.tcFcFieldType   = "F":U.

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-57'Sort By':20(59810)T-57#)
           tBusinessFields.tcFcDescription = trim(#T-58'Sort By':20(59810)T-58#)
           tBusinessFields.tcValueList     = trim(#T-59'Supplier Code':100(1935)T-59#) + chr(2) + "SUPPLIERCODE":U + chr(2) +
                                             trim(#T-70'Business Relation':30(71)T-70#) + chr(2) + "BUSINESSRELATIONNAME":U
           tBusinessFields.tcFcFieldName   = "SortBy":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "ComboBoxM":U
           tBusinessFields.tcDisplayFormat = "x(20)":U
           tBusinessFields.tcFcFieldType   = "F":U.

end.

if can-do("Remittance":U, icReference)    
then do:
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-45'Reference in Bank Files':40(3053)T-45#)
           tBusinessFields.tcFcDescription = trim(#T-46'Reference in Bank Files':100(3054)T-46#)
           tBusinessFields.tcFcFieldName   = "ReferenceInBankFiles":U
           tBusinessFields.tcDataType      = "l":U
           tBusinessFields.tcControlType   = "Bool":U
           tBusinessFields.tcDisplayFormat = "yes/no":U
           tBusinessFields.tcFcFieldType   = "F":U.
/*
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-31'Selection Year':30(3047)T-31#)
           tBusinessFields.tcFcDescription = trim(#T-32'Selection Year':100(3048)T-32#)
           tBusinessFields.tcFcFieldName   = "CollectionYear_RANGE":U
           tBusinessFields.tcDataType      = "i":U
           tBusinessFields.tcControlType   = "NumericInt":U
           tBusinessFields.tcDisplayFormat = "9999":U
           tBusinessFields.tcFcFieldType   = "F":U.
 
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-33'Selection Number':30(3049)T-33#)
           tBusinessFields.tcFcDescription = trim(#T-34'Selection Number':100(3050)T-34#)
           tBusinessFields.tcFcFieldName   = "CollectionNumber_RANGE":U
           tBusinessFields.tcDataType      = "c":U
           /* tBusinessFields.tcDataType      = "i":U
           tBusinessFields.tcControlType   = "NumericInt":U
           tBusinessFields.tcDisplayFormat = "999999999":U */
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDisplayFormat = "x(50)":U
           tBusinessFields.tcFcFieldType   = "F":U
           tBusinessFields.tcLookupQuery       = "BCCollectionSAO.SelectCCollection":U
           tBusinessFields.tcLookupReturnField = "tqSelectCCollection.tiCCollectionNumber":U
           tBusinessFields.tcLookupFilterField = "tCCollection.CCollectionNumber":U.
                                                                         
    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-35'Selection Reference':30(3051)T-35#)
           tBusinessFields.tcFcDescription = trim(#T-36'Selection Reference':100(3052)T-36#)
           tBusinessFields.tcFcFieldName   = "CollectionReference_RANGE":U
           tBusinessFields.tcDataType      = "c":U
           tBusinessFields.tcControlType   = "TextBox":U
           tBusinessFields.tcDisplayFormat = "x(40)":U
           tBusinessFields.tcFcFieldType   = "F":U
         /* tBusinessFields.tcLookupQuery       = "":U
           tBusinessFields.tcLookupReturnField = "":U. */             
           tBusinessFields.tcLookupQuery       = "BCCollectionSAO.SelectCCollection":U
           tBusinessFields.tcLookupReturnField = "tqSelectCCollection.tcCCollectionReference":U
           tBusinessFields.tcLookupFilterField = "tCCollection.CCollectionReference":U. */

    create tBusinessFields.
    assign tBusinessFields.tcSideLabel     = trim(#T-55'Send Remittance Flag':40(71148)T-55#)
           tBusinessFields.tcFcDescription = trim(#T-56'Send Remittance Flag':40(71148)T-56#)
           tBusinessFields.tcFcFieldName   = "SendRemittance":U
           tBusinessFields.tcDataType      = "l":U
           tBusinessFields.tcControlType   = "Bool":U
           tBusinessFields.tcDisplayFormat = "yes/no":U
           tBusinessFields.tcFcFieldType   = "F":U.
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 = "BPaymentSelectionReport".
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.