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.

SettingsBuffer (100)

Blob

Methods

SecretsStorageExists

procedure SecretsStorageExists(): Boolean

Parameters / Return Value

• Returns Boolean

Invalidate

procedure Invalidate()

Invalidates this instance and clears all caches. This will force all settings to be reloaded.

TemporaryMode

procedure TemporaryMode(NewValue: Boolean)

Sets if the current instance is to be treated in temporary mode. Temporary mode does not read or write settings to the database. It keeps them in memory only. Use this to activate this mode explicitly. However, it may already be enabled automatically. See TemporaryMode() for more details. If the instance is in temporary mode, but has the same Code as an existing record, settings will be initially read (read only) from that.

Parameters / Return Value

• NewValue Boolean

  Specifies if temporary mode is to be enabled or disabled.

TemporaryMode

procedure TemporaryMode(): Boolean

Gets if the current instance is in temporary mode. Temporary mode does not read or write settings to the database. It keeps them in memory only. Temporary mode is active if a) it was set explicitly via TemporaryMode(Boolean), b) if this instance is a temporary record or c) if the record has no SystemId which is usually the case if the instance isn’t temporary, but also does not refer to an actual record.

Parameters / Return Value

• Returns Boolean

BeginUpdate

procedure BeginUpdate(): Boolean

Sets the instance into update-mode. While in update mode, and setting changes will not be persisted to the database. Use this if you are updating multiple settings at once and want to save to the database only at the end of the operation. Remember to call EndUpdate to complete the operation.

Parameters / Return Value

• Returns Boolean

EndUpdate

procedure EndUpdate(): Boolean

Ends the update-mode, if the instance is currently in it. This will save all changes to the database. See also: BeginUpdate.

Parameters / Return Value

• Returns Boolean

IsSecret

procedure IsSecret(SettingKey: Text): Boolean

Specifies if a given setting is secret.

Parameters / Return Value

• SettingKey Text[]

  The setting key.

• Returns Boolean

  true if the setting is secret. false otherwise.

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

Parameters / Return Value

• SettingKey Text[]

• Returns Text[]

GetSettingValue

procedure GetSettingValue(SettingKey: Text; Unmask: 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 secrets. If this is true, the actual setting value is returned. If this is false a placeholder string is read instead.

• Returns Text[]

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

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 secrets. If this is true, the actual setting value is returned. 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.

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.

SetSettingValue

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

Parameters / Return Value

• SettingKey Text[]

• Masked Boolean

• SettingValue Text[]

SetSettingValue

procedure SetSettingValue(SettingKey: Text; 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.

• SettingValue Text[]

  The setting value to store.

FilterByType

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

Filters this record instance by the given service configuration type.

Parameters / Return Value

• ConfigType Enum "EOS004 Service Config. Type"

FilterByType

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

Filters this record instance by the given service configuration types.

Parameters / Return Value

• ConfigTypes List[Enum]

HasBufferedValue

procedure HasBufferedValue(): Boolean

Parameters / Return Value

• Returns Boolean

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.