Activity Stream User Guide

As the owner (user with Admin role) or a Manager of your organization, use the Activity Stream feature to view all the activity that has taken place on or to your organization (including its rooms) since its creation.

Organization and room activity is stored as events - known as the Activity Stream, which you can view as an event report, which is a filtered table or charts of these events.

This page answers the following questions:

It also provides a sample of the kinds of events you can expect to find in the Activity Stream.


What is an event?

Tehama stores all activity that takes place on or to your organization and rooms as events.

For example:

  • Ask an individual to join your organization (e.g.: to become a staff member)? That is logged as an event.
  • Create a room? That is also logged an event.
  • Invite another organization to join your room? Also an event.
  • Log in to a desktop in a room? Yet another event.

You get the idea. See the list of possible events at the end of this page.

Event Types

At times it is useful to restrict viewing of events to certain types of events - that is, to filter the events by type.

Tehama defines the following event-types:

  • Room Config - e.g.: create a room, rename a room, archive a room
  • Room Access - e.g.: add user to room, fetch secret from room's secrets vault
  • Desktop Config - e.g.: create desktop configuration
  • Desktop Access - e.g.: connect to desktop

What is an event report?

An event report is a filtered set of events viewed in one of a set of viewing formats.

You can filter events by any combination of:

  • event-type (one type at a time or all-events)
  • organization name(s)
  • room name(s)
  • user name(s)
  • role(s)
  • date-range.

You can view the events in one of two formats:

  • Table format
  • Chart format

The table format is a list of the events, with one list entry per event.

Table format

The chart format displays the events in one of number of different chart-types with different measurement options.

The chart-type determines the purpose of the horizontal axis of the chart.

  • View by All           
  • View by Organization  
  • View by Room        
  • View by User         
  • View by Role         
  • View by Date         

The measurement option determines the purpose of the vertical axis of the chart. Options are:

  • Measurement by Number of Events (default): This option means that each increment on the vertical axis of the chart represents an event. (Currently this is the only measurement option available.)

The sorting option allows you to sort the bars on the chart (along the horizontal axis). Options are:

  • No Sorting: This option does not perform any sorting.
  • Sort Alphabetically (default): This option sorts the bars alphabetically by title. (The title is either role user name, organization name, depending on the chart type.)
  • Sort Ascending: This option sorts the bars in ascending order by number of events (or by whatever the measurement option is currently).
  • Sort Descending: This option sorts the bars in descending order by number of events (or by whatever the measurement option is currently).

You can select one of the preconfigured event reports, or create your own custom event report.


How can you access the Activity Stream?

There are two ways to access the Activity Stream:

  • To view event reports on all activity for your organization (events for all rooms in the org):
    • Open the dropdown User menu at the top right and select Organization and then the sidebar item DASHBOARD. Select the ACTIVITY STREAM option at the top. (It should be selected by the default.)

Activity Stream for Organization

  • To view event reports on all activity for just one room in your organization (events only for that room):
    • Click on ROOMS in the top navigation bar, select the room, click on the AUDIT tab and then the sidebar item ACTIVITY STREAM.

Activity Stream for Organization


How can you create a custom event report?

Follow these steps:

  1. Access the Activity Stream (see section above).
  2. Turn on the custom event report option.
  3. Open up the advanced settings.
  4. Set the event filters.
  5. Set the event report viewing options.

Turn on the custom event report option.

Click on the customize icon customize icon found beside the event reports dropdown menu at the top right of the Activity Stream page.
event reports dropdown menu and customize icon
This will cause the event reports dropdown menu to display Custom as its current selection.

Note, this step is optional, since making any change in the Advanced settings will cause the same thing to occur, (excepting the date-range filter).

Open up the advanced settings.

Click on the Advanced dropdown menu.
advanced dropdown menu open
This will show both the event filters event filters icon and the event report viewing options view options icon.

Set the event filters.

