thingsboard-cli 4.3.1.2__py3-none-any.whl

thingsboard_cli/resources/prompts/solutions/dashboard/resources/ba-overview/dashboards-ready-example.json

@@ -0,0 +1,68 @@
+{
+  "status": "READY",
+  "summary": "Generated three role-based dashboards: Technical User for tenant-level system administration, Facility Manager for customer-level site and device management, and Site Operator for monitoring operations.",
+  "solutionDescription": "An industrial facility management solution combining indoor warehouse monitoring and outdoor container tracking. Sites contain Environment Sensors and Utility Meters positioned on floor plans for indoor monitoring, plus Containers with GPS Trackers for outdoor tracking. RestrictedAreas define geofenced zones to control container movement. The Tenant's Technical User provisions customers and monitors device health. Customer LogisticsCompany owns multiple sites with all devices and assets. Facility Manager administers sites, assets, devices, and users. Site Operator monitors facility conditions and container locations.",
+  "mainDashboard": "System Administration",
+  "dashboards": [
+    {
+      "name": "System Administration",
+      "assignedTo": "Technical User",
+      "description": "### System Administration\n\nTenant-level dashboard for the Technical User to manage the entire system.\n\n#### Customer Management\n- View all customers with device counts, alarm summaries, and connectivity status\n- Create, update, and delete customers with configuration attributes\n- Provision new devices and assign them to customers\n\n#### Monitoring & Alarms\n- Monitor connectivity status of all 'Environment Sensor', 'Tracker', and 'Utility Meter' devices\n- View and acknowledge 'LowBattery' and 'DeviceOffline' alarms across all customers\n\n#### Navigation\n- Navigate from a customer to their 'Site' assets and devices for detailed inspection",
+      "overview": "Tenant-level dashboard for provisioning customers, monitoring device connectivity, and managing system health across all facilities.",
+      "useCases": [
+        "Display a list of all customers with device counts and alarm summaries",
+        "Create, update, and delete customers with configuration attributes",
+        "Monitor connectivity status of all 'Environment Sensor', 'Tracker', and 'Utility Meter' devices",
+        "View and acknowledge 'LowBattery' and 'DeviceOffline' alarms across all customers",
+        "Navigate from customer to their 'Site' assets and devices for detailed inspection",
+        "Provision new devices and assign them to customers"
+      ]
+    },
+    {
+      "name": "Facility Management",
+      "assignedTo": "Facility Manager",
+      "description": "### Facility Management\n\nCustomer-level dashboard for the Facility Manager to administer sites, assets, devices, and users.\n\n#### Site & Asset Management\n- View all 'Site' assets with energy metrics, alarm counts, and device counts\n- Create, update, and delete 'Site' assets with floor plans and coordinates\n- Create, update, and delete 'Container' assets and assign 'Tracker' devices\n- Create and configure 'RestrictedArea' assets with geofence perimeters\n\n#### Device Management\n- Display 'Environment Sensor' devices on floor plan using indoor positioning\n- Create, update, and delete 'Environment Sensor' and 'Utility Meter' devices\n\n#### Monitoring & Alarms\n- Monitor 'HighTemperature', 'PersistentHighCO2', 'HighDailyEnergy', 'HighSiteDailyEnergyTotal', and 'ContainerInsideRestrictedArea' alarms\n- View energy consumption trends with daily aggregations\n\n#### Navigation & Users\n- Navigate from 'Site' to child 'Environment Sensor', 'Utility Meter', 'Container', and 'RestrictedArea' entities\n- Create, update, and delete customer users and assign roles",
+      "overview": "Customer-level dashboard for managing sites, assets, devices, users, and monitoring energy and alarm conditions across facilities.",
+      "useCases": [
+        "Display a list of all 'Site' assets with energy metrics and alarm counts",
+        "Create, update, and delete 'Site' assets with floor plans and coordinates",
+        "Display 'Environment Sensor' devices on floor plan using `positionX` and `positionY`",
+        "Create, update, and delete 'Environment Sensor' and 'Utility Meter' devices",
+        "Display a list of 'Container' assets with location status and tracker assignments",
+        "Create, update, and delete 'Container' assets and assign 'Tracker' devices",
+        "Create and configure 'RestrictedArea' assets with geofence perimeters",
+        "Monitor 'HighTemperature' alarms on 'Environment Sensor' devices",
+        "Monitor 'PersistentHighCO2' alarms on 'Environment Sensor' devices",
+        "Monitor 'HighDailyEnergy' alarms on 'Utility Meter' devices",
+        "Monitor 'HighSiteDailyEnergyTotal' alarms on 'Site' assets",
+        "Monitor 'ContainerInsideRestrictedArea' alarms on 'Container' assets",
+        "Navigate from 'Site' to child 'Environment Sensor', 'Utility Meter', 'Container', and 'RestrictedArea' entities",
+        "View energy consumption trends with `dailyEnergyKwhTotal` aggregations",
+        "Create, update, and delete customer users and assign roles"
+      ]
+    },
+    {
+      "name": "Operations Monitoring",
+      "assignedTo": "Site Operator",
+      "description": "### Operations Monitoring\n\nRead-only dashboard for the Site Operator to monitor environmental conditions, energy usage, and container locations in real time.\n\n#### Indoor Monitoring\n- View 'Environment Sensor' devices on floor plan with live temperature, humidity, CO2, and TVOC readings\n- View calculated air quality index and dew point metrics\n- View 'Utility Meter' devices on floor plan with energy and flow rate data\n\n#### Outdoor Tracking\n- Display 'Container' assets on a map with GPS coordinates from 'Tracker' devices\n- View restricted area status for containers relative to geofences\n\n#### Alarms\n- View 'HighTemperature', 'PersistentHighCO2', 'HighDailyEnergy', and 'ContainerInsideRestrictedArea' alarms\n- View 'LowBattery' and 'DeviceOffline' alarms across all device types\n\n#### Navigation\n- Navigate from 'Site' to view details of specific sensors, meters, or containers\n- View historical telemetry charts for environmental and energy metrics",
+      "overview": "Read-only dashboard for real-time monitoring of environmental conditions, energy consumption, and container tracking across sites.",
+      "useCases": [
+        "Display a list of assigned 'Site' assets with alarm counts and status",
+        "View 'Environment Sensor' devices on floor plan with live `temperature`, `humidity`, `co2`, and `tvoc` readings",
+        "View calculated metrics `dewPoint` and `airQualityIndex` from 'Environment Sensor' devices",
+        "View 'Utility Meter' devices on floor plan with `energyKwhTotal` and `flowRate`",
+        "View `avgHourlyAirQualityIndex` and `dailyEnergyKwhTotal` aggregated metrics",
+        "Display 'Container' assets on a map with GPS coordinates from 'Tracker' devices",
+        "View `restrictedAreaStatus` for 'Container' assets relative to 'RestrictedArea' geofences",
+        "View 'HighTemperature' alarms with warning and critical severity levels",
+        "View 'PersistentHighCO2' alarms when threshold exceeded multiple times",
+        "View 'HighDailyEnergy' alarms on 'Utility Meter' devices",
+        "View 'ContainerInsideRestrictedArea' alarms when duration threshold exceeded",
+        "View 'LowBattery' alarms on 'Environment Sensor', 'Tracker', and 'Utility Meter' devices",
+        "View 'DeviceOffline' alarms when telemetry stops",
+        "Navigate from 'Site' to view details of specific 'Environment Sensor', 'Utility Meter', or 'Container'",
+        "View historical telemetry charts for environmental and energy metrics"
+      ]
+    }
+  ]
+}

