method ApiExportRoles

Description

This method exports the selected roles to an XML file.

Parameters

tRolesForExport	input	temp-table
icFileName	input	character	The name of the XML file where the roles will be exported.
ocFullPathName	output	character	Gives the full pathname of the dumped file.
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/brole.p)

assign oiReturnStatus = -98.

/*return if no role is selected for exporting*/
if not can-find (first tRolesForExport where
                       tRolesForExport.tlExport = true) 
then do: 
    assign oiReturnStatus = -1
           vcMessage = trim(#T-8'No roles selected for export.':255(8994)T-8#).
    <M-7 run SetMessage
       (input  vcMessage (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E':U (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'BLF-172':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BRole>
    return.
end.

if icFileName = '' or 
   icFileName = ?
then do: 
    assign oiReturnStatus = -1
           vcMessage = trim(#T-5'You must enter the file name.':100(6490)T-5#).
    <M-6 run SetMessage
       (input  vcMessage (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E':U (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'BLF-171':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BRole>
    return.
end.

if not trim(icFileName) matches "*.xml"
then do: 
    assign oiReturnStatus = -1
           vcMessage = trim(substitute(#T-10'The file name must have the extension &1':255(650017694)T-10#,'.xml':U)).
    <M-9 run SetMessage
       (input  vcMessage (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E':U (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'BLF-173':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BRole>
    return.
end.

<M-1 run ClearData
   (output viFcReturnSuper (oiReturnStatus)) in BRole>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

for each tRolesForExport where
         tRolesForExport.tlExport = true:
    <M-2 run DataLoad
       (input  '' (icRowids), 
        input  string(tRolesForExport.tiRole_ID) (icPkeys), 
        input  '' (icObjectIds), 
        input  '' (icFreeform), 
        input  true (ilKeepPrevious), 
        output viFcReturnSuper (oiReturnStatus)) in BRole>
    if viFcReturnSuper <> 0
    then assign oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper < 0
    then return.
end.

<M-4 run DumpXmlRepresentation
   (input  icFileName (icFile), 
    input  false (ilHeaderOnly), 
    input  false (ilSuppressEmptyFields), 
    input  0 (iiPriority), 
    input  false (ilWriteXMLSchema), 
    input  ? (icObjectRowId), 
    output viFcReturnSuper (oiReturnStatus)) in BRole>
if viFcReturnSuper <> 0
then assign oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

assign ocFullPathName = search(icFileName).

if oiReturnStatus = -98
then assign oiReturnStatus = 0.

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

vhParameter = vhInputDS:get-buffer-handle("tRolesForExport").
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.