diff --git a/.doc.holiday/styleguide-docs.md b/.doc.holiday/styleguide-docs.md index c52bc28..21fea88 100644 --- a/.doc.holiday/styleguide-docs.md +++ b/.doc.holiday/styleguide-docs.md @@ -287,7 +287,7 @@ introduction/ paid/ - Documentation of features available only in paid plans. -- Files: organization-template-catalog.mdx +- Files: organization-template-catalog.mdx, customer-workspaces.mdx reporting-analytics/ - Documentation of analytics and reporting features, as well as ways to import OpenOps content into external BI tools. diff --git a/docs.json b/docs.json index c511e72..0b7a705 100644 --- a/docs.json +++ b/docs.json @@ -81,7 +81,8 @@ { "group": "Paid Features", "pages": [ - "paid/organization-template-catalog" + "paid/organization-template-catalog", + "paid/customer-workspaces" ] }, { diff --git a/images/paid/master-project-selected.png b/images/paid/master-project-selected.png new file mode 100644 index 0000000..37b47da Binary files /dev/null and b/images/paid/master-project-selected.png differ diff --git a/images/paid/master-project-selection-preview.png b/images/paid/master-project-selection-preview.png new file mode 100644 index 0000000..0a1b97b Binary files /dev/null and b/images/paid/master-project-selection-preview.png differ diff --git a/images/paid/new-workspace.png b/images/paid/new-workspace.png new file mode 100644 index 0000000..c33cfac Binary files /dev/null and b/images/paid/new-workspace.png differ diff --git a/images/paid/personal-workspace-selected.png b/images/paid/personal-workspace-selected.png new file mode 100644 index 0000000..55bcb05 Binary files /dev/null and b/images/paid/personal-workspace-selected.png differ diff --git a/images/paid/workspace-management-page.png b/images/paid/workspace-management-page.png new file mode 100644 index 0000000..dbb8020 Binary files /dev/null and b/images/paid/workspace-management-page.png differ diff --git a/images/paid/workspace-management-rename.png b/images/paid/workspace-management-rename.png new file mode 100644 index 0000000..beda0fa Binary files /dev/null and b/images/paid/workspace-management-rename.png differ diff --git a/images/paid/workspace-switcher-search.png b/images/paid/workspace-switcher-search.png new file mode 100644 index 0000000..251b9ad Binary files /dev/null and b/images/paid/workspace-switcher-search.png differ diff --git a/images/paid/workspace-switcher.png b/images/paid/workspace-switcher.png new file mode 100644 index 0000000..7dcdab7 Binary files /dev/null and b/images/paid/workspace-switcher.png differ diff --git a/paid/customer-workspaces.mdx b/paid/customer-workspaces.mdx new file mode 100644 index 0000000..3fb843a --- /dev/null +++ b/paid/customer-workspaces.mdx @@ -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' + +**Customer workspaces** is an Enterprise edition feature. See [pricing](https://www.openops.com/pricing/) for details. + +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. + +![Workspace Management Page](/images/paid/workspace-management-page.png) + +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. + +![Workspace Switcher](/images/paid/workspace-switcher.png) + +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"** + + +![Workspace Switcher](/images/paid/new-workspace.png) + +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"** + +![Renaming workspace ](/images/paid/workspace-management-rename.png) + +### 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. + +### 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. + +![Searching in Workspace Switcher](/images/paid/workspace-switcher-search.png) \ No newline at end of file diff --git a/paid/organization-template-catalog.mdx b/paid/organization-template-catalog.mdx index 12d8789..fa023d6 100644 --- a/paid/organization-template-catalog.mdx +++ b/paid/organization-template-catalog.mdx @@ -6,9 +6,9 @@ icon: 'grid' import { NarrowImage } from '/snippets/narrow-image.jsx' -Most OpenOps features are available in the Community edition, but some are exclusive to the [paid editions](https://www.openops.com/pricing/). - -One such feature, available only in the Enterprise edition, is the **organization template catalog**. + + **Organization template catalog** is an Enterprise edition feature. See [pricing](https://www.openops.com/pricing/) for details. + Community and Professional editions include a [template catalog](/workflow-management/workflow-templates/) curated by the OpenOps team. The Enterprise edition lets you publish your own templates in a private section of the template catalog called **My Organization Templates**.