.. raw:: html .. role:: heading :heading:`Mobile App` .. role:: bolditalic :class: bolditalic .. _mobileauth: Authentication -------------- Authentication is the first step to accessing the mobile application. This app uses an authentication method with a passcode :code:`passcode` obtained from the :ref:`mobile assignment`. 1. Press the :bolditalic:`Get started` button to begin using the application. .. image:: ../assests/mobile-auth-1.png :alt: Mobile auth step-1 :width: 50% 2. Enter the passcode correctly. If you are unsure, click **the eye icon to view the passcode**. Then click the **Login button** once you are confident. .. image:: ../assests/mobile-auth-2.png :alt: Mobile auth step-2 :width: 50% 3. If successful, you will be redirected to the application's main menu. .. image:: ../assests/mobile-homepage.png :alt: Mobile homepage :width: 50% .. _mobile_dashboard: Home overview ------------- This application features a dashboard that displays most of the information about the questionnaire and basic submission statistics, such as: * The number of saved submissions. * The number of submitted submissions. * The number of synchronized submissions. Besides that, you can also do three things here: 1. Easily search for the questionnaire you want. .. image:: ../assests/mobile-home-search.png :alt: Mobile search forms :width: 100% 2. Go to the users page to get more information about the current user. .. image:: ../assests/mobile-home-users.png :alt: Mobile go to users list :width: 100% 3. Go to the settings page to customize as needed. .. image:: ../assests/mobile-home-settings.png :alt: Mobile go to settings :width: 100% Syncing Datapoints ------------------ .. note:: This will ensure that your app has the most up-to-date information and data from the server. Syncing datapoints is a feature that pulls data from the server to the mobile app. During this process, you will get the following: * Re-fetching forms * Re-downloading administration, organisations and entities data * Getting all registration submissions To sync data with the server, follow these steps: 1. Click the :bolditalic:`Sync Datapoints` button. Wait until the process is finished. .. image:: ../assests/mobile-sync.png :alt: Mobile sync datapoints :width: 100% Submission ---------- ============ Registration ============ A registration submission is the initial datapoint submission that undergoes an approval process and is created by users with aligned administrative access rights. .. image:: ../assests/mobile-registration.png :alt: Mobile :width: 100% ========== Monitoring ========== A monitoring submission can be made when datapoints from the server are available after synchronization. This submission also undergoes an approval process similar to registration submissions. .. image:: ../assests/mobile-monitoring.png :alt: Mobile :width: 100% ============================== Save, Exit and Sync Submission ============================== During the form-filling process, the mobile app also assists the user in exiting the questionnaire with the following options: * Select :bolditalic:`Exit without saving` to exit the questionnaire without saving the current progress. .. image:: ../assests/mobile-exit.png :alt: Mobile :width: 100% * Select :bolditalic:`Save and exit` to save the current progress. To continue filling out the form, reopen the related questionnaire and choose the :bolditalic:`Edit Saved Forms` menu, then click on the draft datapoint. .. image:: ../assests/mobile-exit-save.png :alt: Mobile :width: 100% To ensure all question groups are answered, click the page number in the middle: * **Blue**: indicates all questions have been answered and validated. * **Gray**: indicates some questions are incomplete. .. image:: ../assests/mobile-submit-1.png :alt: Mobile :width: 100% Generally, completed and submitted forms will automatically sync according to the applied sync interval settings. If the sync process is successful, *a green notification bar with "Done" will appear at the bottom*. The submission can then be viewed again in the :bolditalic:`View Submission Form` menu, as shown in the image below. .. image:: ../assests/mobile-submit-2.png :alt: Mobile :width: 100% If automatic synchronization fails for any reason, the user can perform manual synchronization by pressing the **sync icon** in the top right corner. A confirmation dialog will appear; choose **OK** to proceed with synchronization. .. image:: ../assests/mobile-submit-3-manual.png :alt: Mobile :width: 100% Settings -------- ================= Advanced Settings ================= These settings allow you to customize your sync preferences with the following options: * **Sync Interval**: The duration needed to sync submitted submissions to the server, measured in seconds. * **Sync Wifi**: A switch to enable syncing of submitted submissions to the server only when using a Wi-Fi network. .. image:: ../assests/mobile-settings-1.png :alt: Mobile advanced settings :width: 100% ==================== Geolocation Settings ==================== .. note:: Adjust these settings according to your specific needs to balance between accuracy and performance. These settings allow you to customize your geolocation preferences with the following options: * **Threshold**: The maximum acceptable GPS error distance. * **Accuracy Level**: The desired level of GPS accuracy. Higher accuracy reduces the risk of errors but may increase the time required to obtain a GPS fix. * **Geolocation Timeout**: The maximum amount of time allowed to obtain a GPS value. .. image:: ../assests/mobile-settings-2.png :alt: Mobile geolocation settings :width: 100% ====================== Reset (Clear All Data) ====================== .. warning:: Please note that this process cannot be undone, and all locally stored data will be lost. Make sure to sync any important data with the server before performing a reset. This action will clear all data from the application, and you will need to sign in again to access your data. To reset the application, follow these steps: 1. Click the :bolditalic:`Reset` button. 2. Confirm the reset process by clicking the **Yes** button. .. image:: ../assests/mobile-logout.png :alt: Mobile geolocation settings :width: 100% ============== Update the App ============== .. note:: By regularly updating your app, you ensure optimal performance and access to the latest enhancements. Keeping your app up-to-date ensures you have the latest features, improvements, and security updates. Follow these steps to update the app to the newest version. #. In the Settings menu, find and select the About section. This section contains information about the app, including the current version. #. Click on the **Update application** button. The app will then check the server for the latest version available. #. If a new version is available, you will see an option to update. #. Click the **Update** button to start downloading the latest version of the app. #. Wait patiently while the app downloads the new version. The time this takes may vary depending on your internet connection speed. #. Once the download is complete, follow the on-screen instructions to install the new version of the app. #. Otherwise, click the **Cancel** button to close the dialog. .. image:: ../assests/mobile-update-version.png :alt: Mobile update version :width: 100%