Servicios Web AuraPortal (SOA)

Transcripción

1 1 BPMS 2 Intranet 3 Document Management 4 Content Management 5 Online Commerce 6 Business Rules Manual Servicios Web AuraPortal (SOA) Tomo 1 (1 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. info@auraportal.com Skype: AuraPortal Tel: Internacional:

2 ÍNDICE 1. GENERALIDADES DE LOS SERVICIOS WEB (SOA) LENGUAJES DE PROGRAMACIÓN DESCRIPCIÓN Y USO DE LOS SERVICIOS WEB (WSDL) Servicios Web de SharePoint Servicios Web Personalizados de AuraPortal Servicios Web de Sistema de AuraPortal SERVICIOS WEB PERSONALIZADOS DE AURAPORTAL IMPERSONACIÓN PARA SERVICIOS WEB SERVICIOS WEB DE EVENTOS DE MENSAJE (INICIO E INTERMEDIO) Introducción Manual de Datos o a través de Programas Externos Nombre Interno del Término Formato del Campo Datos Formato de los Campos de Selección Múltiple Formato de los Campos de Familia Formato de los Campos de Documentos Formato de los Grupos de Campos Tabla Resumen PARTICULARIDADES DE LOS EVENTOS DE MENSAJE INTERMEDIOS Eventos de Mensaje Intermedios Patrón SERVICIO WEB AURAPORTALPROCESOS.ASMX FUNCIONALIDAD CONEXIÓN MÉTODOS Buscar Clase de Mensaje de Inicio (MensajeClaseBuscar) Crear Mensaje de Inicio (MensajeInicioCrear) Buscar Mensaje de Inicio (MensajeBuscar) Buscar Proceso por su Mensaje de Inicio (ProcesoIDBuscarxMensaje) Consulta de Tiempos (ConsultaTiemposBuscar) Ver Datos del Panel de un Proceso (PanelDatosVer) Ver Tipo de Campos del Panel de una Clase de Proceso (PanelTipoCamposVer) Enlazar una URL en Documentos del Panel de Proceso (PanelDocEnlazarURL) Integrar Documento en Panel de Proceso (PanelDocIntegrar) Integrar Documento según ID (PanelDocIntegrarxID) Obtiene valores de etiquetas de Biblio. en Diccionario (PanelDocIntegradoMetadataArray ) Ver ID y Naturaleza de las Reglas de Negocio (ReglasNegocioBuscar) Obtener datos de las Reglas de Negocio (ReglasNegocioDatosVer) Obtener todas las tareas de un empleado (GetTasksByEmployee) Obtener datos de la duración del Proceso SERVICIO WEB AURAPORTALTAREAS.ASMX CONEXIÓN MÉTODOS INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 2 de 102

3 Crear Tareas Libres (CreateTareaLibre y CreateTarea) Modificar Tareas (UpdateFichaTarea) Cursar Tareas Programadas a un Cargo (ProcessTareaGUID) Cursar tareas Programadas a un Empleado (ProcessTareaID) Devolver Tareas Programadas (RejectTarea) Enviar Tareas Libres por Cargo (SendTareaGUID) Enviar Tareas Libres por Persona (SendTareaID) Terminar Tareas (EndTarea) Eliminar Tareas (DeleteTarea) Ver ID de Tareas (GetIdTarea) Ver Datos de Tareas (GetFichaTarea) Integrar Documentos a una Tarea (IntegrateDoc) Asociar URL a una Tarea (LinkDoc) Enlazar Empleados en una Tarea (LinkEmpleado) Enlazar Tareas en otra Tarea (LinkTarea) Enlazar Cuentas en una Tarea (LinkCuenta) Enlazar Ítems en una Tarea (LinkItem) Enlazar Proyectos en una Tarea (LinkProyecto) Enlazar Áreas en una Tarea (LinkAmbito) Ver Empleados Enlazados a una Tarea (GetEmpleadosEnlazados) Ver Tareas Enlazadas a una Tarea (GetTareasEnlazadas) Ver Cuentas Enlazadas a una Tarea (GetCuentasEnlazadas) Ver Ítems Enlazados a una Tarea (GetItemsEnlazados) Ver Proyectos Enlazados a una Tarea (GetProyectosEnlazados) Ver Áreas Enlazadas a una Tarea (GetAmbitosEnlazados) Ver Costes o Ingresos de Tareas (GetCostesTarea y GetIngresosTarea) Introducir Costes o Ingresos en Tareas (CreateCosteTarea y CreatetIngresoTarea) Eliminar Costes o Ingresos de Tareas (DeleteCosteTarea y DeleteIngresoTarea) Ver Costes e Ingresos a Exportar (GetItemExport_ ) Marcar Costes o Ingresos como Exportados (SetItemExported_ ) INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 3 de 102

4 1. GENERALIDADES DE LOS SERVICIOS WEB (SOA) Este documento está dividido en 5 Tomos. Este 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. En 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. El 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. AuraPortal está diseñando siguiendo los estándares de integración de sistemas basados en SOA (Service Oriented Architecture). La mayoría de información de AuraPortal está accesible a través de Servicios Web. Los Servicios Web son, en definitiva, una manera sencilla y universal de interconectar AuraPortal con programas externos. A través de estos, se pueden realizar las mismas funciones que un usuario realiza directamente desde la interfaz de AuraPortal. Se puede, por ejemplo, iniciar un flujo de aprobación en AuraPortal cuando suceda un evento determinado en otro programa de la empresa, o crear cuentas de clientes automáticamente, o facturar en el ERP obteniendo los datos necesarios de AuraPortal, etc. Este documento proporciona información sobre los métodos y parámetros necesarios para diseñar programas que conecten con los Servicios Web de AuraPortal, incluidos ejemplos realizados con Visual Basic 6 y Visual Studio.Net con el código fuente disponible. En AuraPortal distinguimos tres tipos de Servicios Web: SERVICIOS WEB DE SHAREPOINT: Son Servicios Web proporcionados por defecto en SharePoint para todas sus Listas y Bibliotecas. SERVICIOS WEB PERSONALIZADOS DE AURAPORTAL: Son Servicios Web que se diseñan a medida en cada instalación para los Eventos de Mensaje de Inicio e Intermedios, y para el alta de Roles Personales. SERVICIOS WEB DE SISTEMA DE AURAPORTAL: Son Servicios Web diseñados a propósito para AuraPortal, e incluidos por defecto en la Estructura Inicial de la instalación. Estos Servicios Web facilitan el uso de ciertas acciones concretas que sería complicado o imposible realizar con los Servicios Web genéricos de SharePoint. El presente documento muestra información genérica sobre los Servicios Web de SharePoint y todos los detalles sobre los específicos de AuraPortal Lenguajes de Programación En general se puede utilizar cualquier lenguaje de programación que permita acceder a Servicios Web: Con herramientas.net, como por ejemplo C#, Visual Basic.NET, es sencillo. Con Visual Basic 6 también es posible, si bien algo más laborioso. En este caso es recomendable conexión vía XML con SOAP al Servicio Web. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 4 de 102

5 Nota. Se pueden encontrar ejemplos de programación en la biblioteca de Programas del Portal Externo Descripción y uso de los Servicios Web (WSDL) La descripción de los Servicios Web está especificada según el estándar WSDL (Web Service Description Language). En el WSDL se puede ver cómo está estructurado un Servicio Web y qué parámetros requiere, en definitiva, cómo utilizarlo. Adicionalmente, en este documento se describen más detalles para facilitar su uso. Para obtener el WSDL de cada Servicio Web, antes tenemos que localizar su página.asmx, lo que se explica a continuación: Servicios Web de SharePoint Los Servicios Web de SharePoint están localizados en la siguiente trayectoria: URL a través de Internet Explorer: ( host.dominio.com depende de cada instalación) Directorio de instalación en el servidor de AuraPortal: C:\Archivos de programa\archivos comunes\microsoft Shared\web server extensions\14\isapi (para SharePoint 2010) Nota. En otras versiones de SharePoint puede haber ligeras diferencias. Por ejemplo, la ubicación de los Servicios Web puede ser diferente. Los Servicios Web de SharePoint Services disponibles por defecto son los siguientes: Alerts.asmx Authentication.asmx Copy.asmx diagnostics.asmx DspSts.asmx DWS.asmx Forms.asmx Imaging.asmx Lists.asmx Meetings.asmx People.asmx Permissions.asmx INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 5 de 102

6 SharedAccess.asmx sharepoint ws.asmx SiteData.asmx Sites.asmx spsearch.asmx UserGroup.asmx Versions.asmx Views.asmx Webpartpages.asmx Webs.asmx Para ver uno de ellos, por ejemplo el Lists, en el navegador Internet Explorer teclear la URL siguiente, ( host.dominio.com depende de cada instalación) y se obtendrá la siguiente página con la lista de métodos del Servicio Web lists.asmx de SharePoint: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 6 de 102

7 Al pulsar sobre el link descripción de servicios (o añadiendo?wsdl a la URL) obtendremos la descripción del Servicio Web o WSDL (Web Service Description Language) en formato XML, en este caso: Y si en la página.asmx del Servicio Web pulsamos sobre uno de los métodos, tendremos el esquema de cómo utilizarlo. Por ejemplo, si pulsamos sobre AddAttachment veremos la siguiente información: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 7 de 102

8 En el <soap:body> podemos ver que para utilizar el método AddAttachment del Servicio Web Lists de SharePoint, hay que introducir los siguientes datos: <listname> : String para el nombre de la lista en donde queremos adjuntar el fichero. <listitemid> : String para el ID del Ítem de la lista en donde queremos adjuntar el fichero. <filename> : String para el nombre del documento que queremos adjuntar. <attachment> : base64binary para Datos del fichero que queremos adjuntar en formato base64binary. Se puede diseñar un sencillo programa que utilice estos valores para adjuntar documentos en una lista determinada. Como muestra de cómo se puede diseñar un programa utilizando Servicios Web, se pueden consultar varios ejemplos de programación en la Biblioteca de Programas del Portal Externo. Nota. En la URL se puede encontrar más información sobre los Servicios Web de SharePoint Servicios Web Personalizados de AuraPortal Como se verá en este documento, los Servicios Web Personalizados de AuraPortal se crean desde los formularios de Eventos de Mensaje, tanto de Inicio como Intermedios, y quedan guardados en la siguiente trayectoria: URL a través de Internet Explorer: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 8 de 102

9 ( host.dominio.com depende de cada instalación y PaginaWebService.asmx del nombre dado a cada Servicio Web) Directorio de instalación por defecto en el servidor de AuraPortal (depende de cada instalación): c:\inetpub\sitioauraportal\ws Se puede ver la lista de los Servicios Web de AuraPortal desde la opción Estructura General Servicios Web Lista: El botón Reconstruir Servicios Web crea los ficheros.asmx en el directorio \WS correspondientes a los Servicios Web de Mensajes de Inicio e Intermedios de Clases de Proceso de AuraPortal y resuelve y guarda en base de datos las URL relativas de dichos Servicios Web. El botón Reconstruir WDSL, además, elimina los ficheros.wsdl de Mensajes de Inicio e Intermedios y crea de nuevo los ficheros.wsdl de Mensajes de Inicio e Intermedios, basándose directamente en los ficheros.asmx existentes. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 9 de 102

10 Además de los Servicios Web de Sistema (señalados con el número (3) en la imagen) que están incluidos por defecto en una instalación de AuraPortal, también se muestran los creados a medida por el usuario para los Eventos de Mensaje (4) y Roles Personales (5). Pulsando sobre cualquiera de ellos se accederá a su página.asmx de entrada Servicios Web de Sistema de AuraPortal Los Servicios Web de Sistema de AuraPortal están por defecto en cualquier instalación, localizados en la siguiente trayectoria: URL a través de Internet Explorer: (host.dominio.com depende de cada instalación, y NombreServicioWeb.asmx del nombre de cada Servicio Web). Directorio de instalación por defecto en el servidor de AuraPortal (depende de cada instalación): c:\inetpub\sitioauraportal\home\webservice Los Servicios Web de Sistema de AuraPortal disponibles son los siguientes: AuraPortalProcesos: Servicio Web para manejar Procesos de AuraPortal (datos del Panel, Documentos, Eventos de Mensaje, ). AuraPortalTareas: Servicio Web para manejar Tareas Libres de AuraPortal, por ejemplo Leer, Crear, Cursar, Modificar, Terminar, Eliminar Tareas Libres, manejar Costes e Ingresos, etc. AuraPortalDoc: Servicio Web para manejar documentos y Anexos en AuraPortal, por ejemplo, para ingresar, enlazar y leer documentos en Bibliotecas, Fichas y Anexos de cualquier elemento de todas las Familias de AuraPortal. Por ejemplo, este Servicio Web lo utiliza la AuraPortal Ingresador, programa incluido en las Utilidades de AuraPortal, con el que se facilita el ingreso de documentos y correos en AuraPortal desde Windows, Word, Excel y Outlook. AuraPortalDiccionarioTerminos: Servicio Web para manejar Términos de Diccionario. De momento únicamente tiene 4 métodos, todos enfocados al manejo de los Campos de Selección Simple. Son los siguientes: - SeleccionSimpleVer: Para ver los Términos de Selección Simple y sus Opciones. Tiene un único parámetro, Nombre, donde se le indica el Nombre o parte del Nombre del Término y devuelve todos los Términos de Selección Simple que cumplen la condición de filtrado con su ID, y sus Opciones. - SeleccionSimpleCrearOpciones: Para crear nuevas Opciones en un Campo de Selección Simple. Tiene dos parámetros, IdTermino y Nombre, donde se indica el ID obtenido con SeleccionSimpleVer y el Nombre de la nueva Opción que se desea crear. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 10 de 102

11 - SeleccionSimpleEditarOpciones: Para modificar Opciones ya existentes en un Campo de Selección Simple. Tiene dos parámetros, IdOpcion y Nombre, donde se indica el ID obtenido con SeleccionSimpleVer y el nuevo Nombre que se desea para la Opción indicada. - SeleccionSimpleEliminarOpcion: Para eliminar Opciones de un Campo de Selección Simple. Tiene un único parámetro, IdOpcion, donde se le indica el ID de la Opción que se desea eliminar, obtenido con SeleccionSimpleVer. Si es un Término en uso en algún formulario devolverá un código de error -8 y no se eliminará. - SeleccionSimpleEliminarTermino: Para eliminar Términos de Selección Simple. Tiene un único parámetro, IdTermino, donde se indica el ID del Término que se desea eliminar, obtenido con SeleccionSimpleVer. Si es un Término en uso en algún formulario devolverá un código de error -8 y no se eliminará. AuraPortalFamilas: Servicio Web para manejar elementos del resto de familias de AuraPortal (Empleados, Cuentas, Proyectos, Ítems y Áreas). Con este Servicio Web se puede Crear, Ver, Modificar o Eliminar cualquier elemento. AccionBell: Servicio Web que utiliza el programa Avisador (antes llamado Acción Bell). Tanto si se entra en el Servicio Web seleccionándolo desde Estructura General Servicios Web Lista, como tecleando directamente la URL en el navegador de Internet, se abrirá su página.asmx, que por ejemplo, en el caso de AccionBell sería la siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 11 de 102

12 Este sencillo Servicio Web, diseñado para la utilidad Avisador de AuraPortal, lee el número de tareas pendientes de leer o de abrir de un usuario determinado. Veamos cómo funciona. Al pulsar sobre el link descripción de servicios (o añadiendo?wsdl a la URL) se obtendrá la descripción de este Servicio Web o WSDL (Web Service Description Language) en formato XML. Al pulsar sobre los distintos métodos se verán los detalles de cada uno. Por ejemplo: Al pulsar sobre el método MisPortales: Nota. El parámetro UserName, sólo está disponible para la introducción manual si se está operando desde el propio servidor. En caso contrario, en lugar del campo aparecerá el mensaje: El formulario de prueba sólo está disponible para solicitudes del equipo local. Como se muestra en la sección <soap:body> en la imagen, el único parámetro requerido es el <UserName> (nombre de usuario) en formato string. Este se puede teclear a mano en la casilla UserName, si se ha abierto desde el propio servidor. Por ejemplo, al escribir el nombre empleado01 y pulsar el botón Invocar, el sistema devolverá el ID del Portal en donde este usuario tiene permisos, en este caso -1, que es el portal de Empleados (los ID de los portales Externos tienen número positivo): INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 12 de 102

13 Al pulsar sobre el método TareasNuevasPortal, Este método tiene dos parámetros: <UserName>: Es el nombre de usuario en formato string, igual que el otro método, MisPortales. <IdPortal>: Es el ID del Portal en formato string, que ha sido obtenido con el método anterior, MisPortales. Ambos parámetros se pueden introducir manualmente si la página se ha abierto desde el servidor. Por ejemplo, al teclear el nombre empleado01 en UserName y el ID del portal -1 en IdPortal, se obtendrá número de tareas pendientes de leer (rango 0) de este usuario, 12 en este ejemplo: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 13 de 102

14 De la misma manera se puede conocer cómo funcionan todos los Servicios Web. Para mejor comprensión de los Servicios Web, en los siguientes Capítulos se detallan en profundidad los Personalizados y los de Sistema de AuraPortal. 2. SERVICIOS WEB PERSONALIZADOS DE AURAPORTAL Los Servicios Web Personalizados de AuraPortal se crean a propósito en cada instalación para los Eventos de Mensaje de Inicio e Intermedios y para el alta de Roles Personales. Combinando estos Servicios Web personalizados con las Tareas de Sistema de Tipo Desviador e Invocador se puede realizar, por ejemplo, lo siguiente: Entre procesos de AuraPortal: a) Desde un Proceso A de AuraPortal, desviar la corriente a otro Proceso B para Iniciarlo (creando su Evento de Mensaje de Inicio). b) Desde un Proceso A de AuraPortal, crear un Evento de Mensaje Intermedio del Proceso B. c) Intercambio de datos entre diferentes Procesos de AuraPortal. Entre AuraPortal y Programas externos: d) Desde programas externos, Iniciar Procesos de AuraPortal. e) Desde programas externos, crear Eventos de Mensaje Intermedios de Procesos de AuraPortal. f) Intercambiar datos entre Procesos de AuraPortal y programas externos. g) Dar de alta Roles Personales desde programas externos. En la imagen siguiente se muestra un diagrama con un ejemplo de los puntos a), b) y c): INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 14 de 102

