This document explains how inspection sync model numbers are used to match mechanical equipment types in your component library.

Mechanical Equipment can be supplied in an Inspection Sync JSON with 0-3 model numbers, which are used to try to find a mechanical equipment type in the component library that has those model numbers. If such a component type is found, it replaces the existing type of the mechanical equipment at the specified index. We call this "Model Number Matching".

Each model number supplied in a JSON is searched for in three places. First, it is looked for in the corresponding “Model Number” field of the library type, to which it must be an exact match. Second it is looked for in the “Name” field of the library type, which does not need to be an exact match but must contain the entire model number string (e.g. if the JSON contains “modelNumber”: ”mdn-123”, a library type with the name “Air Conditioner mdn-123 18K/SEER” would be matched because the name contains “mdn-123”). Third, the model number is looked for in the “Description” field where the same rules apply as in “Name”. This means that existing library types with model numbers in their Name/Description can be matched without updating their model number field(s).

Rules For Matching

How Inspection Sync Matches Mechanical Equipment Types

Inspection Sync fields are matched to fields in Mechanical Equipment Library Types as follows:

All Inspection Sync Fields Must Be Found in the Equipment Type

All model number fields supplied in the JSON must be found in the equipment type for it to be used.

• For example, if the following is supplied in the JSON:

"mechanicalEquipments": [
      {
        "index": 0,
        "modelNumber": "MDN-1111",
        "secondModelNumber" : "mdn-2222"
      }
]

And there is a mechanical equipment type with "MDN-1111" in its first model number field, but its second model number field is empty and "mdn-2222" isn't in its Name or Description, then it will not be matched. If no full match is found, the type in use in the project will not change.

All Model Numbers of the Equipment Type Must Be Matched

All model numbers in the Library Type must be matched.

• For example, if an AC unit has an Outdoor Model # (first model number) of "MDN-1111" and an Indoor Model # (second) of "mdn-2222", then this input would match that type:

"mechanicalEquipments": [
      {
        "index": 0,
        "modelNumber": "MDN-1111",
        "secondModelNumber" : "mdn-2222"
      }
]

But this input would not:

"mechanicalEquipments": [
      {
        "index": 0,
        "modelNumber": "MDN-1111"
      }
]

If No Equipment Types Are Matched

If no mechanical equipment type is found in Ekotrope with model numbers that match the given values (or have those values in their name/description), the original mechanical equipment type will not be changed. The failure to find an equipment with the given model numbers will be reported in the results email.

If Multiple Equipment Types Are Matched

In the case there are multiple equipment types found that match the given inputs, one will be chosen based on best-fit. For each model number given, best fit is determined by: The corresponding model number field > Name > Description.

• For example, if library type A has "MDN-1111" in its first Model Number field and library type B has "MDN-1111" in its Description, A will always be the match for the input "modelNumber" : "MDN-1111".
• In the case of library types that have exactly the same Model Number fields, or the model number in their Name, etc. one will be chosen at random, but the email report will indicate that there were multiple choices and list them all by their Names.

Example with the Library Type Interface