EFM Data Items: FMS Configuration

The flow measurement configuration data item strings that follow describe FMS Configuration data items supported by CygNet.

Note: The eventItems section of your device template file does not contain configuration data items. However, changes to any data item in the configItem section results in an event being sent to FMS. Configuration data items are omitted from the eventItems section of the device template file to avoid data item duplication within the device template file.

See CygNet Measurement and Using the Configuration Control for more information about configuration data item usage in CygNet Measurement.

FMS Configuration Data Items

Configuration data item strings are listed in the following table along with their corresponding value options.

The table lists configuration data item strings in sections according to type of usage.

 

See FMS Data Items Units for information about valid units for configuration data items requiring units.

See Required Device Configuration Data for CygNet Measurement for information about minimum configuration requirements according to calculation/device type.

Gas Analysis Configuration Items

Also valid: Quality configuration items (except those marked liquid-specific)

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_GAS_ANALYSIS_BASE_PRESSURE 601 Base pressure Yes Base Pressure
eFMS_CFG_GAS_ANALYSIS_BASE_TEMPERATURE 602 Base temperature Yes Base Temperature
eFMS_CFG_GAS_ANALYSIS_HEATING_VALUE_BASIS 603 Heating Value basis No Heating Value Basis
eFMS_CFG_HEATING_VALUE_VOLUME_WET 545 Heating Value Volume - Wet Yes Heating Value Volume (Wet)
eFMS_CFG_HEATING_VALUE_VOLUME_DRY 546 Heating Value Volume - Dry Yes Heating Value Volume (Dry)
eFMS_CFG_HEATING_VALUE_VOLUME_AS_DELIVERED 547 Heating Value Volume - As delivered Yes Heating Value Volume - (As delivered)
eFMS_CFG_H2O_PER_VOLUME 548 Water - per volume unit Yes H2O per volume
eFMS_CFG_H2S_PPM 549 Hydrogen Sulfide - parts per million Yes H2S (PPM)
eFMS_CFG_TOTAL_H2S_PPM 554 Total Hydrogen Sulfide - parts per million Yes Total H2S (PPM)
eFMS_CFG_COS_PPM 550 Carbonyl Sulfide - parts per million Yes COS (PPM)
eFMS_CFG_MESH_PPM 551 Methanethiol - parts per million Yes MESH (PPM)
eFMS_CFG_ETSH_PPM 552 Ethanethiol - parts per million Yes ETSH (PPM)
eFMS_CFG_DMS_PPM 553 Dimethyl Sulfide - parts per million Yes DMS (PPM)
eFMS_CFG_SAMPLE_PRESSURE 555 Sample pressure Yes Sample Pressure
eFMS_CFG_SAMPLE_TEMPERATURE 556 Sample temperature Yes Sample Temperature
eFMS_CFG_SAMPLE_COUNT 557 Sample count No Sample Count
eFMS_CFG_SAMPLE_DATE 512 Sample date (liquid-specific) No Sample Date
eFMS_CFG_SAMPLE_RATE 522 Sample rate (liquid-specific) No Sample Rate
eFMS_CFG_SAMPLE_TYPE 513 Sample type (liquid-specific) No Sample Type

Options:

  • 1 or eFMS_CFG_SAMPLE_TYPE_SPOT - Spot; single sample taken
  • 2 or eFMS_CFG_SAMPLE_TYPE_COMPOSITE - Composite; sample taken on regular interval
  • 3 or eFMS_CFG_SAMPLE_TYPE_OFFLINE_UNKNOWN - Offline; method unknown
  • 4 or eFMS_CFG_SAMPLE_TYPE_ONLINE - Online; chromatograph
