User Support

Welcome to the CoWorkr user guide


Here you will find detailed information on our app features and general information like definitions and user processes. Administrative and API documentation may be provided to authorized users with approval by CoWorkr.

If you're just getting started, try starting from the top. If you're a veteran but stuck on a feature try using the search bar.

Not finding what you’re looking for? Send us an email.

 

0.0 Definitions

0.1 WorkPoint

CoWorkr’s Sensor hardware, called a “WorkPoint”,  reports an occupancy state, using various methods of sensing. WorkPoints report a reading of “Occupied” instantaneously and otherwise, if no change of status is observed, a WorkPoint has a “heartbeat” that reports an update to CoWorkr every minute, letting CoWorkr know it’s online. WorkPoints also contain a notification button that reports to CoWorkr if pressed.

WorkPoint Versions:

    V1 - Version 1 WorkPoint that uses temperature or vibration sensing (no longer available)

    V2 - Version 2 WorkPoint that uses temperature or vibration sensing

    V3 - Version 3 “Motion” WorkPoint that uses passive infrared (PIR) sensing

WorkPoints attributes:

WorkPoint UUID:  Unique string defined by a WorkPoint’s Bluetooth radio, for example “B827EB13B5F2”

WorkPoint ID: Unique string assigned to a WorkPoint when created on CoWorkr, for example, “54f45a67ac641604fd9bfa1a”.

Name: A custom value assigned by users via CoWorkr’s app. Its default value is the WorkPoint’s UUID.

Firmware: The version of firmware running the WorkPoint.

Notes: A custom field for users to input misc. information regarding a WorkPoint

WorkPoint Statuses: The state of a WorkPoint changes with time and its sensor status. The following states may exist:

      connected - true if the WorkPoint has reported to the server within an anticipated time frame, false if hasn’t recently reported to the server

      recentlyConnected: (CoWorkr Admin use only) 

      occupied - true if the workPoint is reporting an occupied state, false if not occupied 

      occupiedBy - (CoWorkr Admin use only) string with admin info on the occupied state

      occupyReason - (CoWorkr Admin use only) string with admin info on the occupied state

      occupancyChanged - timestamp of the last reported change in status

      flags.press - A notification button on the WorkPoint has been pressed 

      flags.button1 - WorkPoint Notification Button 1 has been pressed

      flags.button2 - WorkPoint Notification Button 2 has been pressed 

      rssi - (CoWorkr Admin use only) signal strength

      battery - (CoWorkr Admin use only)

      optical - (CoWorkr Admin use only) if available, a light intensity reading 

0.2 WorkHub 

CoWorkr’s internet-enabled device that reads and pushes WorkPoint data to CoWorkr’s servers. WorkHubs, or “Hubs”, require an internet connection using LAN, WiFi, or Cellular dongle to operate. 

WorkHub Attributes:

WorkHub ID: Unique string given to a WorkPoint when placed onto a Floorplan, for example, “54f45a67ac641604fd9bfa1a”

WorkHub UUID: Unique string associated with a WorkHub’s Bluetooth radio, for example “CE27EB1455F1”

0.3 WorkPlace

A physical location from where WorkPoints and Workhubs are streaming. A WorkPlace is generally used to represent a single location that is based on a geographical address - for example, a building. WorkPlaces contain one or more Floorplans to which WorkPoints and WorkHubs are assigned. 

WorkPlace Attributes:

WorkPlace ID: A unique case-sensitive alphanumeric identifier, for example “YvamDKDx6KD4QZh5g”, given to a WorkPlace on creation.

WorkPlace Name: A custom field assigned to the WorkPlace by a user.

Address: The physical location of the WorkPlace. This is also used to pair with geolocation services of WorkHubs.

Timezone: The local timezone of the WorkPlace. 

Group: A grouping of users with specific access permissions. Groups are generally created for each customer to segment access but may also be a group of users that belong to a 3rd party that oversees multiple customers. A group is identified by a given Name and a case-sensitive alphanumeric ID, for example “nzYf5H8RNBYSgrLHJ’

Start & End: “Start Date” is the first day the data is to stream from a corresponding WorkPlace.  “End Date” is the day the data at the corresponding WorkPlace will end its streaming. These dates are generally defined by the customer’s subscription period.

Active Hours: “Active Start Hour“ and “Active End Hour” hours determine a range of time wherein occupancy data will be ignored for a specific WorkPlace. This generally is used to eliminate occupancy data created outside of working hours such as that created by late-night cleaners. This is a custom field that can be set by an admin.

