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 in Workflow Designer.
Your Workflow Designer must have at least one workspace. The out-of-the-box workspace name is Generated default.
Workspaces offer several functionalities 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.
- Filter by name: Enter part or all of a workspace name to narrow down the list of workspaces.
- View options: Click
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
- In the navigation bar, select Workspaces.
- On the Workspaces page, click
Create.
- In the Create a new workspace dialog box, enter the required information:
Field Description Name The name for your workspace. This name helps you identify the workspace and its purpose. Key The 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. Description Optionally, a description of the workspace. You can use the formatting options for bold, italics, or monospace. - 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, 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 next to it.
- From an individual workspace page, click
Actions next to the name of the workspace in the navigation menu.
Edit workspace details
- From the actions menu, click Edit workspace.
- 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 for the workspace.
- Description: Update the descriptive text for the workspace.
- Click Ok 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
- From the actions menu, select Remove workspace.
- 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.