method ApiReadCustomization

Description

Method to be used to retrieve a dataset (that can be dumped as XML), on system, role or user level.
This method returns a dataset which contains all customization data for the UI design, which can be loaded in another system by using "ApiLoadCustomization".

Parameters

icBusinessActivity	input	character	Name for the business activty in the format of "<BusComponent>.<BusActivity>" (<BusComponent> = technical short name like "BJournal", <BusActivity> = business activity name like "Create") for which data needs to be read. (for example "BJournal.Create") If only the <BusComponent> is specified, then all information for that specific business component will be returned. If the parameter is blank, then all activities are assumed, which can lead to a large dataset.
iiLevel	input	integer	The level for which the customization information needs to be read. This can be "user" (level=1),"role" (level=2) or "system" (level=3). User level automatically includes role and system levels. Role level automatically includes system level.
ovBControlProperty	output	dataset
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bcontrolproperty.p)

<M-96 run ApiReadCustomizationV01
   (input  icBusinessActivity (icBusinessActivity), 
    input  iiLevel (iiLevel), 
    input  0 (iiLevelValue), 
    output BControlPropertyO (BControlProperty), 
    output viFcReturnSuper (oiReturnStatus)) in BControlProperty>

if viFcReturnSuper < 0 or
   oiReturnStatus  = 0
then assign oiReturnStatus = viFcReturnSuper.

if oiReturnStatus < 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 = "ApiReadCustomization".
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/bcontrolproperty.apireadcustomization.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icBusinessActivity = <parameter value>
       vhParameter::iiLevel = <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.