0.4 FloorPlan

An image file used as a background for CoWorkr’s floorplan view on which WorkPoints are placed. This is commonly a cad-based 2D drawing that has been exported as a raster image like jpeg or png.

FloorPlan Attributes:

FloorPlan ID: A unique string assigned to a FloorPlan upon creation.

FloorPlan Name: A custom, required, field given to the FloorPlan image upon upload.

FloorPlan X, Y: A location on the FloorPlan using a X-Y coordinate system, typically used to describe a WorkPoint location 

Location: A X,Y coordinate that locates a WorkPoint icon on a Floorplan image on CoWorkr’s App

0.5 Tags

Values assigned to WorkPoints to describe, but not limited to, the physical location or the use of the space. Tags contain 2 values, a category and a value associated with that category. For example, a tag category/value for a WorkPoint assigned to a workstation may be “furniture/desk”.


1.0 Account Creation & Login

To get started with CoWorkr, please create an account using your email or a registered Google account.

Based on your client's location, create an account in either of the following locations:

This will take you to a CoWorkr Account Log In Page

  • Click "Register" at the very bottom to create a new account

  • Use an existing Google account or create an account using any email

  • Check your email for an account verification, click the link to verify and login to CoWorkr

  • One you've verified your email account, please contact CoWorkr, info@coworkr.co, to be assigned to a new Group.  If you work within a Partner organization,, please contact your internal Admin to be added to their team

Register with a single sign-on by clicking the red Google Register button

2.0 App Basics

Homepage:

When you log in, you’ll find a list of WorkPlaces to which you’re assigned or you’ve created. If you've logged in and you see nothing but menus, you'll need to contact your CoWorkr rep or your CoWorkr Admin. You'll only be able to see WorkPlaces and Devices to which you're assigned.

Your top menu will give you quick links back to this page (“WorkPlaces”), lists of your devices “WorkHubs” and “WorkPoint”, as well as your User options.  

You can find options to edit your user profile under the drop down at the top right. This includes resetting your password. 

3.0 Launch your WorkPlace

Note: If you don't see a WorkPlace when logging in, contact your administrator. You may not yet be assigned to the Workplace.

To open a WorkPlace, simply click its name in the list of available WorkPlaces from the home page. This will open your WorkPlace Dashboard which includes tabs for FloorPlans, Hubs, WorkPoints, and WorkPlace Analytics. We'll start by opening a FloorPlan.

A WorkPlace is created by a CoWorkr admin. They add floorplans, assign devices, and set up the analytics. For support document access involving the setup and maintenance of WorkPlaces, please contact info@coworkr.co or your representative.

To get started exploring a WorkPlace, try clicking on the FloorPlan icon. This will open the FloorPlan and load its default Live View.

3.1 Live View

Your FloorPlan will launch into its Live view.

Note: The Live Floor Plan uses on-the-fly calculations to determine if a seat is active. This may be slightly different than your processed data represented in your analytics. Processed data may use long-term analysis, unavailable in the short-term, to determine values.

In this view, Blue Icons represent Seats that are currently active. 

Light Blue Seats have been recently active, for example when someone has recently walked away.

White Seats have no recent activity.

Red Seats are not currently connected.

Launching the FloorPlan will load the Live View

 

3.2 Rewind View

The second view is called Rewind. This allows you to choose a historical date and time of the Live view.  This view will display the same color-coded icons as Live View.

Drag the time slider to adjust

3.3 Activity Map View

The third FloorPlan view is called the Activity Map. This allows you to see Activity data overlaid on your FloorPlan. Choose a date and time range in the filterThe Activity Map view uses a color gradient to show the average activity (%) per seat on your floor plan. Hover over an Icon to view its value.

Note: The Activity Map legend includes a selection for your Activity Interval. If you're unfamiliar with this, scroll down to its section below to read about how it works.

Use the Gradient legend to see the color gradation as it corresponds to percent active.

4.0 Analytics Summary

CoWorkr Analytics are a comprehensive set of tools for slicing up your WorkPlace data. Our devices collect data at a very high frequency providing you with a massive trove of data. 

