project BLF > class BScanDaemonPerfWorkItem > method ApiProcessSingleScanDaemonQueue
Description
ApiProcessSingleScanDaemonQueue: this api-method will perform all actions needed to handle a single entry in the scna-daemon queue
Parameters
| icClassShortName | input | character | ClassShortName |
| icFileShortName | input | character | FileShortName |
| icFileFullName | input | character | FileFullName |
| icFileRenamed | input | character | FileRenamed |
| icCreatorUsrLogin | input | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
BLF
program code (program6/bscandaemonperfworkitem.p)
/* ========================= */
/* Validate input parameters */
/* ========================= */
assign vcMsgScanP = "".
if icClassShortName = "" or
icClassShortName = ?
then assign vcMsgScanP = vcMsgScanP + chr(10) + trim(subst(#T-16''&1' is missing.':255(391)T-16#, trim(#T-17'Class short name':40(392)t-17#))).
if icFileFullName = "" or
icFileFullName = ?
then assign vcMsgScanP = vcMsgScanP + chr(10) + trim(subst(#T-18''&1' is missing.':255(391)T-18#, trim(#T-19'File Full Path Name':40(393)T-19#))).
if icFileRenamed = "" or
icFileRenamed = ?
then assign vcMsgScanP = vcMsgScanP + chr(10) + trim(subst(#T-20''&1' is missing.':255(391)T-20#, trim(#T-21'Renamed File Name':40(394)T-21#))).
if icFileShortName = "" or
icFileShortName = ?
then assign vcMsgScanP = vcMsgScanP + chr(10) + trim(subst(#T-22''&1' is missing.':255(391)T-22#, trim(#T-23'File short name':40(395)t-23#))).
if vcMsgScanP <> ""
then do:
assign vcMsgScanP = trim(subst(#T-24'Some mandatory input is missing for method '&1'.':255(396)T-24#, "BScanDaemonPerfWorkItem.ApiProcessSingleScanDaemonQueue")) + vcMsgScanP
oiReturnStatus = -1.
<M-1 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-196':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
/* ===================== */
/* Create draft instance */
/* ===================== */
/* Start the instance */
<M-2 run BusinessClassActions
(input icClassShortName (icClassShortname),
input 'START+OPEN' (icAction),
input false (ilSubtransaction),
input-output viOpenC (biClassOpenCount),
input-output vhDatabaseFromScanDmnInst (bhClassInstanceHandle),
input-output viDatabaseFromScanDmnID (biClassInstanceId),
input '' (icDraftReference),
input '' (icUserDefinedContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
if viFcReturnSuper < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then do:
assign vcMsgScanP = trim(subst(#T-25'An internal error has occurred while performing action '&1' on class '&2'.':255(397)T-25#, "Start+Open", icClassShortName)).
<M-3 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-197':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
assign viDatabaseInstanceID = viDatabaseFromScanDmnID.
/* Set activity to Create */
<M-46 run SetPublicData
(input 'vcActivityCode' (icDataList),
input 'Create' (icValueList),
output viFcReturnSuper (oiReturnStatus)) in database>
if viFcReturnSuper < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then do:
assign vcMsgScanP = trim(subst(#T-45'An internal error has occurred while performing action '&1' on class '&2'.':255(397)T-45#, "SetPublicData", icClassShortName)).
<M-47 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-446':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
/* Create a new instance */
<M-4 run DataNew (output viFcReturnSuper (oiReturnStatus)) in database>
if viFcReturnSuper = 0
then do:
assign vcPK = ""
vcAK = ""
vcDummy = ""
viObjectID = 0.
<M-44 run ApiGetIdentification
(input-output vcPK (bcPrimaryKey),
input-output vcAK (bcAlternateKey),
input-output vcDummy (bcRowid),
input-output viObjectID (biObjectId),
output vcDummy (ocObjectStatusValues),
output vcDummy (ocObjectStatusFieldNames),
output vcDummy (ocPrimaryKeyFieldNames),
output vcDummy (ocAlternateKeyFieldNames),
output vcDummy (ocAlternateKeyFieldLabels),
output viFcReturnSuper (oiReturnStatus)) in database>
end.
if viFcReturnSuper < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then do:
assign vcMsgScanP = trim(subst(#T-27'An internal error has occurred while creating a draft instance for class '&1'.':255(399)T-27#, icClassShortName)) + chr(10) +
trim(subst(#T-28'Error number: &1.':255(400)T-28#, string(oiReturnStatus))).
<M-8 run BusinessClassActions
(input icClassShortName (icClassShortname),
input 'CLOSE+STOP' (icAction),
input false (ilSubtransaction),
input-output viOpenC (biClassOpenCount),
input-output vhDatabaseFromScanDmnInst (bhClassInstanceHandle),
input-output viDatabaseFromScanDmnID (biClassInstanceId),
input '' (icDraftReference),
input '' (icUserDefinedContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
if viFcReturnSuper < 0
then assign vcMsgScanP = vcMsgScanP + chr(10) +
trim(subst(#T-29'Error number on action '&1': &2.':255(401)T-29#, "Close+Stop", string(viFcReturnSuper))).
assign vcMsgScanP = trim(subst(#T-30'An internal error has occurred while getting the object ID of class '&1' based on '&2'.':255(398)T-30#, icClassShortName, vcDummy)).
<M-9 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-198':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
/* Create the draft instance */
<M-10 run BusinessClassActions
(input icClassShortName (icClassShortname),
input 'STORE' (icAction),
input false (ilSubtransaction),
input-output viOpenC (biClassOpenCount),
input-output vhDatabaseFromScanDmnInst (bhClassInstanceHandle),
input-output viDatabaseFromScanDmnID (biClassInstanceId),
input 'Work-object ' + icClassShortName (icDraftReference),
input '' (icUserDefinedContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
if viFcReturnSuper < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then do:
assign vcMsgScanP = trim(subst(#T-31'An internal error has occurred while performing action '&1' on class '&2'.':255(397)T-31#, "Store", icClassShortName)).
<M-11 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-199':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
/* =========================== */
/* Link Document to new object */
/* =========================== */
if viObjectId <> 0 and
viObjectId <> ?
then do:
assign vhFcComponent = ?.
<M-12 run SerializeAndStoreDocument
(input icClassShortName (icBusinessComponent),
input viObjectID (iiObjectId),
input icFileShortName (icFileName),
input icFileRenamed (icFullPath),
output viDummy (oiDocumentLinkID),
output viFcReturnSuper (oiReturnStatus)) in BDocumentLink>
if viFcReturnSuper < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then do:
assign vcMsgScanP = trim(subst(#T-32'An error has occurred while storing document '&1' on class '&2'.':255(402)T-32#, icFileFullName, icClassShortName)) + chr(10) +
trim(subst(#T-33'Renamed file name: &1.':255(403)T-33#, icFileRenamed)) + chr(10) +
trim(subst(#T-34'Error number: &1.':255(400)T-34#, string(oiReturnStatus))).
<M-13 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-200':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
end.
os-delete value(icFileRenamed).
end.
/* ================= */
/* Create workobject */
/* ================= */
<I-42 {bFcStartAndOpenInstance
&CLASS = "BWorkObject"}>
<M-15 run CreateDraftWorkObject
(input icClassShortName (icBusinessComponent),
input viDatabaseInstanceID (iiInstanceId),
input icFileShortName (icDocumentName),
input icCreatorUsrLogin (icCreatorUsrLogin),
input (if vcAK = '' or vcAK = ? then vcPK else vcAK) (icObjectReference),
output viKeepReturn (oiReturnStatus)) in BWorkObject>
<I-43 {bFcCloseAndStopInstance
&CLASS = "BWorkObject"}>
if viKeepReturn < 0 or
oiReturnStatus = 0
then assign oiReturnStatus = viKeepReturn.
if viKeepReturn < 0
then do:
assign vcMsgScanP = trim(subst(#T-35'An error has occurred while creating a work object for document '&1' on class '&2'.':255(404)T-35#, icFileShortName, icClassShortName)) + chr(10) +
trim(subst(#T-36'Instance ID: &1.':255(405)T-36#, string(viDatabaseInstanceID))) + chr(10) +
trim(subst(#T-37'Error number: &1.':255(400)T-37#, string(oiReturnStatus))).
<M-14 run SetMessage
(input vcMsgScanP (icMessage),
input '' (icArguments),
input '' (icFieldName),
input '' (icFieldValue),
input 'E' (icType),
input 3 (iiSeverity),
input '' (icRowid),
input 'BLF-201':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BScanDaemonPerfWorkItem>
return.
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 = "BScanDaemonPerfWorkItem".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "ApiProcessSingleScanDaemonQueue".
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/bscandaemonperfworkitem.apiprocesssinglescandaemonqueue.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icClassShortName = <parameter value>
vhParameter::icFileShortName = <parameter value>
vhParameter::icFileFullName = <parameter value>
vhParameter::icFileRenamed = <parameter value>
vhParameter::icCreatorUsrLogin = <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.