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

Status
subtle true
colour Blue
title 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 :

...

Status

subtle	true
colour	Blue
title	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 o la modificación de una entidad existente; estos procesos se llevan a cabo por medio del servicio School, el cual 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.

...

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.

...

Una vez creado el colegio y se obtiene su ID, es necesario realizar la creación de los niveles escolares que contendrá el colegio. Sin niveles, el colegio no estará visible para ninguna plataforma administrativa. Cada país tiene su propia estructura de niveles escolares, y éstos son válidos para todas las empresas que se creen en cada país.

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 como en la modificación, estos datos son considerados para una búsqueda de duplicidad. El servicio collegeLevelCycle cuenta con un llamado POST y un llamado PUT.

colegio_nivel_ciclo_id: En un llamado tipo POST, este dato deberá ir en 0. Como 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 crear el contrato de un colegio, primero se deberá realizar 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 puede ser llamado por el método POST y PUT. Un artículo es considerado único en BBDD por los siguientes campos: articulo_id, articulo_clave y erp_id (sap_id); tanto en la creación como en la modificación, estos datos son considerados para la búsqueda del artículo.

articulo_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.
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 existe integración hacia alguno de los ERP's del grupo (SAP, NAVISION, EMS), este dato es el que identifica al artículo en el ERP unívocamente.

Los artículos que funcionan como agrupadores de paquetes por grado, deberán de enviar como parametro y tipo_articulo_parametro SUBP-G; este dato debe ser informado para ser utilizado como un agrupador.

...

Con este servicio se realiza la configuración de la lista de precios y la configuración del articulo por grado y periodo. Esta configuración se toma como base para la selección de artículos por Nivel y Grado en los contratos.

Una vez cargado el catálogo de artículos y su clasificación será posible realizar la creación del contrato del colegio, a través del servicio contract. Al igual que los demás servicios, éste cuenta con llamados 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:

...

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 parámetro hasta el día anterior al que se realiza la petició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 parámetros especificados.

Status
colour Blue
title FLUJO DE INFORMACIÓN

Image Removed

Status

colour	Blue
title	EJEMPLOS DE USO

...

Code Block

language	xml
title	school
collapse	true

