method apiMaintainByXml

Description

Generic method for creating or updating object data.
This method provides the same functionality as the XML daemon.

Parameters

imDocument	input	memptr	contents of the XML document (or use parameter icFileName)
icFileName	input	character	file name of the xml document (or use parameter imDocument)
olSuccess	output	logical	update completed successfully
tXmlObjects	output	temp-table
oiReturnStatus	output	integer	Return status of the method.

Internal usage

BLF

method BReportVariant.apiSynchronise
method BRole.ApiImportRoles
method BRole.ApiSynchronizeDefaultRoles
method BStoredSearch.ApiSynchronise
method BSystem.ApiLoadDefaultSecurity

program code (program3/database.p)

create x-document vhDocument in widget-pool "non-persistent".

if icFileName = "" or
   icFileName = ?
then vhDocument:load("MEMPTR", imDocument, no) no-error.
else vhDocument:load("FILE", icFileName, no) no-error.

if error-status:num-messages > 0
then do viErrors = 1 to error-status:num-messages:
    assign vcErrors = vcErrors + chr(2) + error-status:get-message(viErrors).
end.

if vcErrors <> ""
then do:
    <M-1 run SetMessage
       (input  trim(#T-4'The XML document could not be read.':100(371)t-4#) (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'D' (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'BLF-304':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in database>

    do viErrors = 2 to num-entries(vcErrors,chr(2)):
        <M-3 run SetMessage
           (input  entry(viErrors, vcErrors, chr(2)) (icMessage), 
            input  '' (icArguments), 
            input  '' (icFieldName), 
            input  '' (icFieldValue), 
            input  'S' (icType), 
            input  3 (iiSeverity), 
            input  '' (icRowid), 
            input  'BLF-305':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in database>
    end.

    assign oiReturnStatus = -3.
    return.
end.

/* Run without instance */
assign vhFcComponent = ?.

<M-2 run LoadXmlDocument
   (input  vhDocument (ihDocument), 
    input  vcFcComponentName (icClassName), 
    input  '' (icOverrideAction), 
    output tXmlObjects (tXmlObjectsLoaded), 
    output olSuccess (olSuccess), 
    output viFcReturnSuper (oiReturnStatus)) in BXmlDaemonProcessor>
    
if viFcReturnSuper = 0 and
   olSuccess      <> true
then assign viFcReturnSuper = -3.

if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.

if viFcReturnSuper < 0
then return.

finally:
    delete object vhDocument.
    assign vhDocument = ?.
end finally.

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 = "database".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "apiMaintainByXml".
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/database.apimaintainbyxml.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::imDocument = <parameter value>
       vhParameter::icFileName = <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.