Les options d'extension sont des paramètres configurables définis par le développeur de l'extension. Elles permettent de personnaliser le comportement d'une extension pour chaque espace de travail. Par exemple, un développeur peut définir une option permettant aux utilisateurs de contrôler la limite de longueur du code SQL, afin que la même extension applique des limites différentes selon les espaces de travail.
Contexte
-
Le développeur définit les options d'extension lors de l'enregistrement de l'extension. Les utilisateurs peuvent ensuite configurer ces options au sein d'un espace de travail spécifique.
Pour en savoir plus sur la procédure d'enregistrement des extensions par les développeurs, consultez la rubrique Développer et déployer une extension : méthode de service géré par l'utilisateur.
Lorsque vous utilisez une extension dans un espace de travail, configurez ses options avant de l'activer. Sur la page Workspace Configuration > Extensions, consultez la liste des extensions enregistrées avec des détails tels que les points d'extension, les modules applicables et leur statut. Sélectionnez une portée, telle que Global, dans la liste déroulante extension scope, puis cliquez sur Settings dans la colonne Actions pour configurer une extension enregistrée.
Les développeurs d'extensions peuvent appeler l'API GetOptionValueForProject pour récupérer les valeurs de configuration définies par un utilisateur (tel qu'un administrateur d'espace de travail) pour une extension dans un espace de travail spécifique.
Remarques
Le développeur de l'extension fournit les informations de configuration et les textes associés aux options d'extension. La plateforme n'est pas responsable des risques liés au contenu.
Composants pris en charge
La configuration des options prend actuellement en charge sept types de composants de formulaire : text (pour l'affichage de texte statique), single-line input box, multi-line input box, single-select drop-down list, multi-select drop-down list, checkbox (prend en charge plusieurs options, telles que opt1, opt2 et opt3) et radio button (prend en charge plusieurs options, dont certaines peuvent être désactivées).
Configuration des options
Lors de l'enregistrement d'une extension, le développeur doit définir les options sous forme de chaîne JSON dans le champ Option Configuration.
{
"type": "object",
"properties": {
"Component name (must be unique)": {
"type": "string",
"title": "See the table below",
"x-decorator": "See the Parameters section for details",
"x-component": "See the Parameters section for details",
"x-decorator-props": {
"tooltip": "Description"
},
"x-component-props": {
"dataSource": "See the Parameters section for details",
"mode": "multiple"
}
}
}
}Reportez-vous aux ressources suivantes pour la configuration :
Pour plus de détails sur les paramètres des composants, consultez la section Paramètres.
Pour des exemples de configuration de composants, reportez-vous aux sections Exemple : Définir le seuil de ressources CU pour une tâche SQL et Exemple : Utiliser les sept types de composants.
Pour en savoir plus sur l'enregistrement et la gestion des extensions, consultez la rubrique Développer et déployer une extension : méthode de service géré par l'utilisateur.
Paramètres
Paramètre | Type de composant | Valeur |
title | text | Titre du composant. |
single-line input box | Titre du composant. | |
multi-line input box | Titre du composant. | |
single-select drop-down list | Titre du composant. | |
multi-select drop-down list | Titre du composant. | |
checkbox | Titre du composant. | |
radio button | Titre du composant. | |
x-decorator | text | FormItem |
single-line input box | FormItem | |
multi-line input box | FormItem | |
single-select drop-down list | FormItem | |
multi-select drop-down list | FormItem | |
checkbox | FormItem | |
radio button | FormItem | |
x-component | text | PreviewText.Input |
single-line input box | Input | |
multi-line input box | Input.TextArea | |
single-select drop-down list | Select | |
multi-select drop-down list | Select | |
checkbox | Checkbox.Group | |
radio button | Radio.Group | |
dataSource | text | Facultatif |
single-line input box | Facultatif | |
multi-line input box | Facultatif | |
single-select drop-down list | La source de données est un tableau d'objets uniques. Chaque objet doit contenir un | |
multi-select drop-down list | La source de données est un tableau d'objets uniques. Chaque objet doit contenir un | |
checkbox | La source de données est un tableau d'objets uniques. Chaque objet doit contenir un | |
radio button | La source de données est un tableau d'objets uniques. Chaque objet doit contenir un |
Exemple : Définir le seuil CU pour les tâches SQL
L'exemple suivant illustre la procédure de définition d'un seuil de ressources CU pour une tâche SQL.
Après avoir saisi le schéma JSON dans la zone de texte Option Configuration du formulaire Register Extension, le système génère automatiquement une boîte de dialogue Extension Options affichant les contrôles de formulaire correspondants, tels que la zone de saisie CU Threshold.
Le code JSON suivant définit cette configuration :
{
"type": "object",
"properties": {
"cuNumber": {
"type": "string",
"title": "CU Threshold",
"x-decorator": "FormItem",
"x-component": "Input",
"x-decorator-props": {
"tooltip": "Enter the CU consumption threshold for the SQL task."
}
}
}
}Exemple : Utiliser les sept types de composants
L'exemple suivant montre comment configurer et utiliser les sept types de composants.
Après avoir saisi la configuration JSON dans le champ Option Configuration de la boîte de dialogue Register Extension, la boîte de dialogue Extension Options affiche les sept composants de formulaire correspondants.
Le code JSON suivant définit cette configuration :
Si vous souhaitez utiliser les sept composants simultanément, copiez le code JSON suivant et modifiez les données selon vos besoins.
{
"type":"object",
"properties":{
"text":{
"type":"string",
"title":"Text",
"x-decorator":"FormItem",
"x-component":"PreviewText.Input",
"x-decorator-props":{
"tooltip":"Description"
},
"default":"This is text information"
},
"input":{
"type":"string",
"title":"Single-line Input Box",
"x-decorator":"FormItem",
"x-component":"Input",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
},
"default":"This is the default value"
},
"textarea":{
"type":"string",
"title":"Multi-line Input Box",
"x-decorator":"FormItem",
"x-component":"Input.TextArea",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
},
"default":"This is the default value"
},
"select":{
"type":"string",
"title":"Single-select Drop-down List",
"x-decorator":"FormItem",
"x-component":"Select",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
]
},
"default":"10001"
},
"selectmore":{
"type":"string",
"title":"Multi-select Drop-down List",
"x-decorator":"FormItem",
"x-component":"Select",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":["10001","10002"]
},
"checkbox":{
"type":"array",
"title":"Checkbox",
"x-decorator":"FormItem",
"x-component":"Checkbox.Group",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":["10001","10002"]
},
"radio":{
"type":"number",
"title":"Radio Button",
"x-decorator":"FormItem",
"x-component":"Radio.Group",
"x-decorator-props":{
"tooltip":"Description"
},
"x-component-props":{
"dataSource":[
{
"value":"10001",
"label":"opt1"
},
{
"value":10002,
"label":"opt2"
},
{
"value":10003,
"label":"opt3",
"disabled":true
}
],
"mode":"multiple"
},
"default":"10001"
}
}
}Pour plus d'informations, consultez la rubrique Bonnes pratiques : Interdire l'utilisation de la fonction MAX_PT.