API query BudgetByProjectCostCentre (optimised)

Description

BudgetByProjectCostCentre

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icCostCentreCode	c	=
iiCostCentreID	i	=
icProjectCode	c	=
iiProjectID	i	=
icRowidToSkip	c
icBudgetStatus	c	=
tBudget.BudgetCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCostCentre.CostCentreCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tProject.ProjectCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icCostCentreCode	character	Cost Center Code
iiCostCentreID	integer	CostCentreId
icProjectCode	character	Project Code
iiProjectID	integer	Project ID
icRowidToSkip	character	RowidToSkip; if you pass a value for this parameter then the record with this rowid will be removed from the result-set. Rowid = rowid of the budget
icBudgetStatus	character	BudgetStatus

query condition

each Budget where

Budget.Project_ID = iiProjectID AND
Budget.CostCentre_ID = iiCostCentreID AND
rowid(Budget) <> to-rowid(icRowidToSkip) AND
Budget.BudgetStatus = icBudgetStatus

first CostCentre (conditional-join) where

CostCentre.SharedSet_Id = vi_COSTCENTRE_sharedset(iiCompanyId) AND
CostCentre.CostCentre_ID = Budget.CostCentre_ID AND
CostCentre.CostCentreCode = icCostCentreCode

first Project (conditional-join) where

Project.SharedSet_Id = vi_PROJECT_sharedset(iiCompanyId) AND
Project.Project_ID = Budget.Project_ID AND
Project.ProjectCode = icProjectCode

query sort order

Budget.BudgetCode (ascending)

query resultset tqBudgetByProjectCostCentre

field name	data type	db field	description
tiBudget_ID	integer	Budget.Budget_ID	Record ID
tcBudgetCode	character	Budget.BudgetCode	Budget Code
tcBudgetStatus	character	Budget.BudgetStatus	Status
tiCostCentre_ID	integer	Budget.CostCentre_ID	Cost Center Code
tcCostCentreCode	character	CostCentre.CostCentreCode	Cost Center: A code that identifies the cost center.
tiProject_ID	integer	Budget.Project_ID	Project Code
tcProjectCode	character	Project.ProjectCode	Project
BudgetCustom	character	calculated	custom fields
CostCentreCustom	character	calculated	custom fields
ProjectCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Budget),rowid(CostCentre),rowid(Project)

Internal usage

QadFinancials

method BBudget.ApiGetBudgetWBS
method BBudget.ApiGetBudgetWBSWithFigures
method BBudget.CheckBudgetFDSwithWBSID
method BBudget.ValidateComponentBudgetFDSWBS
method BBudget.ValidateComponentValidateStructDet
method BProject.AdditionalUpdates

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 = "BudgetByProjectCostCentre".
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.budgetbyprojectcostcentre.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.