Table 18122315 EOS004 Service Config.

Table 18122315 EOS004 Service Config.

A generic service configuration.

Fields

Code (10)

Code[20]

The code.

Type (15)

Enum "EOS004 Service Config. Type"

Specifies the type of service that this configuration is for.

Description (20)

Text[50]

Description.

Endpoint Uri (30)

Text[1024]

The endpoint URI for this configuration. This may be optional, depending on the service type.

Configuration (40)

Blob

A Blob containing the service-specific configuration settings.

Logging (50)

Option

"None" (0) , "Failures Only" (1) , "All" (2)

Specifies the logging verbosity of requests made for this configuration.

Request Timeout (sec) (60)

Integer

Specifies the timeout in seconds for requests.

Methods

GetSettingKeys

procedure GetSettingKeys(): List of [Text]

Retrieves all list of all setting keys present in the current configuration.

Parameters / Return Value

• Returns List[Text]

  The list of currently configured keys.

IsSettingMasked

procedure IsSettingMasked(SettingKey: Text): Boolean

Checks if a given setting key was stored masked.

Parameters / Return Value

• SettingKey Text[]

  The setting key.

• Returns Boolean

  true if the setting exists and was stored masked. false otherwise.

GetSettingValue

procedure GetSettingValue(SettingKey: Text): Text

Reads the given setting from the configuration.

Parameters / Return Value

• SettingKey Text[]

  The setting key to read.

• Returns Text[]

  The setting value. If the setting was stored masked, a placeholder text is returned.

GetSettingValueAsSecret

procedure GetSettingValueAsSecret(SettingKey: Text; WithError: Boolean): SecretText

Reads the given setting from the configuration as a secret text.

Parameters / Return Value

• SettingKey Text[]

  The setting key to read.

• WithError Boolean

  If this is true, an error is raised should the setting not exist or have no value.

• Returns SecretText

  The setting value as a secret text.

GetSettingValue

procedure GetSettingValue(SettingKey: Text; Unmask: Boolean; WithError: Boolean): Text

Reads the given setting from the configuration.

Parameters / Return Value

• SettingKey Text[]

  The setting key to read.

• Unmask Boolean

  This only applies to settings that have been stored masked and has no effect on settings that were stored unmasked. If this is true, the setting is unmasked after reading. If this is false a placeholder string is read instead.

• WithError Boolean

  If this is true, an error is raised should the setting not exist or have no value.

• Returns Text[]

  The setting value, or - if applicable - a placeholder text.

SetSettingValue

procedure SetSettingValue(SettingKey: Text; Masked: Boolean; SettingValue: Text)

Stores the given setting in the configuration. Any existing value will be overwritten.

Parameters / Return Value

• SettingKey Text[]

  The setting key to store.

• Masked Boolean

  Indicates if the setting should be stored masked. A masked setting is not immediately visible on the configuration.

• SettingValue Text[]

  The setting value to store.

FilterByType

procedure FilterByType(ConfigType: Enum "EOS004 Service Config. Type")

An utility function that allows you to lookup a service configuration code based on a list of compatible types.

Parameters / Return Value

• ConfigType Enum "EOS004 Service Config. Type"

FilterByType

procedure FilterByType(ConfigTypes: List of [Enum "EOS004 Service Config. Type"])

Parameters / Return Value

• ConfigTypes List[Enum]

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.