1 BPMS 2 Intranet 3 Document Management 4 Content Management 5 Online Commerce 6 Business Rules Integración Servicios Web. Tomo 4. Obtener Datos del Panel (7 Abril 2016) Esta publicación pertenece al Servicio de Documentación de AuraPortal (SDAP) y todos los derechos están reservados. La reproducción total o parcial de este documento, así como la entrega a terceras partes sin el permiso escrito del SDAP quedan prohibidas. www.auraportal.com info@auraportal.com Skype: AuraPortal Tel: +34 962 954 497 Internacional: +18 572 390 070
ÍNDICE INTRODUCCIÓN... 3 1. PANELDATOSVER... 5 2. PANELDATOSVERGC... 8 3. PANELDATOSVERGCAFILIADO... 11 INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 2 de 12
INTRODUCCIÓN Este documento está dividido en 5 Tomos. En el Primer Tomo se incluye información General sobre los Servicios Web e información detallada sobre AURAPORTALPROCESOS y AURAPORTALTAREAS. El Segundo Tomo incluye todo lo referente a AURAPORTALDOC y AURAPORTALFAMILIAS. El Tercer Tomo contiene información sobre ejemplos de programación, ejecución de un Procedimiento Almacenado y Localización de Datos en Listas de SharePoint. Este Cuarto Tomo incluye la información necesaria para obtener datos del Panel. El Quinto Tomo incluye los Servicios Web relacionados con las Bibliotecas en Diccionario. En este documento se describe cómo obtener datos del Panel de un Proceso de AuraPortal (la forma de introducir datos a través de los Servicios Web de AuraPortal se detalla en los documentos generales de los Servicios Web). Para obtener datos del Panel de un Proceso de AuraPortal se utiliza el Servicio Web AuraPortalProcesos, y concretamente los tres métodos siguientes: PanelDatosVer. Con este método se obtienen todos los datos del panel de los Procesos de Aura- Portal incluidos los Grupos de Campos Progenitores, pero no los datos de los Grupos de Campos Afiliados. Este método está disponible desde AuraPortal v3.1. PanelDatosVerGC. Se obtienen todos los datos de los Grupos de Campos, tantos del Progenitor como de sus Afiliados. Este nuevo método está disponible a partir de AuraPortal v4.0 con el ServicePack de Octubre 2009. PanelDatosVerGCAfiliado. Similar al anterior, pero sólo muestra el registro del GC Progenitor indicado en el filtro, y todos los de sus Afiliados. Este nuevo método está disponible a partir de Aura- Portal v4.0 con el ServicePack de Octubre 2009. Estos métodos están diseñados para ser utilizados desde programas preparados a propósito, pero también es posible hacer pruebas manualmente. Para ello, dirigirse a Estructura (1) General Servicios Web Lista (2) y entrar en el Servicio Web de Sistema AuraPortalProcesos (3): INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 3 de 12
Se abrirá la página AuraPortalProcesos.asmx en donde se verá una lista de todos sus métodos: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 4 de 12
En los capítulos siguientes se comentan los tres métodos relacionados con obtener los datos del Panel, que son, PanelDatosVer, PanelDatosVerGC y PanelDatosVerGCAfiliado. Nota. Para hacer pruebas manuales con los métodos del Servicio Web, es necesario ejecutarlos directamente desde el propio servido de AuraPortal o desde una sesión remota (Terminal Server o similar). De lo contrario, los campos para introducir datos no estarán disponibles. 1. PANELDATOSVER Con el método PanelDatosVer se obtienen todos los datos del panel de los Procesos de AuraPortal incluidos los Grupos de Campos Progenitores, pero no los datos de los Grupos de Campos Afiliados. Estos se obtienen con PanelDatosVerGC y PanelDatosVerGCAfiliado. Al pulsar sobre la línea PanelDatosVer se abrirá la página siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 5 de 12
En el parámetro RefBase introducir la Referencia Base del Proceso del que se desean obtener todos sus datos del Panel. La Referencia Base de un proceso puede obtenerse desde muchas opciones de AuraPortal, por ejemplo desde el Grid de tareas. En este ejemplo, utilizaremos la Referencia Base -50.1_1: Al introducir la Referencia Base en el campo RefBase del método PanelDatosVer y pulsar sobre el botón Invocar, se obtendrá un fichero XML con todos los datos del panel, por ejemplo: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 6 de 12
Los datos del panel se muestran en el nodo XML <PanelDatosVer> (recuadrado en rojo en la imagen anterior). INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 7 de 12
Se pueden ver todos los campos en formato DataTable con pares Clave-Valor, uno tras otro. Veamos, por ejemplo, el campo 6_Facturas, que es un Grupo de Campos. Este mismo se vería así desde el formulario de la tarea: Nótese que desde el Servicio Web se obtienen todos los campos, estén o no mostrados en formularios. La columna Albaranes es un Grupo de Campos Afiliado, y en el Servicio Web sólo se muestra su nombre con el siguiente formato, pero no sus líneas: 6_Albaranes===GC_Afiliado Para ver sus líneas hay que utilizar los otros dos métodos, PanelDatosVerGC y PanelDatosVerGCAfiliado. 2. PANELDATOSVERGC Con el método PanelDatosVerGC se obtienen todos los datos de los Grupos de Campos, tantos del Progenitor como de sus Afiliados. Este método está disponible a partir de la v4.0 de AuraPortal con el ServicePack de Octubre 2009. Al pulsar sobre PanelDatosVerGC, Se abrirá una ventana como la siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 8 de 12
Los tres parámetros son: RefBase. Es obligatorio. Igual que en el método anterior, introducir la Referencia Base del Proceso del que se desean obtener todos sus datos del Panel. NombreGC. Es obligatorio. Hay que introducir el nombre del Grupo de Campos. Este nombre se puede obtener del método PanelDatosVer, omitiendo el código del tipo de campos y el guión, es decir Facturas y no 6_Facturas. Formato. Es opcional. Hace referencia al formato del documento XML que se devolverá con todos los datos. Hay dos posibilidades: - 1. Si se introduce el número 1, el formato del XML que se devolverá será del mismo tipo que el PanelDatosVer, es decir, en formato DataTable con pares Clave/Valor. - Distinto de 1 (incluyendo vacío o 0). También devolverá un documento XML en formato DataTable, pero en registros en lugar de pares Clave/Valor, más cómodo de utilizar con herramientas de programación. Siguiendo con el ejemplo anterior, el Grupo de Campos Afiliado Albaranes se vería desde el Formulario de esta manera: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 9 de 12
Y desde el método PanelDatosVerGC, se vería de esta forma: INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 10 de 12
En la imagen anterior solo se muestra el primer registro del Grupo de Campos Progenitor (recuadrado en rojo) incluidos los dos registros del Grupo de Campos Afiliado (recuadrados en azul). El fin del primer registro está indicado con Campo/Valor Fin de Registro /, y a continuación se mostraría el segundo registro y así sucesivamente. 3. PANELDATOSVERGCAFILIADO El método PanelDatosVerGCAfiliado es similar al anterior, pero sólo muestra el registro del GC Progenitor que se indique en el filtro (incluyendo todos los de sus Afiliados). Este método está disponible a partir de la v4.0 de AuraPortal con el ServicePack de Octubre 2009. Al pulsar sobre PanelDatosVerGCAfiliado, Se abrirá una ventana como la siguiente: Los cuatro parámetros son: RefBase. Es obligatorio. Igual que en el método anterior, introducir la Referencia Base del Proceso del que se desean obtener todos sus datos del Panel. NombreGC. Es obligatorio. Hay que introducir el nombre del Grupo de Campos. Este nombre se puede obtener del método PanelDatosVer, omitiendo el código del tipo de campos y el guión, es decir Facturas y no 6_Facturas. IdRegistro. Es obligatorio. Hay que indicar el <IdRegistro> del Grupo de Campos Progenitor del que se quieren obtener sus datos. Este valor puede obtenerse desde los dos métodos anteriores. INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 11 de 12
Formato. Es opcional. Hace referencia al formato del documento XML que se devolverá con todos los datos. Hay dos posibilidades: - 1. Si se introduce el número 1, el formato del XML que se devolverá será del mismo tipo que el PanelDatosVer, es decir, en formato DataTable con pares Clave/Valor. - Distinto de 1 (incluyendo vacío o 0). También devolverá un documento XML en formato DataTable, pero en registros en lugar de pares Clave/Valor, más cómodo de utilizar con herramientas de programación. INTEGRACIÓN. SERVICIOS WEB. TOMO 4. OBTENER DATOS DEL PANEL Página 12 de 12