15 A continuación se muestran los detalles de cómo crear los Servicios Web personalizados para los Eventos de Mensaje de AuraPortal, tanto de Inicio como Intermedios. Posteriormente también se muestra cómo crear los de Roles Personales Impersonación para Servicios Web Para invocar Servicios Web en tareas de Sistema DESVIADOR y crear Servicios Web en Eventos de Mensaje de Inicio o Intermedios se necesita utilizar un Login con los permisos y características necesarias. En la siguiente imagen se muestran dichas condiciones. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 15 de 102

16 A esta ventana se accede desde Estructura Servicios Web Acceso Servicios Web de Eventos de Mensaje (Inicio e Intermedio) Cualquier Evento de Mensaje de una Clase de Proceso de AuraPortal puede publicarse como Servicio Web, tanto si es Evento de Mensaje de Inicio como Intermedio. Todas las explicaciones de este apartado son comunes para los Eventos de Mensaje de Inicio e Intermedio, si bien este último tiene alguna particularidad que se comentará en el capítulo correspondiente. Para publicar un Evento de Mensaje como Servicio Web, basta con dirigirse a la página de configuración del evento (dentro de la configuración de la Clase de Proceso), marcar la casilla Servicios Web situada en el panel COMPORTAMIENTO ACTIVADO POR: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 16 de 102

17 Después de pulsar el botón Guardar, se habilitará el ojo configurador. Pulsarlo para configurar el Servicio Web como se indica a continuación: Nota. En un Servicio Web publicado para un Evento de Mensaje sólo estarán disponibles los campos que estén en el Formulario. Sólo se podrán introducir datos desde Tareas de Sistema de tipo Desviador o desde programas externos en estos campos. Aunque un campo se haya configurado como obligatorio en el formulario, desde el Servicio Web puede omitirse. Al pulsar sobre el icono ojo se abrirá una ventana como la siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 17 de 102

18 Configurar las opciones como sigue: Nombre Servicio Web: Será el nombre con el que se publicará el Servicio Web. Con este nombre se creará una página.asmx (entrada al Servicio Web) en la carpeta \WS del Sitio Web donde esté instalado AuraPortal. No es necesario que este nombre coincida con el del Formulario del Evento de Mensaje al que pertenece. Descripción: No es obligatorio. URL: Se rellenará automáticamente con la ubicación del Servicio Web cuando se pulse el botón Guardar. La trayectoria siempre es donde aura.portal.com depende de cada instalación y NombreServicioWeb.asmx depende del nombre dado en Nombre Servicio Web. Si se desea comprobar que la creación y publicación del Servicio Web ha sido correcta, pulsar el botón Test y deberá abrirse la página.asmx creada, que será aproximadamente como la siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 18 de 102

19 En esta ventana de entrada al Servicio Web sólo se verá un método, con el mismo nombre que se le ha dado al Servicio Web con un guión_de_subrayado delante, en este caso _Prueba_Servicio_Web_de_Mensaje_de_Inicio. Al pulsar sobre el método, si se hace desde el servidor, se mostrará un único parámetro genérico, llamado Datos: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 19 de 102

20 que se puede utilizar para para hacer pruebas. Sin embargo, si se pulsa sobre el método desde otro ordenador que no sea el servidor, se mostrarán los datos de SOAP pero no estará el parámetro Datos disponible para introducción manual. En su lugar aparecerá el mensaje: El formulario de prueba solo está disponible para solicitudes del equipo local. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 20 de 102

21 Nota. Una vez un Evento de Mensaje es publicado como Servicio Web, además de poder ser utilizado desde Tareas de Sistema de Tipo Desviador, también puede ser invocado desde programas externos. Es muy fácil realizar un programa con.net, Visual Basic 6, etc, que invoque estos Servicios Web. (AuraPortal proporciona ejemplos de programación con el código fuente incluido). Los detalles de cómo utilizar las Tareas de Sistema de AuraPortal están descritos en la documentación específica de Tareas de Sistema. Para la introducción a través de programas externos (o manualmente para hacer pruebas), leer el siguiente apartado. Para ver la lista de los Servicios Web de AuraPortal, tanto los Personalizados que se han ido creando por los usuarios para los Eventos de Mensaje y Contactos de Cuentas, como los de Sistema incluidos por defecto, dirigirse a la opción Estructura General Servicios Web Lista: Además de los Servicios Web de Sistema (señalados con el número (3) en la imagen) que están incluidos por defecto en una instalación de AuraPortal, también se muestran los creados a medida por el usuario para los Eventos de Mensaje (4) y los Roles Personales (5). Pulsando sobre cualquiera de ellos se accederá a su página.asmx de entrada. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 21 de 102