There are six possible filters:

  • Event-type filter


    Select any one of provided the event-types (there is an 'All' type).
    Your event report will be limited to events that fall into the selected event-type.

  • Organization filter


    Choose zero, one or more of the organizations listed. (Click the X on an organization to remove it.)
    Your event report will be limited to events that were initiated by the chosen organizations. If organizations zero are selected, then no organization-filter will be applied.

  • Room filter


    Choose zero, one or more of the rooms listed. (Click the X on a room to remove it.)
    Your event report will be limited to events that occurred in or to the chosen rooms. If zero rooms are selected, then no room-filter will be applied.

  • Member filter


    Choose zero, one or more of the users listed. (Click the X on a user to remove the user.)
    Your event report will be limited to events that were initiated by the chosen users. If zero users are selected, then no user-filter will be applied.

  • Role filter


    Choose zero, one or more of the roles listed. (Click the X on a role to remove the role.)
    Your event report will be limited to events that were initiated by the users who have the chosen roles. If zero roles are selected, then no role-filter will be applied.

  • Event Date-range filter


    Use the date-time selector to choose the limits of the date-range you want, or click on a date/time and manually type over it to change it. Be sure to check the start and end values of the default date range to see what is currently defined for this filter.

    Be aware that if the start and end-date/time of the date range have not been explicitly changed by you from this default, then the end time will update to the current time whenever any change is made to a event report-type, filter or viewing option (and stay at that date-time). After making an explicit change to the date range, you must refresh the browser page for the Tehama Webapp in order to regain this behaviour.

    Note, the date-range filter is the one filter option that will not cause the selected event report type to change to Custom when it has been changed.

Click on a filter to see the options. The filters are applied, and the displayed event report updated, as soon as you select/update a new option. All filters are ANDed together.

Note that if a filter is not shown, it means that your organization or room only has one option for that filter. For example, if viewing the Activity Stream from a room, then only events for that room will be shown and no room filter will be offered. If viewing the Activity Stream from the organization point of view, and the organization only has one room, then no room filter will be offered.

Set the event report viewing options.

To select the Table viewing format, click on Table under the event report viewing options view options icon.

Table viewing option selected

To select the Chart viewing format, click on Chart under the event report viewing options view options icon.

Chart viewing option selected

Here you can:

  • select the chart type. This determines the horizontal axis of the chart. (The default chart type is "View by Organization".)
  • select the measurement option. This determines the vertical axis of the chart. (The default, and so far only, measurement option is "Measurement by Number of Events".)
  • select the sorting option. This determines the order of the bars of the chart. (The default sorting option is "Sort Alphabetically".)

How can you select a preconfigured event report?

Follow these steps:

  1. Access the Activity Stream (see section above).
  2. Select the desired preconfigured event report option.

Event reports dropdown

Your options are:

  • All Events (table format)
  • All Events (chart format)
  • All Events by Room (only available when viewing the Activity Stream from the organization point of view)
  • All Events by User
  • All Events by Role
  • All Events by Date
  • Desktop Sessions
  • Desktop Sessions by Room (only available when viewing the Activity Stream from the organization point of view)
  • Desktop Sessions by User
  • Desktop Sessions by Role
  • Desktop Sessions by Date

In general, the first part of the event report name refers to the event-type filter to be applied and the second part, "by Room/User/Date", refers to the event report viewing chart-type option. Where it isn't specified, the chart-type option defaults to "View By Organization".

Be sure to check the start and end values of the default date range under Advanced to see what is currently defined for this filter.

Be aware that if the start and end-date/time of the date range have not been explicitly changed by you from this default, then the end time will update to the current time whenever any change is made to a event report-type, filter or viewing option (and stay at that date-time). After making an explicit change to the date range, you must refresh the browser page for the Tehama Webapp in order to regain this behaviour.

The filters and viewing-options for your selection are applied, and the displayed event report updated, as soon as you select it.

The event filters and event report viewing options for your selection will appear in the Advanced settings.

If you want to 'tweak' the event report, feel free to proceed to create a custom event report. The Advanced settings for your custom event report will start off with the values set for your preconfigured event report selection.