eFMS_CFG_INSTRUMENT_NUMBER 558 Instrument number for the sample No Instrument Number
eFMS_CFG_SAMPLE_TECHNICIAN 559 Name of the sample technician No Sample Technician
eFMS_CFG_SAMPLE_COMMENTS 560 Comments for the sample No Sample Comments
eFMS_CFG_ANALYSIS_TECHNICIAN 561 Name of the analysis technician No Analysis Technician
eFMS_CFG_ANALYSIS_COMMENTS 562 Comments for the analysis No Analysis Comments
eFMS_CFG_HEXANE_PLUS 563 Hexane plus Yes n-Hexane Plus
eFMS_CFG_ETHANE_LC 564 Ethane - Liquid Content Yes Ethane LC
eFMS_CFG_PROPANE_LC 565 Propane - Liquid Content Yes Propane LC
eFMS_CFG_ISOBUTANE_LC 607 Isobutane - Liquid Content Yes Isobutane LC
eFMS_CFG_N_BUTANE_LC 566 n-Butane - Liquid Content Yes n-Butane LC
eFMS_CFG_ISOPENTANE_LC 567 Isopentane - Liquid Content Yes Isopentane LC
eFMS_CFG_N_PENTANE_LC 568 n-Pentane - Liquid Content Yes n-Pentane LC
eFMS_CFG_N_HEXANE_LC 569 n-Hexane - Liquid Content Yes n-Hexane LC
eFMS_CFG_N_HEPTANE_LC 570 n-Heptane - Liquid Content Yes n-Heptane LC
eFMS_CFG_N_OCTANE_LC 608 n-Octane - Liquid Content Yes n-Octane LC
eFMS_CFG_N_NONANE_LC 609 n-Nonane - Liquid Content Yes n-Nonane LC
eFMS_CFG_N_DECANE_LC 610 n-Decane - Liquid Content Yes n-Decane LC
eFMS_CFG_CONDENSATE_LC 571 Condensate - Liquid Content Yes Condensate LC

Custom Gas Analysis Configuration Items

Note: To avoid a database misconfiguration, DO NOT re-map the following items once they have been initially mapped.

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_CUSTOM_NUMBER1 596 Custom Number 1 No As configured; can be any valid supported numerical configuration item
eFMS_CFG_CUSTOM_NUMBER2 597 Custom Number 2 No As configured; can be any valid supported numerical configuration item
eFMS_CFG_CUSTOM_NUMBER3 598 Custom Number 3 No As configured; can be any valid supported numerical configuration item
eFMS_CFG_CUSTOM_NUMBER4 599 Custom Number 4 No As configured; can be any valid supported numerical configuration item
eFMS_CFG_CUSTOM_NUMBER5 600 Custom Number 5 No As configured; can be any valid supported numerical configuration item

Back to top

Quality Configuration Items

(also valid as Gas Analysis or Metering configuration items, except those marked liquid-specific)

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_METHANE 30 Methane (C1) Yes Methane
eFMS_CFG_ETHANE 31 Ethane (C2) Yes Ethane
eFMS_CFG_PROPANE 32 Propane (C3) Yes Propane
eFMS_CFG_ISOBUTANE 33 Isobutane (isoC4) Yes Isobutane
eFMS_CFG_N_BUTANE 34 n-Butane (C4) Yes n-Butane
eFMS_CFG_ISOPENTANE 35 Isopentane (isoC5) Yes Isopentane
eFMS_CFG_N_PENTANE 36 n-Pentane (C5) Yes n-Pentane
eFMS_CFG_NEO_PENTANE 37 Neopentane (neoC5) Yes Neopentane
eFMS_CFG_N_HEXANE 38 n-Hexane (C6) Yes n-Hexane
eFMS_CFG_N_HEPTANE 39 n-Heptane (C7) Yes n-Heptane
eFMS_CFG_N_OCTANE 40 n-Octane (C8) Yes n-Octane
eFMS_CFG_N_NONANE 41 n-Nonane (C9) Yes n-Nonane
eFMS_CFG_N_DECANE 42 n-Decane (C10) Yes n-Decane
eFMS_CFG_NITROGEN 43 Nitrogen (N2) Yes Nitrogen
eFMS_CFG_CARBON_DIOXIDE 44 Carbon dioxide (CO2) Yes Carbon Dioxide
eFMS_CFG_WATER 45 Water (H2O) Yes Water
eFMS_CFG_HYDROGEN_SULFIDE 46 Hydrogen sulfide (H2S) Yes Hydrogen Sulfide
eFMS_CFG_HYDROGEN 47 Hydrogen (H2) Yes Hydrogen
eFMS_CFG_CARBON_MONOXIDE 48 Carbon monoxide (CO) Yes Carbon Monoxide
eFMS_CFG_OXYGEN 49 Oxygen (O2) Yes Oxygen
eFMS_CFG_HELIUM 50 Helium (He) Yes Helium
eFMS_CFG_ARGON 51 Argon (Ar) Yes Argon
eFMS_CFG_DEW_POINT 60 Dew point No Dew Point
eFMS_CFG_RELATIVE_DENSITY 58 Relative density No Relative Density
eFMS_CFG_VISCOSITY 61 Viscosity Yes Viscosity
eFMS_CFG_HEATING_VALUE_MASS 56 Heating value - mass Yes (Config) Heating Value Mass
eFMS_CFG_HEATING_VALUE_VOLUME 55 Heating value - volume Yes (Config) Heating Value Volume

