Parameters
| tApiDivision | 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/bdivision.p)
/* Method Info: */
/* Division will be loaded based on the Logical Key */
/* =================================================== */
/* ============================================================================ */
/* Clear the instance: */
/* this will also clear the t_s tables that were filled in ApiMaintainByDataSet */
/* ============================================================================ */
<M-20 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BDivision>
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 vcDivisionMsg = trim(subst(#T-40'Sub-account integration: the specified action &1 should be in the list &2.':255(1812)t-40#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
oiReturnStatus = -1.
<M-22 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2648':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
return.
end. /* if icAction */
/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiDivision no-lock :
assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
assign vcDivisionMsg = trim(#T-41'Sub-account integration: no main sub-account table records were found.':255(1813)t-41#)
oiReturnStatus = -1.
<M-23 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2649':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
return.
end. /* if viMainTableRecordCount */
/* ================================================================= */
/* Start queries */
/* ================================================================= */
<Q-30 run DivisionPrim (Start) in BDivision >
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiDivision by tApiDivision.tc_Rowid:
MAIN-BLOCK:
DO:
/* ========== */
/* Initialize */
/* ========== */
assign vcDivisionMsg = "":U
vcRowID = "":U
vlWarningsFound = false
vlSaveAsDraft = icAction = {&DAEMONACTION-STORE}.
/* =========================================== */
/* Get the Division_ID based on the logical key */
/* =========================================== */
if (tApiDivision.Division_ID = ? or
tApiDivision.Division_ID = 0) and
tApiDivision.DivisionCode <> "" and
tApiDivision.DivisionCode <> ?
then do:
<Q-32 run DivisionPrim (all) (Read) (NoCache)
(input viCompanyId, (CompanyId)
input ?, (DivisionID)
input tApiDivision.DivisionCode, (DivisionCode)
output dataset tqDivisionPrim) in BDivision >
find tqDivisionPrim where
tqDivisionPrim.tcDivisionCode = tApiDivision.DivisionCode
no-lock no-error.
if available tqDivisionPrim
then assign tApiDivision.Division_ID = tqDivisionPrim.tiDivision_ID.
end.
/* ==================== */
/* Load/Create Division */
/* ==================== */
if tApiDivision.Division_ID = ? or
tApiDivision.Division_ID = 0
then assign viFcReturnSuper = -4.
else do:
<M-34 run DataLoad (input ? (icRowids),
input string(tApiDivision.Division_ID) (icPkeys),
input ? (icObjectIds),
input ? (icFreeform),
input false (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
end.
if viFcReturnSuper = -4
then do:
assign viFcReturnSuper = 0.
<M-35 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BDivision>
if viFcReturnSuper < 0
then assign vcDivisionMsg = trim(subst(#T-42'Cannot create a new instance. Error number: &1.':255(308)t-42#, string(viFcReturnSuper))).
find first tDivision no-error.
end.
else do:
if viFcReturnSuper < 0
then assign vcDivisionMsg = trim(subst(#T-43'Cannot load the instance (error number: &1, instance ID: &2).':255(289)t-43#, string(viFcReturnSuper), string(tApiDivision.Division_ID))).
else do:
find tDivision where
tDivision.Division_ID = tApiDivision.Division_ID
no-error.
if not available tDivision
then assign vcDivisionMsg = trim(subst(#T-44'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-44#,
string(tApiDivision.Division_ID))).
else assign tDivision.tc_Status = "C":U.
end.
end.
/* ================================================================= */
/* Check for errors in the previous block */
/* ================================================================= */
if vcDivisionMsg <> "":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-26 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2650':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
leave MAIN-BLOCK.
end.
/* ====================== */
/* Copy data for Division */
/* ====================== */
buffer-copy tApiDivision
except tApiDivision.Division_ID
tApiDivision.SharedSet_ID
tApiDivision.tc_ParentRowid
tApiDivision.tc_Rowid
tApiDivision.tc_Status
tApiDivision.DivisionCode
to tDivision.
if tDivision.tc_Status = "N":U
then assign tDivision.DivisionCode = tApiDivision.DivisionCode.
assign vcRowID = tDivision.tc_Rowid
tApiDivision.Division_ID = tDivision.Division_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.
/* =============================== */
/* Set Actvity */
/* =============================== */
if can-find (first tDivision where
tDivision.tc_Status = "N":U)
then assign vcActivityCode = "Create":U.
else if can-find (first tDivision where
tDivision.tc_Status = "C":U)
then assign vcActivityCode = "Modify":U.
/* ================= */
/* Validate the data */
/* ================= */
<M-36 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BDivision>
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.
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* ================ */
/* External updates */
/* ================ */
<M-37 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BDivision>
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.
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
/* ============= */
/* Save the data */
/* ============= */
if icAction <> {&DAEMONACTION-VALIDATE}
then do:
<M-38 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BDivision>
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.
else if viFcReturnSuper > 0
then assign vlWarningsFound = true.
end.
/* ============================================ */
/* Indicate that everything was saved correctly */
/* ============================================ */
assign ocLstReturn = ocLstReturn + chr(4) + (if vlWarningsFound = true then "1":U else "0":U)
ocLstPrimKey = ocLstPrimKey + chr(4) + string(tApiDivision.Division_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(substr(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 vcDivisionMsg = trim (#T-53'Only one draft instance can be created per method call.':255(13878)T-53#) +
chr(10) +
trim (#T-54'This second object cannot be stored as a draft instance and so is an error.':255(13879)t-54#).
<M-55 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3111':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
next.
end. /* if vlDraftInstanceCreated = true */
<M-39 run StoreState
(input '(':U + string(tDivision.DivisionCode) + ') ':U + trim(#T-45'Sub-account created via an API method.':200(1814)t-45#) (icDescription),
input ? (icUIClass),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
assign vlDraftInstanceCreated = true
entry(num-entries(ocLstReturn , chr(4)), ocLstReturn , chr(4)) = "0":U
entry(num-entries(ocLstPrimKey, chr(4)), ocLstPrimKey, chr(4)) = string(vcPrimKey)
entry(num-entries(ocLstRowid , chr(4)), ocLstRowid , chr(4)) = vcRowID.
end. /* if vlSaveAsDraft and index */
end. /* for each tApiCode */
/* ================================================================= */
/* Stop queries */
/* ================================================================= */
<Q-33 run DivisionPrim (Stop) in BDivision >
/* ============================================================ */
/* Trim the first character of ocLstReturn and 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 vcDivisionMsg = trim(#T-46'Sub-account integration: incomplete information returned by an API method. See other messages for further details.':200(1815)T-46#) + chr(10) +
trim(substitute(#T-47'Main table records: &1.':255(310)T-47#,string(viMainTableRecordCount))) + chr(10) +
trim(substitute(#T-48'Return Statuses: &1.':255(311)T-48#,ocLstReturn)) + chr(10) +
trim(substitute(#T-49'Primary keys: &1.':255(312)T-49#,ocLstPrimKey)) + chr(10) +
trim(substitute(#T-50'Row IDs: &1.':255(313)T-50#,ocLstRowid)).
oiReturnStatus = -3.
<M-27 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2651':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
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 vcDivisionMsg = trim(#T-51'An error has occurred while running this API method. See other error messages for more details.':255(301)T-51#)
oiReturnStatus = -1.
<M-28 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2652':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
end. /* if index(ocLstReturn,"-":U) <> 0 */
else do :
assign vcDivisionMsg = trim(#T-52'A warning has occurred while running this API method. See other error messages for more details.':255(302)T-52#)
oiReturnStatus = +1.
<M-29 run SetMessage (input vcDivisionMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'W':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-2653':U (icFcMsgNumber),
input '' (icFcExplanation),
input '' (icFcIdentification),
input '' (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDivision>
end. /* not if lookup */
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 = "BDivision".
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/bdivision.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.
vhParameter = vhInputDS:get-buffer-handle("tApiDivision").
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.