Skip to content

AttributeFile Schema

File: AttributeFile.json
Purpose: Defines attribute metadata for all entity types in the inRiver export
Format: JSON array of entity type definitions

Structure

json
[
  {
    "EntityTypeId": "string",
    "Attributes": [
      {
        "AttributeId": "string",
        "Name": {
          "stringMap": { "en": "Display Name", "es": "...", "fr-CA": "..." }
        },
        "SortOrder": number,
        "DataType": "string",
        "AvailableFieldsets": [
          { "Id": "string", "Name": { "stringMap": { "en": "..." } } }
        ],
        "IsMultiValue": boolean,
        "AllowedValues": { "key": "Display Name", ... }
      }
    ]
  }
]

IsMultiValue and AllowedValues are only present on CVL-type attributes.

Entity Types

The AttributeFile contains attribute definitions for 5 entity types:

Entity TypeAttributesCVL (AllowedValues)Multi-Value
Channel310
ChannelNode1910
Product21101
Item1,02219524
Resource1120

Data Types

  • String — Plain text
  • Boolean — True/false flags
  • Integer — Whole numbers
  • Double — Decimal values
  • LocaleString — Multi-language text (e.g., {"en": "...", "es": "...", "fr-CA": "..."})
  • CVLString — Controlled Value List (has AllowedValues mapping)
  • File — File reference

CVL Attributes (AllowedValues)

Attributes with DataType: "CVLString" include an AllowedValues object mapping internal keys to display names. These serve as the lookup for resolving coded values in entity exports.

json
{
  "AttributeId": "ItemANSIStandards",
  "Name": {
    "stringMap": {
      "en": "ANSI Standards",
      "fr-CA": "Normes ANSI",
      "es": "Estándares ANSI"
    }
  },
  "SortOrder": 625,
  "DataType": "CVLString",
  "AvailableFieldsets": [
    { "Id": "ItemLaddersandAccessories", "Name": { "stringMap": { "en": "Ladders and Accessories" } } }
  ],
  "IsMultiValue": true,
  "AllowedValues": {
    "A14.52007": "A14.5 (2007)",
    "OSHA": "OSHA",
    "Type1": "Type 1"
  }
}

When IsMultiValue: true, the entity export value is a multi-select CVL (keys/values arrays). When false, it's a single-select CVL (key/value object).

Multi-Value CVL Examples (Item)

  • ItemANSIStandards (7 values)
    • A14.5 (2007), OSHA, A14.2-2017 6.2.4, A14.2 (2007), ...3 more
  • ItemApprovals (35 values)
    • CUL Listed, UL Listed, UL Recognized, ETL Listed, ...31 more
  • ItemBasisOfRotationView (4 values)
    • Lead End, Shaft End, Drive End, Power End
  • ItemBeltSection (7 values)
    • 4L or A, 5L or B; 4L or A; 3L; 5L or B, ...3 more
  • ItemCondenserLocation (3 values)
    • Outdoor, Indoor, Indoor or Outdoor

Single-Value CVL Examples (Item)

  • ItemAHRIUsage (5 values)
    • Indoor AHU, Outdoor, Packaged, Indoor Coil, ...1 more
  • ItemAirFlowDirection (11 values)
    • Horizontal, Multi-Position, Vertical, Convertible, ...7 more
  • ItemBasicItemInformationBypassRequestStatus (3 values)
    • Bypass Requested, Bypass Granted, Bypass Denied

Key Attributes by Entity

Item (1,022 attributes)

High-volume entity with extensive attribute set including:

  • Product identification (ItemManufacturerItemNo, ItemUPCCode, ItemEANCode)
  • Dimensions and weight (Imperial measurements)
  • Inventory data (ItemOnHandQtyInAllWatscoSubs)
  • Business unit flags (per-BU e-commerce activation)
  • Supplier information
  • Rebate and pricing data
  • 195 CVL attributes with full key→display name mappings

ChannelNode (19 attributes)

Navigation and categorization attributes:

  • ChannelNodeName (LocaleString)
  • ChannelNodeActiveInEcommerce (Boolean)
  • Per-business-unit activation flags (CECA, CECPD, CEFL, etc.)
  • SEO metadata (MetaTitle, MetaDescription, MetaKeywords)

Product (21 attributes)

Product-level attributes linking to items and resources:

  • ProductId, ProductMainSupplier, ProductShortDescription
  • Taxonomy references (ProductWatscoTaxonomy1–4)
  • 10 CVL attributes including manufacturer

Resource (11 attributes)

Media asset metadata:

AttributeDataTypeNotes
ResourceTitleStringDisplay title
ResourceResourceTypeCVLString60 values — maps codes to Image_Type names
ResourceFileIdFileInternal file reference
ResourceFilenameStringOriginal filename
ResourceMimeTypeStringe.g., "jpeg", "pdf"
ResourceContentHashStringSHA-256 hash
ResourcePublishedStatusCVLString3 values: NotPublished, PublishedToBlobStorage, DoNotPublish
ResourceSourceURLStringOrigin URL
ResourceNameStringResource name
ResourceAcceptedFileBooleanAcceptance flag
ResourceImportProcessedBooleanImport processing flag

ResourceResourceType CVL (60 values)

This CVL maps abbreviated codes to the human-readable Image_Type names used in the legacy Heiler PIM export:

CodeDisplay Name
normalStandard image
ai1ai4Alt Image 1–4
aiApplication Image
ccsCatalog Cut Sheets
cl, cl2, cl3Consumer Literature 1–3
cc1cc3Consumer Catalog 1–3
ssSpecification Sheet
ss1ss3Submittal Sheet 1–3
subsSubmittal Sheet
ii, ii1ii3Installation Instructions 1–3
uciUse & Care Instructions
sm, sm1sm3Service Manual 1–3
msdss, msdss1, msdss2MSDS Sheet, Alt1, Alt2
sds1sds4Safety Data Sheet 1–4
ahriAHRI Certification
logoLogo
plParts List
explodedviewParts Exploded View
edEngineered Document
fwcFlorida Wind Code
ibwIllustration (B&W)
icIllustration (Color)
taxTax Certificate
warWarranty Document
wdWiring Diagrams
vid1vid4Video 1–4
vpVideo Production
data_sheetData sheet
hcl, hdata_sheet, hii, hpl, hss, hsubsHistorical variants
MainImageMain Image
SiloSilo
AssemblyInstructionsAssembly Instructions

Notable absence: Spin/360 images (Row1–3, 24–36 frames) from the Heiler export are not represented in this CVL.

Localization Coverage

The Name field provides localized display names via stringMap:

Entity TypeENESFR-CA
Channel3 (100%)00
ChannelNode19 (100%)00
Product21 (100%)00
Item1,022 (100%)703 (69%)605 (59%)
Resource11 (100%)00

Compared to Heiler PIM (17,223 attrs with 98% ES, 82% FR coverage), the inRiver Item translations are still growing. Channel/Product/Resource attributes currently have English only.