diff --git a/4.-Setup-and-Monitor-Live-Reports.md b/4.-Setup-and-Monitor-Live-Reports.md index a573892..9bccd77 100644 --- a/4.-Setup-and-Monitor-Live-Reports.md +++ b/4.-Setup-and-Monitor-Live-Reports.md @@ -1,169 +1,125 @@ -# Setup and Monitor Live Reports +# Create and Edit Maps -Live Reports give you real-time visibility into distributor activity across your project areas. You can create a report, assign users, and select specific maps to track. As distributors operate, their movement history is recorded and displayed visually on the map. You'll also be able to monitor area coverage progress and view hourly location posts through the dashboard. +Maps in Lastmiler are used to define areas of interest. You can manage both maps and folders to suit your operational needs. -## Create a Live Report +## Accessing the Mapping Feature -To create a live report go to the **"Reporting"** page. +After logging in to Lastmiler, click **"Mapping"** in the top navigation bar. -![Empty reports table](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/1-empty-report-list.v1.png) +![Mapping default state](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/01.png) -Click on the **"Create Report"** button in the top right corner. +## Managing Folders -![Create report type selection modal](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/2-report-type-selection-modal.v1.png) +Before you can create maps, you must first create folders. Folders help group maps by area, type, or any other criteria relevant to your work. -- You will be prompted to select the type of report you want to create. -- After selecting the report type, you will be taken to the report creation form. +To manage folders, click the **"Manage Folder"** button in the top left corner. This opens a side panel where you can create, rename, and delete folders. To close the panel, click the **"Close"** button in the top left of the side panel. -> The difference between the **"Completeness of maps, fixed time"** and **"Tagged users, fixed time"** is that the first offers property coverage. +### Creating a New Folder -![Filled completeness of maps report form](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/3-filled-report-form.v1.png) +- In the **"Manage Folders"** side panel, enter a name in the input field. +- Click the **"Add"** button. The new folder will appear in the list. -In the form: +![Mapping folders side panel](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/02.png) +![Mapping folders side panel map created](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/03.png) -- In the **"Name"** field, type a name for your report. -- In **Select tag**, choose the tag that includes all users you want to track. -- In **Selected dates**, set the start and end dates. -- In **Map visibility for mobile users**, choose how maps will appear in the mobile app: - - **"None"** means mobile users will not see any map. - - **"Only if in map"** means they will only see maps where they are physically located. - - **"All"** shows all maps in the report. -- **Map selection**: - - Click the dropdown in the top left corner of the Google map. - - Select a folder from the list. Once selected, all areas from that folder will be drawn on the map with names and outlines. - - Click any area to add it to your report. Selected areas will turn red and appear in the list on the right. - *(You can select areas from multiple folders)* - - To remove a selected area, click the area on the Google map again or click the "x" next to its name in the side panel. -- For reports using **"Completeness of maps, fixed time"**, you will also see a Property type option at the bottom. You can include **"Residential only"**, **"Commercial only"**, or both. +### Changing Folder Color -Click **Complete** to create your report. +To help visually distinguish between folders: -## Edit Report +- Click the folder icon next to the folder name to open the color picker. +- Select a color from the palette to apply it to the folder. -To edit an existing report, go to the **"Reporting"** page and click on the **"Edit"** button next to the report you want to modify. +![Mapping folders side panel change color](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/04.png) -![Edit report button](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/10-edit-report.v1.png) +### Renaming Folders -## Delete Report +To rename a folder: -From the **Edit** report form, you can also delete the report by clicking on the **"Remove Report"** button at the bottom of the form. +- Click the folder name or the edit icon next to it. +- Type the new name into the input field that appears. +- Click the checkmark icon to save the change, or click the cross icon to cancel. -## Viewing and Monitoring Live Reports +![Mapping folders side panel rename folder](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/05.png) -![Report list with newly created report](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/4-created-report-in-report-list.v1.png) +### Deleting Folders -To view and monitor your live reports, from the **"Reporting"** page, click on the **"View"** button next to the report overview. +To delete a folder: -### Report Overview +- Click the trash bin icon next to the folder name. +- A confirmation dialog will appear. +- Click **"Delete"** to confirm or **"Cancel"** to abort. -![Report overview](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/5-report-overview.v3.png) +![Deleting a folder](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/06.png) -In the top center of the page you can see the report name, type (e.g., "Completeness of maps, fixed time"), and the start and end dates of the report. +## Managing Maps -The main area of the page is the map, which displays the areas, names, distributors history (represented by gray dots), and area property coverage in percents. +Once a folder has been created and the **"Manage Folder"** side panel is closed, you can begin adding maps to it. Maps are used to define zones such as delivery areas, service regions, or other relevant boundaries. -> To customize the report overview, you can use the checkboxes above the map. +### Creating a New Map -To see more details for any area, click on it. +To begin: -### Report Detailed View +- Use the dropdown next to the **"Manage Folder"** button to select a folder. +- Click the **"Manage Maps"** button in the upper right corner to open the map management panel. -Here you have real-time information about the selected report, including the map with the area of interest, property coverage, and distributor history. +![Mapping select folder](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/07.png) +![Mapping maps side panel](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/08.png) -![Report detailed view](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/6-report-detailed-view.v1.png) +To create a map: -In the report detailed view, you can see more granular information about the selected area in the side panel right of the map. This includes: +- Enter a name in the input field. +- Click **"Add"**. The panel will close, and you can begin drawing the map. -- The name of the area -- The percentage of properties covered in the area -- A count of properties touched by distributors -- Checkbox to show/hide missed properties on the map -- A list of distributors assigned to the report, and checkbox for each user to show/hide their history on the map +![Mapping map drawing](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/09.png) -The map now shows detailed distributor information: +### Searching for a Location -- The oldest location is represented by a white circle with a black border -- The newest location is represented by a black circle with a white border. -*(If the gray halo around the newest location indicates that the distributor is currently active in the area)* -- The gray line represents the path of the distributor, showing their movement history. +To help locate your area of interest: -To view detailed location information, simply zoom on the area of interest on the map. +- Click the **"Search location"** field at the top of the map. +- Enter a place name, such as a street or city. +- Select a result from the suggestions. -![Report detailed location view](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/7-tracking-point-details.v2.png) +![Mapping location search](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/10.png) -The red dots will apear along the distributor path, hovering over them will show you various information about the location, like date, time, speed and battery level. +### Drawing a Map Shape -## Dashboard +Click on the map to begin drawing your shape. -The dashboard provides an overview of all live reports, allowing you to monitor their progress and performance. +![Mapping map drawing](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/11.png) -### Current Reports +- To complete the shape, click the first point again or double-click anywhere. +- Click a point to remove it, or drag to adjust. +- When complete, the commercial, residential, and total property counts will be displayed. +- To cancel the drawing, click **"Cancel"**. +- To clear the shape and start over, click **"Clear"**. +- To save the shape, click **"Save"**. The shape will be saved in the selected folder. -To view the report progress of all active reports, go to the **"Reporting"** page and click on the **"Current Reports"** tab. +![Mapping polygon drawn](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/12.png) -![Current reports dashboard](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/8-dashboard.v1.png) +### Viewing Map Addresses -Here you will see all of your active reports, along with the overal progress of each reportin percentage and in total number of properties covered. You can also see the progress for each individual map within the report. +To view addresses inside a map shape: -These reports can be archived by clicking on the **"Archive"** button next to the report name. You can find archived reports in the **"Archived Reports"** tab and restore them if needed. +- Click the **"Display Addresses"** button below the property count. -### User Activity +A new browser tab will open with a list of addresses. -To view the activity of all users, go to the **"Reporting"** page and click on the **"User Activity"** tab. +![Mapping import postcode library](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/13.png) -![User activity dashboard](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/9-user-activity.v1.png) +### Importing Postcode Sectors -Here you can select a user tag to display all users within that tag, then select a specific date to view post activity within a 24-hour span for that day. The activity is visualized using color-coded boxes for each hour: +To create a map based on postal codes: -- **Gray boxes**: No activity (0 posts) -- **Yellow boxes**: Low activity -- **Green boxes**: High activity +- Click the **"Import"** button at the top of the map to open the postcode selector. -You can hover over any specific hour to see the exact number of posts for that time period. For the current date, a blue indicator appears below the current hour to show real-time progress. +![Mapping import postcode library](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/14.png) -## Report Sharing +- Choose the desired library from the **"Library"** dropdown. +- In the **"Postcode Sector"** field, begin typing the sector code. Matching suggestions will appear. +- Select the correct sector and click **"Draw"**. -Report can be shared privately with your customers, or via a public link. To share a report, go to the **"Reporting"** page and click on the **"Share"** button next to the report you want to share. +![Confirming imported postcode sector](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/15.png) +![Mapping drawn postcode area](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/creating-and-editing-maps/screenshots/16.png) -### Sharing with Customers - -![Share report modal filled](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/11-share-report.v1.png) - -- Enter the email address of the user you want to share the report with in the input on the left side -- Pick a date on the left side to which the user will have access to the report. -*(If you leave the date empty, the user will have access to the report indefinitely, or until you remove them)* -- Click **"Add"** to share the report with the customer. -- The **"Show locations marks on map"** will make properties visible on the map for your customers when toggled on. - -![Share report modal with customer shared](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/12-share-report-with-customer.v1.png) - -You will see the list of the users you have shared the report with. - -The **"Share status"** column shows if the report sharing has expired for that particular customer. - -To unshare the report with a customer, click on the **"Remove"** button in the row of the user you want to remove. - -### Sharing via Public Link - -To share a report via a public link, click on the **"URL Link"** tab in the share report modal. - -![Share report modal with public link](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/13-share-report-via-public-url.v2.png) - -- You can set the expiration date for the public link by setting the date in the **"Share until end of"** field. If you leave the date empty, the link will be valid indefinitely. -- Click **"Generate link"** to create the public link. - -![Public link generated](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/14-shared-report-via-public-url.v1.png) - -You can copy the generated link and share it with anyone. The public link will allow users to view the report without needing to log in. - -### Revoking the Public Link - -If you want to revoke the public link, simply click on the **"Revoke link"** button in the share report modal. This will invalidate the public link and users will no longer be able to access the report via that link. - -## View Shared Report Status - -![Shared report status](https://gitea.redburst.com/lastmiler-knowledge-base/Manager/raw/branch/main/setup-and-monitor-live-reports/screenshots/15-share-report-status.v1.png) - -Visual cue that the report is shared with a customer or via public link is that the **"Share"** button in the report list will replaced with **Link** icon in case that the report is shared via public link, or with **Users** icon in case that the report is shared with a customer. - -You can glance additional information about the shared report by hovering over the **Link** or **Users** icon. This will show you the validity of the public link or the list of customers with whom the report is shared, along with their share status. +After importing the postcode sector shape, you can edit it as you would any manually drawn map. When finished, click **"Save"** to store the map.