API query BankNumberPayFormatByParent (optimised)

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
icParentType	c	=
iiCompanyId	i
icCreditorCode	c	=
icDebtorCode	c	=
iiParentObject_ID	i	=
tBankNumber2.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberExtension	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber2.BankNumberIsActive	l	=,<>
tBankNumber.BankNumberIsActive	l	=,<>
tBankNumber.BankNumberIsDefault	l	=,<>
tBankNumber.BankNumberParentType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberValidation	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankPayFormat.BankPayFormatIsActive	l	=,<>
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCreditor.CreditorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypeIsActive	l	=,<>
tPayFormatType.PayFormatTypeModule	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypePayInstrument	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypePayType	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

icParentType	character
iiCompanyId	integer	Company id
icCreditorCode	character
icDebtorCode	character
iiParentObject_ID	integer

query condition

each BankNumber where

BankNumber.BankNumberParentType = icParentType AND
BankNumber.ParentObject_ID = iiParentObject_ID

first BankPayFormat (inner-join) where

BankPayFormat.BankPayFormat_ID = BankNumber.BankPayFormat_ID AND

first BankNumber2 (inner-join) where

BankNumber2.BankNumber_ID = BankPayFormat.BankNumber_ID AND

first CompanySharedSet (inner-join) where

CompanySharedSet.Company_Id = iiCompanyId AND
CompanySharedSet.CompanySharedSet_ID = BankNumber2.CompanySharedSet_ID AND

first Company (inner-join) where

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

first GL (inner-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = BankNumber2.ParentObject_ID AND

first PayFormatType (inner-join) where

PayFormatType.PayFormatTypeCode = BankPayFormat.PayFormatTypeCode AND

first Creditor (conditional-join) where

Creditor.SharedSet_Id = vi_CREDITOR_sharedset(iiCompanyId) AND
Creditor.Creditor_ID = BankNumber.ParentObject_ID AND
Creditor.CreditorCode = icCreditorCode

first Debtor (conditional-join) where

Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = BankNumber.ParentObject_ID AND
Debtor.DebtorCode = icDebtorCode

query resultset tqBankNumberPayFormatByParent

field name	data type	db field	description
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tiBankNumber_ID	integer	BankNumber.BankNumber_ID	Record ID
tcBankNumberExtension	character	BankNumber.BankNumberExtension	Bank Extension
tlBankNumberIsActive	logical	BankNumber.BankNumberIsActive	Active
tlBankNumberIsDefault	logical	BankNumber.BankNumberIsDefault	Default
tcBankNumberParentType	character	BankNumber.BankNumberParentType	Type
tcBankNumberValidation	character	BankNumber.BankNumberValidation	Validation
tiBankPayFormat_ID	integer	BankPayFormat.BankPayFormat_ID	Record ID
tlBankPayFormatIsActive	logical	BankPayFormat.BankPayFormatIsActive	Active
tiCompany_ID	integer	Company.Company_ID	Record ID
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tcDebtorCode	character	Debtor.DebtorCode	A code (maximum eight characters) that identifies a customer. If the code you specify matches an existing supplier code, a warning message displays. You can choose to ignore the warning, and create the record. However, when a supplier and customer share the same code, they must reference the same business relation.
	api annotation:		If you leave the Customer Code field blank, the system automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcOwnBankNumber	character	BankNumber2.BankNumber	Bank Number
tiOwnBankNumber_ID	integer	BankNumber2.BankNumber_ID	Record ID
tlOwnBankNumberIsActive	logical	BankNumber2.BankNumberIsActive	Active
tcPayFormatTypeCode	character	PayFormatType.PayFormatTypeCode	Format Name
tlPayFormatTypeIsActive	logical	PayFormatType.PayFormatTypeIsActive	Active
tcPayFormatTypeModule	character	PayFormatType.PayFormatTypeModule	Module
tcPayFormatTypePayInstrument	character	PayFormatType.PayFormatTypePayInstrument	Payment Instrument
tcPayFormatTypePayType	character	PayFormatType.PayFormatTypePayType	Payment Type
BankNumberCustom	character	calculated	custom fields
BankPayFormatCustom	character	calculated	custom fields
BankNumber2Custom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
PayFormatTypeCustom	character	calculated	custom fields
CreditorCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(BankNumber),rowid(BankPayFormat),rowid(BankNumber2),rowid(CompanySharedSet),rowid(Company),rowid(GL),rowid(PayFormatType),rowid(Creditor),rowid(Debtor)

Internal usage

QadFinancials

method BCDocument.DefaultValuesCreditorCode

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 = "BBankNumber".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "BankNumberPayFormatByParent".
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/bbanknumber.banknumberpayformatbyparent.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.