Guía del usuario del

Módulo de gestión listas

dinámicas
« myList »

Charles-Fr. BENKE et Romain DESCHAMPS copyright 2013

 INDEX
PRESENTACIÓN ................................................................................................................................................ 3
REQUISITOS PREVIOS A LA INSTALACIÓN ....................................................................................................................... 3
MYLIST CONFIGURACIÓN DEL MÓDULO ........................................................................................................................ 3
PREÁMBULO - ANTES DE COMENZAR ............................................................................................................... 4
GESTIÓN DE LOS MENÚS EN DOLIBARR ......................................................................................................................... 4
Observación ................................................................................................................................................... 4
GESTIÓN DE LAS HABILITACIONES EN DOLIBARR ............................................................................................................. 5
GESTIÓN DE LOS FICHEROS DE TRADUCCIONES EN DOLIBARR ............................................................................................ 5
LOS DOS MODOS DE VISUALIZACIÓN DE LISTAS PERSONALIZADAS ....................................................................................... 5
LOS MENÚS DEL MÓDULO................................................................................................................................ 6
CREACIÓN DE UNA NUEVA LISTA...................................................................................................................... 7
CREACIÓN DE CAMPOS EN UNA LISTA ........................................................................................................................... 8
INTRODUCCIÓN DE UN CAMPO ................................................................................................................................... 9
AJUSTE DE LOS DIFERENTES TIPOS DE CAMPOS ............................................................................................................. 10
Campos que tienen una zona simple de texto como zona de filtración ....................................................... 10
CASO PARTICULAR: LA GESTIÓN DE CLAVES ESPECÍFICAS (ROWID, FK_STATUT) ................................................................... 11
Campos ROWID ........................................................................................................................................... 11
campos Fk_statut ........................................................................................................................................ 11
FUNCIONES PRESENTES EN LA LISTA ESTÁNDAR ............................................................................................ 12
FILTRADO............................................................................................................................................................. 12
FUNCIONES PRESENTES EN LA LISTA AVANZADA ........................................................................................... 13
LIMITACIÓN DEL NÚMERO DE REGISTROS MOSTRADOS .................................................................................................. 13
SELECCIÓN DE CAMPOS PARA MOSTRAR / OCULTAR ...................................................................................................... 13
LÍNEAS Y PAGINACIÓN............................................................................................................................................. 13
DESPLAZAMIENTO DE COLUMNAS ............................................................................................................................. 13
EXPORTACIÓN....................................................................................................................................................... 13
FUNCIONESS AVANZADAS DE MYLIST ............................................................................................................ 14
USO DE LOS CAMPOS DE PARÁMETROS ...................................................................................................................... 14
FILTRADO POR EL USUARIO ...................................................................................................................................... 14
IMPORTACIÓN / EXPORTACIÓN DE LA PÁGINA MYLIST ................................................................................................... 14
CREDITOS ....................................................................................................................................................... 16
Presentación del módulo myList

Presentación
El módulo myList permite crear listas personalizadas y colocarlos en los menús de Dolibarr.

Requisitos previos a la instalación

El módulo myList funciona con a partir de la versión 3.4.x de Dolibarr y una versión de php
5.3 mínimo. se instala como cualquier módulo Dolibarr descomprimiendo el archivo zip en la
carpeta / htdocs o la carpeta /custom si ha activado este modo en su entorno.

MyList configuración del módulo

myList no tiene una pantalla de administración con acceso desde la lista de módulos. Toda la
configuración de myList se realiza a partir de su menú dedicado en el menú principal
"Herramientas".

3
Présentation du module myList

Preámbulo - Antes de comenzar

Antes de lanzarse la creación de una página myList, conviene comprender cómo son
administrados los menús, las habilitaciones y los ficheros de traducciones en Dolibarr.
Un conocimiento del Lenguaje SQL y de la estructuración de las mesas de dolibarr es
preferible para crear sus propios paneles de control, pero en el caso de una instalación de un
modelo predefinido esto no es necesario.

Gestión de los menús en Dolibarr

Dolibarr para su gestión de menú utiliza dos niveles de menú

El menu principal se exhibe en lo alto de la página

El menú izquierdo or secundario se exhibe en el lado izquierda de la página (o, según el tema
utilizado) bajo la forma de un submenú

Para localizar el menú principal, basta con hacer clic en uno dos y analizar el url fijado en lo
alto del navegador.

En el ejemplo más arriba, el valor del menu principal es « bank »

