method ApiGetControlProperties

Description

Return values of customised control properties for a specific window / activity.

Parameters

icWindow	input	character
icBusinessComponentCode	input	character
icActivityCode	input	character
icRoleName	input	character	Current role of current user
tControlPropertyForWindow	output	temp-table
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bcontrolproperty.p)

empty temp-table tControlPropertyForWindow.

<M-1 run DataLoadByWindowActivity
   (input  icWindow (icWindow), 
    input  icBusinessComponentCode (icBusinessComponentCode), 
    input  icActivityCode (icActivityCode), 
    input  icRoleName (icRoleName), 
    input  '' (icUserLogin), 
    input  0 (iiLayerType), 
    input  yes (ilIncludeLowerLevels), 
    output viFcReturnSuper (oiReturnStatus)) in BControlProperty>

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

if oiReturnStatus < 0
then return.

/* Copy data into output table, merged on customisation level */
for each tControlProperty
         by tControlProperty.ControlPropertyLayerType on error undo, throw:
    if tControlProperty.ControlPropertyName = {&CONTROLPROPERTY-VIEWSDEFINITIONS}
    then do:
        /* Special merge for views only */
        /* For View, only one ControlProperty is returned, where the different levels are saved in the field */
        /* tcControlPropertyValue with chr (2) */
        find first tControlPropertyForWindow where
                   tControlPropertyForWindow.tcControlPropertyControl = tControlProperty.ControlPropertyControl and
                   tControlPropertyForWindow.tcControlPropertyName    = tControlProperty.ControlPropertyName
                   no-error.

        if available tControlPropertyForWindow
        then do:
            /* Syntax = USER chr(2) ROLE chr(2) SYSTEM */
            /* ControlPropertyLayerType = 1 --> USER */
            /* ControlPropertyLayerType = 2 --> ROLE - should be one chr (2)*/
            /* ControlPropertyLayerType = 3 --> SYSTEM - should be two chr (2) */
            case tControlProperty.ControlPropertyLayerType:
                when {&CONTROLPROPERTYLAYERTYPE-ROLE}
                then assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + chr(2).

                when {&CONTROLPROPERTYLAYERTYPE-SYSTEM}
                then do:
                    assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + chr(2).

                    if num-entries(tControlPropertyForWindow.tcControlPropertyValue, chr(2)) = 2
                    then assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + chr(2).
                end.
            end.

            if can-find(first tControlPropertySegment where
                              tControlPropertySegment.tc_ParentRowid = tControlProperty.tc_Rowid)
            then for each tControlPropertySegment where
                          tControlPropertySegment.tc_ParentRowid = tControlProperty.tc_Rowid
                          by tControlPropertySegment.ControlPropertySegmentSeq on error undo, throw:
                assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + tControlPropertySegment.ControlPropertySegmentText.
            end.
            else assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + tControlProperty.ControlPropertyValue.

            next.
        end.
    end.

    if not can-find(first tControlPropertyForWindow where
                          tControlPropertyForWindow.tcControlPropertyControl = tControlProperty.ControlPropertyControl and
                          tControlPropertyForWindow.tcControlPropertyName    = tControlProperty.ControlPropertyName)
    then do:
        create tControlPropertyForWindow.

        assign tControlPropertyForWindow.tcControlPropertyAssemblyName = tControlProperty.ControlPropertyAssemblName
               tControlPropertyForWindow.tcControlPropertyAssemblyType = tControlProperty.ControlPropertyAssemblType
               tControlPropertyForWindow.tcControlPropertyControl      = tControlProperty.ControlPropertyControl
               tControlPropertyForWindow.tcControlPropertyName         = tControlProperty.ControlPropertyName
               tControlPropertyForWindow.tcControlPropertyParent       = tControlProperty.ControlPropertyParent
               tControlPropertyForWindow.tiControlPropertyTab          = tControlProperty.ControlPropertyTab
               tControlPropertyForWindow.tlControlPropertyChildChanged = tControlProperty.ControlPropertyChildChange
               tControlPropertyForWindow.tiControlPropertyLayerType    = tControlProperty.ControlPropertyLayerType.

        if can-find(first tControlPropertySegment where
                          tControlPropertySegment.tc_ParentRowid = tControlProperty.tc_Rowid)
        then for each tControlPropertySegment where
                      tControlPropertySegment.tc_ParentRowid = tControlProperty.tc_Rowid
                      by tControlPropertySegment.ControlPropertySegmentSeq on error undo, throw:
            assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + tControlPropertySegment.ControlPropertySegmentText.
        end.
        else assign tControlPropertyForWindow.tcControlPropertyValue = tControlPropertyForWindow.tcControlPropertyValue + tControlProperty.ControlPropertyValue.

        if tControlProperty.ControlPropertyName = {&CONTROLPROPERTY-VIEWSDEFINITIONS}
        then do:
            case tControlProperty.ControlPropertyLayerType:
                when {&CONTROLPROPERTYLAYERTYPE-ROLE}
                then assign tControlPropertyForWindow.tcControlPropertyValue = chr(2) + tControlPropertyForWindow.tcControlPropertyValue.

                when {&CONTROLPROPERTYLAYERTYPE-SYSTEM}
                then do:
                    assign tControlPropertyForWindow.tcControlPropertyValue = chr(2) + tControlPropertyForWindow.tcControlPropertyValue.

                    if num-entries(tControlPropertyForWindow.tcControlPropertyValue, chr(2)) = 2
                    then assign tControlPropertyForWindow.tcControlPropertyValue = chr(2) + tControlPropertyForWindow.tcControlPropertyValue.
                end.
            end.
        end.
    end.
end.

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 = "ApiGetControlProperties".
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.apigetcontrolproperties.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icWindow = <parameter value>
       vhParameter::icBusinessComponentCode = <parameter value>
       vhParameter::icActivityCode = <parameter value>
       vhParameter::icRoleName = <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.