project QadFinancials > class BBudget > API query BudgetVersionByReportPeriod (optimised)

Description

Get back BudgetVersion using
ProjectID - ProjectCode
Report Period End Date


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
icProjectCodec=
itReportPeriodEndDatet<=
icBudgetStatusc=
tBudget.BudgetCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBudget.BudgetStatusc=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetVersion.BudgetVersionCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetVersion.BudgetVersionCommentc=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetVersion.BudgetVersionCreateDatet=,>=,>,<>,<=,<
tBudgetVersion.BudgetVersionCreateTimei=,>=,>,<>,<=,<
tBudgetVersion.BudgetVersionDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tBudgetVersion.BudgetVersionPercCompletd=,>=,>,<>,<=,<
tProject.ProjectCodec=,>=,>,<>,<=,<,begins,can-do,matches
tReportPeriod.ReportPeriodEndDatet=,>=,>,<>,<=,<
tReportPeriod.ReportPeriodPeriodi=,>=,>,<>,<=,<
tReportPeriod.ReportPeriodStartDatet=,>=,>,<>,<=,<
tReportPeriod.ReportPeriodYeari=,>=,>,<>,<=,<


Parameters (internal)


iiCompanyIdintegerCompany id
icProjectCodecharacter
itReportPeriodEndDatedate
icBudgetStatuscharacterBudget Status


query condition


  each Budget where
Budget.BudgetStatus = icBudgetStatus

      each BudgetVersion (inner-join) where
BudgetVersion.Budget_ID = Budget.Budget_ID AND

          first ReportPeriod (inner-join) where
ReportPeriod.ReportPeriod_ID = BudgetVersion.ReportPeriod_ID AND
ReportPeriod.ReportPeriodStartDate <= itReportPeriodEndDate

      first Project (inner-join) where
Project.SharedSet_Id = vi_PROJECT_sharedset(iiCompanyId) AND
Project.Project_ID = Budget.Project_ID AND
Project.ProjectCode = icProjectCode


query sort order


Budget.Project_ID (ascending)
Budget.Budget_ID (ascending)
ReportPeriod.ReportPeriodStartDate (ascending)


query resultset tqBudgetVersionByReportPeriod


field namedata typedb fielddescription
tiBudget_IDintegerBudget.Budget_IDRecord ID
tcBudgetCodecharacterBudget.BudgetCodeBudget Code
tcBudgetStatuscharacterBudget.BudgetStatusStatus
tiBudgetVersion_IDintegerBudgetVersion.BudgetVersion_IDRecord ID
tcBudgetVersionCodecharacterBudgetVersion.BudgetVersionCodeVersion Code
tcBudgetVersionCommentcharacterBudgetVersion.BudgetVersionCommentComment
ttBudgetVersionCreateDatedateBudgetVersion.BudgetVersionCreateDateCreation Date
tiBudgetVersionCreateTimeintegerBudgetVersion.BudgetVersionCreateTimeCreation Time
tcBudgetVersionDescriptioncharacterBudgetVersion.BudgetVersionDescriptionDescription
tdBudgetVersionPercCompletdecimalBudgetVersion.BudgetVersionPercComplet% of Completion
tiProject_IDintegerBudget.Project_IDProject Code
tcProjectCodecharacterProject.ProjectCodeProject
ttReportPeriodEndDatedateReportPeriod.ReportPeriodEndDateEnd Date
tiReportPeriodPeriodintegerReportPeriod.ReportPeriodPeriodGL Period
ttReportPeriodStartDatedateReportPeriod.ReportPeriodStartDateStart Date
tiReportPeriodYearintegerReportPeriod.ReportPeriodYearYear
BudgetCustomcharactercalculatedcustom fields
BudgetVersionCustomcharactercalculatedcustom fields
ReportPeriodCustomcharactercalculatedcustom fields
ProjectCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Budget),rowid(BudgetVersion),rowid(ReportPeriod),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 = "BudgetVersionByReportPeriod".
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.budgetversionbyreportperiod.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.