Los servicios de integración disponibles a través del School Service Bus, permiten a aplicaciones de terceros interactuar con las herramientas administrativas de BDC. Actualmente los siguientes sistemas intercambian datos de las entidades Colegio, Colegio-Nivel, Artículos y Contratos con BDC:
- CRM - Microsoft Dynamics
- ERP - EMS, SAP y Navision
- Sistemas Legacy - PRSAC
REQUISITOS PREVIOS
Para hacer uso de los servicios, se deben seguir estos pasos:
- Solicitar al Equipo School Service Bus un usuario SSB para hacer uso de Microservicios.
- En caso de ser integración desde CRM-Dynamics, solicitar al Equipo de Base de Datos Central activación de parámetro CRM indicando país - empresa.
- Solicitar al Equipo de Base de Dato Central los maestros (catálogos) de ambiente pre-producción y producción para poder hacer uso de los servicios con datos de BDC.
Catálogos necesarios para uso de Microservicios :
Por país | Por empresa |
---|---|
nivel | agrupa_articulo |
estado | categoria |
municipio | ciclo_escolar |
empresa | grado |
idioma | materia |
nivel | nivel_precio |
zona_horaria | opcion_venta |
periodo_ciclo | |
plazo | |
razon | |
tipo_articulo | |
tipo_material | |
tipo_venta | |
turno |
USO DE LOS SERVICIOS
Una vez que se cuenta con los catálogos necesarios, es posible proceder a la creación de un colegio y/o institución, el cual se lleva a cabo por medio del servicio School; éste cuenta con un llamado POST y un llamado PUT.
Alta de Colegio
Cuando se hace referencia en los servicios a un catálogo, se usan dos tag's para identificar el dato: id y clave, sólo uno de estos datos será obligatorio para la búsqueda en BDC.
La entidad Colegio es considerada única en BBDD por los siguientes campos: colegio_id, colegio_clave, crm_id y erp_id (sap_id); tanto en la creación como en la modificación estos datos son considerados para evitar duplicidad.
- colegio_id: En un llamado POST el dato deberá ir en 0, cómo respuesta tendremos su ID correspondiente en BDC el cual deberá sustituir al 0 en un llamado PUT.
- colegio_clave: Identificador único el cual deberá tener una longitud de 50 caracteres como máximo, este será definido por el negocio. Para integraciones CRM el valor de clave = colegio_id que le correspondió en BDC.
- crm_id: Aunque no es un campo obligatorio se sugiere que para integraciones con CRM se mande la información ya que es un identificador único en su sistema.
- erp_id: Este campo es obligatorio cuando existe alguna interfaz que envíe datos a cualquiera de los ERP's del Grupo, puede ser SAP, EMS, Navision. Es posible utilizar este tag para almacenamiento y tener el id único de su base de datos.
Proceso | Servicio | Tipo de llamado | Campos de búsqueda | Campos de datos únicos |
---|---|---|---|---|
Creación de colegio | School | POST | colegio_id; colegio_clave | colegio_id (automático asignado por sistema), colegio_clave, crm_id, erp_id (sap_id). |
Descripción de campos: | ||||
Campo | Tipo | Longitud | Valor por defecto | Observaciones |
colegio_id | int | 11 | 0 | colegio_id Ej. 8125 |
colegio_clave | varchar | 50 | Definido por negocio | En la integración con CRM este valor es el mismo que el colegio_id |
crm_id | varchar | 100 | El id registrado en CRM | El mismo |
erp_id | varchar | 20 | Valor correspondiente a la entidad en el ERP | Sólo es obligatorio en el caso de que exista alguna interfaz hacia el ERP |
Actualización de Colegio
Campos editables en un llamado PUT:
- colegio_clave : Para integraciones CRM no aplica ya que esta actualización es automática y coloca el colegio_id que corrrespondió en BDC.
- colegio : El nombre del colegio.
- colegio_orden: Este dato se utiliza en reportes para realizar un ordenamiento.
- alias: En caso de tener un nombre corto para el colegio.
- demo: El colegio podrá pasar de ser real a demo o viceversa.
- baja: La baja del colegio sólo se dará al contener una razon_baja.
- erp_id (sap_id): Actualiza sólo si viene información en el tag, de venir en blanco deja el campo tal y como está.
- crm_id : Actualiza sólo si viene algo en el tag, de venir en blanco deja el campo tal y como está.
- Embajador: Actualiza en contrato.
Proceso | Servicio | Tipo de llamado | Campos de búsqueda | Campos de datos únicos |
---|---|---|---|---|
Actualización/edición de un colegio | School | PUT | colegio_id; colegio_clave | colegio_id (automático asignado por sistema), colegio_clave, crm_id, erp_id (sap_id). |
Descripción de campos | ||||
Campo | Tipo | Longitud | Valor por defecto | Observaciones |
colegio_clave | varchar | 50 | Definido por negocio | En el caso de interfaz desde CRM, si no se informa, se toma el id del colegio |
colegio | varchar | 255 | Definido por negocio | |
colegio_orden | int | 11 | 0 | Cuando se necesita una ordenación especial en informes o vistas |
alias | varchar | 255 | Definido por negocio | Si se requiere un nombre diferente al oficial, se usa este campo |
demo | int | 11 | 0 | Se activa cuando el colegio es únicamente para demostración o pruebas |
baja | int | 11 | 0 | Cuando un colegio ya no es parte del programa, se da de baja, acompañado de una razón de baja |
erp_id | varchar | 20 | NULL | Código asociado al colegio en el ERP (cuando proceda) |
crm_id | varchar | 100 | NULL | Código asociado al colegio en el CRM (cuando corresponda) |
embajador |
Una vez que se obtiene el ID del colegio es necesario realizar la creación de niveles, ya que sin niveles el colegio no estará visible para ninguna plataforma administrativa.
La entidad Colegio Nivel Ciclo es considerada única en BBDD por los siguientes campos: colegio_nivel_ciclo_id, clave, crm_id y erp_id (sap_id) tanto en la creación cómo en la modificación estos datos son considerados para una búsqueda de duplicidad.El servicio collegeLevelCycle cuenta con un llamado POST Y PUT.
- colegio_nivel_ciclo_id: En un POST el dato deberá ir en 0, cómo respuesta tendremos su ID correspondiente en BDC el cual deberá sustituir al 0 en un llamado PUT.
- clave: Identificador único el cual deberá tener una longitud de 50 caracteres como máximo, este será definido por el negocio.
- crm_id: Aunque no es un campo obligatorio se sugiere que para integraciones con CRM se mande la información ya que es un identificador único del nivel en su sistema .
- erp_id: Este campo no es obligatorio sin embargo si se cuenta con la información del id del sistema que se integra ya sea ERP, SAP es posible utilizar este tag para almacenamiento y tener el id único del nivel de su base de datos.
Campos editables en un llamado PUT:
- erp_id (sap_id): Actualiza sólo si viene información en el tag, de venir en blanco deja el campo tal y como está.
- crm_id : Actualiza sólo si viene algo en el tag, de venir en blanco deja el campo tal y como está.
- clave_oficial: Identificador Oficial del nivel
- fecha_adopcion: Fecha en la que se agrega el nivel al colegio.
- observaciones: Este campo puede ser utilizado para información adicional del nivel.
- activo: Estatus del nivel.
- idioma y zona_horaria.
- baja: La baja del colegio sólo se dará al contener una razon_baja.
Para poder llevar acabo el contrato de un colegio se deberá realizar previo el alta de artículos en BDC.
El servicio articuloGradoPeriodoPrecio permite dar de alta y clasificar Artículos de acuerdo a la necesidad del negocio este servicio cuenta con llamado POST Y PUT.Un artículo es considerado único en BBDD por los siguientes campos: articulo_id, articulo_clave_clave y erp_id (sap_id) tanto en la creación cómo en la modificación estos datos son considerados para una búsqueda del artículo.
- articulo_id: En un POST el dato deberá ir en 0, cómo respuesta tendremos su ID correspondiente en BDC el cual deberá sustituir al 0 en un llamado PUT.
- articulo_clave: Identificador único el cual deberá tener una longitud de 50 caracteres como máximo, este será definido por el negocio.
- erp_id: Este campo no es obligatorio sin embargo si se cuenta con la información del id del sistema que se integra ya sea ERP, SAP es posible utilizar este tag para almacenamiento y tener el id único del nivel de su base de datos.
Para aquellos artículos que serán agrupadores de paquetes por grado deberán de enviar como parametro y tipo_articulo_parametro SUBP-G; aunque no es un elemento obligatorio debe ser informado para ser utilizado como un agrupador.
En caso de ser necesario para el negocio este servicio realiza configuración de lista de precios y configuración del articulo por grado y periodo esto para una configuración base tomada en cuenta para contratos.
Una vez cargado el catálogo de artículos y su clasificación será posible llevar acabo la creación del contrato por colegio en el servicio contract el cual cuenta con llamado POST Y PUT. El contrato es considerado único en BBDD por los siguientes campos: contrato_id, colegio_id, empresa_id y ciclo_escolar_id tanto en la creación cómo en la modificación estos datos son considerados para una búsqueda de un contrato que aún no esté liberado o validado; si el contrato ya cuenta con este estatus ya no podrá ser modificado y no podrá insertar un registro nuevo con los mismos datos.
El contrato nos permite realizar la configuración de subprogramas contratados en el colegio por nivel-grado, e incluso si el negocio lo necesita se configura los componentes de estos subprogramas para que sean visulizados en Acuerdos.
Campos editables en un llamado PUT:
- Contactos : Embajador, Contacto TI, Contacto Académico, CTU y Vendedor.
- generacion_parametro y gana_pierde_parametro: Parametrós usados para colegios que vienen de APS.
- fecha_entrega
- tipo_bonificacion: En caso que el negocio necesite la información sólo se tienen dos valores posibles Efectivo y Equipamiento.
- observaciones
- preferencia: tipo, paga_colegio, paga_distribuidor,tipo_venta_clave,plazo_clave
- alumno
- aula
- Material contratado
La configuración de la Grade es la selección de cada uno de los títulos (módulos) que el colegio ha contratado. Esto permite que el LMS/CMS puedan filtrar el contenido asociado a cada una de las materias en cada uno de los grados. Esta configuración se lleva acabo por medio del servicio colegioArticuloGradoMateria que cuenta con un llamado POST; adicional a la configuración de grade esta información es además usada también para el armado de kit's, pedidos y pagos.
- sincroniza_articulo_materia: Bit que nos permite verificar la configuración del contrato con la configuración de la grade en caso de faltar información en la grade esta es adicionada si el valor es 1.
- articulo_erp_id: Para Colombia este campo será obligatorio ya que realizará la busqueda por codigo erp_id
- periodo_ciclo_config: Al colocar el tag será un indicativo para eliminar componentes del periodo_ciclo este se coloca dentro del artículo SUBP.
Existen tres servicios de consulta que nos apoyarán a tener la información ya antes configurada:
Contracts: Listado de contratos modificados tomando en cuenta un criterios de fechas.
Bonus: Listado con el detalle de las bonificaciones a partir de la fecha pasada como parámetro hasta el día anterior al que se realiza la petición.
Census: Listado de la cantidad de alumnos por Ciclo Escolar, Colegio, Nivel, Grado, Grupo y Material Contratado (Paquete), se reciban dichos datos de acuerdo a los parámetros especificados.
FLUJO DE INFORMACIÓN
EJEMPLOS DE USO
Microservicio | Respuesta |
---|---|
ANEXOS
Carga de Catálogos : Catalogos_ BDC.xls
Mapeo BDC: MapeoInterfaceBDC.xls
Código de errores: codigo_errores_ws.xls