thingsboard_cli/resources/prompts/solutions/dashboard/resources/icons.json

@@ -0,0 +1,22 @@
+[
+{"general": ["search", "settings", "menu", "dashboard", "analytics", "show_chart", "multiline_chart", "pie_chart", "insert_chart", "home", "map", "location_on", "place", "pin_drop", "gps_fixed", "notifications", "notifications_active", "info", "help", "warning", "error", "report_problem", "check", "check_circle", "done", "task_alt", "verified", "verified_user", "add", "add_circle", "add_box", "remove", "remove_circle", "delete", "clear", "close", "cancel", "edit", "mode_edit", "create", "save", "content_copy", "content_paste", "upload", "download", "file_download", "file_upload", "login", "logout", "account_circle"]},
+{"Environment Monitoring": ["cloudy_snowing", "sunny_snowing", "thunderstorm", "foggy", "cloud", "cloud_queue", "snowing", "sunny", "mdi:sun-snowflake", "mdi:sun-snowflake-variant", "mdi:weather-partly-snowy-rainy", "mdi:weather-snowy-rainy", "tsunami", "mdi:cloud-percent", "mdi:cloud-percent-outline"]},
+{"Water Metering": ["gas_meter", "flood", "water_damage", "bloodtype", "dew_point", "format_color_reset", "invert_colors", "invert_colors_off", "local_drink", "mdi:waves", "oil_barrel", "opacity", "tsunami", "water_drop", "bathroom"]},
+{"Gas Metering": ["gas_meter", "mdi:fire", "local_fire_department", "co2", "device_thermostat", "electric_meter", "fire_extinguisher", "fireplace", "local_gas_station", "mdi:candelabra-fire", "mdi:menorah-fire", "oil_barrel", "propane", "propane_tank", "thermostat_auto"]},
+{"Smart Lighting": ["wb_sunny", "wb_iridescent", "wb_twighlight", "wb_twilight", "lightbulb", "lightbulb_circle", "lightbulb_outline", "wb_shade", "wb_incandescent", "fluorescent", "light", "tungsten", "batch_prediction", "emoji_objects", "flare"]},
+{"HVAC Control": ["hvac", "ac_unit", "bedtime_off", "device_thermostat", "local_fire_department", "thermostat", "thermostat_auto", "bedtime", "contactless", "desktop_access_disabled", "desktop_mac", "face", "face_2", "face_3", "face_4"]},
+{"Building Access & Security": ["key", "key_off", "vpn_key", "vpn_key_off", "enhanced_encryption", "https", "lock", "lock_clock", "lock_open", "lock_outline", "lock_reset", "mail_lock", "network_locked", "phone_locked", "phonelink_lock"]},
+{"Asset Tracking & Logistics": ["share_location", "gps_fixed", "map", "gps_not_fixed", "gps_off", "near_me", "near_me_disabled", "location_pin", "person_pin", "person_pin_circle", "pin_drop", "push_pin", "location_disabled", "location_searching", "add_location"]},
+{"Smart Parking": ["directions_car_filled", "local_parking", "directions_car", "garage", "car_crash", "car_rental", "car_repair", "electric_car", "fmd_bad", "fmd_good", "local_car_wash", "sd_card", "sd_card_alert", "sim_card", "sim_card_alert"]},
+{"Fleet Management": ["bluetooth_drive", "bus_alert", "commute", "departure_board", "directions_bus", "directions_bus_filled", "directions_railway", "directions_railway_filled", "directions_subway", "directions_subway_filled", "directions_transit", "directions_transit_filled", "drive_eta", "no_transfer", "railway_alert"]},
+{"Industrial Equipment Monitoring": ["precision_manufacturing", "factory", "warehouse", "construction", "conveyor_belt", "device_hub", "forklift", "front_loader", "pallet", "shelves", "trolley", "hub", "mdi:github", "radar", "developer_board"]},
+{"Predictive Maintenance": ["engineering", "handyman", "build", "build_circle", "car_repair", "tire_repair", "home_repair_service", "horizontal_rule", "mdi:office-building-cog", "mdi:office-building-cog-outline", "mdi:office-building-marker", "mdi:office-building-marker-outline", "query_builder", "rule", "rule_folder"]},
+{"Smart Agriculture": ["mdi:compost", "mdi:grass", "agriculture", "compost", "emergency_recording", "grass", "local_parking", "mdi:heat-wave", "mdi:sprout", "mdi:sprout-outline", "mdi:water", "mdi:waves", "mdi:weather-cloudy", "mdi:weather-dust", "mdi:weather-fog"]},
+{"Air Quality Monitoring": ["air", "ac_unit", "co2", "desktop_windows", "filter_center_focus", "filter_frames", "filter_hdr", "hvac", "laptop_windows", "wind_power", "airlines", "airplane_ticket", "airplanemode_active", "airplanemode_inactive", "connecting_airports"]},
+{"Waste Management": ["auto_delete", "delete", "delete_forever", "delete_outline", "delete_sweep", "folder_delete", "mdi:trash-can", "mdi:trash-can-outline", "mdi:delete", "mdi:delete-circle", "mdi:delete-circle-outline", "mdi:delete-empty", "mdi:delete-outline", "mdi:delete-restore", "mdi:delete-variant"]},
+{"Fire Safety & Alarms": ["local_fire_department", "mdi:smoke", "notification_important", "security_update_warning", "system_security_update_warning", "add_alert", "alarm", "alarm_add", "alarm_off", "alarm_on", "circle_notifications", "doorbell", "edit_notifications", "error", "error_outline"]},
+{"Occupancy & People Counting": ["face", "group", "group_add", "group_remove", "interpreter_mode", "person_pin", "person_pin_circle"]},
+{"Cold Chain Monitoring": ["mdi:snowflake-thermometer", "ac_unit", "cloudy_snowing", "device_thermostat", "mdi:snowflake-alert", "severe_cold", "snowing", "sunny_snowing", "device_hub", "device_unknown", "devices", "devices_fold", "devices_other", "electrical_services", "local_police"]},
+{"Smart City Traffic": ["directions", "directions_off", "route", "add_road", "edit_road", "remove_road", "signpost", "fork_left", "fork_right", "merge", "ramp_left", "ramp_right", "roundabout_left", "roundabout_right", "straight"]},
+{"Energy & EV": ["battery_charging_full", "battery_full", "battery_alert", "offline_bolt", "bolt", "flash_on", "power", "power_settings_new", "energy_savings_leaf", "solar_power", "ev_station", "charging_station", "battery_saver", "battery_std", "electric_meter"]}
+]

