API query SelectBill (optimised)

Description

Select query for Bill

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBill.BillClosingBalanceTC	d	=,>=,>,<>,<=,<
tBill.BillConfirmDate	t	=,>=,>,<>,<=,<
tBill.BillDate	t	=,>=,>,<>,<=,<
tBill.BillDueDate	t	=,>=,>,<>,<=,<
tBill.BillNumber	i	=,>=,>,<>,<=,<
tBill.BillOpeningBalanceTC	d	=,>=,>,<>,<=,<
tBill.BillPaymentAmtTC	d	=,>=,>,<>,<=,<
tBill.BillSalesAmtTC	d	=,>=,>,<>,<=,<
tBillSchedule.BillScheduleCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBill.BillStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBill.BillTaxAmtTC	d	=,>=,>,<>,<=,<
tBill.BillYear	i	=,>=,>,<>,<=,<
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tEmployee.EmployeeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each Bill where

Bill.Company_Id = iiCompanyId AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = Bill.Company_ID AND

first Currency (inner-join) where

Currency.Currency_ID = Bill.Currency_ID AND

first Debtor (conditional-join) where

Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = Bill.Debtor_ID AND

first BillSchedule (outer-join) where

BillSchedule.BillSchedule_ID = Debtor.BillSchedule_ID AND

first BusinessRelation (conditional-join) where

BusinessRelation.BusinessRelation_ID = Debtor.BusinessRelation_ID AND

first Employee (conditional-join) where

Employee.Company_Id = iiCompanyId AND
Employee.Employee_ID = Bill.Employee_ID AND

query resultset tqSelectBill

field name	data type	db field	description
tiBill_ID	integer	Bill.Bill_ID	Record ID
tdBillClosingBalanceTC	decimal	Bill.BillClosingBalanceTC	TC Closing Balance
ttBillConfirmDate	date	Bill.BillConfirmDate	Bill Confirm Date
ttBillDate	date	Bill.BillDate	Bill Date
ttBillDueDate	date	Bill.BillDueDate	Bill Due Date
tiBillNumber	integer	Bill.BillNumber	Bill Number
tdBillOpeningBalanceTC	decimal	Bill.BillOpeningBalanceTC	TC Opening Balance
tdBillPaymentAmtTC	decimal	Bill.BillPaymentAmtTC	TC Payment Amount
tdBillSalesAmtTC	decimal	Bill.BillSalesAmtTC	TC Sales Amount
tcBillScheduleCode	character	BillSchedule.BillScheduleCode	Billing Schedule Code
tcBillStatus	character	Bill.BillStatus	Status
tdBillTaxAmtTC	decimal	Bill.BillTaxAmtTC	TC Tax Amount
tiBillYear	integer	Bill.BillYear	Bill Year
tiBusinessRelation_ID	integer	BusinessRelation.BusinessRelation_ID	Record ID
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.
tcBusinessRelationName1	character	BusinessRelation.BusinessRelationName1	Name: The full name of the business relation. This field sets the default name for linked addresses such as customers and suppliers.
	api annotation:		PartialUpdate = yes - defaults to the BusinessRelationCode.
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCurrencyCode	character	Currency.CurrencyCode	Currency 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.
tcEmployeeCode	character	Employee.EmployeeCode	Employee Code. A code that identifies an employee. The code cannot match any other employee in the current entity or any other entities in the current domain. If you leave the Employee Code field blank, the system automatically generates a number for the record based on the sequence defined in Employee Autonumber Create.
tcStatus	character	calculated
BillCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
EmployeeCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
BillScheduleCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Bill),rowid(Company),rowid(Currency),rowid(Debtor),rowid(BillSchedule),rowid(BusinessRelation),rowid(Employee)

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 = "BBill".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectBill".
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/bbill.selectbill.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.