Lista de elementos
Definición y uso
El componente Lista de elementos es un mashup contenido que permite mostrar una lista de elementos de un conjunto de datos en una vista de rejilla. También permite al usuario final buscar, clasificar y filtrar la lista, así como realizar acciones en toda la lista o en elementos específicos de la lista.
A continuación, se presenta una imagen de ejemplo en la que se muestra el componente Lista de elementos:
El componente Lista de elementos se puede configurar de las siguientes maneras:
• Activar o desactivar la búsqueda y el filtrado.
• Definir las opciones iniciales de filtrado y clasificación.
• Definir el número máximo de filas de la rejilla.
• Definir si se pueden seleccionar elementos de la lista y, si es así, si se pueden seleccionar uno o varios elementos.
• Configurar las acciones disponibles en la Barra de acciones integrada.
• Elegir si se debe mostrar la acción de exportación.
El usuario puede filtrar la lista de elementos o buscar en ella mediante el cuadro de filtro o el cuadro de búsqueda. Sin embargo, si el cuadro de filtro y el cuadro de búsqueda no se activan en la configuración, el filtrado y la búsqueda no están disponibles. Se puede pulsar en el título de una columna para clasificar la lista por esa columna. Para invertir el orden de clasificación, vuelva a pulsar en el título de columna.
En el componente Lista de elementos se incluye un componente Barra de acciones integrado. Al configurar la barra de acciones, se pueden activar funciones adicionales, como ejecutar una acción en uno o más elementos de la lista. Consulte Barra de acciones (BETA) para obtener más información. Por defecto, la lista de elementos contiene una acción Exportar que permite exportar todos los elementos que coinciden con los criterios de filtro a un fichero CSV.
En la lista de elementos también se incluye un botón Restaurar a valores por defecto. El botón Restaurar a valores por defecto permite restaurar la configuración por defecto para el filtrado, la búsqueda y las operaciones de nivel de rejilla, incluida la clasificación, el intercambio y la visualización y ocultación de columnas.
Actividad, Elementos afectados, Adjuntos y Tareas son las configuraciones predefinidas disponibles para el componente Lista de elementos.
Propiedades de enlace
Entrada | ||
|---|---|---|
Nombre de la propiedad | Descripción | Tipo de propiedad |
input | Se utiliza para identificar los datos que se deben extraer del sistema back-end. Cuando se requiere la entrada, defina la propiedad de configuración waitForInput en true. JSON de ejemplo: { "version":"1.0.0", "data":[ { "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" }, "itemListsData":[ { "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:1432583" } } ], "objectType":"PTC.Workflow.WorkItem" } ] } ] } | JSON en formato CCO |
tailoringName | Identifica de forma exclusiva una instancia del componente Lista de elementos. Este valor se utiliza internamente para buscar información de personalización de esa instancia específica. Utilice esta propiedad de enlace solo cuando haya una página de personalización dedicada para la tarea personalizada. | |
Salida | ||
|---|---|---|
Nombre de la propiedad | Descripción | Tipo de propiedad |
totalItemsNumber | Número de elementos de lista que coinciden con los criterios de búsqueda y filtro. | Entero |
selectedItems | Se utiliza para identificar los elementos de la rejilla seleccionada y sus atributos. Esta propiedad se puede enlazar a la propiedad de enlace input de otros componentes. JSON de ejemplo: { "timeStamp":"2019-08-25 18:53:33.476", "data":[ { "itemListsData":[ { "items":[ { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143921" } }, { "workItem":{ "value":"OR:wt.workflow.work.WorkItem:143928" } } ], "objectType":"PTC.Workflow.WorkItem" } ], "adapter":{ "instanceName":"windchill", "thingName":"PTC.WCAdapter" } } ], "version":"1.0.0", "statusMessage":"OK", "status":"200" } | JSON en formato CCO |
Propiedades de configuración
En las siguientes tablas se muestran los campos JSON que se utilizan para configurar este componente.
Para obtener más información sobre la estructura de la configuración, consulte Estructura de configuración de componentes.
Para obtener más información sobre las subpropiedades, consulte Subpropiedades y claves de contenedor.
Nombre de la propiedad | Descripción | Tipo de propiedad | Valor por defecto | Obligatorio u opcional | |
|---|---|---|---|---|---|
actionBarConfiguration | Configuración de la barra de acciones integrada. Consulte Barra de acciones (BETA) para obtener más información. | N/D | Opcional | ||
attributes | Atributos que se deben mostrar. Aparecen como títulos de columna en la cuadrícula. | N/D | Obligatorio | ||
defaultSelectedFilterValue | Valor o valores seleccionados iniciales por los que se debe filtrar. Si se deja en blanco, no hay filtrado por defecto. Esta propiedad es una subpropiedad de filterFields y solo es pertinente cuando filterFields se incluye en la configuración. Su clave de contenedor es itemListFilterFieldDefinition. | N/D | Opcional | ||
defaultSortDirection | La dirección de la clasificación por defecto. Opciones: asc, que indica el orden ascendente y dsc, que indica el orden descendente. Si se deja en blanco, la dirección de clasificación es ascendente. Esta propiedad es una subpropiedad de defaultSortField y solo es pertinente cuando defaultSortField se incluye en la configuración. Su clave de contenedor es itemListDefaultSortFieldDefinition. | asc | Opcional | ||
defaultSortField | La columna inicial por la que se debe clasificar. Si se deja en blanco, la lista de elementos se clasifica por la primera columna. | N/D | Opcional | ||
enableSearch | Si se debe presentar el campo de búsqueda. Opciones: true, false. | true | Opcional | ||
filterFields | Los ID en el sistema back-end de los campos por los que se deben filtrar los datos. Si se deja en blanco, no hay ninguna opción para filtrar los datos. | N/D | Opcional | ||
filterLabelOverride | Un rótulo del filtro que sustituye el valor mostrado que se ha devuelto del servicio GetItems. Esta propiedad es una subpropiedad de filterFields y solo es pertinente cuando filterFields se incluye en la configuración. Su clave de contenedor es itemListFilterFieldDefinition. | N/D | Opcional | ||
implementationConfigurations | Punto de entrada para que el generador de la aplicación pase valores adicionales necesarios para su implementación, a fin de personalizar más el componente. | N/D | Opcional | ||
label | El título de la lista de elementos. | [[PTC.ItemList]] | Opcional | ||
maxNumberOfRowsInGrid | Número máximo de filas que se deben mostrar en el área de rejilla. Se recomienda introducir un valor inferior a 10.000. | 500 | Opcional | ||
searchHintText | El texto de sugerencia que se muestra en el cuadro de búsqueda. Esta propiedad es una subpropiedad de enableSearch y solo es pertinente cuando enableSearch se define en true. Su clave de contenedor es itemListSearchDefinition. | Find Item | Opcional | ||
selectionType | Permite determinar el número de elementos de la rejilla que se pueden seleccionar al mismo tiempo. Opciones: • none: no se pueden seleccionar elementos de la cuadrícula • single: se puede seleccionar elementos de la cuadrícula de uno en uno • multi: se pueden seleccionar uno o más elementos de la cuadrícula a la vez | multi | Opcional | ||
showExportAction | Permite activar o desactivar la acción Exportar. Opciones: true, false. | true | Opcional | ||
waitForInput | Si se debe esperar en tiempo de ejecución a que se pase un valor al parámetro de mashup de entrada de Lista de elementos antes de activar la recuperación de los elementos que rellenan la rejilla. Opciones: true, false. | false | Opcional | ||
Configuración de ejemplo
Para obtener configuraciones de ejemplo del componente Lista de elementos, consulte Actividad, Elementos afectados, Adjuntos y Tareas.
Servicios de personalización
Además de la configuración, cada componente soporta la extensión de la lógica empresarial para personalizar el componente. En la lógica empresarial de cada componente se incluyen los servicios desestimables en una plantilla de cosa que se pueden extender y sustituir. En la tabla siguiente se describen los servicios desestimables de este componente.
Para obtener ejemplos de las devoluciones y los parámetros de cada servicio, consulte Ejemplos de entrada/salida para servicios de personalización.
 | Al devolver un objeto JSON en formato CCO desde un componente de implementación de lógica empresarial al componente Lista de elementos, solo se incluyen los atributos de un único tipo de objeto. Actualmente, Lista de elementos no soporta la inclusión de atributos de diferentes tipos de objeto. |
Nombre | Descripción |
|---|---|
GetConfigurations | Devuelve las configuraciones disponibles para la implementación de componentes. Parámetros: ninguno Devuelve: JSON |
GetImplementationLabel | Devuelve el nombre localizado del componente o el token que se puede utilizar para obtener el nombre localizado. Este nombre localizado se muestra en la interfaz de usuario de Mashup Builder. Parámetros: ninguno Devuelve: Cadena |
GetItems | Devuelve la lista de elementos del sistema back-end. Para crear una implementación personalizada de Lista de elementos, sustituya este servicio para recuperar los datos personalizados. Parámetros: input (opcional): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end y la información del adaptador para el sistema back-end. Al utilizar este parámetro, asegúrese de que la propiedad de configuración waitForInput esté definida en true. configuration (obligatorio): JSON con la configuración combinada final obtenida del recurso del administrador de personalización. Devuelve: JSON en formato CCO |
InitializeFilters | Devuelve la definición de tipo de filtro de cada uno de los campos de filtro de la configuración. Parámetros: input (opcional): JSON en formato CCO en el que se incluye el ID de entrada de los datos que se van a extraer del sistema back-end y la información del adaptador para el sistema back-end. configuration (obligatorio): JSON con la configuración combinada final obtenida del recurso del administrador de personalización. Devuelve: JSON en formato CCO |
DefHookImplementationConfigurationDefinitionGroup | Devuelve la definición específica de la implementación con las configuraciones personalizadas para la implementación. Parámetros: ninguno Devuelve: JSON: matriz |
DefHookImplementationAttributesDefinition | Devuelve la definición específica de la implementación para los atributos seleccionados. Parámetros: ninguno Devuelve: JSON: matriz |
DefHookMaxRowsProperties | Devuelve las propiedades del número máximo de filas que se deben mostrar en el área de cuadrícula. Parámetros: ninguno Devuelve: JSON |
Definición de implementación
Para ver definiciones de implementación del componente Lista de elementos, consulte Actividad, Elementos afectados, Adjuntos y Tareas.