IMS parameters and manifest items
Use IMS parameters to instruct ION how to handle IEC messages and specify preferred values. You can include these optional IMS parameters as part of the manifest:
Manifest Item | Actual Manifest Constant (in Mapper) | IMS Parameters | Notes |
---|---|---|---|
map:ionMessageId |
MAP_ION_MESSAGE_ID |
messageId |
|
map:ionToLogicalId |
MAP_ION_TO_LOGICAL_ID |
toLogicalId |
|
map:ionAccountingEntity or agr:ionAccountingEntity |
MAP_ION_ACCOUNTING_ENTITY AGR_ION_ACCOUNTING_ENTITY |
accountingEntity |
|
map:ionLocation or agr:ionLocation |
MAP_ION_LOCATION AGR_ION_LOCATION |
location |
|
map:ionDocumentId or agr:ionDocumentId |
MAP_ION_DOCUMENT_ID AGR_ION_DOCUMENT_ID |
documentId |
|
map:ionVariationId |
MAP_ION_VARIATION_ID |
variationId |
Must be a number. |
map:ionRevisionId or agr:ionRevisionId |
MAP_ION_REVISION AGR_ION_REVISION |
revisionId |
|
map:ionBatchId or agr:ionBatchId |
MAP_ION_BATCH_ID AGR_ION_BATCH_ID |
batchId |
|
map:ionBatchSequence or agr:ionBatchSequence |
MAP_ION_BATCH_SEQUENCE AGR_ION_BATCH_SEQUENCE |
batchSequence |
|
map:ionBatchSize or agr:ionBatchSize |
MAP_ION_BATCH_SEQUENCE AGR_ION_BATCH_SEQUENCE |
batchSize |
|
map:ionCustom_<property> or agr:ionCustom_<property> or (predefined properties) map:ionCustom_Field1 agr:ionCustom_Field1 map:ionCustom_Field2 agr:ionCustom_Field2 map:ionCustom_Field3 agr:ionCustom_Field3 |
AGR_ION_CUSTOM + "propertyName" MAP_ION_CUSTOM + "propertyName" or (predefined properties) MAP_ION_CUSTOM_FIELD1 MAP_ION_CUSTOM_FIELD2 MAP_ION_CUSTOM_FIELD3 |
custom_<propertyName> custom_Field1 custom_Field2 custom_Field3 |
If a map property is not available, then the corresponding
agr property is used. If none of the properties are available, then the
key-value pair is not sent.You can use up to three custom properties for IMS. If there are more than three custom properties in the manifest, then only the first three properties according to alphabetical property name order are used. A warning is logged. |
You can set all of them using the Mapper. Refer to the pattern and sample below:
Sample: setManifestInfo(ManifestConstants.MAP_ION_MESSAGE_ID, "SampleID");
Pattern: setManifestInfo(ManifestConstants.<ActualManifestConstant>, <value>);