Lors du développement de code pour une extension, DataWorks met à votre disposition des paramètres intégrés et personnalisés afin d'améliorer l'efficacité du développement. Par exemple, utilisez ces paramètres pour activer une extension uniquement dans certains espaces de travail.
Contexte
Lors du développement de code avec des paramètres d'extension, définissez ces paramètres dans les informations d'enregistrement de l'extension. Ajoutez aux informations d'enregistrement les paramètres intégrés ou personnalisés nécessaires au développement. Les développeurs d'extensions peuvent obtenir la configuration des paramètres de l'extension en appelant l'API GetExtension. Dans la boîte de dialogue Register Extension, sélectionnez un événement sur la gauche, tel qu'un événement avant l'exécution du code, avant la suppression d'un fichier, avant la validation d'une table dans l'environnement de développement, avant la validation d'une table dans l'environnement de production ou avant la publication d'un fichier. Sur la droite, remplissez le formulaire avec des informations telles que Associated Event, Applicable Module, Owner, Test Workspace, Extension Details URL, Extension Documentation URL, Extension Parameter Configuration et Description. Dans la zone de texte Extension Parameter Configuration, saisissez les paramètres au format key=value, un paramètre par ligne.
Ajoutez chaque paramètre sur une nouvelle ligne.
-
Pour ajouter un paramètre intégré :
Les paramètres intégrés suivent le format
key=value. Les paramètres intégrés suivants sont pris en charge :Paramètre intégré 1 : extension.project.disabled — liste d'exclusion d'espaces de travail
Paramètre intégré 5 : extension.fileType.{fileType}.{eventCode}.enabled
-
Paramètre intégré 6 :
extension.manualPass.enabled. Ce paramètre contrôle la visibilité du bouton Mark as Passed pour l'extension.extension.manualPass.enabled=trueCe paramètre affiche le bouton Mark as Passed dans la colonne d'action de l'extension.
-
Pour ajouter un paramètre personnalisé :
Nous vous recommandons d'utiliser le format
key=value.
Paramètre intégré 1 : extension.project.disabled — Liste d'exclusion d'espaces de travail
-
Cas d'utilisation :
Utilisez ce paramètre pour désactiver une extension dans des espaces de travail spécifiques.
-
Description du paramètre :
extension.project.disabled=projectId1,projectId2,projectId3projectId correspond à l'ID de l'espace de travail dans lequel l'extension est désactivée. Obtenez cet ID en appelant l'API ListProjects ou en le consultant sur la page de configuration de l'espace de travail dans la console DataWorks.
RemarqueVous pouvez spécifier plusieurs IDs d'espaces de travail pour un seul paramètre. Séparez les IDs par des virgules (,).
-
Exemple de code :
extension.project.disabled=projectId1 -
Remarque :
Ne configurez pas la même clé plus d'une fois. Seule la dernière configuration prend effet.
Paramètre intégré 2 : extension.project.disabled.append — Liste d'exclusion d'espaces de travail (ajout)
-
Cas d'utilisation :
Utilisez ce paramètre pour ajouter des espaces de travail à la liste d'exclusion sans écraser la liste définie par
extension.project.disabled. L'extension est désactivée dans les espaces de travail spécifiés par les deux paramètres. -
Description du paramètre :
extension.project.disabled.append=projectId1,projectId2,projectId3projectId correspond à l'ID de l'espace de travail dans lequel l'extension est désactivée. Obtenez cet ID en appelant l'API ListProjects ou en le consultant sur la page de configuration de l'espace de travail dans la console DataWorks.
RemarqueVous pouvez spécifier plusieurs IDs d'espaces de travail pour un seul paramètre. Séparez les IDs par des virgules (,).
-
Exemple de code :
extension.project.disabled.append=projectId1
Paramètre intégré 3 : extension.project.{eventCode}.disabled — Liste d'exclusion de points d'extension
-
Cas d'utilisation :
Utilisez ce paramètre pour désactiver une extension à un point d'extension spécifique pour des espaces de travail donnés.
-
Description du paramètre :
extension.project.{eventCode}.disabled=projectId1,projectId2,projectId3Où :
eventCode : type d'événement du point d'extension à désactiver. Pour la liste des valeurs valides, consultez l'annexe Annexe : Détails des événements (eventType).
-
projectId : ID de l'espace de travail dans lequel l'extension est désactivée. Obtenez cet ID en appelant l'API ListProjects ou en le consultant sur la page de configuration de l'espace de travail dans la console DataWorks.
RemarqueVous pouvez spécifier plusieurs IDs d'espaces de travail pour un seul paramètre. Séparez les IDs par des virgules (,).
-
Exemple de code :
extension.project.commit-file.disabled=projectId1 extension.project.delete-file.disabled=projectId2,projectId3 -
Remarque :
Ne configurez pas la même clé plus d'une fois. Seule la dernière configuration prend effet.
Paramètre intégré 4 : extension.project.{eventCode}.disabled.append — Liste d'exclusion de points d'extension (ajout)
-
Cas d'utilisation :
Utilisez ce paramètre pour ajouter des espaces de travail à la liste d'exclusion de points d'extension sans écraser la liste définie par
extension.project.{eventCode}.disabled. L'extension est désactivée au point d'extension spécifié pour les espaces de travail indiqués par les deux paramètres. -
Description du paramètre :
extension.project.{eventCode}.disabled.append=projectId1,projectId2,projectId3Où :
eventCode : type d'événement du point d'extension à désactiver. Pour la liste des valeurs valides, consultez l'annexe Annexe : Détails des événements (eventType).
-
projectId : ID de l'espace de travail dans lequel l'extension est désactivée. Obtenez cet ID en appelant l'API ListProjects ou en le consultant sur la page de configuration de l'espace de travail dans la console DataWorks.
RemarqueVous pouvez spécifier plusieurs IDs d'espaces de travail pour un seul paramètre. Séparez les IDs par des virgules (,).
-
Exemple de code :
extension.project.commit-file.disabled.append=projectId1 extension.project.delete-file.disabled.append=projectId2,projectId3
Paramètre intégré 5 : extension.fileType.{fileType}.{eventCode}.enabled
-
Cas d'utilisation :
Utilisez ce paramètre pour activer ou désactiver une extension pour des types spécifiques de tâches de nœud.
-
Description du paramètre :
extension.fileType.{fileType}.{eventCode}.enabledOù :
fileType : code de type pour une tâche de nœud spécifique. Appelez l'API ListFileType pour obtenir le code de type d'une tâche de nœud.
eventCode : type d'événement du point d'extension à désactiver. Pour la liste des valeurs valides, consultez l'annexe Annexe : Détails des événements (eventType).
-
Exemples de code :
Les exemples suivants montrent comment configurer une extension pour les tâches de nœud ODPS SQL (type 10) et les tâches de nœud ODPS MR (type 11).
-
Si tous les types de fichiers spécifiés sont définis sur
true, tous les types de fichiers non configurés prennent par défaut la valeurfalse.extension.fileType.10.run-file.enabled=true extension.fileType.11.run-file.enabled=trueL'extension est active pour la tâche de nœud ODPS SQL (10) et la tâche de nœud ODPS MR (11). Lorsque ces tâches s'exécutent, elles déclenchent l'extension.
Les autres tâches de nœud, telles qu'une tâche de nœud DI de synchronisation par lots, ne déclenchent pas l'extension.
-
Si tous les types de fichiers spécifiés sont définis sur
false, tous les types de fichiers non configurés prennent par défaut la valeurtrue.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=falseL'extension n'est pas active pour la tâche de nœud ODPS SQL (10) ni pour la tâche de nœud ODPS MR (11). Lorsque ces tâches s'exécutent, elles ne déclenchent pas l'extension.
Toutes les autres tâches de nœud, telles qu'une tâche de nœud DI de synchronisation par lots, déclenchent l'extension.
-
Si vous utilisez une configuration mixte où au moins un type de fichier est défini sur
true, tous les types de fichiers non configurés prennent par défaut la valeurfalse.extension.fileType.10.run-file.enabled=false extension.fileType.11.run-file.enabled=trueL'extension est active pour la tâche de nœud ODPS MR (11). Lorsque cette tâche s'exécute, elle déclenche l'extension.
L'extension n'est pas active pour la tâche de nœud ODPS SQL (10) ni pour toute autre tâche de nœud, telle qu'une tâche de nœud DI de synchronisation par lots. Ces tâches ne déclenchent pas l'extension.
-