project BLF > class BSetting > method ApiUpdateSetting

Description

Set or clear a setting. Currently restricted to "INTERNAL" settings.


Parameters


icSettingConfigNameinputcharacter
icSettingConfigLevelinputcharacter
ilSettingIsActiveinputlogical
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program9/bsetting.p)

if icSettingConfigLevel <> {&SETTINGCONFIG-LEVEL-INTERNAL} then do:
    assign oiReturnStatus = -1.
    <M-44 run SetMessage
       (input  #T-2'Currently, only internal settings may be updated via ApiUpdateSetting':255(862737129)T-2# (icMessage), 
        input  '' (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E' (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'blf-640250':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BSetting>
    return.
end.

<Q-16 run SelectConfig (all) (Read) (NoCache)  (output dataset tqSelectConfig) in BSettingConfiguration >

find first tqSelectConfig
    where tqSelectConfig.tcSettingConfigName = icSettingConfigName
    and tqSelectConfig.tcSettingConfigLevel = icSettingConfigLevel no-error.

if not available tqSelectConfig then do:
    assign oiReturnStatus = -1.
    <M-5 run SetMessage
       (input  #T-11'A setting configuration with the specified name: '$1' and scope: '$2' cound not be found.':255(270153187)T-11# (icMessage), 
        input  icSettingConfigName + chr(2) + icSettingConfigLevel (icArguments), 
        input  '' (icFieldName), 
        input  '' (icFieldValue), 
        input  'E' (icType), 
        input  3 (iiSeverity), 
        input  '' (icRowid), 
        input  'blf-910792':U (icFcMsgNumber), 
        input  '' (icFcExplanation), 
        input  '' (icFcIdentification), 
        input  '' (icFcContext), 
        output viFcReturnSuper (oiReturnStatus)) in BSetting>
    return.
end.

assign vcFreeform = 
    "for each fcSetting where fcSetting.SettingConfig_ID = ":U 
    + string(tqSelectConfig.tiSettingConfig_ID).

<M-41 run DataLoad
   (input  '' (icRowids), 
    input  '' (icPkeys), 
    input  '' (icObjectIds), 
    input  vcFreeForm (icFreeform), 
    input  no (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BSetting>

if viFcReturnSuper = -4 then viFcReturnSuper = 0.
if viFcReturnSuper <> 0 then oiReturnStatus = viFcReturnSuper.
if viFcReturnSuper <  0 then return.

find first tfcSetting no-error.

if available tfcSetting then 
    assign 
        tfcSetting.tc_Status = "C":U.

else do:

    <M-35 run AddDetailLine
       (input  'fcSetting':U (icTable), 
        input  '' (icParentRowid), 
        output viFcReturnSuper (oiReturnStatus)) in BSetting>

    if viFcReturnSuper <> 0 then do :
        assign oiReturnStatus = viFcReturnSuper.
        return.
    end.

    assign 
        tfcSetting.SettingConfig_ID = tqSelectConfig.tiSettingConfig_ID
        tfcSetting.SettingScope = "".

end.

assign
    tfcSetting.SettingIsActive = ilSettingIsActive.
    
if can-find (first tfcSetting where tfcSetting.tc_Status <> "") then do :

    <M-14 run ValidateBC  (output viFcReturnSuper (oiReturnStatus)) in BSetting>
    if viFcReturnSuper <> 0 then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper <  0 then return.

    <M-96 run AdditionalUpdates  (output viFcReturnSuper (oiReturnStatus)) in BSetting>
    if viFcReturnSuper <> 0 then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper <  0 then return.

    <M-53 run DataSave  (output viFcReturnSuper (oiReturnStatus)) in BSetting>
    if viFcReturnSuper <> 0 then oiReturnStatus = viFcReturnSuper.
    if viFcReturnSuper <  0 then return.
    
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 = "BSetting".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiUpdateSetting".
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/bsetting.apiupdatesetting.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icSettingConfigName = <parameter value>
       vhParameter::icSettingConfigLevel = <parameter value>
       vhParameter::ilSettingIsActive = <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.