QFieldCloud Django administration

QFieldCloud Django administration

The original version of this document is located at https://docs.qfield.org/reference/qfieldcloud/self_hosted/django_interface

How to manage Organizations in QFieldCloud on-premise

Managing Users

Adding

Workflow

  1. From the homepage, scroll down to find the “Core” pages and select the “People” page.

  2. Click on “Add Person”.

  3. Fill in the required fields, including the “Username”, “Password”, “Email address”, and any additional user information.

Tip

You can also set the user’s “Timezone” and email notification preferences for project and organization changes.

  1. Click “Save” to add the user, and you’ll be redirected to the “People” page with a success message.

Tip

The “Password” field will show the hashed version of any password.
If a system administrator wants to change it, just replace the contents with the new password, QFieldCloud will handle it automatically.

Deleting

Workflow

  1. In the “Core” pages, click on “People”.
  2. Select the user by clicking on its “Username”.

  3. Click the “Delete” button.

  4. The screen will show you all the related objects that will be deleted.
    Once you are sure that you wish to complete the deletion click “Yes, I’m sure”.

  5. You will be redirected to the “People” Section and a message should appear at the top of the page indicating the successful deletion.

Generating a Reset Password URL

Workflow

  1. Access the “People” Page under the “Core” pages section.
  2. Click on the “Username” of the user for whom you want to generate a new password URL.

  3. On the user’s page to find the “Generate reset password URL” option.

  4. The manager should send the URL to the user via email for password reset.

Managing Organizations

Adding

Worflow

  1. Click on “Organizations” under the “Core” section.

  2. Click “Add Organization”.

  3. Fill in the organization details, including “Username” for the organization name, “Email address” for the admin, and select the owner from the dropdown list.

  4. Click “Save” to create the organization, and a success message should be shown at the top of the browser.

Deleting

Workflow

  1. Click on “Organizations” under the “Core” section.

  2. Click on the organization’s name.

  3. Find the “Delete” button.

  4. The screen will show you all the related objects that will be deleted.
    Once you are sure that you wish to complete the deletion click “Yes, I’m sure”.

5.You will be redirected to the “Organization” Section and a message should appear at the top of the page indicating the successful deletion.

Adding Members

Workflow

  1. Go to the “Organizations” page and select the organization where you want to add a new member.

  2. Open the “Organization members” tab and click on “Add another Organization member”.

  3. In the search bar, type the username of the user you want to add.

  4. After finding the user, click on the name and add them to the “Organization Members” list.

  5. Once all desired members are added, click on “Save”.

  6. You will be redirected to the “Team” Section and a message should appear at the top of the page indicating the successful addition of members.

Remove Members

Worfklow

  1. Go to the “Organizations” page and select the organization where you want to remove one or multiple members.
  2. Open the “Organization members” tab.

  3. Check the “Delete?” checkbox for the user you want to remove.

  4. Click “Save”.

  5. You will be redirected to the “Organization Member” Section and a message should appear at the top of the page indicating the successful removal of the selected members.

Changing Roles of Members

Workflow

  1. Find the organization where you wish to change the role of the member.
  2. Open the “Organization members” tab.

  3. In the “Role” field of the user, click the dropdown and choose “Member” or “Admin”.

  4. Select the role you want to assign to the user and click to “Save” the updated data for the “Organization”.

  5. You will be redirected to the “Team” Section and a message should appear at the top of the page indicating the successful role change of the selected members.

Creating Teams

Workflow

  1. Access the “Teams” pages under the “Core” section.

  2. Click on “Add Team”.

  3. Provide a name for the team in the “Username” field and select the organization where the team should belong.

  4. In the “Team members” section, click on “Add another Team member”.

  5. Search for the team members you wish to add.
    The people added to the Team must be members of the Team’s Organization.

  6. Once all members are added, click “Save”.

  7. You will be redirected to the “Teams” section and a message should appear at the top of the page indicating the successful addition of the selected members to the team.

Deleting Teams

Worfklow

  1. Access the “Teams” page under the “Core” section
  2. Find the team which you wish to delete.

  3. Select the “Delete Button”.

  4. The screen will show you all the related objects that will be deleted.
    Once you are sure that you wish to complete the deletion click “Yes, I’m sure”.

  5. You will be redirected to the “Teams” section and a message should appear at the top of the page indicating the successful deletion of the selected members.

Removing Members from the Team

Workflow

  1. Enter the team where you want to delete users.

  2. In the team, activate the “Delete?” checkbox for the users you want to remove.

  3. Click to “Save” the updated data for the “Team”.

  4. You will be redirected to the “Teams” section and a message should appear at the top of the page indicating the successful removal of the selected members.

Managing Projects

Creating Projects

There are two ways in which you can create projects, follow either Method 1 or Method 2.

Method 1: Convert a Local Project to a QFieldCloud Project

