Lea y revise la documentación de Automation Anywhere

Cerrar contenidos

Contenidos

Abrir contenidos

API para exportar e importar bots para la administración del ciclo de vida de los bots

  • Actualizado: 5/10/2019
    • 11.3.x
    • Administrar
    • Enterprise
    • Documentos de API

API para exportar e importar bots para la administración del ciclo de vida de los bots

Utilice las API de exportación e importación de bots para personalizar la solución de administración del ciclo de vida de los bots para la organización a fin de lograr un ciclo de vida de automatización ininterrumpido.

Normalmente, el usuario de Enterprise Control Room tiene que depender de medios distintos a Enterprise Control Room (por ejemplo, correo electrónico) para implementar instancias de TaskBot de un entorno a otro. Al utilizar las API de exportación e importación, puede introducir fácilmente una solución personalizada de Administración del ciclo de vida útil de los bots (BLM), lo que elimina todos los factores externos que pueden interrumpir el ciclo de vida útil de su automatización.

Como un usuario de Enterprise Control Room con permiso para Exportar bots y Descargar bots, usted puede exportar un bot y sus archivos dependientes. De igual forma, al ser un usuario con permiso para Importar bots y Cargar bots, usted puede importar ese bot y sus archivos dependientes.

Por ejemplo, puede mover los bots que están verificados como listos para la producción de validación a producción.

Puede usar la API de Exportación Importación de Enterprise Control Room para administrar sus TaskBots de automatización, incluidos los archivos dependientes en distintos entornos, como Desarrollo, Pruebas, Aceptación y producción, según las necesidades de automatización de su organización.

Consulte los artículos dedicados a Exportar bots e Importar bots para usar esta funcionalidad desde su interfaz de usuario de Enterprise Control Room.

Características y beneficios

  • Control de acceso basado en roles en Administración del ciclo de vida útil de los bots
  • Exportación automática de dependencias (archivos y bots)
  • Auditoría y capacidad de seguimiento en entornos de origen y destino para el cumplimiento
  • Notificación por correo electrónico de ejecución exitosa o fallo de exportación e importación.

Exportar

  • El usuario de Enterprise Control Room cuyas credenciales se usan para la autenticación debe tener permisos para Exportar bots
  • El usuario de Enterprise Control Room cuyas credenciales se usan para la autenticación debe tener permisos de Descarga en los bots, como mínimo permisos para Ejecutar en MetaBot y las dependencias que se están exportando.
  • Si el control de versiones está habilitado en el Enterprise Control Room de origen, la versión de producción de todos los bots y dependencias que quiere exportar debe estar definida.
  • La cuenta del usuario que se usa para ejecutar los servicios de Enterprise Control Room debe tener acceso a la ubicación en la que se exportará el paquete; por ejemplo, la ubicación de red (unidad compartida) o en la máquina de servidor de Enterprise Control Room.

Importar

  • El usuario de Enterprise Control Room cuyas credenciales se usan para la autenticación debe tener permisos para Importar bots
  • El usuario de Enterprise Control Room cuyas credenciales se usan para la autenticación debe tener permisos para Cargar en los bots y en las dependencias que se están importando.
  • El usuario de Enterprise Control Room que ejecutará la utilidad para importar varios bots debe tener acceso al archivo de paquete exportado proporcionado por Automation Anywhere.

Extremos de API

  • Exportar: <Enterprise Control Room URL>/v1/blm/export

    Por ejemplo,https://crdevenv.com:81/v1/alm/export

  • Importar: <Enterprise Control Room URL>/v1/blm/import

    Por ejemplo, https://crtestenv.com:82/v1/alm/import

Mediante el uso de los extremos anteriores de la API de Exportación Importación BLM, puede exportar e importar un solo bot y todas sus dependencias.

Exportar bot

Exporte un solo bot con sus archivos dependientes usando la API de exportación proporcionada por Automation Anywhere:

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Para esto, ingrese la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo, https://crdevenv.com:81/v1/authentication

  2. Use el método POST e indique los parámetros para las credenciales en los Datos de cuerpo. Consulte muestra:

    {

    "nombre de usuario":"cradmin",

    "contraseña":"cr@admin"

    }

  3. Haga clic en Reproducir/Iniciar.
  4. La API de exportación de BLM usará el token de autenticación que se obtiene con la API de autenticación. El token de autenticación se debe pasar como una de las entradas de encabezado en la API de exportación de BLM.
  5. Ingrese parámetros tales como ruta de archivo, ruta de destino y nombre del paquete en los datos del cuerpo para exportar un bot. La siguiente lista proporciona la descripción del parámetro:
    • filePath (ruta de archivo): use esto para especificar la ruta de archivo que termina con el nombre del bot que desea exportar
    • destinationPath (ruta de destino): use esto parece explicar ruta de destino en la que se almacenará el paquete exportado
    • packageName (nombre del paquete): use esto para especificar el nombre del paquete que desea asignar al paquete exportado

      Consulte muestra,

      {

      "filePath":"Automation Anywhere\\My Tasks\\Finance\\Account Reconciliation.atmx",

      "destinationPath":"tempshare\\datashare\\Finance Department",

      "packageName":"Finance package"

      }

  6. Haga clic en Play/Start.
  7. Puede usar varias fuentes para ver los resultados de exportación en
    • Datos de respuesta que comprenden packagePath (ruta del paquete) y suma de comprobación.
    • Página de registro de auditoría (página de inicio y página de detalles)
    • Correo electrónico cuando recibe la notificación de éxito o falla, si está configurado.

