API para iniciar procesos de Excel - Automate_Evolve - Automate_Studio_Manager - Latest

Guía del usuario de Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Evolve
Automate > Automate Studio Manager
Version
Latest
Language
Español (España)
Product name
Automate Evolve
Title
Guía del usuario de Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:32:48.544670

La API para iniciar procesos de Excel permite iniciar un proceso de workflow de Excel. El archivo Excel enviado se manda a la respectiva biblioteca de soluciones y se inicia un proceso nuevo en este documento nuevo. Esta API usa el método POST para iniciar un proceso de workflow.

Información general de la API

A continuación, se ofrece información general sobre la API para iniciar procesos de Excel:

  1. Admite la función de Plantilla de nombre del proceso de workflow de Excel. La propiedad ExcelWorkflowObj.DataFile.Title se ignorará si el proceso de Excel de destino está configurado con la Plantilla de nombre del archivo de datos. Además, el siguiente nombre de la Plantilla de nombre se utilizará para establecer el nombre del documento.

  2. La API admite la preferencia “Control de versiones: Control de versiones para plantillas de datos”. Se trata de una preferencia de nivel de aplicación y se admite cuando el archivo de datos se envía a la ruta de API/Plantilla.

    También se puede utilizar la ruta/Archivo para enviar un archivo de Excel en el caso de que no se cree a partir de un archivo de plantilla de datos. El archivo enviado a esta ruta se considerará como el archivo de la última plantilla. Por lo tanto, la preferencia «Control de versiones para plantillas de datos» no tendrá ningún significado para él.

  3. El usuario de Evolve especificado como remitente del archivo debe tener el rol Originador en la solución.

  4. El usuario de Evolve especificado como remitente del archivo debe tener una licencia de usuario válida (por ejemplo, ejecutor o estándar, etc.).

  5. No se puede especificar el participante del proceso o el usuario de fase en la solicitud de API. Es lo mismo que enviar un archivo Excel desde el complemento Studio Microsoft Excel.

  6. Admite la función de sincronización de los campos de solución.

  7. Admite la cláusula Where en la consulta (por ejemplo, formato RTV). La ejecución automática para el script de Query que tiene un archivo de entrada a través de la API de proceso de Excel funcionará correctamente cuando se proporcione la información de RTV.

  8. El archivo de datos de Excel creado a partir del «Archivo de Excel de plantilla de solución» debe enviarse a la ruta: {Ruta de API}/Plantilla.

  9. El archivo de datos de Excel no creado a partir del «Archivo de Excel de plantilla de solución» debe enviarse a la ruta: {Ruta de API}/Archivo.

    • No se admitirá el control de versiones para la plantilla de datos.

    • La estructura de columnas y datos del archivo de Excel enviado debe ser la misma que la definida para los scripts de la solución de Excel indicados. Un archivo erróneo provocará errores de ejecución del proceso de workflow o de publicación de datos.

  10. Si no se especifica ni la plantilla ni el archivo, el sistema procesa la solicitud como si estuviera enrutada con «{Ruta de API}/Archivo».

  11. No se permite volver a enviar un archivo de datos con el mismo nombre a través de la API.

  12. Un proceso de workflow de Excel iniciado desde la API se etiquetará como documento de API y, si se vuelve a enviar manualmente, el documento de proceso cancelado se seguirá considerando como documento de API. Esta información se tendrá en cuenta para la facturación de las licencias.

Cuerpo de solicitud y respuesta

Para iniciar un proceso de Excel con una plantilla de Excel indicada a través de la API, la estructura de solicitud y respuesta será la siguiente:

Contrato de datos de solicitud

Nombre Tipo Restricción Descripción
ExcelWorkflowObj Jobject Obligatorio Archivo de datos y documentos auxiliares que se enviarán como objeto JSON. Los detalles del esquema del objeto JSON se encuentran al final de esta tabla. El archivo de datos y el documento auxiliar deben estar codificados como cadena en base64.
UserName cadena Obligatorio Nombre de usuario de Evolve. El usuario debe tener permisos de originador en la solución para la que se envía la plantilla.
AppName cadena Obligatorio Nombre de la aplicación donde debe iniciarse este proceso de Excel. La solución o biblioteca de plantillas de Excel debe estar solo en esta aplicación.
LibName cadena Necesario solo para un archivo de Excel que no sea una plantilla de solución, por ejemplo, {Ruta de API}/Archivo Nombre de la biblioteca de la solución de Excel.
TemplateName cadena Necesario solo para un archivo de Excel que no sea una plantilla de solución, por ejemplo, {Ruta de API}/Archivo Nombre para la «solución de Excel».

Detalles del esquema JSON del parámetro ExcelWorkflowObj:

"ExcelWorkflowObj":{ "DataFile":[{   "Title": "ExcelDataFileName1.xlsx",   "RTVInfo": "",   "Description": "",   "DataFileBlob": "<<Base64EncodedString>>" }], "SupportingFiles":[{   "Title": "SupportingFileName1.xlsx",   "Description": "",   "FileBlob": "<<supporting file blob>>"}, {   "Title": "SupportingFileName2.txt",   "Description": "",   "FileBlob": "<<Base64EncodedString>>" }] }

ExcelWorkflowObj.DataFile: Aunque se trata de un tipo matriz, solo se admite el primer elemento de la matriz y lo utilizará la API.

ExcelWorkflowObj.SupportingFiles: Se pueden enviar varios archivos auxiliares.

Contrato de datos de respuesta:

Nombre Tipo Restricción Descripción
DocumentItemId Guid - Id. de devolución del documento de Excel

Ejemplo de solicitud y respuesta

El siguiente ejemplo muestra el uso de la API:

Carga útil de solicitud

{   "LibName":"Excel Workbooks",   "UserName":"wsdt\\centraluser",   "ExcelWorkflowObj":   {     "DataFile":     [       {       "Description":"",       "DataFileBlob":"UEsDBBQABgAIAAAAIQComKncbgEAAJUFAAATAAgCW0NvbnRlbnRfVHlw...",       "RTVInfo":"",       "Title":"publish10474.xlsx"       }     ]   },   "TemplateName":"MM02_EPIM",   "AppName":"Arpit App" }

Carga útil de respuesta

{     "DocumentItemId": "ea03a42e-7eca-4b5d-af8f-d8e778d75e84" }