API query SelectBankPayFormatForAPDraft

Description

Return bank number and payment format based on Module type Payment Instrument, and company

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBankNumber.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankPayFormat.BankPayFormatNextCheckNbr	i	=,>=,>,<>,<=,<
tBankPayFormat.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypeLinesPerPage	i	=,>=,>,<>,<=,<
tPayFormatType.PayFormatTypeModule	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypePayInstrument	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each BankPayFormat where

first BankNumber (inner-join) where

BankNumber.BankNumber_ID = BankPayFormat.BankNumber_ID AND

first CompanySharedSet (inner-join) where

CompanySharedSet.Company_Id = iiCompanyId AND
CompanySharedSet.CompanySharedSet_ID = BankNumber.CompanySharedSet_ID AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CompanySharedSet.Company_ID AND

first PayFormatType (inner-join) where

PayFormatType.PayFormatTypeCode = BankPayFormat.PayFormatTypeCode AND
PayFormatType.PayFormatTypeModule = {&PAYFORMATMODULE-AP} AND
PayFormatType.PayFormatTypePayInstrument = {&PAYFORMATPAYINSTRUMENT-DRAFT}

query sort order

BankNumber.BankNumber (ascending)
BankPayFormat.PayFormatTypeCode (ascending)
BankPayFormat.BankPayFormat_ID (ascending)

query resultset tqSelectBankPayFormatForAPDraft

field name	data type	db field	description
tcBankPaymentFormat	character	calculated
tiBankPayFormat_ID	integer	BankPayFormat.BankPayFormat_ID	Record ID
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tcPayFormatTypeCode	character	BankPayFormat.PayFormatTypeCode	Payment Format
tcPayFormatTypeModule	character	PayFormatType.PayFormatTypeModule	Module
tcPayFormatTypePayInstrument	character	PayFormatType.PayFormatTypePayInstrument	Payment Instrument
tiBankPayFormatNextCheckNbr	integer	BankPayFormat.BankPayFormatNextCheckNbr	Next Pre-Printed Number
tiPayFormatTypeLinesPerPage	integer	PayFormatType.PayFormatTypeLinesPerPage	Invoices per check
BankPayFormatCustom	character	calculated	custom fields
BankNumberCustom	character	calculated	custom fields
PayFormatTypeCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(BankPayFormat),rowid(BankNumber),rowid(CompanySharedSet),rowid(Company),rowid(PayFormatType)

Internal usage

unused

Sample code: how to call this query 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 = "BBankPayFormat".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectBankPayFormatForAPDraft".
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 = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bbankpayformat.selectbankpayformatforapdraft.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* 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.