22 Introducción Manual de Datos o a través de Programas Externos Una vez se ha publicado un Servicio Web para un Evento de Mensaje (de Inicio o Intermedio), queda disponible para su uso desde Tareas de Sistema de Tipo Desviador y desde programas externos diseñados a tal efecto. Los detalles de configuración de la Tarea de Sistema de tipo Desviador están descritos en la documentación correspondiente. En este apartado se detalla el formato de datos que necesitan estos Servicios Web para ser introducidos desde programas externos o manualmente para hacer pruebas. Una vez ha sido publicado el Servicio Web de un Evento de Mensaje de AuraPortal (tanto de Inicio como Intermedio), sólo se podrán introducir datos en los campos que estén en su Formulario. La publicación del Servicio Web ha generado un único parámetro llamado Datos, a través del cual se pueden introducir los datos en los campos del Formulario. AUTENTICACIÓN Para invocar los Servicios Web Personalizados de AuraPortal (Eventos de Mensaje de Inicio e Intermedios, y Roles Personales), hay que utilizar un usuario que cumpla las condiciones siguientes: - Ser Empleado de AuraPortal. - No ser AdminPortal. - Pertenecer al Grupo de Windows Administradores del servidor de AuraPortal. Para que el Servicio Web entienda a qué campo del Panel pertenece cada dato que se introduzca, es necesario seguir un formato específico que básicamente es el siguiente: [[[NombreInternoTérmino:::Valor]]][[[NombreInternoTérmino:::Valor]]] Detalles: Los triples corchetes separan los diferentes campos: [[[ ]]] Para conocer el NombreInternoTérmino ver detalles más adelante. Entre campo y campo no puede haber espacios: ]]][[[ El Nombre Interno del Término y su Valor se separan con triples dos puntos : NombreInternoTérmino:::Valor El formato del Valor se detalla más adelante Nombre Interno del Término Para introducir un dato en un campo determinado, hay que conocer su Nombre Interno del Término en el Diccionario de Términos de AuraPortal. Para conocer el Nombre Interno del Término hay dos maneras, desde Formularios y a través de Servicios Web: DESDE FORMULARIOS: El Nombre Interno del Término se muestra en la LISTA DE CAMPOS SELECCIONADOS de la división, que está en el pie de la ventana de diseño de cualquier formulario de Evento de Mensaje (Inicio o Intermedio), por ejemplo: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 22 de 102

23 DESDE SERVICIOS WEB: Otra manera de conocer el Nombre Interno de los Términos es ejecutando el método PanelTipoCamposVer del Servicio Web AuraPortalProcesos. Para ello dirigirse a la opción Estructura GENERAL Servicios Web Lista - _AuraPortalProcesos PanelTipoCamposVer y se abrirá una página como la siguiente: En el parámetro RefClaseProceso hay que indicar la Referencia de la Clase de Proceso, la cual está indicada en el DataGrid de las Clases de Proceso en Estructura FAMILIAS Procesos Árbol y Clases Crear/Editar Clases, tal como se muestra en la imagen siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 23 de 102

24 Nota. La Referencia de la Clase de Proceso forma parte de la Referencia Base de un Proceso, a la que se añade el número específico de Proceso separado del signo _. Por ejemplo, para la Clase de Proceso de Referencia GEN-13.1, el primer Proceso que se inicie tendrá la Referencia Base GEN-13.1_1, el segundo GEN-13.1_2 y así sucesivamente. Por lo tanto, sabiendo la Referencia Base de cualquier Proceso se puede deducir la Referencia de su Clase de Proceso eliminando el último número y el signo _. Una vez introducida la Referencia en el campo RefClaseProceso del método PanelTipoCamposVer indicado antes, se obtendrá un fichero XML con todos los datos de los Campos de su Panel, entre ellos el Nombre Interno, tal como se muestra a continuación: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 24 de 102

25 En este ejemplo el Nombre Interno del Término es 3_Importancia Formato del Campo Datos Anteriormente ya se ha explicado que el formato de introducción de datos es el siguiente: [[[NombreInternoTérmino:::Valor]]][[[NombreInternoTérmino:::Valor]]] También se ha explicado cómo obtener el NombreInternoTérmino. En este apartado se detalla cómo introducir el Valor (dato que se quiere introducir), que requiere un formato específico. Es el siguiente: Para los términos que requieren introducción libre es simplemente el dato que se quiere introducir. Estos términos son los siguientes: Texto una Línea: Indicar el texto deseado. Texto Multilínea: Indicar el texto deseado. Texto Multilínea Rico: Indicar el texto deseado. Número Entero: Indicar el número entero deseado. Número Decimal: (El separador decimal puede ser punto o coma, pero siempre se guardará en la base de datos con coma). Hay términos cuyo valor necesita un formato específico. Son los siguientes: Fecha: Ha de ser en formato ISO 18000, esto es aaaa-mm-dd, por ejemplo Fecha y Hora: Ha de ser en formato ISO 18000, esto es aaaa-mm-dd hh:mm:ss, por ejemplo :23:00. Si no se introduce la hora, quedará como 00:00:00. Sí/No: Los valores pueden ser True o False, Sí o No y también 1 o 0. Selección Simple: En este caso es necesario indicar el ID y el Nombre de la selección separada por tres #. Un ejemplo para una hipotética selección de Importancia, que podría ser Media, cuyo ID en el diccionario es 110, sería: [[[3_Importancia:::110###Media]]] Para conocer el ID y Nombre de las opciones de Selección Simple ver detalles a continuación. CÓMO CONOCER EL ID DE LAS OPCIONES DE SELECCIÓN SIMPLE: Para conocer el ID y Nombre de las opciones de Selección Simple, hay dos maneras: DESDE DICCIONARIO: Para ver el ID de las opciones del término, entrar en él desde el Diccionario de Términos, y entrar en Opciones: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 25 de 102

26 Aparecerá la siguiente ventana: DESDE SERVICIOS WEB: Otra manera de conocer el ID de las opciones del término de Selección Simple es ejecutando el método PanelTipoCamposVer del Servicio Web AuraPortalProcesos tal como está explicado antes (Estructura GENERAL Servicios Web Lista - _AuraPortalProcesos PanelTipoCamposVer). En el documento XML que se devolverá se puede localizar la información de las opciones de Selección Simple, por ejemplo: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 26 de 102

27 INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 27 de 102

28 En este ejemplo se muestran los datos de un campo de Selección Simple llamado Importancia. Se pueden ver los siguientes datos: (1) Nombre Interno: 3_Importancia, (2) La entrada de la lista de Opciones con las siguientes: (3) ID 109 para la opción llamada Baja (4), y (5) ID 110 para la opción llamada Media (6). Los siguientes términos necesitan separadores especiales por ser multiregistro, es decir, que permiten la introducción de más de un registro: Selección Múltiple Familia Documentos Grupos de Campos Ver detalles en siguientes apartados Formato de los Campos de Selección Múltiple El formato de la Selección Múltiple es muy parecido a la Selección Simple, pero los diferentes valores del mismo campo se separan con ;;;. Un ejemplo podría ser: [[[3_Contacto Deseado:::108###Llamada Telefónica;;;109###Envío ]]] Para conocer el ID y Nombre de las opciones de Selección Múltiple, seguir las mismas instrucciones indicadas antes para la Selección Simple (desde el Diccionario de Términos o con el método PanelTipoCamposVer del Servicio Web AuraPortalProcesos) Formato de los Campos de Familia El formato de los Campos de Familia es el mismo que el de los de Selección Múltiple, con la única diferencia de que los ID son los de la lista de SharePoint AP xxxfichas, donde xxx varía según la Familia: Cuentas, Empleados, Ítems, Proyectos y Áreas (antes Ámbitos). Un ejemplo podría ser: [[[3_Proyectos:::34###Ofertas 2007;;;89###Edificio Miramar]]] En el caso de la familia Cuentas hay que indicar Nombre Comercial y Razón Social de esta manera: [[[3_Clientes:::3567###Salur (Salazones Urquijo, S.L.);;;845###Casa (Castillo, S.A.)]]] Los ID de los elementos de una familia de AuraPortal se pueden obtener de dos maneras: Directamente en la ficha de cada Cuenta desde el interface de usuario de AuraPortal. A través del método GetElements del Servicio Web AuraPortalDoc (ver más detalles en el capítulo correspondiente de este documento). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 28 de 102

29 En el caso de las Cuentas, también está disponible el método GetIdCuenta del Servicio Web AuraPortalFamilias (ver más detalles en el capítulo correspondiente de este documento) Formato de los Campos de Documentos La introducción de documentos en los Servicios Web de Eventos de Mensaje a través de programas externos tiene un formato específico que depende del origen del documento y de la acción que se desee: Posibles orígenes: AuraPortal: Si el documento ya está Integrado o Asociado en un elemento de otra familia de AuraPortal (Tarea Libre, Empleado, Cuenta, Ítem, Proyecto o Área). Externo: Si el documento no está en AuraPortal. Posibles acciones: Integrar en el Proceso. Asociar en el Proceso. A continuación se muestran los formatos necesarios para las diferentes opciones: Acción ORIGEN: AURAPORTAL (ya está Integrado o Asociado) Integrar Documentos 1###ID###NombreDoc;;; Asociar Documentos 2###ID###NombreDoc;;; Asociar Bibliotecas 2###ID###NombreBiblioteca;;; Asociar URLs 2###ID###URL;;; Acción ORIGEN: EXTERNO (no está en AuraPortal) Integrar Documentos 11###ArrayBytesBase64###NombreDoc;;; Asociar Documentos 22###URL;;; Detalles: El primer número identifica si la acción va a ser Integrar o Asociar desde AuraPortal (1 y 2), o desde el exterior (11 y 22). El ID, es el ID en la lista de SharePoint en donde ya está el documento/biblioteca/url Integrado o Asociado en las listas de SharePoint siguientes: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 29 de 102

30 - Para Integrados: AP DocumentosIntegrados - Para Asociados: AP DocumentosAsociados Para obtener el ID de un documento Integrado o Asociado a un elemento de AuraPortal, se pueden utilizar los siguientes métodos: - Para Integrados: GetDocIntegrados del Servicio Web AuraPortalDoc - Para Asociados: GetDocEnlazados del Servicio Web AuraPortalDoc (Ver más detalles en el capítulo correspondiente de este documento) En NombreDoc, NombreBiblioteca y URL, indicar el correspondiente en cada caso. Si el origen es AuraPortal, se obtiene con los métodos comentados en el punto anterior (GetDocIntegrados y GetDocEnlazados). El formato del ArrayBytes para integrar documentos externos es Base64. Además de estos detalles particulares para los documentos, hay que utilizar el resto del formato ya comentado en los otros tipos de campo, es decir todo cerrado entre tres corchetes, indicar el Nombre Interno del Término, etc. Varios ejemplos podrían ser los siguientes: Integrar un documento y Asociar una biblioteca que ya están en AuraPortal: [[[3_Documentación:::1###345###Calendario2007.doc;;;2###23###Agendas]]] Asociar dos URLs: [[[3_Enlaces:::22### 22### Formato de los Grupos de Campos Los Grupos de Campos, al contener a su vez otros campos, necesitan un formato específico con separadores especiales. El campo que engloba el Grupo de Campos se separa igual que los demás tipos de campos, es decir: [[[NombreInternoTérmino:::Valor]]] donde NombreInternoTérmino es el nombre Interno del Grupo de Campos. Sin embargo, dentro del Valor, como también contiene diferentes campos (columnas), tiene otros separadores: DE CAMPOS: Para separar los campos dentro del grupo de Campos, en lugar de [[[ ]]] se utiliza. NOMBRE del VALOR: En lugar de ::: se separan con === DE REGISTROS: Los diferentes registros de un Grupo de Campos se separan con tres guiones de subrayado INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 30 de 102

31 Un ejemplo con un solo registro podría ser el siguiente: [[[6_Albarán::: 1_Artículo===327###Motorola GX _Cantidad===4 2_Artículo/ValorVenta===155 ]]] donde: - 6_Albarán es el nombre del Término del Grupo de Campos. - 1_Artículo es el nombre de un Término de tipo Prefijo de Familia Ítems. 327 es el ID en la lista de SharePoint AP ItemsFichas del Item Motorola GX _Cantidad es el nombre de un Término de tipo Número Entero. - 2_Artículo/ValorVenta es el nombre de un Término de tipo Sufijo creado con el campo ValorVenta de la Ficha del Ítem (Prefijo 1_Artículo). Un ejemplo con dos registros podría ser el siguiente: [[[6_Albarán::: 1_Artículo===327###Motorola GX _Cantidad===4 2_Artículo/ValorVenta===155 1_Artículo===469###Funda Motorola piel 3_Cantidad===2 2_Artículo/ValorVenta===59 ]]] En este ejemplo se ha creado un albarán con dos artículos: - 4 unidades de Motorola GX934 a unidades de Funda Motorola piel a Tabla Resumen A continuación se muestra un resumen de los formatos necesarios. Para ver más detalles dirigirse a los apartados precedentes: SEPARADORES De Campos en general [[[NombreInternoTérmino:::Valor]]] [[[NombreInternoTérmino:::Valor;;;Valor]]] (en monoregistros) (en multiregistros) Un solo registro: De Campos dentro del Valor del Grupo de Campos NombreInternoTérminoGrupoCampos===Valor Varios registros: NombreInternoTérminoGrupoCampos===Valor;;;Valor (El Valor dentro de un Grupo de Campos tiene el mismo formato que en los demás Términos, tal como se describe a continuación) INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 31 de 102

32 VALOR Selección Simple ID###Nombre Selección Múltiple y Familias ID###Nombre;;;ID###Nombre;;; Familia Cuenta ID###Nombre Comercial (Razón Social);;; Origen Externo (Si el origen del documento es externo a AuraPortal) Asociar URLs 22###URL;;; Integrar Documentos 11###ArrayBitsBase64###NombreDoc;;; Origen AuraPortal (Si el documento ya está Integrado o Asociado en otra familia de AuraPortal) Integrar Doc 1###ID###NombreDoc;;; (ID = en Lista AP DocumentosIntegrados) Asociar Documentos y Bibliotecas 2###ID###NombreDoc;;; (ID = en Lista AP DocumentosAsociados) Una manera de ver el resultado de la introducción de datos en un Proceso a través de sus Servicios Web es a través del método PanelDatosVer del Servicio Web de Sistema AuraPortalProcesos. Además de mostrar los datos introducidos, también se puede observar cuál es su formato. Es útil para detectar problemas con la introducción de datos a través de los Servicios Web de Eventos de Mensaje. Se trata de consultar los datos de un Proceso ya creado, introduciendo los datos manualmente a través de un Formulario, por ejemplo: 1. Desde la opción correspondiente, crear un Evento de Mensaje de la Clase en cuestión, con todos los datos deseados. Tener en cuenta lo siguiente: 1.1. La Clase de Proceso ha de estar en modo Simulación. De esta manera, cuando se acaben las pruebas, si se cambia el modo a Publicado Activo, se podrán borrar todos los Procesos provisionales que se hayan creado El Servicio Web del Evento de Mensaje ha de estar configurado con la opción Acepta Introducción Manual en Sí (desde la opción Servicio Web de la configuración del Formulario en la Clase de INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 32 de 102

33 Proceso). Posteriormente a estas pruebas, puede configurarse con No si no se desea que se puedan iniciar Eventos de Mensaje manualmente por los usuarios. 2. Localizar la Referencia Base del Proceso en donde se han introducido los datos. Hay varias maneras de localizarla, por ejemplo, verlo desde una Tarea Personal del Proceso (en Mis Tareas). 3. Dirigirse a Estructura General Servicios Web Lista y entrar en el Servicio Web de Sistema AuraPortalProcesos. Se abrirá la página AuraPortalProcesos.asmx en donde se verá una lista de todos sus métodos, semejante a la de la siguiente imagen: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 33 de 102

34 Entrar en el método PanelDatosVer, En el parámetro RefBase introducir la Referencia Base del Proceso en cuestión, en este ejemplo P2-10.1_2 y pulsar el botón Invocar. Aparecerá un fichero XML con todos sus datos, en este caso: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 34 de 102

35 INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 35 de 102

36 Nótese que el 3_Número Entero (2 en la imagen) está tal como se ha introducido, pero el campo de 3_Familia Cuentas (1 en la imagen) tiene el formato: ID###Nombre Comercial (Razón Social) (donde el ID es el Identificador único de cada Cuenta en la Lista de SharePoint AP CuentasFichas). Nótese que los diferentes registros están separados con ;;;. El 3_Número Decimal (3 en la imagen) se muestra siempre con coma (1767,78), si bien el Servicio Web también acepta su introducción con punto ( ). Nota. Lógicamente los ID y Nombres que se introducen en Campos de tipo Familia han de corresponder con datos existentes en las fichas de AuraPortal. Para conocer el ID y Nombre de los elementos de Familia, se pueden consultar directamente en sus fichas desde el interface de usuario, o bien a través de los Servicios Web siguientes: - Método GetElements del Servicio Web AuraPortalDoc - Método GetIdCuenta del Servicio Web AuraPortalFamilias (Ver más detalles en los Capítulos correspondientes de este documento) Particularidades de los Eventos de Mensaje Intermedios Todos los detalles comentados en el apartado anterior son comunes para los Servicios Web de los Eventos de Mensaje de Inicio e Intermedios. Los Eventos Intermedios no llegan al workflow de ningún usuario, sino que hay que crearlos desde la opción Actuar en Proceso de la pestaña Mis Tareas de Proceso. Al crear el Servicio Web para este Evento Intermedio siguiendo las indicaciones ya comentadas en el apartado anterior, seguirá viéndose Datos como único parámetro, pero cuando se utilice desde programas externos será obligatorio rellenarlo con, al menos, el campo _Lista de Referencias de Procesos: Siguiendo las indicaciones sobre el formato necesario detalladas en el apartado anterior, el campo _Lista de Referencias (nótese que el Nombre Interno es diferente del Título mostrado, no tiene la última parte de Procesos) se tendrá que rellenar así: [[[_Lista de Referencias:::RefBase]]] INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 36 de 102

37 En RefBase hay que indicar la Referencia Base del Proceso que está detenido en este Evento Intermedio que se quiere crear, por ejemplo: [[[_Lista de Referencias:::GEN-45.7_539]]] En este ejemplo únicamente se ha indicado la Referencia Base, sin ningún otro campo del formulario, que han de indicarse si se desea. Nota. Para crear un Evento Intermedio, es necesario que la corriente de su Proceso esté detenida en él. De lo contrario, el Motor BPMS no lo procesará y se perderá Eventos de Mensaje Intermedios Patrón En la monografía de Tareas de Sistema están todos los detalles necesarios para utilizar los Eventos de Mensaje Intermedios Patrón, pero sirva este apartado para ver algunos detalles relacionados con los Servicios Web. El Evento de Mensaje Intermedio PATRÓN está diseñado para simplificar el diseño de Clases de Proceso que se desvían a una Clase común a través de Tareas de Sistema de tipo DESVIADOR. Gracias al Evento Intermedio Patrón, con el diseño de una única Tarea de Sistema en la Clase de Proceso común, será suficiente para que cada corriente pueda volver a su Proceso origen, aunque se haya generado desde diferentes Clases de Proceso. Imaginemos el siguiente ejemplo: Descripción: Se desea que una Clase de Proceso de Compras (C para simplificar) sea reutilizable para efectuar las compras de materiales que pueden ser solicitados desde las Clases de Proceso de Ventas (V) y de Solicitudes de INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 37 de 102

38 Empleados (E). Para ello, en el diseño de las Clases V y E, hay una Tarea de Sistema de tipo DESVIADOR que iniciará un Proceso de la Clase C. En el diseño del Evento de Inicio de C, se ha cuidado de ubicar un campo de texto donde la Tareas de Sistema de V y E puedan grabar su Referencia Base (RefBase). Así mismo, en V y E, después de la Tarea de Sistema DESVIADOR hay un Evento de Mensaje Intermedio PATRÓN en donde se detendrá su corriente después de haber creado un Proceso de la Clase C. Cuando desde C se termina la compra, una sola Tarea de Sistema de tipo DESVIADOR invocará el Evento Patrón de V y E para comunicar la realización de la compra y que puedan continuar su corriente. Como el Evento es Patrón y está igualmente ubicado en las Clases V y E, bastará con indicar la Referencia Base que se traspasó en el Mensaje de Inicio de C para que se cree el Evento del Proceso adecuado y la corriente continúe. Nota. Un Evento Intermedio Patrón no tiene formulario, por lo que sólo podrá ser utilizado desde Tareas de Sistema DESVIADOR, pero no desde el Interface de usuario de AuraPortal. Para crear un Evento Intermedio Patrón seguir los pasos siguientes: Dirigirse a Estructura FAMILIAS Procesos Entorno: y aparecerá la siguiente pantalla: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 38 de 102

39 Configurar como sigue: 1. Dirigirse a la pestaña Patrones. 2. Pulsar el botón Crear Patrón de Evento Mensaje. 3. En la ventana que aparecerá, introducir el Nombre deseado. 4. Pulsar el botón Guardar. 5. Automáticamente habrá aparecido el Campo de Sistema _Lista de Referencias de Procesos, obligatorio para los Eventos de Mensaje Intermedios. 6. Agregar Campos de Diccionario si se desea. 7. Agregar Campos de Sistema si se desea. 8. Pulsar sobre el botón Servicio Web para publicarlo. Este punto es necesario para poder utilizar el Evento Patrón. Aparecerá la ventana de creación y publicación del Servicio Web: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 39 de 102

40 Configurarla como de costumbre y pulsar el botón Test para comprobar. Se abrirá la página.asmx con un solo método: y al pulsar sobre él se abrirá la página de parámetros, que por ser Patrón tiene más parámetros que un Evento Intermedio normal: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 40 de 102

41 Si esta ventana se ha abierto desde el propio servidor de AuraPortal, los parámetros se mostrarán como en la imagen, es decir, permitiendo introducción manual para hacer pruebas. Sin embargo, si esta ventana se abre desde otro ordenador que no sea el servidor, se mostrarán los datos de SOAP pero no estarán los dos parámetros disponibles para introducción manual. En su lugar aparecerá el mensaje: El formulario de prueba sólo está disponible para solicitudes del equipo local. Nota. El uso de este Servicio Web está reservado a las Tareas de Sistema de tipo DESVIADOR. Una vez configurado el Evento Patrón, para utilizarlo desde Tareas de Sistema de tipo DESVIADOR, seleccionarlo desde la opción DESTINO DEL DESVÍO de la configuración de la Tarea de Sistema, tal como se muestra en la imagen siguiente: Ver todos los detalles en la documentación sobre Tareas de Sistema. 3. SERVICIO WEB AURAPORTALPROCESOS.ASMX Además de los Servicios Web Personalizados, con los que se pueden crear Eventos de Mensaje de Inicio para iniciar e introducir datos en Procesos, también está disponible un Servicio Web de Sistema (por defecto en la instalación), llamado AuraPortalProcesos, con funcionalidades para el manejo de los Procesos de AuraPortal BMPS desde programas externos. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 41 de 102

42 En este Capítulo se muestran todos los detalles sobre el Servicio Web AuraPortalProcesos Funcionalidad El Servicio Web AuraPortalProcesos tiene más de 30 métodos con los que básicamente se puede realizar todo lo que se pueda necesitar: Buscar y crear Mensajes de Inicio de Proceso e Intermedios sin introducir datos (para introducir datos utilizar los Servicios Web Personalizados). Consultar los datos introducidos en el Panel de cualquier Proceso. Consultar los tipos de Campos del Panel de una Clase de Proceso. Consultas de tiempos de Procesos. Integrar y Asociar documentos en Procesos y obtener el Array de bits de documentos integrados en Procesos. Obtener las Tareas de un Empleado Conexión Para iniciar el servicio hace falta especificar los siguientes valores: URL del servicio ( ( host.dominio.com depende de cada instalación) Usuario / contraseña (el usuario debe ser Empleado de AuraPortal) El usuario indicado en la conexión es el que se mostrará cómo Creador o Modificador de los elementos de los Procesos que se creen o modifiquen en AuraPortal Métodos Para ver los métodos del Servicio Web AuraPortalProcesos hay teclear la URL del Servicio Web: ( host.dominio.com depende de cada instalación) y se obtendrá una página semejante a la siguiente con la lista de métodos del Servicio Web AuraPortalProcesos: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 42 de 102

43 Al pulsar sobre el link descripción de servicios (Service Description) (o añadir?wsdl a la URL) se obtendrá la descripción del Servicio Web o WSDL (Web Service Description Language) en formato XML. Al pulsar sobre uno de los métodos, por ejemplo PanelDatosVer, método que sirve para ver los datos del Panel de un Proceso, se obtendrá el siguiente resultado: Si esta página se ha abierto desde el propio navegador del servidor de AuraPortal, se podrán introducir valores manualmente en el parámetro RefBase. Al introducir datos adecuados y pulsar el botón Invocar, se obtendrá un documento con los datos del Panel del Proceso indicado, como por ejemplo el siguiente: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 43 de 102

44 INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 44 de 102

45 A continuación se comentan todos los detalles de los métodos del Servicio Web AuraPortalProcesos: Buscar Clase de Mensaje de Inicio (MensajeClaseBuscar) Para crear un Mensaje de Inicio de Proceso con el método MensajeInicioCrear (descrito en el apartado siguiente) es necesario conocer el ID de su Clase. Y el método para ver el ID de la Clase de un Mensaje de Inicio de Proceso es MensajeClaseBuscar, cuyo único parámetro de búsqueda es por su nombre: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 45 de 102

46 Parámetro <Nombre> (string) Nombre (o parte) de la Clase de Mensaje de Inicio de Proceso del que se quiere obtener su ID. Para buscar todos dejar el parámetro vacío. Valor Devuelto ( XmlDocument ) Se obtiene un documento XML en formato DataTable con el <ID> y <Nombre> de las Clases de Mensajes de Inicio de Proceso que cumplen las condiciones de filtrado Crear Mensaje de Inicio (MensajeInicioCrear) Para crear un Mensaje de Inicio de Proceso se utiliza el método MensajeInicioCrear. El único parámetro que hay que indicar en este método es el ID de la Clase de Mensaje de Inicio, el cual se puede obtener con el método anterior, MensajeClaseBuscar: Parámetro <IDClaseMensaje> (int) Número entero que identifica (ID) la Clase de Mensaje de Inicio del Mensaje que se quiere crear. Este ID se puede obtener a partir de su Nombre, con el método MensajeClaseBuscar comentado anteriormente. Valor Devuelto ( XmlDocument ) Si el Mensaje de Inicio se ha creado correctamente, se obtiene un documento XML con su ID. Si el parámetro no se ha rellenado o se han introducido caracteres diferentes a números enteros, el Servicio Web no se iniciará y se obtendrá un error de tipo System.FormatException: La cadena de entrada no tiene el formato correcto. Si se ha producido alguna Incidencia conocida, se devolverá con los siguientes números negativos: -1 : Problema indefinido al comprobar el Login. Quizás no tiene suficientes permisos. -3 : El Mensaje de Inicio indicado tiene campos obligatorios no rellenados. -4 : El usuario AdminPortal no puede crear Mensajes de Inicio de Proceso. -9 : El ID indicado no pertenece a ningún Mensaje de Inicio existente. En condiciones normales cada Mensaje de Inicio inicia un Proceso. Para saber cuál es el ID de cada uno de esos Procesos se pueden utilizar los métodos INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 46 de 102

47 ProcesoBuscarxMensaje (a partir del ID que se obtiene con este método, MensajeInicioCrear) y también el MensajeBuscar (que busca todos los ID de los Mensajes de Inicio creados de una determinada Clase) Buscar Mensaje de Inicio (MensajeBuscar) Con este método se pueden obtener todos los ID de los Mensajes de Inicio creados a partir de una determinada Clase de Mensaje de Inicio. Tiene un único parámetro, que es el ID de la Clase de Mensaje de Inicio (que se obtiene con el método MensajeClaseBuscar): Parámetro <IDClaseMensaje> (int) Número entero que identifica (ID) la Clase de Mensaje de Inicio del que se quieren obtener los Mensajes de Inicio que se han creado. Este ID se puede obtener con el método MensajeClaseBuscar a partir del Nombre de la Clase de Mensaje de Inicio. Valor Devuelto ( XmlDocument ) Se obtendrá un documento XML con los <ID> de todos los Mensajes de Inicio existentes de la Clase indicada, y con su <Fecha> de creación. Si la Clase indicada no existe se devolverá un documento XML vacío. Si el parámetro no se ha rellenado o se han introducido caracteres diferentes a números enteros, el Servicio Web no se iniciará y se obtendrá un error de tipo System.FormatException: La cadena de entrada no tiene el formato correcto Buscar Proceso por su Mensaje de Inicio (ProcesoIDBuscarxMensaje) Con este método se puede obtener el ID del Proceso que se ha creado a partir de un determinado Mensaje de Inicio. Tiene un único parámetro, que es el ID del Mensaje de Inicio, número que se obtuvo en el momento de crear el Mensaje de Inicio con el método MensajeInicioCrear o posteriormente con MensajeBuscar: Parámetro <IDMensaje> (int) Número entero que identifica (ID) el Mensaje de Inicio de Proceso que creó el Proceso del que se quiere obtener su ID. El ID del Mensaje de Inicio se obtiene en el momento de crearlo con el método MensajeInicioCrear, o posteriormente con MensajeBuscar. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 47 de 102

48 Valor Devuelto ( XmlDocument ) Si el Mensaje de Inicio indicado en IDMensajeInicio creó un Proceso, se obtendrá un documento XML con su ID. Si el parámetro no se ha rellenado o se han introducido caracteres diferentes a números enteros, el Servicio Web no se iniciará y se obtendrá un error de tipo System.FormatException: La cadena de entrada no tiene el formato correcto. Si se ha producido alguna Incidencia conocida se devolverá con los siguientes números negativos: -8 : El ID indicado pertenece a un Mensaje de Inicio existente, pero no creó ningún Proceso. Quizás el Motor BPMS no lo ha creado porque está detenido u ocupado, se debe a algún problema en el diseño de la Clase del Proceso o en el paso del Estado de la Clase de Proceso de Entorno Pruebas a Entorno Producción se eliminó. -9 : No existe el Mensaje de Inicio indicado en el parámetro IDMensaje. El método ProcesoBuscarxMensaje es parecido pero en lugar de devolver el ID, devuelve la Referencia Base Consulta de Tiempos (ConsultaTiemposBuscar) Este método es un buscador de elementos según su Cronometría. Es el mismo filtro que se puede encontrar a través del interface de AuraPortal en: Procesos Cuadro de Mandos Consulta de Tiempos. Este método también se puede utilizar para localizar ID de Procesos para, por ejemplo, utilizar el método PanelDatosVer que necesita el ID de los Procesos. Tiene varios parámetros, comentados a continuación: Parámetro <IDClaseProceso> (string) <Referencia> (string) <Asunto> (string) <Objeto> (string) Número entero que identifica (ID) la Clase de Proceso a la que pertenece el Proceso en el que se está buscando. Para buscar en todas las Clases de Procesos dejar este parámetro vacío. Referencia Base (o parte) del Proceso en el que se está buscando. Para buscar en todos los Procesos dejar este parámetro vacío. Tema (o parte) del Proceso en el que se está buscando. Para buscar en todos los Procesos dejar este parámetro vacío. Tipo de Objeto que se está buscando. Los posibles valores son los siguientes: 1 : Tareas. 2 : Procesos. Los Puntos de Control y los Lapsos no están todavía implementados en este método. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 48 de 102

49 Para buscar todos los Tipos de Objeto dejar este parámetro vacío. También se pueden indicar varios tipos separándolos por comas, por ejemplo: 1, 2 (en el futuro 3 y 4 para Puntos de Control y Lapsos). Si se indican valores diferentes a los indicados, los omitirá y devolverá todos los valores, como si se hubiera dejado el parámetro vacío. Estas opciones son las mismas que se pueden encontrar a través del interface de AuraPortal en: Procesos Cuadro de Mandos Consulta de Tiempos Otros Conceptos Objetos. <NivelCritico> (string) <Situacion> (string) Es el Nivel Crítico del elemento que se está buscando. Los posibles valores son los números enteros entre el 1 y el 9. Si se indica uno superior se obtendrá un error. Se pueden indicar varios separándolos por comas, por ejemplo 1,3,5,6. Para buscar en todos los Niveles Críticos dejar este parámetro vacío. Si se indican números diferentes a los indicados, por ejemplo 10, los omitirá y devolverá todos los valores, como si se hubiera dejado el parámetro vacío. Si se indican letras, el Servicio Web no se iniciará y se obtendrá una devolución de tipo System.FormatException: La cadena de entrada no tiene el formato correcto. Estas opciones son las mismas que se pueden encontrar a través del interface de AuraPortal en: Procesos Cuadro de Mandos Consulta de Tiempos Otros Conceptos Nivel Crítico. Situación, con respecto al control de tiempos, en que se encuentra el elemento que se está buscando. Los posibles valores son los siguientes: 1 : Alarma (elemento Activo pero en Alarma) 2 : Alerta (elemento Activo pero en Alerta) 3 : Term.ALA (se terminó en Alarma, fuera de plazo) 4 : Term.OK (se terminó dentro del tiempo establecido) 5 : Activa Ok (el elemento está activo y sin Alertas ni Alarmas) 6 : Cancelado (el elemento se canceló) Para buscar todos dejar el parámetro vacío. Se pueden indicar varios separándolos por comas, por ejemplo 1,3,6. Si se indican números diferentes a los indicados, por ejemplo 10, los omitirá y devolverá todos los valores, como si se hubiera dejado el parámetro vacío. Si se indican letras, el Servicio Web no se iniciará y se obtendrá una devolución de tipo System.FormatException: La cadena de entrada no tiene el formato correcto. Estas opciones son las mismas que se pueden encontrar a través del interface de AuraPortal en: Procesos Cuadro de Mandos Consulta de Tiempos Otros Conceptos Situación. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 49 de 102

50 <Duracion> (string) Indica si el elemento que se está buscando tiene Duración o no (en la configuración de Cronometría). Los posibles valores son los siguientes: 0 : Sin duración. 1 : Con duración. Para buscar todos dejar este parámetro vacío. Estas opciones son las mismas que se pueden encontrar a través del interface de AuraPortal en: Procesos Cuadro de Mandos Consulta de Tiempos Otros Conceptos Duración. Valor Devuelto ( XmlDocument ) Se devolverá un documento XML en formato DataTable con los siguientes datos de los elementos que cumplen las condiciones de filtrado: <ClaseProceso> : Nombre de la Clase de Proceso. <Referencia> : Referencia Base del Proceso. <Asunto> : Tema del Proceso. <Objeto> : Tipo de Objeto, según los valores siguientes: 1 : Tareas. 2 : Procesos. Los Puntos de Control y los Lapsos no están todavía implementados en este método. <Identificacion> : Nombre del Objeto. <NivelCritico> : Nivel Crítico indicados en el Control de Duración en la Cronometría del elemento. <EjecResp> : En Tareas es el Ejecutor, y en Procesos es el Responsable de la Clase de Proceso. <Vencimiento> Es un valor calculado, resultante de añadir a la fecha de inicio del elemento, las Unidades indicadas en el valor Máxima del Control de Duración en la Cronometría del elemento. <Umbral> Indicado en la Cronometría del elemento, se refiere a las Unidades de tiempo para que salte la Alerta, antes del Vencimiento. <Unidades> : Es la unidad en Cronometría del objeto, según los valores siguientes: -1 : No Definido. 0 : Días Naturales. 1 : Días Hábiles. 2 : Horas Naturales. 3 : Minutos Naturales. 5 : Segundos Naturales. 6 : Horas Hábiles. 7 : Minutos Hábiles. 8 : Segundos Hábiles. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 50 de 102

51 <Margen> : Es la diferencia entre la Fecha de Vencimiento y la Fecha Actual. <Alarma> : Es el tiempo que falta para llegar a la Alerta, es decir la Fecha de Vencimiento menos el Umbral. <IdClaseProceso> : ID de la Clase de Proceso. <IdProceso> : ID del Proceso Ver Datos del Panel de un Proceso (PanelDatosVer) Con este método se pueden obtener todos los datos de un Panel de un Proceso determinado. Tiene dos parámetros, ambos necesarios: Parámetro <RefBase> (string) Referencia Base del Proceso del que se quieren obtener los datos de su Panel. Este ID se puede obtener con el método ConsultaTiemposBuscar, ProcesoBuscarxMensaje y otros que están en preparación. Valor Devuelto ( XmlDocument ) Si los valores indicados en los parámetros coinciden con un Proceso existente, se obtendrá un documento XML en formato DataTable con todos los datos de su Panel. La estructura devuelta en el documento XML dependerá del diseño de cada Clase de Proceso, pero básicamente consistirá en una lista con el <Nombre> del campo y su <Valor>. El <Nombre> estará basado en su nombre en el Diccionario de Términos, pero con una codificación delante según los siguientes criterios: - Los campos de Sistema (incluidos por defecto en toda Clase de Proceso) empiezan con el carácter _, por ejemplo: _Base Reference _Extended Reference _Process Start Date _Start Message Creator (mostrará el ID y el nombre, separados por #) - Los campos creados por los Usuarios empezarán con los siguientes caracteres, seguidos por el nombre indicado en el momento de crearlos en el Diccionario de términos: 1_ : Términos Prefijo 2_ : Términos Sufijo 3_ : Términos General 5_ : Términos Clave 6_ : Términos Grupo de Campos INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 51 de 102

52 Si el Proceso indicado no existe, se devolverá un documento XML vacío. Si el parámetro no se ha rellenado o se han introducido caracteres diferentes a números enteros, el Servicio Web no se iniciará y se obtendrá un error de tipo System.FormatException: La cadena de entrada no tiene el formato correcto Ver Tipo de Campos del Panel de una Clase de Proceso (PanelTipoCamposVer) Con este método se pueden obtener todos los Tipos de Campos que tiene una determinada Clase de Proceso. La información obtenida será necesaria para poder rellenar datos del panel con los métodos diseñados específicamente para ello, como son PanelDocIntegrar, PanelDocEnlazarURL, etc. Este método tiene un único parámetro, que es la Referencia de la Clase de Proceso: Parámetro <RefClaseProceso> (string) Referencia de la Clase de Proceso de la que se quieren obtener sus Tipos de Campos de Panel. La información obtenida será necesaria para poder rellenar datos del panel con los métodos diseñados específicamente para ello, como son PanelDocIntegrar, PanelDocEnlazarURL, etc. Ver más información en cada método en particular. Valor Devuelto ( XmlDocument ) Se obtendrá un documento XML en formato ArrayList, con todos los Tipos de Campo del Panel de la Clase de Proceso indicada en los parámetros. Si no existe la Clase de Proceso indicada se devolverá un documento XML vacío. Si el parámetro no se ha rellenado o se han introducido caracteres diferentes a números enteros, el Servicio Web no se iniciará y se obtendrá una devolución de tipo System.FormatException: La cadena de entrada no tiene el formato correcto Enlazar una URL en Documentos del Panel de Proceso (PanelDocEnlazarURL) Con este método se pueden enlazar URLs en Procesos, concretamente en Campos de tipo Biblioteca. Para poder utilizarlo, hay que proporcionar los siguientes parámetros: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 52 de 102

53 Parámetro <IDProceso> (int) <IDTermino> (int) <URL> (string) <Nombre> (string) Número entero que identifica (ID) del Proceso en el que se quiere integrar el documento. Número entero que identifica (ID) del Término en el que se quiere enlazar la URL. Este Término sólo puede ser del tipo Biblioteca, y para obtener su ID hay que utilizar el método PanelTipoCamposVer explicado anteriormente, y en el documento XML que se obtendrá localizarlo en la sección siguiente: + <anytype xsi:type="campotablaselecciondocumentos"> Se ve el ID del Término en el valor <IdTermino>, el cual es el que hay que proporcionar en este parámetro <IDTermino> para enlazar la URL. URL que se quiere enlazar. Nombre del documento. Valor Devuelto ( XmlDocument ) Si la URL se ha enlazado correctamente se obtendrá un documento XML con el número 0. <?xml version="1.0" encoding="utf-8"?> <int xmlns=" Si se ha producido alguna Incidencia se devolverá con los siguientes números negativos: -2 : El Proceso está Terminado. No se pueden enlazar URLs. -6 : No existe el Término indicado. -7 : El Tipo de Término no es de tipo Biblioteca. -8 : No existe el Proceso indicado. -9 : Problema indefinido Integrar Documento en Panel de Proceso (PanelDocIntegrar) Con este método se pueden integrar documentos en Procesos, concretamente en Campos de tipo Biblioteca. Para poder utilizarlo, hay que proporcionar los siguientes parámetros: Parámetro <IDProceso> (int) Número entero que identifica (ID) del Proceso en el que se quiere integrar el documento. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 53 de 102

54 <IDTermino> (int) Número entero que identifica (ID) del Término en el que se quiere integrar el documento. Este Término sólo puede ser del tipo Biblioteca, y para obtener su ID hay que utilizar el método PanelTipoCamposVer explicado anteriormente, y en el documento XML que se obtendrá localizarlo en la sección siguiente: + <anytype xsi:type="campotablaselecciondocumentos"> Se ve el ID del Término en el valor <IdTermino>, el cual es el que hay que proporcionar en este parámetro <IDTermino> para integrar el documento. <ByteArray> (base64binary) Secuencia de Bytes (base64binary) que componen el documento. <Nombre> (string) <IdRegistro>(int) Nombre del documento. Es el id del registro del Grupo de Campos. Si no se está integrando en un Grupo de Campos, es 0. Valor Devuelto Si el documento se ha integrado correctamente se obtendrá un documento XML con el número 0. <?xml version="1.0" encoding="utf-8"?> <int xmlns=" ( XmlDocument ) Si se ha producido alguna Incidencia se devolverá con los siguientes números negativos: -2 : El Proceso está Terminado. No se pueden integrar documentos. -6 : No existe el Término indicado. -7 : El Tipo de Término no es de tipo Biblioteca. -8 : No existe el Proceso indicado. -9 : Problema indefinido. Nota. En todos aquellos Servicios Web para integrar documentos se pueden indicar valores para los campos _Description y los de texto (Txt1, Txt2,... Txt16) de las Bibliotecas en Diccionario. El formato que se utilizaba hasta ahora para integrar documentos se mantiene, era el siguiente: [[[NombreCampoDoc:::11###ArrayDeBits###NombreDocumento]]] Consultar el método PanelDocIntegradoMetadataArray para más información Integrar Documento según ID (PanelDocIntegrarxID) El método PanelDocIntegrarxID es de uso interno para que AuraPortal Ingresador pueda crear una nueva versión de un documento integrado en un Proceso. Se utiliza con los siguientes parámetros: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 54 de 102

55 Parámetro <IDDocumento> (int) Número entero que identifica (ID) del Documento que se ha abierto desde el DataGrid de Documentos Integrados del formulario de una Tarea de Proceso. <ByteArray> (base64binary) Secuencia de Bytes (base64binary) que componen el documento. <NewVersion>(string) Los valores admitidos son: True (Verdadero o 1 son considerados como True y se creará una nueva versión del documento). Cualquier otra cosa es False y no se crea nueva versión del documento. Valor Devuelto ( XmlDocument ) Si el documento se ha integrado correctamente se obtendrá un documento XML con el número 0. <?xml version="1.0" encoding="utf-8"?> <int xmlns=" Si se ha producido alguna Incidencia se devolverá con los siguientes números negativos: 2 : El Proceso está Terminado. No se pueden integrar documentos. 7 : El Tipo de Término no es de tipo Biblioteca. 8 : No existe el Proceso indicado. 9 : No existe el ID del documento. 99 : Problema indefinido. Nota. En todos aquellos Servicios Web para integrar documentos se pueden indicar valores para los campos _Description y los de texto (Txt1, Txt2,... Txt16) de las Bibliotecas en Diccionario. El formato que se utilizaba hasta ahora para integrar documentos se mantiene, era el siguiente: [[[NombreCampoDoc:::11###ArrayDeBits###NombreDocumento]]] Consultar el método PanelDocIntegradoMetadataArray para más información Obtiene valores de etiquetas de Biblio. en Diccionario (PanelDocIntegradoMetadataArray ) Los siguientes métodos permiten obtener los valores de los campos _Description y Txt1, etc del documento indicado. Hay 3 versiones, según el formato en que se obtengan los valores: PanelDocIntegradoMetadataArrayDataSet. Obtiene los datos en formato DataSet. PanelDocIntegradoMetadataArrayString. Obtiene los datos en formato String. PanelDocIntegradoMetadataArrayXML. Obtiene los datos en formato XML. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 55 de 102

56 El formato anterior es compatible, pero también vale el siguiente: [[[NombreCampoDoc:::11###_Array===ArrayDeBits###_Name===NombreDocumento### _Description===DescripcionDeseada###_Txt1===TextoDeseado###Txt2...]]] También se pueden omitir las etiquetas _Array, _Name, _Txt1,... pero entonces será obligatorio respetar el nombre y poner todos los separadores ### necesarios en orden para localizar el campo de inserción. Si se ponen las etiquetas, se tiene la ventaja de que no importa el nombre y se puede indicar directa y únicamente un valor para un campo de texto cualquiera, por ejemplo el _Txt16 sin tener que poner delante 15 conjuntos de ### para identificarlo. De esta manera un ejemplo válido sería: [[[NombreCampoDoc:::11###_Array===ArrayDeBits###_Name===NombreDocumento### _Description===DescripcionDeseada###_Txt9===TextoDeseado9]]] Ver ID y Naturaleza de las Reglas de Negocio (ReglasNegocioBuscar) Se utiliza con los siguientes parámetros: Parámetro <Nombre> (string) <Naruraleza> (string) Nombre o parte del nombre de la/las reglas de las que se quiere obtener su ID. Para no limitar la búsqueda se puede dejar el campo en blanco. Naturaleza de la/las Reglas de las que se quiere obtener su ID. Los posibles valores son los siguientes: 1 : Textual 2 : Asignación 3 : Cálculo 4: Inferencia Para no limitar la búsqueda se puede dejar el campo en blanco Valor Devuelto ( XmlDocument ) Se obtendrá un documento XML con los siguientes datos de todas las Reglas que cumplen las condiciones de filtrado: <ID> (ID de la Regla) <Nombre> (Nombre de la Regla) <Naturaleza> (Naturaleza de la Regla. Ver códigos en (*) al final) (*) 1 = Textual, 2 = Asignación, 3 = Cálculo, 4 = Inferencia. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 56 de 102

57 Obtener datos de las Reglas de Negocio (ReglasNegocioDatosVer) Una vez obtenido el ID de una Regla de Negocio utilizando el método ReglasNegocioBuscar, se pueden obtener sus datos con el método ReglasNegocioDatosVer, cuyos parámetros se describen a continuación. Parámetro <idreglanegocio> (int) ID de la Regla cuyos datos se quieren obtener. Este campo es obligatorio. Valor Devuelto ( XmlDocument ) Se obtendrá un documento XML, con los siguientes datos, de la Regla cuyo ID se introdujo como valor del parámetro: Sección: < Regla >: (Devuelve los datos generales de la Regla) <ID> (ID de la Regla) <Codigo> (Código definido en la Regla) <Nombre> (Nombre de la Regla) <Naturaleza> (Naturaleza de la Regla. Ver códigos en (1) al final) <Descripcion> (Descripción de la Regla) <Clase> (Nombre de la Clase a la que pertenece la Regla) <Clave> (Nombre de la Clave definida en la Regla) <Responsable> (Nombre del Responsable de la Regla) <Recinto_Seguro> (Nombre del Recinto Seguro al que pertenece la Regla) <Vigencia> (Vigencia de la Regla. Ver códigos en (2) al final. En la versión actual el único valor mostrado corresponde a Permanente) <Estado> (Estado de la Regla. Ver códigos en (3) al final) <Comentarios> (Comentarios en la ficha de la Regla) <Texto_Regla> (Sólo aparece si la regla es de tipo Textual. Devuelve el texto de la Regla en formato HTML) (1) 1 = Textual, 2 = Asignación, 3 = Cálculo, 4 = Inferencia. (2) 1 = Permanente, 2= Con caducidad. (3) 1 = Certificada, 2 = No Certificada, 3 = Inactiva Temporal, 4 = Deshabilitada. Sección: < Asignacion >: (Define las asignaciones en una Regla de Asignación. Solo aparece si se trata de una Regla de Asignación. Habrá tantas secciones como asignaciones, numeradas de 1 a n). <ID> (ID de la asignación) <Nombre_Termino> (Es el nombre del término del diccionario utilizado para la asignación) <Tipo_de_Dato (Es el tipo de dato del término utilizado para la asignación) <Valor> (Es el valor dado a la asignación) Sección: < Operacion >: (Define las operaciones en una Regla de Cálculo. Solo aparece si se trata de una Regla de Cálculo. Habrá tantas secciones como operaciones, numeradas de 1 a n). <ID> (Es el ID de la operación). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 57 de 102

58 <Tipo_Operacion> (Es el tipo de operación de cálculo que realiza la regla. En la versión actual, el único valor posible es FormulaMatematica, correspondiente al tipo de operación Fórmula Matemática). <Resultado> (En el caso de una Operación Intermedia es el Nombre de la Variable. En el caso de una Operación Final es el Nombre del Campo donde se guardará el Resultado). <Formula> (Es la Fórmula matemática de la operación, Intermedia o Final). <Operacion> (Es el tipo de operación: Intermedia o Final). ATENCION Sección: < Criterio_Valor >: (Define los valores que pueden tomar los distintos Criterios en una Regla de Inferencia. Solo aparece si se trata de una Regla de Inferencia. Habrá tantas Secciones como valores distintos puedan presentar los distintos Criterios, numeradas de 1 a n). <Nombre_Criterio> (Es el nombre del campo o regla elegido como Criterio). <Modalidad> (Es la modalidad de la comparación. Sólo devolverá un valor cuando, al configurar el criterio, el tipo de campo lo hace necesario: por ejemplo, en el caso de comparación de fechas). (Ver posibles valores en (4) al final). <Operador> (Es el Operador que se ha utilizado al definir el Criterio. Sólo devolverá un valor cuando, al configurar el criterio, el tipo de campo lo hace necesario: por ejemplo, en el caso de comparación de fechas). (Ver posibles valores en (5) al final).) <Valor> (Es el valor del Criterio). (4): Fecha completa, Solo Años, Solo Meses, Solo Semanas, etc (5): <menor, >mayor, =igual, etc Sección: < Combinaciones >: (Combinaciones de valores de Criterios que forman la Tabla de Calificaciones en una Regla de Inferencia. Solo aparece si se trata de una Regla de Inferencia. Habrá tantas Secciones como combinaciones tenga la Tabla de Calificaciones, numeradas de 1 a n). <Nombre_Criterio 1> (Valor del Criterio). < > ( ) <Nombre_Criterio n> (Valor del Criterio). <Resultado> (Valor del Resultado) Obtener todas las tareas de un empleado (GetTasksByEmployee) Si no se pasan parámetros, se obtienen todas las tareas del empleado. Si se desea, no obstante, se puede filtrar utilizando Parámetros de Entrada. Parámetro <filtervalues> (array ValorCampo) Array de objetos ValorCampo. ValorCampo.id = X ValorCampo.valor = Valor_a_buscar INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 58 de 102

59 donde X puede tener los valores: 0: y se obtendrá el Nombre de la Clase de Tarea de todas las tareas o de Valor_a_buscar. 5: y se obtendrá la Referencia de todas las tareas o de Valor_a_buscar. 4: y se obtendrán los Temas de todas las tareas o de Valor_a_buscar. Valor Devuelto (Array de objetos ElementoFamilia[] ) Valores devueltos por cada tarea: Id Nombre Código Tema tema2 claseelemento claseproceso Familia prioridad rango naturaleza estado remitente creador clase ultimaaccion Ejemplo. List <ValorCampo> ListaParametros = new <ValorCampo>(); ValorCampo Parametro = new ValorCampo(); //Nombre de tarea Parametro.id = 0; Parametro.valor = "Valor_a_Buscar"; ListaParametros.Add(Parametro); //Referencia Parametro = new ValorCampo(); Parametro.id = 5; Parametro.valor = "ref"; //valor_a_ buscar ListaParametros.Add(Parametro); //Tema 1 Parametro = new ValorCampo(); Parametro.id = 4; INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 59 de 102

60 Parametro.valor = "tema"; //valor_a_buscar ListaParametros.Add(Parametro); Obtener datos de la duración del Proceso Para obtener datos de la duración existen los siguientes métodos: DurationProcessWorkingMinutes, con un único parámetro: - Process_ID. Devuelve los minutos hábiles de duración del Proceso indicado, es decir, teniendo en cuenta el calendario del Proceso. DurationObjectWorkingMinutes, con dos parámetros: - Object_Type(2=TPy 5=Mensaje IM/EM) y - Element_ID. Devuelve los minutos hábiles de duración del objeto indicado. DurationSpanWorkingMinutes. Requiere dos parámetros: - Span_ID y - Process_ID. Devuelve los minutos hábiles de duración de los Lapsos de Puntos de Control. 4. SERVICIO WEB AURAPORTALTAREAS.ASMX AuraPortalTareas es un Servicio Web incluido en AuraPortal, que posibilita que programas externos realizados a medida realicen operaciones con Tareas Libres y Programadas del portal de Empleados de AuraPortal. Nota. Las Tareas Personales de Procesos se manejan con el Servicio Web AuraPortalProcesos y los Servicios Web Personalizados (para Eventos de Mensaje de Inicio e Intermedios). Nota. Los métodos de este Servicio Web relacionados con Tareas Programadas se pueden utilizar, aunque AuraPortal Helium cubre todas las necesidades con sus Procesos. El Servicio Web AuraPortalTareas permite realizar las siguientes operaciones: Crear Tareas Libres y Programadas (no Personales de Proceso). Modificar Tareas Libres y Programadas (no Personales de Proceso). Cursar Tareas Programadas. Devolver Tareas Programadas. Enviar Tareas Libres. Terminar Tareas. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 60 de 102

61 Eliminar Tareas. Ingresar documentos en Tareas. Introducir Costes e Ingresos en Tareas. Enlazar los siguientes elementos a una Tarea: o o o o o o o Empleados Tareas Documentos Cuentas Ítems Proyectos Áreas Ver los siguientes elementos de las Tareas: o o o o o o o o o o Datos propios de la tarea (Creador, Nombre, Histórico, etc ) Empleados Enlazados. Tareas Enlazadas. Los Documentos Enlazados se obtienen con el Servicio Web AuraPortalDoc No se obtienen las Tareas enlazadas. Cuentas Enlazados. Ítems Enlazados. Proyectos Enlazados. Áreas Enlazadas. Costes e Ingresos. Ver, Introducir, Exportar y Eliminar Costes e Ingresos de las tareas Conexión Para conectarse al Servicio Web hace falta especificar los siguientes valores: URL del servicio ( ( host.dominio.com depende de cada instalación) Usuario / contraseña (el usuario debe estar dado de alta en AuraPortal y en SharePoint) En general, los únicos usuarios que podrán realizar acciones en la tarea a través del Servicio Web AuraPortalTareas.asmx son el Asignado actual de la tarea y AdminPortal, si bien en algunos casos los Administradores Delegados podrán utilizar algunos métodos. Ver detalles en los apartados de cada método. Nota. Los usuarios que pueden manejar Tareas a través del Servicio Web AuraPoralTareas, son los siguientes: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 61 de 102

62 - Asignado Actual. - Administradores Delegados. - AdminPortal (excepto crear Tareas) Métodos Para ver los métodos del Servicio Web AuraPortalTareas, teclear la URL del Servicio Web: ( host.dominio.com depende de cada instalación) y obtendremos una página similar a la siguiente con la lista de métodos del Servicio Web AuraPortalTareas: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 62 de 102

63 Si pulsamos sobre el link descripción de servicios (o añadimos?wsdl a la URL) obtendremos la descripción del Servicio Web o WSDL (Web Service Description Language) en formato XML. Si pulsamos sobre uno de los métodos, por ejemplo CreateTarea obtendremos el siguiente resultado: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 63 de 102

64 Si estamos trabajando desde el propio servidor de AuraPortal tendremos la posibilidad de poner valores en las tres casillas de parámetros: ClassId, Tasktitle y TaskComments. Y en <soap:body> veremos el tipo de valor que requiere cada parámetro, en este caso: - <ClassId>int</ClassId> = Número entero que corresponde al ID de la Clase de Tarea que se quiere crear. Es obligatorio. - <Tasktitle>string< /Tasktitle > = Valor de tipo string, que corresponde al Nombre de la tarea a crear. Si se deja en blanco, aparecerá con nombre _No Definido. - <TaskComments>string</TaskComments > Valor de tipo string, que corresponde a los Comentarios que se verán en el Histórico de la tarea a crear. Es opcional. A continuación se detallan y se comentan los siguientes métodos del Servicio Web AuraPortalTareas Crear Tareas Libres (CreateTareaLibre y CreateTarea) Hay dos métodos para crear Tareas Libres y Programadas (no Tareas Personales de Proceso), que son CreateTareaLibre y CreateTarea. La diferencia entre ambas es que CreateTareaLibre tiene más parámetros. Los parámetros de CreateTareaLibre son los siguientes: Parámetro < IdClaseTarea > (int) < Nombre > (string) Es obligatorio, y corresponde al ID de la Clase de Tarea a Crear. Pueden ser utilizadas Clases de Tarea que no estén ubicadas en el árbol de Clases de Tareas. Es el Nombre de la tarea a crear. Si se deja en blanco aparecerá un _ como nombre. < Historico > (string) Es opcional, y es el texto que aparecerá en el Histórico de la tarea a crear. < PrioridadOriginal > (string) < PrioridadActual > (string) < Aviso > (string) Tres son los valores posibles: 1: Alta 2: Media 3: Baja Si no se indica se creará con Prioridad Original Media. Tres son los valores posibles: 1: Alta 2: Media 3: Baja Si no se indica se creará sin Prioridad Actual. Es la fecha de Aviso en formato aaaa-mm-dd, por ejemplo, para el 31 de enero de 2016hay que indicar INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 64 de 102

65 < Dormida > (string) < Rango > (string) < Confidencial > (string) < PrevisionFechaOriginalInicio> (datetime) < PrevisionFechaOriginalFin> (string)) < PrevisionFechaActualInicio> (string) < PrevisionFechaActualFin> (string) Indica si la tarea está Dormida o no. Los posibles valores son: 0: Despierta 1: Dormida Si se indica 1 (Dormida), es obligatorio indicar una Fecha de Aviso en el parámetro <Aviso>. De lo contrario se obtendrá el Código de Devolución - 3. Si se indican otros valores se ignorarán y se creará Despierta. Indica el Rango de la tarea, orden en el que se mostrará en el Grid de Mis Tareas. Los posibles valores son un número entre 0 y 90. Indica si la tarea es Confidencial o no. Los posibles valores son: 0: No Confidencial 1: Confidencial Si se indican otros valores se ignorarán y se creará No Confidencial. Es la fecha de Previsión Original de Inicio de la tarea en formato aaaa-mmdd, por ejemplo, para el 31 de enero de 2013 hay que indicar Si se desea indicar horas ha de ser con formato hh:mm:ss pero con la condición de que mm sólo sea 00 o 30 y ss sólo 00. Por ejemplo, si se desea indicar las 12:30 del 31 de enero de 2016, el formato correcto será: :30:00 Si se indica mal el formato, la fecha o la hora no se rellenarán. Es la fecha de Previsión Original de Finalización de la tarea en formato aaaa-mm-dd, por ejemplo, para el 31 de enero de 2015 hay que indicar Si se desea indicar horas ha de ser con formato hh:mm:ss pero con la condición de que mm sólo sea 00 o 30 y ss solo 00. Por ejemplo, si se desea indicar las 12:30 del 31 de enero de 2016, el formato correcto será: :30:00 Si se indica mal el formato, la fecha o la hora no se rellenarán. Es la fecha de Previsión Actual de Inicio de la tarea en formato aaaa-mmdd, por ejemplo, para el 31 de enero de 2016 hay que indicar Si se desea indicar horas ha de ser con formato hh:mm:ss pero con la condición de que mm sólo sea 00 o 30 y ss solo 00. Por ejemplo, si se desea indicar las 12:30 del 31 de enero de 2016, el formato correcto será: :30:00 Si se indica mal el formato, la fecha o la hora no se rellenarán. Es la fecha de Previsión Actual de Finalización de la tarea en formato aaaamm-dd, por ejemplo, para el 31 de enero de 2016 hay que indicar Si se desea indicar horas ha de ser con formato hh:mm:ss pero con la condición de que mm sólo sea 00 o 30 y ss solo 00. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 65 de 102

66 Por ejemplo, si se desea indicar las 12:30 del 31 de enero de 2016, el formato correcto será: :30:00 Si se indica mal el formato la fecha o la hora no se rellenarán. < PrevisionCosteOriginal> (string) < PrevisionIngresoOriginal> (string) < PrevisionCosteActual> (string) < PrevisionIngresoActual> (string) Es la Previsión de Coste Original. Si se desea indicar decimales puede hacerse con separador punto o coma, indistintamente. Si no se indica, la tarea se creará con este campo con valor 0. Es la Previsión de Ingreso Actual. Si se desea indicar decimales puede hacerse con separador punto o coma, indistintamente. Si no se indica, la tarea se creará con este campo con valor 0. Es la Previsión de Coste Actual. Si se desea indicar decimales puede hacerse con separador punto o coma, indistintamente. Si no se indica, la tarea se creará con este campo con valor 0. Es la Previsión de Ingreso Actual. Si se desea indicar decimales puede hacerse con separador punto o coma, indistintamente. Si no se indica, la tarea se creará con este campo con valor 0. Los parámetros de CreateTarea son los siguientes: Parámetro < ClassId > (int) < TaskTitle > (string) < TaskComments > (string) Es obligatorio, y corresponde al ID de la Clase de Tarea a Crear. Pueden ser utilizadas Clases de Tarea que no estén ubicadas en el árbol de Clases de Tareas. Es el Nombre de la tarea a crear. Si se deja en blanco, aparecerá con nombre _No Definido. Es opcional, y es el texto que aparecerá en el Histórico de la tarea a crear. Valor devuelto ( int ) Si devuelve un número mayor que 0, es el ID de la Tarea Creada. Los códigos de devolución son negativos y son los siguientes: -1: No se ha podido comprobar el login del usuario. -2: Este usuario no puede crear tareas. Ver nota de Permisos en cuadro siguiente. -3: No existe la Clase de Tarea indicada en ClassId o se ha indicado tarea Dormida pero falta la fecha de Aviso. También se obtiene -3 con otros problemas indefinidos. -5: No se tienen permisos para crear tareas de la Clase de Tarea indicada en ClassId. Revisar los permisos por Grupos de Empleados. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 66 de 102

67 Permisos. Pueden utilizar el método CreateTarea los siguientes usuarios: - Cualquiera que sea integrante de un Grupo de Empleados con permisos en la Clase de Tarea indicada en ClassId. - AdminPortal NO puede crear tareas. Nota. La tarea creada con el Servicio Web AuraPortalTareas queda, por defecto, en estado Latente, estado en el que se pueden realizar modificaciones antes de Cursarla (Programadas) o Enviarla (Libres), para lo que hay varios métodos que se explican a continuación. Para Cursar tareas Libres Programadas hay dos métodos, ProcessTareaID y ProcessTareaGUID comentados con detalle más adelante en su apartado correspondiente. Ambos métodos cursan tareas Libres Programadas, pero la diferencia entre ellos es la manera de indicar el Asignado en los casos en los que en la siguiente FASE de la tarea el Asignado es A INDICAR EN LA FASE ANTERIOR (opción que se configura en la Clase de Tareas). - Con el método ProcessTareaGUID hay que indicar un GUID del empleado, es decir, el identificador del Cargo al que se quiere Cursar la tarea. Téngase en cuenta que las tareas programadas se cursan siempre al Cargo de un Empleado, y un Empleado puede tener varios cargos en el organigrama de AuraPortal. - Con el método ProcessTareaID hay que indicar el ID del empleado, es decir, el identificador único del Empleado en AuraPortal al que se quiere Cursar la tarea. Cómo las tareas programadas se cursan siempre al Cargo de un Empleado, lo que hará el método es cursar la tarea automáticamente al Cargo más alto de este Empleado en el organigrama. Es una facilidad para no tener que saber el GUID de un Empleado cuando no importe el Cargo que recibirá la tarea. Permisos. Pueden utilizar el método CreateTarea los siguientes usuarios: - Cualquiera que sea integrante de un Grupo de Empleados con permisos en la Clase de Tarea indicada en ClassId. - AdminPortal NO puede crear tareas. Nota. La tarea creada con el Servicio Web AuraPortalTareas queda, por defecto, en estado Latente, estado en el que se pueden realizar modificaciones antes de Cursarla (Programadas) o Enviarla (Libres), para lo que hay varios métodos que se explican a continuación Modificar Tareas (UpdateFichaTarea) Con el método UpdateFichaTarea se pueden modificar ciertos datos de la ficha de la tarea, concretamente, añadir comentarios en el Histórico, la Prioridad Actual, la Fecha de Aviso y las Previsiones Actuales (Fecha y Coste). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 67 de 102

68 En otros métodos, que están explicados posteriormente, se pueden integrar y enlazar documentos, Empleados, Cuentas, Ítems, Proyectos y Áreas. Sus parámetros son los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a modificar. < Historico > (string) Se añadirá en el Histórico que haya. < PrioridadActual > (String) < Aviso > (DateTime) < PrevisionFechaActualInicio > (DateTime) < PrevisionFechaActualFin > (DateTime) < PrevisionCosteActual > (float) < PrevisionIngresoActual > (float) Los posibles valores son: _NoDefinido (será introducido como _No Definido) Alta Media Baja Fecha y hora, que en la Tarea de AuraPortal representa el valor PRIORIDAD Aviso. El formato correcto es DD/MM/AA (día/mes/año). Fecha y hora, que en la Tarea de AuraPortal representa el valor PREVISIÓN ACTUAL Fecha Inicio. El formato correcto es DD/MM/AA hh:mm (día/mes/año hora:minuto). Los minutos han de ser 00 o 30, si no, el Servicio Web lo redondeará a la cantidad inferior. Fecha y hora, que en la Tarea de AuraPortal representa el valor PREVISIÓN ACTUAL Fecha Fin. El formato correcto es DD/MM/AA hh:mm (día/mes/año hora:minuto). Los minutos han de ser 00 o 30, si no, el Servicio Web lo redondeará a la cantidad inferior. Número con decimales, que en la Tarea de AuraPortal representa el valor PREVISIÓN ACTUAL Costes. Número con decimales, que en la Tarea de AuraPortal representa el valor PREVISIÓN ACTUAL Ingresos. Valor devuelto ( int ) Si se recibe el número 0 es que la tarea se ha modificado correctamente. Los códigos de devolución son negativos y son los siguientes: -2: Problema indefinido. -4: El usuario que intenta modificar la tarea no tiene suficientes permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea que se intenta modificar. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 68 de 102

69 Permisos. Pueden utilizar el método UpdateFichaTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado tiene sentido en tareas Programadas cuando la tarea se envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Cursar Tareas Programadas a un Cargo (ProcessTareaGUID) El método utilizado para Cursar Tareas Programadas eligiendo el GUID del Cargo es ProcessTareaGUID, siendo sus parámetros los siguientes: Nota. Los métodos de este Servicio Web relacionados con Tareas Programadas se pueden utilizar, aunque AuraPortal Helium cubre todas las necesidades con sus Procesos. Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a cursar. < AssignedGuid > (string) Es obligatorio introducir un valor, aunque sea 0, pero sólo es necesario indicar un GUID existente cuando el Asignado de la Fase 2 configurado en la Clase de Tarea es: A INDICAR EN FASE ANTERIOR. Su valor ha de ser el GUID del Asignado de la siguiente Fase. En los demás casos, cuando el asignado de la Fase 2 de la Clase de Tarea no es A INDICAR EN LA FASE ANTERIOR, hay que dejar este parámetro con el valor 0 (cero). Si se indica otro valor se omitirá, e igualmente se cursará al que esté configurado en la Clase de Tarea. Si se deja en blanco se obtendrá un error. Los GUIDs (Cargos) de un Empleado se pueden ver con el método GetCargosEmpleado del Servicio Web AuraPortalFamilias. Valor devuelto ( int ) Si se recibe el número 0 es que la tarea se ha cursado correctamente. Los códigos de devolución son negativos y son los siguientes: -1: Se está intentando cursar una tarea Terminada o está en la última fase. En este caso sólo se puede Terminar. -2: Problema indefinido. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 69 de 102

70 -4: El usuario que intenta cursar la tarea no tiene suficientes permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea que se intenta cursar. -11: Problema al Cursar la tarea. Quizás el GUID no existe o la tarea está Terminada. -12: La tarea indicada es de Clase Libre. Sólo se pueden Cursar tareas de Clase Programada. Permisos. Pueden utilizar el método ProcessTareaGuid los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado tiene sentido en tareas Programadas cuando la tarea se envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Cursar tareas Programadas a un Empleado (ProcessTareaID) El método utilizado para Cursar Tareas Programadas eligiendo el ID del Asignado es ProcessTareaID, siendo sus parámetros los siguientes: Nota. Los métodos de este Servicio Web relacionados con Tareas Programadas se pueden utilizar, aunque AuraPortal Helium cubre todas las necesidades con sus Procesos. Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a cursar. < AssignedId > (string) Es obligatorio introducir un valor, aunque sea 0, pero sólo es necesario indicar un ID existente cuando el Asignado de la Fase 2 configurado en la Clase de Tarea es: A INDICAR EN FASE ANTERIOR. Su valor ha de ser el ID del Asignado de la siguiente Fase. Como las tareas programadas sólo se pueden cursar a Cargos y en este método se indica el ID, este método automáticamente cursará la tarea al cargo más alto del empleado indicado con el ID, según el árbol de empleados. En los demás casos, cuando el asignado de la Fase 2 de la Clase de Tarea no es A INDICAR EN LA FASE ANTERIOR, hay que dejar este parámetro con el valor 0 (cero). Si se indica otro valor se omitirá, e igualmente se cursará al que esté configurado en la Clase de Tarea. Si se deja en blanco se obtendrá un error. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 70 de 102

71 Valor devuelto ( int ) Si re recibe el número 0 es que la tarea se ha cursado correctamente. Los códigos de devolución son negativos y son los siguientes: -1: Se está intentando Cursar una tarea Terminada o está en la última fase. En este caso sólo se puede Terminar. -2: Problema indefinido. -4: El usuario que intenta cursar la tarea no tiene suficientes permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea que se intenta cursar. -11: Problema al Enviar la tarea. Quizás el ID no existe o la tarea está Terminada. -12: La tarea indicada es de Clase Libre. Sólo se pueden Cursar tareas de Clase Programada. Permisos. Pueden utilizar el método ProcessTareaID los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Devolver Tareas Programadas (RejectTarea) El método utilizado para Devolver Tareas Programadas es RejectTarea, siendo su parámetro el siguiente: Nota. Los métodos de este Servicio Web relacionados con Tareas Programadas se pueden utilizar, aunque AuraPortal Helium cubre todas las necesidades con sus Procesos. Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a devolver. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 71 de 102

72 Valor devuelto ( int ) Si re recibe el número 0 es que la tarea se ha devuelto correctamente. Los códigos de devolución son negativos y son los siguientes: -1: La tarea que se quiere Devolver no es de Clase Programada o está Terminada. Las tareas de Clase Libre no se pueden Devolver, sólo Enviar. -2: No se encuentra el Delegado Anterior necesario para Devolver la tarea. -4: No se tienen permisos suficientes para Devolver la tarea. Ver nota de Permisos en cuadro siguiente. -8: No se encuentra la tarea indicada en TaskId. Permisos. Pueden utilizar el método RejectTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enviar Tareas Libres por Cargo (SendTareaGUID) El método utilizado para Enviar Tareas Libres por Cargo eligiendo el GUID del Asignado es SendTareaGUID, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a cursar. < AssignedGuid > (string) Es obligatorio, y es el GUID del Cargo al cual se quiere enviar la tarea. Los GUIDs (Cargos) de un Empleado se pueden ver con el método GetCargosEmpleado del Servicio Web AuraPortalFamilias. Valor devuelto ( int ) Si recibe el número 0 es que la tarea se ha enviado correctamente. Los códigos de devolución son negativos y son los siguientes: -4: El usuario que intenta enviar la tarea no tiene suficientes permisos o la tarea está Terminada. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea que se intenta cursar. -9: No existe el GUID del asignado. -10: La tarea es de Clase Libre por Persona. Sólo se pueden Enviar por GUID tareas de Clase Libres por Cargo. -12: La tarea es de Clase Programada. Sólo se pueden Enviar tareas de Clase Libre. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 72 de 102

73 Permisos. Pueden utilizar el método SendTareaGUID los siguientes usuarios: - Asignado Actual. - AdminPortal Enviar Tareas Libres por Persona (SendTareaID) El método utilizado para enviar tareas Libres por Persona eligiendo el ID del Asignado es SendTareaID. También se puede utilizar este método para enviar Tareas Libres por Cargo porque el método automáticamente cursará la tarea al Cargo (GUID) más alto del AssignedId indicado, según el árbol de empleados. Sus parámetros son los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a enviar. < AssignedId > (int) Es obligatorio, y es el ID del Empleado al cual se quiere Enviar la tarea. Si la tarea que se envía es Libre por Cargo, como en este método se indica ID del Empleado, se cursará la tarea a su Cargo (GUID) más alto según el árbol de empleados. Valor devuelto ( int ) Si re recibe el número 0 es que la tarea se ha cursado correctamente. Los códigos de devolución son negativos y son los siguientes: -4: El usuario que intenta cursar en la tarea no tiene suficientes permisos. Ver nota de Permisos en cuadro siguiente. Quizás la tarea esté Terminada. -8: No existe la tarea que se intenta cursar. -9: No existe el ID del Asignado indicado. -12: La tarea es de Clase Programada. Sólo se pueden Enviar tareas de Clase Libre. Permisos. Pueden utilizar el método SendTareaID los siguientes usuarios: - Asignado Actual. - AdminPortal Terminar Tareas (EndTarea) El método utilizado para TERMINAR la tarea CON ÉXITO o SIN ÉXITO es EndTarea, siendo sus parámetros los siguientes: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 73 de 102

74 Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a terminar. < Exito > (bool) Indica si la tarea se Termina CON ÉXITO (true) o SIN ÉXITO (false). Valor devuelto ( int ) Si se recibe el número 0 es que la tarea se ha terminado correctamente. Los códigos de devolución son negativos y son los siguientes: -2: El usuario que intenta terminar la tarea no tiene permisos. Ver nota de Permisos en cuadro siguiente. -8: La tarea que se intenta terminar no existe. -11: La tarea que se intenta Terminar Con Éxito es de Clase Programada y no está en la última fase. Sólo se puede Terminar Con Éxito si está en la última fase o es de Clase Libre. Permisos. Pueden utilizar el método EndTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal. Si la tarea es programada, para Terminarla Con Éxito tiene que estar en la última Fase Eliminar Tareas (DeleteTarea) El método utilizado para eliminar Tareas Libres y Programadas (No Personales de Proceso) es DeleteTarea, siendo sus parámetros: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a eliminar. Valor devuelto ( int ) Si se recibe el número 0, es que la tarea se ha eliminado correctamente. Los códigos de devolución son negativos y son los siguientes: -1: Problema Indefinido. -2: El usuario que intenta eliminar la tarea no tiene permisos. Ver nota de Permisos en cuadro siguiente. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 74 de 102

75 -8: La tarea que se intenta eliminar no existe. Permisos. Pueden utilizar el método DeleteTarea los siguientes usuarios: - Creador. Siempre si es de Clase Libre, y si es de Clase Programada sólo cuando está en Fase 1 (porque está Latente o ha sido Devuelta hasta el Creador). - AdminPortal Ver ID de Tareas (GetIdTarea) El método utilizado para ver los ID de tarea es GetIdTarea, siendo sus parámetros los siguientes: Parámetro < TaskTitle > (int) < ClassId > (int) Es parte del Nombre de las Tareas de las que queremos visualizar su ID. Si no introducimos nada veremos todas las tareas de la Clase indicada en el siguiente parámetro, ClassId. Es obligatorio, y es el ID de la Clase de Tarea a visualizar. Para ver todas las Clases introducir el número 0. Valor devuelto (XmlDocument) Se recibe un documento XML estructurado con el IdTarea, Nombre, IdClaseTarea y NombreClaseTarea de todas las tareas que cumplen las condiciones de filtrado. Si hay un error de permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se devuelve el siguiente documento: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> Nota. No se obtendrán las tareas de Clase Programada cuando están Asignadas a un Grupo. Permisos. Pueden utilizar el método GetFichaTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 75 de 102

76 - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal. Nota. Con el método GetIdTarea no se obtendrán las tareas de Clase Programada cuando están Asignadas a un Grupo Ver Datos de Tareas (GetFichaTarea) El método utilizado para ver los datos de la tarea es GetFichaTarea, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a visualizar. Valor devuelto (XmlDocument) Se recibe un documento XML estructurado con los campos y valores de la tarea. Para comprender el significado de todos los campos obtenidos en el documento XML, conviene dirigirse al Capítulo LOCALIZACIÓN DE LOS DATOS EN LISTAS DE SHAREPOINT. Si hay un problema de permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se devuelve el siguiente documento: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> Permisos. Pueden utilizar el método GetFichaTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Integrar Documentos a una Tarea (IntegrateDoc) El método utilizado para integrar documentos en una tarea es IntegrateDoc, siendo sus parámetros los siguientes: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 76 de 102

77 Parámetro < TaskId > (int) < FileStream > (byte[]) Es obligatorio, y su valor es el ID de la Tarea a la que se le quiere integrar un documento. Es obligatorio, y debe ser la secuencia de bytes que representa el documento que se desea integrar. < FileName > (string) Es obligatorio, y es el Nombre del documento que se desea integrar. < Principal > (bool) < SaveInBiblio > (bool) Es obligatorio, e indica si el documento integrado estará marcado como Principal en el Data Grid de la tarea o no. Los posibles valores son: True o False. Es obligatorio, e indica, en la Clase de Tareas Programada configurada con Acciones al Terminar Ingresar en Biblioteca, si el documento integrado se marcará para ser ingresado en la biblioteca o no. Los posibles valores son: True o False. Valor devuelto (int) Si se recibe el número 0 es que el documento se ha integrado correctamente. Los códigos de devolución son negativos y son los siguientes: -1: Problema integrando el documento. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -3: Problema actualizando el contador de documentos integrados. Permisos. Pueden utilizar el método IntegrateDoc los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Asociar URL a una Tarea (LinkDoc) El método utilizado para asociar URL en una tarea (en Doc. Asociados) es LinkDoc, siendo sus parámetros los siguientes: Parámetro INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 77 de 102

78 < TaskId > (int) < UrlDoc > (string) < Name > (string) < Principal > (bool) Es obligatorio, y su valor es el ID de la Tarea a la que se le quiere asociar la URL de un documento. Es obligatorio, y debe ser la URL absoluta del documento que se desea asociar. Es obligatorio, y será el nombre visible en el Data Grid, que puede coincidir o no con la URL. Es obligatorio, e indica si el documento enlazado estará marcado como Principal en el Data Grid de la tarea o no. Posibles valores: True o False. Valor devuelto (int) Si se recibe el número 0 es que el documento se ha enlazado correctamente. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar el documento. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -3: Problema actualizando el contador de documentos enlazados. -8: No existe la tarea con el ID que se ha indicado. Permisos. Pueden utilizar el método LinkDoc los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Empleados en una Tarea (LinkEmpleado) El método utilizado para enlazar Empleados a una tarea es LinkEmpleado, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y su valor es el ID de la Tarea a la que se le quiere enlazar el empleado. < IdEmpleado > (int) Es obligatorio, y es el ID del Empleado que se desea enlazar la tarea. < Principal > (bool) Es obligatorio, e indica si el Empleado enlazado estará marcado como Principal en el Data Grid o no. Los posibles valores son: True o False. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 78 de 102

79 Valor devuelto (int) Si el número obtenido es mayor que 0, es el ID del Enlace que se ha creado en la lista de SharePoint AP EmpleadosEnlazadosTareas. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar el Empleado. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: No existe el Empleado que se quiere vincular a la tarea. Permisos. Pueden utilizar el método LinkEmpleado los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Tareas en otra Tarea (LinkTarea) El método utilizado para enlazar Tareas Libres y Programadas (No Personales de Proceso) es LinkTarea, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) < TaskIdDestino > (int) Es obligatorio, y es el ID de la Tarea que queremos enlazar. Esta tarea quedará enlazada en el árbol de tareas enlazadas de la indicada en el parámetro TaskIdDestino. La tarea indicada en TaskId NO puede estar previamente enlazada a ninguna otra tarea. Es obligatorio, y es el ID de la Tarea a la que queremos enlazar la tarea indicada en TaskId. La tarea indicada en TaskIdDestino SÍ puede estar previamente enlazada a otras tareas. Valor devuelto INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 79 de 102

80 (int) Si el número obtenido es mayor que 0 es la tarea se ha enlazado correctamente. Los códigos de devolución son negativos y son los siguientes: -4: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: La tarea indicada ya está enlazada a otras. Permisos. Pueden utilizar el método LinkTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Cuentas en una Tarea (LinkCuenta) El método utilizado para enlazar Cuentas a una tarea es LinkCuenta, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a la que se le quiere enlazar una Cuenta. < IdCuenta > (int) Es obligatorio, y es el ID de la Cuenta que se desea enlazar a la tarea. < Principal > (bool) Es obligatorio, e indica si la Cuenta enlazada estará marcada como Principal en el Data Grid o no. Los posibles valores son: True o False. Valor devuelto (int) Si el número obtenido es mayor que 0, es el ID del Enlace que se ha creado en la lista de SharePoint AP CuentasEnlazadasTareas. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar la Cuenta. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: No existe la Cuenta que se quiere vincular a la tarea. Permisos. Pueden utilizar el método LinkCuenta los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 80 de 102

81 Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Ítems en una Tarea (LinkItem) El método utilizado para enlazar Ítems a una tarea es LinkItem, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a la que se le quiere enlazar el Ítem. < IdItem > (int) Es obligatorio, y es el ID del Ítem que se desea enlazar a la tarea. < Principal > (bool) Es obligatorio, e indica si el Ítem enlazado estará marcado como Principal en el Data Grid o no. Los posibles valores son: True o False. Valor devuelto (int) Si el número obtenido es mayor que 0, es el ID del Enlace que se ha creado en la lista de SharePoint AP ItemsEnlazadosTareas. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar el Ítem. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: No existe el Ítem que se quiere vincular a la tarea. Permisos. Pueden utilizar el método LinkItem los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Proyectos en una Tarea (LinkProyecto) El método utilizado para enlazar Proyectos a una tarea es LinkProyecto, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a la que se le quiere enlazar el Proyecto. < IdProyecto > (int) Es obligatorio, y es el ID del Proyecto que se desea enlazar a la tarea. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 81 de 102

82 < Principal > (bool) Es obligatorio, e indica si el Proyecto enlazado estará marcado como Principal en el Data Grid o no. Los posibles valores son: True o False. Valor devuelto Si el número obtenido es mayor que 0, es el ID del Enlace que se ha creado en (int) la lista de SharePoint AP ProyectosEnlazadosTareas. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar el Proyecto. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: No existe el Proyecto que se quiere vincular a la tarea. Permisos. Pueden utilizar el método LinkProyecto los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Enlazar Áreas en una Tarea (LinkAmbito) El método utilizado para enlazar Áreas a una tarea es LinkAmbito, siendo sus parámetros los siguientes: Nota. Desde AuraPortal v3.1, se ha sustituido el nombre de la Familia Ámbitos por Áreas. Sin embargo, por compatibilidad con programas externos que hayan sido realizados con versiones anteriores, los métodos de los Servicios Web relacionados con esta Familia, han conservado su nombre original basado en la palabra ambito. Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea a la que se le quiere enlazar el Área. < IdAmbito > (int) Es obligatorio, y es el ID del Área que se desea enlazar a la tarea. < Principal > (bool) Es obligatorio, e indica si el Área enlazada estará marcada como Principal en el Data Grid o no. Los posibles valores son: True o False. Valor devuelto INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 82 de 102

83 (int) Si el número obtenido es mayor que 0, es el ID del Enlace que se ha creado en la lista de SharePoint AP AmbitosEnlazadosTareas. Los códigos de devolución son negativos y son los siguientes: -1: Problema al enlazar el Área. -2: Problema de permisos. Ver nota de Permisos en cuadro siguiente. -8: No existe la tarea con el ID que se ha indicado. -9: No existe el Área que se quiere vincular a la tarea. Permisos. Pueden utilizar el método LinkAmbito los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Ver Empleados Enlazados a una Tarea (GetEmpleadosEnlazados) El método utilizado para visualizar los Empleados enlazados a una tarea es GetEmpleadosEnlazados, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Empleados enlazados. Valor devuelto (XmlDocument) Devolverá un documento XML indicando el ID y Nombre de todos los Empleados enlazados en la tarea, y cual es Principal en el Data-Grid. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución Si no hay ningún Empleado Enlazado en la tarea, devolverá el mismo documento XML pero con el Código de Devolución -9. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 83 de 102

84 Permisos. Pueden utilizar el método GetEmpleadosEnlazados los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Ver Tareas Enlazadas a una Tarea (GetTareasEnlazadas) El método utilizado para ver las Tareas Libres y Programadas (No Personales de Proceso) enlazadas a una tarea es GetTareasEnlazadas, siendo su parámetro el siguiente: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Tareas enlazadas. Valor devuelto (XmlDocument) Devolverá un documento XML con el árbol de tareas enlazadas, indicando el IdTarea, el Nombre (Título) y el IdNivelSuperior de todas las Tareas enlazadas a la tarea indicada en TaskId. El IdNivelSuperior es el ID de la Tarea de la rama desde donde está enlazada cada tarea. - Si no hay ninguna Tarea Enlazada en la tarea, devolverá el mismo documento XML pero sólo con los datos de la propia tarea indicada en TaskId y con el IdNivelSuperior = 0, que indica que es el principio del árbol. - Si hay un problema de permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución -8. Permisos. Pueden utilizar el método GetTareasEnlazadas los siguientes usuarios: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 84 de 102

85 - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Ver Cuentas Enlazadas a una Tarea (GetCuentasEnlazadas) El método utilizado para ver las Cuentas enlazadas en una tarea es GetCuentasEnlazadas, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Cuentas enlazadas. Valor devuelto (XmlDocument) Devolverá un documento XML indicando el ID y Nombre de todas las Cuentas enlazadas en la tarea, y cual es Principal en el Data-Grid. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución Si no hay ninguna Cuenta enlazada en la tarea, devolverá el mismo documento XML pero con el Código de Devolución -9. Permisos. Pueden utilizar el método GetCuentasEnlazadas los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 85 de 102

86 - AdminPortal Ver Ítems Enlazados a una Tarea (GetItemsEnlazados) El método utilizado para visualizar los Proyectos enlazados a una tarea es GetItemsEnlazados, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Ítems enlazados. Valor devuelto (XmlDocument) Devolverá un documento XML indicando el ID y Nombre de todos los Ítems enlazados en la tarea, y cual es Principal en el Data-Grid. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución Si no hay ningún Ítem enlazado en la tarea, devolverá el mismo documento XML pero con el Código de Devolución -9. Permisos. Pueden utilizar el método GetItemsEnlazados los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Ver Proyectos Enlazados a una Tarea (GetProyectosEnlazados) El método utilizado para ver qué Proyectos están enlazados en una tarea es GetProyectosEnlazados, siendo sus parámetros los siguientes: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 86 de 102

87 Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Proyectos enlazados. Valor devuelto Devolverá un documento XML indicando el ID y Nombre de todos los Proyectos enlazados en la tarea, y cual es Principal en el Data-Grid. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: (XmlDocument) <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución Si no hay ningún Proyecto enlazado en la tarea, devolverá el mismo documento XML pero con el Código de Devolución -9. Permisos. Pueden utilizar el método GetProyectosEnlazados los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Ver Áreas Enlazadas a una Tarea (GetAmbitosEnlazados) El método utilizado para visualizar las Áreas enlazadas a una tarea es GetAmbitosEnlazados, siendo sus parámetros los siguientes: Nota. A partir de AuraPortal v3.1, se ha sustituido el nombre de la Familia Ámbitos por Áreas. Sin embargo, por compatibilidad con programas externos que hayan sido realizados con versiones anteriores, los métodos de los Servicios Web relacionados con esta Familia, han conservado su nombre original basado en la palabra ambito. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 87 de 102

88 Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Áreas enlazadas. Valor devuelto Devolverá un documento XML indicando el ID y Nombre de todas las Áreas enlazadas en la tarea, y cual es Principal en el Data-Grid. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el (XmlDocument) siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> - Si no hay ninguna tarea con el ID indicado, devolverá el mismo documento XML pero con el Código de Devolución Si no hay ningún Área enlazada en la tarea, devolverá el mismo documento XML pero con el Código de Devolución -9. Permisos. Pueden utilizar el método GetAmbitosEnlazados los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal Ver Costes o Ingresos de Tareas (GetCostesTarea y GetIngresosTarea) Los métodos utilizados para visualizar los Costes o Ingresos de las Tareas Libres y Programadas (No Personales de Proceso) son GetCostesTarea y GetIngresosTarea, siendo sus parámetros los siguientes: Parámetro < TaskId > (int) Es obligatorio, y es el ID de la Tarea de la que se quieren ver sus Costes o Ingresos. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 88 de 102

89 Valor devuelto (XmlDocument) Devolverá un documento XML indicando todos los datos de Costes o Ingresos de la tarea indicada. El significado de los datos está detallado en la tabla al final en este mismo apartado: - Si no hay Costes o Ingresos, el documento que se obtendrá estará vacío. - Si no se tienen suficientes permisos para visualizar los datos de la tarea (ver nota de Permisos en cuadro siguiente), se obtendrá un documento XML con el siguiente código: <?xml version="1.0" encoding="utf-8"?> <Errores> <Error>-4</Error> </Errores> Para comprender el significado de cada campo obtenido en el documento XML, conviene ver la tabla mostrada a continuación en este mismo apartado y también el Capítulo LOCALIZACIÓN DE LOS DATOS EN LISTAS DE SHAREPOINT más adelante en este documento. Permisos. Pueden utilizar el método GetCostesTarea y GetIngresosTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - Creador. - Administrador Delegado (perteneciente al grupo). - AdminPortal. A continuación se muestra una tabla con los datos que se obtienen, su relación en el interface de AuraPortal y su descripción: DATOS OBTENIDOS COSTES INGRESOS Campo en interface de AP Descripción NombreItemAsc = Item Nombre del Ítem introducido como Coste o Ingreso, de la lista AP ItemsFichas. CodigoERPItem = Código ERP Código ERP del Ítem Enlazado, de la lista AP ItemsFichas. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 89 de 102

90 Fecha = Fecha Fecha indicada manualmente en la introducción del Coste o Ingreso. Por defecto es la del día que se introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. Formato DataTime. UsuarioAsc = Empleado Nombre del Empleado indicado manualmente en la introducción del Coste o Ingreso. Por defecto es el usuario que introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. Descripcion = Comentarios Comentarios introducidos en el Coste o Ingreso. Cantidad = Cantidad Cantidad de unidades de Coste o Ingresos introducidos en la línea. PrecioUnidad = Concepto de Coste o Concepto de Ingreso Valor introducido en el Concepto de Coste o de Ingreso en la ficha del Ítem (lista AP ItemsFichas). Descuento = Variación% Variación porcentual del precio en el Coste o Ingreso. Puede ser positiva o negativa. PrecioCoste PrecioVenta Precio Precio final aplicado por unidad de Coste o Ingreso. Por defecto es el resultante de haberlo cogido de la ficha del Ítem (Concepto de Coste o Ingreso), pero varía si se aplica la Variación%, o se introduce directamente a mano en el campo Precio de Coste o Ingreso desde el interface de AuraPortal. SubTotal = Total Total de la línea del Coste o Ingreso, resultante de multiplicar la Cantidad por el PrecioCoste o PrecioVenta. InsertadoPor = Insertado Por Nombre del Empleado que introdujo el Coste o Ingreso, y la fecha cuando lo hizo. Se compone a partir del IdInserAsc y la FechaInser. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 90 de 102

91 IdUsuarioAsc = (No se muestra) ID del Empleado indicado manualmente en la introducción del Coste o Ingreso, en la lista AP EmpleadosFichas. Por defecto es el usuario que introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. IdCoste IdVenta (No se muestra) ID del registro de Coste o de Ingreso en la lista de Sharepoint AP TareasCostes o AP TareasVentas. IdTareaAsc = ID de la Tarea ID de la Tarea desde donde se ha introducido el Coste o Ingreso, en la lista AP TareasFichas. IdInserAsc = (No se muestra) ID del Empleado que introdujo el Coste o Ingreso, en la lista AP EmpleadosFichas. FechaInser = (No se muestra) Fecha de la introducción del Coste o Ingreso, que junto con el nombre del Empleado, servirá para componer el campo Insertado por del interface de AuraPortal. Referencia = (No se muestra) ID del Ítem introducido como Coste o Ingreso, en la lista AP ItemsFichas. ValorVentaItem ValorCosteItem (No se muestra) Valor de Concepto de Coste o de Ingreso en la ficha del Ítem. Están cruzados, es decir, en Costes se muestra el Concepto de Ingreso y viceversa, en Ingresos se muestra el Concepto de Coste. Multiplicando por la Cantidad se obtiene el SubTotalVenta o SubtoTalCoste. SubTotalVenta SubTotalCoste (No se muestra) Están cruzados, es decir, en Costes es el resultado de multiplicar la Cantidad por el Concepto de Ingreso del Ítem, y en Ingresos al contrario, es el resultado de multiplicar la cantidad por el Concepto de Coste del Ítem INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 91 de 102

92 Tarea_NombreClaseTarea Asc = (No se muestra) Nombre de la Clase de Tarea a la que pertenece la Tarea desde donde se ha introducido el Coste o Ingreso (IdTareaAsc). Tarea_IdClaseTareaAsc = (No se muestra) ID de la Clase de Tarea a la que pertenece la Tarea desde donde se ha introducido el Coste o Ingreso (IdTareaAsc). Tarea_EmpleadoPrincipal Enlazado = ENLACES Tarea - Empleados Nombre del Empleado Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdUsuarioAsc = (No se muestra) ID del Empleado Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_CuentaPrincipalEnl azada = ENLACES Tarea - Cuentas Nombre de la Cuenta Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdCuentaAsc = (No se muestra) ID de la Cuenta Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. Tarea_NombreItemPrinci palasc = ENLACES Tarea - Items Nombre del Ítem Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdItemAsc = (No se muestra) ID del Ítem Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_ProyectoPrincipalE nlazado = ENLACES Tarea - Proyectos Nombre del Proyecto Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdProyectoAsc = (No se muestra) ID del Proyecto Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_AmbitoPrincipalEnl azado = ENLACES Tarea - Áreas Nombre del Área Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdAmbitoAsc = (No se muestra) ID del Área Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 92 de 102

93 Exportar = Exportar Es un marcador que indica si este Coste o Ingreso será publicado en el método GetItemExport_... de este Servicio Web, cuando la Tarea se Termine Con Éxito. Es Booleano y sus valores son: 1 (True): Se exportará 0 (False): No se exportará. Exportado = (No se muestra) Es un marcador que indica que este Coste o Ingreso deje de ser publicado en el método GetItemExport_... de este Servicio Web. Su finalidad es que sea marcado por aquel programa externo cuando ya lo haya obtenido para, por ejemplo, facturar en el ERP. Es Booleano y sus valores son: 1 (True): Ha sido exportado, por lo que ya NO se publica en el método GetItemExport_... de este Servicio Web. 0 (False): Todavía no ha sido exportado, por lo que SÍ se publica en el método GetItemExport_... de este Servicio Web Introducir Costes o Ingresos en Tareas (CreateCosteTarea y CreatetIngresoTarea) Los métodos utilizados para introducir Costes o Ingresos en Tareas Libres y Programadas (No Personales de Proceso) son CreateCosteTarea y CreateIngresoTarea, siendo sus parámetros los siguientes: (Nótese que todos son iguales para Costes e Ingresos excepto el PrecioCoste y PrecioVenta) Parámetro < TaskId > (int) < Referencia > (int) < Cantidad > (double) Es obligatorio, y es el ID de la Tarea de la que queremos introducir un Coste o Ingreso. Es obligatorio y es el ID del Ítem introducido como Coste o Ingreso, en la lista AP ItemsFichas. Cantidad de unidades de Coste o Ingreso introducidos en la línea. Es obligatorio, pero se puede poner 0 y también números negativos. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 93 de 102

94 < Descuento > (double) < PrecioVenta > (double) o < PrecioCoste > (double) < Fecha > (datatime) < IdUsuarioAsc > (int) Variación porcentual del precio en el Coste o Ingreso. Puede ser un número positivo o negativo. Es obligatorio, pero si no se desea aplicar se puede introducir 0. Precio final aplicado por unidad del Coste o Ingreso. - Si se deja con valor 0, cogerá el valor de la ficha del Ítem (Concepto de Coste o Ingreso) y aplicará la Variación%. - Si se introduce un valor distinto de 0, se omitirá el valor de la ficha del Ítem y la Variación%. Es obligatorio, pero se puede indicar 0, en cuyo caso se omite su uso. Fecha indicada en la introducción del Coste o Ingreso. Es obligatorio. Puede ser diferente del día de la inserción del Coste o Ingreso. ID del Empleado indicado en la introducción del Coste o Ingreso, correspondiente en la lista AP EmpleadosFichas. Es obligatorio. Puede ser diferente del usuario que introduce el Coste o Ingreso. < Descripcion > (string) Comentarios del Coste o Ingreso. < Exportar > (boolean) Es un marcador que indica si este Coste o Ingreso será publicado en el método GetItemExport_... de este Servicio Web, cuando la Tarea se Termine Con Éxito. Es Booleano y sus valores son: 1 (True): Se Exportará 0 (False): No se exportará. Valor devuelto (int) Si el número obtenido es 0, el Coste o Ingreso ha sido introducido correctamente. Los códigos de devolución son negativos y son los siguientes: -3: Problema indefinido. -4: Problema de permisos (ver nota de Permisos en cuadro siguiente.). -8: No existe la tarea indicada en TaskId. -9: No existe el Ítem indicado en Referencia o no está marcado como Concepto de Coste o Concepto de Ingreso en su Ficha. -10: No existe el ID indicado en IdUsuarioAsc. Permisos. Pueden utilizar el método CreateCosteTarea y CreateIngresoTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 94 de 102

95 Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Eliminar Costes o Ingresos de Tareas (DeleteCosteTarea y DeleteIngresoTarea) Los métodos utilizados para eliminar los Costes o Ingresos de las Tareas Libres y Programadas (No Personales de Proceso) son DeleteCosteTarea y DeleteIngresoTarea, siendo su único parámetro el siguiente: Parámetro < IdVenta > (int) o < IdCoste > (int) Es obligatorio, y es el ID del Coste o Ingreso que queremos eliminar, correspondiente a la lista de SharePoint AP TareasCostes y AP TareasVentas. Este ID se puede ver con los métodos GetCostesTarea y GetIngresosTarea explicados anteriormente. Valor devuelto (int) Si el número obtenido es 0, el Coste o Ingreso ha sido eliminado correctamente. Los códigos de devolución son negativos y son los siguientes: -4: Problema de permisos (ver nota de Permisos en cuadro siguiente). -8: No existe el Coste o Ingreso indicado en IdCoste o IdVenta. Permisos. Pueden utilizar el método DeleteCosteTarea y DeleteIngresoTarea los siguientes usuarios: - Asignado Actual y Delegado al mismo tiempo. El campo interno Delegado, tiene sentido en tareas Programadas cuando la tarea se Envía en flujo horizontal a otro usuario. Este nuevo usuario será el Asignado Actual, pero no podrá ni Cursar, ni Devolver, ni Delegar la tarea porque no es el Delegado. Sólo podría Enviar o Responder. Sería Delegado si la tarea se le Delega en lugar de Enviar. - AdminPortal Ver Costes e Ingresos a Exportar (GetItemExport_ ) Las Tareas Programadas de AuraPortal tienen una funcionalidad específica que permite la exportación de los Costes e Ingresos, para, por ejemplo, facturar en el ERP o programa de gestión de la empresa. Nota. Aunque desde AuraPortal v3.1 no existen las Tareas Programadas porque han sido sustituidas por los Procesos, los métodos de este Servicio Web relacionados con INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 95 de 102

96 Tareas Programadas se han conservado por si se quieren utilizar durante el proceso de migración de la v2.3 (o 2.4) a la v3.1. Esta exportación se realiza a través del Servicio Web AuraPoralTareas cuando se cumplen las siguientes condiciones: - La Tarea debe ser de naturaleza PROGRAMADA. - Se exportan los Costes e Ingresos marcados con la opción EXPORTAR de Costes/Ingresos de la tarea de AuraPortal. - Sólo se exportan al Servicio Web cuando la Tarea está TERMINADA CON ÉXITO. Mientras no está Terminada con Éxito, los Costes/ingresos marcados con la opción EXPORTAR de Costes/Ingresos de la tarea quedan a la espera pero disponibles desde el Servicio Web. Hay tres métodos diferentes para ver los Costes e Ingresos exportados, a elegir según el formato de datos que se prefiera: - GetItemExport_DataSet obtiene los Costes e Ingresos exportados en formato DataSet. Esta estructura es la que utilizan las aplicaciones.net. - GetItemExport_XMLDocument obtiene los Costes e Ingresos exportados en formato XML. - GetItemExport_String obtiene los Costes e Ingresos exportados en formato string, pero manteniendo una estructura XML. Es la utilizada para lenguajes de programación que no entienden los formatos XML. En los tres casos los parámetros son los mismos: Parámetro < Concepto > (int) < TaskId > < ClassId > Es obligatorio, y puede tener dos valores: 1: Para ver todos los Costes. 2: Para ver los Ingresos. Indica el ID de la Tarea de la que queremos ver sus Costes o Ingresos a Exportar. Es obligatorio, pero si se indica el número 0 se obtendrán los Costes o Ingresos de todas las Tareas Libres y Programadas (No Personales de Proceso). Indica el ID de la Clase de Tarea de la que queremos ver sus Costes o Ingresos a Exportar. Es obligatorio, pero si se indica el número 0 se obtendrán los Costes o Ingresos de todas las Clases de Tareas. Permisos. Pueden utilizar los métodos GetItemExport los siguientes usuarios: - Administrador Delegado (perteneciente al grupo). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 96 de 102

97 - AdminPortal. En los tres casos se obtendrán todos los Costes o Ingresos marcados con EXPORTAR que no estén marcados como EXPORTADOS, de todas las Tareas PROGRAMADAS que estén TERMINADAS CON ÉXITO. - La marca EXPORTAR es visible en el Interface de la Tarea, en cada línea de Coste o Ingreso, e internamente es la columna Exportar en las listas AP TareasVentas y AP TareasCostes. Es un campo de valor booleano (Sí / No). - La marca EXPORTADO no es visible en el Interface de AuraPortal. Internamente es la columna Exportado en las listas AP TareasVentas y AP TareasCostes. Es un campo de valor booleano (Sí / No). A continuación se muestra una tabla con los datos que se obtienen, su relación en el interface de AuraPortal y su descripción: DATOS OBTENIDOS COSTES INGRESOS Campo en interface de AP Descripción NombreItemAsc = Item Nombre del Ítem introducido como Coste o Ingreso, de la lista AP ItemsFichas. CodigoERPItem = Código ERP Código ERP del Ítem Enlazado, de la lista AP ItemsFichas. Fecha = Fecha Fecha indicada manualmente en la introducción del Coste o Ingreso. Por defecto es la del día que se introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. Formato DataTime. UsuarioAsc = Empleado Nombre del Empleado indicado manualmente en la introducción del Coste o Ingreso. Por defecto es el usuario que introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. Descripcion = Comentarios Comentarios introducidos en el Coste o Ingreso. Cantidad = Cantidad Cantidad de unidades de Coste o Ingresos introducidos en la línea. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 97 de 102

98 PrecioUnidad = Concepto de Coste o Concepto de Ingreso Valor introducido en el Concepto de Coste o de Ingreso en la ficha del Ítem (lista AP ItemsFichas). Descuento = Variación% Variación porcentual del precio en el Coste o Ingreso. Puede ser positiva o negativa. PrecioCoste PrecioVenta Precio Precio final aplicado por unidad de Coste o Ingreso. Por defecto es el resultante de haberlo cogido de la ficha del Ítem (Concepto de Coste o Ingreso), pero varía si se aplica la Variación%, o se introduce directamente a mano en el campo Precio de Coste o Ingreso desde el interface de AuraPortal. SubTotal = Total Total de la línea del Coste o Ingreso, resultante de multiplicar la Cantidad por el PrecioCoste o PrecioVenta. InsertadoPor = Insertado Por Nombre del Empleado que introdujo el Coste o Ingreso, y la fecha cuando lo hizo. Se compone a partir del IdInserAsc y la FechaInser. IdUsuarioAsc = (No se muestra) ID del Empleado indicado manualmente en la introducción del Coste o Ingreso, en la lista AP EmpleadosFichas. Por defecto es el usuario que introduce el Coste o Ingreso, pero se puede variar en el momento de la introducción. IdCoste IdVenta (No se muestra) ID del registro de Coste o de Ingreso en la lista de Sharepoint AP TareasCostes o AP TareasVentas. IdTareaAsc = ID de la Tarea ID de la Tarea desde donde se ha introducido el Coste o Ingreso, en la lista AP TareasFichas. IdInserAsc = (No se muestra) ID del Empleado que introdujo el Coste o Ingreso, en la lista AP EmpleadosFichas. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 98 de 102

99 FechaInser = (No se muestra) Fecha de la introducción del Coste o Ingreso, que junto con el nombre del Empleado, servirá para componer el campo Insertado por del interface de AuraPortal. Referencia = (No se muestra) ID del Ítem introducido como Coste o Ingreso, en la lista AP ItemsFichas. ValorVentaItem ValorCosteItem (No se muestra) Valor de Concepto de Coste o de Ingreso en la ficha del Ítem. Están cruzados, es decir, en Costes se muestra el Concepto de Ingreso y viceversa, en Ingresos se muestra el Concepto de Coste. Multiplicando por la Cantidad se obtiene el SubTotalVenta o SubtoTalCoste. SubTotalVenta SubTotalCoste (No se muestra) Están cruzados, es decir, en Costes es el resultado de multiplicar la Cantidad por el Concepto de Ingreso del Ítem, y en Ingresos al contrario, es el resultado de multiplicar la cantidad por el Concepto de Coste del Ítem Tarea_NombreClaseTarea Asc = (No se muestra) Nombre de la Clase de Tarea a la que pertenece la Tarea desde donde se ha introducido el Coste o Ingreso (IdTareaAsc). Tarea_IdClaseTareaAsc = (No se muestra) ID de la Clase de Tarea a la que pertenece la Tarea desde donde se ha introducido el Coste o Ingreso (IdTareaAsc). Tarea_EmpleadoPrincipal Enlazado = ENLACES Tarea - Empleados Nombre del Empleado Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdUsuarioAsc = (No se muestra) ID del Empleado Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_CuentaPrincipalEnl azada = ENLACES Tarea - Cuentas Nombre de la Cuenta Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 99 de 102

100 Tarea_IdCuentaAsc = (No se muestra) ID de la Cuenta Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. Tarea_NombreItemPrinci palasc = ENLACES Tarea - Items Nombre del Ítem Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdItemAsc = (No se muestra) ID del Ítem Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_ProyectoPrincipalE nlazado = ENLACES Tarea - Proyectos Nombre del Proyecto Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdProyectoAsc = (No se muestra) ID del Proyecto Principal Enlazado en la Tarea en el momento de Terminarla Con Éxito. Tarea_AmbitoPrincipalEnl azado = ENLACES Tarea - Áreas Nombre del Área Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito. Tarea_IdAmbitoAsc = (No se muestra) ID del Área Principal Enlazada en la Tarea en el momento de Terminarla Con Éxito Marcar Costes o Ingresos como Exportados (SetItemExported_ ) Una vez el supuesto programa externo obtenga los Costes o Ingresos, para, por ejemplo, facturar en el ERP, es posible marcarlos a través del Servicio Web como EXPORTADOS, para que no sean obtenidos de nuevo en siguientes consultas. Los que tengan la marca EXPORTADO, dejarán de publicarse en el Servicio Web. La idea es que el programa externo obtiene los Costes o Ingresos para, por ejemplo, facturar, y los marca como Exportados para no volver a obtenerlos. Para marcar los Costes e Ingresos como Exportados hay dos métodos: - SetItemExported_ArrayList marca los Ítems como Exportados para que dejen de publicarse en el Servicio Web. Esta estructura es la que utilizan las aplicaciones.net. - SetItemExported_Array marca los Ítems como Exportados para que no vuelvan a publicarse en el Servicio Web. Los dos métodos realizan las mismas acciones. La diferencia está en el modo en el que se indican los parámetros de llamada, en ArrayList o en Array: INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 100 de 102

101 Parámetro < Concepto > (int) Es obligatorio, y puede tener dos valores: 1: Para Costes. 2: Para Ingresos. Es obligatorio, y corresponde a los ID de los registros que se desea marcar como Exportados. Por ejemplo, para marcar los Costes o Ingresos 3, 15 y 20 (IDs de la lista de SharePoint AP TareasCostes o AP TareasVentas) como exportados: < IDs > (ArrayList) o (Array) - Con el método ArrayList: ArrayList Ids= new ArrayList(); Ids.Add("3"); Ids.Add("15"); Ids.Add("20"); SetItemExported_ArrayList(Ids); - Con el método Array: int[] Ids= new int[3]; Ids[0]=3; Ids[1]=15; Ids[2]=20; SetItemExported_Array(Ids); Permisos. Pueden utilizar los métodos SetItemExport los siguientes usuarios: - Administrador Delegado (perteneciente al grupo). - AdminPortal. Nota. La marca EXPORTADO de Costes o Ingresos no es visible en el Interface de AuraPortal. Internamente es la columna EXPORTADO en las listas AP TareasVentas y AP TareasCostes, de valor booleano (Sí / No). INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 101 de 102

102 INTEGRACIÓN. SERVICIOS WEB. TOMO 1 Página 102 de 102