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:
| Name | Description |
|---|---|
| User ID | The unique identifier of the logged in user who made the change |
| Date | A 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 Type | Additional Fields |
|---|---|
| API Token Created | |
| API Token Disabled | |
| API Token Edited | |
| API Token Enabled |
Activity Record for App Approvals Changes:
| Change Type | Additional Fields | Description | |
|---|---|---|---|
| App Approval Made | When a user completes an individual approval needed for an app version | ||
| App Approval Request Cancelled | When the publisher of the app version retracts the version, thereby cancelling approval requests | ||
| Approval Type Assignment Disabled | Approval type | ||
| Approval Type Assignment Enabled | Approval type |
Activity Records for App Changes:
| Change Type | Additional Fields | Description |
|---|---|---|
| App Copied | ||
| App Created | ||
| App Archived | ||
| App Description Changed | ||
| App Exported | ||
| App Imported | ||
| App Moved | When an app is moved from one App Group to another | |
| App Promoted To Library | When an app is promoted to the Enterprise App Exchange | |
| App Removed From Library | When an app is removed from the Enterprise App Exchange | |
| App Renamed | Previous name New name | |
| App Restored | App is restored from an archived state | |
| App Updated In Library | ||
| App Permission Added | User added ID Permission type | |
| App Permission Changed | User added ID Previous permission type New permission type | |
| App Permission Removed | User added ID Previous permission type | |
| App User Added As Approver | User added ID Approval type | |
| App User Removed As Approver | User removed ID Approval type | |
| App Version Published | List of approvers and associated approval types | |
| App Version Restored | User restored ID | When a published version of the app is restored to the development version of app |
| Comment Created | When a comment is created on an individual step in the app by the app developer |
Activity Records for App Group Changes:
| Change Type | Additional Fields | Description |
|---|---|---|
| App Group Created | ||
| App Group Archived | ||
| App Group Exported | ||
| App Group Imported | ||
| App Group Moved | When an app group is moved to a different level of hierarchy within the list of app groups | |
| App Group Renamed | Previous name New name | |
| App Group Restored | ||
| Group App Permission Changed | Previous app group New app group |
Activity Records for Completions:
| Change Type | Additional Fields | Description |
|---|---|---|
| Completion Failed | When 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 Type | Additional Fields |
|---|---|
| Connector Assigned To Workspace | Connector |
| Connector Cloned | Connector |
| Connector Config Cloned | Connector |
| Connector Config Publish Type Changed | Connector |
| Connector Created | Connector |
| Connector Deleted | Connector |
| Connector Details Edited | Connector |
| Connector Edited | Connector |
| Connector Function Cloned | Connector Connector Function |
| Connector Function Created | Connector Connector Function |
| Connector Function Deleted | Connector Connector Function |
| Connector Function Details Edited | Connector Connector Function |
| Connector Function Renamed | Connector Connector Function |
| Connector Function Restored | Connector Connector Function |
| Connector Function Saved | Connector Connector Function |
| Connector Renamed | Connector |
| Connector Restored | Connector |
| Connector Unassigned From Workspace | Connector Workspace |
| Immutable Connector Updated | Connector |
Activity Records for Analysis Changes:
| Change Type | Additional Fields |
|---|---|
| Dashboard Created |
Activity Records for Display Device Changes:
| Change Type | Additional Fields |
|---|---|
| Display Device Registration Identifier Updated | |
| Display Device Registration Link Used | |
| Display Device Created | |
| Display Device Removed | New display device Station |
| Display Device Renamed | New display device Old display device Station |
| Gateway Removed |
Activity Records for Machine Changes:
| Change Type | Additional 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 Type | Additional Fields |
|---|---|
| Station App Assignment Added | |
| Station App Assignment Removed | |
| Station App Assignment Updated | New assignment Previous assignment Station |
| Station Created | Station |
| Station Deleted | Station |
| Station Display Device Assigned | Display device Station |
| Station Gateway Added | |
| Station Gateway Removed | |
| Station Group App Assignment Added | App assignment Station |
| Station Group App Assignment Removed | App assignment Station |
| Station Group App Assignment Updated | App assignment Station |
| Station Group Created | Station Group |
| Station Group Deleted | Station Group |
| Station Group Renamed | Previous name New name |
| Station Renamed | Previous name New name |
| Station Timezone Changed | Previous timezone New timezone Station |
Activity Records for Table Changes:
| Change Type | Additional 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 Type | Additional Fields |
|---|---|
| User Added To Workspace | |
| User Created | |
| User Deactivated | |
| User Reactivated | |
| User Removed From Workspace | |
| User Role Changed | Previous role New role |
Activity Records for User Role Changes:
| Change Type | Additional Fields |
|---|---|
| Role Created | |
| Role Archived | |
| Role Permissions Updated |
Activity Records for Account and Workspace Settings:
| Change Type | Additional Fields |
|---|---|
| IP Allowlist Enabled | |
| IP Allowlist Disabled | |
| IP Address Added to Allowlist | |
| IP Address Removed From Allowlist | |
| Account Renamed | |
| Workspace Renamed | |
| Workspace Created | |
| Workspace Archived | |
| Time Zone Changed | |
| SAML Authentication Enabled | |
| SAML Authentication Disabled |
Tests
| ID | Name |
|---|---|
| QA-T126 | News Feed : 01 - Activity History and Activity Records |
| QA-T596 | Widgets - Record History Widget |
| QA-T1251 | Activity history is workspace scoped |
Requirements
| ID | Requirement |
|---|---|
| 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. |