Parameters
| tApiProjectGroup | 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/bprojectgroup.p)
/* Method Info: */
/* Project Group 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-1 run ClearData (output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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 vcProjectGroupMsg = trim(subst(#T-2'A project group integration error occurred. The specified action (&1) must be in the list '&2'.':255(16270)t-2#,trim(icAction),"{&DAEMONACTION-SAVESTORE},{&DAEMONACTION-SAVE},{&DAEMONACTION-STORE},{&DAEMONACTION-VALIDATE}":U))
oiReturnStatus = -1.
<M-3 run SetMessage (input vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3939':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
return.
end. /* if icAction */
/* ======================== */
/* Count main-table records */
/* ======================== */
for each tApiProjectGroup no-lock :
assign viMainTableRecordCount = viMainTableRecordCount + 1.
end. /* for each */
if viMainTableRecordCount = 0
then do:
assign vcProjectGroupMsg = trim(#T-4'A project group integration error occurred. The system could not find main table records (project group).':255(16272)t-4#)
oiReturnStatus = -1.
<M-5 run SetMessage (input vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3941':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
return.
end. /* if viMainTableRecordCount */
/* ================================================================= */
/* Start queries */
/* ================================================================= */
<Q-6 run ProjectGroupPrim (Start) in BProjectGroup >
/* ================================ */
/* Start loop on main-table records */
/* ================================ */
for each tApiProjectGroup by tApiProjectGroup.tc_Rowid:
MAIN-BLOCK:
DO:
/* ========== */
/* Initialize */
/* ========== */
assign vcProjectGroupMsg = "":U
vcRowID = "":U
vlWarningsFound = false
vlSaveAsDraft = icAction = {&DAEMONACTION-STORE}.
/* =========================================== */
/* Get the ProjectGroup_ID based on the logical key */
/* =========================================== */
if (tApiProjectGroup.ProjectGroup_ID = ? or
tApiProjectGroup.ProjectGroup_ID = 0) and
tApiProjectGroup.ProjectGroupCode <> "" and
tApiProjectGroup.ProjectGroupCode <> ?
then do:
<Q-7 run ProjectGroupPrim (all) (Read) (NoCache)
(input ?, (ProjectGroupID)
input tApiProjectGroup.ProjectGroupCode, (ProjectGroupCode)
output dataset tqProjectGroupPrim) in BProjectGroup >
find tqProjectGroupPrim where
tqProjectGroupPrim.tcProjectGroupCode = tApiProjectGroup.ProjectGroupCode
no-lock no-error.
if available tqProjectGroupPrim
then assign tApiProjectGroup.ProjectGroup_ID = tqProjectGroupPrim.tiProjectGroup_ID.
end.
/* ========================= */
/* Load/Create Project Group */
/* ========================= */
if tApiProjectGroup.ProjectGroup_ID = ? or
tApiProjectGroup.ProjectGroup_ID = 0
then assign viFcReturnSuper = -4.
else do:
<M-8 run DataLoad (input '':U (icRowids),
input string(tApiProjectGroup.ProjectGroup_ID) (icPkeys),
input '':U (icObjectIds),
input '':U (icFreeform),
input false (ilKeepPrevious),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
end.
if viFcReturnSuper = -4
then do:
assign viFcReturnSuper = 0.
<M-9 run DataNew (output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
if viFcReturnSuper < 0
then assign vcProjectGroupMsg = trim(subst(#T-10'Cannot create a new instance. Error number: &1.':255(308)t-10#, string(viFcReturnSuper))).
find first tProjectGroup no-error.
end.
else do:
if viFcReturnSuper < 0
then assign vcProjectGroupMsg = trim(subst(#T-11'Cannot load the instance (error number: &1, instance ID: &2).':255(289)t-11#, string(viFcReturnSuper), string(tApiProjectGroup.ProjectGroup_ID))).
else do:
find tProjectGroup where
tProjectGroup.ProjectGroup_ID = tApiProjectGroup.ProjectGroup_ID
no-error.
if not available tProjectGroup
then assign vcProjectGroupMsg = trim(subst(#T-12'Cannot find the instance after it has been loaded (instance ID: &1).':255(290)t-12#,
string(tApiProjectGroup.ProjectGroup_ID))).
else assign tProjectGroup.tc_Status = "C":U.
end.
end.
/* ================================================================= */
/* Check for errors in the previous block */
/* ================================================================= */
if vcProjectGroupMsg <> "":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 vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3946':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
leave MAIN-BLOCK.
end.
/* =========================== */
/* Copy data for Project Group */
/* =========================== */
buffer-copy tApiProjectGroup
except tApiProjectGroup.ProjectGroup_ID
tApiProjectGroup.tc_ParentRowid
tApiProjectGroup.tc_Rowid
tApiProjectGroup.tc_Status
tApiProjectGroup.ProjectGroupCode
to tProjectGroup.
if tProjectGroup.tc_Status = "N":U
then assign tProjectGroup.ProjectGroupCode = tApiProjectGroup.ProjectGroupCode.
assign vcRowID = tProjectGroup.tc_Rowid
tApiProjectGroup.ProjectGroup_ID = tProjectGroup.ProjectGroup_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 tProjectGroup where
tProjectGroup.tc_Status = "N":U)
then assign vcActivityCode = "Create":U.
else if can-find (first tProjectGroup where
tProjectGroup.tc_Status = "C":U)
then assign vcActivityCode = "Modify":U.
/* ================= */
/* Validate the data */
/* ================= */
<M-14 run ValidateBC (output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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-15 run AdditionalUpdates (output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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-16 run DataSave (output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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(tApiProjectGroup.ProjectGroup_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 vcProjectGroupMsg = trim (#T-17'Only one draft instance can be created per method call.':255(13878)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 vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3947':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
next.
end. /* if vlDraftInstanceCreated = true */
<M-20 run StoreState
(input '(':U + string(tProjectGroup.ProjectGroupCode) + ') ':U + trim(#T-19'The project group was created using an API method.':200(16275)t-19#) (icDescription),
input ? (icUIClass),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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-21 run ProjectGroupPrim (Stop) in BProjectGroup >
/* ============================================================ */
/* 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 vcProjectGroupMsg = trim(#T-22'A project group integration error occurred. An API method returned incomplete information. See other messages for further details.':200(16276)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 vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3948':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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 vcProjectGroupMsg = 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 vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 1 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3949':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
end. /* if index(ocLstReturn,"-":U) <> 0 */
else do :
assign vcProjectGroupMsg = 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 vcProjectGroupMsg (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'W':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QADFIN-3950':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BProjectGroup>
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 = "BProjectGroup".
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/bprojectgroup.apistdmaintaintt.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icAction = <parameter value>.
vhParameter = vhInputDS:get-buffer-handle("tApiProjectGroup").
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.