LogoLogo
  • PlaceOS Documentation
  • Overview
    • Key Concepts
      • Drivers
      • Interfaces
      • Modules
      • Settings
      • Systems
      • Triggers
      • Zones
    • Languages
      • Crystal
      • TypeScript
    • Protocols
      • MQTT
      • SAML
      • OAuth2
  • How To
    • Configure PlaceOS for Microsoft 365
      • Step 1: Room Calendar Access
        • Create Azure App Registration (Application Permissions)
        • Exchange Calendar Group
        • Limit Application Permissions
        • Configure PlaceOS Calendar Driver
      • Step 2: User Authentication & Calendar Access
        • Create a PlaceOS Authentication Source
        • Create Azure App Registration (Delegated Permissions)
        • Configure PlaceOS Authentication Source
        • Add User Login Redirects
      • Concierge Access
      • Troubleshooting
        • Blocked or Blacklisted IP Error
    • Configure PlaceOS for Google Workspace
      • Google Configuration
        • Create Google Cloud Project & Enable API
        • Configure Google Cloud Service Account
        • Add Google Workplace Permissions
        • Create Google Marketplace App (optional)
        • Google Workspace Service User (RBAC)
        • Configure Access to Google Resource Calendars
      • User Authentication
        • Create a PlaceOS Authentication Source for Google
        • Create Google Cloud OAuth2 Client App
        • Configure PlaceOS Auth Source for Google
        • Add User Login Redirects
    • Deployment
      • Deploy AWS Fargate on Modular CloudFormation Stacks
      • Deploy AWS Fargate on Nested CloudFormation Stacks
      • Writing Import Scripts
    • Analytics
      • MQTT Integration
    • Backoffice
      • Add a Domain to PlaceOS
      • Backoffice File Upload
      • Configure Staff API
      • Calendar Driver
      • Enable Sensor UI
      • Bookings Driver
      • Configure a webhook
    • Authentication
      • Azure B2C
        • Azure B2C Custom Policy Framework
        • Configure PlaceOS for Azure B2C
        • 365 Room Resources on Azure B2C
      • Configure SAML SSO
        • Configure SAML2 with AD FS
        • Configure SAML2 with Auth0
        • Configure SAML2 with Azure AD
        • Configure SAML2 with Google Workspace
      • Configure OAuth2 SSO
      • X-API Keys
      • Bearer tokens
    • Location Services
      • Location Services
      • Area Management
      • Discovering User Devices
      • Locating Users on a Network
      • People Finding with Cisco Meraki on PlaceOS
      • People Finding with Juniper Mist on PlaceOS
    • Notifications
      • Catering Orders
    • User Interfaces
      • Booking Panel App
      • Workplace App
      • Native Booking Panel App
      • Deploy a Frontend Interface
      • Microsoft Outlook Plugin
      • Configure Endpoint Auto Login
      • SVG Map Creation
      • Configuring a default UI
  • Tutorials
    • Setup a dev environment
    • Backend
      • Troubleshooting Backend Failures
      • Import Bookable Rooms
      • Writing A Driver
        • Testing drivers
        • ChatGPT / LLM Capabilities
          • Native GPT Plugins
      • Testing Internal Builds
    • Backoffice
      • Adding Drivers & Modules
      • Add Zone Structure
    • Common Configurations
      • Asset Manager
      • Catering
      • Locker Booking
      • Webex Instant Connect
      • Desk booking
      • Sensor Data Collection
        • Configure Kontakt IO
        • Configuring Meraki
        • Configuring DNA Spaces
      • Elevated Privileges
  • Reference
    • API
      • Real-time Websocket
      • Rest API
      • Staff API
    • Drivers
      • PlaceOS
        • Bookings
        • Staff API
        • Visitor Mailer
        • Lockers
      • Microsoft
        • Graph API
    • PlaceOS Skills
    • Privacy Policy
    • Recommended Products
    • Supported Integrations
    • System Architecture
    • System Functionality & Requirements
    • Infrastructure Requirements
    • Security Compliance
      • FAQ
      • GDPR
      • Security
    • Microsoft Azure Permissions
  • Glossary
  • 🎯PlaceOS Roadmap
  • 🆘PlaceOS Support
  • 👩‍💻PlaceOS Github
  • 📝PlaceOS Changelog
Powered by GitBook
On this page
  • Log in with SSO
  • Book Rooms
  • Show or use sensor data
  • Control devices
  • Locate Devices
  • Analytics for connected integrations
  • Network Connectivity, WAN Access & Ports
Export as PDF
  1. Reference

System Functionality & Requirements

Reference for functional requirements for a system implementing PlaceOS

Below is a list of high level functions that PlaceOS is capable of and the technical requirements for each.

Log in with SSO

Users can log on using existing enterprise credentials. They do not need to “sign up” nor remember a new user account/password.

Requirement Integration with enterprise identity providers via SAML2 or OAuth2. Examples:

  • Azure AD Enterprise Application

  • AD FS

  • Google Workspace (GSuite) authentication

Book Rooms

PlaceOS web apps are able to search and book room & user Calendars from the enterprise directory. Enterprise directories include Office 365, Exchange Online, Google Workspace (GSuite) etc.

Requirement Office 365/Exchange Online or Google Calendar:

  • Integration with Microsoft Graph API via an Azure “Registered App”

  • All required Calendars and Users must be accessible via MS Graph API or Google Calendar API if users are on GSuitexs

Show or use sensor data

PlaceOS web apps or analytics are able to show or track live sensor data, such as:

  • Desk occupancy

  • In-room people count

  • Air quality

Requirement

  • Compatible PlaceOS Driver for the integration (device/service)

  • Network connectivity to the Cisco DNA Spaces integration or its gateway

Control devices

PlaceOS web apps or automations are able to send messages to edge devices over the network. These can control integrations or receive live status information.

Requirement

  • Compatible PlaceOS Driver for the integration (device/service)

  • Network connectivity to the integration or its gateway

Locate Devices

If a user's device (such as phone or laptop) is online, PlaceOS will be able to locate it within the building. This infers a user's location and the distribution/density of people.

Requirement Locations services such as:

  • Cisco DNA Spaces

  • Cisco Meraki RTLS

  • HP Aruba

  • Juniper Mist

  • RUCKUS SPoT

Analytics for connected integrations

PlaceOS provides live and retrospective data for all connected integrations. An analytics dashboard enables insights.

Requirement PlaceAnalytics API

Network Connectivity, WAN Access & Ports

PlaceOS Frontend Applications require Ports 80 and 443. 443 is preferred for all data in transit.

All cloud services integration via API require Port 443.

Integration with Audio Visual and other Bespoke hardware may require additional ports, these will be scoped in the solution design.

The PlaceOS Servers will require access to https://github.com for routine code updates and frontend deployments. PlaceOS connects to Github via the SSH Protocol.

Where devices or services are on secure networks we can deploy edge devices that communicate locally

PreviousSystem ArchitectureNextInfrastructure Requirements

Last updated 1 year ago