Importar bot

Después que el bot se exporta exitosamente a la unidad de red o ruta de máquina de Enterprise Control Room,otro usuario autorizado puede importar ese paquete a un Enterprise Control Room diferente usando la API de importación:

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Proporcione la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo, https://crtestenv.com:82/v1/authentication

  2. Use el método POST e indique los parámetros para las credenciales en los Datos de cuerpo.

    Consulte muestra:

    {

    "username":"cradmin2",

    "contraseña":"cr@admin"

    }

  3. Haga clic en Play/Start.
  4. La API de importación de BLM usará el token de autenticación que se obtiene con la API de autenticación. El token de autenticación se debe pasar como una de las entradas de encabezado en la API de importación de BLM.
  5. Después que sus credenciales estén autenticadas, proporcione parámetros como ruta del paquete y la suma de comrpobación que se generó como un token durante la exportación en Datos de cuerpo.

    Consulte muestra:

    {

    "packagePath":"tempshare\\datashare\\Finance Department\\Finance Package_20171221-154403.aapkg",

    "checksum":"ZLyQ+Lbu2N+beEuXf6qd2Qi9uwi3BZxApn57C7mYjKQ="

    }

Consejo: Puede copiar la respuesta de la BLM Export API y pasar esos directamente como una entrada a la BLM Import API, si la ruta del paquete es la misma y es accesible para el usuario de la BLM Import API.

Códigos de respuesta de API

Código de estado HTTP(s) Respuesta - Descripción Acción correctiva
200 Paquete creado exitosamente No aplica
400 Parámetro de solicitud incorrecto Vuelva a intentarlo con parámetros válidos
404 No se encontró el archivo Asegúrese de que el archivo o bot esté presente en Enterprise Control Room
501 Error de permisos Asegúrese de que tiene los permisos Exportar/importar bots o Subir/descargar

Utilidad de la API de exportación e importación

Para exportar e importar varios bots, puede usar la utilidad proporcionada por Automation Anywhere, que comprende archivos en lotes y archivos jar*.

*Versiones de Java 1.8 y posteriores.

Exportar bots

Puede exportar varios bots desde un repositorio de Enterprise Control Room con la utilidad de exportación de BLM de Enterprise Control Room. Aquí se explica el método en el que se usa el archivo de lote para exportar instancias de TaskBot desde su repositorio de Enterprise Control Room:

  1. Abra el archivo de lote de exportación de BLM que incluye los comandos de la API y los parámetros necesarios para exportar bots desde Enterprise Control Room. Este archivo también ofrece parámetros de muestra para facilitar su uso.
    Nota: Esta utilidad hace uso de la API de exportación de BLM en segundo plano para exportar varios bots. Consulte los requisitos previos. Archivo de lote de exporación BLM
    Consejo: Se recomienda crear una copia del archivo de lote antes de comenzar el proceso de exportación.
  2. Ahora deberá proporcionar los siguientes parámetros en el archivo para exportar instancias de TaskBot y sus archivos dependientes
    • Instancia de Enterprise Control Room como parámetro source_CR.

      Por ejemplo, http://stagingCR-mydomain.com:8081/

    • Sus credenciales de inicio de sesión de Enterprise Control Room, como parámetros de nombre de usaurio y contraseña.

      Por ejemplo, nombre de usuario: Mike, contraseña: Mike@123

    • Nombres de archivos de TaskBot como parámetro export_files. Puede especificar los bots o archivos separados por comas.

      Por ejemplo, Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx

    • Nombre de la ruta del repositorio de TaskBot como parámetro export_directories. Use esta opción si desea exportar una gran cantidad de bots desde carpetas.

      Por ejemplo, Automation Anywhere\\My Tasks\\Utilities Bots\\312018, Automation Anywhere\\My Tasks\\Sample Tasks\\Analytics Tasks

    • Nombres de archivos CSV con su ruta como parámetro export_CSVs. Use esta opción si desea exportar bots o archivos desde un archivo externo .csv o .txt.
      • Puede combinar nombres de archivos, directorios y archivos .csv para exportar varios archivos desde diferentes fuentes.

        Por ejemplo, Automation Anywhere\My Tasks\Finance\Bank Account Reconcilation.atmx, Automation Anywhere\My Tasks\Banking\Audit Certification Generation.atmx, Automation Anywhere\My MetaBots\Import Customer Data.mbot, Automation Anywhere\My Docs\daily sales data.xlsx

      • Debe pasar al menos un parámetro y dejar los valores en blanco para los que no sean necesarios.

        Por ejemplo, SET export_CSVs=""

    • Nombre del paquete como parámetro package_name. Este archivo se guarda como archivo comprimido que se usa para importar los bots a otra instancia de Enterprise Control Room.

      Por ejemplo, Reconciliación de la cuenta bancaria

    • Ruta de destino del paquete como parámetro package_path.
      Nota: Esto puede ser una unidad compartida o una ruta de máquina de Enterprise Control Room para la cual el usuario del servicio de Enterprise Control Room debe tener permiso de escritura.
      Por ejemplo,\\\\network_share\\BLM Export Packages
  3. Ejecute el archivo de lote para iniciar el comando de exportación.
  4. Verifique que el paquete se haya creado en la ubicación especificada como parámetro package_path.

    El usuario de Enterprise Control Room utilizará este paquete para importar los bots a otra instancia de Enterprise Control Room.

