-
Notifications
You must be signed in to change notification settings - Fork 12
Add customer workspaces page #295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cezudas
wants to merge
9
commits into
main
Choose a base branch
from
cezudas/OPS-3418
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4613812
Add customer workspaces page
cezudas e89c296
Reorganize sections and add more screenshots
cezudas 418b5db
Mention new file in styleguide-docs as it appears to be manually main…
cezudas a6ea176
Address PR findings
cezudas 767c4f1
Remove screenshots
cezudas e2e2186
Fix prefix
cezudas 40e4f4e
Use canonical name for this feature
cezudas 9e0f42f
Be more explicit about which features are disabled
cezudas d0a4dd5
Remove Workspace User Management via REST API request samples
cezudas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| title: 'Customer Workspaces' | ||
| description: 'Organize and manage work in separate, isolated environments' | ||
| icon: 'folders' | ||
| --- | ||
|
|
||
| import { NarrowImage } from '/snippets/narrow-image.jsx' | ||
|
|
||
| <Info>**Customer workspaces** is an Enterprise edition feature. See [pricing](https://www.openops.com/pricing/) for details.</Info> | ||
|
|
||
| Customer workspaces allow you to organize work in separate, isolated environments. Each workspace contains its own workflows, connections, and tables. This enables organizations to separate different projects, clients, or departments while maintaining clear boundaries between them. | ||
|
|
||
|  | ||
|
|
||
| In larger organizations, workspaces help teams organize their work by business unit, environment (dev/staging/production), or client. Central teams can create workspaces for different departments, each with its own workflows and data. | ||
|
|
||
| For managed service providers (MSPs), customer workspaces are essential for maintaining strict separation between client data and workflows, ensuring each client's work remains isolated and secure. | ||
|
|
||
| ## Accessing Workspaces | ||
|
|
||
| Every user automatically gets a default workspace. You can access workspaces through the **workspace switcher** in the top navigation bar. | ||
|
|
||
|  | ||
|
|
||
| You can also navigate to the **Workspaces Management** page to view all workspaces in a table, create new ones, and manage existing workspaces. | ||
|
|
||
| ## Creating a New Workspace | ||
|
|
||
| To create a new workspace: | ||
|
|
||
| 1. Navigate to the **Workspaces Management** page | ||
| 2. Click the **"Add new"** button | ||
| 3. Enter a unique workspace name (at least 1 character) | ||
| 4. Click **"Confirm"** | ||
|
|
||
|
|
||
|  | ||
|
|
||
| You will automatically become the owner and be switched to the new workspace. The system creates a dedicated database and authentication tokens for the workspace. | ||
|
|
||
| ## Switching Between Workspaces | ||
|
|
||
| You can switch workspaces by: | ||
|
|
||
| - Clicking the workspace name in the top navigation bar and selecting a workspace from the dropdown | ||
| - Clicking the **"Switch"** button next to a workspace in the Workspaces Management page | ||
|
|
||
| The current workspace is marked with a checkmark (✓). The application reloads when switching workspaces to ensure all data and resources are properly loaded for the selected workspace. | ||
|
|
||
| ## Managing Workspaces | ||
|
|
||
| ### Workspace Information | ||
|
|
||
| The Workspaces Management page displays for each workspace: | ||
|
|
||
| - Workspace name | ||
| - Number of active workflows | ||
| - Ownership status (only owners see the action menu) | ||
|
|
||
| ### Renaming a Workspace | ||
|
|
||
| Only workspace owners can rename workspaces: | ||
|
|
||
| 1. In the Workspaces Management page, click the three-dot menu (⋯) on the workspace row | ||
| 2. Select **"Rename"** | ||
| 3. Enter a new unique name | ||
| 4. Click **"Update"** | ||
|
|
||
|  | ||
|
|
||
| ### Default Workspace | ||
|
|
||
| Every user has a default workspace (initially named "[Your Name]'s Workspace") that is automatically created. Default workspaces appear first in lists and are marked with a users icon in the workspace switcher. | ||
|
|
||
| ## Workspace Ownership and Members | ||
|
|
||
| ### Ownership | ||
|
|
||
| The user who creates a workspace becomes its owner. Owners can rename the workspace and manage members. | ||
|
|
||
| ### Member Management | ||
|
|
||
| Workspace members can switch to and work within any workspace they have access to. You can manage members and switch workspaces programmatically using the REST API. | ||
|
|
||
| ### Roles | ||
|
|
||
| Workspaces support the following roles: **ADMIN**, **EDITOR**, **OPERATOR**, and **VIEWER**. Role-based permission enforcement is currently being implemented; the primary authorization check is ownership-based. | ||
cezudas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Master Project Workspace | ||
|
|
||
| Each organization has one designated **Master Project** workspace that provides access to special organization-wide features. You must switch to the master project workspace to access these features. | ||
|
|
||
| New users are not assigned to the master project by default. They must be granted access and switch to it manually. | ||
|
|
||
| #### Analytics Access | ||
|
|
||
| **OpenOps Analytics** is only accessible when switched to the master project workspace. All users who have access to the master project can view analytics, regardless of their role. | ||
|
|
||
| #### Organization Template Catalog Management | ||
|
|
||
| Only organization **admins** in the master project workspace can create, edit, delete, and publish private templates to the organization catalog (requires private template editor feature to be enabled). | ||
|
|
||
| ## Searching Workspaces | ||
|
|
||
| Use the search bar in the workspace switcher or the Workspaces Management page to filter workspaces by name. Search is case-insensitive and matches partial names. | ||
|
|
||
|  | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.