EDITRAN/API. Manual de referencia. API para aplicaciones. Windows/Unix

Transcripción

1 EDITRAN/API API para aplicaciones Windows/Unix Manual de referencia INDRA 11 de mayo de 2018

2 ÍNDICE 1. INTRODUCCION SOLICITUD DE SERVICIO FUNCION EDItranG_Req Conversión a texto de los códigos de retorno Función GetErrorText Función GetErrText Función EDItranIsAlive Variable de entorno EJEMPLO DE PROGRAMACIÓN Entorno C, C++: Entorno Visual Basic COMPONENTES DE LA API INDRA. Todos los derechos reservados. EDITRAN/API

3 1.INTRODUCCION. 1. INTRODUCCION. El interfaz de programación de aplicaciones basadas en el módulo de EDItran/G, de la plataforma de comunicaciones de Indra, permite a los desarrolladores de aplicaciones usuarias acceder a todos los servicios que la plataforma proporciona. Esta API incorpora la misma funcionalidad que se ofrece desde el menú de operador de EDItran/G, pudiéndose sustituir de esta manera la actuación manual por un programa de aplicación. INDRA. Todos los derechos reservados. EDITRAN/API Pág. 1-1

4 2.SOLICITUD DE SERVICIO. 2. SOLICITUD DE SERVICIO FUNCION EDItranG_Req Declaración de la función en C, C++ int EDItranG_Req (char *Request, char *Presentación, int bwait, int bverbose); Declaración de la función en Visual Basic Declare Function EDItranG_Req Lib "libedi_g" Alias (ByVal txtrequest As String, ByVal txtpresentation As String, ByVal bwait As Long, ByVal bverbose As Long) As Long Descripción Realiza la petición a EDItran/G para la presentación dada y espera el resultado de dicha petición si bwait es distinto de cero. Parámetros Request - Operación a realizar. INITE_EDITRANG_REQ LOADE_EDITRANG_REQ SEND_EDITRANG_REQ SENDD_EDITRANG_REQ ENDE_EDITRANG_REQ INITR_EDITRANG_REQ UNLOADR_EDITRANG_REQ RECV_EDITRANG_REQ ENDR_EDITRANG_REQ Procesar emisión Cargar emisión Emitir Emitir (dinámica) Finalizar emisión Inicializar recepción Descargar recepción Recibir Finalizar recepción Presentación - identificador de la presentación sobre la que realizar la petición. bwait - Esperar respuesta. bverbose - Modo verboso. Valores de retorno IGAMSG_NO_ERROR_RC Resultado correcto SCRIPT_OPEN_ERROR_RC Error al abrir script SCRIPT_CLOSE_ERROR_RC Error al cerrar script SCRIPT_READ_ERROR_RC Error al leer script SCRIPT_WRITE_ERROR_RC Error al escribir script SCRIPT_EXEC_ERROR_RC Error al ejecutar script IGAMSG_SNTX_ERROR_RC Sintaxis incorrecta IGAMSG_INIT_ERROR_RC Sistema EDItran/G no iniciado IGAMSG_SEND_ERROR_RC Error al comunicar con EDItran/G (send) IGAMSG_RECV_ERROR_RC Error al comunicar de EDItran/G (receive) NO_ERROR_RC Resultado correcto OPEN_IN_ERROR_RC Error al abrir fichero de aplicación origen OPEN_OUT_ERROR_RC Error al abrir fichero de aplicación destino READ_CTRL_ERROR_RC Error al leer control en TAMPON o CSB WRITE_CTRL_ERROR_RC Error al escribir control en TAMPON o CSB WRITE_DATA_ERROR_RC Error al escribir datos en TAMPON o CSB ZERO_REC_ERROR_RC Fichero tampón sin registros cargados ALLOC_ERROR_RC Error al solicitar memoria OPEN_REL_ERROR_RC Error al abrir fichero de relación WRITE_REL_ERROR_RC Error al escribir fichero de relación WRITE_OUT_ERROR_RC Error al escribir fichero de aplicación SEQUENCE_ERROR_RC Error de secuencia en CSB TOTALFILES_ERROR_RC Error en el numero total de ficheros en CSB TIPOFICH_ERROR_RC Formato de fichero desconocido LONGREG_ERROR_RC Error en la longitud de ficheros en CSB SECFILE_ERROR_RC Error de secuencia de registros en la descarga TOTALREGFILE_ERROR_RC Error en numero total de registros en fichero aplicación TOTALAPLICREGS_ERROR_RC Error en el numero total de registros de ficheros en CSB TOTALBYTES_ERROR_RC Error en el total de bytes del fichero de aplicación TOTALSYNCS_ERROR_RC Error en el numero total de sincronismos en CSB CONFIGLEN_ERROR_RC Fichero con registro menor que dado en perfil INDRA. Todos los derechos reservados. EDITRAN/API Pág. 2-1

