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:

...

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

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.

...

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
pais_id	int	11	id del país de la empresa que crea el colegio	Sólo los niveles escolares se crean en la empresa correspondiente
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 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.

...

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.

Proceso	Servicio	Tipo de llamado	Campos de búsqueda	Campos de datos únicos
Creación de Nivel de Colegio	collegeLevelCycle	POST	colegio_nivel_ciclo_id, clave	colegio_nivel_ciclo_id, clave, crm_id, erp_id
Descripción de campos
Campo	Tipo	Longitud	Valor por defecto	Observaciones
colegio_nivel_ciclo_id	int	11	0	En el llamado POST, siempre debe ir en cero.
colegio_id	int	11	ID del colegio	Campo requerido en el llamado POST, se debe indicar el id del colegio al que se le crea el nivel escolar
erp_id	varchar	35	Definido por negocio	Clave o código identificador del colegio en el ERP
crm_id	varchar	100	Valor del CRM	Es el indicador único del nivel del colegio en el CRM
empresa_id	int	11	ID de la empresa	Identificador de la empresa en la que se crea el nivel
nivel_id	int	11	ID del nivel	Los niveles se crean por país y aplican a todos los colegios
ciclo_escolar_id	int	11	ID del ciclo escolar	Identificador único del ciclo escolar; los ciclos escolares pueden variar en las empresas de cada país
clave	varchar	50	Definido por negocio	Clave otorgada por negocio al nivel del colegio
clave_oficial	varchar	100	Definida por negocio	Es la clave otorgada por los ministerios de educación a cada nivel escolar de los colegios.

Campos editables en un llamado PUT:

...

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.

Proceso	Servicio	Tipo de Llamado	Campos de Búsqueda	Campos de Datos Únicos
Creación de artículo	articuloGradoPeriodoPrecio	POST	articulo_id, articulo_clave, erp_id
Descripción de campos
Campo	Tipo	Longitud	Valor por Defecto	Observaciones
articulo_id
empresa_id
articulo_clave
articulo
erp_id

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.

...

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

Status

colour	Blue
title	EJEMPLOS DE USO

Microservicio

Respuesta

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>

Code Block

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>
      <sincroniza_articulo_materia>1</sincroniza_articulo_materia>        
	  <calcula_precio_subprograma>1</calcula_precio_subprograma>          
      <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>
			<precio>100</precio>
			<descuento_porcentaje>12.00</descuento_porcentaje>
            <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

...

Version	Old Version 38	New Version 39
Changes made by	Laura Olvera. CCORP	Tania Romo
Saved on	Oct 06, 2018	May 29, 2019

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