Warning

You're reading a development version (main) of the documentation. For the latest released version, please see 1.0.0.

Open Energy Tech Docs

Technical documentation for the IcebreakerOne Open Energy project.

Contents

• 1. Introduction to Open Energy
  • 1.1. Overview and purpose of the guidelines
  • 1.2. What is Open Energy, how was it made and who is it for?
  • 1.3. How is Open Energy Structured?
    • 1.3.1. Dataset Search
    • 1.3.2. Governance Service
    • 1.3.3. Project Governance
  • 1.4. What data can be found and used through Open Energy?
    • 1.4.1. Open data
    • 1.4.2. Shared data
    • 1.4.3. Closed data
  • 1.5. What role does your organisation play in the Open Energy ecosystem?
    • 1.5.1. Data Providers
    • 1.5.2. Data Consumers
      • 1.5.2.1. Service Providers
    • 1.5.3. Dual Roles
  • 1.6. How does dataset access and licensing operate under Open Energy?
    • 1.6.1. Types of Access Conditions
    • 1.6.2. Creating Access Rules (Introduction)
    • 1.6.3. Data Licensing (Introduction)
  • 1.7. Future development of the guidelines
• 2. Considerations Before You Start
  • 2.1. Introduction (Before you start)
  • 2.2. Considerations for Data Providers
  • 2.3. Considerations for Data Consumers
• 3. Core Policies
  • 3.1. Introduction (Core Policies)
  • 3.2. Metadata
  • 3.3. Data Sensitivity Classes
    • 3.3.1. Policy details
  • 3.4. Data Access Conditions
    • 3.4.1. Policy details (Data access conditions)
    • 3.4.2. Group based access control
    • 3.4.3. Use case based access control
    • 3.4.4. Prioritisation
  • 3.5. Data Licensing
    • 3.5.1. Creating access rules
    • 3.5.2. Associating access rules with capabilities
    • 3.5.3. What are licenses and capabilities?
    • 3.5.4. How will capability grants work in practice?
    • 3.5.5. Obligations accompanying capability grants
    • 3.5.6. Why are we proposing this approach?
    • 3.5.7. Example access control and capability grant scenarios
    • 3.5.8. Risks of license proliferation
    • 3.5.9. Is there a risk of licences changing too frequently or without notice?
    • 3.5.10. Where are these rules specified?
    • 3.5.11. Where are these rules evaluated, and by whom?
  • 3.6. Service Desk and Notifications
  • 3.7. Dispute Resolution
• 4. Guidance for Data Consumers
  • 4.1. Data Consumer Role and Responsibilities
    • 4.1.1. Data Consumer vs Service Provider
    • 4.1.2. Responsibility - Data consumption
    • 4.1.3. Responsibility - Data licensing
  • 4.2. Problem Resolution (Data Consumers)
    • 4.2.1. Effective resolution of problems (Data Consumers)
    • 4.2.2. Dispute resolution for access control and capability grant policies
    • 4.2.3. OEGS support
• 5. Guidance for Data Providers
  • 5.1. Data Provider Role and Responsibilities
    • 5.1.1. Responsibility - Data classification
    • 5.1.2. Responsibility - Access and licensing specification
    • 5.1.3. Responsibility - Data provision
      • 5.1.3.1. Data formats
    • 5.1.4. Responsibility - Data integrity and correctness
    • 5.1.5. Responsibility - Metadata provision
    • 5.1.6. Responsibility - API availability
    • 5.1.7. Responsibility - API stability and change management
  • 5.2. Data API Requirements
    • 5.2.1. Date and time formats
    • 5.2.2. Endpoint security
      • 5.2.2.1. Open data endpoints
      • 5.2.2.2. Shared data endpoints
    • 5.2.3. Heartbeat and monitoring endpoint
    • 5.2.4. API documentation
    • 5.2.5. Versioning
  • 5.3. Problem Resolution (Data Providers)
    • 5.3.1. Effective resolution of problems (Data Providers)
    • 5.3.2. Online support
    • 5.3.3. Ticket management process
    • 5.3.4. Dispute resolution for access control and capability grant policies (Data Providers)
    • 5.3.5. OEGS support (Data Providers)
  • 5.4. Change Management
    • 5.4.1. Downtime
    • 5.4.2. Licensing and access control changes
    • 5.4.3. Data API changes
      • 5.4.3.1. Dual running and deprecation
      • 5.4.3.2. API credentials, consent and authorisation
• 6. Common Security Requirements
  • 6.1. Applicable standards
    • 6.1.1. Discovery of endpoint URLs
  • 6.2. Token acquisition
  • 6.3. Token usage - calling a shared data API
  • 6.4. Request validation
    • 6.4.1. Token introspection
    • 6.4.2. Introspection response validation
      • 6.4.2.1. active
      • 6.4.2.2. time ranges
      • 6.4.2.3. certificate thumbprint
    • 6.4.3. Interaction header
    • 6.4.4. Other validation
• 7. Open Energy Architecture
• 8. Data Set Metadata
  • 8.1. Metadata File Structure
  • 8.2. Content Block
    • 8.2.1. Additional metadata
  • 8.3. Access Block
  • 8.4. Transport Block
    • 8.4.1. Heartbeat URL
  • 8.5. Representation Block
    • 8.5.1. text/csv
    • 8.5.2. Other types
  • 8.6. Full Example
• 9. Access Control and Capability Grant Language
  • 9.1. Syntax
    • 9.1.1. Names
    • 9.1.2. Rule syntax
  • 9.2. Conditions
    • 9.2.1. Unary clauses
    • 9.2.2. Binary clauses
    • 9.2.3. Example conditions
    • 9.2.4. Specifying multiple conditions
  • 9.3. Capabilities
    • 9.3.1. Standard capabilities
    • 9.3.2. Expressing Open Data licenses with capabilities
  • 9.4. Obligations
    • 9.4.1. Standard obligations
• 10. Open Energy Glossary
  • 10.1. Commercial
  • 10.2. Data
  • 10.3. Legal
  • 10.4. Open Energy ecosystem
  • 10.5. Operational
  • 10.6. Other
  • 10.7. Policy and governance
  • 10.8. Regulated monopoly
  • 10.9. Regulatory
  • 10.10. Research
  • 10.11. Security
  • 10.12. Standard
  • 10.13. Technology
  • 10.14. Term - multiple uses
  • 10.15. Unit of measurement
• 11. Additional Material
  • 11.1. Membership
  • 11.2. Search Related
  • 11.3. Technical
  • 11.4. Policy
  • 11.5. Reporting
  • 11.6. Engagement