API query JournalByDomain

Description

The purpose of the query is to allow the daybook set maintenance functions to validate daybooks when the daybook set type is set to AP.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icJournalCode	c	=
icDomainCode	c	=
icJournalTypeCode	c	=
iiJournalID	i	=
tDomains.DomainCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalControl	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalIsActive	l	=,<>
tJournal.JournalTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icJournalCode	character	The Daybook Code
icDomainCode	character	The domain in which the query is being run
icJournalTypeCode	character	The Daybook Type
iiJournalID	integer

query condition

each Journal where

Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.JournalCode = icJournalCode AND
Journal.Journal_ID = iiJournalID AND
Journal.JournalTypeCode = icJournalTypeCode

first SharedSet (inner-join) where

SharedSet.SharedSet_ID = Journal.SharedSet_ID AND

each DomainSharedSet (inner-join) where

DomainSharedSet.SharedSet_ID = SharedSet.SharedSet_ID AND

first Domains (inner-join) where

Domains.Domain_ID = DomainSharedSet.Domain_ID AND
Domains.DomainCode = icDomainCode

query resultset tqJournalByDomain

field name	data type	db field	description
tcDomainCode	character	Domains.DomainCode	Domain
tiJournal_ID	integer	Journal.Journal_ID	Record ID
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tcJournalControl	character	Journal.JournalControl	A type of daybook control: Financial/Operational/External-used to clearly separate postings based on their source.
tcJournalDescription	character	Journal.JournalDescription	A brief description of the daybook.
	api annotation:		Value for this field defaults to null.
tlJournalIsActive	logical	Journal.JournalIsActive	Indicate if this is an active daybook.
	api annotation:		Value for this field defaults to false.
tcJournalTypeCode	character	Journal.JournalTypeCode	A daybook type code.
	api annotation:		Value for this field defaults to "Journal Entries".
JournalCustom	character	calculated	custom fields
DomainsCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Journal),rowid(SharedSet),rowid(DomainSharedSet),rowid(Domains)

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 = "BJournal".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "JournalByDomain".
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/bjournal.journalbydomain.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.