project QadFinancials > class BJournal > API query JournalLayerForMFG

Description

This query returns some journal information based on journal code, journal control, journal type and layer type.


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
icLayerTypec=
icJournalTypeCodec=
icJournalControlc=
iiCompanyIdi
icJournalCodec=
tJournal.JournalCodec=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalControlc=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalTypeCodec=,>=,>,<>,<=,<,begins,can-do,matches
tLayer.LayerCodec=,>=,>,<>,<=,<,begins,can-do,matches
tLayer.LayerTypeCodec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


icLayerTypecharacterLayer Type
icJournalTypeCodecharacterJournal Type Code
icJournalControlcharacterJournal Control
iiCompanyIdintegerCompany id that will determine the shared set where the journal needs to belong to.
icJournalCodecharacterJournal Code


query condition


  each Journal where
Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.JournalControl = icJournalControl AND
Journal.JournalTypeCode = icJournalTypeCode AND
Journal.JournalCode = icJournalCode

      first Layer (inner-join) where
Layer.Layer_ID = Journal.Layer_ID AND
Layer.LayerTypeCode = icLayerType


query resultset tqJournalLayerForMFG


field namedata typedb fielddescription
tcJournalCodecharacterJournal.JournalCodeA daybook code (maximum eight characters).
tcJournalControlcharacterJournal.JournalControlA type of daybook control: Financial/Operational/External-used to clearly separate postings based on their source.
tcJournalTypeCodecharacterJournal.JournalTypeCodeA daybook type code.
api annotation:Value for this field defaults to "Journal Entries".
tcLayerCodecharacterLayer.LayerCodeLayer Code
tcLayerTypeCodecharacterLayer.LayerTypeCodeLayer Type
JournalCustomcharactercalculatedcustom fields
LayerCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Journal),rowid(Layer)


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 = "JournalLayerForMFG".
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.journallayerformfg.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.