thingsboard_cli/resources/prompts/solutions/dashboard/resources/images.json

@@ -0,0 +1,95 @@
+[
+  {
+    "title": "Assisted living plan 1",
+    "type": "Assisted living" ,
+    "fileName": "assisted-living-plan-1.png"
+  },
+  {
+    "title": "Assisted living plan 2",
+    "type": "Assisted living",
+    "fileName": "assisted-living-plan-2.png"
+  },
+  {
+    "title": "Assisted living plan 3",
+    "type": "Assisted living",
+    "fileName": "assisted-living-plan-3.png"
+  },
+  {
+    "title": "Oil station plan 1",
+    "type": "Oil station",
+    "fileName": "oil-station-plan-1.png"
+  },
+  {
+    "title": "Oil station plan 2",
+    "type": "Oil station",
+    "fileName": "oil-station-plan-2.png"
+  },
+  {
+    "title": "Oil station plan 3",
+    "type": "Oil station",
+    "fileName": "oil-station-plan-3.png"
+  },
+  {
+    "title": "Smart irrigation plan 1",
+    "type": "Smart irrigation",
+    "fileName": "smart-irrigation-plan-1.png"
+  },
+  {
+    "title": "Smart irrigation plan 2",
+    "type": "Smart irrigation",
+    "fileName": "smart-irrigation-plan-2.png"
+
+  },
+  {
+    "title": "Smart irrigation plan 3",
+    "type": "Smart irrigation",
+    "fileName": "smart-irrigation-plan-3.png"
+  },
+  {
+    "title": "Smart office plan 1",
+    "type": "Smart office",
+    "fileName": "smart-office-plan-1.png"
+  },
+  {
+    "title": "Smart office plan 2",
+    "type": "Smart office",
+    "fileName": "smart-office-plan-2.png"
+
+  },
+  {
+    "title": "Smart office plan 3",
+    "type": "Smart office",
+    "fileName": "smart-office-plan-3.png"
+  },
+  {
+    "title": "Smart parking plan 1",
+    "type": "Smart parking",
+    "fileName": "smart-parking-plan-1.png"
+  },
+  {
+    "title": "Smart parking plan 2",
+    "type": "Smart parking",
+    "fileName": "smart-parking-plan-2.png"
+
+  },
+  {
+    "title": "Smart parking plan 3",
+    "type": "Smart parking",
+    "fileName": "smart-parking-plan-3.png"
+  },
+  {
+    "title": "Smart retail plan 1",
+    "type": "Smart retail",
+    "fileName": "smart-retail-plan-1.png"
+  },
+  {
+    "title": "Smart retail plan 2",
+    "type": "Smart retail",
+    "fileName": "smart-retail-plan-2.png"
+  },
+  {
+    "title": "Smart retail plan 3",
+    "type": "Smart retail",
+    "fileName": "smart-retail-plan-3.png"
+  }
+]

