Workspaces

Workspaces in Workflow Designer are essential for organizing your workflow models, particularly for large projects or managing multiple distinct workstreams.

Workspaces provide a dedicated area to group and manage your workflow models. This structure allows you to create workspaces tailored to your specific needs, helping to keep different projects or development efforts clearly separated and organized.

Your Workflow Designer must have at least one workspace. The out-of-the-box workspace name is Generated default.

Workspaces offer several features to enhance how you manage your workflow development:

  • Improved project organization: You can create distinct workspaces for different projects or initiatives. This helps maintain a clear and focused modeling environment while providing flexibility through the ability to move apps or copy app versions between workspaces.
  • Tailored environments: The ability to create workspaces as needed means you can set up an organizational structure that best fits your development processes.
  • Default workspace: You can designate one workspace as the default. This can streamline your access to your most frequently used or primary set of workflow apps and models.
  • Efficient navigation: The Workspaces page allows you to filter and sort your workspaces. This makes it easier to quickly find and navigate to the specific workspace you need, especially as the number of your projects grows.

By using these workspace features, you can maintain a more organized and efficient workflow development process.

Find and view workspaces

As you create more workspaces, the Workspaces page provides several options to help you efficiently locate and view them.

  • Search: Use the search to find workspaces or jump to recently visited models.
  • Filter by name: Enter part or all of a workspace name to narrow down the list of workspaces.
  • View options: Click Sliders icon View options to open the controls for changing how workspaces are shown:
    • View: Select List view or Grid view to change the layout.
    • Sort: Choose to sort by Name or Key, and in Ascending or Descending order.

Create a workspace

You can create new workspaces to organize your workflow models according to your project needs.

Steps

  1. In the navigation bar, select Workspaces.
  2. On the Workspaces page, click Add icon Create.
  3. In the Create a new workspace dialog box, enter the required information:
    FieldDescription
    NameThe name for your workspace. This name helps you identify the workspace and its purpose.
    KeyThe unique identifier of the workspace. By default, the Workflow Designer auto-generates the key from the workspace name. Alternatively, you can specify a custom key.
    DescriptionOptionally, a description of the workspace. You can use the formatting options for bold, italics, or monospace.
    VisibilityWhether the workspace is public or private. A public workspace is visible to all users. A private workspace is visible only to users with explicit access.
  4. Click Create.

Your new workspace is created and appears on the Workspaces page. You can now select this workspace to start adding or managing workflow apps and models in it.

Manage workspaces

After you create workspaces, you can modify their properties, visibility, set one as default, or remove those you no longer need.

To perform these actions, access the actions menu:

  • On the Workspaces page, find the workspace and click the More icon more icon next to it.
  • From an individual workspace page, click Beak down icon Actions next to the name of the workspace in the navigation menu.

Edit workspace details

  1. From the actions menu, click Edit workspace.
  2. In the Update the workspace dialog box, update any of the following:
    • Name: Change the display name of the workspace.
    • Key: Modify the unique key of the workspace.
    • Description: Update the descriptive text of the workspace.
  3. Click Ok to apply your changes.

Change workspace visibility

  1. From the actions menu, click Change visibility.
  2. In the Change visibility dialog box, select one of the following:
    • Public: The workspace is visible to all users.
    • Private: The workspace is visible only to you and users with explicit access.
  3. Click Save to apply your changes.

Change workspace permissions

A private workspace is visible only to you. You can manage access to your workspace and define user roles through workspace permissions:

  1. From the actions menu, click Change permissions.
  2. In the Change workspace permissions dialog box, configure the following options:
    • Users: Select who has access to the workspace.
    • Type: Select the role to assign to each user:
      • Owner: Has full access to the workspace and the apps and models it contains, including the ability to edit, change visibility, or remove the workspace.
      • Modeler: Can create and edit apps and models.
      • Reader: Can view the workspace and the apps and models it contains.
  3. Click Save to apply your changes.

Set a default workspace

From the actions menu of the desired workspace, select Set as default.

The selected workspace is now your default workspace.

Remove a workspace

If you no longer need a workspace and the items it contains, you can remove it.

Removing a workspace is a permanent action that also deletes all workflow apps and models from that workspace. Ensure you no longer need the workspace, apps, and models before proceeding.

Steps

  1. From the actions menu, select Remove workspace.
  2. In the Delete the workspace dialog box, click Delete the workspace to confirm that you want to remove the workspace.

The workspace and the associated workflow apps and models are deleted.