Las opciones de extensión son ajustes configurables definidos por el desarrollador de la extensión. Estas opciones personalizan el comportamiento de una extensión para cada espacio de trabajo. Por ejemplo, un desarrollador puede definir una opción que permita a los usuarios controlar el límite de longitud de SQL, lo que permite que la misma extensión aplique diferentes límites en distintos espacios de trabajo.
Contexto
-
El desarrollador define las opciones de extensión al registrar una extensión. Posteriormente, los usuarios pueden configurar estas opciones dentro de un espacio de trabajo específico.
Para obtener más información sobre cómo los desarrolladores registran extensiones, consulte Develop and deploy an extension: Self-managed service method.
Al usar una extensión en un espacio de trabajo, configure sus opciones antes de habilitarla. En la página Workspace Configuration > Extensions, consulte la lista de extensiones registradas con detalles como puntos de extensión, módulos aplicables y estado. Seleccione un ámbito, como Global, en la lista desplegable extension scope y luego haga clic en Settings en la columna Actions para configurar una extensión registrada.
Los desarrolladores de extensiones pueden llamar a la API GetOptionValueForProject para recuperar los valores de configuración establecidos por un usuario (como un administrador del espacio de trabajo) para una extensión en un espacio de trabajo específico.
Notas
El desarrollador de la extensión proporciona la información de configuración y el texto relacionado para las opciones de extensión. La plataforma no se hace responsable de ningún riesgo asociado con el contenido.
Componentes compatibles
La configuración de opciones admite actualmente siete tipos de componentes de formulario: text (para mostrar texto estático), single-line input box, multi-line input box, single-select drop-down list, multi-select drop-down list, checkbox (admite varias opciones, como opt1, opt2 y opt3) y radio button (admite varias opciones, algunas de las cuales pueden estar deshabilitadas).
Configuración de opciones
Al registrar una extensión, el desarrollador debe definir las opciones como una cadena JSON en el campo 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"
}
}
}
}Consulte los siguientes recursos para la configuración:
Para obtener detalles sobre los parámetros de los componentes, consulte Parameters.
Para ver ejemplos de configuración de componentes, consulte Example: Set the CU resource threshold for an SQL task y Example: Use the seven component types.
Para obtener más información sobre cómo registrar y gestionar extensiones, consulte Develop and deploy an extension: Self-managed service method.
Parámetros
Parámetro | Tipo de componente | Valor |
title | text | Título del componente. |
single-line input box | Título del componente. | |
multi-line input box | Título del componente. | |
single-select drop-down list | Título del componente. | |
multi-select drop-down list | Título del componente. | |
checkbox | Título del componente. | |
radio button | Título del componente. | |
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 | opcional |
single-line input box | opcional | |
multi-line input box | opcional | |
single-select drop-down list | El origen de datos es una matriz de objetos únicos. Cada objeto debe contener un | |
multi-select drop-down list | El origen de datos es una matriz de objetos únicos. Cada objeto debe contener un | |
checkbox | El origen de datos es una matriz de objetos únicos. Cada objeto debe contener un | |
radio button | El origen de datos es una matriz de objetos únicos. Cada objeto debe contener un |
Ejemplo: Establecer el umbral de CU para tareas SQL
En el siguiente ejemplo se muestra cómo establecer un umbral de recursos de CU para una tarea SQL.
Después de introducir el esquema JSON en el área de texto Option Configuration del formulario Register Extension, el sistema genera automáticamente un cuadro de diálogo Extension Options que muestra los controles de formulario correspondientes, como el cuadro de entrada CU Threshold.
El siguiente JSON define esta configuración:
{
"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."
}
}
}
}Ejemplo: Uso de los siete tipos de componentes
En el siguiente ejemplo se muestra cómo configurar y usar los siete tipos de componentes.
Después de introducir la configuración JSON en el campo Option Configuration del cuadro de diálogo Register Extension, el cuadro de diálogo Extension Options muestra los siete componentes de formulario correspondientes.
El siguiente JSON define esta configuración:
Si desea usar los siete componentes a la vez, copie el siguiente JSON y modifique los datos según sea necesario.
{
"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"
}
}
}Para obtener más información, consulte Best Practices: Prohibit the Use of the MAX_PT Function.