Quality Configuration Items - Gas-Specific

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_COMPRESSIBILITY 59 Compressibility (gas-specific) No Compressibility
eFMS_CFG_HEATING_VALUE_BASIS 57 Heating value basis (gas-specific) No (Config) Heating Value Basis

Options:

  • 1 or eFMS_CFG_HEATING_VALUE_BASIS_WET - Wet
  • 2 or eFMS_CFG_HEATING_VALUE_BASIS_DRY - Dry
  • 3 or eFMS_CFG_HEATING_VALUE_BASIS_AS_DELIVERED - As delivered
  • 4 or eFMS_CFG_HEATING_VALUE_BASIS_UNSPECIFIED - Unspecified

Quality Configuration Items - Liquid-Specific

(not currently supported in all FMS Explorer controls)

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_ETHYLENE 540 Ethylene (liquid-specific) Yes Ethylene
eFMS_CFG_PROPYLENE 541 Propylene (liquid-specific) Yes Propylene

Back to top

Metering Configuration Items

Also valid: Quality configuration items (except those marked liquid-specific)

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_ATMOSPHERIC_PRESSURE 24 Atmospheric pressure Yes Atmospheric Pressure
eFMS_CFG_BASE_PRESSURE 10 Base pressure Yes (Config) Base Pressure
eFMS_CFG_BASE_TEMPERATURE 11 Base temperature Yes (Config) Base Temperature
eFMS_CFG_CALIBRATION_FACTOR 78 Calibration factor No Calibration Factor
eFMS_CFG_CONE_DIAMETER 18 Cone diameter Yes Cone Diameter
eFMS_CFG_CONE_MATERIAL 20 Cone material No Cone Material

Options:

  • 1 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL - Stainless steel
  • 2 or eFMS_CFG_MATERIAL_TYPE_MONEL - Monel
  • 3 or eFMS_CFG_MATERIAL_TYPE_CARBON_STEEL - Carbon steel
  • 4 or eFMS_CFG_MATERIAL_TYPE_UNSPECIFIED - Unspecified

Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_CONE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.

eFMS_CFG_CONE_REF_TEMP 19 Cone reference temperature Yes Cone Ref Temp
eFMS_CFG_CONTRACT_HOUR 9 Contract hour No Contract Hour
eFMS_CFG_DISCHARGE_COEFFICIENT 27 Discharge coefficient No Discharge Coefficient
eFMS_CFG_DP_ALARM_HIGH 107 DP alarm - high Yes DP Alarm High
eFMS_CFG_DP_ALARM_LOW 106 DP alarm - low Yes DP Alarm Low
eFMS_CFG_DP_BACKFLOW_ALARM 114 DP alarm - backflow Yes DP Backflow Alarm
eFMS_CFG_DP_CALIBRATE_HIGH 116 DP calibrate - high Yes DP Calibrate High
eFMS_CFG_DP_CALIBRATE_LOW 115 DP calibrate - low Yes DP Calibrate Low
eFMS_CFG_DP_TAPS_TYPE 21 DP taps type No DP Tap Style

Options:

  • 1 or eFMS_CFG_DP_TAPS_TYPE_FLANGE - Flange
  • 2 or eFMS_CFG_DP_TAPS_TYPE_PIPE - Pipe
eFMS_CFG_DP_TRANSDUCER_RANGE_HIGH 101 DP transducer range - high Yes DP Transducer Range High
eFMS_CFG_DP_TRANSDUCER_RANGE_LOW 100 DP transducer range - low Yes DP Transducer Range Low
eFMS_CFG_ELEVATION 86 Elevation Yes Elevation
eFMS_CFG_FIXED_TEMP 85 Fixed temperature Yes Fixed Temp (if eFMS_CFG_USE_LIVE_TEMP = No)

eFMS_CFG_FLASH_GAS_FACTOR

611

Flash gas factor (liquid-specific)

No

Flash Gas Factor

eFMS_CFG_FLOW_COMPUTER_ID 133

Flow computer ID

