A workspace directory is an organizational structure for team collaboration. It helps you manage node code and resources in your workspace to coordinate the development of scheduled tasks. This topic describes how to use the workspace directory.
Directory type comparison
Data Studio provides workspace directories and personal directories to help you efficiently manage and develop data for various business scenarios. The following table compares these two directory types so you can choose the one that best fits your requirements.
|
Directory type |
Permission scope |
Features |
Use cases |
|
workspace directory |
Workspace-level |
|
Create production tasks that run on a schedule. |
|
personal directory |
Account-level |
|
Develop and debug code individually. |
Navigate to workspace directory
Go to the Workspaces page in the DataWorks console. In the top navigation bar, select a desired region. Find the desired workspace and choose in the Actions column.
-
In the navigation pane on the left of Data Studio, click the
icon and choose .
Manage directories
Create a directory structure
Design and create a directory structure based on your workspace standards.
-
In the Project Directory pane, click Create Directory....
-
In the Create Directory dialog box, configure the basic information for the directory.
Parameter
Description
Path
Specify the storage path for the directory.
Name
Enter a name for the directory.
Manage directory tags
Workspace directories support the use of tags for categorization. This allows you to distinguish between different types of directories and quickly filter for specific categories of directories to improve management efficiency. For example, you can tag a directory as Workflow and then use this tag to quickly filter for all directories that are also tagged as Workflow.
-
Tag a directory
In the workspace directory, find the directory you want to tag. Right-click the directory name and select Mark As>Workflow. The directory is now tagged as Workflow. Similarly, you can tag directories as Data Integration, MaxCompute, Hologres, Flink, Algorithm, General, or Custom. This feature ensures compatibility with the directory structure from the previous Data Development version, allowing you to replicate the old structure quickly.
-
Untag a directory
In the workspace directory, find a tagged directory. Right-click the directory name and select Untag to remove its tag.
-
Filter directories by tag
To filter directories by a specific tag, click the ... > Filter Tags icon in the upper-right corner of the Project Directory pane. Select the desired tag types and click OK.
Use focus mode
Focus mode is a feature that reduces visual clutter in the workspace directory. It pins a specific directory and hides all others to help you concentrate by reducing distractions and cognitive load. You can enter and exit focus mode as follows.
-
Enter focus mode.
In the workspace directory, find the directory you want to focus on. Right-click the directory name and select Enter Focus Mode. Only the selected directory will be displayed.
-
Exit focus mode.
In the workspace directory, you can click the
icon to exit focus mode, or right-click the focused directory and select Exit Focus Mode.
Create and locate workflows and nodes
Create a workflow or node
Within the established directory structure, workspace members can create scheduled nodes or workflows.
-
Create a workflow or node.
In the Workspace Directories pane, click the
> Create Node... or > Create Workflow... icon, and then select the node type or workflow that you want to create. -
Develop the workflow or node.
Configuration depends on the task type. For more information, see Nodes or Workflows.
Locate workflows and nodes
The workspace directory provides several features to help you quickly find and locate nodes, improving search efficiency for better data management and development.
|
1. Filter by owner Click the ... > Show... icon in the upper-right corner of the Project Directory pane and select Show all or Show Managed by Me to filter which workflows or nodes are displayed. |
2. Locate the currently open workflow or node Click the |
|
3. Search for a workflow or node Use the search bar above the Project Directory pane to find a specific workflow or node by name, node ID, owner, or other criteria. The search can display a maximum of 2,048 results. |
4. Search for a node by code snippet Click the |
icon in the upper-right corner of the Project Directory pane to quickly locate the currently open workflow or node in the directory tree.
icon in the upper-right corner of the Project Directory pane to search for nodes that contain a specific code snippet. For more information, see Batch operations on workflows and nodes
Batch operations are available only in DataWorks Standard Edition and higher.
In daily development and operations, you may need to perform repetitive actions in the following scenarios:
-
Changing ownership: When a project member changes, you need to assign a large number of nodes or resources to a new owner.
-
Environment migration or changes: When underlying computing or storage resources, such as data sources or scheduling resource groups, change, you must modify the configurations of all related Data Integration tasks.
-
Uniformly adjusting scheduling properties: Due to changes in business requirements, you need to uniformly modify the scheduling cycle, rerun properties, or other settings for a group of tasks.
-
Bulk deployment or undeployment: When launching a new module, you need to deploy dozens of related nodes to the production environment simultaneously.
The batch operation feature lets you perform the same action on multiple workflows, standalone nodes, and nodes within a workflow simultaneously, such as changing the owner, modifying scheduling configurations, or deploying them in bulk.
-
Go to the batch operation page
Click the Batch Operation icon
to the right of the Project Directory to open the batch operation page. If you select a directory, the batch operation will include the Directory by default.The batch operation page allows you to filter nodes by Node Name/ID, Node Type, and Owner. The results are displayed in a table showing the node's name, type, directory, deployment status, owner, and creation time. You can select nodes from the table and click Batch Operation at the bottom to perform an action.
-
Filter and select objects
On the Batch Operation page, you can use filters to quickly locate the objects you need to manage.
-
Filter: Use the search bar at the top of the list and the Filter icon
to precisely filter the list of objects based on criteria such as Directory, Node Type, Owner, or Computing Resource for Scheduling.You can edit your favorite filters in the filter pop-up window to display them directly above the list for quick access.
-
Select: In the list, select the checkboxes for the objects you want to modify.
Note: When you select a workflow, you can click the dropdown icon next to it to quickly Select Parent Node and All Child Nodes.
-
-
Perform a batch operation
After selecting the target objects, click the Batch Operation button at the bottom left of the page and choose a specific action from the menu.
Depending on the action you choose, a dialog box appears. Configure the settings and click OK. Common operations include:
-
Change Owner (requires Workspace Administrator permissions)
-
Modifying Data Integration Tasks (you can change the data source, destination, resource group for running, etc.)
-
Modify scheduling configuration (you can change the scheduling cycle, dependencies, resource group, etc.)
-
Deploy/Downline Release
-
to the right of the Project Directory to open the batch operation page. If you select a directory, the batch operation will include the Directory by default.
to precisely filter the list of objects based on criteria such as Directory, Node Type, Owner, or Computing Resource for Scheduling.Notes
-
Scope of effect: Modifications made on the batch operation page affect only the development environment. To apply changes to the production environment, such as modified scheduling properties, you must deploy them to Operation Center.
-
Force modification: If any of the objects you are modifying are locked by another user, the system prompts you to confirm whether you want to Forcefully Modify File Locked By Another User. This action overwrites the other user's unsaved changes. Use this option with caution and only after you confirm with the relevant colleagues.
View operation history
To review the history of batch operations, click the Batch Operation History button in the upper-right corner of the page. You can view the details of each operation, including the operation type, affected objects, execution status, and time.