API de datos SAP con Evolve - 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 de datos SAP se expone para cargar y descargar datos procedentes de SAP. La API está disponible tanto para Evolve como para Studio Manager. Esta solución se rige por el proceso de workflow de scripts y por la configuración del proceso de workflow de scripts. La API expone la carga útil JSON y otros detalles (como SAP, la configuración de ejecución, etc.) para publicar datos en SAP.

Para acceder a la API de datos SAP desde Evolve, siga estos pasos:

  1. Active una licencia válida de la API de datos SAP.
  2. Cree una biblioteca de almacenes de API de SAP.
  3. Cree un script en Studio para que se utilice al añadir las API de SAP desde Evolve. Consulte Crear un script para la integración con la API de datos SAP en API de datos SAP con Studio.
  4. Añada la API de SAP desde la pestaña Soluciones.

Biblioteca de almacenes de API de SAP

Para guardar soluciones de las API de datos SAP en Evolve, el usuario necesita crear una biblioteca nueva en Evolve. A continuación, se indican los pasos para crear una biblioteca nueva:

  1. Vaya a Evolve → Configuración → Administrar bibliotecas, en la aplicación en la que debe crearse la biblioteca.

  2. Haga clic en Añadir.

  3. El tipo que hay que seleccionar debe ser SAPAPIStore.

  4. Indique un nombre y una descripción para la biblioteca. Ambos campos son obligatorios.

  5. Active la opción Habilitar historial del documento si desea generar documentos para la solución de API de SAP en el momento de la ejecución. El valor predeterminado será False.

  6. Haga clic en Guardar.

  7. Vaya a la página Soluciones; la biblioteca nueva debería aparecer junto a todas las demás bibliotecas.

Si se habilita la clave SapIntegrationAPIEnable, el tipo de biblioteca SAPAPIStore también se habilitará para todas las aplicaciones de Evolve. Esta biblioteca no estará disponible para las aplicaciones de datos de referencia. El tipo de biblioteca SAPAPIStore se habilitará en Añadir biblioteca. Solo los administradores de aplicaciones y los administradores globales tienen permiso para añadir esta biblioteca.

Para administrar los permisos de la biblioteca de tipo «SAPAPIStore», vaya a Configuración → Administrar bibliotecas en Evolve y seleccione las API de datos SAP haciendo clic en la casilla que hay en la cuadrícula de la tabla. Haga clic en Administrar permisos de biblioteca. Al igual que la biblioteca de formularios, la biblioteca SAPAPIStore también tiene dos opciones de administración de permisos, Permisos de procesos y Permisos de solución de biblioteca. La opción Permisos de proceso tiene un permiso predeterminado establecido en Originador. El usuario puede eliminar el permiso predeterminado y añadir cualquier grupo de permisos de originador. La opción Permisos de solución de biblioteca tiene los permisos predeterminados establecidos en Desarrollador de soluciones y Revisor de soluciones; el usuario puede eliminar los permisos predeterminados y añadir cualquier grupo de permisos de desarrollador de soluciones y revisor de soluciones.

La configuración de aprobación de la API de SAP se puede añadir en la página Aplicación → Preferencias → Preferencias de diseño, con las tres opciones que se indican a continuación. El valor predeterminado es False para las tres opciones.

  1. Aprobación de la solución: Si se establece en True, la solución enviada a Evolve estará en revisión hasta que el revisor la apruebe desde las tareas.

  2. Aprobación automática: Si se establece en True, el usuario que envía la solución puede aprobarla por sí mismo y el nombre del usuario aparecerá en la lista de revisores al enviar o actualizar la API de datos SAP.

  3. Motivo del rechazo de la solución: Si se establece en True, el usuario debe definir un motivo para rechazar la solución.

Añadir la API de SAP desde la pestaña Soluciones

Una vez seleccionada la biblioteca SAPAPIStore en Soluciones, estará disponible la opción Añadir API. Dicha opción solo se verá si el usuario que ha iniciado sesión tiene el rol Desarrollador de soluciones. Los usuarios autorizados pueden hacer clic en Añadir API para generar el esquema de la API web mediante scripts para cargar/descargar datos de SAP en el esquema JSON.

Añadir API abre un asistente que contiene los tres pasos Información de API, Seleccionar archivos y Seleccionar revisor.

