project BLF > class BSetting > method ApiGetSystemSetting

Description

returns the value of a system setting


Parameters


icSettingConfigNameinputcharacter
olSettingIsActiveoutputlogical
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program3/bsetting.p)

case icSettingConfigName:

    when {&SETTINGCONFIG-DRAFT}
    then olSettingIsActive = vlDraftsActive.
    
    when {&SETTINGCONFIG-CBF}
    then olSettingIsActive = vlCBFActive.
    
    when {&SETTINGCONFIG-EVTPUBLISH}
    then olSettingIsActive = vlEventPublishingActive.
    
    when {&SETTINGCONFIG-OBJSEC}
    then olSettingIsActive = vlObjectSecurityActive.
    
    when {&SETTINGCONFIG-WORKFLOW}
    then olSettingIsActive = vlWorkFlowActive.
    
    when {&SETTINGCONFIG-FIELDSECURITY}
    then olSettingIsActive = vlFieldSecurityActive.
    
    /* These system settings are also user settings. */
    when {&SETTINGCONFIG-ALLOWSAVEGRID}
    then do:
        <Q-22 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-ALLOWSAVEGRID}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.

    when {&SETTINGCONFIG-AUTOSAVEGRID}
    then do:
        <Q-47 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-AUTOSAVEGRID}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.

    when {&SETTINGCONFIG-AUTOSAVELASTUSED}
    then do:
        <Q-65 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-AUTOSAVELASTUSED}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.

    when {&SETTINGCONFIG-ENABLEPERSISTENTCACHE}
    then do:
        <Q-27 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-ENABLEPERSISTENTCACHE}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.

    when {&SETTINGCONFIG-OBJECTTRANSLATIONS}
    then do:
        <Q-23 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-OBJECTTRANSLATIONS}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.

    when {&SETTINGCONFIG-UICUSTOM}
    then do:
        <Q-2 assign vlFcQueryRecordsAvailable = CheckSettingByName (NoCache)
           (input {&SETTINGCONFIG-UICUSTOM}, (ConfigName)
            input {&SETTINGCONFIG-LEVEL-SYSTEM}, (ConfigLevel)
            input '', (Scope)
            input yes, (Active)) in BSettingConfiguration>
        olSettingIsActive = (vlFcQueryRecordsAvailable <> no).
    end.
    
    otherwise do:
        oiReturnStatus = -3.
        <M-1 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) + {&SETTINGCONFIG-LEVEL-SYSTEM} (icArguments), 
            input  '' (icFieldName), 
            input  '' (icFieldValue), 
            input  'D' (icType), 
            input  3 (iiSeverity), 
            input  '' (icRowid), 
            input  'blf-328098':U (icFcMsgNumber), 
            input  '' (icFcExplanation), 
            input  '' (icFcIdentification), 
            input  '' (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BSetting>
    end.

end case.


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 = "ApiGetSystemSetting".
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.apigetsystemsetting.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icSettingConfigName = <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.