project QadFinancials > class BCreditorReport > method ApiGetAlternateKeyValues

Description

This procedure can be used to convert filtering conditions (on browses or reports) on primary key fields into filtering conditions on alternate key fields, which are more readable. This procedure will for example convert a language ID (which is a meaningless number) into a language code. Conversion rules are generated based on the definition of related key business fields in the business class.


Parameters


tFilterinputtemp-tableinput dataset with filter conditions
tBusinessFieldValuesoutputtemp-tableoutput dataset with converted displayable filter conditions
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program/bcreditorreport.p)

<ANCESTOR-CODE>

find tFilter where
     tFilter.tcBusinessFieldName = "tCInvoice.Creditor_ID":U
     no-error.

if available tFilter
then do:
    <Q-1 run CreditorPrim (all) (Read) (NoCache)
       (input ?, (CompanyId)
        input int(tFilter.tcParameterValue), (CreditorId)
        input ?, (CreditorCode)
        output dataset tqCreditorPrim) in BCreditor >

    find first tqCreditorPrim where
               tqCreditorPrim.tiCreditor_ID = int(tFilter.tcParameterValue)
               no-error.

    if available tqCreditorPrim
    then do:
        create tBusinessFieldValues.

        assign tBusinessFieldValues.tcBusinessFieldName  = "CreditorCode_CANDO":U
               tBusinessFieldValues.tcBusinessFieldValue = tqCreditorPrim.tcCreditorCode.
    end.
end.


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 = "BCreditorReport".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetAlternateKeyValues".
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 = "".

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