5 2.SOLICITUD DE SERVICIO. READ_DATA_ERROR_RC Error de lectura de fichero TAMPON OPEN_STATUS_ERROR_RC Error al abrir fichero de estados OPEN_CSB_ERROR_RC Error al abrir fichero CSB ERROR_NO_PERFIL_LOCAL No existe perfil local de EDITRAN/G ERROR_NO_PERFIL_SESION No existe perfil de la presentación ERROR_CONVERSOR Error de conversión ERROR_CARGADOR Error de carga TMPS_UNCOMPLETED_RC No existe tampón recibido completo NO_FILES_TO_CONVERT No hay ficheros de aplicación para convertir ERROR_USER_SCRIPT Error al ejecutar script de usuario PENDING_ERROR_RC Hay pendiente una petición previa I_OFFSET Offset de los códigos de excepción I_Aborto Recibido aborto I_Operador Operador I_Tampon_remoto_incorr_lanza_previo Tampon_remoto_incorr_lanza_previo I_Tampon_remoto_incorr_no_existe_previo Tampon_remoto_incorr_no_existe_previo I_Tampon_remoto_incorr_posible_previo Tampon_remoto_incorr_posible_previo I_Tampon_remoto_incorr_numero_sesion Tampon_remoto_incorr_numero_sesion I_Tampon_remoto_incorr_reg_totales Tampon_remoto_incorr_reg_totales I_Liberacion Liberación I_Exceso_reintentos_emitir Exceso reintentos para emitir I_SBR_Descuadre_totales Descuadre de totales I_Exceso_reintentos_sincronismo Exceso reintentos de sincronismo I_Exceso_reintentos_fin_emision Exceso reintentos de fin de emisión I_Perfiles Perfiles I_Fichero_no_preparado Fichero no preparado 2.2. Conversión a texto de los códigos de retorno Función GetErrorText char *GetErrorText (int Error); Descripción Transforma los códigos de retorno de EDItranG_Req en texto. La función GetErrorText es adecuada para usarla en entornos de programación C, C Función GetErrText - Declaración de la función en C, C++: void GetErrText (int nerror, char *szerror); - Declaración de la función en Visual Basic: Declare Sub GetErrText Lib "libedi_g" Alias "_GetErrText@8" (ByVal nerror As Long, ByVal strerror As String) Descripción Transforma los códigos de retorno de EDItranG_Req en texto. La función GetErrText es adecuada tanto para usarla junto a programas C o C++ u otros lenguajes de programación de Windows como Visual Basic Función EDItranIsAlive - Declaración de la función en C, C++: int EDItranIsAlive (void); INDRA. Todos los derechos reservados. EDITRAN/API Pág. 2-2

6 2.SOLICITUD DE SERVICIO. Descripción Indica el estado del sistema EDItran. La función devuelve 0 si el sistema está inactivo y 1 si está listo para recibir peticiones Variable de entorno. EDITRAN_INSTALL_DIR Opcionalmente indica a la API de EDItran/G el directorio donde se encuentra la instalación EDItran. Esto permite que las aplicaciones que hacen uso de dicha API sean invocadas desde cualquier directorio. INDRA. Todos los derechos reservados. EDITRAN/API Pág. 2-3

7 3.EJEMPLO DE PROGRAMACIÓN. 3. EJEMPLO DE PROGRAMACIÓN Entorno C, C++: /***************************************************************************** * * Departamento : Soluciones de comunicaciones * * (C) INDRA SSI, S.A Noviembre, * * <ejemplo.c> ****************************************************************************/ System includes #include <stdio.h> #include <stdlib.h> #include <stdarg.h> #include <ctype.h> #include <signal.h> #include <string.h> #if defined(dos) #include <direct.h> #elif defined(os2) #include <direct.h> #define INCL_DOSPROCESS #include <os2.h> #else int chdir (const char *path); #endif #define SLASH '\\' #define TRUE 1 #define IGAMSG_SNTX_ERROR_RC 101 #define IGAMSG_NO_ERROR_RC 100 Projetc includes #include "api.h" Typedefs /* Program options */ typedef struct { char presentacion[100]; /* Presentacion */ char operacion[100]; /* Operacion */ int bwait; /* Opcion espera */ int bverbose; /* Opcion verboso */ opts_t; Global variables static char *ProgName; static char IgaMsgVersion[] = "1.0"; usage void usage (char *format,...) { va_list ap; va_start (ap, format); fprintf (stderr, "%s: ", ProgName); INDRA. Todos los derechos reservados. EDITRAN/API Pág. 3-1

