API query SelectTaxRegister

Description

This is the main select query for the Tax Registers

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiDomainID	i	=
tTaxReg.TaxRegCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tTaxReg.TaxRegCompanyAddress	c	=,>=,>,<>,<=,<,begins,can-do,matches
tTaxReg.TaxRegDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tTaxReg.TaxRegIsActive	l	=,<>
tTaxReg.TaxRegIsEU	l	=,<>
tTaxReg.TaxRegIsFinal	l	=,<>
tTaxReg.TaxRegNextPage	i	=,>=,>,<>,<=,<
tTaxReg.TaxRegType	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiDomainID

integer

query condition

each TaxReg where

TaxReg.Domain_ID = iiDomainID

query sort order

TaxReg.TaxRegCode (ascending)

query resultset tqSelectTaxRegister

field name	data type	db field	description
tiDomain_ID	integer	TaxReg.Domain_ID	Domain ID
tiTaxReg_ID	integer	TaxReg.TaxReg_ID	Tax Register ID
tcTaxRegCode	character	TaxReg.TaxRegCode	Tax Register Code
tcTaxRegCompanyAddres	character	TaxReg.TaxRegCompanyAddress	Company Address
tcTaxRegDescreption	character	TaxReg.TaxRegDescription	Description
tlTaxRegIsActive	logical	TaxReg.TaxRegIsActive	Active
tlTaxRegIsEU	logical	TaxReg.TaxRegIsEU	EU
tlTaxRegIsFinal	logical	TaxReg.TaxRegIsFinal	Final Report Generated
tiTaxRegNextPage	integer	TaxReg.TaxRegNextPage	Next Page
tcTaxRegType	character	TaxReg.TaxRegType	Type
TaxRegCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(TaxReg)

Internal usage

QadFinancials

lookup query on tTaxReg.TaxRegCode

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 = "BTaxRegister".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectTaxRegister".
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/btaxregister.selecttaxregister.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.