method ApiClearDaemonQueue

Description

ApiClearDaemonQueue; this Api-method allows users to clean-up a Queue of a certain daemon (identified by its ID or Name).
A set of input parameters allows the user to specify the details of the clean-up action.

General remarks;
This method starts by cleaning everything that was in this instance to make sure we start from scratch. This method also contains a DateSave; this implies that this code will be committed in case this component was started with &AddToTransAction=True
In case only Warnings (ReturnStatus>0) are created then
- the transaction will be committed,
- the warnings will be retuned to the caller via FcMessages

Parameters

ilDeleteWaiting	input	logical	Delete DaemonQueue records with status Waiting
ilDeleteInProcess	input	logical	Delete DaemonQueue records with status InProcess
ilDeleteProcessedOk	input	logical	Delete DaemonQueue records with status Processed-Ok
ilDeleteProcessedErr	input	logical	Delete DaemonQueue records with status Processed-Err
olDeletesExecuted	output	logical	Deletes Executed ? (Yes/No)
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bbasedaemon.p)

/* ================================= */
/* Find information about the Daemon */
/* ================================= */
<Q-9 run DaemonInfoLimited (all) (Read) (NoCache)
   (input ?, (DaemonId)
    input vcFcDaemonName, (DaemonName)
    input ?, (DaemonStatus)
    input ?, (DaemonStatusDiffersFrom)
    output dataset tqDaemonInfoLimited) in BBaseDaemon >
find first tqDaemonInfoLimited no-lock no-error.
if not available tqDaemonInfoLimited
then do:
    assign vcBaseDaemonMsg = trim(#T-7'This daemon has not yet been configured. You must configure the daemon before it can be started or monitored.':255(50)T-7#)
           oiReturnStatus  = 2.
    <M-6 run SetMessage
          (input  vcBaseDaemonMsg (icMessage), 
           input  '':U (icArguments), 
           input  '':U (icFieldName), 
           input  '':U (icFieldValue), 
           input  'W':U (icType), 
           input  4 (iiSeverity), 
           input  '':U (icRowid), 
           input  'BLF-4':U (icFcMsgNumber), 
           input  '' (icFcExplanation), 
           input  '' (icFcIdentification), 
           input  '' (icFcContext), 
           output viFcReturnSuper (oiReturnStatus)) in BBaseDaemon>
    return.
end.

/* =============================== */
/* Call the method in BDaemonQueue */
/* =============================== */
<M-8 run StopExternalInstances
   (output oiReturnStatus (oiReturnStatus)) in BBaseDaemon>
<I-2 {bFcStartAndOpenInstance
            &ADD-TO-TRANSACTION = "false"
            &CLASS              = "BBaseDaemonQueue"}>
<M-3 run ApiClearDaemonQueue
   (input  tqDaemonInfoLimited.tiDaemonId (iiDaemonID), 
    input  tqDaemonInfoLimited.tcDaemonName (icDaemonName), 
    input  ilDeleteWaiting (ilDeleteWaiting), 
    input  ilDeleteInProcess (ilDeleteInProcess), 
    input  ilDeleteProcessedOk (ilDeleteProcessedOk), 
    input  ilDeleteProcessedErr (ilDeleteProcessedErr), 
    output olDeletesExecuted (olDeletesExecuted), 
    output viFcReturnSuper (oiReturnStatus)) in BBaseDaemonQueue>
<I-4 {bFcCloseAndStopInstance
            &CLASS           = "BBaseDaemonQueue"}>

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 = "BBaseDaemon".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiClearDaemonQueue".
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/bbasedaemon.apicleardaemonqueue.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::ilDeleteWaiting = <parameter value>
       vhParameter::ilDeleteInProcess = <parameter value>
       vhParameter::ilDeleteProcessedOk = <parameter value>
       vhParameter::ilDeleteProcessedErr = <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.