8 3.EJEMPLO DE PROGRAMACIÓN. vfprintf (stderr, format, ap); fprintf (stderr, "\n\n%s. Peticionario de EDItran/G en modo comando.\n", ProgName); Copyright (IgaMsgVersion); fprintf (stderr, "\nuso : %s -o <operacion> -p <presentacion> [-v] [-w]\n",progname); fprintf (stderr, "Siendo :\n"); fprintf (stderr, " -o <operacion> : Operacion a realizar.\n"); fprintf (stderr, " InitE - Inicializar emision\n"); fprintf (stderr, " LoadE - Cargar emision\n"); fprintf (stderr, " Send - Emitir\n"); fprintf (stderr, " SendD - Emitir dinamica\n"); fprintf (stderr, " EndE - Interrumpir emision\n"); fprintf (stderr, " InitR - Inicializar recepcion\n"); fprintf (stderr, " UnloadR - Descargar recepcion\n"); fprintf (stderr, " Recv - Recibir.\n"); fprintf (stderr, " EndR - Interrumpir recepcion.\n"); fprintf (stderr, " -p <presentacion#> : Identificador de la presentacion.\n"); fprintf (stderr, " -v : Modo verboso.\n"); #if!defined(dos) fprintf (stderr, " -w : Espera finalizacion de la peticion.\n"); #endif fflush (stderr); exit (IGAMSG_SNTX_ERROR_RC); quit void quit (int code) { printf ("Received signal %d\n", code); exit (code); main int main (int argc, char *argv[]) { opts_t opts; char *BaseDir, *pstr; int result = IGAMSG_NO_ERROR_RC; if ((ProgName = (char *) strrchr (argv[0], SLASH)) == NULL) ProgName = argv[0]; else ++ProgName; BaseDir = (char *) strrchr (argv[0], '/'); if (BaseDir!= NULL) { *BaseDir = '\0'; if (chdir (argv[0]) < 0) usage ("%s: directorio invalido", argv[0]); /*****************************************************/ /* Obtencion de opciones */ /*****************************************************/ argv++; argc++; memset (&opts, 0, sizeof (opts)); while (*argv) { pstr = *argv; if (*pstr == '-') { /* it's an option */ pstr++; switch (tolower (*pstr)) { INDRA. Todos los derechos reservados. EDITRAN/API Pág. 3-2

9 3.EJEMPLO DE PROGRAMACIÓN. case 'p': /* presentacion */ argv++; if (*argv) { pstr = *argv; strcpy (opts.presentacion, pstr); else { usage ("Error - falta presentacion"); return (IGAMSG_SNTX_ERROR_RC); break; case 'o': /* operacion */ argv++; if (*argv) { pstr = *argv; strcpy (opts.operacion, pstr); else { usage ("Error - falta operacion"); return (IGAMSG_SNTX_ERROR_RC); break; case 'v': /* verbose */ opts.bverbose = TRUE; break; case 'w': /* wait */ #if!defined(dos) opts.bwait = TRUE; #endif break; default: usage ("Opcion ilegal -- %c", tolower (*pstr)); return (IGAMSG_SNTX_ERROR_RC); argv++; /*****************************************************/ /* Validacion de opciones */ /*****************************************************/ if (!*opts.operacion) { usage ("Error - falta operacion"); return (IGAMSG_SNTX_ERROR_RC); if (!*opts.presentacion) { usage ("Error - falta presentacion"); return (IGAMSG_SNTX_ERROR_RC); /*****************************************************/ /* Realiza la peticion */ /*****************************************************/ result = EDItranG_Req (opts.operacion, opts.presentacion, opts.bwait, opts.bverbose); return (result); 3.2. Entorno Visual Basic Ediapi.frm Private Sub btnejecutar_click() Dim nret As Integer Dim strerror As String Dim txtrequest as String Dim txtpresentation as String Dim lwait as Long Dim lverbose as Long INDRA. Todos los derechos reservados. EDITRAN/API Pág. 3-3

10 3.EJEMPLO DE PROGRAMACIÓN. 'Reservo memoria y asigno variables strerror = Space(500) txtrequest = InitE txtpresentation = Presentacion01 lwait = 1 lverbose =1 'LLamada a la función de la DLL nret = EDItranG_Req(txtRequest, txtpresentation, lwait, lverbose) 'Reemplazo el codigo de error por un texto mediante otra llamada a la DLL GetErrText nret, strerror MsgBox ("Retorno: " & nret & ". " & strerror) End Sub Module1.bas Attribute VB_Name = "Module1" ' Declaraciónes globales de las funciones de la DLL Declare Function EDItranG_Req Lib "libedi_g" Alias "_EDItranG_Req@16" (ByVal txtrequest As String, ByVal txtpresentation As String, ByVal bwait As Long, ByVal bverbose As Long) As Long Declare Sub GetErrText Lib "libedi_g" Alias "_GetErrText@8" (ByVal nerror As Long, ByVal strerror As String) INDRA. Todos los derechos reservados. EDITRAN/API Pág. 3-4

11 4.COMPONENTES DE LA API. 4. COMPONENTES DE LA API. libedi_g Librería con los componentes de la API de EDItran/G api.h Fichero de definición de la API. libmisc Librería con componentes comunes. liblic Librería de control de licencia. libdes Librería con componentes criptográficos. export.h Fichero de definiciones para la exportación de símbolos. cc_depen.h Fichero de definiciones dependientes. ejemplo.c Ejemplo INDRA. Todos los derechos reservados. EDITRAN/API Pág. 4-1

12 Centros de Competencia ecommerce Avda. de Bruselas Alcobendas. Madrid, España T T INDRA. Todos los derechos reservados. EDITRAN/API Pág. 4-1