project QadFinancials > class BJournal > method ApiLoadJournal

Description

This method will return all journal records for the sharedset of the company that was passed as input parameter. If the company parameter is left blank, all journals are returned.


Parameters


iiCompanyIdinputintegerCompany ID
tApiJournaloutputtemp-tableTemp-table defined like journal to return the journals for the selected company.
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program9/bjournal.p)

assign oiReturnStatus = -98
       viLocalStatus  = 0.

empty temp-table tApiJournal.

<Q-57 run JournalForExcelNoRole (all) (Read) (NoCache)
   (input iiCompanyId, (CompanyId)
    output dataset tqJournalForExcelNoRole) in BJournal >

/* Create tApiJournal records */
for each tqJournalForExcelNoRole:
    create tApiJournal.
    <M-52 run BufferCopy
       (input  buffer tqJournalForExcelNoRole:handle (ihFrom), 
        input  buffer tApiJournal:handle (ihTo), 
        output viFcReturnSuper (oiReturnStatus)) in BJournal>
end.

<Q-85 run UsrRoleByUsrId (all) (Read) (NoCache)
   (input viUsrId, (UsrId)
    input iiCompanyId, (CompanyId)
    output dataset tqUsrRoleByUsrId) in BUserRole >

for each  tqUsrRoleByUsrId
    where tqUsrRoleByUsrId.tiUsr_ID = viUsrId and
          tqUsrRoleByUsrId.tiCompany_ID = viCompanyId:  

    <Q-3 run JournalForExcel (all) (Read) (NoCache)
       (input iiCompanyId, (CompanyId)
        input tqUsrRoleByUsrId.tiRole_ID, (RoleID)
        output dataset tqJournalForExcel) in BJournal >

    /* Create tApiJournal records */
    for each tqJournalForExcel:
        create tApiJournal.
        <M-2 run BufferCopy
           (input  buffer tqJournalForExcel:handle (ihFrom), 
            input  buffer tApiJournal:handle (ihTo), 
            output viFcReturnSuper (oiReturnStatus)) in BJournal>
        if viFcReturnSuper <  0 or 
           viFcReturnSuper <> 0 and 
           viLocalStatus   =  0
        then assign viLocalStatus = viFcReturnSuper.
    end.
end.

assign oiReturnStatus = viLocalStatus.


Sample code: how to call this method 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 = "ApiLoadJournal".
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.apiloadjournal.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiCompanyId = <parameter value>.

/* 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.