<colegio_im xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Colegio>
        <colegio_id>0</colegio_id>
        <colegio_clave>INST.CO</colegio_clave>
        <colegio>INSTITUTO COLOMBIA</colegio>
        <colegio_orden>10</colegio_orden>
        <erp_id>123456789</erp_id>
        <crm_id>123456789-1245-1245-1245-123456789</crm_id>
        <pais_id>62</pais_id>
        <nombre_oficial>INSTITUTO COLOMBIA A.C.</nombre_oficial>
        <apellido_paterno></apellido_paterno>
        <apellido_materno></apellido_materno>
        <sexo>X</sexo>
        <alias></alias>
        <id_fiscal>IEM051207F82E</id_fiscal>
        <id_oficial></id_oficial>
        <telefono_1>314 333 1930</telefono_1>
        <telefono_2></telefono_2>
        <telefono_3></telefono_3>
        <email>instituto_colombia@hotmail.com</email>
        <pagina_web></pagina_web>
        <zona_horaria_id>24</zona_horaria_id>
        <idioma_id>16</idioma_id>
        <demo>0</demo>
        <baja>0</baja>
        <razon_baja_parametro>0</razon_baja_parametro>
        <embajador>LORENA</embajador>
        <embajador_apellido_paterno>RAMIREZ</embajador_apellido_paterno>
        <embajador_apellido_materno>MORAN</embajador_apellido_materno>
        <embajador_email>lorenamoran@hotmail.com</embajador_email>
        <embajador_telefono>314193045</embajador_telefono>
        <Domicilios>
            <Domicilio>
                <domicilio_id>0</domicilio_id>
                <erp_id></erp_id>
                <crm_id></crm_id>
                <principal>1</principal>
                <fiscal>0</fiscal>
                <entrega>0</entrega>
                <calle>SERRATOS</calle>
                <numero_exterior>11</numero_exterior>
                <numero_interior></numero_interior>
                <colonia>SALAHUA</colonia>
                <ciudad></ciudad>
                <codigo_postal>28867</codigo_postal>
                <municipio_id>0</municipio_id>
                <municipio_clave>91540</municipio_clave>                
                <contacto>LORENA RAMIREZ MORAN</contacto>
                <telefono_1>314 333 456</telefono_1>
                <telefono_2></telefono_2>
                <cargo>Contacto principal</cargo>
                <horario_atencion></horario_atencion>
                <email>lorenamran@hotmail.com</email>
                <zona_horaria_id>24</zona_horaria_id>
                <idioma_id>16</idioma_id>
                <activo>1</activo>
            </Domicilio>
            <Domicilio>
                <domicilio_id>0</domicilio_id>
                <erp_id></erp_id>
                <crm_id></crm_id>
                <principal>1</principal>
                <fiscal>0</fiscal>
                <entrega>0</entrega>
                <calle>SERRATOS</calle>
                <numero_exterior>11</numero_exterior>
                <numero_interior></numero_interior>
                <colonia>SALAHUA</colonia>
                <ciudad></ciudad>
                <codigo_postal>28867</codigo_postal>
                <municipio_id>0</municipio_id>
                <municipio_clave>91540</municipio_clave>                
                <contacto>LORENA RAMIREZ MORAN</contacto>
                <telefono_1>314 333 456</telefono_1>
                <telefono_2></telefono_2>
                <cargo>Contacto principal</cargo>
                <horario_atencion></horario_atencion>
                <email>lorenamran@hotmail.com</email>
                <zona_horaria_id>24</zona_horaria_id>
                <idioma_id>16</idioma_id>
                <activo>1</activo>
            </Domicilio>
            <Domicilio>
                <domicilio_id>0</domicilio_id>
                <erp_id></erp_id>
                <crm_id></crm_id>
                <principal>1</principal>
                <fiscal>0</fiscal>
                <entrega>0</entrega>
                <calle>SERRATOS</calle>
                <numero_exterior>11</numero_exterior>
                <numero_interior></numero_interior>
                <colonia>SALAHUA</colonia>
                <ciudad></ciudad>
                <codigo_postal>28867</codigo_postal>
                <municipio_id>0</municipio_id>
                <municipio_clave>91540</municipio_clave>                
                <contacto>LORENA RAMIREZ MORAN</contacto>
                <telefono_1>314 333 456</telefono_1>
                <telefono_2></telefono_2>
                <cargo>Contacto principal</cargo>
                <horario_atencion></horario_atencion>
                <email>lorenamran@hotmail.com</email>
                <zona_horaria_id>24</zona_horaria_id>
                <idioma_id>16</idioma_id>
                <activo>1</activo>
            </Domicilio>
        </Domicilios>
    </Colegio>
</colegio_im>

Code Block

language	xml
title	colegio_im
collapse	true

<colegio_im_resultado xmlns="http://www.sistemauno.com/source/xml">
<OK>
<colegio_id>7872</colegio_id>
<erp_id>123456789</erp_id>
<crm_id>123456789-1245-1245-1245-123456789</crm_id>
<ok_text>Transacción exitosa: i</ok_text>
</OK>
</colegio_im_resultado>

...

language	xml
title	collegeLevelCycle
collapse	true

Code Block

language	xml
title	colegio_nivel_ciclo_im
collapse	true

<colegio_nivel_ciclo_im_resultado xmlns="http://www.sistemauno.com/source/xml"><OK><colegio_nivel_ciclo_id>56156</colegio_nivel_ciclo_id><colegio_id>7872</colegio_id><erp_id/><crm_id>134-1234567</crm_id><empresa_id>10</empresa_id><nivel_id>21</nivel_id><ciclo_escolar_id>63</ciclo_escolar_id><ok_text>Transacción exitosa: i (0 cambios)</ok_text><login>INST.CO-K</login></OK></colegio_nivel_ciclo_im_resultado>

Code Block

language	xml
title	articuloGradoPeriodoPrecio
collapse	true

