Platform Resources

Everything you manage in Mirox is organized into three nested resources — organization, portfolio, and park — that together define what you can see, who can access it, and how your data is grouped for monitoring and reporting. Understanding this hierarchy is the foundation for working with the platform and its APIs.

Organization

The Organization is the top-level entity that represents a business entity using the Mirox platform.

Key Characteristics

• Primary Business Entity: Represents a company, institution, or other business entity
• User Container: Contains users that belong to the organization
• Resource Owner: Owns portfolios and their underlying resources
• Billing Entity: Serves as the entity for billing and account management
• Permission Boundary: Defines the highest level permission boundary

Organization Structure

Organizations typically have the following components:

• Members: Users that belong to the organization with different roles and permissions
• Information: Business details like name, contact information, and business type
• Settings: Organization-wide settings and preferences
• Cooperation Partners: Other organizations that the organization collaborates with

Portfolio

Portfolios are collections of parks managed as a unit. They represent logical groupings of renewable energy assets.

Key Characteristics

• Asset Collection: Groups multiple parks for management purposes
• Organizational Unit: Represents a business unit, client, or geographical region
• Permission Level: Enables access control at the portfolio level
• Reporting Unit: Serves as a basis for aggregated reporting

Portfolio Structure

Portfolios typically contain:

• Parks: The individual solar parks or other renewable energy installations
• Contacts: People associated with the portfolio who may receive reports or notifications
• Settings: Portfolio-wide settings and configurations
• Performance Metrics: Aggregated data from all contained parks

Park

A Park represents an individual renewable energy installation, typically a solar park.

Key Characteristics

• Physical Asset: Represents a real-world renewable energy installation
• Monitoring Subject: Primary entity for which performance is monitored
• Data Source: Generates time-series data about its operation
• Geographic Entity: Has a specific location and physical characteristics

Park Structure

Parks typically include:

• Components: The physical components of the installation (inverters, strings, generator junction boxes, meters, irradiation sensors, loggers, network devices). Most components are auto-discovered from your loggers and synced in automatically — you surface and refine them rather than entering them by hand.
• Technical Details: Specifications like installed capacity, inverter limit, orientation, and monthly performance-ratio targets.
• Location Information: Geographic coordinates and address.
• Performance Metrics: Operational data like energy production, specific yield, and efficiency ratios.
• Events: Machine-detected operational signals like grid shutdowns, overproduction, and source-availability changes.

Resource Relationships

These resources form a hierarchical structure:

1. Organization: The top-level entity

   • Contains multiple portfolios
   • Contains organization members (users)

2. Portfolio: The middle-level entity

   • Belongs to one organization
   • Contains multiple parks
   • Has portfolio-specific contacts

3. Park: The lowest-level operational entity

   • Belongs to one portfolio
   • Contains multiple components
   • Generates operational data and events

Resource Identifiers

All resources in the Mirox platform are identified by:

• UID: A unique 12-character uppercase hexadecimal string (e.g., "A1B2C3D4E5F6") that is assigned at creation and cannot be modified. This static identifier is essential for script automation and consistent referencing across the platform.
• Name: A human-readable name for display purposes that can be changed by users.

Supporting Resources

Beyond the core hierarchy, a few shared resources help you describe and document your assets:

• Datasheet Items: Reusable manufacturer spec sheets for inverters, solar panels, and battery storage, boxes, modules, and cells. You maintain these once at the organization level and link them to the matching components on any park, so equipment specifications stay consistent across your fleet.
• Document Storage: Each park has a file explorer for storing supporting documents — irradiation reports, contracts, datasheets, photos, and more. Uploaded files are automatically tagged with the help of the AI Assistant, making them easy to find later.

Common Operations

Organization Operations

• User management (adding/removing users)
• Managing organization settings
• Establishing cooperation partnerships
• Managing organization-wide access controls

Portfolio Operations

• Creating and managing parks
• Assigning parks to portfolios
• Portfolio-level reporting
• Portfolio contact management

Park Operations

• Monitoring park performance
• Analyzing park events
• Generating park reports
• Managing park components

Permission Model

The resource hierarchy also defines the permission model:

• Organization-level permissions grant access to all portfolios and parks within the organization
• Portfolio-level permissions grant access to all parks within the portfolio
• Park-level permissions grant access to a specific park only

This hierarchical access model ensures that users only see the resources they should have access to. Roles and the fine-grained access rules layered on top of this hierarchy are covered in the Permission System.

Related Features

• Permission System — roles and access rules across organizations, portfolios, and parks
• Plant Overview — what each park monitors and how its data is structured
• First Steps — set up your organization, portfolio, and first park
• AI Assistant & Wizards — automatic document tagging and guided onboarding