X-O&M Assistant provides a global overview of task execution, intelligent diagnosis, one-click reruns of failed tasks, and quick analysis of task alerts. You can also check table data updates. This helps you perform operations and maintenance (O&M) tasks easily, anytime, and anywhere.
Prerequisites
You must activate the Basic R&D Edition to use X-O&M Assistant.
To configure a DingTalk application for your organization, the user who performs the configuration must have developer permissions on the DingTalk Open Platform. For more information, see Become a DingTalk developer.
Before using O&M Assistant, go to Super X > Intelligent Application Management > Intelligent Applications, enable O&M Assistant, and complete the model configuration.
Limits
Mobile devices must have access to the network where the Dataphin instance is located. If your Dataphin instance does not support public network access, you must access it from your company's internal network or by connecting to 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. They can also configure the models that X-O&M Assistant can use.
Configure X-O&M Assistant in DingTalk
Step 1: Create a DingTalk application
Log on to the DingTalk Developer Platform with an account that has developer permissions.
On the DingTalk Applications page, click Create Application. In the Create Application panel, enter an Application Name and Application Description, and upload an Application Icon.
Application Name: Enter a name that is 2 to 20 characters long. The name can contain any characters.
Application Description: Enter a description that is 4 to 200 characters long. The description helps users understand the purpose and features of the application. The description can contain any characters.
Application Icon: Upload a JPG or PNG icon without a border radius. The icon must be at least 240×240 px in size and no larger than 2 MB. Click View Icon Specifications to view the detailed rules.
Click LightIcon.png or DarkIcon.png to download the corresponding Dataphin icon.
After you complete the configuration, click Save.
Step 2: Add DingTalk application capabilities
After the DingTalk application is saved, you are automatically 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, click Add next to Web Application.
Step 3: Configure the web application
In the navigation pane on the left, select Application Capabilities > Web Application.
On the Web Application page, under H5 Application Configuration Information, set the Application Homepage URL to a URL in the format
{Dataphin domain name}/mobile/ops/chat, such ashttps://dataphin.alibaba.com/mobile/ops/chat. Then, click Save.
Step 4: Manage and publish the version
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, enter the Application Version Number and Version Description, and select the Available Range for the application. By default, the Application Available Range is set to All Employees. Select a range as needed. After you complete the configuration, click Save. In the dialog box that appears, click Publish Directly.
Step 5: Access X-O&M Assistant on a mobile device
Open the DingTalk app on your mobile device and click Workspace in the bottom navigation bar. The workspace displays all applications. To quickly find an application, enter its name in the search bar at the top.
Click the X-O&M Assistant icon to open the application.
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 a border radius. The icon must be at least 240×240 px in size and no larger 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, set the URLs for the Desktop Homepage and Mobile Homepage. The URL must be in the format
{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 X-O&M Assistant on a mobile device
Open the Lark app on your mobile device and click Workspace in the bottom navigation bar. The workspace displays all applications. To find an application, enter its name in the search bar at the top.
Click the X-O&M Assistant icon to open the application.
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 an Application Name and Application Description, select the scope under Visible To, and upload an Application Logo. After you complete the configuration, click Create Application.
The application logo must be a JPG or PNG icon that is 50×750 px and less than 1 MB in size. 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 must be in the format
{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. Click Workspace in the bottom navigation bar. The workspace displays all applications. You can find the X-O&M Assistant application by entering its name in the search bar at the top. Click the application icon to open it.
X-O&M Assistant features
X-O&M Assistant currently supports the following features:
View the overall progress of task execution.
Intelligently diagnose the causes of failed tasks.
Query the execution status of specific tasks.
Check whether data in a specific table has been updated.
Query the operational status of task instances in projects that you manage.
The following two 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 a daily overview of your tasks. You can quickly check the execution status of all tasks for which you have O&M permissions and the status of tasks that you own.
Focus on tasks with a status of Failed Execution or Repeated Failures. Failed Execution indicates instances that failed to run on the current day. Repeated Failures indicates tasks that failed to run on the current day and also failed on the previous day. If a task generates multiple instances and at least one instance fails, the task is marked as failed.
Click the Failed Execution or Repeated Failures card. O&M Assistant automatically displays the failed tasks. Each failed task card shows the task owner. Notify the owner to resolve the failure.
Scenario 2: Analysis and handling of task execution failures
After you receive an alert about a task failure, open X-O&M Assistant and enter the alert information. X-O&M Assistant automatically queries the status of the alert object and starts a diagnosis.
Use the error logs and recommended solutions from X-O&M Assistant to handle task failures. For example, rerun instances or mute alerts. Click Follow Instance to mark an instance for priority monitoring. This lets you track its status changes more efficiently and take further action when necessary.
For tasks that can be handled later, mute their alerts. After an alert is muted, you no longer receive alert information for that task during the mute period.