Let’s start with the data from a supermarket chain’s store finder and create a very simple “Powered by FIWARE” application by passing in the address and location of each store as context data to the FIWARE context broker.
\nThe docker-compose file for this tutorial can be found on GitHub:
![\"GitHub\"](\"https://fiware.github.io/tutorials.Getting-Started/icon/GitHub-Mark-32px.png\"){kind=icon}
\n\nFIWARE 101: An Introduction to the FIWARE Platform
\nOur demo application will only make use of one FIWARE component - the Orion Context Broker . Usage of the Orion Context Broker is sufficient for an application to qualify as “Powered by FIWARE”.
\nCurrently, the Orion Context Broker relies on open source MongoDB technology to keep persistence of the context data it holds. Therefore, the architecture will consist of two elements:
\nThe Orion Context Broker server which will receive requests using NGSI
\nThe underlying MongoDB database associated to the Orion Context Broker server
\nSince all interactions between the two elements are initiated by HTTP requests, the entities can be containerized and run from exposed ports.
\n![](\"https://fiware.github.io/tutorials.Getting-Started/img//architecture.png\")
\n\nTo keep things simple both components will be run using Docker. Docker is a container technology which allows to different components isolated into their respective environments.
\nTo install Docker on Windows follow the instructions here
\nTo install Docker on Mac follow the instructions here
\nTo install Docker on Linux follow the instructions here
\nFirst pull the necessary Docker images from Docker Hub and create a network for our containers to connect to:
\ndocker pull mongo:3.6\ndocker pull fiware/orion\ndocker network create fiware_default\n\nA Docker container running a MongoDB database can be started and connected to the network with the following command:
\ndocker run -d --name=context-db --network=fiware_default \\\n --expose=27017 mongo:3.6 --bind_ip_all --smallfiles\n\nThe Orion Context Broker can be started and connected to the network with the following command:
\ndocker run -d --name orion --network=fiware_default \\\n -p 1026:1026 fiware/orion -dbhost context-db\n\nYou can check if the Orion Context Broker is running by making an HTTP request to the exposed port:
\ncurl -X GET http://localhost:1026/version\n\nAlternatively run all your curl commands from within the container network:
\ndocker run --network fiware_default --rm appropriate/curl -s \\\n -X GET http://orion:1026/version\n\nWhat if I get an error response?
\nIf you get an error response, the Orion Content Broker cannot be found where expected
for this tutorial - you will need to substitute the URL and port in each Postman request
with the corrected ip address. All the Postman requests in this tutorial assume
that orion is available on localhost:1026.
Try the following remedies:
\ndocker ps\n\nYou should see two containers running. If orion is not running, you can restart the
containers as necessary. This command will also display open port information.
docker-machine and Virtual Box, you will need to retrieve the virtual host ip as shown:curl -X GET http://$(docker-machine ip default):1026/version\n\nIf you need to update the location of orion:
\nClick on the elipsis ... at the head of the imported postman collection
Select edit from the dropdown
Click on the variables tab and alter the value from localhost:1026 as necessary.
Once the Orion Context Broker is running, You can check the status by making an HTTP request to the exposed port. \nIf the response is blank, this is usually because the MongoDB database holding the context information is not running or not connected.
\n\n\n","urlObject":{"protocol":"http","path":["version",""],"host":["localhost:1026"],"query":[],"variable":[]}},"response":[],"_postman_id":"64444fc0-67ea-4198-9b9d-630f8540cf40"},{"name":"Creating your first Data Entity","id":"e359340f-8f8a-418b-aa37-2eda047a2386","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"urn:ngsi-ld:Store:001\",\n \"type\": \"Store\",\n \"address\": {\n \"type\": \"PostalAddress\",\n \"value\": {\n \"streetAddress\": \"Bornholmer Straße 65\",\n \"addressRegion\": \"Berlin\",\n \"addressLocality\": \"Prenzlauer Berg\",\n \"postalCode\": \"10439\"\n },\n \"metadata\": {\n \t\t\"verified\": {\n \t\t\"value\": true,\n \t\t\"type\": \"Boolean\"\n \t\t}\n \t}\n },\n \"location\": {\n \"type\": \"geo:json\",\n \"value\": {\n \"type\": \"Point\",\n \"coordinates\": [13.3986, 52.5547]\n }\n },\n \"name\": {\n \"type\": \"Text\",\n \"value\": \"Bösebrücke Einkauf\"\n }\n}"},"url":"http://localhost:1026/v2/entities/","description":"Troubleshooting: What if the response is blank ?
\n\n
\n- To check that a docker container is running try
\n\ndocker ps\nYou should see two containers running. If orion is not running, you can restart the containers as necessary.
\n
At its heart, FIWARE is a system for managing context information, so lets add some context data into the system by creating a new entity (a store in Berlin). Any entity must have a id and type attributes, additional attributes are optional and will depend on the system being described. Each additional attribute should also have a defined type and a value attribute.
This example returns the full data context
\n","urlObject":{"protocol":"http","path":["v2","entities"],"host":["localhost:1026"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c9949d8-9306-4ac0-9507-9dc6c122418b"},{"name":"Obtain Entity Data by id","id":"75bb0012-88ec-4edd-8559-f19c77ad2bb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:1026/v2/entities/urn:ngsi-ld:Store:001?options=keyValues","description":"This example returns the context data of store1. The id of the entity should be unique or the type parameter should also be used.
Because of the use of the options=keyValues, the response consists of JSON only without the attribute type elements.
keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyEntity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"disabled":true,"description":{"content":"Ordered list of attribute names to display
\n","type":"text/plain"},"key":"attrs","value":"name"}],"variable":[]}},"response":[],"_postman_id":"75bb0012-88ec-4edd-8559-f19c77ad2bb4"},{"name":"Obtain Entity Data by type","id":"d5c28b0c-224a-4a61-a74c-e233b112c644","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:1026/v2/entities/?type=Store&options=keyValues","description":"This example returns the data of all Store entities within the context data.
The type parameter limits the response to store entities only.\nBecause of the use of the options=keyValues, the response consists of JSON only without the attribute type elements.
Entity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"description":{"content":"keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyOrdered list of attribute names to display
\n","type":"text/plain"},"key":"attrs","value":"name"}],"variable":[]}},"response":[],"_postman_id":"d5c28b0c-224a-4a61-a74c-e233b112c644"},{"name":"Filter context data by attribute value","id":"fcbde4dd-b8fa-42b7-bacf-158e7d6ecb1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:1026/v2/entities/?q=name=='Checkpoint Markt'&type=Store&options=keyValues","description":"This example returns the data of all Store entities found with the name Checkpoint Markt.
Filtering can be done using the q parameter - if a string has spaces in it, it can be URL encoded and held within single quote characters ' = %27
Because of the use of the options=keyValues, the response consists of JSON only without the attribute type and metadata elements.
Entity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"description":{"content":"keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyOrdered list of attribute names to display
\n","type":"text/plain"},"key":"attrs","value":"name"}],"variable":[]}},"response":[],"_postman_id":"fcbde4dd-b8fa-42b7-bacf-158e7d6ecb1d"},{"name":"Filter context data by sub-attribute value","id":"2c5d1c0a-9d26-4422-8d07-8cf7ab5fa309","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:1026/v2/entities/?q=address.addressLocality=='Kreuzberg'&type=Store&options=keyValues","description":"This example returns the data of all Store entities found in the Kreuzberg district of Berlin.
Filtering can be done using the q parameter - sub-attributes are annotated using the dot syntax e.g. address.addressLocality
Because of the use of the options=keyValues, the response consists of JSON only without the attribute type and metadata elements.
Entity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"description":{"content":"keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyThis example returns the data of all Store entities with a verified address.
Metadata queries can be made using the mq parameter.
Entity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"description":{"content":"keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyThis example returns the data of all Store entities found within 1.5km the Brandenburg Gate in Berlin (52.5162N 13.3777W)
Entity type, to avoid ambiguity in case there are several entities with the same entity id
\n","type":"text/plain"},"key":"type","value":"Store"},{"description":{"content":"keyValues option in order to get a more compact and brief representation, including just attribute valuesvalues option combined with a list of attribute values attrs for an ordered list of attributes onlyOrdered list of attribute names to display
\n","type":"text/plain"},"key":"attrs","value":"name"}],"variable":[]}},"response":[],"_postman_id":"8e8dee67-577a-4a86-9e31-68c920adf9ba"}],"event":[{"listen":"prerequest","script":{"id":"29de01fb-29bc-418f-96df-f6b5f1ce1236","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04e10871-c7b3-450d-b3d1-89d8fec68108","type":"text/javascript","exec":[""]}}],"variable":[{"key":"orion","value":"localhost:1026","type":"string"}]}