X-O&M Assistant provides a global overview of task execution, intelligent diagnosis and one-click rerun of failed tasks, quick analysis of task alerts, and the ability to check table data updates, helping you perform operations and maintenance easily anytime, anywhere.
Prerequisites
You must activate the Basic Development Edition to use X-O&M Assistant.
To configure DingTalk applications for your organization, you need to have development permissions for the DingTalk Open Platform. For information about how to obtain development permissions, see Become a DingTalk developer.
Before using O&M Assistant, you need to enable O&M Assistant in Super X > Intelligent Application Management > Intelligent Applications and complete the model configuration.
Limits
Mobile devices must be able to access the network where the Dataphin instance is located. If your Dataphin instance does not support public network access, you need to use it within your company's internal network environment or after enabling your company's VPN.
Permission description
Super administrators, system administrators, operations administrators, and custom global roles with Intelligent Application Management-Management permissions can enable or disable X-O&M Assistant and configure the models that X-O&M Assistant can use.
Configure X-O&M Assistant in DingTalk
Step 1: Create a DingTalk application
Users with DingTalk Open Platform development permissions log on to the DingTalk Development Platform.
On the DingTalk Applications page, click Create Application. In the Create Application panel, enter the Application Name and Application Description, and upload an Application Icon.
Application Name: Enter a name between 2 and 20 characters. All characters are supported.
Application Description: Enter a description between 4 and 200 characters to help users understand the purpose and specific functions of the application. All characters are supported.
Application Icon: Upload a JPG or PNG icon without border radius that is larger than 240×240 px and smaller than 2 MB. You can click View Icon Specifications to check the detailed rules.
You can click LightIcon.png or DarkIcon.png to download the corresponding Dataphin icon.
After completing the configuration, click Save.
Step 2: Add DingTalk application capabilities
After the DingTalk application is saved, you will automatically be redirected to the development page of the application. In the navigation pane on the left, select Application Capabilities > Add Application Capability.
In the Other Application Capabilities section on the right side of the page, click Web Application's Add.
Step 3: Configure the web application
In the navigation pane on the left, select Application Capabilities > Web Application.
On the Web Application page, configure H5 Application Configuration Information > Application Homepage URL. The link format is
{Dataphin domain}/mobile/ops/chat, for example,https://dataphin.alibaba.com/mobile/ops/chat. After filling in the information, click Save.
Step 4: Version management and publishing
In the navigation pane on the left, select Application Publishing > Version Management And Publishing. On the Version Management And Publishing page, click Create New Version.
On the Version Details page, fill in the Application Version Number and Version Description, and select the Available Range for the current application. The Application Available Range is set to All Employees by default. You can select according to your actual needs. After completing the configuration, click Save. In the dialog box that appears, click Publish Directly.
Step 5: Access the intelligent X-O&M Assistant on mobile
Open the DingTalk app on your mobile phone and click Workspace in the bottom navigation bar. You can view all applications in the workspace and quickly search for an application by entering its name in the search bar at the top.
Click the icon for X-O&M Assistant to use it.
Configure X-O&M Assistant in Lark
When you configure and publish a Lark application for your organization, a company administrator must review the application in the admin console. For more information, see Publish and review custom applications.
Step 1: Create an enterprise custom application
Log on to the Lark Open Platform.
In the Lark Developer Platform, click the Custom Enterprise Applications tab. On the Custom Enterprise Applications tab, click Create Custom Enterprise Application.
In the Create Enterprise Custom Application dialog box, configure the Application Name, Application Description, and Application Icon.
Application Icon: Upload a JPEG, PNG, SVG, or BMP icon without border radius that is larger than 240×240 px and smaller than 2 MB. You can click LightIcon.png or DarkIcon.png to download the corresponding Dataphin icon.
Step 2: Add Lark application capabilities
In the navigation pane on the left, choose Application Capabilities > Add Application Capability.
On the Add By Capability tab, click Configure on the Web App card.
Step 3: Configure the web application
In the navigation pane on the left, choose Application Capabilities > Web App.
On the Web App Configuration page, configure the Desktop Homepage and Mobile Homepage. The URL format is
{Dataphin domain name}/mobile/ops/chat, for example,https://dataphin.alibaba.com/mobile/ops/chat. After you complete the configuration, click Save.
Step 4: Manage and publish the version
In the navigation pane on the left, choose Application Release > Version Management & Publishing. On the Version Management & Publishing page, click Create Version.
On the Version Details page, enter the App Version and Update Description, and select the Availability for the application. After you complete the configuration, click Save.
Step 5: Access the intelligent X-O&M Assistant on a mobile device
Open the Lark app on your mobile device and click Workspace in the bottom navigation bar. You can view all applications in the workspace and search for an application by entering its name in the top search bar.
Click the icon for X-O&M Assistant to use it.
Configure X-O&M Assistant in WeCom
Use an administrator account to log on to the WeCom Admin console.
In the navigation pane on the left of the WeCom Admin console, click Application Management.
On the Application Management page, click Create Application.
On the Create Application page, enter the Application Name and Application Description, select the visibility in the Visible To field, and upload an Application Logo. After you complete the configuration, click Create Application.
The recommended application logo is a JPG or PNG icon that is 50×750 px and smaller than 1 MB. You can click LightIcon.png or DarkIcon.png to download the corresponding Dataphin icon.
In the navigation pane on the left of the WeCom Admin console, click Application Management. Click the X-O&M Assistant application, and then click Set next to Application Homepage.
In the Set Workbench Application Homepage dialog box, select the Webpage version of the application and enter the Webpage URL. After you complete the configuration, click OK.
The webpage URL format is
<Dataphin domain name>/mobile/ops/chat, for example,https://dataphin.alibaba.com/mobile/ops/chat.After the configuration is complete, open the WeCom app on your mobile device and click Workspace in the bottom navigation bar. You can view all applications in the workspace and search for an application by entering its name in the top search bar. Click the X-O&M Assistant icon to use the application.
X-O&M Assistant feature description
X-O&M Assistant currently supports the following features:
View the overall progress of task execution.
Intelligently diagnose the causes of failed tasks.
Query task execution status (specific task query).
Check if the data in a specific table has been updated.
Query the operational status of task instances in the projects you are responsible for.
The following two example scenarios demonstrate some of the features of X-O&M Assistant.
Scenario 1: Daily overview of task execution
Open X-O&M Assistant on your mobile device to view the daily overview of tasks for which you have O&M operation permissions. You can quickly understand the execution status of all tasks for which you have O&M operation permissions, along with the execution status of tasks you are responsible for.
Pay special attention to Failed Execution and Repeated Failures. Failed Execution refers to instances that failed to run on the current day (up to the query time). Repeated Failures refers to tasks that failed to run on the current day (up to the query time) and also failed to run the previous day. If a single task generates multiple instances and one of them fails to run, the task is considered failed.
Click the Failed Execution or Repeated Failures card, and O&M Assistant will automatically query the failed tasks. Each failed task card includes the person responsible for the task, so you can inform the corresponding person to handle the task execution failure.
Scenario 2: Analysis and handling of task execution failures
After receiving an alert about a task execution failure, you can open X-O&M Assistant and enter the alert information. X-O&M Assistant will automatically query the status of the alert object and initiate a diagnosis.
You can handle different tasks differently based on the error logs and recommended solutions provided by X-O&M Assistant (such as rerunning instances or enabling alert do-not-disturb). You can click Follow Instance to mark it as an object that needs key monitoring, so that you can track its status changes more efficiently in the future and take further actions when necessary.
For tasks that need to be handled later, you can enable do-not-disturb for their alerts. After do-not-disturb is enabled, you will not receive alert information for that task during the do-not-disturb period.