CIRC4Life System Architecture

General

This document includes the description of the CIRC4Life overall System Architecture.

10 mile view

System Architecture 10 mile view

Project partners involved with Information and Communications Technology development

Group Module Developed by
1. ICT Platform 1.1 Access Control Manager ICCS
1. ICT Platform 1.1.1 ICT Web Services ICCS
1. ICT Platform 1.1.2 Data Gateway ICCS
2. Data Providers 2.1 Data Entry Tool for Stakeholders ENV
2. Data Providers 2.2 Intermediate Products Data Export Web Service ENV
3. Services 3.1 Recycle and Reuse Module NTU
3. Services 3.2 Traceability Module EECC
3. Services 3.3 LCIA ReCiPe Score Module (Cancelled) NTU
4. End user applications 4.1 Eco Account and Shopping Module NTU
4. End user applications 4.2 Retailer Tool for Eco Accounting NTU
4. End user applications 4.3 Impact Assessment Tool ICCS
4. End user applications 4.4 Brokerage System ICCS

Data Models

See here.

Data Flows

The Data Flows below are a work in progress. All partners developing these modules should collaborate on finalizing this table as soon as possible.

Data Flow Source Destination Data Format Communication Protocol Comment System/User Requirements
DF#1 2.1 Data Entry Tool for Stakeholders 2.2.1 Intermediate Products Data Internal Query Language Local Database connector Data entry UI application saves records to local relational database
DF#2 2.2 Intermediate Products Data Export Web Service 1.1.2 Data Gateway JSON HTTP Web Service Data Gateway service retrieves data entry records
DF#3 1.1.2 Data Gateway 1.1.1 ICT Web Services JSON HTTP REST Service Data Gateway posts validated data entry records to REST endpoint that updates Product Master Database.
DF#4 3.2 Traceability Module 1.1.1 ICT Web Services JSON HTTP REST Service Post Consumer and Product ID with recycler evaluation result SYSTEM_01,05,18,30 - USER_G_10,13,15
DF#5 4.2 Retailer Tool for Eco Accounting 1.1.1 ICT Web Services JSON HTTP REST Service Retailer tool access to Product Master Database and EcoAccount anonymously for purchase history update SYSTEM_05,08 - USER_G_04,12 - USER_U_02
DF#6 4.1 Eco Account and Shopping Module 1.1.1 ICT Web Services JSON HTTP REST Service End-user applications access Product Master Data information and EcoAccount SYSTEM_03,04,05,06,08,09,10,11,12,13,14,16,17,19,20,21,25,26,28,29 - USER_G_02,03,04,08,09,11,12,15 - USER_U_01,03,04,05,06,07
DF#7 1.1.1 ICT Web Services 4.3 Impact Assessment Tool JSON HTTP REST Service Impact Assessment Tool retrieves product information, material and recycle/re-use information SYSTEM_02,27 - USER_G_12,15
DF#8 1.1.1 ICT Web Services 3.2 Traceability Module JSON HTTP REST Service Get purchase history, Eco-credit from evaluated recycled product, Eco-credit estimation for user incentive USER_U_03,04 - USER_G_03 - USER_R_02,04

Modules

1. ICT Platform

The ICCS CIRC4Life ICT Platform is the main host system of the Access Control Manager, the REST Web Services and Persistent Databases. End-users and project client applications retrieve and update data by using the single authorization point provided by the Access Control Manager.

1.1 Access Control Manager

The Access Control Manager is responsible for all Authentication and Authorization of the ICT Platform. It handles the consumer’s Eco-accounts and the accessibility of 3rd party application to the provided REST Web Services. The implementation is based on the Open Source Identity and Access Management platform Keycloak, a project supported by the industry’s open source leader RedHat. keycloak uses standard protocols and provides support for OpenID Connect, OAuth 2.0, and SAML. It integrates with a large list of different technology stacks and programming languages via Client Adapter libraries. It can federate user repositories from external LDAP or Active Directory servers and also provides identity brokering for external social networks including:

1.1.1 ICT Web Services (REST)

All data access to end-users and 3rd party client application is provided by a layer of REST Web Service endpoints. The Application Programming Interface (API) provided by the REST endpoints targets to cover all System and User Requirements described in Deliverable 4.1. See REST APIs and Services Usage.

1.1.1.1 Master Product Data

See Data Models.

1.1.1.2 User Eco Account

See Data Models.

1.1.2 Data Gateway

See Data Models.

2. Data Providers

ENV developed applications for data entry input, mainly for products and their life cycle information.

2.1 Data Entry Tool for Stakeholders

Available as a Web Application here: ENV Data Entry Tool.

  • Username: DataEntryTool
  • Password: iccs.isense.circ4life.envirodata.2019

2.2 Intermediate Products Data Export Web Service

Available as a Web Application here: ENV Data Export Service.

No authorization is in place, the service is public.

2.2.1 Intermediate Products Data

ENV developed internal persistence database back-end for the 2.1 and 2.2 applications above.

3. Services

External Web Services, not part of the core ICT Platform.

3.1 Recycle and Reuse Module

NTU is working on this module.

3.2 Traceability Module

Available as a Web Application here: CIRC4Life Traceability Module.

3.3 LCIA ReCiPe Score Module

NTU cancelled the implementation of this module.

4. End user applications

Consumer applications for mobile devices.

4.1 Eco Account and Shopping Module

Google Android mobile application. It can be installed on Android devices via the Google Play Store.

4.2 Retailer Tool for Eco Accounting

NTU is working on this module.

4.3 Impact Assessment Tool

See Impact Assessment Tool Usage.