Après avoir enregistré, publié et activé une extension sur la plateforme ouverte DataWorks, DataWorks envoie des messages d'événement à votre extension lorsque des actions dans l'espace de travail déclenchent des événements au niveau des points d'extension. Operation Center prend en charge les événements de modification de nœud et les événements de remplissage rétroactif de données (backfill), que vous pouvez utiliser pour exécuter une validation personnalisée.
Prérequis
Vous avez activé l'abonnement aux messages. Pour plus d'informations, consultez la rubrique Activer l'abonnement aux messages.
Vous avez développé et déployé l'extension. Pour plus d'informations, consultez la rubrique Développer et déployer une extension à l'aide de Function Compute.
Contexte
DataWorks envoie des notifications pour les événements liés aux points d'extension et vous permet de créer des points de contrôle de processus qui exécutent une logique personnalisée pour des opérations spécifiques. Pour utiliser cette fonctionnalité, enregistrez votre extension dans la console DataWorks et activez-la dans Administration > Extensions. Dans le volet de navigation de DataWorks Administration, cliquez sur Extensions pour accéder à la page de gestion des extensions. Dans la section Extension Scope, sélectionnez Workspace comme type, choisissez l'espace de travail cible, puis activez l'interrupteur Enable pour votre extension. Dans la boîte de dialogue Extension Data Authorization qui s'affiche, confirmez les détails de l'autorisation, tels que l'OpenAPI pour un événement de modification de fichier : UpdateIDEEventResult. Cochez I have read and agree to the risks associated with the preceding data authorization., puis cliquez sur Agree and Authorize.
Seul un administrateur d'espace de travail peut activer une extension dans Administration > Extensions.
Pour plus d'informations sur les extensions, consultez la rubrique Présentation des extensions.
La procédure ci-dessus concerne une extension au niveau de l'espace de travail. Pour plus d'informations, consultez la rubrique Événements de points d'extension pris en charge.
Vue d'ensemble
Operation Center envoie des messages pour les événements de points d'extension suivants. Vous pouvez enregistrer un programme local en tant qu'extension DataWorks pour recevoir ces messages, les traiter avec une logique personnalisée et renvoyer les résultats en appelant l'API UpdateWorkbenchEventResult afin de mettre en œuvre des contrôles de processus. Les points d'extension suivants sont pris en charge :
|
Événement |
Description |
|
node change event |
Remarque
Dans ce contexte, un nœud désigne une tâche figurant dans la liste Scheduled Tasks d'Operation Center en environnement de production. |
|
backfill data event |
|
Dans ce contexte, un nœud désigne une tâche figurant dans la liste production Scheduled Tasks d'Operation Center. Lorsque vous effectuez les opérations précédentes sur des tâches dans la page Scheduled Tasks de l'environnement de production, la validation par extension est déclenchée. L'exécution de ces opérations sur des tâches planifiées dans l'environnement de développement ne déclenche pas la validation par extension. De même, la suspension ou la réactivation d'une instance sur la page des instances ne déclenche pas la validation par extension.
Points d'extension pris en charge
Operation Center : Suspendre et réactiver un nœud
L'exemple suivant illustre comment déclencher une extension en suspendant un nœud. Dans Operation Center, sur la page Scheduled Tasks, faites un clic droit sur un nœud cible, tel que xc_demo_start, et sélectionnez Suspend (Freeze) dans le menu contextuel. Vous pouvez également cliquer sur l'icône de suspension dans la barre d'outils. Une fois l'action déclenchée, le panneau Operation Check Details s'affiche à droite, indiquant le nom du nœud, le type d'opération (Suspend/Freeze) et l'état du point de contrôle. Vous pouvez cliquer sur View Details ou View Documentation pour consulter les résultats de la validation, sur Recheck pour relancer la validation, ou sur Close pour fermer le panneau.
Operation Center : Retirer un nœud du déploiement
Dans la liste Scheduled Tasks, faites un clic droit sur une tâche cible, telle que test_select, et sélectionnez Undeploy node dans le menu contextuel. Après avoir lancé le retrait du déploiement, une icône d'état et un message Undeployment check in progress apparaissent dans la ligne de la tâche. Cliquez sur l'icône d'état pour ouvrir la boîte de dialogue Operation Check Details, qui affiche le nom de la tâche, le type d'opération (Undeploy) et l'état du point de contrôle. La colonne Operation propose des liens vers View Details et View Documentation. Cliquez sur Recheck pour relancer la validation, ou sur Close pour fermer la boîte de dialogue.
Operation Center : Remplissage rétroactif des données (Backfill)
Dans le volet de navigation de gauche d'Operation Center, sélectionnez Scheduled Tasks. Dans le DAG à droite, faites un clic droit sur un nœud de tâche cible et sélectionnez une option de remplissage rétroactif (backfill) des données, par exemple pour le nœud actuel, pour le nœud actuel et ses nœuds en aval, en mode massif (massive node) ou en mode avancé. Cette action déclenche un événement de point d'extension de pré-vérification. Après avoir soumis la tâche, sélectionnez Backfill Instances dans le volet de navigation de gauche pour afficher l'état de la vérification. Cliquez sur l'état de la vérification pour ouvrir la boîte de dialogue Operation Check Details, qui affiche les résultats de la validation, y compris les noms des points de contrôle et leurs états.
Références
Pour activer une extension, consultez la rubrique Activer une extension.
Pour plus d'informations sur les événements de points d'extension dans Operation Center, consultez la rubrique Événements de points d'extension pris en charge.
Pour connaître le format des messages d'un événement de remplissage rétroactif des données (backfill), consultez la rubrique Événement de backfill de données.
Pour connaître le format des messages d'un événement de modification de nœud, consultez la rubrique Événement de modification de nœud (création, modification, suppression, suspension, réactivation et retrait du déploiement).