Our Analytics have several metrics and features that we'll walk through in detail including:

  • 4.1 Analytics Dashboards

    • Analytics Preview

    • FloorPlan Analytics

    • WorkPlace Analytics

  • 4.2 Using the Analytics Dashboard

 

  • 4.3 Features & Tools

    • Selections

    • Interval

    • Data Download

    • Elastic Scales

    • Links

 

  • 4.4 Data Metrics

    • Activity

      • Average

      • Peak

    • Average WorkPoints Active

    • Inactive WorkPoints

    • Stays

    • Dashboards

 

4.1 Analytics Dashboards

There are several locations where you can view your workplace's data. These are outlined below:

 

4.1.1 ANALYTICS PREVIEW:

The analytics preview provides the last week of data, Average Active WorkPoints, and Inactive Workpoints.

Make a selection using the Floor Plan

  • Make a selection using Tags

  • Click the Analytics button

This will launch the Analytics Preview. If you'd like to recalculate the metrics, you can drag over the timeline chart to narrow the focus of your time selection.

Note: Expand the window using the button at the top right of Analytics Preview to launch the full FloorPlan Dashboard.

4.1.2 FloorPlan Analytics:

Expanding the Analytics Preview from your FloorPlan will launch the full FloorPlans analytics.

The FloorPlan analytics displays all metrics based on your selection from the FloorPlan. This scope can be narrowed by further selecting Tags or specific date/time ranges within the Dashboard.

These processes are outlined below per feature.

 

4.1.3 WORKPLACE ANALYTICS:

The WorkPlace analytics contains all data from all floors in the workplace.  This is accessed from the WorkPlace Dashboard by clicking Analytics.

The WorkPlace Analytics will load all the data from the start of the installation. You can then make selections to further narrow the scope of your analysis.

Note: based on your WorkPlace size, this dashboard can load much more slowly than the FloorPlan Analytics. Each change to the dashboard will require the data to be reprocessed and may take several minutes. Once the new selection data is loaded once, it'll be stored and allow to be quickly loaded in the future.

The WorkPlace Analytics dashboard can be found from the WorkPlace's homepage while FloorPlan Analytics, from the FloorPlan

4.2 Using the Analytics Dashboard

4.2.1 TOP MENU

In all of CoWorkr's analytics, the contents of the Analytics Dashboard is ultimately controlled by several features in the Top Menu such as the date/time range and an Interval option. In the examples below, we will be using the WorkPlace Analytics, found in the WorkPlace's home menu on the right.

The menu along the top of the Analytics Dashboard contains several key functions that control your data. Adjust these prior to analyzing your data and save your settings if you want to change the default. 

1. Start with the Date Range

  • If the date range loaded is not preferred, click the Date Range and select a new Date Range

note: If you'd like to exclude days from your data, for example, holidays or work off-sites, click the calendar button next to your WorkPlace name at the top of the page. This will not delete data — you can add these dates back into your dataset at any time.

 Adjust your date range

Adjust your date range


2. Select an Interval

The Interval will default to 15min. If a different interval is desired, click the Interval menu and select a new Interval. 

Note: An "Interval" is a period of time that rounds up activity into larger chunks. For example, 7 minutes of actual detected activity will be shown as 10 minutes if using a 10 minute interval. If using a 15 minute interval, it will be rounded up even further, to 15 min. 

Aug-27-2018 08-20-06.gif

3. Choose from a list of default View Filters or Save your own.

To create your own:

  • Make a section on the dashboard and choose settings
  • Click the File button above the View Filters
  • Click to save it as your default, or the WorkPlace's default
 Set a WorkPlace Analytics filter or save your existing settings

Set a WorkPlace Analytics filter or save your existing settings


4.2.2 CHARTS

Each chart will display Activity as a function of the time or location. Each chart also acts as a method of filtering. 

Horizontal Bar Charts:

  • Try selecting one of the Tags from the list on the right, this will sort the Dashboard to show only this specific Tag.
  • Try selecting more than one Tag by clicking any multiple Tags. They will aggregate your results.
  • To reset these selections, click RESET to revert to the default settings

Vertical Bar Charts

The full date range graphs at the top of the dashboard shows all data in the date range. You can select any range within this date range:

  • Click and drag a region over the graph, this will filter your dashboard to show data that only falls within this range
  • Adjust this time range by pulling the grips at either end of the selection

Charts using the WorkPlace Analytics

Aug-27-2018 08-59-09.gif
 

Charts Using the FloorPlan Analytics

Adjusting the charts on the FloorPlan Analytics: All of the charts act as filters for the data instantaneously. Click away or the Reset button to clear the selection.

