All Products
Search
Document Center

DataWorks:Workspace directories

Last Updated:Apr 15, 2025

A workspace directory is an organizational structure that is designed for team collaboration. You can use a workspace directory to manage node code and resources on the cloud by managing on-premises files and collaborate with other users to develop objects that need to be periodically scheduled. This topic describes how to use a workspace directory.

Background information

In addition to workspace directories, Data Studio also allows you to create personal directories and manual directories to meet different development requirements. You can use these directories to efficiently develop and manage data in various business scenarios. The following table compares these types of directories. You can select a directory type for development based on your business requirements.

Directory type

Permission scope

Feature and characteristic

Use scenario

Workspace directory

Workspace level

  • Teams can collaborate with each other for development based on workspace directories.

  • You can create objects that need to be periodically scheduled, such as nodes and workflows, in a workspace directory.

  • Nodes in a workspace directory belong to the workspace in which the directory is created.

You want to create objects that need to be periodically scheduled in the production environment.

Personal directory

Account level

  • You can debug code in a personal directory.

  • You cannot create objects that need to be periodically scheduled in a personal directory.

  • Files in a personal directory are visible only to the user who creates the personal directory.

You want to develop and debug code.

Manual directory

Workspace level

  • You can create objects that need to be manually triggered, such as nodes or workflows, in a manual directory.

  • You cannot create objects that need to be periodically scheduled in a manual directory.

You want to create temporary tasks or one-time tasks that need to be manually triggered.

Go to the Workspace Directories section

  1. Go to the Workspaces page in the DataWorks console. In the top navigation bar, select a desired region. Find the desired workspace and choose Shortcuts > Data Studio in the Actions column.

  2. In the left-side navigation pane of the Data Studio page, click the image icon. The Workspace Directories section appears.

Create a workspace directory

You can design a workspace directory based on the specifications of your workspace and create a workspace directory in the Workspace Directories section by performing the following steps:

  1. In the Workspace Directories section, click the image icon and select Create Directory.

  2. In the Create Directory dialog box, configure the parameters described in the following table.

Parameter

Description

Path

Select a path in which you want to store the workspace directory.

Name

Specify a name for the workspace directory.

Create an object that needs to be periodically scheduled

In the created workspace directory, you can create a node or workflow that needs to be periodically scheduled. For information about how to create a node or workflow, see Node development or Workflow orchestration.

  1. Create a node or workflow that needs to be periodically scheduled.

    In the Workspace Directories section, click the image icon, select Create Node, and then select a desired node type. Alternatively, click the image icon and select Create Workflow.

  2. Configure the node or workflow.

    The parameters you must configure vary based on the object that you create. For more information, see Node development or Workflow orchestration.

Manage markers for a workspace directory

DataWorks allows you to use markers to categorize workspace directories. You can quickly filter all workspace directories by marker to obtain specific workspace directories. This helps improve management efficiency.

For example, you can mark a workspace directory as Workflow. You can also filter all workspace directories by the marker to obtain all workspace directories that are marked as Workflow.

  1. Mark a workspace directory.

    In the Workspace Directories section, find the workspace directory that you want to mark, right-click the directory name, and then choose Mark As > Workflow to mark the workspace directory as Workflow.

    In addition, you can mark the workspace directory as Data Integration, MaxCompute, Hologres, Flink, Algorithm, General, or Custom.

  2. Unmark the workspace directory.

    In the Workspace Directories section, find the workspace directory that is marked, right-click the directory name, and then select Untag.

  3. Filter workspace directories by marker.

    If you want to obtain workspace directories that have a specific type of marker, click the image icon next to Workspace Directories. In the popover that appears, select the desired marker type and click OK to perform filtering.

Use the focus mode

The focus mode is a visual noise-reduction mechanism that is provided for workspace directories. You can use the focus mode to enable the system to fixedly display specific workspace directories and hide the remaining workspace directories. This helps you focus on the required workspace directories, and reduce visual disturbance and cognitive load that is generated when multiple tasks are run in parallel. You can refer to the following instructions to enter or exit the focus mode.

  1. Enter the focus mode.

    In the Workspace Directories section, find the workspace directory for which you want to use the focus mode, right-click the directory name, and then select Enter Focus Mode. Then, only the workspace directory is displayed in the Workspace Directories section.

  2. Exit the focus mode.

    In the Workspace Directories section, click the image icon to exit the focus mode. Alternatively, find the desired workspace directory, right-click the directory name, and then select Exit Focus Mode.

Locate a node or workflow

The Workspace Directories section provides multiple types of location features that you can use to quickly locate the desired node or workflow. These location features improve the search efficiency and help you efficiently perform data management and development operations.

  1. Display all nodes or workflows or only nodes or workflows that are managed by me.

    Click the image icon next to Workspace Directories and select Show All or Show Managed by Me.

  2. Locate the node that is opened.

    Click the image icon next to Workspace Directories to locate the node that is opened.

  3. Search for a node.

    Click the image icon next to Workspace Directories. In the popover that appears, enter a node name or ID to search for the desired node.

  4. Search for a node by using a code snippet.

    Click the image icon next to Workspace Directories. In the search box of the Search Code tab, enter a code snippet to search for the node whose code contains the code snippet. For more information, see Code search.

Appendix: Icons in the Workspace Directories section

Icon

Feature description

image

Performs a specific operation on multiple nodes at a time. For example, you can deploy or undeploy multiple nodes at a time, or adjust scheduling information for multiple nodes at a time.

image

Exits the focus mode.

image

Searches for a node by node name or ID.

image

Searches for a node whose code contains a specific code snippet.

image

Displays all nodes or workflows, or displays only nodes or workflows that are managed by me.

image

Filters all workspace directories to obtain the workspace directories that have a specific marker.

image

Refreshes the list of workspace directories.

image

Collapses all workspace directories.

image

Creates workspace directories, workflows, notebooks, and various nodes such as MaxCompute SQL. For more information, see Create an auto triggered node.

Note

Node names are not case-sensitive.