Código de muestra

SET source_CR=<Dirección URL de Enterprise Control Room>

SET username=<Nombre de usuario de Enterprise Control Room>

SET password=<Contraseña de Enterprise Control Room>

SET export_files="<Comma separated list of bots to be exported>"

SET export_directories="<Comma separated list of directories to be exported>"

SET export_CSVs="<Comma separated list of CSVs whose content are to be exported>"

SET package_name=<Name of the export package>

SET package_path=<Path at which package will be exported>

java -jar %utility_path% -Oexport -H%source_CR% -U%username% -P%password% -N%package_name% -K%package_path% -F%export_files% -D%package_path% -C%export_CSVs%

pause

@echo off

REM *****************************PARÁMETROS DE MUESTRA***************************************

REM SET source_CR=http://123.456.78.90:8080

REM SET username=Mike

REM SET password=Mike@123

REM SET export_files="Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM bots\\Comparison Data.atmx"

REM SET export_directories="Automation Anywhere\\My Tasks\\Utilities Bots\\312018"

REM SET export_CSVs="D:\BLM\Account Reconciliation Bots.csv"

REM SET package_name=Reconciliación de la cuenta bancaria

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Importar bots

Puede importar varios bots en un repositorio de Enterprise Control Room con la utilidad de importación de BLM de Enterprise Control Room. Aquí se explica el método en el que se usa el archivo de lote para importar instancias de TaskBot en su repositorio de Enterprise Control Room:

  1. Abra el archivo de lote de importación de BLM que incluye los comandos de la API y los parámetros necesarios para importar bots a Enterprise Control Room. Este archivo también ofrece parámetros de muestra para facilitar su uso.
    Consejo: Se recomienda crear una copia del archivo de lote antes de comenzar el proceso de importación.
  2. Ahora deberá proporcionar los siguientes parámetros en el archivo para importar instancias de TaskBot y sus archivos dependientes:
    1. La instancia de Enterprise Control Room de destino como parámetro target_CR.

      Por ejemplo, http://prodCR-mydomain.com:80/

    2. Sus credenciales de inicio de sesión de Enterprise Control Room, como parámetros de nombre de usaurio y contraseña.

      Por ejemplo, nombre de usuario: John.Smith, contraseña: John@123

    3. Nombre de ruta absoluto del paquete de exportación como parámetro package_path.

      Por ejemplo, \\\\network_share\\BLM Export Packages

  3. Ejecute el archivo de lote para iniciar el comando de importación.
  4. Puede verificar que los bots se importen en el repositorio de bots de Enterprise Control Room desde la lista de bots o archivos exportados o importados en el archivo BLM Logs.log. Este archivo se guarda en la misma carpeta que la utilidad (archivo .jar).

Código de muestra

SET target_CR=<Dirección URL de la instancia de destino de Enterprise Control Room>

SET username=<Nombre de usuario de Enterprise Control Room>

SET password=<Contraseña de Enterprise Control Room>

SET package_path=<Absolute path of the export package>

java -jar %utility_path% -Oimport -S%package_path% -U%username% -P%password% -H%target_CR%

pause

@echo off

REM *****************************PARÁMETROS DE MUESTRA***************************************

REM SET target_CR=http://987.654.32.10:8080

REM SET username=John

REM SET password=John@123

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Registros de auditoría

Una entrada de auditoría se registra en la página de Registro de auditoría de Enterprise Control Room al exportar o importar bots.

Enviar comentarios