project BLF > class BReportVariant > method apiExportFactoryDefaults

Description

Create an XML file with factory defaults for report requests.
These factory defaults will be loaded in each installation by the synchronization process.


Parameters


oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/breportvariant.p)

if oiReturnStatus = 0
then oiReturnStatus = -98.

/* ================================================================= */
/* Determine filename of export-xml-file                             */
/* ================================================================= */
<M-38 run Main  (input  viSessionID (iiSessionId)) in TApplication>
<M-50 run GetDefaultsFolder  (output vcFilePath (ocFolder)) in TApplication>
run gipr_DeleteProcedure in vhFcComponent.
delete procedure vhFcComponent.

assign vcFileName = trim(vcFilePath) + "reportvariantfactorydefaults.xml":U.

/* ================================================================= */
/* Load factory defaults                                             */
/* ================================================================= */
assign vcFreeform = "for each RptRequest where "
                  + "RptRequest.RptRequestType = 'V' and "
                  + "RptRequest.RptRequestName = '" + {&STOREDSEARCH-FACTORY-DEFAULT} + "'".
<M-1 run DataLoad
   (input  '' (icRowids), 
    input  '' (icPkeys), 
    input  '' (icObjectIds), 
    input  vcFreeform (icFreeform), 
    input  no (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

/* ================================================================= */
/* Remove all scope restrictions.                                    */
/* ================================================================= */
for each tRptRequest on error undo, throw:

    assign tRptRequest.tcUsrLogin = "mfg":u.

    find first tRptRequestVariant where
               tRptRequestVariant.tc_ParentRowid = tRptRequest.tc_Rowid no-error.
    if available tRptRequestVariant
    then assign tRptRequestVariant.tcCompanyCode = ""
                tRptRequestVariant.Company_ID    = 0
                tRptRequestVariant.tcRoleName    = ""
                tRptRequestVariant.Role_ID       = 0
                tRptRequestVariant.tcUsrLogin    = ""
                tRptRequestVariant.Usr_ID        = 0.
    else do:
        <M-2 run AddDetailLine
           (input  'RptRequestVariant' (icTable), 
            input  tRptRequest.tc_Rowid (icParentRowid), 
            output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
        if viFcReturnSuper <> 0
        then oiReturnStatus = viFcReturnSuper.
        if viFcReturnSuper < 0
        then return.
    end.
end.

/* ================================================================= */
/* Standardise the data before dumping, so it becomes easier to      */
/* compare different versions of the output file.                    */
/* - Clear contents of LastModifiedDate-Time-User.                   */
/* - Assign fixed values to tc_Rowid and tc_ParentRowid.             */
/* - Sort stored searches on report name.                            */
/* ================================================================= */
for each tRptRequest on error undo, throw:

    for each tRptRequestCBF where tRptRequestCBF.tc_ParentRowid = tRptRequest.tc_Rowid
             break by tRptRequestCBF.RptRequestResultField on error undo, throw:
        if first-of (tRptRequestCBF.RptRequestResultField)
        then viRptRequestCBFRowid = 0.
        viRptRequestCBFRowid = viRptRequestCBFRowid + 1.
        assign tRptRequestCBF.tc_ParentRowid   = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
               tRptRequestCBF.tc_Rowid         = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
                                               + "." + tRptRequestCBF.RptRequestResultField
                                               + (if viRptRequestCBFRowid = 1
                                                  then ""
                                                  else "." + string(viRptRequestCBFRowid)).
    end.
    
    for each tRptRequestFilter where tRptRequestFilter.tc_ParentRowid = tRptRequest.tc_Rowid
             break by tRptRequestFilter.RptRequestFilterBusField on error undo, throw:
        if first-of (tRptRequestFilter.RptRequestFilterBusField)
        then viRptRequestFilterRowid = 0.
        viRptRequestFilterRowid = viRptRequestFilterRowid + 1.
        assign tRptRequestFilter.LastModifiedDate = ?
               tRptRequestFilter.LastModifiedTime = 0
               tRptRequestFilter.LastModifiedUser = ""
               tRptRequestFilter.tc_ParentRowid   = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
               tRptRequestFilter.tc_Rowid         = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
                                                  + "." + tRptRequestFilter.RptRequestFilterBusField
                                                  + (if viRptRequestFilterRowid = 1
                                                     then ""
                                                     else "." + string(viRptRequestFilterRowid)).
    end.
    
    viRptRequestMailRowid = 0.
    for each tRptRequestMail where tRptRequestMail.tc_ParentRowid = tRptRequest.tc_Rowid on error undo, throw:
        viRptRequestMailRowid = viRptRequestMailRowid + 1.
        assign tRptRequestMail.LastModifiedDate = ?
               tRptRequestMail.LastModifiedTime = 0
               tRptRequestMail.LastModifiedUser = ""
               tRptRequestMail.tc_ParentRowid   = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
               tRptRequestMail.tc_Rowid         = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
                                                + "." + string(viRptRequestMailRowid,"9999").
    end.
    
    viRptRequestVariantRowid = 0.
    for each tRptRequestVariant where tRptRequestVariant.tc_ParentRowid = tRptRequest.tc_Rowid on error undo, throw:
        viRptRequestVariantRowid = viRptRequestVariantRowid + 1.
        assign tRptRequestVariant.LastModifiedDate = ?
               tRptRequestVariant.LastModifiedTime = 0
               tRptRequestVariant.LastModifiedUser = ""
               tRptRequestVariant.tc_ParentRowid   = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
               tRptRequestVariant.tc_Rowid         = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode
                                                   + "." + string(viRptRequestVariantRowid,"9999").
    end.
    
    assign tRptRequest.LastModifiedDate = ?
           tRptRequest.LastModifiedTime = 0
           tRptRequest.LastModifiedUser = ""
           tRptRequest.tc_Rowid         = tRptRequest.tcBusComponentCode + "." + tRptRequest.tcBusActivityCode.
end.
    
/* ================================================================= */
/* Dump the data.                                                    */
/* ================================================================= */
<M-3 run DumpXmlRepresentation
   (input  vcFileName (icFile), 
    input  no (ilHeaderOnly), 
    input  ? (ilSuppressEmptyFields), 
    input  0 (iiPriority), 
    input  no (ilWriteXMLSchema), 
    input  ? (icObjectRowId), 
    input  yes (ilExportForInput), 
    output viFcReturnSuper (oiReturnStatus)) in BReportVariant>
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

/* ================================================================= */
/* Clear the data.                                                   */
/* ================================================================= */
<M-4 run ClearData  (output viFcReturnSuper (oiReturnStatus)) in BReportVariant>

if oiReturnStatus = -98
then 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 = "BReportVariant".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "apiExportFactoryDefaults".
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 = "".

/* 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.