Source of truth for implementation is the canonical schema host: https://schemas.meta-aiml.org/v3.0.0/. If any page text conflicts with canonical schema files, follow canonical files. Documentation home.

SoftwareProduct

v3.0.0

ProductEntity

Technology

v3 schema for software products as product artifacts (not services), including packaging, licensing, release lifecycle, and inventory characteristics.

Top-level required

Required modules

Capability groups

Entity properties

Canonical Files

Contract URL: https://schemas.meta-aiml.org/v3.0.0/entity/software_product.json

Example URL: https://schemas.meta-aiml.org/v3.0.0/examples/software_product_example_schema_v3.json

Inheritance Chain

https://schemas.meta-aiml.org/v3.0.0/ontology/product_entity.json

Interaction archetype

No interaction archetype (ProductEntity exception).

Required Top-level Fields

These fields are enforced by JSON Schema required[] at root level.

@type

ontologicalMode

domain

name

description

deliveryFormat

productType

inventory

capabilities

structuralMetadata

modules

Non-universal required fields

productType

inventory

Entity-specific Properties

Keys under properties.properties dedicated to this entity contract.

activationRequired

productCategory

releaseChannel

supportedPlatforms

supportsOfflineUsage

Modules Contract

Required modules

No required modules for this entity.

Optional modules

licensing

support

updates

Capabilities Contract

Required capability groups

No required capability groups for this entity.

Optional capability groups

commerce

content

financial

interaction

Governance Validation Rules

Normative rule list from governanceMetadata.sdkValidationRules.

RULE-SWPRD-001: @type MUST equal "SoftwareProduct"

RULE-SWPRD-002: ontologicalMode MUST equal "ProductEntity"

RULE-SWPRD-003: interactionArchetype MUST NOT be present

RULE-SWPRD-004: productType MUST equal "digital"

RULE-SWPRD-005: inventory.availableQuantity and inventory.stockStatus MUST be present

RULE-SWPRD-006: allOf MUST reference only product_entity ontology

Canonical Contract JSON