Información de API tiene los siguientes campos:

  1. Nombre: Nombre del servicio o de la solución; debe ser único en el ámbito de la biblioteca.

  2. Categoría: Ayuda a clasificar las soluciones en diferentes categorías, que pueden filtrarse posteriormente mediante filtros en la página Soluciones. La categoría no es un campo obligatorio.

  3. Descripción: El usuario puede utilizarlo para explicar en qué consiste la solución. La descripción no es un campo obligatorio.

Creación de API tiene dos opciones: Crear desde Transaction y Crear desde Query. La opción predeterminada es Crear desde Transaction. Creación de API tiene los siguientes campos:

  1. Seleccionar archivo: Solo se admitirá un script asignado a JSON para generar el esquema de la API. Si el script es de tipo Query, se mostrarán los niveles de uso del sistema (Bajo, Medio y Alto).

  2. Visores: Hay dos visores JSON, Área de texto y Visor JSON; la selección predeterminada es Visor JSON. Ambos visores tienen una anchura y una altura fijas y activan una barra de desplazamiento según el texto JSON.

Es necesario crear un script en Studio para utilizarlo en Evolve. Consulte Crear un script para la integración con la API de datos SAP en API de datos SAP con Studio.

Después de examinar un archivo de script válido desde Seleccionar archivo, la llamada al método de servicio genera las especificaciones de la API y las muestra en el visor JSON. JSON tiene tres pestañas: InputPayload, OutputPayload y ErrorPayload. Las especificaciones de la API para InputPayload y OutputPayload se efectúan de acuerdo con el archivo de script y ErrorPayload es una matriz fija. El tipo de datos correspondiente al tipo de datos del script y las especificaciones de la API estarán disponibles en las cargas útiles generadas.

InputPayload y OutputPayload tienen las siguientes secciones:

  1. RunParameter: Tiene todos los campos de entrada en el caso de Transaction. El script de Query mostrará todos los campos de criterios definidos por el usuario y omitirá los campos de criterios fijos.

  2. SolutionDetail: Tiene los campos SolutionName, LibraryName y AppName.

  3. RequestParameter: Tiene todas las entradas en tiempo de ejecución, es decir, Record Count, GetRecordCount etc.

  4. SAPDetails: Tiene ConnectionName y EvolveUser como campos obligatorios. Los otros campos, como SAPUser, SAPCredentials y WindowsCredentials, son opcionales.

Nota: Guarde las Credenciales de SAP o las Credenciales de Windows en Evolve con el Usuario de Evolve, de modo que la contraseña de texto sin formato no se transmita en la llamada de red mientras se ejecuta la API a través de un cliente de terceros.

La opción Seleccionar revisor aparecerá si la marca Aprobación de la solución en Configuración de aprobación de la API de SAP se ha establecido en True. Tiene un menú desplegable Revisor, que mostrará todos los usuarios que tienen el rol de revisor de soluciones en la aplicación actual. Si el valor de Aprobación automática es False, el usuario que ha iniciado la sesión actualmente no estará visible en el menú desplegable, aunque el usuario actual tenga el rol de revisor de soluciones en la aplicación. La solución no se puede enviar sin seleccionar un revisor.

Tras el envío de la solución, esta aparecerá en la página Soluciones, con las columnas Descripción, Estado, Categoría, Revisado por y Creado por.

La dirección URL de las API de datos SAP será <PrefijoDeRuta>/api/v1/SAPIS.

Nota: Los detalles del esquema de la API se han documentado en la Especificación de la API de datos de SAP.

Si la marca Aprobación de la solución en Configuración de aprobación de la API de SAP se ha establecido en True, la solución debe enviarse por medio de un revisor. Tras presentar la solución, la tarea se asigna al revisor para que la revise. Si está activada la preferencia Motivo del rechazo de la solución, el revisor de la solución debe indicar comentarios sobre el motivo de rechazo. Si se aplica el proceso de workflow de la solución, Actualizar API solo funcionará si la solución está en el estado Producción.

Actualizar la API de SAP desde la pestaña Soluciones