No Flow Computer ID
eFMS_CFG_FLOW_COMPUTER_BRAND 134

Flow computer brand

No Flow Computer Brand
eFMS_CFG_FLOW_COMPUTER_MODEL 135

Flow computer model

No Flow Computer Model
eFMS_CFG_FLOW_COMPUTER_SOFTWARE_VERSION 136

Flow computer software version

No Flow Computer Software Version
eFMS_CFG_FLOW_RATE_ALARM_HIGH 113 Flow rate - high Yes Flow Rate Alarm High
eFMS_CFG_FLOW_RATE_ALARM_LOW 112 Flow rate - low Yes Flow Rate Alarm Low
eFMS_CFG_FLUID_TYPE 81 Fluid type No Fluid Type

Options:

  • 1 or eFMS_CFG_FLUID_TYPE_COMPRESSIBLE - Compressible
  • 2 or eFMS_CFG_FLUID_TYPE_NONCOMPRESSIBLE - Non-compressible
eFMS_CFG_ISENTROPIC_EXPONENT 82 Isentropic exponent No Isentropic Exponent
eFMS_CFG_LOW_FLOW_CUTOFF_DP 89 Low flow cutoff - differential pressure Yes Low Flow Cutoff DP

(can apply to Orifice or Cone device type)

eFMS_CFG_LOW_FLOW_CUTOFF_FLOW_RATE 90 Low flow cutoff - volume flow rate Yes Low Flow Cutoff Flow Rate

(can apply to Orifice, Turbine, Ultrasonic, Cone, or Coriolis device type)

eFMS_CFG_LOW_FLOW_CUTOFF_MASS 128 Low flow cutoff - mass flow rate Yes Low Flow Cutoff Mass

(can apply to Coriolis device type)

eFMS_CFG_LOW_FLOW_CUTOFF_PULSE_INTERVAL 91 Low flow cutoff - pulse interval Yes Low Flow Cutoff Pulse Interval

(can apply to Turbine, Ultrasonic, or Coriolis device type)

eFMS_CFG_METER_DESC 8 Meter description No Device Description
eFMS_CFG_METER_FACTOR 25 Meter factor No Meter Factor
eFMS_CFG_METER_ID 7 Meter ID No Device Name
eFMS_CFG_METER_TUBE_INSIDE_DIAMETER 12 Meter tube inside diameter Yes Meter Tube Inside Diameter
eFMS_CFG_METER_TUBE_MATERIAL 14 Meter tube material No Meter Tube Material

Options:

  • 1 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL - Stainless steel (unspecified type)
  • 2 or eFMS_CFG_MATERIAL_TYPE_MONEL - Monel (valid for AGA 3 1985 or 1992 only)
  • 3 or eFMS_CFG_MATERIAL_TYPE_CARBON_STEEL - Carbon steel
  • 4 or eFMS_CFG_MATERIAL_TYPE_UNSPECIFIED - Unspecified
  • 5 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL_304 - Stainless steel 304 (valid for AGA 3 2013 only)
  • 6 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL_316 - Stainless steel 316 (valid for AGA 3 2013 only)
  • 7 or eFMS_CFG_MATERIAL_TYPE_MONEL_400 - Monel 400 (valid for AGA 3 2013 only)

Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_PIPE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.

eFMS_CFG_METER_TUBE_REF_TEMP 13 Meter tube reference temperature Yes Meter Tube Ref Temp

eFMS_CFG_METER_TYPE

1 Meter type No Device Type

Options:

  • 1 or eFMS_CFG_METER_TYPE_ORIFICE - Orifice
  • 2 or eFMS_CFG_METER_TYPE_POSITIVE - Positive (supported for liquid devices)
  • 3 or eFMS_CFG_METER_TYPE_TURBINE - Turbine
  • 4 or eFMS_CFG_METER_TYPE_ULTRASONIC - Ultrasonic
  • 5 - (not supported)
  • 6 or eFMS_CFG_METER_TYPE_CONE - Cone
  • 7 or eFMS_CFG_METER_TYPE_CORIOLIS - Coriolis
eFMS_CFG_ORIFICE_PLATE_BORE_SIZE 15 Orifice plate bore size Yes Orifice Plate Bore Size
eFMS_CFG_ORIFICE_PLATE_MATERIAL 17 Orifice plate material No Orifice Plate Material

