API query SelectPeriod

Description

Select Query for Accounting Periods

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCMask.CMaskCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCMask.CMaskDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodClosingDate	t	=,>=,>,<>,<=,<
tPeriod.PeriodEndDate	t	=,>=,>,<>,<=,<
tPeriod.PeriodIsPostingGLAllowed	l	=,<>
tPeriod.PeriodIsPostingInvAllowed	l	=,<>
tPeriod.PeriodIsPostingOtherAllow	l	=,<>
tPeriod.PeriodIsPostingPCAllowed	l	=,<>
tPeriod.PeriodIsPostingPurchAllow	l	=,<>
tPeriod.PeriodIsPostingSalesAllow	l	=,<>
tPeriod.PeriodIsReportChecked	l	=,<>
tPeriod.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod.PeriodReportingPeriod	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodStartDate	t	=,>=,>,<>,<=,<
tPeriod.PeriodStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<
tPeriod.PeriodYearPeriod	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId

integer

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 name	data type	db field	description
tiCMask_ID	integer	CMask.CMask_ID	Record ID
tcCMaskCode	character	CMask.CMaskCode	Closing Mask
tcCMaskDescription	character	CMask.CMaskDescription	Description
tcPeriodReportingPeriod	character	Period.PeriodReportingPeriod	Reporting GL Period
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tcStatusPeriodCalc	character	calculated	Status of the period, calculated field
tcPeriodTypeCalc	character	calculated	PeriodTypeCalc
ttPeriodStartDate	date	Period.PeriodStartDate	Start Date
ttPeriodEndDate	date	Period.PeriodEndDate	End Date
tlPeriodIsPostingGLAllowed	logical	Period.PeriodIsPostingGLAllowed	GL
tlPeriodIsPostingPurchAllow	logical	Period.PeriodIsPostingPurchAllow	Purchases
tlPeriodIsPostingSalesAllow	logical	Period.PeriodIsPostingSalesAllow	Sales
tlPeriodIsPostingInvAllowed	logical	Period.PeriodIsPostingInvAllowed	Inventory
tlPeriodIsPostingPCAllowed	logical	Period.PeriodIsPostingPCAllowed	Periodic Costing
tlPeriodIsPostingOtherAllow	logical	Period.PeriodIsPostingOtherAllow	Other
tlPeriodIsReportChecked	logical	Period.PeriodIsReportChecked	Checked/Reported
tiPeriodYearPeriod	integer	Period.PeriodYearPeriod	GL Calendar Year/GL Period
ttPeriodClosingDate	date	Period.PeriodClosingDate	Closing Date
tiPeriodMark_ID	integer	Period.PeriodMark_ID	Mark
tiCompany_ID	integer	Period.Company_ID	Link to Company
tiPeriod_ID	integer	Period.Period_ID	Record ID
tcPeriodTypeCode	character	Period.PeriodTypeCode	GL Period Type
tcPeriodStatus	character	Period.PeriodStatus	Status
PeriodCustom	character	calculated	custom fields
CMaskCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Period),rowid(CMask)

Internal usage

QadFinancials

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.