API query SelectFABook (optimised)

Description

Select Query on Fixed Assets - Book

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tFABook.FABookCalculationType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tFABook.FABookCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tFABook.FABookDepreciationType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tFABook.FABookDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tFABook.FABookIsActive	l	=,<>
tFABook.FABookIsWithDepreciation	l	=,<>
tFABook.FABookLifeCycle	i	=,>=,>,<>,<=,<
tFABookType.FABookTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tFABookType.FABookTypeIsOfficial	l	=,<>
tLayer.LayerCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUnit.UnitCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each FABook where

FABook.Company_Id = iiCompanyId AND

first FABookType (inner-join) where

FABookType.Company_Id = iiCompanyId AND
FABookType.FABookType_ID = FABook.FABookType_ID AND

first Layer (inner-join) where

Layer.Layer_ID = FABookType.Layer_ID AND

first Unit (outer-join) where

Unit.Unit_ID = FABook.Unit_ID AND

query sort order

FABookType.FABookTypeCode (ascending)
FABook.FABookCode (ascending)

query resultset tqSelectFABook

field name	data type	db field	description
tcFABookDepreciationTypeCalc	character	calculated	Depreciation Type
tcFABookCalculationTypeCalc	character	calculated	Calculation type
tiUnit_ID	integer	FABook.Unit_ID	GL Account Unit of Measure
tiCompany_ID	integer	FABook.Company_ID	Link to Company
tiFABookType_ID	integer	FABook.FABookType_ID	Book Type
tiFABook_ID	integer	FABook.FABook_ID	Record ID
tcFABookTypeCode	character	FABookType.FABookTypeCode	Code
tlFABookTypeIsOfficial	logical	FABookType.FABookTypeIsOfficial	Official
tcLayerCode	character	Layer.LayerCode	Layer Code
tcFABookCode	character	FABook.FABookCode	Code
tcFABookDescription	character	FABook.FABookDescription	Description
tlFABookIsActive	logical	FABook.FABookIsActive	Active
tlFABookIsWithDepreciation	logical	FABook.FABookIsWithDepreciation	With Depreciation
tcFABookDepreciationType	character	FABook.FABookDepreciationType	Depreciation Type
tcFABookCalculationType	character	FABook.FABookCalculationType	Calculation Type
tiFABookLifeCycle	integer	FABook.FABookLifeCycle	Life Cycle
tcUnitCode	character	Unit.UnitCode	Unit of Measure
FABookCustom	character	calculated	custom fields
FABookTypeCustom	character	calculated	custom fields
LayerCustom	character	calculated	custom fields
UnitCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(FABook),rowid(FABookType),rowid(Layer),rowid(Unit)

Internal usage

QadFinancials

lookup query on tFABook.FABookCode
lookup query on tFAAssetTypeFABook.tcFABookCode

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 = "BFixedAssetBook".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectFABook".
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/bfixedassetbook.selectfabook.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.