Workflow

  1. In QGIS, access your project and open the QFieldSync plugin.
  2. Click on “QFieldCloud Projects Overview”.
  3. Click “Create New Project”.

  4. Choose the first option “Convert the currently open project to a cloud project”.

  5. Provide project details and select the organization.

  6. Click “Create”.

  7. Once completed, click “Ok”.

  8. The project will be listed in the “QFieldCloud Projects Overview”.
  9. In the Admin view, navigate to the “Projects” and inspect the project’s information.

Method 2: Creating an Empty Project

You can create Empty projects by using QFieldSync or directly in QFieldCloud.

2.1. Creating an empty project QFieldCloud method

Workflow

  1. Go to the “Projects” Section and click on “Add Project”.

  2. Fill in the project details and select an organization as the owner.

  3. Click to “Save” the updated data for the project.

  4. In QGIS use QFieldSync to access the “QFieldCloud Projects Overview”.

  5. Select the newly created project and synchronize it.

  6. Choose the path for storing the project files and complete the synchronization.

  7. Click “Ok”.

  8. Edit the project in an external file browser.
  9. Paste the necessary project files into the folder.

  10. Return to QFieldSync and complete the synchronization.

  11. Once finished, inspect the files in the project.

2.2. Creating an empty project QFieldSync Method

Workflow

  1. In QGIS and the QFieldSync plugin, go to the “QFieldCloud Projects Overview.”

  2. Click the “Create New Project” button.

  3. Select “Create a new empty QFieldCloud project” and click “Next”.

  4. Fill in the project name and select the organization as the project owner.

  5. For the “Local Directory,” you can select an existing project or an empty folder, then click the “Create” button.

  6. If you choose an empty folder, copy the project files into it.
  7. Go back to QFieldSync and finish the synchronization.

Deleting Projects

Workflow

  1. Enter to the “Projects” Section in QFieldCloud Admin.

  2. Select the project you want to delete and click “Delete”.

  3. The screen will show you all the related objects that will be deleted.
    Once you are sure that you wish to complete the deletion click “Yes, I’m sure”

Adding Project Collaborators

Workflow

  1. Enter the project and access the “Project collaborators” section, click “Add another Project collaborator”.
  2. Search for the user or team you wish to add.

  3. Assign the corresponding permissions roles to the different users.

  4. Click “Save”.

  5. You will be redirected to the “Collaborator” section and a message should appear at the top of the page indicating the successful addition of the selected prject collaborators

Changing Roles of Collaborators

Workflow

  1. Enter the project and access the “Project collaborators” section.

  2. Change the roles of collaborators by selecting the desired role from the dropdown.

  3. Click “Save”.

  4. You will be redirected to the “Project” section and a message should appear at the top of the page indicating the successful Role change of the selected members

Making and Reviewing Changes

Workflow

  1. Enter to “Deltas” section in the “Core” pages.

  2. Click on the delta you want to inspect.
    You will see the content in JSON format, showing the corresponding changes.

  3. In QGIS and the QFieldSync plugin, synchronize the current cloud project changes.

  4. Once the synchronization is complete, check the changes downloaded from QFieldCloud in the “Attribute table” of the layers and attachments folders.

Managing PostGIS secrets

Workflow

  1. In “Projects”, select the project.

  2. Open the “Secrets” tab.

  3. Click on “Add Secret”.

  4. Fill in the “Name” of the secret (this should be in all uppercase). In the “Type” field, choose “pg_service” from the dropdown list.

  5. Fill the “Value” field with the credentials of the pg_service connection established on the layers.

  6. Click to “Save” the updated data for the project.

  7. You will be redirected to the “Secrets” page with a success message.

    • Related Articles

    • QFieldCloud Self-Hosting

      The original version of this document is located at https://docs.qfield.org/reference/qfieldcloud/self_hosted/index QFieldCloud Self-Hosting Note Most of this documentation site describes QFieldCloud as offered at app.qfield.cloud. That hosted ...

    • Get started with QFieldCloud

      The original version of this document is located at https://docs.qfield.org/get-started/tutorials/get-started-qfc Get started with QFieldCloud What is QFieldCloud QFieldCloud is the cloud service that allows smoothless synchronisation of your data ...

    • Project creation in QFieldCloud

      The original version of this document is located at https://docs.qfield.org/get-started/tutorials/create-project-qfc Creating Projects in QFieldCloud There are multiple options available to initialize and build a project in QFieldCloud: Using QGIS ...

    • The official QFieldCloud SDK and CLI

      The original version of this document is located at https://docs.qfield.org/reference/qfieldcloud/sdk SDK and CLI qfieldcloud-sdk is the official client to connect to QFieldCloud API either as a Python module, or directly from the command line. Check ...

    • Get started with QField and QFieldCloud

      The original version of this document is located at https://docs.qfield.org/get-started/index Get started with QField and QFieldCloud QField What is it? QField is an open-source application that allows painless fieldwork and synchronisation with your ...