project QadFinancials > class BPeriod > API query SelectPeriod

Description

Select Query for Accounting Periods


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
tCMask.CMaskCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCMask.CMaskDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodClosingDatet=,>=,>,<>,<=,<
tPeriod.PeriodEndDatet=,>=,>,<>,<=,<
tPeriod.PeriodIsPostingGLAllowedl=,<>
tPeriod.PeriodIsPostingInvAllowedl=,<>
tPeriod.PeriodIsPostingOtherAllowl=,<>
tPeriod.PeriodIsPostingPCAllowedl=,<>
tPeriod.PeriodIsPostingPurchAllowl=,<>
tPeriod.PeriodIsPostingSalesAllowl=,<>
tPeriod.PeriodIsReportCheckedl=,<>
tPeriod.PeriodPeriodi=,>=,>,<>,<=,<
tPeriod.PeriodReportingPeriodc=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodStartDatet=,>=,>,<>,<=,<
tPeriod.PeriodStatusc=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodTypeCodec=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodYeari=,>=,>,<>,<=,<
tPeriod.PeriodYearPeriodi=,>=,>,<>,<=,<


Parameters (internal)


iiCompanyIdinteger


query condition


  each Period where
Period.Company_Id = iiCompanyId AND

      first CMask (conditional-join) where
CMask.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
CMask.CMask_ID = Period.CMask_ID AND


query sort order


Period.PeriodYear (descending)
Period.PeriodPeriod (descending)


query resultset tqSelectPeriod


field namedata typedb fielddescription
tiCMask_IDintegerCMask.CMask_IDRecord ID
tcCMaskCodecharacterCMask.CMaskCodeClosing Mask
tcCMaskDescriptioncharacterCMask.CMaskDescriptionDescription
tcPeriodReportingPeriodcharacterPeriod.PeriodReportingPeriodReporting GL Period
tiPeriodYearintegerPeriod.PeriodYearGL Calendar Year
tiPeriodPeriodintegerPeriod.PeriodPeriodGL Period
tcStatusPeriodCalccharactercalculatedStatus of the period, calculated field
tcPeriodTypeCalccharactercalculatedPeriodTypeCalc
ttPeriodStartDatedatePeriod.PeriodStartDateStart Date
ttPeriodEndDatedatePeriod.PeriodEndDateEnd Date
tlPeriodIsPostingGLAllowedlogicalPeriod.PeriodIsPostingGLAllowedGL
tlPeriodIsPostingPurchAllowlogicalPeriod.PeriodIsPostingPurchAllowPurchases
tlPeriodIsPostingSalesAllowlogicalPeriod.PeriodIsPostingSalesAllowSales
tlPeriodIsPostingInvAllowedlogicalPeriod.PeriodIsPostingInvAllowedInventory
tlPeriodIsPostingPCAllowedlogicalPeriod.PeriodIsPostingPCAllowedPeriodic Costing
tlPeriodIsPostingOtherAllowlogicalPeriod.PeriodIsPostingOtherAllowOther
tlPeriodIsReportCheckedlogicalPeriod.PeriodIsReportCheckedChecked/Reported
tiPeriodYearPeriodintegerPeriod.PeriodYearPeriodGL Calendar Year/GL Period
ttPeriodClosingDatedatePeriod.PeriodClosingDateClosing Date
tiPeriodMark_IDintegerPeriod.PeriodMark_IDMark
tiCompany_IDintegerPeriod.Company_IDLink to Company
tiPeriod_IDintegerPeriod.Period_IDRecord ID
tcPeriodTypeCodecharacterPeriod.PeriodTypeCodeGL Period Type
tcPeriodStatuscharacterPeriod.PeriodStatusStatus
PeriodCustomcharactercalculatedcustom fields
CMaskCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Period),rowid(CMask)


Internal usage


QadFinancials
lookup query on tPeriod.PeriodPeriod
lookup query on tWHT.WHTPeriodYear
lookup query on tWHT.WHTPeriodPeriod
lookup query on tAPMatching.tiPeriodPeriod
lookup query on tBankState.tiPeriodPeriod
lookup query on tBankStateLine.tiPeriodPeriod
lookup query on tCashReport.tiPeriodPeriod
lookup query on tConCheck.tiPeriodPeriod
lookup query on tConsolid.tiFromPeriodPeriod
lookup query on tConsolid.tiToPeriodPeriod
lookup query on tConsolidDump.tiFromPeriodPeriod
lookup query on tConsolidDump.tiOpeningPeriodPeriod
lookup query on tConsolidDump.tiToPeriodPeriod
lookup query on tConsolidPeriodXref.tiConsolidPeriodPeriod
lookup query on tConsolidPeriodXref.tiPeriodPeriod
lookup query on tFAAsset.tiPeriodPeriod
lookup query on tFACapital.tiPeriodPeriod
lookup query on tFADepreciationPosting.tiPeriodPeriod
lookup query on tFARevalPosting.tiPeriodPeriod
lookup query on tRecEntryLine.tiPeriodPeriod
lookup query on tRevalHeader.tiPeriodPeriod


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 = "BPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectPeriod".
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/bperiod.selectperiod.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.