Workspaces
  • 02 Aug 2024
  • 3 Minutes to read
  • Dark
    Light

Workspaces

  • Dark
    Light

Article summary

Overview

The Workspaces feature uses partitions in the ReportWORQ Database for teams to leverage the ReportWORQ functionality but with unique content or configurations. The following is shared across all Workspaces: Authentication, Web server, Microsoft 365, Cloud API, and Distributor configuration. The following features are unique to each Workspace: Jobs, Contacts, Global Variables, Schedules, Datasource and Report Provider configurations. User accounts can be assigned to Workspaces to partition work and configuration by team or duty. A user account can be assigned to multiple Workspaces. System administrators do not need to be assigned to any Workspaces as they already have full access to all Workspaces, by default. ReportWORQ will automatically create a single "Default" Workspace during the installation.

Creating a Workspace

Workspaces are created in the Administration > Authentication screen. Create a Workspace by selecting the Workspaces button shown below. Provide a display name for the Workspace, then assign members to the Workspace. The Workspace Members list displays all configured user accounts. ReportWORQ Administrators already have access to all Workspaces, eliminating the need to add them. Optionally, you may designate a Workspace Member to be a Workspace Administrator.  A Workspace Administrator can configure Datasources (and datasource credentials) for that Workspace using their limited access to the Administration section. The ReportWORQ System Administrator will still be responsible for configuring any ReportWORQ API or Report Providers for the Workspace. These configurations can be created and maintained by logging into ReportWORQ as a ReportWORQ System Administrator, switching to the Workspace that needs to be administered, and then navigating to the Administration/Configuration screen. Workspace Administrators cannot configure Report Providers, preventing unintended access to network folders or other providers using System Administrative configuration.

Switching Workspaces

Switching Workspaces is performed by selecting the Workspace Selector button in the top navigation bar. If the user has access to multiple Workspaces, then this button will appear and the current Workspace will be displayed in the ReportWORQ footer. If the user only has access to a single Workspace then this button will not appear. If the user is a Workspace or ReportWORQ System Administrator then the Administration button will also appear next to the Workspace Selector. The user can only work in a single Workspace within a single browser tab at a time, so be sure that all work is saved before switching Workspaces. When the user logs into ReportWORQ, the last accessed Workspace will be displayed by default. The user can work in multiple Workspaces simultaneously by using several browser tabs or windows.

Running Jobs

ReportWORQ Jobs from all Workspaces run in the same execution queue. Depending on the system configuration, a job may have to join a queue if no slots are available for execution. Therefore the Running Jobs screen will display jobs from all workspaces, which will help inform the user if their job is waiting in a Pending state. A user is not able to expand, cancel, or view the name of a job running from another Workspace. However, the Workspace will be identified so that it is known which team(s) is/are responsible for the jobs that are currently executing. To view or cancel a running job a valid Workspace Administrator must first switch to the Workspace from where the job originated.

Workspace Migration

Jobs can now be migrated between workspaces as well as exported and imported between ReportWORQ installations. To move a job between workspaces, select the more options menu or right-click on the desired Job folder or multiple jobs by shift-clicking, select “Send to”, and then select the target workspace.

To export Jobs or folders select More options or right-click on the Job and then select Export. A zipped file will then be automatically be downloaded through the browser. To Import, right-click inside the Jobs window and select Import. Then select the desired file in its folder location and the Jobs will be imported into the target workspace or alternate ReportWORQ installation.

Additional Notes

  • The ReportWORQ Local API has a separate API Key configured for each Workspace. When using this API the Workspace will be determined based on a valid API Key. There is no need to provide Workspace information when using the Local API.

  • The ReportWORQ Cloud API is configured at a global level and contains only a single API Key. Therefore, if multiple Workspaces are configured then a Workspace name must be provided in a "workspace={value}" query string. 



Was this article helpful?

What's Next