API query SelectBudgetWBS (optimised)

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBudget.BudgetCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetFDS.BudgetFDSIsAllocationTotal	l	=,<>
tBudgetWBS.BudgetFDSSeq	i	=,>=,>,<>,<=,<
tBudgetWBS.BudgetFDSType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetIsUsedForAllocation	l	=,<>
tBudgetWBS.BudgetWBSCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetWBS.BudgetWBSComment	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetWBS.BudgetWBSCostRevenue	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetWBS.BudgetWBSCostType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetWBS.BudgetWBSFDSFromCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetWBS.BudgetWBSSeq	d	=,>=,>,<>,<=,<
tBudgetWBS.BudgetWBSStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each BudgetWBS where

first Budget (inner-join) where

Budget.Budget_ID = BudgetWBS.Budget_ID AND

first BudgetFDS (conditional-join) where

BudgetFDS.BudgetFDS_ID = BudgetWBS.BudgetFDS_ID AND

query sort order

Budget.BudgetCode (ascending)
BudgetWBS.BudgetWBSSeq (ascending)

query resultset tqSelectBudgetWBS

field name	data type	db field	description
tlBudgetFDSIsAllocationTotal	logical	BudgetFDS.BudgetFDSIsAllocationTotal	Used for Proportional Allocation
tlBudgetIsUsedForAllocation	logical	Budget.BudgetIsUsedForAllocation	Used for Allocation
tcBudgetWBSSeqStr	character	calculated
tcBudgetCode	character	Budget.BudgetCode	Budget Code
tcBudgetWBSCode	character	BudgetWBS.BudgetWBSCode	WBS Code
tcBudgetWBSComment	character	BudgetWBS.BudgetWBSComment	Comment
tcBudgetWBSCostRevenue	character	BudgetWBS.BudgetWBSCostRevenue	Cost/Revenue
tcBudgetWBSCostType	character	BudgetWBS.BudgetWBSCostType	Cost Type
tcBudgetWBSFDSFromCode	character	BudgetWBS.BudgetWBSFDSFromCode	From COA
tiBudgetFDSSeq	integer	BudgetWBS.BudgetFDSSeq	COA Sequence
tcBudgetFDSType	character	BudgetWBS.BudgetFDSType	COA Type
tiBudgetGroup_ID	integer	BudgetWBS.BudgetGroup_ID	Budget Group
tdBudgetWBSSeq	decimal	BudgetWBS.BudgetWBSSeq	WBS Seq
tcBudgetWBSStatus	character	BudgetWBS.BudgetWBSStatus	Status
tiBudgetWBS_ID	integer	BudgetWBS.BudgetWBS_ID	Record ID
tiBudget_ID	integer	BudgetWBS.Budget_ID	Link to Budget
tiBudgetFDS_ID	integer	BudgetWBS.BudgetFDS_ID	Link to BudgetFDS
BudgetWBSCustom	character	calculated	custom fields
BudgetCustom	character	calculated	custom fields
BudgetFDSCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(BudgetWBS),rowid(Budget),rowid(BudgetFDS)

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 = "BBudget".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectBudgetWBS".
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/bbudget.selectbudgetwbs.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.