El usuario puede utilizar Actualizar API para la solución que tenga el estado Producción. Si la aprobación de la solución está activada en Configuración de aprobación de la API de SAP (página Aplicación→ Preferencias→ Preferencias de diseño), la solución estará en revisión hasta que el revisor asignado la apruebe. Las soluciones que están en revisión no pueden actualizarse. Después de aprobar la solución y pasarla a producción, el usuario puede actualizar la solución de API de datos SAP. Si la revisión de la solución está desactivada, la solución estará siempre en producción y el usuario podrá editar dicha solución de API de SAP. A continuación, encontrará la información para actualizar la API:

  1. Vaya a Soluciones y seleccione la biblioteca de API de datos SAP.

  2. Seleccione la solución de API de SAP (en producción) que desea actualizar haciendo clic en la casilla situada en la cuadrícula de soluciones.

  3. Haga clic en Actualizar API.

  4. El nombre del servicio o de la solución es de solo lectura. Los campos Categoría y Descripción son editables.

  5. El tipo de script se seleccionará en función del tipo de script existente y las demás opciones se deshabilitarán. La opción Seleccionar archivo permitirá añadir el mismo tipo de script.

  6. La URL del servicio y las vistas JSON (Área de texto y Visor JSON) son de solo lectura.

  7. Estos pasos aparecerán si la marca Aprobación de la solución en Configuración de aprobación de la API de SAP se ha establecido en True. El menú desplegable Revisor mostrará todos los usuarios que tienen el rol de revisor de soluciones en la aplicación actual. Si el revisor de soluciones actual está disponible en la lista de revisores, se seleccionará el mismo revisor.

  8. Si la opción Aprobación automática se ha establecido en False, el usuario que ha iniciado la sesión actualmente no aparecerá en la lista desplegable, aunque tenga el rol de revisor de soluciones en la aplicación. La solución no se puede enviar sin seleccionar un revisor.

  9. Esta acción creará una versión nueva de la solución.

Ver la API de SAP

Para ver la API de SAP, haga clic en la opción Ver API después de seleccionar una solución concreta en la biblioteca de API de SAP. Los datos completos se mostrarán en una sola página, como la vista del esquema de referencia. JSON puede verse en ambos visores JSON, es decir, Área de texto y Visor JSON.

La URL del servicio aparecerá como <URLBase/URLDePuertaDeEnlace>/api/v1/SAPIS.

Ejecutar la API de datos SAP

Para ejecutar la API de integración, el usuario rellenará el encabezado de autenticación y la carga útil, y lo enviará al extremo expuesto válido para su ejecución. Siga estos pasos para ejecutar la API de datos SAP:

  1. Rellene todos los campos de entrada necesarios de la carga útil, como el encabezado de autenticación, SolutionName, LibraryName, AppName, ConnectionName, EvolveUser, etc., antes de la ejecución.

  2. El usuario de Evolve debe tener el rol Originador para la ejecución de la API.

  3. En el caso de Transaction, la solución de API de datos SAP en estado de producción puede ejecutarse en el servidor de producción. Se aplicará la versión más reciente de la solución. La solución de API de datos SAP en estado Revisión o Rechazada puede ejecutarse en un sistema SAP de no producción. La validación se ejecutaría tanto en el sistema SAP de producción como en el de no producción.

    En el caso de Query, la solución de API de SAP en estado de producción puede ejecutarse tanto en servidores de producción como de no producción. Se aplicará la versión más reciente de la solución. La solución de API de SAP en estado Revisión o Rechazada puede ejecutarse en el sistema SAP de no producción.

  4. Se utilizará EvolveUser para verificar el rol y las políticas y para comprobar las credenciales de inicio de sesión con respecto al nombre ConnectionName especificado si no se envían las credenciales de SAP y las credenciales de Windows.

    El criterio de preferencia para ejecutar la solución de API de SAP es el siguiente:

    1. Credenciales de SAP.

    2. Credenciales de Windows.

    3. Usuario de Evolve.

    La preferencia predeterminada es utilizar EvolveUser para evitar el uso de contraseñas de texto sin formato a través de la red.

  5. Después de la ejecución, el resultado de esta (campos de registro y salida) se sobrescribirá en el documento JSON.

  6. Si el historial del documento está habilitado en la biblioteca, los documentos se identificarán de forma exclusiva como NombreDeServicio_MarcaDeTiempo (en números). El documento será un archivo de texto que contiene InputPayload y OutputPayload en formato JSON. Si el usuario indica la contraseña, esta no se guardará en el documento. El documento no tiene ningún proceso de workflow, por lo que el estado será siempre Completado.

Para ver el uso de API, seleccione cualquier solución en la biblioteca de soluciones y haga clic en Uso de API. La vista Uso de API tiene las columnas Título, Archivo de datos, Fecha y hora de la actividad, Sistema SAP, Registros cargados y Errores de ejecución que muestran información detallada de la ejecución de la API.

Para Importar o exportar la solución de API de integración, vaya a la solución (es decir, a la prueba) y descargue el script; ahora puede añadir una solución nueva mediante el script descargado.