API query PeriodForBLFUnitTest

Description

Please don't remove this query. It is used by the BLF unit tests. As soon as a real entity neutral query was defined, we will use that one and delete this one ourselves..

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodEndDate	t	=,>=,>,<>,<=,<
tPeriod.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod.PeriodStartDate	t	=,>=,>,<>,<=,<
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<
tPosting.PostingVoucher	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each Period where

Period.Company_Id = iiCompanyId AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = Period.Company_ID AND

each Posting (inner-join) where

Posting.Company_Id = iiCompanyId AND
Posting.Period_ID = Period.Period_ID AND

first Journal (inner-join) where

Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.Journal_ID = Posting.Journal_ID AND

query resultset tqPeriodForBLFUnitTest

field name	data type	db field	description
tiPeriod_ID	integer	Period.Period_ID	Record ID
ttPeriodStartDate	date	Period.PeriodStartDate	Start Date
ttPeriodEndDate	date	Period.PeriodEndDate	End Date
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiPostingVoucher	integer	Posting.PostingVoucher	Voucher is a sequential number that uniquely identifies the journal entry (within the combination of an entity and a daybook code).
	api annotation:		In create mode,enter 0 in this field - the voucher number is generated by the system. In Modify/Delete, the correct voucher number must be entered because this identifies the record.
tcCompanyCode	character	Company.CompanyCode	Entity Code
PeriodCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
PostingCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Period),rowid(Company),rowid(Posting),rowid(Journal)

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 = "BPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "PeriodForBLFUnitTest".
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.periodforblfunittest.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.