Description

The GMapGetGen retrieves a value from a G-MapServer based on a referenced value representing the key.


Component Diagram

The component diagram below shows how the GMapGetGen interacts with the G-MapServer.



Generator Parameters

The following parameters may be configured for the GMapGetGen Generator. Items with an asterisk* are required.

  • configPath* - Defines the base path where a configuration file contains the REST URL and port for connecting to a G-MapServer.
  • configSubDir - Defines an optional subdirectory where a configuration file contains the REST URL and port for connecting to a G-MapServer.
  • configName* - Defines the name of the configuration file that contains the REST URL and port for connecting to a G-MapServer.
  • namespace* - Defines the namespace within a G-MapServer to store key/value data.
  • mapKeyName* - Defines the name of the key to query for within the namespace of a G-Map Server.
  • keyReference* - Defines the Attribute to reference whose Generator will generate the value used as the key.
  • callOption*- Defines how often the Generator calls G-MapServer to retrieve a mapped value. The options are as follows: 
    • Each - Call on each iteration. 
    • Once - Called only once on the first iteration.
    • OnParent - Called once on each loop of the parent calling the child. 
  • defaultValue - Defines the default value to be used when no value is returned from the G-Map Server for a particular key or when the current Attribute using this Generator needs to be referenced in another Attribute.


Example

The image below shows the GMapGetGen referencing the gen1 linked Generator as its Key-Value.