DocsAcciones
Hay
Todas las acciones del servicio de API web deben llamarse desde la utilidad Interact API VBO en Blue Prism, y no directamente desde el servicio web.
Obtener envío
La acción Obtener envío es muy similar a la acción Obtener elemento siguiente cuando recupera la información de una cola.
Para utilizar la acción, se agrega una acción a su proceso y se selecciona el objeto de negocio, con la acción establecida en Obtener envío. Hay solo un parámetro de entrada que es la Id. de envío, como se ilustra a continuación.
Los parámetros de salida recuperan el contenido del formulario de Interact, utilizando la Id. de envío en una colección.
Una diferencia cuando el envío se recupera utilizando esta metodología en lugar de la acción estándar Obtener elemento siguiente es el formato de los elementos de fecha. Mediante la técnica Obtener elemento siguiente, la fecha se devuelve en formato de texto, mientras que la opción Obtener envío la devuelve en formato de fecha y hora como se muestra a continuación.
Para obtener una lista completa de las restricciones, consulte las Restricciones de objetos del servicio de API web de Interact.
No puede utilizar la acción Obtener envío a menos que conozca la Id. del envío, ya que es única por envío y no se puede codificar en su automatización. Esta debe recuperarse mediante la acción Obtener elemento siguiente.
Obtener esquema de formulario
La acción Obtener esquema de formulario obtiene una estructura de un formulario de Interact en una colección que le permite manipular y luego utilizar la acción Crear envío al crear un formulario de Interact, ya sea vacío o parcialmente creado para que un usuario lo complete y lo envíe.
Hay solo un parámetro de entrada que es el nombre del formulario dentro de Interact para el que está recuperando la estructura, como se ilustra a continuación.
Los parámetros de salida son similares a la acción “Obtener envío”, donde se devuelve el estado de la solicitud junto con una colección que contiene los campos.
La colección recuperada es una colección en blanco que contiene la estructura del formulario.
La diferencia entre los formatos Obtener elemento siguiente y Obtener esquema de formulario es el campo del elemento de carga. La acción Obtener elemento siguiente devuelve un enlace al lugar donde se almacena el archivo; sin embargo, la acción Obtener esquema de formulario devuelve una colección que incluye no solo un enlace, sino también detalles del archivo cargado. Esto también es necesario cuando se utiliza la acción Cargar archivo.
El formato de la colección que contiene los detalles del archivo de carga debe establecerse correctamente, como se ilustra arriba:
- Nombre: el nombre del archivo, incluida la extensión.
- Tamaño: el tamaño del archivo en bytes.
- Extensión: la extensión del archivo, sin el punto inicial ni el punto final.
- Enlace: el enlace al archivo cargado.
- Tipo: el tipo de archivo, por ejemplo, “application/pdf” o “image/png”.
Obtener usuarios por nombre del formulario
La acción Obtener usuarios por nombre del formulario le permite recopilar una lista de usuarios asociados con un nombre de formulario en particular.
La entrada para la acción es el nombre del formulario, como se ilustra a continuación.
La salida es una colección que enumera los usuarios asociados con ese nombre de formulario.
Crear envío
Hay cuatro parámetros que deben definirse dentro de la acción Crear envío.
Estos cuatro parámetros son los siguientes:
- Nombre de usuario: este es el nombre de usuario del usuario de Interact para el que se creará el envío.
- Contraseña: la contraseña para este usuario de Interact.
- Nombre del formulario: el formulario que se creará dentro de Interact.
- Campos: los valores que se establecerán dentro del envío creado.
Para ayudar a crear un nuevo envío, se puede utilizar Obtener esquema de formulario para recuperar la estructura básica del formulario. Esto podría completarse con nuevos elementos de datos y luego crearse como un nuevo envío para un usuario.
Para crear un envío, los campos y el esquema de formulario deben coincidir con los del formulario dentro de Interact. Los campos faltantes o una estructura incorrecta harán que se cree un envío dañado.
Una vez iniciado, el envío creado aparecerá en el historial de envíos de los usuarios especificados como un formulario enviado y se agregará a la cola de Blue Prism especificada que se detalla en la construcción del formulario.
El usuario cuyas credenciales se utilizan para crear el nuevo envío debe tener permiso para acceder al formulario. Por lo tanto, el rol de Interact que contiene el formulario debe tener el usuario especificado en la lista de usuarios.
No hay parámetros de salida para la acción Crear envío.
Presentar envío
La acción Presentar envío le permite crear un envío en una carpeta de la bandeja de entrada específica de un usuario. El envío presentado puede completarse en forma total o parcial, o incluso estar completamente vacío según sus requisitos.
Las entradas para la acción son el nombre del formulario, la id. de usuario (que se puede obtener ejecutando Obtener usuarios por nombre del formulario) y los datos que se cargarán en los campos, como se ilustra a continuación. El archivo de datos cargado se puede crear ejecutando el comando obtener esquema de formulario.
No hay salidas para la acción Presentar envío.
Cuando utilice Presentar envío con Cargar archivo, asegúrese de formatear correctamente la colección que contiene los detalles del archivo que se adjunta. Consulte Obtener esquema de formulario para obtener más detalles sobre el formato de la colección.
Cargar archivo
La acción Cargar archivo le permite cargar un archivo al almacenamiento local, por ejemplo, un archivo de imagen o un documento. Puede utilizarse junto con:
La acción Cargar archivo solo carga un archivo a la vez. Al cargar varios archivos a un formulario, debe ejecutar la acción de carga de archivo para cada archivo y luego almacenar los enlaces de salida por separado.
Hay cuatro entradas para la acción, como se ilustra a continuación:
- Nombre del formulario: el formulario dentro de Interact con el que se asociará el archivo cargado.
- Nombre del campo: la id. de automatización del campo en el formulario.
- Nombre del archivo: el archivo que se cargará en el almacenamiento local. Este debe incluir el nombre completo del archivo, incluida la extensión.
- Archivo: el contenido del archivo adjunto utilizando un elemento de datos con el tipo establecido en binario.
Al cargar un archivo, se le proporciona un enlace que luego se puede utilizar en las acciones enumeradas anteriormente de
Una vez que el archivo se haya cargado, puede adjuntar el contenido del archivo a la acción correspondiente de
- Cargar archivo: cargar el archivo en el almacenamiento local.
- Obtener esquema del formulario: obtener la estructura del formulario al que se adjuntará el archivo.
- Crear envío o presentar envío: hace referencia a la estructura modificada del formulario y adjunta el archivo cargado al nuevo envío.
Cuando se utiliza Crear envío, el archivo adjunto se puede descargar y ver desde la pestaña Historial de envíos de Interact. Si se utiliza la función Presentar envío, el usuario solo puede editar el enlace que reemplaza al archivo, el usuario no puede ver el archivo adjunto, a menos que sea una imagen, ni puede descargar el archivo.
Editar valor de campo de envío
La acción Editar valor de campo de envío, como todas las demás acciones, se llama desde el objeto. Hay varias acciones dentro del objeto que le permiten actualizar elementos de campo específicos; estas acciones se vinculan directamente con el tipo de elemento que se utiliza en el formulario de Interact.
El nombre del campo en las secciones siguientes es la id. de automatización que se creó dentro del diseñador de formularios.
Los detalles de los diferentes tipos de elementos se describen en las siguientes secciones.
Elemento de casilla de verificación (simple)
El valor de edición de la casilla de verificación son dos acciones diferentes que admiten el uso de las casillas de verificación simples y múltiples. Para actualizar los valores de una casilla de verificación simple, se envía una cadena de texto simple.
Elemento de casilla de verificación (múltiple)
Para el valor de edición de casilla de verificación (múltiple), nuevamente es una cadena de texto simple que se envía, pero que utiliza una cadena separada por comas para los diferentes valores.
Elemento de fecha
El elemento de fecha utiliza el formato de texto para editar valores en un formulario de Interact; esto es para admitir los tres formatos diferentes dentro del formulario de Interact. El formulario le permitirá usar estos formatos para las fechas:
- DD/MM/AAAA: formato del Reino Unido.
- MM/DD/AAAA: formato de EE. UU.
- AAAA/MM/DD: formato internacional.
Si configuró el formulario de Interact para aceptar el formato internacional para las fechas y envía la fecha nuevamente en el formato del Reino Unido o de los EE. UU., el formulario de Interact mostrará un mensaje de datos no válidos.
Elemento de lista despegable (simple)
El elemento de lista despegable, como el elemento de casilla de verificación, admite dos acciones para las entradas simples y múltiples. Para actualizar los valores de una lista despegable simple, se envía una cadena de texto simple.
Elemento de lista despegable (múltiple)
Para el valor de edición de lista despegable (múltiple), nuevamente es una cadena de texto simple que se envía, pero que utiliza una cadena separada por comas para los diferentes valores.
Elemento de número
El elemento de número aceptará que se le pase un número o un texto. Aunque el tipo de campo es un tipo de texto, debe proporcionar un número usando solo los delimitadores aceptables, como comas y puntos decimales. Si se devuelve texto, el formulario de Interact mostrará un mensaje relacionado con datos no válidos.
Elemento de grupo de radio
El elemento de grupo de radio es como un elemento de casilla de verificación o lista despegable simple. El valor editado es un campo de texto simple que incluye el valor actualizado requerido.
Elemento de tabla
El elemento de tabla utiliza una colección para permitirle actualizar los valores. La colección debe contener la misma cantidad de columnas que el campo del formulario dentro del formulario de destino. Se deben utilizar ID de automatización para los nombres de campo de la colección. La cantidad de filas se puede aumentar o disminuir para adaptarse a los datos que se actualizan.
La acción Editar tabla sobrescribe toda la tabla en lugar de agregar filas a una tabla existente.
Elemento de texto
El elemento de texto requiere que se le pase un campo de texto simple.
Elemento de hora
El elemento de hora utiliza el formato de texto para editar valores en un formulario de Interact. Puede proporcionar la hora en uno de los dos formatos siguientes:
- 03:00:00 p. m.; o
- 15:00:00.
Ambos devolverán las 3 de la tarde en Interact.
Actualizar configuración
La acción Actualizar configuración ha sido reemplazada por acciones individuales y se eliminará del objeto de Blue Prism en un lanzamiento futuro. Ahora cada opción de estado tiene una acción independiente. Si está utilizando Actualizar configuración, debe cambiar para utilizar la acción adecuada.
La acción Actualizar configuración le permite cambiar el estado de un campo o una página dentro de un envío. Las entradas para la acción se ilustran a continuación. Este ejemplo muestra un campo con el nombre de “seguridad” configurado en un estado “obligatorio”. Las entradas son la id. de envío, la id. de automatización del campo o el nombre de la página si está cambiando el estado de una página, un tipo y las entradas de estado.
No hay salidas de la acción Actualizar configuración.
Las entradas Tipo y Estado funcionan juntas. Para el tipo, hay dos valores que se pueden utilizar:
- 0: para modificar el estado de un campo
- 2: para modificar el estado de una página
|
Si modifica el estado de un campo (tipo establecido en “0”), las opciones de estado son las siguientes:
|
Si modifica el estado de una página (tipo establecido en “2”), las opciones de estado son las siguientes:
|
La configuración de actualización generalmente se utiliza en un escenario de colaboración entre trabajador humano/Digital Worker en el que el formulario se actualiza dinámicamente a medida que el trabajador humano interactúa con la automatización. Esto se detalla por separado y muestra cómo se pueden utilizar estas acciones para actualizar un formulario con información de un usuario.
Los elementos de párrafo son bloques de texto que no se pueden cambiar en un formulario una vez que se ha implementado el formulario. Sin embargo, es posible usar “Obtener esquema de formulario” para obtener la id. del elemento del campo de párrafo, luego usar Actualizar configuración, y ocultarlos o mostrarlos a medida que avanza la actualización.
Cambiar el estado del campo a opcional
La acción Cambiar el estado del campo a opcional le permite cambiar el estado de un campo dentro de un envío y lo mueve a una condición opcional.
Las entradas para la acción son la id. del envío y el nombre del campo al que está cambiando el estado a opcional, como se ilustra a continuación. Este ejemplo muestra un campo con el nombre de “seguridad” configurado en un estado “opcional”.
No hay salidas para Cambiar el estado del campo a opcional.
Cambiar el estado del campo a obligatorio
La acción Cambiar el estado del campo a obligatorio le permite cambiar el estado de un campo dentro de un envío y lo mueve a una condición de obligatorio.
Las entradas para la acción son la Id. del envío y el nombre del campo al que está cambiando el estado a obligatorio, como se ilustra a continuación. Este ejemplo muestra un campo con el nombre de seguridad configurado en un estado “obligatorio”.
No hay salidas para Cambiar el estado del campo a obligatorio.
Cambiar el estado del campo a solo lectura
La acción Cambiar el estado del campo a solo lectura le permite cambiar el estado de un campo dentro de un envío y lo mueve a una condición de solo lectura.
Las entradas para la acción son la id. del envío y el nombre del campo al que está cambiando el estado a solo lectura, como se ilustra a continuación. Este ejemplo muestra un campo con el nombre de “seguridad” configurado en un estado de “solo lectura”.
No hay salidas para Cambiar el estado del campo a solo lectura.
Cambiar el estado del campo a oculto
La acción Cambiar el estado del campo a oculto le permite cambiar el estado de un campo dentro de un envío y lo mueve a una condición de oculto.
Las entradas para la acción son la Id. del envío y el nombre del campo al que está cambiando el estado a oculto, como se ilustra a continuación. Este ejemplo muestra un campo con el nombre de “seguridad” configurado en un estado “oculto”.
No hay salidas para Cambiar el estado del campo a oculto.
Cambiar el estado de la página a visible
La acción Cambiar el estado de la página a visible le permite hacer visible una página dentro de un envío.
Las entradas para la acción son la Id. del envío y el nombre de la página que está cambiando para que se vuelva visible, como se ilustra a continuación. Este ejemplo muestra una página con el nombre de “entradas” que se establece en un estado “visible”.
No hay salidas para Cambiar el estado de la página a visible.
Cambiar el estado de la página a oculto
La acción Cambiar el estado de la página a oculto le permite ocultar una página de la vista dentro de un envío.
Las entradas para la acción son la id. del envío y el nombre de la página que está cambiando para que se vuelva oculta, como se ilustra a continuación. Este ejemplo muestra una página con el nombre de “entradas” que se establece en un estado “oculto”.
No hay salidas para Cambiar el estado de la página a oculto.
Actualizar estado
La acción Actualizar estado ha sido reemplazada por acciones individuales y se eliminará del objeto de Blue Prism en un lanzamiento futuro. Ahora cada opción de estado tiene una acción independiente. Si está utilizando Actualizar estado, debe cambiar para utilizar la acción adecuada.
La acción Actualizar estado, como la acción Actualizar configuración, se utiliza generalmente en un escenario modelo con interacción humana.
Las entradas para la acción se ilustran a continuación y son la Id. del envío y el estado.
Hay seis estados que se pueden aplicar a un envío, que se definen de la siguiente manera:
- 0: establece el estado en enviado y mueve el envío a la pestaña Historial de envíos en Historial, si aún no está allí. El filtro Estado se puede utilizar para mostrar únicamente los elementos enviados. Utilice la acción Mover envío a la pestaña Historial.
- 1: establece el estado en aprobado y mueve el envío a la pestaña Historial de envíos en Historial, si aún no está allí. El filtro Estado se puede utilizar para mostrar únicamente elementos aprobados. Utilice la acción Mover envío a la pestaña Aprobado.
- 2: mueve el envío a la pestaña En espera de aprobación en Historial para el remitente, y a la pestaña Aprobaciones en Mi trabajo para el aprobador. Utilice la acción Mover envío a la pestaña Revisión.
- 3: establece el estado en rechazado y mueve el envío a la pestaña Historial de envíos en Historial, si aún no está allí. El filtro de estado se puede utilizar para mostrar únicamente los elementos rechazados. Utilice la acción Mover envío a la pestaña Rechazados.
- 4: mueve el envío a la pestaña Borrador en Mi trabajo.
- 5: mueve el envío a la pestaña Bandeja de entrada en Mi trabajo.
- 6: mueve el envío a la pestaña Archivados en Historial.
Mover envío a la pestaña Historial
La acción Mover envío a la pestaña Historial le permite mover un envío de su carpeta actual a la carpeta Historial de envíos en Historial. Esta acción también actualiza el estado del envío a enviado. El filtro Estado en Interact se puede utilizar para mostrar solo los envíos con este estado.
La entrada para la acción es la Id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Historial.
Mover envío a la pestaña Aprobado
La acción Mover envío a la pestaña Aprobado le permite mover un envío de su carpeta actual a la carpeta Historial de envíos en Historial. Esta acción también actualiza el estado del envío a aprobado. El filtro Estado en Interact se puede utilizar para mostrar solo los envíos con este estado.
La entrada para la acción es la id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para Mover envío a Aprobado.
Mover envío a la pestaña Revisión
La acción Mover envío a la pestaña Revisión le permite mover el envío a la carpeta En espera de aprobación en Historial para el remitente, y a la carpeta Aprobaciones en Mi trabajo para el aprobador.
Esto requiere que se configure un formulario con un Aprobador único o con Cualquier aprobador. De lo contrario, el formulario se moverá a la carpeta En espera de aprobación, pero no se moverá a la pestaña Mi trabajo de un aprobador.
La entrada para la acción es la id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Revisión.
Mover envío a la pestaña Rechazados
La acción Mover envío a la pestaña Rechazados le permite mover un envío de su carpeta actual a la carpeta Historial de envíos en Historial. Esta acción también actualiza el estado del envío a Rechazado. El filtro Estado en Interact se puede utilizar para mostrar solo los envíos con este estado.
La entrada para la acción es la id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Rechazados.
Mover envío a la pestaña Borrador
La acción Mover envío a la pestaña Borrador le permite mover un envío de su carpeta actual a la carpeta Borrador en Mi trabajo.
La entrada para la acción es la id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Borrador.
Mover envío a la pestaña Bandeja de entrada
La acción Mover envío a la pestaña Bandeja de entrada le permite mover un envío de su carpeta actual a la carpeta Bandeja de entrada en Mi trabajo.
La entrada para la acción es la Id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Bandeja de entrada.
Mover envío a la pestaña Archivados
La acción Mover envío a la pestaña Archivados le permite mover un envío de su carpeta actual a la carpeta Archivados en Historial.
La entrada para la acción es la id. del envío que se mueve, como se ilustra a continuación.
No hay salidas para la opción Mover envío a la pestaña Archivados.
Volver al principio