API query BudgetisReportStruct (optimised)

Annotation

SelectBudget; select query for the budgets

Description

Similar to SelectBudget but with condition of reportstruct; query used for the Lookup of Report Structures

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBudget.BudgetCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetIsCompanyDependent	l	=,<>
tBudget.BudgetIsReportStruct	l	=,<>
tBudget.BudgetIsWithQuantityData	l	=,<>
tBudget.BudgetOverrunPeriod	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetOverrunTotal	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetOverrunYTD	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetType	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

query condition

each Budget where

Budget.BudgetIsReportStruct = TRUE

each BudgetCompany (inner-join) where

BudgetCompany.Company_Id = iiCompanyId AND
BudgetCompany.Budget_ID = Budget.Budget_ID AND

first CostCentre (conditional-join) where

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

first Project (conditional-join) where

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

query sort order

Budget.BudgetCode (ascending)

query resultset tqBudgetisReportStruct

field name	data type	db field	description
tlBudgetIsReportStruct	logical	Budget.BudgetIsReportStruct	Use as Report
tcBudgetCode	character	Budget.BudgetCode	Budget Code
tcBudgetDescription	character	Budget.BudgetDescription	Description
tcBudgetStatus	character	Budget.BudgetStatus	Status
tcBudgetStatusSelect	character	calculated
tcBudgetTypeSelect	character	calculated	BudgetTypeSelect
tcProjectCode	character	Project.ProjectCode	Project
tcCostCentreCode	character	CostCentre.CostCentreCode	Cost Center: A code that identifies the cost center.
tcBudgetOverrunTotal	character	Budget.BudgetOverrunTotal	Total Overrun
tcBudgetOverrunTotalSelect	character	calculated	Total Overrun
tcBudgetOverrunPeriod	character	Budget.BudgetOverrunPeriod	GL Period Overrun
tcBudgetOverrunPeriodSelect	character	calculated	BudgetOverrunPeriodSelect
tcBudgetOverrunYTD	character	Budget.BudgetOverrunYTD	Overrun (YTD)
tcBudgetOverrunYTDSelect	character	calculated	BudgetOverrunYTDSelect
tlBudgetIsCompanyDependent	logical	Budget.BudgetIsCompanyDependent	Entity Dependent
tlBudgetIsWithQuantityData	logical	Budget.BudgetIsWithQuantityData	Use Quantity Info
tiBudget_ID	integer	Budget.Budget_ID	Record ID
tiCostCentreSharedSet_ID	integer	Budget.CostCentreSharedSet_ID	Link to SharedSet
tiCostCentre_ID	integer	Budget.CostCentre_ID	Cost Center Code
tiCurrency_ID	integer	Budget.Currency_ID	Currency Code
tiDivisionSharedSet_ID	integer	Budget.DivisionSharedSet_ID	Link to SharedSet
tiGLSharedSet_ID	integer	Budget.GLSharedSet_ID	Link to SharedSet
tiProjectSharedSet_ID	integer	Budget.ProjectSharedSet_ID	Link to SharedSet
tiProject_ID	integer	Budget.Project_ID	Project Code
tiUsr_ID	integer	Budget.Usr_ID	Budget Administrator
tcBudgetType	character	Budget.BudgetType	Budget Type
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(BudgetCompany),rowid(CostCentre),rowid(Project)

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 = "BudgetisReportStruct".
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.budgetisreportstruct.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.