Options:

  • 1 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL - Stainless steel (unspecified type)
  • 2 or eFMS_CFG_MATERIAL_TYPE_MONEL - Monel (valid for AGA 3 1985 or 1992 only)
  • 3 or eFMS_CFG_MATERIAL_TYPE_CARBON_STEEL - Carbon steel
  • 4 or eFMS_CFG_MATERIAL_TYPE_UNSPECIFIED - Unspecified
  • 5 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL_304 - Stainless steel 304 (valid for AGA 3 2013 only)
  • 6 or eFMS_CFG_MATERIAL_TYPE_STAINLESS_STEEL_316 - Stainless steel 316 (valid for AGA 3 2013 only)
  • 7 or eFMS_CFG_MATERIAL_TYPE_MONEL_400 - Monel 400 (valid for AGA 3 2013 only)

Note: This field is "Unspecified" for devices that do not return a material type value. In these cases, a (non-zero) thermal expansion coefficient value (eFMS_CFG_PIPE_COEFFICIENT_THERMAL_EXPANSION) is required for calculation to succeed.

eFMS_CFG_ORIFICE_PLATE_REF_TEMP 16 Orifice plate reference temperature Yes Orifice Plate Ref Temp
eFMS_CFG_SP_ALARM_HIGH 109 SP alarm - high Yes SP Alarm High
eFMS_CFG_SP_ALARM_LOW 108 SP alarm - low Yes SP Alarm Low
eFMS_CFG_SP_CALIBRATE_HIGH 118 SP calibrate - high Yes SP Calibrate High
eFMS_CFG_SP_CALIBRATE_LOW 117 SP calibrate - low Yes SP Calibrate Low
eFMS_CFG_SP_SENSOR_TYPE 23 SP sensor type No SP Sensor Type

Options:

  • 1 or eFMS_CFG_SP_SENSOR_TYPE_ABSOLUTE - Absolute
  • 2 or eFMS_CFG_SP_SENSOR_TYPE_GAUGE - Gauge
eFMS_CFG_SP_TAP_LOCATION 22 SP tap location No SP Tap Location

Options:

  • 1 or eFMS_CFG_SP_TAP_LOCATION_UPSTREAM - Upstream
  • 2 or eFMS_CFG_SP_TAP_LOCATION_DOWNSTREAM - Downstream
eFMS_CFG_SP_TRANSDUCER_RANGE_LOW 102 SP transducer range - low Yes SP Transducer Range Low
eFMS_CFG_SP_TRANSDUCER_RANGE_HIGH 103 SP transducer range - high Yes SP Transducer Range High
eFMS_CFG_TEMP_ALARM_HIGH 111 Temp alarm - high Yes Temp Alarm High
eFMS_CFG_TEMP_ALARM_LOW 110 Temp alarm - low Yes Temp Alarm Low
eFMS_CFG_TEMP_CALIBRATE_HIGH 120 Temp calibrate - high Yes Temp Calibrate High
eFMS_CFG_TEMP_CALIBRATE_LOW 119 Temp calibrate - low Yes Temp Calibrate Low
eFMS_CFG_TEMP_CALIBRATE_ZERO 121 Temp calibrate - zero Yes Temp Calibrate Zero
eFMS_CFG_TEMP_TRANSDUCER_RANGE_LOW 104 Temp transducer range - low Yes Temp Transducer Range Low
eFMS_CFG_TEMP_TRANSDUCER_RANGE_HIGH 105 Temp transducer range - high Yes Temp Transducer Range High
eFMS_CFG_USE_LIVE_TEMP 84 Use live temperature No Use Live Temp

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes
eFMS_CFG_USE_LIVE_K_FACTOR 125 Use live K factor No Use Live K Factor

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes
eFMS_CFG_USE_LIVE_METER_FACTOR 126 Use live meter factor No Use Live Meter Factor

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes

Metering Configuration Items - Gas-Specific

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_AGA3_EXPANDED_RANGE 88 AGA 3 Expanded Range (gas-specific) No AGA 3 Expanded Range

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes
eFMS_CFG_AGA8_EXPANDED_RANGE

See AGA 8 Data Ranges for more information.

87 AGA 8 Expanded Range (gas-specific) No AGA 8 Expanded Range

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes
eFMS_CFG_BASE_COMPRESSIBILITY_OF_AIR 83 Standard air compressibility (gas-specific) No Base Compressibility of Air
eFMS_CFG_CALC_METHOD_DISCHARGE_COEFFICIENT 5 Discharge coefficient calc method (gas-specific) No Discharge Coefficient Calc

