Integration Data Model - i-on-project/integration GitHub Wiki

Let us have a deeper look into the internal structure of each output file:

• Timetable
• Academic Calendar
• Evaluations Schedule
• School Programmes Descriptions
• Course Offering
• Schools

Timetable

The timetable format provides a description per school and programme of the weekly schedule per each class and section.

Field	Type	Description
creationDateTime	Date	Date of creation of the PDF file
retrievalDateTime	Date	Date of data extraction
school	School	Name and acronym of the school
programme	Programme	Name and acronym of the programme
calendarTerm	String	Calendar term of the processed timetable
classes	ClassDetail Array	All classes available in the timetable
acr	String	Course acronym
sections	sections Array	List of sections with events related to a particular course
events	events Array	Description of events with the event type, location, begin time, duration, and weekday
instructors	instructors Array	Provides the instructor’s name and category of lecture that he or she teaches

creationDateTime: 2021-04-21T20:49:16Z  # Coordinated Universal Time (UTC) - ISO 8601
retrievalDateTime: 2021-04-21T20:49:16Z # Coordinated Universal Time (UTC) - ISO 8601
school:
  name: INSTITUTO SUPERIOR DE ENGENHARIA DE LISBOA
  acr: ISEL
programme:
  name: Licenciatura em Engenharia Informática e de Computadores
  acr: LEIC
calendarTerm: 2020-2021-2
classes:
  -   acr: E
      sections:
        - section: LEIC11Da
          events:
            - category: LECTURE  # [LECTURE | PRACTICE | LAB | LECTURE_PRACTICE]
              location:
                - L_H2    # not mandatory
              beginTime: "14:00"
              duration: "01:30"
              weekday: MO # RFC 5545  [ SU | MO | TU | WE | TH | FR | SA ]
            - category: LECTURE
              beginTime: "14:00"
              duration: "01:30"
              weekday: WE
            - category: LECTURE
              beginTime: "14:00"
              duration: "01:30"
              weekday: TH
          instructors:
            - name: Teacher A
              category: PRACTICE
            - name: Teacher B
              category: LECTURE

Academic Calendar

The academic calendar describes major events in an academic year. Since it is institution based, there is no need to include the programme.

Field	Type	Description
creationDateTime	Date	Date of creation of the PDF file
retrievalDateTime	Date	Date of data extraction
school	School	Name and acronym of the school
language	Language	Indicates the language used in the event descriptions
terms	term Array	List of the calendar terms
calendarTerm	String	Calendar term identification
interruptions	interruption Array	List of interruption of lectures during a term
evaluations	evaluation Array	List of evaluation periods during a term
lectures	lecture Array	Start and end of lectures in a term split by curricular term
otherEvents	otherEvents Array	List of other events described in the calendar

creationDateTime: 2021-04-21T20:49:16Z
retrievalDateTime: 2021-04-21T20:49:16Z
school:
  name: Instituto Superior Engenharia Lisboa 
  acr: ISEL
language: pt-PT
terms:
  - calendarTerm: 2019-2020-1
    interruptions:
      - name: Férias Natal
        startDate: 2019-12-23
        endDate: 2020-01-04
    evaluations:
      - name: Exames época normal
        startDate: 2020-01-13
        endDate: 2020-02-01
        duringLectures: false
      - name: Exames época recurso
        startDate: 2020-02-03
        endDate: 2020-02-15
        duringLectures: false
      - name: Exames época especial
        startDate: 2020-02-26
        endDate: 2020-03-07
        duringLectures: true
    lectures:
      - name: Todas as Turmas
        curricularTerm:
          - id: 1
          - id: 2
          - id: 3
          - id: 4
          - id: 5
          - id: 6
        startDate: 2019-09-09
        endDate: 2019-12-21
    otherEvents:
      - name: Divulgação de horários
        startDate: 2019-07-22
        endDate: 2019-07-22

Evaluations Schedule

The evaluations schedule describes the evaluations taking place at a calendar term, for a programme.

Field	Type	Description
creationDateTime	Date	Date of creation of the PDF file
retrievalDateTime	Date	Date of data extraction
school	school	Name and acronym of the school
programme	programme	Name and acronym of the programme
calendarTerm	String	Calendar term identification
exams	exam Array	List of interruption of lectures during a term
category	category	This field classifies the evaluations with the following values: test, exam_normal, exam_altern, exam_special.
location	location	Shows the room where the evaluation will take place - this information is not processed since is only available in a separate PDF source file.

creationDateTime: 2021-04-21T20:49:16Z
retrievalDateTime: 2021-04-21T20:49:16Z
school:
    name: Instituto Superior Engenharia Lisboa 
    acr: ISEL
programme:
    name: Licenciatura em Engenharia Informática e de Computadores
    acr: LEIC
calendarTerm: 2019-2020-2
exams:
    - name: AED
      startDate: 2020-07-09T14:00:00Z
      endDate: 2020-07-09T17:00:00Z
      category: TEST #TEST | EXAM_NORMAL | EXAM_ALTERN | EXAM_SPECIAL
      location: null

School Programmes Descriptions

The school programme description was a new requirement added for the 2021 instance of i-on Integration to offer this type of data for consumption by other i-on projects. Provides details about each programme in a school.

school: pt.ipl.isel
programmes:
  - acronym: MEIC
    name: Mestrado em Engenharia Informática e de Computadores
    termSize: 4
    department: ADEETC
    coordination:
      - Teacher A
      - Teacher B
    email: [email protected]
    uri: https://www.isel.pt/cursos/mestrados/engenharia-informatica-e-de-computadores
    description: O mestrado em Engenharia Informática e de Computadores (MEIC), corresponde ao 2º ciclo no âmbito da Declaração de Bolonha. 
  - acronym: LEIC
    termSize: 6
    department: ADEETC
    coordination:
      - Teacher B
      - Teacher D
    email: [email protected]
    uri: https://www.isel.pt/cursos/licenciaturas/engenharia-informatica-e-de-computadores
    description: O ciclo de estudos conducente ao grau de licenciado em Engenharia Informática e de Computadores resulta do aprofundamento dum perfil profissional reconhecido pelo mercado empregador nacional e internacional.

Course Offering

Like the school programme description, the course offering was added this semester for consumption by other i-on projects. Describes all the courses available in a school, detailing the term where is offered and the programmes where is available.

school: pt.ipl.isel
courses:
  - id: 0
    acronym: 
      - PSC
    name: Programação em Sistemas Computacionais
    termNumber: 
      - 3
    optional: false
    termDuration: 1 # 1 .. 4
    ects: 6
    scientificArea: IC
    programmes:
      - LEIC
  - id: 1	
    acronym:
      - CD
    name: Computação Distribuída
    termNumber:
      - 1
    optional: false
    termDuration: 1 # 1 .. 4
    ects: 6
    scientificArea: IC
    programmes:
      - MEIC

Schools

This format provides details of schools. The primary key is the id field which uses same naming prefix as described above for the folders.

schools:
  - id: pt.ipl.isel
    countryCode: pt
    name: Instituto Superior de Engenharia de Lisboa  
    address: Rua Conselheiro Emídio Navarro, 1, 1959-007 LISBOA
    telephone: (+351) 218317000
    uri: https://www.isel.pt
    email: [email protected]
  - id: pt.ulisboa.tecnico
    countryCode: pt
    name: Instituto Superior Técnico
    address: Av. Rovisco Pais, 1049-001 LISBOA
    telephone: (+351) 218417769
    uri: https://www.tecnico.ulisboa.pt
    email: [email protected]