support:user_logging
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| support:user_logging [2022/05/11 15:26] – [p.d] dpatenaude | support:user_logging [2022/05/24 19:20] (current) – [p.d] dpatenaude | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== User Logging ====== | ====== User Logging ====== | ||
| - | This page serves as a high level reference guide to what .decimal logs for user interactions with our software. There are 3 difference | + | This page serves as a high level reference guide to what .decimal logs for user interactions with our software. There are 3 different |
| - | - **[[support: | + | - **[[support: |
| - **[[support: | - **[[support: | ||
| - **[[support: | - **[[support: | ||
| Line 15: | Line 15: | ||
| - | .decimal uses [[https:// | + | .decimal uses [[https:// |
| * Successful & Failed Logins | * Successful & Failed Logins | ||
| * Successful Logouts | * Successful Logouts | ||
| * Blocked Account (after too many login attempts) | * Blocked Account (after too many login attempts) | ||
| + | |||
| + | Note: These logs are not directly accessible by end users, but may be provided by .decimal staff upon request. | ||
| See below for example logs for common Auth0 events: | See below for example logs for common Auth0 events: | ||
| Line 26: | Line 28: | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | { | ||
| - | " | ||
| - | }, | ||
| " | " | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| } | } | ||
| </ | </ | ||
| Line 53: | Line 42: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| Line 68: | Line 54: | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | " | ||
| " | " | ||
| } | } | ||
| Line 80: | Line 62: | ||
| { | { | ||
| " | " | ||
| - | " | ||
| " | " | ||
| " | " | ||
| " | " | ||
| " | " | ||
| - | " | + | " |
| " | " | ||
| " | " | ||
| " | " | ||
| " | " | ||
| - | " | ||
| - | " | ||
| " | " | ||
| } | } | ||
| Line 104: | Line 83: | ||
| ==== p.d ==== | ==== p.d ==== | ||
| - | p.d logs the local user activity and records the following information to it' | + | p.d logs the local user activity and records the following information to its local application |
| ^ Log Item ^ Description ^ | ^ Log Item ^ Description ^ | ||
| | username | The username/ | | username | The username/ | ||
| | patientName | An encrypted string | | patientName | An encrypted string | ||
| - | | medicalRecordNumber | An encrypted string for the patient the log entry applies to | | + | | medicalRecordNumber | An encrypted string for the patient's MRN the log entry applies to | |
| | uniquePlanName | An encrypted string for the plan the log entry applies to | | | uniquePlanName | An encrypted string for the plan the log entry applies to | | ||
| | planName | An encrypted string for the plan the log entry applies to | | | planName | An encrypted string for the plan the log entry applies to | | ||
| | logDate | The local date time of the log entry | | | logDate | The local date time of the log entry | | ||
| - | | logEvent | The event that the log entry is for. logEvents include, but are not limited to: \\ -User log in \\ -User log out \\ -Plan Opens \\ -Plan Saves \\ -Plan Closes | + | | logEvent | The event that the log entry is for. logEvents include, but are not limited to: \\ -User log in \\ -User log out \\ -Plan Open \\ -Plan Save \\ -Plan Close \\ -Order placed to decimal Direct \\ -Local and DICOM AE file export |
| + | |||
| + | * If on p.d 5.4.5 or later these logs may be exported from the About menu within p.d to the designated Data folder in the p.d settings. A new Logs folder will be created that contain the unencrypted user logs. | ||
| + | * Otherwise these logs may be exported to a local text file only by a .decimal administrator. For assistance exporting the logs please contact .decimal support. | ||
| ==== decimal3D ==== | ==== decimal3D ==== | ||
| - | [[decimal3d: | + | [[decimal3d: |
| ^ Log Item ^ Description ^ | ^ Log Item ^ Description ^ | ||
| | User ID | The username/ | | User ID | The username/ | ||
| | Action | | Action | ||
| - | | Date/Time | The local date time the action was performed | + | | Date/Time | The local date time the action was performed. Actions include, but are not limited to: \\ -User log in attempts\\ -User log in success/ |
| - | + | ||
| - | Actions include, but are not limited to: | + | |
| - | * User log in attempts | + | |
| - | * User log in success/ | + | |
| - | * User log out | + | |
| - | * View patients list | + | |
| - | * View patient info (including patient MRN) | + | |
| - | * Create new scans/ | + | |
| - | * Orders placed to decimal Direct (including beam name) | + | |
| - | * Local and AE file exports (e.g.: DICOM) | + | |
| - | * Patient deletion | + | |
| ==== decimal eRT ==== | ==== decimal eRT ==== | ||
| - | [[electronrt: | + | [[electronrt: |
| ^ Log Item ^ Description ^ | ^ Log Item ^ Description ^ | ||
| Line 143: | Line 114: | ||
| | ID | The ID of the corresponding Data Type of the log entry | | | ID | The ID of the corresponding Data Type of the log entry | | ||
| | Date | The date time of the log entry | | | Date | The date time of the log entry | | ||
| - | | Log Event | The even that was logged | + | | Log Event | The event that was logged. Log Event' |
| - | | Data Type | What data caused to the log entry (see below for an itemized list) | | + | | Data Type | What data caused to the log entry. Data Type's include, but are not limited to: \\ -Application |
| | Username | The users first and last name that caused the log entry | | | Username | The users first and last name that caused the log entry | | ||
| - | Log Event' | ||
| - | * Import Patients | ||
| - | * View Patients | ||
| - | * Open Patients | ||
| - | * Import Courses | ||
| - | * Update Course | ||
| - | * Create Plans | ||
| - | * Update Plans | ||
| - | * Clone Plans | ||
| - | * Open Plans | ||
| - | * Update Organization | ||
| - | * Export DICOM files locally | ||
| - | * Export DICOM files to AE service | ||
| - | * Approve Plans | ||
| - | * Order files to decimal Direct | ||
| - | * Export Reports | ||
| - | Data Type's include, but are not limited to: | ||
| - | * Application (root level interactions without a specific data to link to) | ||
| - | * Organization | ||
| - | * Patient | ||
| - | * Course | ||
| - | * Plan | ||
| - | * Export | ||
| - | * Order | ||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ||
| Line 176: | Line 123: | ||
| ===== decimal Direct ===== | ===== decimal Direct ===== | ||
| - | Users will interact with the decimal Direct website to perform certain tasks. | + | Users will interact with the decimal Direct website to perform certain tasks. For each logged interaction in Direct the following is recorded: |
| - | + | ||
| - | For each logged interaction in Direct the following is recorded: | + | |
| ^ Log Item ^ Description ^ | ^ Log Item ^ Description ^ | ||
| Line 186: | Line 131: | ||
| | TimeStamp | The data time (as Eastern Time) of the action | | | TimeStamp | The data time (as Eastern Time) of the action | | ||
| + | See below for the outline of what user interactions are recorded. | ||
| ==== Normal User Interactions ==== | ==== Normal User Interactions ==== | ||
| Line 201: | Line 147: | ||
| A manager user interaction includes any elevated user tasks that are performed by the site manager within the Management pages. Manager user interactions that are logged include: | A manager user interaction includes any elevated user tasks that are performed by the site manager within the Management pages. Manager user interactions that are logged include: | ||
| - | * FIXME | + | |
| + | ^ Log Event ^ Captured Data ^ | ||
| + | | Site Management | Site Info (address) Update | | ||
| + | | Application Management | Version Change | | ||
| + | | User Management | User Add | | ||
| + | | ::: | User Remove | | ||
| + | | ::: | User Info Edit | | ||
| + | | ::: | User Permissions Edit | | ||
| ==== Application Integrations ==== | ==== Application Integrations ==== | ||
| Line 216: | Line 169: | ||
| | Website Auth0 User Login | User | | | Website Auth0 User Login | User | | ||
| | ::: | Date Time | | | ::: | Date Time | | ||
| + | |||
| + | |||
support/user_logging.1652282781.txt.gz · Last modified: 2022/05/11 15:26 by dpatenaude