Options:

  • 1 or eFMS_CFG_CALC_METHOD_DISCHARGE_COEFFICIENT_NONE - None
eFMS_CFG_CALC_METHOD_FPV 3 Compressibility calc method (gas-specific) No FPV Calc

Options:

  • 1 or eFMS_CFG_CALC_METHOD_FPV_AGA8_GROSS_1 - AGA 8 Gross 1
  • 2 or eFMS_CFG_CALC_METHOD_FPV_AGA8_GROSS_2 - AGA 8 Gross 2
  • 3 or eFMS_CFG_CALC_METHOD_FPV_AGA8_DETAIL - AGA 8 Detail
  • 4 or eFMS_CFG_CALC_METHOD_FPV_NX19_GCN - NX 19 GCN
  • 5 or eFMS_CFG_CALC_METHOD_FPV_NX19_COMPLETE - NX 19 Complete
  • 6 or eFMS_CFG_CALC_METHOD_FPV_NONE - None
  • 7 - GERG (not supported)
eFMS_CFG_CALC_METHOD_GAS_EXPANSION_FACTOR 6 Gas expansion factor calc method (gas-specific) No Gas Expansion Factor Calc

Options:

  • 1 or eFMS_CFG_CALC_METHOD_GAS_EXPANSION_FACTOR_NONE - None
eFMS_CFG_CALC_METHOD_HV 4 Heating value calc method (gas-specific) No HV Calc

Options:

  • 1 or eFMS_CFG_CALC_METHOD_HV_AGA5 - AGA 5
  • 2 or eFMS_CFG_CALC_METHOD_HV_GPA2172 - GPA 2172
  • 3 or eFMS_CFG_CALC_METHOD_HV_NONE - None

Note: For gas analysis, FMS calculations are based on GPA 2172-09. See CygNet Measurement Data Calculation for more information.

eFMS_CFG_CALC_METHOD_PRIMARY 2 Primary calc method (gas-specific) No Primary Calc

Options:

  • 1 or eFMS_CFG_CALC_METHOD_PRIMARY_AGA3_85 - AGA 3 1985
  • 2 or eFMS_CFG_CALC_METHOD_PRIMARY_AGA3_92 - AGA 3 1992
  • 3 or eFMS_CFG_CALC_METHOD_PRIMARY_AGA7 - AGA 7
  • 4 - Cone (not supported)
  • 5 - AGA 9 (not supported)
  • 6 or eFMS_CFG_CALC_METHOD_PRIMARY_AGA11 - AGA 11
  • 7 or eFMS_CFG_CALC_METHOD_PRIMARY_VCONE - VCone
  • 8 - AGA 5 (not supported)
  • 9 - ISO 9951 (not supported)
  • 10 - ISO 5167 (not supported)
  • 11 or eFMS_CFG_CALC_METHOD_PRIMARY_WAFER_CONE - Wafer Cone
  • 12 or eFMS_CFG_CALC_METHOD_PRIMARY_AGA3_13 - AGA 3 2013
eFMS_CFG_INTEGRAL_VALUE_VARIABLES 28 Variables included in IV (gas-specific) No IV Definition

Options:

  • 1 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_BASE_FT - (FT*DP[inh2o]*SP[psia])
  • 2 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP_FT - (FT*DP[inh2o]*SP[psia])/T[R]
  • 3 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_GR_FT - (FT*DP[inh2o]*SP[psia])/Gr
  • 4 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP_GR_FT - (FT*DP[inh2o]*SP[psia])/(T[R]*Gr))
  • 5 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_NONE - None
  • 6 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_BASE_EX1_FT - (FT*DP[mBar]*SP[bar])
  • 7 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP_EX1_FT - (FT*DP[mBar]*SP[bar])/T[K]
  • 8 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_BASE - (DP[inh2o]*SP[psia])
  • 9 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP - (DP[inh2o]*SP[psia])/T[R]
  • 10 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_GR - (DP[inh2o]*SP[psia])/Gr
  • 11 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP_GR - (DP[inh2o]*SP[psia])/(T[R]*Gr)
  • 12 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_BASE_EX1 - (DP[mBar]*SP[bar])
  • 13 or eFMS_CFG_INTEGRAL_VALUE_VARIABLES_PLUS_TEMP_EX1 - (DP[mBar]*SP[bar])/T[K]
