Websydian v6.1 online documentationOnline documentation - Websydian v6.5

Parameter Store Parts


Data

The Parameter Store pattern contains a single data entity.

ParameterValue

Each instance of the ParameterValue entity specifies a stored field value.  The ParameterValue entity is owned by an abstract WebOwner entity which usually will be replaced by the implemented Session entity when the pattern is applied.

Fields:

NameSpace Key field set to the object name of the variable containing the stored field value.
ParameterName Key field which is set to the object name of the stored field.
ParameterValue Text field containing the value of the parameter field.

Abstract

One abstract function is defined.

ParameterStoreShell

All Websydian functions (Page Generators and Event Handlers) using the Parameter Store must inherit from the ParameterStoreShell abstract function.  This function provides the Load parameters and Store parameters subroutines that need to be called in order to load and save field values to the Parameter Store.

Services

Two meta-functions are included as Service functions in the Parameter Store pattern.  Both functions must be called within a +For Variable meta-construct.  These calls are part of the abstract ParameterStoreShell function, but the calls may also be specified explicitly by the developer if using the Parameter Store on other variables (see the Using Parameter Store with Other Variables section of the Other Uses page).

SaveParameters

Saves all fields in a specified variable to the Parameter Store.

StoreParameters

Loads all fields in a specified variable from the Parameter Store.