API query SelectCompanyPropertyForWHT (optimised)

Description

SelectCompanyPropertyForWHT: select query on tables CompanyProperty, Company, Currency, SharedSet and CompanySharedSet
The purpose of this query is to provide the caller to pass in a base-currency and a shared-set of type 'Creditor' so the result-set of the query can be filterd on that.
Note that If no filtering on SharedSet is provided then the result-set will contain multiple entires per company (due to the join to CompanySharedSet).
This query should only be used by UI-components!!!!

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyIsActive	l	=,<>
tCompanyProperty.CompanyPropertyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyDelTax	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyIsActive	l	=,<>
tCompanyProperty.CompanyPropertyIsDelPaid	l	=,<>
tCompanyProperty.CompanyPropertyIsGrIncAcc	l	=,<>
tCompanyProperty.CompanyPropertyIsSuspPaid	l	=,<>
tCompanyProperty.CompanyPropertySuspTax	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tSharedSet.SharedSetCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tSharedSet.SharedSetIsActive	l	=,<>
tSharedSet.SharedSetTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each CompanyProperty where

CompanyProperty.Company_Id = iiCompanyId AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CompanyProperty.Company_ID AND

each CompanySharedSet (inner-join) where

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

first SharedSet (inner-join) where

SharedSet.SharedSet_ID = CompanySharedSet.SharedSet_ID AND

first Currency (inner-join) where

Currency.Currency_ID = CompanyProperty.Currency_ID AND

query sort order

Company.CompanyCode (ascending)

query resultset tqSelectCompanyPropertyForWHT

field name	data type	db field	description
tcCompanyCode	character	Company.CompanyCode	Entity Code
tlCompanyIsActive	logical	Company.CompanyIsActive	Active
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tcSharedSetTypeCode	character	SharedSet.SharedSetTypeCode	Shared Set Type
tcSharedSetCode	character	SharedSet.SharedSetCode	Shared Set Code
tlCompanyPropertyIsDelPaid	logical	CompanyProperty.CompanyPropertyIsDelPaid	Delay Until Paid Status
tlCompanyPropertyIsGrIncAcc	logical	CompanyProperty.CompanyPropertyIsGrIncAcc	Gross Income Accounting
tlCompanyPropertyIsSuspPaid	logical	CompanyProperty.CompanyPropertyIsSuspPaid	Suspend Until Paid Status
tcCompanyPropertySuspTax	character	CompanyProperty.CompanyPropertySuspTax	Suspended Tax
tcCompanyPropertyDelTax	character	CompanyProperty.CompanyPropertyDelTax	Delayed Tax
tiDomain_ID	integer	Company.Domain_ID	Domain
tiSharedSet_ID	integer	CompanySharedSet.SharedSet_ID	Shared Set
tiCompanyProperty_ID	integer	CompanyProperty.CompanyProperty_ID	Record ID
tiCompany_ID	integer	CompanyProperty.Company_ID	Link to Company
tlSharedSetIsActive	logical	SharedSet.SharedSetIsActive	Active
tiCompanySharedSet_ID	integer	CompanySharedSet.CompanySharedSet_ID	Record ID
tlCompanyPropertyIsActive	logical	CompanyProperty.CompanyPropertyIsActive	Active
tcCompanyPropertyCode	character	CompanyProperty.CompanyPropertyCode	Entity Code
CompanyPropertyCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
CompanySharedSetCustom	character	calculated	custom fields
SharedSetCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CompanyProperty),rowid(Company),rowid(CompanySharedSet),rowid(SharedSet),rowid(Currency)

Internal usage

QadFinancials

lookup query on tWHT.WHTCompanyCode

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 = "BCompanyProperty".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectCompanyPropertyForWHT".
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/bcompanyproperty.selectcompanypropertyforwht.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.