Note:  Using the Floorplan Analytics, where data is shown based on the WorkPoints selected on your floorplan, the Analytics are responsive — meaning they'll instantaneously change with your interactions. When using the WorkPlace Analytics, which loads all floorplans and all data, making selections on the charts will require the dataset to reload.

4.3 Features & Tools

4.3.1 SELECTIONS

To view a quick preview of the analytics or even load the entire FloorPlan to view, you'll need to first make a selection.  A selection can be made my dragging over any seats you'd like to view or opening the Tag menu and selecting the relevant tag.

  • Click any number of tags to add it to your selection. Click the tag(s) again to remove it from the selection.
  • Shift+Click a seat after selecting to deselect.

After making a selection, click the red Analytics button at the bottom of the window to open a preview. Click the expand button to open the full FloorPlan Analytics dashboard.

Note: If you want to load the full WorkPlace Analytics, where you can view all FloorPlans, you can access this from the WorkPlace Dashboard on the previous page by clicking the Analytics button.

Expand the Analytics Preview to launch the full FloorPlan Analytics dashboard


4.3.2 INTERVAL

The Activity Interval defines the length of time associated with each reading of Activity. Intervals may be thought of as buckets of time; if any activity is detected within the amount of time determined by the Interval, such as "5-minutes", the entire 5 minutes will be shown as active. For example, a desk may only be active for 12 minutes during an hour of the day but using an Interval of 30-minutes would mean the entire 30-minutes would be shown as active.

You'll find the Interval selection available at all options to change your data such as in the Activity Map, Analytics Preview, or full Workplace Analytics.

To change the Interval:

  • Click the Interval Drop Down menu to choose an interval
  • Select between 1 min and 30 min intervals
  • Your Analytics will then be reloaded

4.3.3 DATA DOWNLOAD

All of your data collected by CoWorkr can be downloaded in CSV format for integration with other applications. You'll see the download icon throughout the App marking locations where specific data sets are available for download. 

Click the Download icon to start the download, give it a name & click Download.

Download your data from any of our charts by clicking the Download icon


4.3.4 ELASTIC SCALES

The Elastic Scales button, located under the tools icon, allows the maximum value on the Y-Axis to be the maximum value of the data. This may provide a higher resolution view of your data if the peak of your data is very low. 


4.3.5 LINKED WORKPOINTS

When setting up your WorkPlace, Seats on your FloorPlan may be linked to create larger areas of space to study. Linked WorkPoints takes two seats and combines the data. For example, if a desk has two sensors because it may have multiple seating positions, the two locations can be linked together to show the data as one.

Another example is using Linked WorkPoints to create rooms or spaces using individual sensors. For example, select all seats in a conference to link them together. 

Note: When you create a new Link, it creates a new set of data that then gathers data based on the sensors you've linked. This is not retroactive. The Links need to be created before the Start Date of a Workplace to ensure all data is properly collected by the Link.

In the Analytics, to show the Linked Workpoints together, as one, click the Group Linked WorkPoints toggle button under the tools tab. To show the Linked WorkPoints separately, click the Separate Linked WorkPoints toggle button.

4.4 CRE Metrics

4.4.1 ACTIVITY

CoWorkr's primary occupancy metric is called "Activity"

Activity is generated when a human interacts with a space or seat where our sensor(s) are located. This data is collected at 1-minute intervals but is viewed on the app in 30-minute buckets. The resolution of this data can adjusted by using the Interval settings of 1, 5, 10, 15 , or 30 minute buckets. 

Average Activity: The average of all observed activity within the selected time period for a selection of seats or spaces.

Peak Activity: The highest Activity observed at a given point in time. This is often provided with a % occurrence and time of highest occurrence.


4.4.2 INACTIVE WORKPOINTS

Of a selection, how many of seats remained completely vacant throughout the time range. This is defined by seats that have an average activity of less than 5%.

Furthermore, this metric defines the number of seats that fit the next rung of activity: between 5%-10% active. 


4.4.3 AVERAGE ACTIVE WORKPOINTS

Of a selection, this is the number of seats occupied simultaneously. This is a great metric for determining how many people use a space at the same time — for example, use this to estimate the average number of workers in a room. 


4.4.4 STAYS

The Stay Duration is the quantity of lengths of stay during the date range. For example, a stay might be 120 minutes— represented by the number of times a worker used the seat for an uninterupted 120 minutes.