eFMS_CFG_GAS_K_FACTOR_MASS 127 K factor - mass (gas-specific) Yes K Factor Mass
eFMS_CFG_GAS_K_FACTOR_VOLUME 26 K factor - volume (gas-specific) Yes K Factor Volume
eFMS_CFG_CONE_COEFFICIENT_THERMAL_EXPANSION 130 Cone thermal expansion coefficient (gas-specific) Yes Cone Expansion Coefficient
eFMS_CFG_ORIFICE_COEFFICIENT_THERMAL_EXPANSION 75 Orifice (linear) thermal expansion coefficient (gas-specific) Yes Orifice Expansion Coefficient
eFMS_CFG_PIPE_COEFFICIENT_THERMAL_EXPANSION 76 Pipe (linear) thermal expansion coefficient (gas-specific) Yes Pipe Expansion Coefficient
eFMS_CFG_LINEAR_CURVE_TYPE 129 Linear curve type (gas-specific) No Linear Curve Type

Options:

  • 1 or eFMS_CFG_LINEAR_CURVE_TYPE_BOTH_CONST - Meter Factor and K Factor are both constant
  • 2 or eFMS_CFG_LINEAR_CURVE_TYPE_KF_AVG - K Factor is averaged, and Meter Factor is constant
  • 3 or eFMS_CFG_LINEAR_CURVE_TYPE_MF_AVG - Meter Factor is averaged, and K Factor is constant
eFMS_CFG_USE_CORIOLIS_PRESSURE_EFFECT 122 Use coriolis pressure effect (gas-specific) No Use Coriolis Pressure Effect

Options:

  • 0 or eFMS_YESNO_NO - No
  • 1 or eFMS_YESNO_YES - Yes
eFMS_CFG_CORIOLIS_PRESSURE_EFFECT 123 Percent of rate per gauge pressure (gas-specific) Yes Coriolis Pressure Effect
eFMS_CFG_CORIOLIS_CALIBRATION_PRESSURE 124 Pressure at which the pressure effect was calibrated (gas-specific) Yes Coriolis Calibration Pressure
eFMS_CFG_WATER_VAPOR_CORRECTION_FACTOR 74 Water vapor correction factor (gas-specific) No Water Vapor Correction factor
eFMS_CFG_WELL_STREAM_FACTOR 77 Well stream factor (gas-specific) No Well Stream factor

Metering Configuration Items - Liquid-Specific

(not currently fully supported in all FMS Explorer controls)

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_DENSITY_METER_FACTOR 537 Density meter factor (liquid-specific) No DMF
eFMS_CFG_MASS_FLOW_RATE_ALARM_HIGH 132 Mass flow rate alarm - high (liquid-specific) Yes Flow Rate Alarm High
eFMS_CFG_MASS_FLOW_RATE_ALARM_LOW 131 Mass flow rate alarm - low (liquid-specific) Yes Flow Rate Alarm Low
eFMS_CFG_LIQ_K_FACTOR_MASS 543 K factor - mass (liquid-specific) Yes K Factor Mass
eFMS_CFG_LIQ_K_FACTOR_VOLUME 542 K factor - volume (liquid-specific) Yes K Factor Volume
eFMS_CFG_LIQUID_CALC_METHOD 539 Liquid calculation method (liquid-specific) No Liquid Calculation Method

Options:

  • 1 or eFMS_CFG_LIQUID_CALC_METHOD_NONE - None
  • 2 or eFMS_CFG_LIQUID_CALC_METHOD_API_12_2 - API 12.2
  • 3 or eFMS_CFG_LIQUID_CALC_METHOD_API_14_7 - API 14.7
  • 4 or eFMS_CFG_LIQUID_CALC_METHOD_DIRECT_MASS - Direct Mass
  • 5 or eFMS_CFG_LIQUID_CALC_METHOD_API_14_3_MASS - API 14.3: Mass
  • 6 or eFMS_CFG_LIQUID_CALC_METHOD_API_14_3_VOLUME - API 14.3: Volume
  • 7 or eFMS_CFG_LIQUID_CALC_METHOD__PRIMARY_ISO_5167 - ISO 5167
  • 8 or eFMS_CFG_LIQUID_CALC_METHOD_VCONE - V-Cone
  • 9 or eFMS_CFG_LIQUID_CALC_METHOD_API_12_2_INFERRED_VOLUME - API 12.2