thingsboard_cli/resources/prompts/solutions/dashboard/resources/state-action/change-owner-dialog/action-capabilities.md

@@ -0,0 +1,47 @@
+# Change Owner Dialog Action Configuration
+
+## Overview
+
+The `changeOwnerDialog` action opens a dialog to reassign an entity (Device or Asset) from one Customer to another. The user selects the new customer owner from a filtered list. This action is available exclusively to Tenant-level users — Customer-level users cannot change entity ownership.
+
+## Output Fields
+
+- `actionTrigger` (string, required) — how the user triggers this action
+- `label` (string, required) — display text (e.g., "Change Owner", "Assign to Customer")
+- `actionType` (string, required) — must be `"changeOwnerDialog"`
+- `iconName` (string, required) — Material icon name (typically `supervisor_account`)
+- `dialogTitle` (string, required) — title of the dialog window
+- `requiredMessage` (string, required) — validation message when no customer is selected
+- `customerProfile` (string, required) — the customer profile name to filter the list of selectable customers
+
+## Trigger Selection
+
+- **entityTable**: Use `iconButton` — change owner icon in the row action cell
+
+This action is a per-entity operation, so use `iconButton` on tables (same row as edit/delete).
+
+## Customer Profile
+
+The `customerProfile` field filters which customers appear in the owner selection dropdown. It must match a Customer entity profile defined in the solution descriptor.
+
+For example, if the solution has a `ParkingCompany` customer profile, setting `"customerProfile": "ParkingCompany"` shows only parking companies in the dropdown.
+
+## Permission Restriction
+
+This action is for Tenant-level administrator dashboards ONLY. Do not add this action to dashboards assigned to Customer-level users, as they do not have visibility or management rights over other customers.
+
+## Examples
+
+**Change device owner from table:**
+```json
+{
+  "actionTrigger": "iconButton",
+  "label": "Change Device Owner",
+  "actionType": "changeOwnerDialog",
+  "iconName": "supervisor_account",
+  "dialogTitle": "Change Device Owner",
+  "requiredMessage": "Please select a customer.",
+  "customerProfile": "ParkingCompany"
+}
+```
+