<articulo_grado_periodo_precio_im  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<Articulo>
		<articulo_id></articulo_id>
		<empresa_id>6</empresa_id>
		<pais_id>165</pais_id>
		<articulo_clave>COSCPL01</articulo_clave>
		<articulo>COMPARTIR PACK PLUS</articulo>
        <articulo_abrev>PCOMPARTIR PACK PLUS</articulo_abrev>
		<articulo_alterno>SAN COMPARTIR PACK PLUS</articulo_alterno>
		<articulo_orden>100</articulo_orden>
		<erp_id></erp_id>
		<ean></ean>
		<isbn></isbn>
		<ean_alterno></ean_alterno>
		<materia_clave>Esp</materia_clave>
		<categoria_parametro>AL</categoria_parametro>
		<tipo_articulo_parametro>SUBP-G</tipo_articulo_parametro>
		<agrupa_articulo_parametro></agrupa_articulo_parametro>
		<parametro>SUBP-G</parametro>
		<articulo_grado_periodos>
			<articulo_grado_periodo>
				<articulo_grado_periodo_id></articulo_grado_periodo_id>
				<grado_id>39</grado_id>
				<grado_clave>05</grado_clave>
				<grado_erp></grado_erp>
				<nivel_clave>001</nivel_clave>
				<nivel_erp></nivel_erp>
				<ciclo_escolar_id>63</ciclo_escolar_id>
				<ciclo_escolar_clave>A-2017</ciclo_escolar_clave>
				<periodo_ciclo_id>905</periodo_ciclo_id>
				<periodo_ciclo_clave>A-2017.ANUAL</periodo_ciclo_clave>
				<periodo_ciclo_parametro></periodo_ciclo_parametro>
				<activo>1</activo>
				<colegio_id></colegio_id>
				<colegio_clave></colegio_clave>
				<colegio_erp_id></colegio_erp_id>
				<colegio_crm_id></colegio_crm_id>
			</articulo_grado_periodo>
		</articulo_grado_periodos>
		<articulo_nivel_precios>
			<articulo_nivel_precio>
				<articulo_nivel_precio_id></articulo_nivel_precio_id>
				<nivel_precio_id>68</nivel_precio_id>
				<nivel_precio_clave>PVP2017</nivel_precio_clave>
				<colegio_nivel_ciclo_id></colegio_nivel_ciclo_id>
				<colegio_grado_grupo_id></colegio_grado_grupo_id>
				<precio>2559.7330</precio>
				<impuesto_porcentaje></impuesto_porcentaje>
			</articulo_nivel_precio>
		</articulo_nivel_precios>
	</Articulo>
</articulo_grado_periodo_precio_im>

Code Block

language	xml
title	articulo_im
collapse	true

<articulo_im_resultado xmlns="http://www.sistemauno.com/source/xml"><OK><articulo_id>32803</articulo_id><erp_id/><empresa_id/><ok_text>Transacción exitosa: i</ok_text></OK></articulo_im_resultado>

Code Block

language	xml
title	contract
collapse	true

<contrato_im xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Contrato>
<contrato_id>0</contrato_id>
<colegio_clave>INST.CO</colegio_clave>
<empresa_id>10</empresa_id>
<ciclo_escolar_id>63</ciclo_escolar_id>
<Representante_legal>
      <nombre>Lorena</nombre>
      <apellido_paterno>Mora</apellido_paterno>
      <apellido_materno/>
      <sexo>F</sexo>
      <id_fiscal/>
      <id_oficial/>
      <telefono_1>123456789</telefono_1>
      <email>lorenamora@gmail.com</email>
      <idioma_id>16</idioma_id>
      <zona_horaria_id>24</zona_horaria_id>   
</Representante_legal>     
<Contacto_ti>
      <nombre>Javier</nombre>
      <apellido_paterno>Ramos</apellido_paterno>
      <apellido_materno/>
      <sexo>M</sexo>
      <id_fiscal/>
      <id_oficial/>
      <telefono_1/></telefono_1>
      <email>javierramos@institutocolombia.com</email>
      <idioma_id>16</idioma_id>
      <zona_horaria_id>24</zona_horaria_id>   
</Contacto_ti>  
<Niveles>
    <Nivel>
        <nivel_id>21</nivel_id>
        <nivel_clave>001</nivel_clave>
        <Contrato_preferencia>
            <preferencia>
                <tipo>programa</tipo>
                <paga_colegio>1</paga_colegio>
                <paga_distribuidor>0</paga_distribuidor>
                <tipo_venta_clave>VTA</tipo_venta_clave>
                <plazo_clave>CON</plazo_clave>
            </preferencia>
        </Contrato_preferencia>
        <Grados>
            <Grado>
                <grado_clave>05</grado_clave>
                <aula>2</aula>
                <alumno>10</alumno>
                <Articulos>
                    <Subprograma_grado>
                        <articulo_clave>COSCPL01</articulo_clave>
                        <articulo>COMPARTIR PACK PLUS</articulo>
                        <cantidad>10</cantidad>
                        <precio>2559.7330</precio>
                        <descuento_porcentaje>0.00</descuento_porcentaje>
                        <tipo_venta_clave>VTA</tipo_venta_clave>
                        <paga_colegio>1</paga_colegio>
                        <paga_distribuidor>0</paga_distribuidor>                                
                        <parametro>SUBP-G</parametro>
                        <agrupa_articulo_clave></agrupa_articulo_clave>
                            <Componentes>
                                  <Componente>
                                        <articulo_clave>61045964</articulo_clave>
                                        <articulo>7 CAMINOS DEL SABER SOCIALES</articulo>
                                        <ean/>
                                        <isbn/>
                                        <erp_id/>
                                        <cantidad>1</cantidad>
                                        <materia_clave></materia_clave>
                                    </Componente>
                            </Componentes>
                    </Subprograma_grado>                        
                </Articulos>
            </Grado>
        </Grados>
    </Nivel>
