Logs
Why do we need the feature?
Manual csv uploads are an integral part of the value proposition of Compass - it’s one of the most widely used methods for feeding data into the system apart from integration. When the user uploads the data (user/event), the Logs feature helps the end user to see the status of the corresponding upload in real time (uploading/ completed) with the number of records created/skipped once the upload completes.
The UI under uploads have 6 user data points for end users to see for themselves and monitor their uploads against them:
File Name - name of the csv file uploaded
Upload Date - date when the upload was attempted
Uploaded By - admin name, based on the current login
Uploaded To - name of the datasource/user template
Records Created - no. of records created in DS post upload
Records Skipped - no. of records skipped
While the first 4 elements help maintain logs and information about uploads made in the past, ‘Records created’ and ‘Record Skipped’ helps end users determine whether the corresponding upload was successful.
Using the Feature
As soon as the user uploads a file in a corresponding event/user template, a corresponding record is added in the top of the Logs page/table stating the status of the upload as ‘Processing’ under Records created (please see screenshot below for reference):
A successful upload is indicated by the expected number of records under ‘Records Created’ and zero under ‘Records Skipped’.
The number of record(s) that fail to upload can be viewed under the ‘Records Skipped’ column - by downloading the csv file by clicking on the download button next to this number, we can view these records and the reason for the failure as the error message in the last column of the downloaded csv.
The expectation/next step is to fix these errors and reupload the file for the complete data upload.
Example Use Case
In the below example, two records are being uploaded but one has a different date format that what is expected in the template (dd-mm-yyyy)
Based on the error message in the last column of downloaded error file from Compass, the end user is expected to make the rectification and upload the same file:
Below listed are the various error messages for upload on Compass and ways to handle them: <Product Input>
UI Elements
Below screenshot shows the landing page of Logs.
The main UI elements are as follows:
File Name - name of the csv file uploaded
Upload Date - date when the upload was attempted
Uploaded By - admin name, based on the current login
Uploaded To - name of the datasource/user template
Records Created - no. of records created in DS post upload
Records Skipped - no. of records skipped
Other UI elements include:
Rows per page - Dropdown to select number of records to be displayed from the option 10, 25, 50, 100 for pagination at the bottom right, element 1
Arrows - To navigate to next or previous page, grayed out based on the current page the user in on (first/last) at the bottom right, element 2
Search - Magnifying glass icon where user/admin who made the upload can be searched for, returning all corresponding uploads made by the user at the top right, element 1
Filter - The records can be filtered on the basis of three input fields - Date range of upload (Uploaded On), the uploader (Uploaded By), and the datasource to which the data was uploaded (Uploaded To). The user can choose the filters accordingly and Apply or Reset the filters at the bottom of the pop-up (see below screenshot for reference)
Feature Details
Name | Logs |
Description | This feature helps end users to monitor the various parameters pertaining to all uploads on Compass |
Vision | Monitoring the uploads on Compass |
Goals | Enable end users to be able to monitor the uploads made by them Keep a log of all uploads in the A/c along with timestamps |
Personas | Admin |
Not doing | NA |
Acceptance criteria | 1. Creation of a record showing upload in progress 2. Values populated against Records created and Records skipped for all uploads |
Additional details NA
Release <Product Input> (Product Team)
Release | Release name |
Date | Release date |
Initiative | Initiative that the release relates to |
Features | List the key features included in the release |
Milestones | Release milestones |
Dependencies | Release dependencies |
Analytics
How long it takes for people to interact with the feature for the first time, measure of ease of use and adaptability
Fairly simple to understand, self explanatory verbatim on the UI
How often feature is being used
Critical feature, hence used frequently
How long users spend interacting with the feature
Depends on the frequency of upload, used/referred to with each upload
Abandonment rate
None, as this is a critical and frequently used feature
Future work, optional
<Product team to fill in>
Last updated