specs/models/M_ACTIVITY

Activity Record

Activity records are generated by certain types of changes to a model in the system. They are immutable, and can be retrieved in a reverse chronological timeline to give an audit log of actions.

Fields

All activity records have these fields:

NameDescription
User IDThe unique identifier of the logged in user who made the change
DateA timestamp of when the action occured

The fields saved on the activity record also have access to additional fields based on the model and change type. Every record also contains a reference to the ID of that model. Activity record types in the system:

Activity Records for API Token Changes:

Change TypeAdditional Fields
API Token Created
API Token Disabled
API Token Edited
API Token Enabled

Activity Record for App Approvals Changes:

Change TypeAdditional FieldsDescription
App Approval MadeWhen a user completes an individual approval needed for an app version
App Approval Request CancelledWhen the publisher of the app version retracts the version, thereby cancelling approval requests
Approval Type Assignment DisabledApproval type
Approval Type Assignment EnabledApproval type

Activity Records for App Changes:

Change TypeAdditional FieldsDescription
App Copied
App Created
App Archived
App Description Changed
App Exported
App Imported
App MovedWhen an app is moved from one App Group to another
App Promoted To LibraryWhen an app is promoted to the Enterprise App Exchange
App Removed From LibraryWhen an app is removed from the Enterprise App Exchange
App RenamedPrevious name
New name
App RestoredApp is restored from an archived state
App Updated In Library
App Permission AddedUser added ID
Permission type
App Permission ChangedUser added ID
Previous permission type
New permission type
App Permission RemovedUser added ID
Previous permission type
App User Added As ApproverUser added ID
Approval type
App User Removed As ApproverUser removed ID
Approval type
App Version PublishedList of approvers and associated approval types
App Version RestoredUser restored IDWhen a published version of the app is restored to the development version of app
Comment CreatedWhen a comment is created on an individual step in the app by the app developer

Activity Records for App Group Changes:

Change TypeAdditional FieldsDescription
App Group Created
App Group Archived
App Group Exported
App Group Imported
App Group MovedWhen an app group is moved to a different level of hierarchy within the list of app groups
App Group RenamedPrevious name
New name
App Group Restored
Group App Permission ChangedPrevious app group
New app group

Activity Records for Completions:

Change TypeAdditional FieldsDescription
Completion FailedWhen a user switches from one app to another before completing the app, the app data will be logged as a "failed completion"

Activity Records for Connector Changes:

Change TypeAdditional Fields
Connector Assigned To WorkspaceConnector
Connector ClonedConnector
Connector Config ClonedConnector
Connector Config Publish Type ChangedConnector
Connector CreatedConnector
Connector DeletedConnector
Connector Details EditedConnector
Connector EditedConnector
Connector Function ClonedConnector
Connector Function
Connector Function CreatedConnector
Connector Function
Connector Function DeletedConnector
Connector Function
Connector Function Details EditedConnector
Connector Function
Connector Function RenamedConnector
Connector Function
Connector Function RestoredConnector
Connector Function
Connector Function SavedConnector
Connector Function
Connector RenamedConnector
Connector RestoredConnector
Connector Unassigned From WorkspaceConnector
Workspace
Immutable Connector UpdatedConnector

Activity Records for Analysis Changes:

Change TypeAdditional Fields
Dashboard Created

Activity Records for Display Device Changes:

Change TypeAdditional Fields
Display Device Registration Identifier Updated
Display Device Registration Link Used
Display Device RemovedNew display device
Station
Display Device RenamedNew display device
Old display device
Station
Gateway Removed

Activity Records for Machine Changes:

Change TypeAdditional Fields
Machine Created
Machine Data Exported
Machine Deleted
Machine Edited
Machine Published
Machine Renamed
Machine Restored
Machine Type Created
Machine Type Deleted
Machine Type Edited
Machine Type Imported
Machine Type Renamed
Machine Type Restored
Machine Type Version Published

Activity Records for Station Changes:

Change TypeAdditional Fields
Station App Assignment Added
Station App Assignment Removed
Station App Assignment UpdatedNew assignment
Previous assignment
Station
Station CreatedStation
Station DeletedStation
Station Display Device AssignedDisplay device
Station
Station Gateway Added
Station Gateway Removed
Station Group App Assignment AddedApp assignment
Station
Station Group App Assignment RemovedApp assignment
Station
Station Group App Assignment UpdatedApp assignment
Station
Station Group CreatedStation Group
Station Group DeletedStation Group
Station Group RenamedPrevious name
New name
Station RenamedPrevious name
New name
Station Timezone ChangedPrevious timezone
New timezone
Station

Activity Records for Table Changes:

Change TypeAdditional Fields
Table Archived
Table Column Added
Table Column Archived
Table Column Description Edited
Table Column Label Edited
Table Column Restored
Table Created
Table Csv Imported
Table Description Edited
Table Record Archived
Table Records Exported
Table Renamed
Table Renamed Description Edited
Table Restored

Activity Records for User Changes:

Change TypeAdditional Fields
User Added To Workspace
User Created
User Deactivated
User Reactivated
User Removed From Workspace
User Role ChangedPrevious role
New role

Tests

IDName
QA-T126News Feed : 01 - Activity History and Activity Records
QA-T596Widgets - Record History Widget
QA-T1251Activity history is workspace scoped

Requirements

IDRequirement
PLAT-8885 (813)All data shall be Attributable; data must be identified to the person who did the data collection. Records shall include information about how the data was acquired, action/activity performed, where and and when.