</Niveles>
</Contrato>
</contrato_im>

Code Block

language	xml
title	contrato_im
collapse	true

<contrato_im_resultado xmlns="http://www.sistemauno.com/source/xml">
<OK>
<contrato_id>21285</contrato_id>
<ok_text>Transacción exitosa: i</ok_text>
<contrato>INST.CO-1462</contrato>
<colegio_clave>INST.CO</colegio_clave>
<empresa_id>10</empresa_id>
<ciclo_escolar_id>63</ciclo_escolar_id>
</OK>
</contrato_im_resultado>

Code Block

language	groovy
title	colegioArticuloGradoMateria
collapse	true

<colegio_articulo_grado_materia_ime xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <articulo_grado_materia>
      <empresa_id>10</empresa_id>
	  <colegio_clave>INST.CO</colegio_clave>	  
      <articulos>
         <articulo>
            <accion>i</accion>
            <articulo_clave>COSCPL01</articulo_clave>
            <nivel_id>21</nivel_id>
            <nivel_clave>001</nivel_clave>
            <grado_clave>05</grado_clave>
            <materia_id>0</materia_id>
            <periodo_ciclo_clave>A-2017.ANUAL</periodo_ciclo_clave>
            <opcion_venta_clave>OBLIG</opcion_venta_clave>
            <orden>0</orden>
            <activo>1</activo>
            <cantidad>1</cantidad>
			<parametro>SUBP</parametro> 
         </articulo>
         <articulo>
            <accion>i</accion>
            <tipo_material_clave>BAS</tipo_material_clave>
            <articulo_clave>61045964</articulo_clave>
            <nivel_id>21</nivel_id>
            <nivel_clave>001</nivel_clave>
            <grado_clave>05</grado_clave>
            <materia_clave>LEN</materia_clave>
            <periodo_ciclo_clave>A-2017.ANUAL</periodo_ciclo_clave>
            <opcion_venta_clave>OBLIG</opcion_venta_clave>
            <orden>0</orden>
            <activo>1</activo>
            <cantidad>1</cantidad>
            <parametro />
            <articulo_grado_materia_padre_clave>COSCPL01</articulo_grado_materia_padre_clave>
         </articulo>
      </articulos>
   </articulo_grado_materia>
</colegio_articulo_grado_materia_ime>

Code Block

language	xml
title	colegio_articulo_grado_materia
collapse	true

<colegio_articulo_grado_materia_ime_resultado xmlns="http://www.sistemauno.com/source/xml">
<OK>
<ok_text>Transacción exitosa</ok_text>
<accion-id>i-3214506,i-3214507</accion-id>
</OK>
</colegio_articulo_grado_materia_ime_resultado>

Status

colour	Blue
title	ANEXOS

Carga de Catálogos : Catalogos_ BDC.xls

Mapeo BDC: MapeoInterfaceBDC.xls

...

Version	Old Version 38	New Version Current
Changes made by	Laura Olvera. CCORP (Unlicensed)	Diana Núñez. CCORP
Saved on	Oct 06, 2018	Jan 12, 2022

Versions Compared

Key

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:

Status
subtle true
colour Blue
title Requisitos Previos

Alta de Colegio

Actualización de Colegio

Status
colour Blue
title FLUJO DE INFORMACIÓN

Page Comparison

Versions Compared

Key

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:

StatussubtletruecolourBluetitleRequisitos Previos

Alta de Colegio

Actualización de Colegio

StatuscolourBluetitleFLUJO DE INFORMACIÓN

Status
subtle true
colour Blue
title Requisitos Previos

Status
colour Blue
title FLUJO DE INFORMACIÓN