thingsboard_cli/resources/prompts/solutions/dashboard/resources/state-action/change-owner-dialog/action-schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Change owner action",
+  "description": "A schema for generating change owner action.",
+  "type": "object",
+  "properties": {
+    "actionTrigger": {
+      "type": "string"
+    },
+    "label": {
+      "type": "string"
+    },
+    "actionType": {
+      "type": "string",
+      "enum": [
+        "changeOwnerDialog"
+      ]
+    },
+    "iconName": {
+      "type": "string"
+    },
+    "dialogTitle": {
+      "type": "string"
+    },
+    "requiredMessage": {
+      "type": "string"
+    },
+    "customerProfile": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "actionTrigger",
+    "label",
+    "actionType",
+    "iconName",
+    "dialogTitle",
+    "requiredMessage",
+    "customerProfile"
+  ]
+}

thingsboard_cli/resources/prompts/solutions/dashboard/resources/state-action/change-state/action-capabilities.md

@@ -0,0 +1,75 @@
+# Change State Action Configuration
+
+## Overview
+
+The `changeState` action switches to a different dashboard state by replacing the current one, similar to changing tabs.
+Use this for navigating to top-level views (e.g., switching to alarm management, settings) or tab-style navigation between peer states.
+Do NOT use this for backward navigation (e.g., returning from detail states to root) - the dashboard breadcrumbs handle that automatically.
+
+## Output Fields
+
+- `actionTrigger` (string, required) — how the user triggers this action
+- `label` (string, required) — display text (e.g., "Back to Overview", "Alarm Management")
+- `actionType` (string, required) — must be `"changeState"`
+- `iconName` (string, optional) — Material icon name (e.g., `arrow_back` for back navigation)
+- `targetState` (string, required) — the dashboard state to navigate to (must match a valid state name)
+- `targetStateEntity` (string, optional) — name for the entity passed to the target state (rarely used with changeState)
+
+## Trigger Selection
+
+- **actionButton**: Use `click` — the primary widget class for changeState actions (back buttons, tab buttons)
+
+`changeState` is almost always triggered by `actionButton` widgets with the `click` trigger. This is the standard pattern for back navigation and tab-style switching.
+
+## Common Use Cases
+
+### Back Navigation
+Backward navigation (returning from detail states to parent/root) is handled automatically and should NOT use additional actions.
+
+### Tab-Style Navigation
+Used on `actionButton` widgets to switch between top-level views:
+- Switch from main view to alarm management
+- Switch between different monitoring tabs
+
+## targetStateEntity
+
+For `changeState`, `targetStateEntity` is rarely needed since this action typically navigates to states that don't depend on a specific entity context (e.g., going back to root, switching tabs). Only use it when the target state needs entity context.
+
+## State Name Rules
+
+The `targetState` must reference a valid state name from the dashboard's states list. Use the exact state name as defined (e.g., `root`, `alarm-management`).
+
+## Examples
+
+**Navigate to alarm management state:**
+```json
+{
+  "actionTrigger": "click",
+  "label": "Alarm Management",
+  "actionType": "changeState",
+  "iconName": "notifications",
+  "targetState": "alarm-management"
+}
+```
+
+**Navigate to settings state:**
+```json
+{
+  "actionTrigger": "click",
+  "label": "Settings",
+  "actionType": "changeState",
+  "iconName": "settings",
+  "targetState": "settings"
+}
+```
+
+**Tab navigation between peer states:**
+```json
+{
+  "actionTrigger": "click",
+  "label": "Analytics",
+  "actionType": "changeState",
+  "iconName": "analytics",
+  "targetState": "analytics-view"
+}
+```

