Mapping EFM Data Items — FMS and FMS Legacy Only

Some EFM-enabled device template files contain special elements called fmsMaps and gmrMaps. fmsMaps is only required if you are using FMS; gmrMaps is only required if you are using FMS Legacy. Each contains subsections that correspond to the EFM data groups in your template, and each subsection contains a number of FMS and/or FMS Legacy data items.

EFM data items are associated with specific data group elements from a support data group by means of a deid attribute. (In special Modbus EFM cases, a register number may be used to associate the data item with a data source.) EFM data groups contain support data group (supportDg) elements that reference the native data groups that contain the associated data elements. The combination of support data group and specific data group elements within it ensures that the data element referenced by an EFM data item is the correct one.

See the following subsections for more information:

For information about measurement units, see Defining EFM Data Item Units.

For information about how to configure EFM data items in a particular device template file, see the appropriate EIE subsection in Remote Devices.

For information about how data items can optionally be mapped from FMS or FMS Legacy to export EFM data files to Flow-Cal, see Mapping Data Items for Flow-Cal Export.

Example

<!-- In the following example, the FmsConfig data group has 3 support data groups. One of these support data groups has 4 data group elements. But the FmsConfig data group requires data from only 2 of these data group elements. The required data group elements are referenced in corresponding EFM configuration items located in the fmsMaps section. -->

<FmsConfig>

<supportDg>

<SupportDg1/>

<SupportDg2/>

<SupportDg3/>

</supportDg>

</FmsConfig>

...

<SupportDg1>

<dgElements>

<DEID1/>

<DEID2/>

<DEID3/>

<DEID4/>

</dgElements>

</SupportDg1>

...

<fmsMaps>

<configItems>

<eFMS_CFG_ITEM1 deid="DEID1"/>

<eFMS_CFG_ITEM2 deid="DEID2"/>

</configItems>

</fmsMaps>

To Map Data Items

There are multiple ways to map data items and the possible combinations of useful data items is extensive. How you choose to map your data items depends on many variables.

The following is one possible basic sequence for mapping data items:

  1. Add all the EFM data groups you require.
  2. Add a supportDg subsection to each EFM data group.
  3. Add support data groups to the supportDg subsection. The supportDg elements reference native data groups.

    4. Note: Some EFM data groups are hard-coded to include an associated support group. If this is the case, you do not need to manually add the hard-coded support data group, nor can you configure it.

  1. Add an fmsMaps and/or gmrMaps section to your template. Best practice is to place this section near the end of your template.
  2. Add items subsections to your gmrMaps and/or fmsMaps sections that correspond to all of the EFM data groups in your template.
  3. Populate each of the items subsections with all of the appropriate EFM data items you require.
  4. Use the deid attribute in EFM item elements to define data group IDs (DEID) that correspond to data group elements that are the source of data for this particular EFM data item.

    5. Note: For FMS Legacy only, certain EIEs can compute flow rate using flow volume and flow time if flow rate is not provided by a device. To compute flow rate in such a case, include a flow time data item in the histItems section of gmrMaps in your device template file. Do not include a deid in the flow rate data item.

  1. Add the appropriate data item attributes and when clauses to your flow measurement data items.

Back to top