Toggle navigation
Centro de Ayuda
Precios
Contáctanos
Blog
Web services API
<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <h1><a name="_Toc61945706"></a><a name="_Toc106435884"></a><a name= "_Toc92531031"></a><a name="_Toc92259326"></a><a name= "_Toc92258893"></a><a name="_Toc92181714"></a><a name= "_Toc92181555"></a><a name="_Toc92180943"></a><a name= "_Toc91588610"></a><a name="_Toc91495571"></a><a name= "_Toc91495311"></a><a name="_Toc91495167"></a><a name= "_Toc91495092"><span lang="ES" xml:lang= "ES">Introducción</span></a></h1> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El propósito de este manual es describir la API de web services de Q-flow para apoyar a desarrolladores de aplicaciones que los utilizan.</span></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Este manual contiene solamente información acerca de la interfaz y del comportamiento de los web services. Para obtener información acerca de cómo instalarlos y configurarlos, consulte el manual de instalación de Q-flow.</span></p> <h1><a name="_Toc61945707"></a><a name="_Toc106435885"><span lang= "ES" xml:lang="ES">Organización de este manual</span></a></h1> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Primero encontrará una explicación de cómo invocar cualquier servicio, incluyendo cómo hacer uso de la interfaz Swagger. Luego, Q-flow incluye los siguientes web services:</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebBot</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebChart</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebDeploy</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebFlow</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebLinks</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebLists</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebOperations</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebOrganization</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebPackage</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebQueue</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebResponse</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">WebStart</span></p> <p class="MsoNormal"><span lang="ES" xml:lang= "ES"> </span></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El manual dedica una sección a cada uno de esos web services.</span></p> <p class="MsoNormal"><span lang="ES" xml:lang= "ES"> </span></p> <p class="MsoNormal"><span lang="ES" xml:lang= "ES"> </span></p> <h1><a name="_Toc61945708"><span lang="ES" xml:lang= "ES">Convenciones usadas en este manual</span></a></h1> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Este manual representa la firma de un método de un web service de la siguiente forma:</span></p> <p class="MsoNormal"><span lang="ES" xml:lang= "ES">Nombre_del_método(lista_de_parámetros):Tipo_de_Retorno</span></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Los parámetros están separados por comas, y cada parámetro está representado por su tipo seguido de su nombre, como en código C#. Ejemplo: string name. Si un método no devuelve nada, el tipo de retorno es “void”, como en C#.</span></p> <h1><a name="_Toc61945709"><span lang="ES" xml:lang="ES">API de servicios</span></a></h1> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Para invocar los servicios expuestos se debe usar la URL <nombreServidor>/<nombreDirectorioVirtual>/api/<Servicio/<Método>. El nombre del servidor y del directorio son los configurados durante la instalación; el servicio y el método son los ya explicados.</span></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Para autenticarse, puede hacer uso del método que se encuentra en el grupo Auth:</span></p> <p class="MsoNormal"><b><span lang="EN-US" xml:lang= "EN-US">Token(string grant_type, string userLogon, string password, Guid tenantId)</span></b></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Este método devuelve un token de autenticación al pasarle las credenciales de un usuario: logon, contraseña y el identificador de la instancia en la que se encuentra. El parámetro “grant_type” debe tener el valor “password”. El token obtenido se puede agregar a la autorización del cabezal con clave “bearer” para usar los servicios estando autenticado. Si no se utiliza, se iniciará sesión cada vez que se use un servicio.</span></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Existe una interfaz con Swagger para facilitar el uso experimental de estos web services. Para poder hacer uso de ella, se debe tener en el archivo web.config de la API de servicios la clave “EnableSwaggerUI” en “true”, dentro de la sección “AppSettings”. Para acceder a la interfaz, la URL es <nombreServidor>/<nombreDirectorioVirtual>/swagger/ui/index. Para poder usar la autenticación mencionada, al invocar el método Token, dicho token se encuentra en el valor de la propiedad “access_token” del resultado. Debe copiar dicho token y luego hacer clic en el botón “Autorizar” que se encuentra en la parte superior de la página.</span></p> <p class="MsoNormal" align="center" style='text-align:center'> <img width="160" height="47" id="Picture 2" src= "Qf500020ESP-Web%20services%20API-v1.0_files/image003.png" alt= "image" name="Picture 2" /></p> <p class="MsoNormal"><span lang="ES" xml:lang="ES">Esto abrirá un cuadro de diálogo en el que se le solicitará el token. En el campo de texto, escriba “bearer”, un espacio y luego pegue el token. Finalmente haga clic en “Autorizar”. Puede entonces proceder a probar los servicios.</span></p> <h1><a name="_Toc61945710"><span lang="ES" xml:lang= "ES">Descripción de los web services</span></a></h1> <p class="MsoNormal"><span lang="ES" xml:lang="ES">A continuación, se describe cada uno de los web services de Q-flow.</span></p> <h2><a name="_Toc61945711">WebBot</a></h2> <p class="MsoNormal">El web service WebBot es el que permite que un bot pueda obtener información acerca de qué tareas tiene pendientes, e informar a Q-flow acerca de qué tareas completó y canceló. Una explicación de qué es un bot y para qué sirve puede ser encontrada en el manual del diseñador de procesos del negocio.</p> <p class="MsoNormal">Un bot, en general, utilizará los métodos de WebBot de la siguiente forma:</p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> 1.<span style= 'font:7.0pt "Times New Roman"'> </span> Invocará el método GetActiveJobs para obtener la lista de trabajos pendientes.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> 2.<span style= 'font:7.0pt "Times New Roman"'> </span> Recorrerá los trabajos devueltos por GetActiveJobs para procesar cada uno de ellos. Para obtener los datos necesarios para procesar un trabajo, invocará el método GetJob, que devuelve un objeto que contiene todos los datos del trabajo.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> 3.<span style= 'font:7.0pt "Times New Roman"'> </span> El bot procesa el trabajo. Mientras lo hace, modifica el objeto obtenido mediante el método GetJob. También puede modificar datos de aplicación, roles y adjuntos. Si durante el procesamiento de un trabajo el bot debe obtener el contenido de un archivo adjunto, invoca el método GetAttachmentContent.</p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> 4.<span style= 'font:7.0pt "Times New Roman"'> </span> Una vez procesado el trabajo, si pudo completarlo, el bot invocará el método CompleteJob, pasándole el objeto que modificó para que Q-flow guarde los cambios. Si debe abortar el trabajo (por ejemplo, porque hubo un error), invocará el método AbortJob.</p> <h3><a name="_Toc61945712">Métodos de WebBot</a></h3> <p class="MsoListParagraphCxSpFirst" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>AbortJob(BotJob job, string message): void</b> – aborta un trabajo del bot. El parámetro “job” representa el trabajo que se desea abortar, y se debe haber obtenido previamente mediante la invocación del método GetActiveJobs. El parámetro “message” permite especificar un mensaje para, por ejemplo, indicar por qué el trabajo fue cancelado.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>CompleteJob(BotJobMessage job): void</b> – marca un trabajo del bot como completado. Un bot debe invocar este método al terminar de procesar un trabajo para indicarle a Q-flow que lo ha completado. El parámetro “job” se tiene que haber obtenido previamente mediante la invocación del método GetJob. Al invocar este método, se guardan los cambios efectuados por el bot. En el caso de los adjuntos, si se quitó alguno de la lista de adjuntos, Q-flow lo eliminará. Si se agregó un adjunto (y se le cargó la propiedad “Content” y el nombre), Q-flow lo agregará. Para modificar un adjunto, basta con modificar la propiedad “Content” del objeto AttachmentMessage que lo representa.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetActiveJobs(Guid botId): BotJob[]</b> – devuelve un vector que indica qué trabajos del bot con identificador “botId” están pendientes.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetActiveJobsByFlow(Guid botId, Guid flowId): BotJob[]</b> – devuelve un vector que indica qué trabajos del bot con identificador “botId” están pendientes para el proceso con identificador “flowId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetAttachmentContent(BotJob job, Guid attachId): byte[]</b> – devuelve el contenido del archivo adjunto indicado por “attachId”. El bot debe tener permisos para acceder al archivo.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetJob(BotJob job): BotJobMessage</b> – obtiene un objeto con los datos necesarios (datos del proceso, parámetros) para procesar el trabajo indicado por el parámetro “job”. Entre otras cosas, se trae la lista de adjuntos del proceso (si el paso de bot correspondiente tiene el permiso de listar adjuntos), pero sin el contenido de los adjuntos. Para obtener el contenido de un archivo adjunto, utilice el método GetAttachmentContent.</p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>UpdateJob(BotJobMessage job):void</b> - actualiza un trabajo del bot, sin marcarlo como completado.</p> <h2><a name="_Toc61945713">WebChart</a></h2> <p class="MsoNormal">El web service WebChart permite recuperar información sobre las gráficas del sitio web, así como obtener los datos que abastecen las gráficas “Carga de tareas de mis supervisados” y “Tareas del usuario por estado”.</p> <h3><a name="_Toc61945714">Métodos de WebChart</a></h3> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetMyManagedTaskLoad(Guid packageId):UserTaskLoadResponse[]</b> – devuelve un vector de objetos de la clase UserTaskLoadResponse. Cada uno de estos objetos contiene información acerca de la carga de tareas de un usuario supervisado por el usuario cuya cuenta se utilizó para invocar el web service. Sólo se tienen en cuenta las tareas que pertenezcan a procesos del paquete indicado por “packageId” o de paquetes que desciendan de éste.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetUserTaskLoad(Guid packageId, Guid userId): UserTaskLoadResponse</b> – devuelve un objeto que indica la carga de tareas del usuario con identificador “userId”. Sólo se tienen en cuenta las tareas que pertenezcan a procesos del paquete indicado por “packageId” o de paquetes que desciendan de éste.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">GetPackageCharts(Guid packageId): ChartMessage[]</span></b> <span lang="ES-AR" xml:lang= "ES-AR">– devuelve un arreglo de objetos de la clase ChartMessage, que contiene información sobre una gráfica tal como el nombre, las dimensiones y las columnas. Estos objetos corresponden a las gráficas ubicadas en el paquete identificado por “packageId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">GetMyPackageCharts(Guid packageId): ChartMessage[]</span></b> <span lang="ES-AR" xml:lang= "ES-AR">– devuelve un arreglo de objetos de la clase ChartMessage, correspondientes a las gráficas ubicadas en el paquete identificado por “packageId” y que pertenecen al usuario actual.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">GetChart(Guid chartId): ChartMessage</span></b> <span lang="ES-AR" xml:lang="ES-AR">– devuelve un objeto ChartMessage correspondiente a la gráfica identificada por el parámetro “chartId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">GetMyChart(Guid chartId): ChartMessage</span></b> <span lang="ES-AR" xml:lang="ES-AR">– devuelve un objeto ChartMessage correspondiente a la gráfica identificada por el parámetro “chartId”, siempre que la gráfica le pertenezca al usuario actual.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang= "ES-AR">GetChartData(ChartDataRequest request): ChartDataResponse</span></b> <span lang="ES-AR" xml:lang="ES-AR">– devuelve un objeto con los datos que abastecen la gráfica con los parámetros representados en el objeto “request”.</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span lang="ES-AR" style='font-family:Symbol' xml:lang= "ES-AR">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang= "ES-AR">GetMyChartData(ChartDataRequest request): ChartDataResponse</span></b> <span lang="ES-AR" xml:lang="ES-AR">– devuelve un objeto con los datos que abastecen la gráfica con los parámetros representados en el objeto “request”, siempre que la gráfica pertenezca al usuario.</span></p> <h2><a name="_Toc61945715">WebDeploy</a></h2> <p class="MsoNormal">El web service WebDeploy provee funcionalidades de importación y exportación de paquetes (con los elementos contenidos en ellos) y el modelo organizacional, entre otras cosas.</p> <h3><a name="_Toc61945716">Métodos de WebDeploy</a></h3> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportChartsById(Guid[] chartIds):ChartMessage[]:</span></b> <span lang="ES-UY" xml:lang= "ES-UY">exporta las gráficas identificadas por los identificadores provistos en el parámetro “chartIds”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportChartsByPackage(Guid packageId):ChartMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">exporta las gráficas definidas en el paquete especificado por el parámetro “packageId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportDashboardsById(Guid[] dashboardIds):DashboardMessage[]</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang= "ES-UY">exporta los tableros de control cuyos identificadores son especificados por el parámetro.</span></p> <p class="MsoListParagraphCxSpMiddle" align="left" style= 'text-align:left; text-indent:-18.0pt'><span lang="ES-UY" style= 'font-family:Symbol' xml:lang="ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">ExportDashboardsByPackage(Guid packageId):DashboardMessage[]</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang= "ES-UY">exporta los tableros de control del paquete cuyo identificador es indicado en el parámetro.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportKpisById(Guid[] kpiIds):KpiMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">– e</span><span lang="ES-UY" xml:lang="ES-UY">xporta los indicadores identificados por los identificadores provistos en el parámetro “kpiIds”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportKpisByPackage(Guid packageId):KpiMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">– e</span><span lang="ES-UY" xml:lang="ES-UY">xporta los indicadores definidos en el paquete especificado por el parámetro “packageId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportLinksByPackage(Guid packageId):LinkMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">– e</span><span lang="ES-UY" xml:lang="ES-UY">xporta los vínculos y categorías definidos en el paquete especificado por el parámetro “packageId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportLinksByParent(Guid parentLinkId):LinkMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">– e</span><span lang="ES-UY" xml:lang="ES-UY">xporta los descendientes del vínculo o categoría indicado por el parámetro “parentLinkId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ExportOrganizationNode(Guid nodeId):OrganizationModelMessage</span></b> <span lang="ES-UY" xml:lang="ES-UY">– exporta el nodo organizacional solicitado en el parámetro “nodeId”. El objeto devuelto incluye la información del nodo solicitado, incluyendo su contenido, así como toda su descendencia. Además incluye elementos de configuración: proveedores de seguridad, roles de seguridad y calendarios.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ExportPackage(Guid packageId, bool recursive):PackageMessage</b> - devuelve un objeto con todos los datos del paquete identificado por “packageId”. Si el parámetro “recursive” tiene valor “true”, además de los datos del paquete identificado por “packageId” el objeto devuelto contiene todo el árbol cuya raíz es ese paquete (el paquete y todos sus descendientes).</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ExportViewsById(Guid[] viewIds):ViewMessage[]</b> – devuelve un vector de objetos de la clase ViewMessage con todos los datos de las vistas cuyos identificadores están contenidos en el parámetro “viewIds”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ExportViewsByPackage(Guid packageId):ViewMessage[]</b> – devuelve un vector de objetos de la clase ViewMessage con todos los datos de las vistas del paquete identificado por “packageId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ImportCharts(ChartMessage[] charts):void</span></b> <span lang="ES-UY" xml:lang= "ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">importa las gráficas contenidas en el parámetro “charts”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">ImportDashboards(DashboardMessage[] dashboards)</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">importa los tableros de control contenidos en el parámetro.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ImportKpis(KpiMessage[] kpis):void</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">importa los indicadores contenidos en el parámetro “kpis”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">ImportLinks(LinkMessage[] links, Guid parentLinkId):void</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span><span lang="ES-UY" xml:lang= "ES-UY">importa los vínculos contenidos en el parámetro “links”, y los pone dentrol del vínculo o categoría cuyo identificador se indica en el parámetro “parentLinkId</span><span lang="ES" xml:lang="ES">”</span><span lang="ES-UY" xml:lang= "ES-UY">.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">ImportOrganizationNode(OrganizationModelMessage organizationModel, Guid parentNodeId):void</span></b> <span lang= "ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang= "ES-UY">importa los datos del modelo organizacional pasados en el parámetro “organizationModel”. Los nodos se importan bajo el nodo identificado por el parámetro “parentNodeId”.</span></p> <p class="MsoListParagraphCxSpMiddle" align="left" style= 'text-align:left; text-indent:-18.0pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ImportPackage(PackageMessage package, Guid parentPackageId, PackageImportOptions options):ImportPackageResponse</b> - importa un paquete, representado por el parámetro “package”. El parámetro “parentPackageId” es el identificador del paquete dentro del cual se desea importar el paquete. El parámetro “options” permite especificar opciones de importación equivalente a las disponibles en el diseñador de procesos, estas son: “UpdateTemplateParameters” y “FixMissingReferences”. El objeto devuelto tiene una lista de advertencias que indica posibles problemas y decisiones tomadas por Q-flow durante la importación.</p> <p class="MsoListParagraphCxSpLast" align="left" style= 'text-align:left;text-indent: -18.0pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ImportViews(ViewMessage[] views):void</b> – importa las vistas contenidas dentro del objeto recibido por parámetro.</p> <h2><a name="_Toc61945717">WebFlow</a></h2> <p class="MsoNormal">El web service WebFlow permite obtener y modificar datos de un proceso fuera del contexto de alguna tarea.</p> <h3><a name="_Toc61945718">Métodos de WebFlow</a></h3> <p class="MsoNormalCxSpFirst" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">CheckInAttachment(Guid flowId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang= "EN-US">–</span> <span lang="EN-US" xml:lang="EN-US">protege el archivo adjunto indicado.</span> Esto es análogo a hacer clic en el botón “Proteger” en el formulario de edición del proceso en el sitio web viejo. Esta funcionalidad está deprecada.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">CheckOutAttachment(Guid flowId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang= "EN-US">–</span> <span lang="EN-US" xml:lang="EN-US">desprotege el archivo adjunto indicado.</span> Esto es análogo a hacer clic en el botón “Desproteger” en el formulario de edición del proceso en el sitio web viejo. Esta funcionalidad está deprecada.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="EN-US" style= 'font-family:Symbol' xml:lang="EN-US">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">DeleteAttachment(Guid flowId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang= "EN-US">–</span> <span lang="EN-US" xml:lang="EN-US">elimina el archivo adjunto indicado.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>DownloadAttachment(Guid flowId, Guid attachId):byte[]</b> – Devuelve el contenido del archivo adjunto identificado por “attachId”. <span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en un adjunto protegido en el formulario de edición del proceso. Vea la descripción de DownloadCheckedOutAttachment para ver la diferencia entre ambos métodos.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>DownloadCheckedOutAttachment(Guid flowId, Guid attachId):byte[]</b> – Devuelve el contenido del archivo adjunto identificado por attachId. <span lang="ES" xml:lang= "ES">Esto es análogo a hacer clic en un adjunto desprotegido en el formulario de edición del proceso. La diferencia entre este método y el método DownloadAttachment importa cuando un usuario desprotegió un archivo adjunto, lo actualizó, y todavía no lo volvió a proteger (notar que la protección y desprotección de adjuntos está deprecada). DownloadCheckedOutAttachment devuelve el borrador que todavía no se protegió, que todavía no es público y, si se deshace la desprotección, nunca lo será. DownloadAttachment devuelve la versión actual pública del archivo. Ejemplo: Juan adjunta el archivo Informe.docx a un proceso. El título del informe es “Informe”. Pablo desprotege el informe, cambia el título por “Informe de ventas” y sube sus cambios, pero sin proteger el archivo. En este caso, DownloadAttachment devuelve la versión cuyo título es “Informe”, mientras que DownloadCheckedOutAttachment devuelve la versión cuyo título es “Informe de ventas”, es decir, el borrador que Pablo todavía no protegió. Una vez que Pablo haya protegido esa versión, ésta será pública y ambos métodos devolverán la misma.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>EditFlow(FlowMessage request):void</b> - modifica los datos de un proceso. Para utilizar este método, primero se debe obtener un objeto FlowMessage mediante una llamada al método GetEditFlowInfo. Después se modifica el objeto y se lo envía como parámetro del método EditFlow.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetEditFlowInfo(Guid flowId):FlowMessage</b> - obtiene los datos de un proceso para poder modificarlos y guardarlos mediante el método EditFlow.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="EN-US" style= 'font-family:Symbol' xml:lang="EN-US">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">GetFlowInfo(Guid flowId):FlowMessage -</span></b> <span lang="EN-US" xml:lang= "EN-US">obtiene los datos del proceso.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>UndoCheckOutAttachment(Guid flowId, Guid attachId):void</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> deshace la desprotección del archivo adjunto indicado. Esta funcionalidad está deprecada.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>UploadCheckedOutAttachment(Guid flowId, Guid attachId, byte[] content):void</b> - envía al servidor un archivo adjunto para actualizar un archivo adjunto del cual antes se hizo checkout, para actualizar su contenido.</p> <p class="MsoNormalCxSpLast" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span style= 'font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">UploadNewAttachment(Guid flowId, string name, byte[] content):Guid</span></b> <span lang= "ES-AR" xml:lang="ES-AR">-</span> <span lang="ES-AR" xml:lang= "ES-AR">agrega un nuevo archivo adjunto al proceso indicado.</span> El parámetro name indica el nombre del archivo, y el parámetro content es un array de bytes con el contenido del nuevo adjunto. Devuelve el identificador que se le asignó al nuevo adjunto.</p> <h2><a name="_Toc61945719"><span lang="ES" xml:lang= "ES">WebLink</span></a></h2> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El web service WebLink dispone solamente de un método.</span></p> <h3><a name="_Toc61945720"><span lang="ES" xml:lang="ES">Método de WebLink</span></a></h3> <p class="MsoListParagraph" style='text-indent:-18.0pt'><span lang= "ES" style='font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">HasUserPermissionsToSeeLink(string url):bool</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES" xml:lang="ES">devuelve “true” si el usuario actual (aquel cuyas credenciales se utilizan para invocar el web service) tiene permiso para ver el vínculo cuya URL se indica en el parámetro</span> <span lang="ES-UY" xml:lang= "ES-UY">“</span><span lang="ES" xml:lang="ES">url”.</span></p> <h2><a name="_Toc61945721"><span lang="ES" xml:lang= "ES">WebList</span></a></h2> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El web service WebList tiene métodos para obtener listas de tareas.</span></p> <h3><a name="_Toc61945722"><span lang="ES" xml:lang="ES">Métodos de WebList</span></a></h3> <p class="MsoNormalCxSpFirst" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang= "ES">GetCurrentUserTasks():Task[]</span></b> <span lang="ES" xml:lang="ES">– obtiene un vector que contiene las tareas del usuario en cuyo contexto se invoca el método.</span></p> <p class="MsoNormalCxSpLast" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetCurrentUserTasksByTemplatesWithData(Guid[] templatesFilter, Guid[] dataToInclude) :DataTable</b> – devuelve un objeto DataTable con información de las tareas que pertenecen a los templates cuyos identificadores se especifican en el parámetro templatesFilter. Las columnas del objeto DataTable devuelto son:</p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "EN-US" style='font-family:"Courier New"' xml:lang= "EN-US">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="EN-US">FlowId:</span></b> <span lang="EN-US" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="EN-US">identificador del proceso.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskId:</span></b> <span style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black'> identificador de la tarea</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskToId:</span></b> <span style= 'font-size:10.0pt;line-height: 107%;font-family:"Arial",sans-serif;color:black'> identificador de la tarea propia de un usuario (si una tarea está dirigida a n usuarios, está compuesta por n tareas propias de cada uno de esos usuarios).</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang="ES" style='font-family:"Courier New"' xml:lang="ES">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="ES">TemplateCorrelativeId:</span></b> <span lang="ES" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="ES">identificador correlativo del template.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "EN-US" style='font-family:"Courier New"' xml:lang= "EN-US">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="EN-US">TemplateId:</span></b> <span lang="EN-US" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="EN-US">identificador del template.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "EN-US" style='font-family:"Courier New"' xml:lang= "EN-US">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="EN-US">TemplateName:</span></b> <span lang="EN-US" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="EN-US">nombre del template.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TemplateVersionId:</span></b> <span style= 'font-size:10.0pt; line-height:107%;font-family:"Arial",sans-serif;color:black'> identificador de la versión del template.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TemplateVersionName:</span></b> <span style= 'font-size:10.0pt; line-height:107%;font-family:"Arial",sans-serif;color:black'> nombre de la versión del template.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "ES-AR" style='font-family:"Courier New"' xml:lang= "ES-AR">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="ES-AR">FlowCorrelativeId:</span></b> <span lang="ES-AR" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="ES-AR">identificador correlativo del proceso.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "EN-US" style='font-family:"Courier New"' xml:lang= "EN-US">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="EN-US">FlowName:</span></b> <span lang="EN-US" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="EN-US">nombre del proceso.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span lang= "EN-US" style='font-family:"Courier New"' xml:lang= "EN-US">o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" style= 'font-size:10.0pt;line-height:107%; font-family:"Arial",sans-serif;color:black' xml:lang="EN-US">FlowFlag:</span></b> <span lang="EN-US" style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black' xml:lang="EN-US">bandera del proceso.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> FlowStartDate:</span></b> <span style= 'font-size:10.0pt;line-height: 107%;font-family:"Arial",sans-serif;color:black'> fecha de inicio del proceso.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskName:</span></b> <span style= 'font-size:10.0pt;line-height: 107%;font-family:"Arial",sans-serif;color:black'> nombre de la tarea.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskDescription:</span></b> <span style= 'font-size:10.0pt; line-height:107%;font-family:"Arial",sans-serif;color:black'> descripción de la tarea.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskSubject:</span></b> <span style= 'font-size:10.0pt;line-height: 107%;font-family:"Arial",sans-serif;color:black'> asunto de la tarea.</span></p> <p style='margin-left:72.0pt;text-indent:-18.0pt'><span style= 'font-family: "Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span style= 'font-size:10.0pt;line-height:107%;font-family:"Arial",sans-serif; color:black'> TaskTimeStarted:</span></b> <span style= 'font-size:10.0pt; line-height:107%;font-family:"Arial",sans-serif;color:black'> fecha de inicio de la tarea.</span></p> <p class="MsoNormalCxSpFirst" align="left" style= 'margin-left:35.7pt;text-align: left;text-indent:-17.85pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetCurrentUserTasksByTemplatesNamesWithDataNames(string[] templatesFilter, string[] dataToInclude):DataTable</b> – similar al anterior, pero en lugar de utilizar los identificadores de los templates y datos cuyos datos se deben traer, se utilizan sus nombres.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetFlowTasks(Guid flowId):Task[]</span></b> <span lang="ES" xml:lang="ES">– obtiene un vector que contiene las tareas del proceso indicado por el parámetro flowId.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetFlowsUsingQuickSearch(string query):Flow</span></b><b><span lang="ES-UY" xml:lang= "ES-UY">[]</span></b> <span lang="ES" xml:lang="ES">– funciona como la búsqueda rápida del sitio web. Busca procesos a partir de un texto: si el texto es un número, busca un proceso que tenga ese número como identificador correlativo. De lo contrario, busca procesos cuyos nombres sean similares al texto.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang= "ES">GetMyTemplates()</span></b><b><span lang="ES" xml:lang= "ES">:Template[]</span></b> <span lang="ES" xml:lang="ES">- obtiene un vector con los objetos que representan todos los templates del usuario actual, y contienen información básica de éstos. El resultado es similar a lo que se muestra en la vista “Mis Templates” del sitio web. El usuario actual es aquél cuyas credenciales son utilizadas para invocar el web service.</span></p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal" style='text-align:left'> <b>GetPackageViewData(PackageViewDataRequest request):PackageViewDataResponse</b> – devuelve los datos de una vista. Es como pedirle a Q-flow que muestre una vista, pero desde fuera de Q-flow. En el sitio web, no se muestran todos los datos de una vista en la misma página. Se muestra una cantidad limitada de filas por página. El usuario puede elegir la página que desea ver. El par<span lang="ES" xml:lang="ES">ámetro de este método es un objeto de tipo PackageViewDataRequest que contiene propiedades que permiten especificar el número de página y el tamaño.</span> La propiedad PageSize indica el tamaño de página, y la propiedad PageNumber, el número de página que se desea ver, de modo que invocar el método <span style= 'color:black'>GetPackageViewData</span> es análogo a hacer clic sobre un número de página de una vista, dado cierto tamaño de página. Para traer todos los elementos de la vista, se puede pedir la página 1 (PageNumber = 1) e indicar que el tamaño de la página sea Int32.MaxValue. Además de esas propiedades, el parámetro contiene las siguientes:</li> </ul> <p class="MsoListParagraphCxSpFirst" style= 'margin-left:71.7pt;text-indent:-17.85pt'><span style= 'font-family:"Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>PackageId:Guid:</b> identificador del paquete al cual pertenece la vista cuyos datos se están obteniendo.</p> <p class="MsoListParagraphCxSpMiddle" style= 'margin-left:71.7pt;text-indent:-17.85pt'><span style= 'font-family:"Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ParameterValues</b><b><span lang="ES-UY" xml:lang= "ES-UY">:</span></b><b>ParameterValue[]:</b> en esta propiedad se pueden cargar objetos de tipo ParameterValue para especificar los valores de los par<span lang="ES" xml:lang="ES">ámetros, si la vista cuyos datos se pretenden obtener es una vista con parámetros.</span></p> <p class="MsoListParagraphCxSpLast" style= 'margin-left:71.7pt;text-indent:-17.85pt'><span style= 'font-family:"Courier New"'>o<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ViewId:Guid:</b> es el identificador de la vista cuyos datos se quieren obtener.</p> <ul style='margin-top:0cm' type="disc"> <li class="MsoNormal"><b><span lang="ES" xml:lang= "ES">GetTemplates()</span></b><b><span lang="ES" xml:lang= "ES">:Template[]</span></b> <span lang="ES" xml:lang="ES">– obtiene un vector con los objetos que representan todos los templates del sistema y contienen información básica de éstos. El resultado es similar a lo que se muestra en la vista “Templates” del sitio web.</span></li> </ul> <h2><a name="_Toc61945723"><span lang="ES" xml:lang= "ES">WebOperations</span></a></h2> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El web service WebOperations tiene métodos para delegar una tarea, para finalizar un proceso y para trabajar con el paso de sincronización (ver manual del diseñador de procesos del negocio). Un paso de sincronización puede ser configurado para que espere la ocurrencia de una acción externa. La forma de indicarle a Q-flow que la acción externa tuvo lugar es invocar alguno de los dos métodos del web service WebOperations que tienen ese propósito.</span></p> <h3><a name="_Toc61945724"><span lang="ES" xml:lang="ES">Métodos de WebOperations</span></a></h3> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">DelegateTask(DelegationRequest request):void</span></b> <span lang="ES-UY" xml:lang= "ES-UY">–</span> <span lang="ES" xml:lang="ES">delega una tarea. El parámetro “request” es un objeto de tipo DelegationRequest que permite especificar todos los datos necesarios para delegar la tarea.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">FinalizeFlow(Guid flowId)</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES" xml:lang="ES">finaliza el proceso indicado por el parámetro “flowId”.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">FinalizeWaitingStepsByName(Guid flowId, string templateStepName):void</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span><span lang="ES" xml:lang="ES">dado un paso de sincronización, especificado por el identificador del proceso al que pertenece y el nombre del paso, indica que ese paso debe terminar la espera por una acción externa.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">FinalizeWaitingStepsById(Guid flowId, Guid templateStepId):void</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES" xml:lang="ES">dado un paso de sincronización, especificado por el identificador del proceso al que pertenece y el identificador del paso del template en el que se basa, indica que ese paso debe terminar la espera por una acción externa.</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">GetFlowWaitingSteps(Guid flowId):FlowStepMessage[]</span></b> <span lang="ES-UY" xml:lang= "ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">dado el identificador de un proceso (“flowId”), devuelve una lista de objetos que representan los pasos de sincronizaci</span><span lang= "ES" xml:lang="ES">ón de ese proceso que estén en estado de espera.</span></p> <h2><a name="_Toc61945725"><span lang="ES" xml:lang= "ES">WebOrganization</span></a></h2> <p class="MsoNormal" align="left" style='text-align:left'> <span lang="ES" xml:lang="ES">El web service WebOrganization permite interactuar con el modelo organizacional de Q-flow.</span></p> <h3><a name="_Toc61945726"><span lang="ES" xml:lang="ES">Métodos de WebOrganization</span></a></h3> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">CreateGroup(string name, string description, Guid groupNodeId):Guid</span></b> <span lang= "EN-US" xml:lang="EN-US">– crea un grupo.</span> El parámetro “name” indica el nombre del grupo. El parámetro “description” indica la descripción del grupo y “groupNodeId” es el identificador del nodo en el que se debe crear el nuevo grupo.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang= "EN-US">CreateOrganizationNode(string name, string description, Guid parentNodeId):Guid</span></b> <span lang="EN-US" xml:lang= "EN-US">– crea un nodo organizacional.</span> <span lang="ES-UY" xml:lang="ES-UY">El parámetro “name” indica el nombre del nodo. El parámetro “description” indica su descripción y el parámetro “parentNodeId” es el identificador del nodo en el que se debe crear el nuevo nodo.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-AR" xml:lang="ES-AR">CreateUser(string name, string description, Guid userNodeId):Guid</span></b> <span lang= "ES-AR" xml:lang="ES-AR">– crea una cuenta de usuario.</span> El parámetro “name” indica el nombre de usuario. El parámetro description indica la descripción del usuario y userNodeId es el identificador del nodo en el que se debe crear la nueva cuenta.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>DeleteGroup(Guid groupId):void</b> – elimina el grupo identificado por “groupId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>DeleteOrganizationNode(Guid nodeId):void</b> – elimina el nodo identificado por “nodeId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>DeleteUser(Guid userId):void</b> – elimina la cuenta de usuario identificada por “userId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetCalendars():CalendarMessage[]</b> – devuelve un vector de objetos que representan los calendarios existentes en el sistema y contienen los datos de éstos.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetGroup(Guid groupId):GroupMessage</b> – devuelve un objeto que representa el grupo identificado por “groupId”. </p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetGroupsWithUser(Guid userId):SecurityMemberMessage[]</b> – devuelve un vector con objetos que representan aquellos grupos que tienen como miembro el usuario identificado por “userId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetNotifiers(): NotifierMessage[]</span></b> <span lang="ES" xml:lang="ES">– devuelve un vector que contiene objetos que representan los servicios de notificación existentes.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES-UY" style='font-family:Symbol' xml:lang= "ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang="ES-UY">GetOrganizationNode(Guid nodeId):OrganizationNodeMessage</span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" xml:lang= "ES-UY">devuelve un objeto que representa el nodo cuyo identificado por “nodeId”.</span></p> <p class="MsoListParagraphCxSpMiddle" align="left" style= 'text-align:left; text-indent:-18.0pt'><span lang="ES-UY" style= 'font-family:Symbol' xml:lang="ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">GetOrganizationNodeChildren<span style= 'color:black'>(</span>Guid <span style='color:black'>nodeId,</span> bool <span style= 'color:black'>recursive):OrganizationNodeTreeMessage</span></span></b> <span lang="ES-UY" xml:lang="ES-UY">–</span> <span lang="ES-UY" style='color:black' xml:lang="ES-UY">dado el identificador de un nodo organizacional (nodeId), devuelve sus hijos. Si el parámetro “recursive” tiene valor “true”, devuelve todo el subárbol cuya raíz es el nodo con identificador “nodeId”.</span></p> <p class="MsoListParagraphCxSpMiddle" align="left" style= 'text-align:left; text-indent:-18.0pt'><span lang="ES-UY" style= 'font-family:Symbol' xml:lang="ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">GetSecurityMembersByExtendProperties(ExtendedPropertyMessage [] properties, bool includeDisabled):SecurityMemberMessage[]</span></b> <span lang= "ES-UY" xml:lang="ES-UY">- dado un conjunto de propiedades extendidas con valores especificados, devuelve un vector con los elementos del modelo organizacional que tienen todas esas propiedades extendidas. Si el parámetro “includeDisabled” es “true”, va a incluir los elementos del modelo organizacional deshabilitados. De lo contrario, si “includeDisabled” es “false” no va a incluir estos elementos.</span></p> <p class="MsoListParagraphCxSpMiddle" align="left" style= 'text-align:left; text-indent:-18.0pt'><span lang="ES-UY" style= 'font-family:Symbol' xml:lang="ES-UY">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES-UY" xml:lang= "ES-UY">GetSecurityMemberByName(string name):SecurityMemberMessage</span></b> <span lang="ES-UY" xml:lang= "ES-UY">–</span> <span lang="ES-UY" xml:lang="ES-UY">devuelve el elemento del modelo organizacional que tenga el nombre indicado. Notar que el nombre no es único. Puede haber dos miembros con el mismo nombre. En ese caso, se devolverá el primero que se encuentre.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang= "ES">GetSecurityProviders():SecurityProviderMessage[]</span></b> <span lang="ES" xml:lang="ES">– devuelve un</span> vector <span lang="ES" xml:lang="ES">de objetos que representan los proveedores de seguridad y contienen los datos de éstos.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang= "ES">GetSecurityRoles():SecurityRoleMessage[]:</span></b> <span lang="ES" xml:lang="ES">-</span> <span lang="ES" xml:lang= "ES">devuelve un vector de objetos que representan los roles de seguridad existentes en el sistema y que contienen los datos de éstos.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetSecurityRolesWithUser(Guid userId):SecurityRolesMessage[]</b> – devuelve un vector con los roles de seguridad que tienen como miembro el usuario con identificador userId.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetUser(Guid userId):UserMessage</span></b> <span lang="ES" xml:lang= "ES">–</span> <span lang="ES" xml:lang="ES">dado el identificador de un usuario, devuelve un objeto con los datos de ese usuario.</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetUserByLogon(string logon):UserMessage</b><span lang="ES-UY" xml:lang="ES-UY">–</span> dado el logon de un usuario, devuelve un objeto con sus datos.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetUsersByExtendedProperties(ExtendedPropertyMessage[] properties, RestrictionType restrictionType):SimpleUserMessage[]</b> - dado un conjunto de propiedades extendidas con valores especificados, devuelve el conjunto de usuarios que tienen todas esas propiedades con los valores indicados (si RestrictionType es “And”) o el conjunto de usuarios que tienen por lo menos una de esas propiedades con el valor indicado (si RestrictionType es “Or”). Por ejemplo, si RestrictionType es “And” y las propiedades son “Sexo” con el valor “M” y “País” con el valor “Uruguay”, devuelve todos los usuarios que tengan la propiedad “Sexo” con el valor “M” y la propiedad “País” con el valor “Uruguay”. Si la RestrictionType es “Or”, devuelve los usuarios que tienen la propiedad “Sexo” en “M” o la propiedad “País” en “Uruguay”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetUsersInGroup(Guid groupId, bool excludeSubNodeMembers):SimpleUserMessage[]</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> dado el identificador de un grupo, devuelve todos sus usuarios. Si “excludeSubNodeMembers” es “false”, devuelve también los usuarios de todos los grupos descendientes de ese grupo. De lo contrario, devuelve solamente los usuarios del grupo cuyo identificador fue indicado.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ModifyGroup(GroupMessage group):void</b> – dado un objeto GroupMessage que representa un grupo, modifica los datos de ese grupo, reemplazando sus valores por los que son proporcionados en el parámetro. Es conveniente invocar el método GetGroup antes de invocar éste, para obtener un objeto GroupMessage que contenga los datos actualizados del grupo. Después, se modifica el objeto obtenido y se lo utiliza como parámetro para invocar este método.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ModifyOrganizationNode(OrganizationNodeMessage node):void</b> – dado un objeto OrganizationNodeMessage que representa un nodo organizacional, modifica los datos de ese nodo, reemplazando sus valores por los que son proporcionados en el parámetro. Es conveniente invocar el método GetOrganizationMessage antes de invocar éste, para obtener un objeto que contenga los datos actualizados del nodo. Después, se modifica el objeto obtenido y se lo utiliza como parámetro para invocar este método.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>ModifyUser(UserMessage user):void</b> – dado un objeto UserMessage que representa un usuario, modifica los datos de ese usuario, reemplazando sus valores por los que son proporcionados en el parámetro. Es conveniente invocar el método GetUser antes de invocar éste, para obtener un objeto UserMessage que contenga los datos actualizados del usuario. Después, se modifica el objeto obtenido y se lo utiliza como parámetro para invocar este método.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>MoveGroup(Guid groupId, Guid toNodeId): void</b> – mueve el grupo indicado por el parámetro “groupId” al nodo indicado por el parámetro “toNodeId”.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>MoveOrganizationNode(Guid newParentId, Guid nodeId):void</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> mueve el nodo organizacional con identificador “nodeId” hacia el nodo con identificador “newParentId”.</p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>MoveUser(Guid userId, Guid toNodeId):void</b> - mueve el usuario indicado por el parámetro userId al nodo indicado por el parámetro toNodeId.</p> <p class="MsoNormal"><b> </b></p> <h2><a name="_Toc61945727">WebPackage</a></h2> <p class="MsoNormal">El web service WebPackage permite interactuar con la estructura de paquetes de Q-flow.</p> <h3><a name="_Toc61945728">Métodos de WebPackage</a></h3> <p class="MsoListParagraph" style='text-indent:-18.0pt'> <span style='font-family: Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetPackage(Guid packageId):SimplePackageMessage</b> <span lang= "ES-UY" xml:lang="ES-UY">–</span> dado el identificador de un paquete devuelve un objeto con los datos básicos de éste.</p> <h2><a name="_Toc61945729">WebQueue</a></h2> <p class="MsoNormal">El web service WebQueue permite trabajar con colas de trabajo.</p> <h3><a name="_Toc61945730">Métodos de WebQueue</a></h3> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>CheckInTask(Guid flowId, Guid taskId, Guid taskToId):void</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> dados los identificadores de un proceso (flowId), de una tarea (taskId) y de la parte de esa tarea que es propia de un usuario (taskToId), hace que el usuario con cuyas credenciales se está invocando el web service deje la tarea. La tarea tiene que haber sido tomada por el usuario antes (por ejemplo, con el método CheckOutTask).</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>CheckOutTask(Guid flowId, Guid taskId, Guid taskToId):void</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> dados los identificadores de un proceso (flowId), de una tarea (taskId) y de la parte de esa tarea que es propia de un usuario (taskToId), hace que el usuario con cuyas credenciales se está invocando el web service tome la tarea. La tarea tiene que estar dirigida a una cola de trabajo para la cual el usuario tenga permisos de actuar.</p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetMyWorkQueueTasks(Guid workQueueId):Task[]</b> <span lang= "ES-UY" xml:lang="ES-UY">–</span> dado el identificador de una cola de trabajo, permite obtener las tareas de esa cola tomadas por el usuario con cuyas credenciales se invoca el web service.</p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span style='font-family:Symbol'>·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b>GetUnassignedWorkQueueTasks(Guid workQueueId):Task[]</b> <span lang="ES-UY" xml:lang="ES-UY">–</span> dado el identificador de una cola de trabajo, permite obtener las tareas de esa cola que no están tomadas por ningún usuario.</p> <h2><a name="_Toc61945731"><span lang="ES" xml:lang= "ES">WebResponse</span></a></h2> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El web service WebResponse tiene métodos para responder tareas. Para especificar una tarea se utilizan:</span></p> <p class="MsoListParagraphCxSpFirst" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">El identificador del proceso al que pertenece (<b>flowId</b>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">El identificador del paso que corresponde a la tarea en el proceso (<b>stepId</b>).</span></p> <p class="MsoListParagraphCxSpLast" style='text-indent:-18.0pt'> <span lang="ES" style='font-family:Symbol' xml:lang= "ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <span lang="ES" xml:lang="ES">El identificador de la parte de la tarea específica a un destinatario (<b>toId</b>).</span></p> <h3><a name="_Toc61945732"><span lang="ES" xml:lang="ES">Métodos de WebResponse</span></a></h3> <p class="MsoNormalCxSpFirst" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">CheckInAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang="EN-US">-<b> </b>Protege el archivo adjunto identificado por “attachId”.</span> <span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en el botón “Proteger” para ese adjunto</span> en el sitio web viejo. Esta funcionalidad está deprecada.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">CheckOutAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang="EN-US">- Desprotege el archivo adjunto identificado por “attachid”. </span><span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en el botón “Desproteger” para ese adjunto en el sitio</span> web viejo. Esta funcionalidad está deprecada.</p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">DeleteAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang="EN-US">- Elimina el archivo adjunto identificado por “attachId”.</span> <span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en el botón “Eliminar” para ese adjunto.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">DownloadAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):byte[]</span></b> <span lang="EN-US" xml:lang="EN-US">– Devuelve el contenido del archivo adjunto identificado por “attachId”. </span><span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en un adjunto protegido en el formulario de tarea. Para ver la diferencia entre este método y el método DownloadCheckedOutAttachment, vea la descripción de éste.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang= "EN-US">DownloadCheckedOutAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):byte[]</span></b> <span lang="EN-US" xml:lang= "EN-US">-</span><span lang="EN-US" xml:lang="EN-US"> devuelve el contenido del archivo adjunto identificado por “attachId”. </span><span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en un adjunto desprotegido en el formulario de tarea. La diferencia entre este método y el método DownloadAttachment importa cuando un usuario desprotegió un archivo adjunto, lo actualizó, y todavía no lo volvió a proteger (notar que la protección y desprotección de adjuntos está deprecada). DownloadCheckedOutAttachment devuelve el borrador que todavía no se protegió, que todavía no es público y, si se deshace la desprotección, nunca lo será. DownloadAttachment devuelve la versión actual pública del archivo. Ejemplo: Juan adjunta el archivo Informe.docx a un proceso. El título del informe es “Informe”. Pablo desprotege el informe, cambia el título por “Informe de ventas” y sube sus cambios, pero sin proteger el archivo. En este caso, DownloadAttachment devuelve la versión cuyo título es “Informe”, mientras que DownloadCheckedOutAttachment devuelve la versión cuyo título es “Informe de ventas”, es decir, el borrador que Pablo todavía no protegió. Una vez que Pablo haya protegido esa versión, ésta será pública y ambos métodos devolverán la misma.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetTask(Guid flowId, Guid stepId, Guid toId):TaskMessage</span></b> <span lang="ES" xml:lang="ES">– obtiene un objeto que representa la tarea determinada por el identificador de un proceso (“FlowId”), un paso de ese proceso (“StepId”) y la parte de la tarea específica a un destinatario (“ToId”). Una vez obtenido ese objeto, es posible usarlo para responder la tarea que representa por medio de alguno de los otros métodos de ese web service.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">RespondTask(TaskMessage task):void</span></b> <span lang="ES" xml:lang="ES">– responde la tarea representada por parámetro. Ese objeto debe haber sido obtenido por medio del método GetTask y ser modificado para indicar la respuesta que se da a la tarea y, opcionalmente, un porcentaje de progreso.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">RespondTaskNow(Guid flowId, Guid stepId, Guid toId, string responseKey):void</span></b> <span lang= "ES" xml:lang="ES">– responde una tarea con la respuesta indicada por el parámetro ResponseKey.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">RespondTaskNowWithProgress(Guid flowId, Guid stepId, Guid toId, string responseKey, byte progress):void</span></b> <span lang="ES" xml:lang="ES">– responde una tarea con la respuesta indicada por el parámetro “ResponseKey”, y actualizando el progreso de la tarea con el valor del parámetro “Progress”.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang="EN-US">UndoCheckOutAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId):void</span></b> <span lang="EN-US" xml:lang="EN-US">-Deshace la desprotección del archivo adjunto identificado por “attachId”. </span><span lang="ES" xml:lang="ES">Esto es análogo a hacer clic en el botón “Deshacer desprotección” para ese adjunto en el sitio web viejo. Esta funcionalidad está deprecada.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="EN-US" xml:lang= "EN-US">UploadCheckedOutAttachment(Guid flowId, Guid stepId, Guid toId, Guid attachId, byte[] content):void</span></b> <span lang= "EN-US" xml:lang="EN-US">-</span> <span lang="EN-US" xml:lang= "EN-US">Actualiza el contenido del archivo adjunto identificado por “attachid". </span><span lang="ES" xml:lang="ES">El adjunto debe estar desprotegido para actualizar su contenido. Esto es análogo a seleccionar un archivo con el mismo nombre que un adjunto y hacer clic en “Subir” (cuando el adjunto está desprotegido).</span></p> <p class="MsoNormalCxSpLast" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">UploadNewAttachment(Guid flowId, Guid stepId, Guid toId, string name, byte[] content):</span></b><b>Guid</b> -<span lang="ES" xml:lang= "ES"> Crea un nuevo</span> archivo <span lang="ES" xml:lang= "ES">adjunto con el nombre y contenido especificados</span> por los parámetros “name” y “content” respectivamente<span lang="ES" xml:lang="ES">. </span>Devuelve <span lang="ES" xml:lang= "ES">el identificador del adjunto creado. Esto es análogo a seleccionar un archivo con nombre diferente de los adjuntos existentes y hacer clic en “Subir”.</span></p> <h2><a name="_Toc61945733"><span lang="ES" xml:lang= "ES">WebStart</span></a></h2> <p class="MsoNormal"><span lang="ES" xml:lang="ES">El web service WebStart tiene métodos que inician procesos.</span></p> <h3><a name="_Toc61945734"><span lang="ES" xml:lang="ES">Métodos de WebStart</span></a></h3> <p class="MsoNormalCxSpFirst" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">StartFlowNow(Guid templateId, string title, string description):Guid</span></b> <span lang="ES" xml:lang="ES">– inicia un proceso basado en el template indicado por el parámetro “templateId”. El parámetro “title” indica el título que se le dará al proceso, y el parámetro “description” indica la descripción. Devuelve el identificador global (Guid) del proceso iniciado.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">StartFlowNowCorrelativeID(long templateCorrelativeID, string title, string description):Guid</span></b> <span lang="ES" xml:lang="ES">– hace lo mismo que el método StartFlowNow, pero en lugar de recibir un parámetro del tipo Guid para identificar el template en el que se debe basar el nuevo proceso, recibe un parámetro de tipo long, que indica el identificador correlativo del template a ser utilizado.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">StartFlow(NewFlowMessage flowMessage):Guid</span></b> <span lang="ES" xml:lang="ES">– hace lo mismo que los métodos StartFlowNow y StartFlowNowCorrelative, pero recibe un parámetro del tipo NewFlowMessage para indicar los datos del proceso que será iniciado. El objeto NewFlowMessage, además de tener propiedades que representan el título y la descripción del proceso, tiene propiedades que representan los datos de aplicación, roles y archivos adjuntos del proceso. Estas propiedades pueden ser modificadas para inicializar los datos, roles y archivos adjuntos del proceso que se va a iniciar. Para obtener el objeto NewFlowMessage que se va a utilizar para invocar este método, primero debe invocar el método GetFlowInfoCorrelativeId o el método GetNewFlowInfo.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetNewFlowInfoCorrelativeId(long templateCorrelativeID):NewFlowMessage</span></b> <span lang="ES" xml:lang="ES">– dado un template indicado por su identificador correlativo, devuelve un objeto de tipo NewFlowMessage que puede ser utilizado para iniciar un proceso con el método StartFlow.</span></p> <p class="MsoNormalCxSpMiddle" style= 'margin-left:35.7pt;text-indent:-17.85pt'><span lang="ES" style= 'font-family:Symbol' xml:lang="ES">·<span style= 'font:7.0pt "Times New Roman"'> </span></span> <b><span lang="ES" xml:lang="ES">GetNewFlowInfo(Guid templateId):NewFlowMessage</span></b> <span lang="ES" xml:lang= "ES">– dado un template indicado por su identificador global, devuelve un objeto de tipo NewFlowMessage que puede ser utilizado para iniciar in proceso con el método StartFlow.</span></p> <p class="MsoNormal"> </p> </div>
Contents
Topics
Search
Introducción
Organización de este manual
Convenciones usadas en este manual
API de servicios
Descripción de los web services
WebBot
Métodos de WebBot
WebChart
Métodos de WebChart
WebDeploy
Métodos de WebDeploy
WebFlow
Métodos de WebFlow
WebLink
Método de WebLink
WebList
Métodos de WebList
WebOperations
Métodos de WebOperations
WebOrganization
Métodos de WebOrganization
WebPackage
Métodos de WebPackage
WebQueue
Métodos de WebQueue
WebResponse
Métodos de WebResponse
WebStart
Métodos de WebStart
API de servicios
Convenciones usadas en este manual
Descripción de los web services
Introducción
Método de WebLink
Métodos de WebBot
Métodos de WebChart
Métodos de WebDeploy
Métodos de WebFlow
Métodos de WebList
Métodos de WebOperations
Métodos de WebOrganization
Métodos de WebPackage
Métodos de WebQueue
Métodos de WebResponse
Métodos de WebStart
Organización de este manual
WebBot
WebChart
WebDeploy
WebFlow
WebLink
WebList
WebOperations
WebOrganization
WebPackage
WebQueue
WebResponse
WebStart
Generated with
chmProcessor
Generated with
chmProcessor