Class MappingMgr
Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be used to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings.
Mappings are read into the system using the ImportKeyValueMapping job step.
Generic mapping capability enables you to map keys to values, with the mapping stored in a high-performance data store that is independent of the database. This supports large datasets, with high performance for lookup. An example of using this feature is to map SKUs from a backend system to Commerce Cloud Digital SKUs on-the-fly in Digital script, so that interaction with the backend system is transparent and does not require adding Digital SKUs to the third party system.
| Property | Description |
|---|---|
mappingNames: Collection (read-only) | List all known mappings. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| static get(String, MappingKey) | Returns a map containing value(s) associated to the specified key for the specified mapping. |
| static getFirst(String, MappingKey) | Gets the first string value of a mapping by name and key. |
| static getMappingNames() | List all known mappings. |
| static keyIterator(String) | Key iterator over known mapping keys by mapping name. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- mappingNames: Collection
(read-only) List all known mappings.
- static get(mappingName: String, key: MappingKey): Map
Returns a map containing value(s) associated to the specified key for the specified mapping.
Parameters:
- mappingName - the mapping name
- key - the key
Throws:
- IllegalArgumentException - if mappingName is unknown
- static getFirst(mappingName: String, key: MappingKey): String
Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an exception if mappingName does not exist.
Parameters:
- mappingName - the mapping name
- key - the key
Returns:
- the value if a single value. The first value sequentially if a compound value.
Throws:
- IllegalArgumentException - if mappingName is unknown
- static getMappingNames(): Collection
List all known mappings.
Returns:
- the collection of mapping names
- static keyIterator(mappingName: String): SeekableIterator
Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.
Parameters:
- mappingName - the mapping name
Returns:
- the seekable iterator
Throws:
- IllegalArgumentException - if mappingName is unknown