API query SelectCreditorBalance (optimised)

Description

Select Query on CreditorBalance

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCBalance.CBalanceCC	d	=,>=,>,<>,<=,<
tCBalance.CBalanceLC	d	=,>=,>,<>,<=,<
tCBalance.CBalanceTC	d	=,>=,>,<>,<=,<
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCreditor.CreditorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCreditor.CreditorIsActive	l	=,<>
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each CBalance where

CBalance.Company_Id = iiCompanyId AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CBalance.Company_ID AND

first Creditor (inner-join) where

Creditor.SharedSet_Id = vi_CREDITOR_sharedset(iiCompanyId) AND
Creditor.Creditor_ID = CBalance.Creditor_ID AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Creditor.BusinessRelation_ID AND

first Currency (inner-join) where

Currency.Currency_ID = CBalance.Currency_ID AND

query sort order

Creditor.CreditorCode (ascending)
Company.CompanyCode (ascending)
Currency.CurrencyCode (ascending)

query resultset tqSelectCreditorBalance

field name	data type	db field	description
tiCBalance_ID	integer	CBalance.CBalance_ID	Record ID
tiCreditor_ID	integer	CBalance.Creditor_ID	Link to Creditor
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tlCreditorIsActive	logical	Creditor.CreditorIsActive	Active
tiBusinessRelation_ID	integer	Creditor.BusinessRelation_ID	Name
tcBusinessRelationCode	character	BusinessRelation.BusinessRelationCode	Business Relation. A code to identify the business relation. If this field does not have a input from the user, the system automatically generates a number for the record based on the sequence defined in Business Relation Autonumber Create.
tiCompany_ID	integer	CBalance.Company_ID	Link to Company
tcCompanyCode	character	Company.CompanyCode	Entity Code
tiCurrency_ID	integer	CBalance.Currency_ID	Link to Currency
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tdCBalanceLC	decimal	CBalance.CBalanceLC	BC Balance
tdCBalanceTC	decimal	CBalance.CBalanceTC	TC Balance
tdCBalanceCC	decimal	CBalance.CBalanceCC	SC Balance
CBalanceCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
CreditorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CBalance),rowid(Company),rowid(Creditor),rowid(BusinessRelation),rowid(Currency)

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 = "BCreditorBalance".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectCreditorBalance".
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/bcreditorbalance.selectcreditorbalance.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.