https://schemas.meta-aiml.org/v3.0.0/entity/software_product.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "@context": [
    "https://schemas.meta-aiml.org/v3.0.0/context.jsonld"
  ],
  "@id": "https://schemas.meta-aiml.org/v3.0.0/entity/software_product.json",
  "$id": "https://schemas.meta-aiml.org/v3.0.0/entity/software_product.json",
  "@type": "SoftwareProduct",
  "schemaVersion": "3.0.0",
  "aimlVersion": "3.0.0",
  "title": "Software Product Entity Schema",
  "description": "v3 schema for software products as product artifacts (not services), including packaging, licensing, release lifecycle, and inventory characteristics.",
  "examples": [
    {
      "description": "Commercial desktop software package with annual maintenance entitlement",
      "reference": "software_product_example_desktop"
    },
    {
      "description": "Developer tool delivered as versioned digital package with license pool",
      "reference": "software_product_example_developer_tool"
    }
  ],
  "type": "object",
  "additionalProperties": false,
  "allOf": [
    {
      "$ref": "../ontology/product_entity.json"
    }
  ],
  "properties": {
    "@type": {
      "const": "SoftwareProduct"
    },
    "ontologicalMode": {
      "const": "ProductEntity"
    },
    "domain": {
      "const": "Technology"
    },
    "businessModel": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "License",
          "Subscription",
          "PerSeat",
          "Freemium"
        ]
      }
    },
    "deliveryFormat": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "DigitalDownload",
          "LicenseKeyDelivery",
          "PackageRegistry",
          "ContainerImage"
        ]
      }
    },
    "name": {
      "$ref": "../components/multilingual_format.json#/$defs/LocalizedText"
    },
    "description": {
      "$ref": "../components/multilingual_format.json#/$defs/LocalizedText"
    },
    "shortDescription": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "foundingDate": {
      "type": "string",
      "format": "date"
    },
    "productType": {
      "const": "digital"
    },
    "inventory": {
      "type": "object",
      "required": [
        "availableQuantity",
        "stockStatus"
      ],
      "properties": {
        "availableQuantity": {
          "type": "integer",
          "minimum": 0
        },
        "stockStatus": {
          "type": "string",
          "enum": [
            "in_stock",
            "out_of_stock",
            "backorder"
          ]
        },
        "licensePoolType": {
          "type": "string",
          "enum": [
            "limited",
            "unlimited",
            "metered"
          ]
        }
      }
    },
    "properties": {
      "type": "object",
      "properties": {
        "productCategory": {
          "type": "string",
          "enum": [
            "desktop_app",
            "developer_tool",
            "security_suite",
            "analytics_tool",
            "productivity_suite"
          ]
        },
        "supportedPlatforms": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "windows",
              "macos",
              "linux",
              "cross_platform",
              "web"
            ]
          }
        },
        "releaseChannel": {
          "type": "string",
          "enum": [
            "stable",
            "beta",
            "lts"
          ]
        },
        "activationRequired": {
          "type": "boolean"
        },
        "supportsOfflineUsage": {
          "type": "boolean"
        }
      }
    },
    "capabilities": {
      "type": "object",
      "properties": {
        "commerce": {
          "$ref": "../components/capability_groups.json#/$defs/CommerceCapabilities"
        },
        "financial": {
          "$ref": "../components/capability_groups.json#/$defs/FinancialCapabilities"
        },
        "content": {
          "$ref": "../components/capability_groups.json#/$defs/ContentCapabilities"
        },
        "interaction": {
          "$ref": "../components/capability_groups.json#/$defs/InteractionCapabilities"
        }
      }
    },
    "modules": {
      "type": "object",
      "properties": {
        "licensing": {
          "type": "object",
          "properties": {
            "seatReassignmentEnabled": {
              "type": "boolean"
            },
            "offlineActivationSupported": {
              "type": "boolean"
            },
            "maxActivationsPerLicense": {
              "type": "integer",
              "minimum": 1
            }
          }
        },
        "updates": {
          "type": "object",
          "properties": {
            "autoUpdatesSupported": {
              "type": "boolean"
            },
            "securityPatchSlaDays": {
              "type": "integer",
              "minimum": 0
            },
            "releaseNotesUrl": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "support": {
          "type": "object",
          "properties": {
            "knowledgeBaseAvailable": {
              "type": "boolean"
            },
            "supportPortalUrl": {
              "type": "string",
              "format": "uri"
            },
            "slaTier": {
              "type": "string",
              "enum": [
                "basic",
                "business",
                "enterprise"
              ]
            }
          }
        }
      }
    },
    "structuralMetadata": {
      "type": "object",
      "properties": {
        "entityNature": {
          "const": "product_item"
        },
        "distributionModel": {
          "type": "string",
          "enum": [
            "download",
            "registry",
            "hybrid"
          ]
        },
        "versioningModel": {
          "type": "string",
          "enum": [
            "semantic_versioning",
            "calendar_versioning",
            "custom"
          ]
        },
        "contentOwnership": {
          "const": "platform"
        }
      }
    },
    "targetAudience": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "siteCapabilities": {
      "type": "object",
      "properties": {
        "supportedDevices": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "desktop",
              "mobile",
              "tablet"
            ]
          }
        },
        "languages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "accessibilityFeatures": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "@type",
    "ontologicalMode",
    "domain",
    "name",
    "description",
    "deliveryFormat",
    "productType",
    "inventory",
    "capabilities",
    "structuralMetadata",
    "modules"
  ],
  "validationMetadata": {
    "schemaVersion": "3.0.0",
    "phase": "entity",
    "status": "draft",
    "lastValidated": "2026-02-20T12:00:00Z",
    "validator": "META-AIML QA"
  },
  "semanticAnnotations": {
    "classificationRationale": "SoftwareProduct is modeled as ProductEntity because the schema describes a software artifact and license inventory rather than live service behavior.",
    "disambiguationNotes": "ProductEntity does not carry interactionArchetype; service delivery must be modeled in a separate DigitalEntity schema."
  },
  "governanceMetadata": {
    "entityVersion": "3.0.0",
    "introducedIn": "META-AIML v3.0.0",
    "stabilityLevel": "draft",
    "sdkValidationRules": [
      "RULE-SWPRD-001: @type MUST equal \"SoftwareProduct\"",
      "RULE-SWPRD-002: ontologicalMode MUST equal \"ProductEntity\"",
      "RULE-SWPRD-003: interactionArchetype MUST NOT be present",
      "RULE-SWPRD-004: productType MUST equal \"digital\"",
      "RULE-SWPRD-005: inventory.availableQuantity and inventory.stockStatus MUST be present",
      "RULE-SWPRD-006: allOf MUST reference only product_entity ontology"
    ]
  }
}

