method apiExportFactoryDefaults

Description

Export factory default stored searches to an XML file.
This file should be loaded as fixed data in every installation, as part of the synchronisation process.

Parameters

oiReturnStatus

output

integer

Return status of the method.

Internal usage

unused

program code (program3/bcontrolproperty.p)

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

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

/* ================================================================= */
/* Load factory default grid view settings                           */
/* ================================================================= */
vcFreeform = "for each ControlProperty where ControlProperty.ControlPropertyName = '" + {&CONTROLPROPERTY-VIEWSDEFINITIONS}
           +    "' and ControlProperty.ControlPropertyLayerType = ":U + string({&CONTROLPROPERTYLAYERTYPE-SYSTEM}).
<M-1 run DataLoad (input  '' (icRowids), 
                   input  '' (icPkeys), 
                   input  '' (icObjectIds), 
                   input  vcFreeform (icFreeform), 
                   input  no (ilKeepPrevious), 
                   output viFcReturnSuper (oiReturnStatus)) in BControlProperty>
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

/* ============================================= */
/* Dump the data in the instance to the XML-file */
/* ============================================= */
<M-2 run DumpXmlRepresentation
   (input  vcFile (icFile), 
    input  false (ilHeaderOnly), 
    input  ? (ilSuppressEmptyFields), 
    input  0 (iiPriority), 
    input  false (ilWriteXMLSchema), 
    input  ? (icObjectRowId), 
    input  yes (ilExportForInput), 
    output viFcReturnSuper (oiReturnStatus)) in BControlProperty>
if viFcReturnSuper <> 0
then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper < 0
then return.

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 = "BControlProperty".
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.