Skip to main content

Consultant Guide

The Consultant role is a special global role designed for external auditors, data analysts, or multi-tenant support staff who need read access to multiple organizations.

What is a Consultant?​

Unlike regular users who belong to a single tenant, Consultants have:

  • Cross-Tenant Access: View data from multiple organizations
  • Read-Only Permissions: Cannot modify tenant settings or delete data
  • Tenant Switching: Easily switch between assigned tenants

Common Use Cases:

  • External auditors reviewing compliance data
  • Data analysts generating reports across multiple clients
  • Support engineers troubleshooting issues for multiple customers
  • System integrators managing deployments for multiple organizations

Accessing the Consultant Dashboard​

  1. Log in with your Consultant account
  2. You'll land on the Consultant Dashboard at /consultant/dashboard
  3. The dashboard shows:
    • Assigned Tenants: List of organizations you have access to
    • Quick Stats: High-level metrics across all tenants
    • Recent Activity: Latest data from all monitored devices

Switching Between Tenants​

To work within a specific tenant:

  1. Click the Tenant Selector in the top navigation bar
  2. Select the organization you want to view
  3. The interface reloads with that tenant's context
  4. You can now:
    • View devices and sensors
    • Access device groups
    • Review historical data
    • View dashboards

What You CAN Do (Per-Tenant):​

  • ✅ View all devices and their telemetry
  • ✅ View device groups and aggregated charts
  • ✅ View sensors and their historical data
  • ✅ Edit device and sensor metadata (name, description)
  • ✅ Update device status (enable/disable)
  • ✅ View Rule Chains (read-only)
  • ✅ Export sensor data

What You CANNOT Do:​

  • ❌ Create or delete devices
  • ❌ Modify Rule Chains
  • ❌ Manage users or permissions
  • ❌ Change tenant billing or plan settings
  • ❌ Delete the tenant
  • ❌ View or modify authentication credentials (API tokens)

Available Features​

Devices​

Route: /consultant/devices

View and manage device metadata across all assigned tenants.

Actions:

  • View device list with filtering and search
  • Open device details to see:
    • Latest sensor values
    • Historical charts
    • Device sensors
  • Edit device name, description, and status
  • Update device status (Active/Inactive)

Device Groups​

Route: /consultant/device-groups

View device groups within the current tenant context.

Actions:

  • Browse group hierarchy
  • View group-level aggregated charts
  • See which devices belong to each group

Sensors​

Route: /consultant/sensors

View all sensors across devices in the current tenant.

Actions:

  • Browse sensor list
  • View sensor details and historical data
  • Edit sensor metadata (name, description)
  • Update sensor profiles

Best Practices​

1. Document Your Access​

Keep a record of which tenants you have access to and why (e.g., audit purposes, support contract).

2. Respect Data Privacy​

Even with read access, treat all tenant data as confidential. Follow your organization's data handling policies.

3. Use Tenant Context Carefully​

Always verify which tenant you're viewing before taking screenshots or generating reports.

4. Report Issues Properly​

If you discover issues, report them through proper channels. Do not attempt to "fix" things yourself.

5. Avoid Excessive API Calls​

When exporting data or running reports, be mindful of API rate limits to avoid impacting system performance.

Managing Consultant Access (For System Admins)​

System admins can manage Consultant users at Admin > Consultants.

Creating a Consultant:

  1. Navigate to Admin > Consultants
  2. Click + Create Consultant
  3. Fill in user details
  4. Assign tenants the consultant should have access to
  5. Save

Removing Tenant Access:

  1. Edit the consultant user
  2. Remove tenants from the assigned list
  3. Save

Troubleshooting​

Cannot See Expected Tenant​

  • Verify you have been assigned access by the System Admin
  • Try logging out and back in to refresh permissions

Cannot Switch Tenants​

  • Check that you're on a consultant route (starts with /consultant/)
  • Ensure you have active tenant assignments

Data Not Loading​

  • Verify the tenant has active devices
  • Check that you're within the correct tenant context
  • Contact the System Admin if permissions seem incorrect