Para recuperar el menú secundario, hay que hacer clic en la cabecera del menú secundario y
analizar de nuevo el url mostrada.

En el ejemplo más arriba, el valor del menú secundario es « checks »

Observación
Si el módulo asociado con el menú donde está colocada la página myList es desactivado, ésta
no será accesible

4
Présentation du module myList

Gestión de las habilitaciones en Dolibarr

Dolibarr posee nativement funcionalidades avanzadas para administrar los derechos de acceso
de sus menús. Es posible utilizar esto campos para definir una condición de habilitación con
el fin de acceder al contenido de la página (si la condición no es respetada, el menú aparece en
gris).
Generalmente las habilitaciones son definidas de la manera siguiente:
$user-> rights-> elemento-> derecho donde :

Elemento : corresponde a un módulo de Dolibarr (presupuesto, encargo(mando), proyecto)

Derecho : corresponde a la habilitación sobre el módulo (lira, ecrire, definir parámetros)

Por ejemplo para autorizar el acceso únicamente a los usuarios que tienen acceso en lectura a
las propuestas comerciales hay que entrar:

$user-> rights-> propale-> leer

Para localizar la habilitación que se desea utilizar, un truco es entrar en el fichero de

configuración del módulo de gestión de esta habilitación.

Gestión de los ficheros de traducciones en Dolibarr

Con el fin de hacer más explícito los nombres de variable en el momento de su entrada y las
cabeceras de columnas sobre los cuadros, es posible utilizar los ficheros de traducciones
Basta con añadir uno o varios nombres de ficheros de lenguas separado por un #.
Si el fichero de lang no es depositado en el la carpeta del core de Dolibarr, hay que aumentar
@nomdumodule a éste.

Los dos modos de visualización de listas personalizadas

MyList permite mostrar las listas bajo dos formatos:

• El formato clásico (como otras listas de Dolibarr)

• El formato avanzado (formato y funcionalidades vinculadas al plug-in jquery
datatables)

Por defecto el modo mostrado es el formato clásico, para activar el formato avanzado, hay que
añadir en los parametrajes diversos el parámetro MAIN_USE_JQUERY_DATATABLES y
darle el valor " 1 "

5
Présentation du module myList

Los menús del módulo

Es a partir de los menús del módulo que se configura myList. Éstos son accesibles a partir del
espacio de las Herramientas

• « Mis Listas » permite mostrar la lista de las listas definidas en su entorno (aunque no
fueran activas). Haciendo clic en el título de la página, podemos visualizar la lista.
Este pantalla es muy útil en el momento del desarrollo de una lista que no es todavía
activa. Es sin embargo preferible someter a un test estas listas sobre un entorno de
prueba, y luego utilizar la función de importación / exportación para ponerla en
producción.

• « Nueva Lista personalizada » permíte crear una lista personalizada. La creación de

una página será presentada en otro capítulo,

• « Mis listados » muestra una lista de listas en su entorno. El enlace en el principio de

la línea permite ver los detalles de la lista.

• « Importar lista » Por último, esta página permite utilizar archivos XML para
transferir una lista directamente en su entorno. Veremos cómo funciona y el formato
del archivo XML en otro capítulo.

6
Présentation du module myList

Creación de una nueva lista.

La creación de una lista se divide en dos etapas:
• La creación de la lista, y en particular, su posición
• La creación de campos para mostrar en la lista
Esta pantalla permite definir una nueva lista dinámica.

Código: es el código único de la lista

Texto: es el título de la lista

Título del menú: es el título del enlace que aparece en el menú. Si no se entra este campo, el
texto de la lista se usa como el título del menú (Cuidado con la longitud)

Menú principal y menú secundario: Establece la posición del menú, Si ambos campos están
en blanco, el menú no se mostrará en los menús pero va a estar presente en la lista del menú
“Mis Listas”.

Habilitación: Permíte establecer derechos de acceso de la lista y, en particular a sus menú. Si

no se introduce este campo, la página sigue siendo accesible,

Tab en el elemento: Para que aparezca la lista entre las pestañas del tercero o producto

Archivo de idioma: permite incluir las bibliotecas de idiomas para hacer ajustes multilingües.

Autor: Establece el autor de la página. Una vez introducido, esta área ya no es editable,

Consulta la lista: Cpermíte definir una parte de la consulta SQL utilizada por myList para ver
los datos necesarios para la tabla

Consultas de procesamiento: Establece la consulta SQL utilizada para el tratamiento factible

