Welcome to the Organicity technical documentation. This web site will provide you detailed information about the services and tools provided by the Organicity EaaS (Experimentation as a Service) facility.

Overview of the technical environment

Architecture

As it can be seen in the following figure, three different tiers can be distinguished within the OC facility architecture:

Facility

Figure 1. OrganiCity facility high level architecture

Accounts and registration

To ensure that all interactions with and within the facility are authenticated with valid user credentials and access rights, Authentication, Authorization and Accounting (AAA) mechanisms have been implemented. Users will be enforced to use their own credentials to interact with the different APIs, services and tools. To start experimenting on top of the OC facility, the experimenters are encouraged to register themselves in the platform.

Once experimenters get registered within the platform, they will be assigned with the OC user role. The OC facility managers will assign the experimenters the OC experimenter role upon the acceptation of the corresponding request. To this end, you should send an email to [email protected], indicating the mail that you have been registered with and the experiment that you belong to.

Likewise, if you are federating a new Organicity (namely a new OC site), you will also have to contact the OC facility managers to obtanin permissions to manage your site. Again, you should send an email to [email protected], indicating the mail that you have been registered with and the OC site you are federating.

APIs

In general, the interaction with the whole technical environment is performed by using the a number of APIs aiming different purposes.

In general the interaction with the different APIs will require authentication, what is perfomed by sending appropriate access tokens. Under the Tutorials tab you will find insightful explanations about how to obtain and work with these tokens: How To Access Token, How To Refresh A Token and How To Authenticate A User.

In order to test the different APIs, you may find the Tester API Application useful.

Services

Living on top of the APIs, a number of services will help you during your interaction with the facility, either if you are an experimenter or manager of an Organicity. You can find them under the Services tab:

Tools

Organicity tools are a set of developments aiming to cover experimentation needs from different perspectives. In this sense, while the Organicity facility is aiming general purpose, the tools are devoted to rather specific needs. You can find them under Tools tab:

Data assets

Urban data, embracing from IoT devices to social events, are modeled inside Organicity as assets. In order to cover a large range of different urban data, OC assets are defined in a generic way following NGSI9/10 specification. Either if you are an experiment or want to federate data into he facility as a new Organicity, you will have to model your resources as assets. Here you will find a thorough description of the data model along with meaningful examples that will help you to model your data.

Currently there are federated assets from the city sites: Aarhus (Denmark), London (UK) and Santander (Spain) ( More details)

If you are an experimenter, you will have to knwo how to manage your assets. Go to the Tutorials to learn: How To Push An Asset To The Experimenters Site and How To Update And Delete An Asset.

If you are managing a new city the tutorial How To Oc Site explains the steps to get your data federated into Organicity.

Experimentation overview

In order to avoid getting lost among the different APIs, services and tools, here we present minimal guidelines to follow to start the experiment:

Apart from these steps, you can find much more in the Tutorials and use the Tools for tailored solutions.

New Organicities (OC sites)

If you are going to federate a new OC site, you should follow the intructions provided in How To Oc Site. It is worth highlighting that you need to host a server (your OC site) that will feed data into the Organicity facility core.

Site managers will be given special rights to manage their sites and data for different urban services within their sites. This will be done through the Facility Manager.

Support

For resolving technical questions, reporting specific issues/bugs and discussion possible extensions in the APIs, services and tools of Organicity, you have different alternatives: