project QadFinancials > class BFRWTreeView > method ApiCubePostingHist

Parameters

Internal usage

program code (program4/bfrwtreeview.p)

/* This api method is created for retrieving PostingHist records for each Cube Dim */

assign oiReturnStatus = 0.

empty temp-table tqApiCubePostingHist.
/* Get Report Year Range. */ 
for each tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportYear':U:
    if tFilter.tcOperator = '=':U then
    do:
        assign viReportYearFrom = int(tFilter.tcParameterValue)
               viReportYearTill = int(tFilter.tcParameterValue).
    end.
    else if tFilter.tcOperator = '>=':U then
    do:
        assign viReportYearFrom = int(tFilter.tcParameterValue).
    end.
    else if tFilter.tcOperator = '<=':U then
    do:
        assign viReportYearTill = int(tFilter.tcParameterValue).
        delete tFilter.
    end.
end.
/* Get Report Period Range. */ 
for each tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U:
    if tFilter.tcOperator = '=':U then
    do:
        assign viReportPeriodFrom = int(tFilter.tcParameterValue)
               viReportPeriodTill = int(tFilter.tcParameterValue).
    end.
    else if tFilter.tcOperator = '>=':U then
    do:
        assign viReportPeriodFrom = int(tFilter.tcParameterValue).
    end.
    else if tFilter.tcOperator = '<=':U then
    do:
        assign viReportPeriodTill = int(tFilter.tcParameterValue).
    end.
end.

for each tFilter where tFilter.tcBusinessFieldName = 'iiCompanyID':U : 
     delete tFilter. 
end. 

<Q-11 run CubeDimForPostingHist  (Start) in BCubeQuery>

if viReportYearFrom = viReportYearTill then
do:
    /* The API Query will retrieve the data from PostingHist table*/
    <Q-41 run api/bcubequery/cubedimforpostinghist.p
       (input  ? (icApiLogin), 
        input  ? (icApiPassword), 
        input  ? (icApiExtra), 
        input  viSessionID (iiApiSessionId), 
        input  'A':U (icRange), 
        input  ? (icRowid), 
        input  0 (iiRowNum), 
        input  0 (iiNumber), 
        input  '':U (icSortColumns), 
        input  false (ilCountOnly), 
        input  yes (ilForwardRead), 
        input  0 (iiMaximumBrowseRecordsToCount), 
        input  dataset tFilter (izFilterDS), 
        output viApiQueryCount (oiCount), 
        output vlEndofQuery (olEndOfQuery), 
        output dataset tCubeDimForPostingHist (ozResultsetDS), 
        output dataset tFcMessages (ozFcMessagesDS), 
        output viFcReturnSuper (oiReturnStatus))>
    
    for each tCubeDimForPostingHist:
        create tqApiCubePostingHist.
        buffer-copy tCubeDimForPostingHist to tqApiCubePostingHist.
    end.
end.
else
do:
    /* only keep one Period parameter. */
    find first tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U and tFilter.tcOperator = '<=':U no-error.
    if available tFilter then delete tFilter.

    do viReportYear = viReportYearFrom to viReportYearTill by 1:
        find first tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportYear':U no-error.
        if available tFilter then
        do:
            assign tFilter.tcOperator = '=':U
                   tFilter.tcParameterValue = string(viReportYear).
            if viReportYearFrom = viReportYear then
            do:
               /* build period range */
               find first tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U no-error. 
               if available tFilter then           
                assign tFilter.tcParameterValue = string(viReportPeriodFrom)
                       tFilter.tcOperator = '>=':U.
            end.
            else if viReportYearTill = viReportYear then
            do:
                /* build period range */
                find first tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U no-error. 
                if not available tFilter then
                    create tFilter.       
                assign tFilter.tcParameterValue = string(viReportPeriodTill)
                       tFilter.tcOperator = '<=':U
                       tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U
                       tFilter.tcDataType = 'i':U.      
            end.
            else do:
               for each tFilter where tFilter.tcBusinessFieldName = 'tFRWCubeMeas.FRWCubeMeasReportPeriod':U:
                    delete tFilter.
               end.
            end. 
        end.
        /* The API Query will retrieve the data from PostingHist table*/
        <Q-95 run api/bcubequery/cubedimforpostinghist.p
           (input  ? (icApiLogin), 
            input  ? (icApiPassword), 
            input  ? (icApiExtra), 
            input  viSessionID (iiApiSessionId), 
            input  'A':U (icRange), 
            input  ? (icRowid), 
            input  0 (iiRowNum), 
            input  0 (iiNumber), 
            input  '':U (icSortColumns), 
            input  false (ilCountOnly), 
            input  yes (ilForwardRead), 
            input  0 (iiMaximumBrowseRecordsToCount), 
            input  dataset tFilter (izFilterDS), 
            output viApiQueryCount (oiCount), 
            output vlEndofQuery (olEndOfQuery), 
            output dataset tCubeDimForPostingHist (ozResultsetDS), 
            output dataset tFcMessages (ozFcMessagesDS), 
            output viFcReturnSuper (oiReturnStatus))>
            
        for each tCubeDimForPostingHist:
            create tqApiCubePostingHist.
            buffer-copy tCubeDimForPostingHist to tqApiCubePostingHist.
        end.
    end.
end.
<Q-14 run CubeDimForPostingHist  (Stop) in BCubeQuery>

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 = "BFRWTreeView".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiCubePostingHist".
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/bfrwtreeview.apicubepostinghist.i.xsd", ?).
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.