thingsboard_cli/resources/prompts/solutions/dashboard/resources/state-action/change-state/action-schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Change state action",
+  "description": "A schema for generating change state action.",
+  "type": "object",
+  "properties": {
+    "actionTrigger": {
+      "type": "string"
+    },
+    "label": {
+      "type": "string"
+    },
+    "actionType": {
+      "type": "string",
+      "enum": [
+        "changeState"
+      ]
+    },
+    "iconName": {
+      "type": "string"
+    },
+    "targetState": {
+      "type": "string"
+    },
+    "targetStateEntity": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "actionTrigger",
+    "label",
+    "actionType",
+    "targetState"
+  ]
+}

thingsboard_cli/resources/prompts/solutions/dashboard/resources/state-action/common-action-capabilities.md

@@ -0,0 +1,101 @@
+# Common Action Configuration Rules
+
+## Overview
+
+This document defines the shared rules for generating detailed action configurations for ThingsBoard dashboard widgets. Each action type assistant must follow these rules in addition to its type-specific rules.
+
+## Action Triggers
+
+The `actionTrigger` field determines how the user invokes the action. Valid triggers depend on the widget class.
+
+### Supported Widgets and Their Triggers
+
+Only `entityTable`, `actionButton`, `outdoorMap`, and `indoorMap` support action triggers. All other widget classes do not support any actions.
+
+- **entityTable:**
+  - `headerButton` — button in the widget header toolbar; used for create/provision actions
+  - `rowClick` — click on a table row; used for navigation actions (drill down to detail view)
+  - `iconButton` — icon button in a table action cell; used for per-row actions (edit, delete, change owner)
+- **actionButton:**
+  - `click` — click on the widget body; the only valid trigger. Typically used for back navigation (`changeState`) or standalone create actions
+- **outdoorMap / indoorMap:**
+  - `headerButton` — button in the widget header toolbar; used for header-level actions
+  - `markerClick` — click on a map marker; used for navigating to entity details
+  - `polygonClick` — click on a map polygon; used for navigating to entity details via polygon area
+  - `circleClick` — click on a map circle; used for navigating to entity details via circle area
+  - `mapButton` — button on a map widget; used for map-level create actions (e.g., place new entity on map)
+
+## Common Output Fields
+
+Every action configuration must include these fields:
+
+- `actionTrigger` (string, required) — how the user triggers this action (see trigger types above)
+- `label` (string, required) — display text shown to the user (e.g., "Edit Customer", "View Details")
+- `actionType` (string, required) — the action type identifier (must match the requested action type)
+- `iconName` (string, required for button/icon actions, optional for rowClick) — Material icon name
+
+## Action Icons
+
+Pick the icon that best fits the action's context. Prefer the icons below. If none fit, choose an appropriate icon from `icons.json`.
+
+- **Create / Provision:** `add`
+- **Edit / Update:** `edit`
+- **Delete / Remove:** `delete`
+- **Navigate / View details:** `arrow_forward`
+- **Back / Return:** `arrow_back`
+- **Change owner / Assign:** `supervisor_account`
+- **Place on map:** `add_location`
+- **Settings / Configure:** `settings`
+- **Save:** `save`
+
+## Label Conventions
+
+- Use short, action-oriented labels: "Edit Customer", "Delete Sensor", "View Details"
+- For `headerButton`: describe the create action (e.g., "Add Parking Lot", "Provision Sensor")
+- For `rowClick`: use the navigation description (e.g., "View Details")
+- For `iconButton`: describe the row-level action (e.g., "Edit", "Delete", "Change Owner")
+- For `click` on actionButton: describe the navigation (e.g., "Back to Overview")
+
+## Solution Descriptor Usage
+
+The request includes a `minifiedSolutionDescriptor` with the following fields:
+
+- **`entityProfiles`**: Use to classify widget keys as `entityField`, `attribute`, or `telemetry` for the target entity type. Only `entityField` and `attribute` keys should appear in create/edit form fields.
+- **`entityRelations`**: Use to determine the relation type between entities for create actions. Look up the relation where `fromEntityType` matches the parent entity (i.e., `rootStateEntity`) and `toEntityType` matches the entity being created, then use that relation type in `createRelations`.
+- **`roles`**: IAM roles available in the solution.
+- **`alarms`**: Alarm configurations for the solution.
+
+The request also includes `rootStateEntity` — the entity type of the current dashboard state. Use this as the parent entity when resolving relations for create actions.
+
+## Entity-Type Reserved Fields (for Create/Edit Actions)
+
+Each entity type has a fixed set of reserved fields. The primary identifier is **always required**:
+
+- `CUSTOMER` — primary field: `title`; other fields: `email`, `country`, `city`, `state`, `address`, `zip`, `phone`
+- `DEVICE` — primary field: `name`; other fields: `label`
+- `ASSET` — primary field: `name`; other fields: `label`
+- `USER` — primary field: `email`; other fields: `firstName`, `lastName`, `phone`
+
+**CRITICAL:** Always use the correct primary field for the entity type — `title` for CUSTOMER, `name` for DEVICE/ASSET, `email` for USER. Never use `name` for a CUSTOMER entity. The primary field must always be present and marked `required: true`.
+
+## Field Exclusion Rules (for Create/Edit Actions)
+
+When generating form fields for create or edit actions, exclude the following key types:
+
+### Telemetry Keys (Read-Only Data)
+All telemetry keys must be excluded from form fields as they are read-only data reported by devices/sensors.
+
+### Coordinate/Position Keys (Typically Time Series)
+**CRITICAL:** Always exclude coordinate and position keys from form fields:
+- **latitude, longitude**: Time series (telemetry) - GPS coordinates reported by mobile devices
+- **xPos, yPos**: Time series (telemetry) - indoor position coordinates
+- **perimeter**: Attribute or time series - polygon/circle boundaries for geofence zones
+
+Coordinate keys should never appear in form fields because:
+- They are typically time series (telemetry) reported by devices, not user input
+- For static map entities, coordinates are set by the map placement interface, not manual entry
+
+**Examples of excluded coordinate keys:**
+- `latitude`, `longitude`, `lat`, `lng` (outdoor GPS)
+- `xPos`, `yPos`, `x`, `y` (indoor position)
+- `perimeter` (area boundaries)