Parameters
| tApiSafConcept | input | temp-table | |
| icAction | input | character | |
| ocLstPrimKey | output | character | |
| ocLstReturn | output | character | |
| ocLstRowId | output | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program7/bsafconcept.p)
/* ================================================== */
/* Method info: */
/* SafConcept will be loaded based on the logical key */
/* ================================================== */
/* ============================================================================= */
/* Clear the instance: */
/* this will also clear the t_s tables that where filled in ApiMaintainByDataset */
/* ============================================================================= */
<M-1 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if oiReturnStatus < 0
then return.
/* ==================== */
/* Set default return */
/* Parameter validation */
/* ==================== */
Assign oiReturnStatus = -98
vlDraftInstanceCreated = false.
if icAction = ?
then assign icAction = '':U.
if icAction <> {&DAEMONACTION-SAVESTORE} and
icAction <> {&DAEMONACTION-SAVE} and
icAction <> {&DAEMONACTION-STORE} and
icAction <> {&DAEMONACTION-VALIDATE}
then do:
assign vcSafConceptMsg = trim(subst(#T-2'SAF concept integration: the specified action &1 should be in the list &2.':255(14454)t-2#,
trim(icAction),
"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-STORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-VALIDATE}":U))
oiReturnStatus = -1.
<M-3 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3331':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
return.
end. /*if icAction <> {&DAEMONACTION-SAVESTORE} and*/
/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiSafConcept no-lock:
assign viMainTableRecordCount = viMainTableRecordCount + 1.
end.
if viMainTableRecordCount = 0
then do:
assign vcSafConceptMsg = trim(#T-4'SAF concept integration: no main SAF concept table records can be found.':255(14455)t-4#)
oiReturnStatus = -1.
<M-5 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3338':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
return.
end. /*if viMainTableRecordCount = 0*/
/* ============= */
/* Start queries */
/* ============= */
<Q-6 run SafConceptPrim (Start) in BSafConcept >
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiSafConcept by tApiSafConcept.tc_Rowid:
main-block: do:
/* ========== */
/* Initialize */
/* ========== */
assign vcSafConceptMsg = '':U
vcRowId = '':U
vlWarningsFound = false
vlSaveAsDraft = icAction = {&DAEMONACTION-STORE}.
/* ============================================== */
/* Get the SafConcept_ID based on the logical key */
/* ============================================== */
if (tApiSafConcept.SafConcept_ID = ? or
tApiSafConcept.SafConcept_ID = 0) and
tApiSafConcept.SafConceptCode <> ? and
tApiSafConcept.SafConceptCode <> '':U
then do:
<Q-7 run SafConceptPrim (all) (Read) (NoCache)
(input ?, (SafConceptID)
input tApiSafConcept.SafConceptCode, (SafConceptCode)
output dataset tqSafConceptPrim) in BSafConcept >
find tqSafConceptPrim where
tqSafConceptPrim.tcSafConceptCode = tApiSafConcept.SafConceptCode
no-lock no-error.
if available tqSafConceptPrim
then assign tApiSafConcept.SafConcept_ID = tqSafConceptPrim.tiSafConcept_ID.
end. /* if (tApiSafConcept.SafConcept_ID = ? or */
/* ====================== */
/* Load/Create SafConcept */
/* ====================== */
if tApiSafConcept.SafConcept_ID = ? or
tApiSafConcept.SafConcept_ID = 0
then assign viFcReturnSuper = -4.
else do:
<M-8 run DataLoad (input ? (icRowids),
input string(tApiSafConcept.SafConcept_ID) (icPkeys),
input ? (icObjectIds),
input ? (icFreeform),
input false (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
end. /* NOT if tApiSafConcept.SafConcept_ID = ? or */
if viFcReturnSuper = -4
then do:
assign viFcReturnSuper = 0.
<M-9 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
if viFcReturnSuper < 0
then assign vcSafConceptMsg = trim(subst(#T-10'Cannot create a new instance. Error number &1.':255(14463)t-10#,string(viFcReturnSuper))).
find first tSafConcept no-error.
end. /* if viFcReturnSuper = -4 */
else do:
if viFcReturnSuper < 0
then assign vcSafConceptMsg = trim(subst(#T-11'Cannot load the instance. Error number &1.':255(14464)t-11#,string(viFcReturnSuper))).
else do:
find tSafConcept where
tSafConcept.SafConcept_ID = tApiSafConcept.SafConcept_ID
no-lock no-error.
if not available tSafConcept
then assign vcSafConceptMsg = trim(subst(#T-12'Cannot find the instance &1 after it has been loaded.':255(14465)t-12#,string(tApiSafConcept.SafConcept_ID))).
else assign tSafConcept.tc_Status = 'C':U.
end. /* NOT if viFcReturnSuper < 0 */
end. /* NOT if viFcReturnSuper = -4 */
/* ====================================== */
/* Check for errors in the previous block */
/* ====================================== */
if vcSafConceptMsg <> '':U
then do:
assign ocLstReturn = ocLstReturn + chr(4) + (if viFcReturnSuper = 0 then '-3':U else string(viFcReturnSuper))
ocLstPrimKey = ocLstPrimKey + chr(4) + '*':U
ocLstRowId = ocLstRowId + chr(4) + '*':U
vlSaveAsDraft = false.
<M-13 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3345':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
leave main-block.
end. /* if vcSafConceptMsg <> '':U */
/* ======================== */
/* Copy data for SafConcept */
/* ======================== */
buffer-copy tApiSafConcept except
SafConcept_ID
SafConceptCode
tc_ParentRowid
tc_Rowid
tc_Status
to tSafConcept.
if tSafConcept.tc_Status = 'N':U
then assign tSafConcept.SafConceptCode = tApiSafConcept.SafConceptCode.
assign vcRowId = tSafConcept.tc_Rowid
tApiSafConcept.SafConcept_ID = tSafConcept.SafConcept_ID.
/*needed to set the prim-key after the save*/
/* =================================================== */
/* This is where it ends if only SaveAsDraft is needed */
/* =================================================== */
if vlSaveAsDraft
then do:
assign ocLstReturn = ocLstReturn + chr(4) + '-1':U
ocLstPrimKey = ocLstPrimKey + chr(4) + '*':U
ocLstRowId = ocLstRowId + chr(4) + '*':U.
leave main-block.
end. /* if vlSaveAsDraft */
/* ============ */
/* Set activity */
/* ============ */
if can-find(first tSafConcept where
tSafConcept.tc_Status = 'N':U)
then assign vcActivityCode = 'Create':U.
else if can-find(first tSafConcept where
tSafConcept.tc_Status = 'C':U)
then assign vcActivityCode = 'Modify':U.
/* ================= */
/* Validate the data */
/* ================= */
<M-14 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + '*':U
ocLstRowId = ocLstRowId + chr(4) + '*':U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and
icAction <> {&DAEMONACTION-VALIDATE}).
leave main-block.
end. /* if viFcReturnSuper < 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* ================ */
/* External updates */
/* ================ */
<M-15 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + '*':U
ocLstRowId = ocLstRowId + chr(4) + '*':U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and
icAction <> {&DAEMONACTION-VALIDATE}).
leave main-block.
end. /* if viFcReturnSuper < 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* ============= */
/* Save the data */
/* ============= */
if icAction <> {&DAEMONACTION-VALIDATE}
then do:
<M-16 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
if viFcReturnSuper < 0
then do:
assign ocLstReturn = ocLstReturn + chr(4) + string(viFcReturnSuper)
ocLstPrimKey = ocLstPrimKey + chr(4) + '*':U
ocLstRowId = ocLstRowId + chr(4) + '*':U
vlSaveAsDraft = (icAction <> {&DAEMONACTION-SAVE} and
icAction <> {&DAEMONACTION-VALIDATE}).
leave main-block.
end. /* if viFcReturnSuper < 0 */
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
end. /* if icAction <> {&DAEMONACTION-VALIDATE} */
/* ============================================ */
/* Indicate that everything was saved correctly */
/* ============================================ */
assign ocLstReturn = ocLstReturn + chr(4) + (if vlWarningsFound then '1':U else '0':U)
ocLstPrimKey = ocLstPrimKey + chr(4) + string(tApiSafConcept.SafConcept_ID)
ocLstRowId = ocLstRowId + chr(4) + vcRowId.
end. /* main-block */
/* ================================================================== */
/* Handle errors: store if SaveAsDraft is needed */
/* Check: only 1 draft is allowed for a single bus-component instance */
/* ================================================================== */
if vlSaveAsDraft and
index(substring(ocLstReturn,r-index(ocLstReturn, chr(4)) + 1, -1, 'CHARACTER':U), '-':U) <> 0
/* negative return-status for this entry */
then do:
if vlDraftInstanceCreated = true
then do:
assign vcSafConceptMsg = trim(#T-17'Only one draft instance can be created per method call.':255(13856)T-17#) +
chr(10) +
trim(#T-18'This second object cannot be stored as a draft instance and so is an error.':255(13879)t-18#).
<M-19 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3346':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
next.
end. /* if vlDraftInstanceCreated = true */
<M-20 run StoreState (input '(':U + string(tsafconcept.SafConceptCode) + ')':U + trim(#T-19'SAF concept created via an API method.':200(14468)T-19#) (icDescription),
input ? (icUIClass),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
assign vlDraftInstanceCreated = true
entry(num-entries(ocLstReturn, chr(4)), ocLstReturn, chr(4)) = string(viFcReturnSuper)
entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(tApiSafConcept.SafConcept_ID)
entry(num-entries(ocLstRowId, chr(4)), ocLstRowId, chr(4)) = vcRowId.
end. /* if vlSaveAsDraft and */
end. /* for each tApiSafConcept by tApiSafConcept.tc_Rowid: */
/* ============ */
/* Stop queries */
/* ============ */
<Q-21 run SafConceptPrim (Stop) in BSafConcept >
/* ============================================================ */
/* Trim the first character of ocLstReturn en primkey */
/* Check for correct number and format of the return parameters */
/* ============================================================ */
if length(ocLstReturn, "CHARACTER":U) > 1
then assign ocLstReturn = substring(ocLstReturn, 2,-1,"CHARACTER":U).
if length(ocLstPrimKey,"CHARACTER":U) > 1
then assign ocLstPrimKey = substring(ocLstPrimKey,2,-1,"CHARACTER":U).
if length(ocLstRowid, "CHARACTER":U) > 1
then assign ocLstRowid = substring(ocLstRowid, 2,-1,"CHARACTER":U).
if num-entries(ocLstReturn, chr(4)) <> viMainTableRecordCount or
num-entries(ocLstPrimKey,chr(4)) <> viMainTableRecordCount or
num-entries(ocLstRowid, chr(4)) <> viMainTableRecordCount
then do :
assign vcSafConceptMsg = trim(#T-22'SAF concept integration: incomplete information returned by an API method. See other messages for further details.':255(14470)T-22#) +
chr(10) +
trim(substitute(#T-23'Main table records: &1.':255(310)T-23#,string(viMainTableRecordCount))) + chr(10) +
trim(substitute(#T-24'Return Statuses: &1.':255(311)T-24#,ocLstReturn)) + chr(10) +
trim(substitute(#T-25'Primary keys: &1.':255(312)T-25#,ocLstPrimKey)) + chr(10) +
trim(substitute(#T-26'Row IDs: &1.':255(313)T-26#,ocLstRowid))
oiReturnStatus = -3.
<M-27 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3348':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
return.
end. /* if num-entries */
/* ===================================================== */
/* Set global return status based on the individual ones */
/* ===================================================== */
if ocLstReturn = substring(fill("0":U + CHR(4),viMainTableRecordCount),1,length(ocLstReturn,"CHARACTER":U),"CHARACTER":U)
then assign oiReturnStatus = 0.
else do :
if index(ocLstReturn,"-":U) <> 0
then do :
assign vcSafConceptMsg = trim(#T-28'An error has occurred while running this API method. See other error messages for more details.':255(301)T-28#)
oiReturnStatus = -1.
<M-29 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3351':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
end. /* if index(ocLstReturn,"-":U) <> 0 */
else do:
assign vcSafConceptMsg = trim(#T-30'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-30#)
oiReturnStatus = +1.
<M-31 run SetMessage (input vcSafConceptMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'W':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3352':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BSafConcept>
end. /* not if index(ocLstReturn,"-":U) <> 0 */
end. /* not if ocLstReturn */
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 = "BSafConcept".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "ApiStdMaintainTT".
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/bsafconcept.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.
vhParameter = vhInputDS:get-buffer-handle("tApiSafConcept").
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.