de las líneas seleccionadas. Esta operación se explicará más adelante en el documento.

Campos personalizados por defecto: define un conjunto de variables utilizadas por la

solicitud de los campos pre-filtro que no se visualizan

7
Présentation du module myList

Creación de campos en una lista

Una vez registrada la lista dinámica, entonces es posible añadir campos.

Estos campos deben estar presentes en las tablas de la consulta SQL de la lista

Para crear nuevo campos, basta con hacer clic en el botón [nuevo Campo] abajo de la página.
Es posible modificar un campo haciendo clic en el enlace de la primera columna.
Es posible cambiar la orden de los campos en la lista utilizando la reja en fin de línea
La importación / Exportación del parametraje de la lista serán explicados en otro párrafo

8
Présentation du module myList

Introducción de un campo

Esta página permite crear un campo que se mostrará en la lista personalizada

Nombre del campo: se trata del nombre del campo en el sentido basa de datos, es preferible
precisar el nombre de la tabla, en particular las llaves de tabla (ex: f.rowid si se trata de la
llave de la tabla de facturación)

Alias: se trata del alias del campo en el sentido base de datos. Esta alias no es necesario.

Nombre: es el texto que será utilizado como título sobre la columna de la lista personalizada
para este campo. Este texto es vinculado con ficheros de traducción, lo que permite si hay una
referencia a éste en un fichero .lang mostrar el contenido (ex: utilización de OrderDate como
nombre de campo, mostrar « fecha encargo » en el cuadro)

Tipo y ElementField: especifica el tipo de datos del campo. Un capítulo es dedicado a estos
parámetros más lejos.

Alineación: permíte escoger la alineación de los datos de la columna (derecha, izquierda,

centrado)

Activo y visible: permite definir cómo el campo es utilizado en la lista

• si es activo y visible directamente será mostrado sobre la lista
• si es activo pero no visible, no será mostrado pero será posible seleccionarlo a partir
de la lista de los campos disponibles.
• si no es activo: no será visible ni seleccionable en la lista.

Filtrable: este último parámetro permite indicar si se desea autorizar o no el filtrado de esto
campos

9
Présentation du module myList

Ajuste de los diferentes tipos de campos

La definición de de ajuste campos sigue ciertas lógicas de definición de campos adicionales

(extrafields) nativamente presentes en Dolibarr, este ajuste actúa principalmente en el modo
de filtrado, sino también en el método de la clasificación y el formato en la tabla

Formato específico de Campos

3 campos tienen un formato específico

• Precio: muestra un número en el formato definido en la precisión Dolibarr
• Fecha: Muestra una fecha con el formato "día"
• Boolean Muestra un sí o un no en la línea celular

Campos que tienen una zona simple de texto como zona de filtración

Texto Modo de filtrado de texto:

Selecciona las líneas cuyo campo contiene el texto introducido en el área de filtro
(corresponde a LIKE SQL)

Fecha modo de filtrado por fecha:

• Entrar “2008” devolverá todas las fechas de 2008 a 1,1 31/12 incluido
Entrar "2006-2009" devolverá todas las fechas desde 01/01/2006 hasta 31/12/2009
incluido
Entrar “> 2004” devolverá todas las fechas anteriores (o =) 01.01.2004
Entrar “<2004” devolverá todas las fechas a continuación (o =) 31/12/2004
para delimitar a una fecha que incluye el mes, tomemos por ejemplo: 200604
para delimitar a una fecha que incluye un día entrar por ejemplo: 20060401

Duree, Number, Sum, Price Modo de filtrado digital:

• Entrando "<200000" devolverá los números <= 200000 y
• Entrando 200000-300000" devolverá 200000-300000 incluido

Boolean, List Statut Modo de filtrado por lista desplegable

En el caso de un filtro booleano, tres valores son seleccionables en la lista:
• vacío: el campo no se filtra
• verdadero : valores de entrada selección verdaderos a “true”
• Falso: la selección de valores de entrada a “false”
En los demás casos, depende de la configuración del campo adicional

Nota:
Un área al formato "Check" no es filtrable

10
Présentation du module myList

Caso particular: la gestión de claves específicas (rowid, fk_statut)

Campos ROWID
Los campos rowid tienen un funcionamiento especial en myList, parámetros asociados en
elementfields, pueden crear un enlace al artículo que ellos son la clave

Haciendo un campo seleccionable es probablemente el problema más complejo porque

involucra myList entender un poco la arquitectura Dolibarr

