Database Configuration

GlobalForms stores its own data in MongoDB. It can also connect to SQL databases so forms can read from and write to your business systems. This page covers both connections.

Which database is used for what

All of these settings go in config\local.json. Restart the GlobalForms service after any change. See Configuration Files.

MongoDB

GlobalForms normally uses the MongoDB server that GlobalCapture installs, with its own database on that server. A standalone MongoDB server is only for upgrades where GlobalCapture can't be updated yet; see System Requirements.

Setup writes the MongoDB connection to local.json from the values you enter during installation. To change it later, for example after moving MongoDB to another server, edit the mongo setting.

{
  "mongo": "mongodb://db-server:27017/GlobalForms"
}

The value is a standard MongoDB connection string:

mongodb://[username:password@]host[:port]/database[?options]

• authSource is the database that holds the MongoDB user, usually admin.

• If the password contains special characters such as @, : or /, URL-encode them (for example @ becomes %40).

• Use a dedicated MongoDB user for GlobalForms with access only to its database.

Standalone MongoDB: create a database user

If you run GlobalForms on a standalone MongoDB server that you manage, turn on MongoDB authentication and create a user that can read and write only the GlobalForms database. Connect with mongosh as a MongoDB administrator and run:

use admin
db.createUser({
  user: "svc_globalforms",
  pwd: passwordPrompt(),
  roles: [ { role: "readWrite", db: "GlobalForms" } ]
})

Enter the password when prompted. Then use this user and password during GlobalForms setup, with authSource set to admin. If your GlobalForms database has a different name, use that name in db.

SQL connections for SQL Query actions

The SQL Query form action runs a SQL statement when a form is submitted, for example to save data or generate an ID. It uses the connections in settings.databases, one per database type: mssql, mysql or postgresql.

{
  "settings": {
    "databases": {
      "mssql": {
        "host": "sql-server",
        "port": "1433",
        "database": "FormsData",
        "user": "svc_globalforms",
        "password": "<password>"
      },
      "postgresql": {
        "host": "pg-server",
        "port": "5432",
        "database": "forms_data",
        "user": "svc_globalforms",
        "password": "<password>"
      }
    }
  }
}

All five settings are required for a database type to appear in the SQL Query action. For SQL Server, TCP/IP connections must be enabled and SQL Server authentication allowed. See SQL Query Form Actions.

SQL connections for data lookups (Resquel)

To let forms read data from SQL, for example to fill a Select list from a table, you define queries as GlobalForms routes in settings.resquel. Resquel supports SQL Server, MySQL, MariaDB and PostgreSQL. See Setting Up SQL Lookups (Resquel).

Security recommendations

• Create a dedicated database account for GlobalForms. Do not use sa, root or other administrator accounts.

• Grant only the permissions your forms need, such as read-only access for lookups.

• Use encrypted connections where your database supports them.

• Limit who can read config\local.json, because it contains database passwords.

Troubleshooting

Related pages

• Configuration Files

• Using SQL Data Sources

• SQL Query Form Actions

• Setting Up SQL Lookups (Resquel)

• System Requirements