Filled Example Instance

https://schemas.meta-aiml.org/v3.0.0/examples/software_product_example_schema_v3.json

{
  "@context": [
    "https://schemas.meta-aiml.org/v3.0.0/context.jsonld"
  ],
  "@id": "https://data.meta-aiml.org/v3.0.0/examples/software_product/vectorforge-studio",
  "$id": "https://data.meta-aiml.org/v3.0.0/examples/software_product/vectorforge-studio",
  "@type": "SoftwareProduct",
  "schemaVersion": "3.0.0",
  "aimlVersion": "3.0.0",
  "title": "Example Filled Software Product Entity (VectorForge Studio)",
  "ontologicalMode": "ProductEntity",
  "domain": "Technology",
  "businessModel": [
    "License",
    "Subscription",
    "PerSeat"
  ],
  "deliveryFormat": [
    "DigitalDownload",
    "LicenseKeyDelivery",
    "PackageRegistry"
  ],
  "name": {
    "en": "VectorForge Studio",
    "es": "VectorForge Studio",
    "fr": "VectorForge Studio"
  },
  "description": {
    "en": "VectorForge Studio is a fictional software product artifact for visual data engineering, delivered as a versioned digital package with seat licensing and managed update channels.",
    "es": "VectorForge Studio es un producto de software ficticio para ingenieria visual de datos, entregado como paquete digital versionado con licencias por asiento.",
    "fr": "VectorForge Studio est un produit logiciel fictif pour ingenierie visuelle des donnees, livre en package numerique versionne avec licences par siege."
  },
  "shortDescription": {
    "en": "Digital software product schema with licensing, release, and support lifecycle metadata.",
    "es": "Esquema de producto software digital con metadatos de licencia, release y soporte.",
    "fr": "Schema de produit logiciel numerique avec metadonnees de licence, release et support."
  },
  "url": "https://downloads.vectorforge.example/studio",
  "foundingDate": "2024-03-18",
  "createdDate": "2026-02-20T21:16:00Z",
  "lastModified": "2026-02-20T21:16:00Z",
  "productType": "digital",
  "inventory": {
    "availableQuantity": 50000,
    "stockStatus": "in_stock",
    "licensePoolType": "metered"
  },
  "examples": [
    {
      "scenario": "Major version launch with phased rollout",
      "note": "AI should use licensing and updates modules to coordinate release channels and entitlement migration safely."
    },
    {
      "scenario": "Enterprise procurement with offline activation requirement",
      "note": "AI should prioritize support and activation constraints without introducing service-archetype assumptions."
    }
  ],
  "properties": {
    "productCategory": "developer_tool",
    "supportedPlatforms": [
      "windows",
      "macos",
      "linux"
    ],
    "releaseChannel": "stable",
    "activationRequired": true,
    "supportsOfflineUsage": true,
    "identifiers": [
      {
        "type": "sku",
        "value": "VF-STUDIO-ENT"
      },
      {
        "type": "url",
        "value": "https://downloads.vectorforge.example/studio"
      },
      {
        "type": "custom",
        "value": "SWPRD-VFS-001"
      }
    ]
  },
  "capabilities": {
    "commerce": {
      "features": [
        "productCatalog",
        "pricing",
        "checkout",
        "filtering"
      ],
      "hasProductCatalog": true,
      "catalogSize": 3,
      "supportsCart": false,
      "supportsCheckout": true,
      "hasOrderTracking": true,
      "recommendationEngine": false,
      "vendorManagement": false,
      "searchCapability": true,
      "filteringOptions": [
        "license_type",
        "seat_count",
        "support_tier"
      ]
    },
    "financial": {
      "features": [
        "payments",
        "invoicing",
        "billing",
        "subscriptionManagement",
        "refunds"
      ],
      "paymentMethods": [
        "credit_card",
        "bank_transfer",
        "invoice_terms"
      ],
      "acceptsCreditCards": true,
      "currencies": [
        "USD",
        "EUR"
      ],
      "priceRange": "seat_tiered",
      "commissionModel": "fixed_price",
      "commissionRate": 0,
      "supportsSubscriptions": true,
      "supportsInvoicing": true,
      "refundPolicy": "partial_refund"
    },
    "content": {
      "features": [
        "publishing",
        "search",
        "categories",
        "tags",
        "archives"
      ],
      "contentTypes": [
        "release_note",
        "documentation",
        "security_advisory",
        "migration_guide"
      ],
      "contentFormats": [
        "text",
        "html",
        "markdown",
        "pdf"
      ],
      "contentAccess": [
        "public",
        "member"
      ],
      "editorialControl": true,
      "userGeneratedContent": false,
      "mediaHosting": false,
      "searchPossible": true,
      "hasCategorization": true,
      "hasTagging": true,
      "archiveAccess": true,
      "rssFeeds": false
    },
    "interaction": {
      "features": [
        "messaging",
        "notifications"
      ],
      "interactionMethods": [
        "online_form",
        "email"
      ],
      "availableActions": [
        "download_package",
        "activate_license",
        "open_support_ticket"
      ],
      "hasMessaging": true,
      "hasComments": false,
      "hasRating": false,
      "hasReviews": false,
      "hasSocialGraph": false,
      "hasFeed": false,
      "hasNotifications": true,
      "hasMatching": false,
      "realTimeCommunication": false,
      "moderationEnabled": true,
      "privacyControls": [
        "private"
      ]
    }
  },
  "modules": {
    "licensing": {
      "seatReassignmentEnabled": true,
      "offlineActivationSupported": true,
      "maxActivationsPerLicense": 3
    },
    "updates": {
      "autoUpdatesSupported": true,
      "securityPatchSlaDays": 7,
      "releaseNotesUrl": "https://docs.vectorforge.example/releases"
    },
    "support": {
      "knowledgeBaseAvailable": true,
      "supportPortalUrl": "https://support.vectorforge.example",
      "slaTier": "enterprise"
    }
  },
  "structuralMetadata": {
    "entityNature": "product_item",
    "distributionModel": "hybrid",
    "versioningModel": "semantic_versioning",
    "contentOwnership": "platform"
  },
  "targetAudience": [
    "data_engineers",
    "analytics_teams",
    "enterprise_it"
  ],
  "siteCapabilities": {
    "supportedDevices": [
      "desktop",
      "mobile",
      "tablet"
    ],
    "languages": [
      "en",
      "es",
      "fr"
    ],
    "accessibilityFeatures": [
      "keyboard_navigation",
      "screen_reader_labels",
      "text_scaling"
    ]
  },
  "validationMetadata": {
    "schemaVersion": "3.0.0",
    "phase": "example_instance",
    "status": "reference",
    "lastValidated": "2026-02-20T21:16:00Z",
    "validator": "META-AIML SDK v3"
  },
  "semanticAnnotations": {
    "classificationRationale": "SoftwareProduct is modeled as ProductEntity because it is a versioned software artifact with licensing and inventory characteristics.",
    "disambiguationNotes": "No interactionArchetype is included because this schema does not represent an operational service platform.",
    "intendedUse": "Canonical example for digital software product records."
  },
  "governanceMetadata": {
    "entityVersion": "3.0.0",
    "introducedIn": "META-AIML v3.0.0",
    "stabilityLevel": "reference",
    "sdkValidationRules": [
      "RULE-SWEX-001: @type MUST equal \"SoftwareProduct\"",
      "RULE-SWEX-002: ontologicalMode MUST equal \"ProductEntity\"",
      "RULE-SWEX-003: interactionArchetype MUST NOT be present",
      "RULE-SWEX-004: productType MUST equal \"digital\"",
      "RULE-SWEX-005: inventory.availableQuantity and inventory.stockStatus MUST be populated",
      "RULE-SWEX-006: examples MUST include at least two operational scenarios"
    ]
  }
}

All entities Product