-
-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'development' of github.com:hotosm/fmtm into fix/design-…
…word-changes
- Loading branch information
Showing
41 changed files
with
828 additions
and
486 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,7 +57,7 @@ bump: | |
| && git config --global user.name svcfmtm \ | ||
| && git config --global user.email [email protected] \ | ||
| && cd src/backend \ | ||
| && cz bump --check-consistency' | ||
| && cz bump --check-consistency --no-verify' | ||
|
|
||
| # Run docs website locally | ||
| docs: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ type: application | |
| name: fmtm | ||
| description: Field Mapping Tasking Manager - coordinated field mapping. | ||
| version: "0.1.0" | ||
| appVersion: "2024.4.1" | ||
| appVersion: "2024.5.0" | ||
| maintainers: | ||
| - email: [email protected] | ||
| name: Sam Woodcock | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| If you want to visualise the submissions and create custom charts | ||
| and diagrams using FMTM submissions, then you can follow the steps | ||
| below and load the submissions on any data analysis platform using OData. | ||
| OData endpoints are a standardised way to ingest | ||
| this data into other tools: PowerBI, Tableau, Redash, Grafana | ||
|
|
||
| Why PowerBI? You can use other tools too like Tableau, Redash, Grafana or even | ||
| Excel. However, PowerBI is free to use, very powerful, and user friendly though its Proprietary Microsoft. | ||
|
|
||
| The steps shows how to use powerBI and create custom visualisations. | ||
| ODK already has good docs on this which you can refer to. | ||
| https://docs.getodk.org/tutorial-mapping-households/ | ||
|
|
||
| Step 1: Start a new project, add a new data source 'OData Feed' | ||
| https://private-user-images.githubusercontent.com/78538841/366426499-376de20e-61e5-452e-ab76-669bf1940c72.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzM5MDgwMTUsIm5iZiI6MTczMzkwNzcxNSwicGF0aCI6Ii83ODUzODg0MS8zNjY0MjY0OTktMzc2ZGUyMGUtNjFlNS00NTJlLWFiNzYtNjY5YmYxOTQwYzcyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDEyMTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQxMjExVDA5MDE1NVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPThiMWYzOTBiMDQyNGEzNDI1ZjBjZDg1Mjg2ZmE0NGU4Yzg1MGQyZWIyN2Q5YjQ4MGJmZmRlYzYzMWI3OWMxZWQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.riSVz4Y2tiFXqjkaSWsmsOvLjhx8M_5YiA-LSQ7FBys | ||
| Step 2: Use the OData URLs shown in the ODK docs: | ||
| a. Submission data: /v1/projects/{projectId}/forms/{xmlFormId}.svc | ||
| e.g. https://odk.hotosm.org/v1/projects/86/forms/df9135c8-84b1-4753-b348-e8963a8b4088.svc | ||
| a. Entity data: /v1/projects/{projectId}/datasets/{name}.svc | ||
| e.g. https://odk.hotosm.org/v1/projects/86/datasets/features.svc | ||
|
|
||
| Step 3: Enter your credentials using Basic Auth | ||
|
|
||
| Step 4: Preview the data | ||
|
|
||
| Step 5: Transform data as needed, load into charts, graphs, etc, to create the dashboard you need. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Field Mapping Examples | ||
|
|
||
| Users often write their own guides for the team they are working with. | ||
|
|
||
| This page provides some links to user-generated guides of FMTM over time. | ||
|
|
||
| ## Know Your City Africa: Ghana Slum Mapping | ||
|
|
||
| [Link](https://docs.google.com/document/d/1i6LPj3Ah860BaSQCLvmxqbLmcQB3fM0_W8n15NEeZPo/edit?tab=t.0) | ||
| to project document, including detail on the mapping workflow. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # Mapper Frontend Documentation | ||
|
|
||
| The **Mapper Frontend** was developed to provide a simpler, more intuitive | ||
| mapping experience. | ||
|
|
||
| ## Part (A): Setup For Mapping | ||
|
|
||
| ### Step 1: Install The Custom ODK Collect Mobile App | ||
|
|
||
| - The first time you load the project, you should be prompted to download | ||
| the custom `.apk` from the sidebar. | ||
| - Once downloaded, you should install the custom ODK Collect application. | ||
|
|
||
| !!! tip | ||
|
|
||
| If you already have ODK Collect installed, you may have to uninstall | ||
| it first. | ||
|
|
||
| You may have to enable installing from unknown sources in your device | ||
| settings too. | ||
|
|
||
| ### Step 2: Access the Mapper Frontend | ||
|
|
||
| - **Option 1:** Click the **Start Mapping** button on the project cards of | ||
| explore project page. | ||
| - **Option 2:** Click the **Start Mapping** button on the project details page. | ||
| - **Option 3:** Go to `https://fmtm.hotosm.org/mapnow/<project_id>` to open | ||
| the Mapper Frontend for a specific project. | ||
|
|
||
| !!! note | ||
|
|
||
| This functionality is designed for mappers in the field, so it is | ||
| recommended to use a mobile device to access it. | ||
|
|
||
| ### Step 3: Configure ODK Collect (once only) | ||
|
|
||
| - **Option 1:** Scan the QR code displayed on the Mapper Frontend using | ||
| the custom ODK Collect mobile application. | ||
|
|
||
| - **Option 2:** Download the QR code and import it into ODK Collect to | ||
| load the project. Follow the steps below: | ||
|
|
||
| 1. Open ODK Collect. | ||
| 2. Click the project name in the top right corner. | ||
| 3. Tap the **menu** icon (three horizontal dots). | ||
| 4. Select **Import QR Code**. | ||
| 5. Browse to the downloaded QR image and load the project. | ||
|
|
||
| !!! tip | ||
|
|
||
| For a demonstration of the process above, click the **i** info icon | ||
| on the QR Code tab of the mapper frontend. | ||
|
|
||
| ### Step 4: Load Imagery (optional) | ||
|
|
||
| - You can load the reference base imagery by clicking on offline mode option | ||
| (second tab on bottom navigation bar). | ||
| - Choose the layer you want to load and click on **Show on Map** to visualise | ||
| the layer on map. | ||
| - The layer can also be stored for offline mapping by clicking | ||
| **Store Offline**. | ||
|
|
||
| ## Part (B): Mapping Features | ||
|
|
||
| ### Select An Existing Feature | ||
|
|
||
| In most cases we are submitting a survey about a feature that already exists. | ||
|
|
||
| - Click on a task area: the features within will be displayed. | ||
| - Now click on a feature you wish to map: a popup will appear. | ||
| - Now click 'Map Feature In ODK': ODK Collect will open, with the | ||
| feature pre-selected in the survey (no need to open the ODK map!). | ||
| - Complete the survey and submit. | ||
|
|
||
| !!! note | ||
|
|
||
| You may manually click 'Start Mapping' for a task area. | ||
|
|
||
| However, the task will be automatically locked for you | ||
| if you map a feature within the task area. | ||
|
|
||
| ### Mapping A New Feature | ||
|
|
||
| Sometimes the feature does not exist on the map yet! | ||
|
|
||
| - Click on a task area: a popup will display. | ||
| - At the top right, there is a button **Map New Feature**. | ||
| - Click on the map to create a new geometry. | ||
| - ODK Collect will be opened automatically to fill out the survey | ||
| data for the newly created feature. | ||
|
|
||
| ### Repeat The Process | ||
|
|
||
| - Once the form is submitted, you have to get back to FMTM and select the | ||
| another feature for mapping. | ||
| - You also also have to click the **Sync Status** button to see the feature | ||
| turn green. | ||
| - Select another feature to map (repeat from step 5)! | ||
|
|
||
| !!! note | ||
|
|
||
| You need internet access to update the feature status. | ||
|
|
||
| In a future release, this process will be handled seamlessly | ||
| without user interaction. | ||
|
|
||
| ## Upcoming improvements | ||
|
|
||
| Refer the milestone: <https://github.com/hotosm/fmtm/milestone/50> |
Oops, something went wrong.