Skip to content

Windows Installation

Last updated: 12 Dec 2023

Document Overview


Running the Installer

The installer is mostly non-interactive; all default installation choices can be kept initially if desired, and moving through the installer mostly consists of hitting the “Next” on each installer screen. The complete installation process is as follows:

  1. Accept the DataWORQ license agreement
  2. Configure DataWORQ settings
  3. Choose “Complete” install to install all DataWORQ components
  4. Accept all the UAC prompts
    • NB: the installer may take a while to download the required files


Configuration Settings

The DataWORQ web application is configured through a list of settings configured during installation.

These settings include:

  • The installation location for DataWORQ, and all its dependencies (the default is C:\Program Files\DataWORQ)
  • The data folder location for DataWORQ, which will store users' files (.csv, .xlsx, .etc) (the default is C:\Program Files\DataWORQ)
  • The port number on which DataWORQ is exposed (the default is 9696)
  • The maximum amount of memory for DataWORQ to use (the default is 6GB)
  • The service account under which to run DataWORQ and its dependencies (the default is the Windows Local System account)


DataWORQ is also configured through a list of properties set up in configuration files in the /DataWORQ/Tomcat/conf/DataWORQ/ folder.

These settings include:

  • The authentication mode that DataWORQ is set to use (the default is basic username/password auth)
  • Additional directories to use for source files
  • The ability to enable/disable the following, all of which can be used directly inside of DataWORQ:
    • R
    • Python
    • GLPK
    • Command Line support

After any updates are made the Apache Tomcat service that DataWORQ uses must be restarted.


Additional Configuration

Directory Mappings

DataWORQ provides access to files on the host machine via directory mappings. This ensures that file management can be securely managed and isolated. These mappings contain the drive locations of the directories you would like DataWORQ to use when storing files. The mapping also contains the name of the folder as it appears to users in the application. The example below shows mappings for two physical locations. The first location is C:/temp and will map to / in the application UI. The second location is C:/temp/example and will map to /Example in the applicaiton UI.

{
  "rootMapping": {
    "sourceLocation": "C:/temp"
  },
  "mappings": [
    {
      "sourceLocation": "C:/temp/example",
      "virtualLocation": "Example"
    }
  ]
}

Setting the mappings

  1. Edit /DataWORQ/Tomcat/conf/DataWORQ/directoryMappings.cfg

  2. Update the sourceLocation value (there is only one root directory mapping allowed)

  3. Update the mappings entries (multiple entries can be defined e.g.)

"mappings": [
    {
      "sourceLocation": "C:/temp/example",
      "virtualLocation": "Example"
    },
    {
      "sourceLocation": "C:/temp/alt",
      "virtualLocation": "Alt"
    }
  ]


Authentication

Authentication can be configured by updating the .properties file at /DataWORQ/Tomcat/conf/DataWORQ/dataworq.properties

The following security modes are supported:

  • BASIC - Basic username/password authentication
  • AD - Microsoft Active Directory
  • LDAP - Vendor-neutral directory service
  • OIDC - Open ID Connect
  • AZURE_OIDC - Open ID Connect via Azure AD
  • SAML - SAML2.0-based authentication


In order to enable a security mode, update the following property in dataworq.properties

  • security.auth-mode

These security modes each have a unique set of configuration properties necessary to set up the relevant authentication mode. They are all commented out by default and need to be uncommented to use the respective mode. Each group of settings are modeled after industry standards.

For example, spring.cloud.azure.active-directory.profile.tenant-id represents the tentant ID of the Azure AD instance,

For any specifics, please reach out to QueBIT's help desk at support@quebit.com.


User Setup

The first user to log in will automatically be set to the ADMIN role. This user will be able to add/enable other users to DataWORQ.

When a new user attempts to log in, the will be added to DataWORQ in a disabled state. An Admin must then enable those users in the Manage Interactive Users screen.


Using DataWORQ

Navigate to http://localhost:9696/DataWORQ to access DataWORQ via a browser

NB: This URL is case-sensitive

When logging in the first time, whatever username/password are entered become the default admin account (for basic authentication)