Description
The GMapPutReceiver sends key/value generated data to a given G-MapServer via REST. The GMapPutReceiver works in conjunction with the GMapKeyValueGen Generator.
In This Article
Component Diagram
The component diagram below shows how the GMapPutReceiver interacts with a GMapKeyValueGen and a G-MapServer.
Receiver Parameters
The GMapPutReceiver requires that the following parameters be defined. 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.
- batchSize* - Defines the number of key/value pairs to send to a G-MapServer in one batch. The default is 1 key/value pair.
- resetAction* - Defines if, when, and how a G-MapServer resets its' internal cache. The options are the following:
- NoAction
- ResetNamespaceOnStartup
- ResetNamespaceOnShutdown
- ResetCacheOnStartup
- ResetCacheOnShutdown
Example
Receiver Attributes Property Keys
The Receiver defines two property keys that can be modified on any of its associated Domain Attributes:
- columnName - Defines the actual column name (e.g., first_name, last_name)
- map - Tells the GMapPutReceiver to send the key/value generated data for that Attribute to the G-Map Server.
- The default value is 'false' for each Attribute.
- It must be set to 'True' for each Attribute that requires the key/value generated data to be sent.
Property Keys Example
How to Change the Map Property Key Value
Complete these steps in the Receiver Dashboard to change the map property key value for one or more Attributes:
- Select an Attribute.
- Select an option and click Save.
Note: You can also click Save & Next to modify property keys for the next Attribute in the hierarchy.