DataStudio feature guide
This topic describes the layout of the DataWorks DataStudio interface and its main components: workflows and nodes.
Go to DataStudio
Log on to the DataWorks console. In the target region, click in the left-side navigation pane. Select a workspace from the drop-down list and click Go to Data Development.
In DataStudio, you can create workflows and different types of nodes. For more information, see Create a workflow and Create a node.
The UI features vary for different development tasks. See the following topics for more information about specific interfaces.
DataStudio interface overview
The following table describes the DataStudio interface.
No. | Description |
1 |
|
2 | Click the
Note If some modules are not displayed in the left-side navigation pane, click the |
3 | Shortcuts to other modules in DataStudio:
Common features of DataWorks modules: Note This topic uses the DataStudio interface as an example to describe the following common features. These features are the same in other modules.
|
4 | System configuration includes the following settings:
|
5 | This area displays common shortcuts for the DataStudio editor. For a complete list, see Editor shortcuts. |
icon to switch to another workspace in the current region.
icon to access other modules, such as Data Integration and Operation Center.
icon in the lower-left corner to return to the DataWorks console.
icon in Area 4 and add the modules on the Personal Settings page. For more information, see 
): Displays notifications about product feature changes.
): Provides instructions for product features.
): Go to the workspace configuration page. On this page, you can view the basic information, scheduling information, IP address whitelist details, data sources, and open source clusters of the workspace. For more information, see Workflow interface features
When you enter DataStudio, the data development module opens by default. You must first create a workflow to organize your data development tasks. For more information, see Create a workflow. The following table describes the key areas of the workflow interface.
No. | Description |
1 |
Click the |
2 |
Note If you are in a new workspace, you must first create a workflow and then create nodes within it to start data development. For details, see Create a workflow. |
3 | Use the directory tree to manage nodes, tables, resources, and functions in each workflow:
The icon next to a node name indicates the node status:
The time of the last edit is displayed after the node name. Double-click a workflow name to open the workflow editing page (Areas 5 to 8), where you can perform data development. |
4 | Resource Group Orchestration ( |
5 |
|
6 | Tools on the workflow canvas (1):
|
7 | Tabs in the right-side pane (2):
|
8 | Tools in the toolbar (3):
|
icon to display all solutions or workflows in the current workspace.
): Click this icon to update the directory tree after you modify a workflow or solution.
): Quickly locates the currently open file in the directory tree.
): Searches for code snippets by keyword. This lets you quickly locate all nodes that contain a specific code snippet in data development, manually triggered workflows, ad hoc queries, and the recycle bin, and view the snippet's details. You can use this feature to find the source task that caused data changes in a target table.
): Modifies multiple tables, resources, or functions. You can change properties such as the owner, engine instance, resource group for scheduling, rerun properties, scheduling type, scheduling period, and scheduling timeout.
): Uploads local data to a target table. Currently, you can only upload data to MaxCompute tables.
): Quickly creates workflows, nodes of various types, tables, resources, and functions.
icon to find a specific node.
icon and select a node type to find all nodes of that type. After you select a node type, the directory tree displays only nodes of that type.
icon: Indicates the current node version has not been submitted. Click to submit the node.
icon: Indicates the node has not been deployed. Click this icon to go to the deployment center to deploy the node.
): During data development, use this feature to perform batch modifications on the resource groups for scheduling that are used by nodes in a workflow. This helps you reassign resource groups to improve resource utilization. After making changes, you must deploy them to Operation Center for the new settings to take effect for nodes in the production environment.
): Switches the canvas layout to Vertical, Horizontal, or Grid.
): Groups selected nodes into a node group to perform batch operations.
): Refreshes the current workflow. When you make changes to the workflow, you can manually refresh to get the latest view.
): Aligns nodes in the workflow horizontally.
): Automatically fits the workflow layout to the current window size.
): Centers the nodes in the current workflow.
): Sets the workflow view scale to 1:1.
): Zooms in on the current workflow.
): Zooms out of the current workflow.
): Enter a keyword to search for nodes that contain the keyword.
): Displays the current workflow in full-screen mode.
): Shows or hides the engine information for each node.
): Submits updated nodes in the workflow to the deployment page in batches.
): Runs all nodes in the current workflow.
): Stops nodes that are running in the workflow in batches.
): Opens the deployment page, filtering it to show nodes from this workflow that are pending deployment.
): Navigates to Operation Center to view operational details for the nodes.
icon to view them all in a drop-down list.
icon to close a specific tab.Workflow shortcut menu
Right-click a workflow to display its shortcut menu.
Feature | Description |
Create Node | Creates new nodes of various types. When you create a node, the system displays recently used node types for quick access. Selecting a type automatically populates the Compute Engine Instance and Node Type fields from the last used configuration, letting you quickly recreate nodes. In the Create Node dialog box, you can click a previously used node type (such as ODPS SQL) in the Recently Used section to quickly populate the Engine Instance and Node Type fields. You can also manually configure the following:
After configuration, click Submit. |
Create Table | Creates new tables of various types. |
Create Resource | Creates new engine resources. Note Currently, this feature supports creating resources only for MaxCompute, CDH, and EMR engines. |
Create Function | Creates new engine functions. Note Currently, this feature supports creating functions only for MaxCompute, CDH, and EMR engines. |
Board | Opens the editing canvas for the workflow. |
Change | Modifies the name, owner, and description of the workflow. |
Delete Workflow | Deletes the current workflow. Note This action deletes all objects within the workflow. Proceed with caution. If an object cannot be deleted, you can choose one of the following strategies:
Select I acknowledge the risk and confirm the operation, then click OK to complete the deletion. |
Batch-modify properties—such as owner, engine instance, and scheduling attributes—for multiple nodes, resources, and functions. You can also commit and deploy these changes to the production environment. |
DataStudio node editor features
After you create a workflow, you can create different types of DataStudio nodes based on your development requirements. For more information, see Create a development node. Different types of nodes provide similar features. This topic uses an ODPS SQL node as an example to describe the features of the node editor.
The following example shows a sample SQL statement in the ODPS SQL node editor:
--odps sql
--********************************************************************--
--author xxx xxx
--create time:2019-09-03 18:05:45
--********************************************************************--
INSERT OVERWRITE TABLE xc_rpt_user_info_d PARTITION (dt='${bdp.system.bizdate}')
SELECT uid
, MAX(region)
, MAX(device)
, COUNT(0) AS pv
, MAX(gender)
, MAX(age_range)
, MAX(zodiac)
FROM xc_dw_user_info_all_d
WHERE dt = ${bdp.system.bizdate}
GROUP BY uid;
No. | Description |
1 | The toolbar for node development:
|
2 | Scheduling Settings:
Lineage: Displays the dependencies and internal lineage between the current node and other nodes. Versions: A new version is created each time you commit or deploy a node. This panel displays the node's version history, the committer, commit time, change type, status, and remarks. The version statuses are as follows:
Structure: Visualizes the code's structure based on its SQL operators. |
3 | SQL editor: Write SQL statements for your task in this editor.
|
4 | Deployment and O&M operations: |
): Saves the code and configurations of the current node.
): Saves the current code as an ad hoc query file. You can go to the Ad Hoc Query page to view the file. For more information, see 
): Commits the current node.
): Commits the current node and unlocks it for other users to edit.
): Lets a user other than the node owner edit the node.
): Runs the code of the current node. When you run SQL code, you only need to assign values to SQL variables once. These initial assignments are retained even if the node's code changes.
): Runs the code for the current node with configured parameters. When you use Running, you must manually assign values to the variables in the SQL statement for each run. The initial values assigned by using Running are passed to Advanced Run. After custom parameter values are assigned by using Run with Parameters, the custom parameters for the current run are updated.
): Stops the running node.
): Refreshes the node page and restores the last saved version of the page.
): Tests the current node's code in the development environment. This test simulates how scheduling parameters are replaced during scheduling in the production environment. After you select a business date, the system replaces the parameters with the values that correspond to that date.
): Views the run log of the node in the development environment.
): Navigates to Operation Center for the development environment to perform O&M tasks. For more information, see 
): Formats the code of the current node. This feature is useful for long lines of code.
): Shares the current node with other users.
icon to jump to the first line of the SQL statement.
icon to display the SQL editor in full-screen mode.
icon to quickly run a selected code snippet and verify that it is correct. For more information, see Data development node shortcut menu
Hover over the target development node and right-click to display the shortcut menu for the node.
Feature | Description |
Rename | Changes the name of the target node. |
Add to Favorites | Adds the target node to your favorites. You can view your favorite nodes by clicking My Favorites in the upper-right corner of the directory tree. To remove a node from your favorites, click Remove from Favorites in its shortcut menu. |
Move | Moves the target node to another workflow directory. |
Clone | Creates a copy of the target node with the same node type, owner, and resource properties. Note In the same workflow directory, the original and cloned nodes cannot have the same name. |
Opens the Versions panel, which displays the node's version history. The history includes details such as the committer, commit time, change type, status, and remarks. | |
Opens Operation Center to display the node's runtime information. If a node in a standard workspace is committed to both the development and production environments, you can view its runtime status for either environment in Operation Center. | |
Submits the node's code for a code review. The node must pass this review before it can be deployed. | |
Delete | Deletes the target node and unlinks it from any upstream or downstream nodes. If a deleted node has been deployed to the production environment, you must use the Task Deployment page to take the node offline. For details, see Undeploy a task. |