Componente Filter Builder del SDK de Jitterbit Connector
Descripción general
El componente Filter Builder muestra una lista de objetos y proporciona un área de texto donde un usuario puede ingresar una expresión de filtro. Debe estar precedido por un Componente de Lista de Objetos en un paso anterior para proporcionar datos al componente.
Características del componente
El componente Filter Builder incluye un comportamiento integrado para buscar, actualizar y especificar expresiones de filtro:
- Barra de búsqueda: Los usuarios pueden escribir una palabra clave y filtrar los campos.
- Actualizar: Hacer clic obtiene datos del conector y actualiza la lista de campos.
- Triángulo de divulgación: Hacer clic colapsa y expande la lista de campos.
- Arrastrar y soltar: Los campos se pueden arrastrar desde el lado izquierdo y soltar en el área de texto de la derecha, además de escribir un nombre de campo.
- Área de texto derecha: Un área de texto vacía donde un usuario puede escribir una expresión o arrastrar nombres de campos. No debe estar vacía para que el formulario sea válido y permitir avanzar al siguiente paso.
El resultado del componente es una cadena de filtro que luego puede ser utilizada por el conector.
JSON del componente
{
"name": "filter-page",
"type": "pagination",
"children": [
{
. . .
},
{
"displayName": "Filter Builder",
"name": "filter",
"type": "filter-builder",
"widgetHint": "component:connector/filter-builder",
"use": {
"ui": {
"leftSubTitle": "Available Attributes",
"rightSubTitle": "Filter Expression"
}
}
},
{
. . .
}
]
}
En el JSON que describe el filter-builder
, se pueden configurar estas propiedades:
type
: El tipo de componente del filter builder debe ser"filter-builder"
.widgetHint
: ElwidgetHint
del componente filter builder debe ser"component:connector/filter-builder"
.leftSubTitle
: Título sobre la lista de objetos en el lado izquierdo del componente.rightSubTitle
: Título sobre el área de texto en el lado derecho del componente.
Propiedades del componente
Las propiedades se devuelven en un objeto similar a este:
interface PropertyShape {
filterString: string;
auxiliaryClasses: string;
objectId: string;
}
El campo filterString
contendrá el filtro que fue ingresado por el usuario en el área de texto de la derecha. Se devolverá como una cadena JSON y se puede obtener en el método execute()
de una actividad utilizando un código similar a este:
public void execute(ExecutionContext context) throws Exception {
Map<String, String> functionalParam = context.getFunctionParameters();
. . .
String filter = functionalParam.get(FILTER);
try {
JSONObject filterBuilder = new JSONObject(filter);
filter = filterBuilder.getString("filterString");
} catch (Exception ex) {
. . .
}
. . .