method ApiSetGLMasksInitialise

Description

ApiSetGLMasksInitialise; this method will initialise the temp-table that is used as input for method ApiSetGLMasks.

After calling this method, you can call method ApiSetGLMasks and be sure that ApiSetGLMasks will only use the content of the input temp-table of ApiSetGLMasks.

Normaly, this Api-method will be called after calling Api-method 'ApiGetGLMaskCombinations' that returns the same temp-table as isused as input by this method.

Only the records in this temp-table with field 'tcStatus' equal to 'N' (new) or 'D' (delete) will be handled.
If tcStatus=D then field tiGLMaskID should be filled as well. If tcStatus=N then the ID-fields will be discarded and the Code-fields will be used for the creation.
Records with a value for field 'tcStatus' that differs from these values, will be discarded.

Note that this api-method will start by clearing all instance-data.

Do also note that field 'tlSelected' is of no use here.

Parameters

oiReturnStatus

output

integer

Return status of the method.

Internal usage

unused

program code (program9/bglmask.p)

/* ==================================================================================== */
    /* Make sure the temp-table that is used as input for method ApiSetGLMasks gets cleared */
    /* ==================================================================================== */
    empty temp-table tSetGLMaskCombinations.

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