eFMS_CFG_LIQUID_PRODUCT_INDEX 544 Product index (liquid-specific) No Product Index
eFMS_CFG_TOTALIZER_DIGITS 538 Totalizer digits (liquid-specific) No Totalizer Digits
eFMS_CFG_SHRINK_FACTOR 604 Shrink factor (liquid-specific) No Shrink Factor
eFMS_CFG_STOCK_TANK_DENSITY 605 Stock tank - density (liquid-specific) Yes Stock Tank Density
eFMS_CFG_STOCK_TANK_SW 606 Stock tank - sediment and water (liquid-specific) Yes Stock Tank S&W

 

 

 

 

 

Back to top

Custom Configuration Items - Gas-Specific

Note: To avoid a database misconfiguration, DO NOT re-map the following items once they have been initially mapped.

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_CUSTOM1 500 Custom 1 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM2 501 Custom 2 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM3 502 Custom 3 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM4 503 Custom 4 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM5 504 Custom 5 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM6 505 Custom 6 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM7 506 Custom 7 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM8 507 Custom 8 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM9 508 Custom 9 No As configured; can be any valid configuration item
eFMS_CFG_CUSTOM10 509 Custom 10 No As configured; can be any valid configuration item

Custom Configuration Items - Gas-Specific

Note: To avoid a database misconfiguration, DO NOT re-map the following items once they have been initially mapped.

See Configuring Custom Device Data in the CygNet Measurement section for more information.

FMS Configuration Data Item String Enum Data Item Description Units Required for FMS? FMS Explorer Description
eFMS_CFG_ACCUMULATED_VOLUME 517 Accumulated volume (gas-specific) Yes Can be mapped as a custom gas configuration item.
eFMS_CFG_AIR 536 Air (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_COLD_START_DATETIME 515 Cold start date/time (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_CONTRACT_DAY 523 Contract day (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_DELIVERY_DATE 519 Delivery date (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_DP_CALIBRATE_MID 525 DP calibrate - mid (gas-specific) Yes Can be mapped as a custom gas configuration item.
eFMS_CFG_EXPANSION_FACTOR 530 Expansion factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_FLOWING_TEMPERATURE_FACTOR 533 Flowing temperature factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_LATITUDE 510 Latitude (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_LONGITUDE 511 Longitude (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_METER_ACCESS_DATETIME 514 Meter access date/time (liquid-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_METER_SERIAL_NUMBER 518 Meter serial number (liquid-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_ORIFICE_FITTING_TYPE 521 Orifice fitting type (liquid-specific) No Can be mapped as a custom gas configuration item.

Options:

  • 1 or eFMS_ORIFICE_FITTING_TYPE_SENIOR - Senior
  • 2 or eFMS_ORIFICE_FITTING_TYPE_JUNIOR - Junior
  • 3 or eFMS_ORIFICE_FITTING_TYPE_SIMPLEX - Simplex
eFMS_CFG_ORIFICE_FLOW_FACTOR 528 Orifice flow factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_POWER_SOURCE 520 Power source (gas-specific) No Can be mapped as a custom gas configuration item.

Options:

  • 1 or eFMS_CFG_POWER_SOURCE_AC - AC
  • 2 or eFMS_CFG_POWER_SOURCE_BATT - Batt
  • 3 or eFMS_CFG_POWER_SOURCE_SOLAR - Solar
eFMS_CFG_PRESSURE_BASE_FACTOR 531 Pressure base factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_RELATIVE_DENSITY_FACTOR 534 Relative density factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_REYNOLDS_FACTOR 529 Reynolds factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_SP_CALIBRATE_MID 526 SP calibrate - mid (gas-specific) Yes Can be mapped as a custom gas configuration item.
eFMS_CFG_SUPERCOMPRESSIBILITY_FACTOR 535 Supercompressibility factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_TEMP_CALIBRATE_MID 527 Temp calibrate - mid (gas-specific) Yes Can be mapped as a custom gas configuration item.
eFMS_CFG_TEMPERATURE_BASE_FACTOR 532 Temperature base factor (gas-specific) No Can be mapped as a custom gas configuration item.
eFMS_CFG_WARM_START_DATETIME 516 Warm start date/time (gas-specific) No Can be mapped as a custom gas configuration item.

More:

Back to top