diff --git a/documentation/get-started/storage-qfc.en.md b/documentation/get-started/storage-qfc.en.md index f95c6de84..1c81a7055 100644 --- a/documentation/get-started/storage-qfc.en.md +++ b/documentation/get-started/storage-qfc.en.md @@ -1,8 +1,60 @@ --- -title: Additional Storage +title: Billing and Additional Storage tx_slug: documentation_get-started_storage_qfieldcloud --- +# QFieldCloud Billing + +Adding billing information to the account is needed to use QFieldCloud Pro plan or Organization plan. + +For a **Pro plan**, follow these steps : + +1. Click on the username up-right the page +2. Click on "Upgrade to pro" +3. In the "Subscription" section, click on "Upgrade" +4. In Pro section, click on "Activate" +5. Carefully read the "Terms of Service" and agree to the terms of service, then "Proceed" +6. In the "Billing Address" section, fill up the form, and then click on "Proceed to payment" + +For an **Organization plan**, follow these steps : + +1. Click on the username up-right the page +2. Click on "Create organization" +3. Click on "Create" +4. Choose a name for your organization with only 150 characters or fewer, letters, digits, and @/./+/-/_ +5. Click on "Create" +6. Choose how much storage is needed +7. Carefully read the "Terms of Service"and agree to the terms of service, then "Proceed" +8. In the "Billing Address" section, fill up the form, and then click on "Proceed to payment" + +If the billing information is incomplete, at any time it is possible to finish filling up the form by going to *Billing > Subscription > Finish checkout* + +All pricing information is available on the Pricing page. + +## Discontinuing QFieldCloud subscription + +1. If you need to cancel your subscription on QFieldCloud: +1.1. For **Pro** plan accounts, click on your username, choose "Settings." +1.2. For **Organization** plan account, click on the name of your Organization, click on "Edit Organization". Note you need to be owner of that Organization. + + ![Enter to setting](../assets/images/discontinuing_service_01_enter_to_setting.png) + +2. Proceed to the "Billing" section, click on "Change". + + ![Enter to billing section](../assets/images/discontinuing_service_02_change_subcription.png) + +3. Select "Cancel Subscription". + + ![Cancel subscription](../assets/images/discontinuing_service_03_cancel_subscription.png) + +4. Confirm the cancellation in the subsequent pop-up window. + + ![Confirm Cancel subscription](../assets/images/discontinuing_service_04_popup_cancel_subcription.png) + +5. A Nyuki message will then appear, indicating that the subscription will conclude at the end of the current billing period. + + ![Cancellation message](../assets/images/discontinuing_service_05_nyuki_message.png) + # Add QFieldCloud storage QFieldCloud allows you to configure as much storage as you need for your project. diff --git a/documentation/get-started/tutorials/advanced-setup-qfc.en.md b/documentation/get-started/tutorials/advanced-setup-qfc.en.md index acd564f3f..2caf5d767 100644 --- a/documentation/get-started/tutorials/advanced-setup-qfc.en.md +++ b/documentation/get-started/tutorials/advanced-setup-qfc.en.md @@ -63,3 +63,172 @@ It requires your database to be publicly accessible and credentials must be save When using `offline editing`, QField will work on a local copy of the database in a GeoPackage, which will be synced by QFieldCloud to the original database. This is the best choice if the connection in the field is not reliable. Changes will only be visible to users once they sync to QFieldCloud. As a local copy is created, advanced PostGIS features will not be available on QField. Just like for regular GeoPackages, if you define relationships, it is recommended to use UUIDs instead of integer primary keys to avoid conflicts if multiple users create data at the same time. You can find more information on [QFieldCloud technical reference](../../reference/qfieldcloud/concepts.md). + + +## Enabling automatic pushing of changes to QFieldCloud + +With this functionality, users and managers of QFieldCloud projects can enforce automatic pushing of pending changes to QField devices in the field, as well as specify the interval in between automated pushes. The functionality is activated through a project setting, allowing remote activation. + +1. **Access Project Settings**: Navigate to the QField panel in the Project Settings dialog provided by the QFieldSync plugin. + +2. **Enable Auto-Push**: Toggle the "Automatically push pending changes on the following interval" option and establish your preferred interval. + +!![Auto push QFieldSync](../../assets/images/auto-push-pending-changes-qfieldsync.png) + +!![Auto push QField](../../assets/images/auto-push-pending-changes-qfield.png,400px) + +!!! Note + **Benefits:** + + - **Real-Time Updates**: Ensures prompt synchronization of field data with the QFieldCloud project. + - **Streamlined Workflow**: Minimizes manual intervention and ensures surveyors do not need to worry about synchronization, helping them focus on data quality. + + **Considerations:** + + - **Network Stability**: Ensure stable internet connectivity for auto-push functionality. + - **Battery Optimization**: Implement strategies to mitigate battery consumption on QField devices during prolonged fieldwork. + +## Create a project in an organization + +How to create a project in an organization: + +**Option 1: Directly convert your local project to an Organization QFieldCloud project:** + +1. Follow the steps [configure your cloud project](#create-and-configure-your-cloud-project), until you get the "Project details". + +2. Change the owner of the project to your Organization. + + ![Project files over view in QFieldCloud](../../assets/images/converting-project-to-organization-01.png) + +3. Click on "Create" to start the conversion and synchronization. When finish you will see the project is in your Organization in QFieldCloud. + + ![Project files over view in QFieldCloud](../../assets/images/converting-project-to-organization-02.png) + +!!! note + QField Sync 4.6 or newer is required for this functionality + +**Option 2: Uploading directly to the organization:** + +1. Select your organization. + + ![Entering into Organization](../../assets/images/project_organization_01_entering_into_organization.png) + +2. Once you get into the organization, click on "Create a project". + + ![Creating Project](../../assets/images/project_organization_02_creating_project.png) + +3. Select "Create a new empty project". + + ![New empty project](../../assets/images/project_organization_03_new_empty_project.png) + +4. You can see the new project in the overview. + + ![New project created](../../assets/images/project_organization_04_new_project_created.png) + +5. On QGIS in QFieldSync, you will see the new project listed, click on "Edit Selected Cloud Project". + + ![QFieldSync](../../assets/images/project_organization_05_qfield_sync.png) + +6. Choose the folder where you want to save the project. + + ![Selecting folder](../../assets/images/project_organization_06_selecting_folder.png) + +7. In the selected folder, you can either paste an already worked-on project or save a new one. + + ![Copy to project folder](../../assets/images/project_organization_07_copy_project_to_folder.png) + +8. Once the folder contains the project, you can synchronize it. + + ![QFieldSync Overview](../../assets/images/project_organization_08_qfield_sync_overview.png) + +9. Finally, push the changes to the cloud. + + ![Pushing changes to QFieldCloud](../../assets/images/project_organization_09_pushing_changes_to_cloud.png) + +10. You can verify that the files are present in the Organization project. + + ![Project files over view in QFieldCloud](../../assets/images/project_organization_10_files_overview_in_cloud.png) + +**Option 3: Moving the project from your own account to the Organizations:** + +1. If you already have a project in QFieldCloud (refer to [configure your cloud project](#create-and-configure-your-cloud-project)). In the project, click on "Settings" and select "Transfer ownership of this project" to choose the desired Organization for the transfer. + + ![Transferring to Organization](../../assets/images/project_organization_11_transfering_to_organization.png) + +2. A pop-up window will appear to confirm the transfer. To proceed, you will need to type "Here be dragons" and click "Transfer project". + + ![Confirm transfer](../../assets/images/project_organization_12_confirming_transfer.png) + +## Activate email notifications for QFieldCloud changes + +1. Access the Settings of your account. +2. Navigate to the Notifications section. Here, you can customize the frequency of notifications you wish to receive at the email address registered with your account.![Synchronize](../../assets/images/frequency_notifications_settings.png) + + The events you get notified about are: + - User created + - Organization created + - Organization deleted + - Organization membership created + - Organization membership deleted + - Team created + - Team deleted + - Team membership created + - Team membership deleted + - Project created + - Project deleted + - Project membership created + - Project membership deleted + +You will receive notifications for events in which you are not the actor. These notifications are specifically for events that are initiated by other members of your organization or collaborators on your projects. + +## Enhance your project with the "Optimized Packager" + +We recommend to use the new "Optimized Packager" over the deprecated "QGIS Core Offline Editing" for all your projects. Set the packager under "Packaging Offliner" in the "Settings" tab of your project. + +The "Optimized Packager" supports consolidating filtered layers of same datasource into a single offline layer, respecting distinct symbology but also using less storage. Here is an example to illustrate this feature: + +**Example Configuration:** + +- **Layer 1.1:** + - Data Source: `layers.gpkg` + - Table: `layer1` + - Filter: `id % 2 = 1` + +- **Layer 1.2:** + - Data Source: `layers.gpkg` + - Table: `layer1` + - Filter: `id % 2 = 0` + +**Result:** + +For the new offliner: +- A single layer is generated in the offline geopackage, combining data from `layer1` with the specified filters. + +For the old (QGIS) offliner: +- Two separate layers are created, each representing the filtered datasets: + - Layer 1: Filtered with `id % 2 = 1` + - Layer 2: Filtered with `id % 2 = 0` + +!![](../../assets/images/qfc_offline_packager.png,700px) + +!!! note + This configuration must be set in the Settings page of each project in [QFieldCloud](https://app.qfield.cloud/). + +## Connect to a custom QFieldCloud server in QField and QFieldSync + +QField and QFieldSync connect to the QFieldCloud service on [app.qfield.cloud](https://app.qfield.cloud/) by default. + +You can modify the default QFieldCloud server QField and QFieldSync connect to: + +1. Open the login screen in QField or QFieldSync. +2. Double-tap on the Nyuki icon (the blue bee QFieldCloud logo). +3. This action will reveal a field where you can enter the preferred QFieldCloud server address. +4. Enter the details of the desired server in the provided field. +(Leaving the field empty will connect to the default QFieldCloud server at app.qfield.cloud.) + +!![Reveling server in QField Sync](../../assets/images/changing_default_qfieldcloud_server_qfield_sync.png,250px) + +!![Reveling server in QField](../../assets/images/changing_default_qfieldcloud_server_qfield.png,250px) + +!!! Note + It's important to note that QFieldSync does not support the same cloud project in multiple QGIS profiles. As a recommendation use a single QGIS profile for your QFieldCloud projects to avoid synchronization issues. diff --git a/documentation/get-started/tutorials/get-started-qfc.en.md b/documentation/get-started/tutorials/get-started-qfc.en.md index c8defa473..1387599c4 100644 --- a/documentation/get-started/tutorials/get-started-qfc.en.md +++ b/documentation/get-started/tutorials/get-started-qfc.en.md @@ -7,7 +7,7 @@ tx_slug: documentation_get-started_tutorials_get-started-qfc !!! help We have a [community discussion platform](https://github.com/opengisch/qfield/discussions) to discuss your questions, doubts and ideas. Do not hesitate to check it out. -## Get a QFieldCloud account +## Get a free QFieldCloud account :material-monitor: Desktop preparation @@ -15,77 +15,21 @@ Go to the [registration page](https://app.qfield.cloud/accounts/signup/), enter !![Registration form](../../assets/images/qfieldcloud_registration.png,250px) -### Edit Profile +### Edit your profile Change your personal settings. Add a profile picture or get an overview about your ownerships and memberships in organizations. -### Billing - -Adding billing information to the account is needed to use QFieldCloud Pro plan or Organization plan. - -For a **Pro plan**, follow these steps : - -1. Click on the username up-right the page -2. Click on "Upgrade to pro" -3. In the "Subscription" section, click on "Upgrade" -4. In Pro section, click on "Activate" -5. Carefully read the "Terms of Service" and agree to the terms of service, then "Proceed" -6. In the "Billing Address" section, fill up the form, and then click on "Proceed to payment" - -For an **Organization plan**, follow these steps : - -1. Click on the username up-right the page -2. Click on "Create organization" -3. Click on "Create" -4. Choose a name for your organization with only 150 characters or fewer, letters, digits, and @/./+/-/_ -5. Click on "Create" -6. Choose how much storage is needed -7. Carefully read the "Terms of Service"and agree to the terms of service, then "Proceed" -8. In the "Billing Address" section, fill up the form, and then click on "Proceed to payment" - -If the billing information is incomplete, at any time it is possible to finish filling up the form by going to *Billing > Subscription > Finish checkout* - -All pricing information is available on the Pricing page. - -### Discontinuing Services in QFieldCloud - -1. If you need to cancel your subscription on QFieldCloud: -1.1. For **Pro** plan accounts, click on your username, choose "Settings." -1.2. For **Organization** plan account, click on the name of your Organization, click on "Edit Organization". Note you need to be owner of that Organization. - - ![Enter to setting](../../assets/images/discontinuing_service_01_enter_to_setting.png) - -2. Proceed to the "Billing" section, click on "Change". - - ![Enter to billing section](../../assets/images/discontinuing_service_02_change_subcription.png) - -3. Select "Cancel Subscription". - - ![Cancel subscription](../../assets/images/discontinuing_service_03_cancel_subscription.png) - -4. Confirm the cancellation in the subsequent pop-up window. - - ![Confirm Cancel subscription](../../assets/images/discontinuing_service_04_popup_cancel_subcription.png) - -5. A Nyuki message will then appear, indicating that the subscription will conclude at the end of the current billing period. - - ![Cancellation message](../../assets/images/discontinuing_service_05_nyuki_message.png) - -### Organizations - -Your organizations are listed here. Find out more about teams, members and their roles in [concepts of the QField Ecosystem](https://docs.qfield.org/reference/qfieldcloud/concepts/). - -### Projects +### View your cloud projects Search and choose a project from the list or start to create a new project. !![QFieldCloud projects overview](../../assets/images/overview_projects_qfcloud.png) -## Connection to QFieldCloud on QGIS Desktop +## Connect to QFieldCloud on QGIS Desktop :material-monitor: Desktop preparation -In order to connect to QFieldCloud, you need the Plugin “QFieldSync” in QGIS. The next steps show you how you can install and synchronize your data to and from QFieldCloud. +In order to connect to QFieldCloud, you need the QFieldSync plugin in QGIS. The next steps show you how you can install and synchronize your data to and from QFieldCloud. ### Install QFieldSync @@ -137,26 +81,7 @@ By double-clicking on a project in the list, you can see and edit the specific p !![Project properties in QFieldCloud](../../assets/images/project_properties_settings.png) -### Change the default QFieldCloud server in QField and QField Sync - -QField and QFieldSync connect to the QFieldCloud service on [app.qfield.cloud](https://app.qfield.cloud/) by default. - -You can modify the default QFieldCloud server QField and QFieldSync connect to: - -1. Open the login screen in QField or QFieldSync. -2. Double-tap on the Nyuki icon (the blue bee QFieldCloud logo). -3. This action will reveal a field where you can enter the preferred QFieldCloud server address. -4. Enter the details of the desired server in the provided field. -(Leaving the field empty will connect to the default QFieldCloud server at app.qfield.cloud.) - -!![Reveling server in QField Sync](../../assets/images/changing_default_qfieldcloud_server_qfield_sync.png,250px) - -!![Reveling server in QField](../../assets/images/changing_default_qfieldcloud_server_qfield.png,250px) - -!!! Note - It's important to note that QFieldSync does not support the same cloud project in multiple QGIS profiles. As a recommendation use a single QGIS profile for your QFieldCloud projects to avoid synchronization issues. - -### Create and configure your Cloud project +## Create and configure your cloud project Create a new project by clicking the cloud button, down-left. First, you will need to choose how to create the new project between @@ -180,77 +105,6 @@ A form will ask you for project name, description and local directory. In the lo * The entered path is not an existing directory. It will be created after you submit this form. * Multiple project files have been found in the directory. Please leave exactly one QGIS project in the root directory. -### Create a project in an Organization - -How to create a project in an organization: - -**Option 1: Directly convert your local project to an Organization QFieldCloud project:** - -1. Follow the steps [configure your cloud project](#create-and-configure-your-cloud-project), until you get the "Project details". - -2. Change the owner of the project to your Organization. - - ![Project files over view in QFieldCloud](../../assets/images/converting-project-to-organization-01.png) - -3. Click on "Create" to start the conversion and synchronization. When finish you will see the project is in your Organization in QFieldCloud. - - ![Project files over view in QFieldCloud](../../assets/images/converting-project-to-organization-02.png) - -!!! note - QField Sync 4.6 or newer is required for this functionality - -**Option 2: Uploading directly to the organization:** - -1. Select your organization. - - ![Entering into Organization](../../assets/images/project_organization_01_entering_into_organization.png) - -2. Once you get into the organization, click on "Create a project". - - ![Creating Project](../../assets/images/project_organization_02_creating_project.png) - -3. Select "Create a new empty project". - - ![New empty project](../../assets/images/project_organization_03_new_empty_project.png) - -4. You can see the new project in the overview. - - ![New project created](../../assets/images/project_organization_04_new_project_created.png) - -5. On QGIS in QFieldSync, you will see the new project listed, click on "Edit Selected Cloud Project". - - ![QFieldSync](../../assets/images/project_organization_05_qfield_sync.png) - -6. Choose the folder where you want to save the project. - - ![Selecting folder](../../assets/images/project_organization_06_selecting_folder.png) - -7. In the selected folder, you can either paste an already worked-on project or save a new one. - - ![Copy to project folder](../../assets/images/project_organization_07_copy_project_to_folder.png) - -8. Once the folder contains the project, you can synchronize it. - - ![QFieldSync Overview](../../assets/images/project_organization_08_qfield_sync_overview.png) - -9. Finally, push the changes to the cloud. - - ![Pushing changes to QFieldCloud](../../assets/images/project_organization_09_pushing_changes_to_cloud.png) - -10. You can verify that the files are present in the Organization project. - - ![Project files over view in QFieldCloud](../../assets/images/project_organization_10_files_overview_in_cloud.png) - -**Option 3: Moving the project from your own account to the Organizations:** - -1. If you already have a project in QFieldCloud (refer to [configure your cloud project](#create-and-configure-your-cloud-project)). In the project, click on "Settings" and select "Transfer ownership of this project" to choose the desired Organization for the transfer. - - ![Transferring to Organization](../../assets/images/project_organization_11_transfering_to_organization.png) - -2. A pop-up window will appear to confirm the transfer. To proceed, you will need to type "Here be dragons" and click "Transfer project". - - ![Confirm transfer](../../assets/images/project_organization_12_confirming_transfer.png) - ### Configure your project layers for QField Configure the project layers by clicking the fifth icon in the QFieldSync toolbar ![](../../assets/images/project_properties.svg){Width="20px"}. Here you can configure QFieldCloud layer actions. Most of the time you need to configure a preference either to online or offline layers. For more fine grained control, in the advanced settings you can configure the action layer by layer. Get more information about how to configure your layers in the [Get Started guide for QFieldSync](./get-started-qfs.md)!. @@ -264,29 +118,6 @@ Any QField supported raster and vector layer formats may be used as read-only da !![Project properties](../../assets/images/getting_started_project_properties.png) -### Enabling Automatic Pushing of Changes to QFieldCloud - -With this functionality, users and managers of QFieldCloud projects can enforce automatic pushing of pending changes to QField devices in the field, as well as specify the interval in between automated pushes. The functionality is activated through a project setting, allowing remote activation. - -1. **Access Project Settings**: Navigate to the QField panel in the Project Settings dialog provided by the QFieldSync plugin. - -2. **Enable Auto-Push**: Toggle the "Automatically push pending changes on the following interval" option and establish your preferred interval. - -!![Auto push QFieldSync](../../assets/images/auto-push-pending-changes-qfieldsync.png) - -!![Auto push QField](../../assets/images/auto-push-pending-changes-qfield.png,400px) - -!!! Note - #### Benefits: - - - **Real-Time Updates**: Ensures prompt synchronization of field data with the QFieldCloud project. - - **Streamlined Workflow**: Minimizes manual intervention and ensures surveyors do not need to worry about synchronization, helping them focus on data quality. - - #### Considerations: - - - **Network Stability**: Ensure stable internet connectivity for auto-push functionality. - - **Battery Optimization**: Implement strategies to mitigate battery consumption on QField devices during prolonged fieldwork. - ### Upload a project Once configured, you can press the cloud button to open the synchronization dialog. Here you have to decide what do you prefer: the local file or the file on the cloud. @@ -295,72 +126,13 @@ Once configured, you can press the cloud button to open the synchronization dial Now you should see your project and files on [QFieldCloud](https://app.qfield.cloud/) -### Activate Notifications for QFieldCloud changes - -1. Access the Settings of your account. -2. Navigate to the Notifications section. Here, you can customize the frequency of notifications you wish to receive at the email address registered with your account.![Synchronize](../../assets/images/frequency_notifications_settings.png) - - The events you get notified about are: - - User created - - Organization created - - Organization deleted - - Organization membership created - - Organization membership deleted - - Team created - - Team deleted - - Team membership created - - Team membership deleted - - Project created - - Project deleted - - Project membership created - - Project membership deleted - -You will receive notifications for events in which you are not the actor. These notifications are specifically for events that are initiated by other members of your organization or collaborators on your projects. - -## Enhance your project with the "Optimized Packager" - -We recommend to use the new "Optimized Packager" over the deprecated "QGIS Core Offline Editing" for all your projects. Set the packager under "Packaging Offliner" in the "Settings" tab of your project. - -The "Optimized Packager" supports consolidating filtered layers of same datasource into a single offline layer, respecting distinct symbology but also using less storage. Here is an example to illustrate this feature: - -### Example Configuration: - -- **Layer 1.1:** - - Data Source: `layers.gpkg` - - Table: `layer1` - - Filter: `id % 2 = 1` - -- **Layer 1.2:** - - Data Source: `layers.gpkg` - - Table: `layer1` - - Filter: `id % 2 = 0` - -### Result: - -For the new offliner: -- A single layer is generated in the offline geopackage, combining data from `layer1` with the specified filters. - -For the old (QGIS) offliner: -- Two separate layers are created, each representing the filtered datasets: - - Layer 1: Filtered with `id % 2 = 1` - - Layer 2: Filtered with `id % 2 = 0` - -!![](../../assets/images/qfc_offline_packager.png,700px) - -!!! note - This configuration must be set in the Settings page of each project in [QFieldCloud](https://app.qfield.cloud/). - ## Field device :material-tablet: Fieldwork ### Install QField -Download and install the latest version of [QField from the play store](https://play.google.com/store/apps/details?id=ch.opengis.qfield_dev). Scroll to the bottom and enable beta testing. -Do not use this version in production! - -!!! note - Since QField 2.0 is still in beta phase, there are regular updates and fixes at least on a weekly basis. Please upgrade your experimental QField at least once a week. In case of an issue, please try to reproduce on the latest release before reporting. +Download and install the latest version of QField from Google's play store, Apple's app store, or by [downloading the lastest release for Windows, Linux, or macos](https://github.com/opengisch/QField/releases). ### Start working on your project