One way to tweak the preconfigured event report may be to change the default date-time range. Note that the date-range filter is the one filter option that will not cause the selected preconfigured event report type to change to Custom when it has been changed.


How can you export a chart event report?

Follow these steps:

  1. Access the Activity Stream (see section above).
  2. Configure your chart event report (custom or pre=configured).
  3. From the top of the page select the export icon export icon.

Export icon dropdown

Click on the export option that you desire. For example, Export as SVG (Scalable Vector Graphics), or Export as PDF (Portable Document Format). (Note, more options may become available in the future.)

Look for your event report in your downloads folder.




Events

These tables of events, broken down by event type, provide a reasonable idea of the events you can expect to see in the Activity Stream. It is not guaranteed to be complete nor accurate:

(The event text displayed in the Tehama Webapp may vary from what is provided in the tables below.)

Room Access Events:
Description Text
Add user(s) to room
   (user proposed by another user, same message if approval automatic or explicit)
Approver has approved access for user(s) to room room
Add user to room
   (user proposed by approver, approval always automatic)
Approver has added user to room room
Propose adding user to room
   (user proposed by non-approver where explicit approval required)
User (non approver) has proposed user to room room
Remove user(s) from room Approver has removed user(s) from room room
Reject proposed adding of user(s) to room Approver has rejected access for user(s) to room room
Accept invitation to join room (user) User has accepted the invitation to the room room
Decline invitation to join room (user) User has declined to connect to the room 'room'.
Invite another organization to join room User has invited organization to room room
Add organization to room (in response to acceptance of invitation) The organization organization has been added to the room room
Decline invitation to join room (organization) User for invited organization has declined to connect to your created room 'room'._
Remove room access policy
User has removed access from the organization organization to the room room
Fetch secret from room's secret vault User has fetched secret 'name' of type 'secret-type' (owner: 'owner')
Test connectivity to a target with the connectivity test tool User has run the connectivity test with 'ip' from 'origin'. The connectivity test id is 'id'
A connectivity test run with the connectivity test tool succeeds Connectivity test 'id' completed successfully.
A connectivity test run with the connectivity test tool fails Connectivity test 'id' failed

Room Config Events:
Description Text
Create room User has created room room
Archive room User has archived room room
Delete room User has deleted room room
Delete room recordings User has deleted a recording in room room
Change room name Room 'old room name's' name has been changed to new room name
Create mount in secrets vault
e.g.: create secrets folder with name 'MYSQL ON EC2 IN US-EAST-1' of type 'mysql'
User has created mount 'name' of type 'type'
Configure mount connection in secrets vault User has configured the connection for mount 'name' of type 'type'
Configure mount lease in secrets vault User has configured the lease for mount with name 'name'
Change room subscription plan User has changed the room plan to plan
Create a connectivity profile for a room User has initiated room connectivity
Complete a connectivity profile for a room
This generates the room's access code.
User has completed room connectivity

Desktop Access Events:
Description Text
Connect to desktop User has connected to workspace: workspace for hours hours and minutes minutes

Desktop Config Events:
Description Text
Create a desktop configuration User has assigned a desktop name
Request a desktop configuration User has requested a desktop in the room room
Reject requested desktop configuration Approver has rejected the request for a new desktop configuration.
Delete a desktop configuration request User has deleted the request for a new desktop configuration.
All other (primarily Organization-related) Events:
Description Text
Add user(s) to a team User has added user(s) to team team
Remove user(s) from a team User has removed user(s) from team team
Invite user to join organization as team member User has invited new user to their organization
Request MFA reset User has reset MFA access for email: email
Remove staff member(s) from an organization Manager 'manager' has removed the following staff members from the organization: 'staffMembers'.
Change the role of a staff member in an organization Manager has changed role of user to role
Change the support plan for an organization User has changed the support plan to plan
Deactivate organization The organization organization name has been deactivated
Reactivate organization The organization organization name has been reactivated.