Todas primero es necesario identificar los directorios Dolibarr donde la clase del elemento
que desea llamar y cómo se le llama en el archivo

Si uno desea hacer se puede hacer clic, por ejemplo una orden de compra, hay que encontrar
el archivo de clase asociado a este material (/fourn/class/fournisseur.commande.class.php)
luego ver el nombre de la clase de objeto (CommandeFournisseur) .

campos Fk_statut
Los campos fk_statut se utilizan para conocer el estado de un elemento, sin embargo, el
número y tipo de estado es único para cada elemento. Hay que agregar Las opciones
seleccionables a los parámetros adicionales de los campos. Tal como para el rowid, se debe
identificar la clase utilizada para definir el elemento, y agregar los estados que se desea
utilizar separandolos con un #

11
Présentation du module myList

Funciones presentes en la lista estándar

Por defecto myList muestra las listas generadas en el mismo formato de presentación que
Dolibarr.

Este formato es compatible con navegadores más antiguos incompatibles con jQuery utilizado
en la versión avanzada para definir la lista.

Filtrado

Las funciones de filtrado retoman el funcionamiento de los campos de filtrado presente en el

módulo de exportación de la versión 3.3

Una lista de comprobación (tooltip) está disponible junto a la zona de filtro para los campos
con capacidades avanzadas de filtrado.

12
Présentation du module myList

Funciones presentes en la lista avanzada

Este formato utiliza una lista de jQuery plug-in llamado DataTables.
Puede encontrar más información sobre el mismo en la siguiente dirección:
http://datatables.net/

Para activar este modo, debe introducir en los diversos ajustes de Dolibarr la variable
MAIN_USE_JQUERY_DATATABLES y asignarle un valor de 1 (0 desactiva la función)

Limitación del número de registros mostrados

Con fin de no sobrecargar el servidor, myList devuelve un número limitado de líneas por
defecto si no hay filtrado de entrada (al principio de la página).
El número de líneas se define por

Selección de campos para mostrar / ocultar

A la apertura de la lista, solo los campos definidos como visibles aparecen en la tabla. Se
puede seleccionar otros campos definidos para hacerles también aparecer o no mostrar otros
campos

Líneas y paginación
Se uede cambiar el número de líneas de la tabla mostradas en pantalla. En la parte inferior de
la tabla se encuentra un conjunto de botones de ajuste para moverse por la tabla por
paginación

Desplazamiento de columnas
Se puede cambiar el orden predeterminado de paginación de la tabla,

Exportación
El plug-in DataTables permite utilizar funciones de exportación bajo diferentes formatos,

13
Présentation du module myList

Funcioness avanzadas de myList

Uso de los campos de parámetros

myList permite agregar filtros adicionales en una lista. Para esto, es posible definir variables
utilizables en la lista de consultas.

Los parámetros de escritura son los siguientes:

Valor1 = 1000 # valor2 = 2013
• Si hay varios parámetros estarán separados por un signo (#)
• El orden de entrada del parámetro determina su orden de visualización
• El valor introducido después del signo igual se utiliza como valor predeterminado

Filtrado por el usuario

En ciertos típos de listas, puede que tenga que mostrar sólo las filas que coinciden con el
usuario que las accede. Para ello, es posible utilizar en la consulta SQL parámetro # USER #
que será sustituido por la clave del usuario conectado

Importación / exportación de la página myList

myList tiene una función para importar y exportar a XML

Esta característica permite compartir una página, pero también permite transferir una página
entre dos entornos (como una página desarrollada en un entorno de prueba e instalada en un
entorno de producción).

Para exportar una página, sólo tiene que ir hasta él y pulse el botón:
[Configuración de importación / exportación]

La pantalla proporciona un área que contiene la transcripción de la página mylist y las tablas
presentes en él en formato XML.
Para importar una nueva página simplemente basta con acceder al menú 'Importar Lista' y
pegarlo en el cuadro de entrada del contenido del archivo XML....

14
Présentation du module myList

Uso de myList en pestañas

Gestión de acciones en lcampos seleccionables

15
Présentation du module myList

Creditos
Autor : Charles-François BENKE
Corrector : Romain DESCHAMPS
Traductor : Abbes Bahfir

Contactos : charles.fr@benke.fr - romain.deschamps@live.fr - bafbes@gmail.com

Historial de modificaciones
Versión Fecha Commentario

1.0.6 Diciembre 2013 Primera versión pública

1.1.1 Enero 2014 Mayor Evolución (tratamiento y tabulación)

16