project QadFinancials > class BQBudgetActual > method ApiCreateQBudgetLinkActual

Description

Method that will create QBudgetLinkActual records based on the input table of this method.
Do note that this is an api methods: it takes care about all validations and saves the data: this also implicates that this can only be called once within a single transaction.


Parameters


tNewQBudgetLinkActualinputtemp-tableNewQBudgetLinkActual; table containing the information of the new records that shoudl be created.
Do note that the TC field should match: Debit - Credit
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


QadFinancials
method BBudgetRebuild.ApiRebuildBudget
method BPosting.AdditionalUpdatesBQBudgetActual


program code (program9/bqbudgetactual.p)

/* ================================================================ */
    /* Return if no data is passed                                      */
    /* ================================================================ */
    if not can-find (first tNewQBudgetLinkActual) 
    then return.
    
    /* ================================================================ */
    /* Set Return-status = Default-error                                */
    /* ================================================================ */
    assign oiReturnStatus = -98.
    
    /* ================================================================ */
    /* Empty the instance                                               */
    /* ================================================================ */
    <M-1 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Go through the input and create a record for every input-record  */
    /* ================================================================ */
    <Q-8 run PostingLineByCyPostingLineID  (Start) in BPosting >
    for each tNewQBudgetLinkActual : 
        <M-2 run AddDetailLine (input  'QBudgetLinkActual':U (icTable), 
                        input  '':U (icParentRowid), 
                        output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
        if viFcReturnSuper <> 0 
        then do :
            assign oiReturnStatus = viFcReturnSuper.
            if viFcReturnSuper < 0 
            then return.
        end.  /* if viFcReturnSuper <> 0 */
        buffer-copy tNewQBudgetLinkActual
                    except  tc_rowid 
                            tc_parentrowid
                            tc_status
                            QBudgetLinkActual_ID
                    to tQBudgetLinkActual.
        /* ================================================================================= */
        /* Fill the info-field with Posting-information (year/number/Jrnl) if not yet filled */
        /* ================================================================================= */
        if tQBudgetLinkActual.BudgetLinkActualInfo = "":U or 
           tQBudgetLinkActual.BudgetLinkActualInfo = ?
        then 
            if tQBudgetLinkActual.PostingLine_ID <> 0 and 
               tQBudgetLinkActual.PostingLine_ID <> ?
            then do :
                <Q-6 run PostingLineByCyPostingLineID (all) (Read) (Cache)
          (input ?, (CompanyId)
           input tQBudgetLinkActual.PostingLine_ID, (PostingLine_ID)
           output dataset tqPostingLineByCyPostingLineID) in BPosting >
                find first tqPostingLineByCyPostingLineID where 
                           tqPostingLineByCyPostingLineID.tiPostingLine_ID = tQBudgetLinkActual.PostingLine_ID
                           no-lock no-error.
                if available tqPostingLineByCyPostingLineID
                then assign tQBudgetLinkActual.BudgetLinkActualInfo = string(tqPostingLineByCyPostingLineID.tiPeriodYear,"9999":U) + "/":U + string(tqPostingLineByCyPostingLineID.tiPeriodPeriod,"99":U) + "/":U + trim(tqPostingLineByCyPostingLineID.tcJournalCode) + "/":U + string(tqPostingLineByCyPostingLineID.tiPostingVoucher).
                else assign tQBudgetLinkActual.BudgetLinkActualInfo = string(tQBudgetLinkActual.PostingLine_ID).
            end. /* tQBudgetLinkActual.PostingLine_ID <> 0 */
            else assign tQBudgetLinkActual.BudgetLinkActualInfo = "?":U.
    end. /* for each tNewQQBudgetLinkActual */
    <Q-7 run PostingLineByCyPostingLineID  (Stop) in BPosting >
            
    /* ================================================================ */
    /* Perfom Validation, AdditionalUpdates and DataSave                */
    /* ================================================================ */
    <M-3 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-4 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    <M-5 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BQBudgetActual>
    if viFcReturnSuper <> 0 
    then do :
        assign oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0 
        then return.
    end.  /* if viFcReturnSuper <> 0 */
    
    /* ================================================================ */
    /* Set Return-status = OK                                           */
    /* ================================================================ */
    if oiReturnStatus = -98
    then assign oiReturnStatus = 0.


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 = "BQBudgetActual".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiCreateQBudgetLinkActual".
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/bqbudgetactual.apicreateqbudgetlinkactual.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tNewQBudgetLinkActual").
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.