Introduction

OpenRecordz is an OpenData as a Service platform written in Java and Spring that use MongoDB (NOSQL) database.
See more here http://www.openrecordz.com

OpenRecordz is an OpenData cloud software with :

• Powerful API to read and create opendata (datasets and records). Documentation here http://www.openrecordz.com/documentazione/api/
• Full-text and Geo query support
• Support LinkedData with RDF and SPARQL
• Full-stack with Mobile app skeleton (iOS and Android)
• OpenSource. Source available on GitHub https://github.com/openrecordz
• Social: Everyone can contribute to the opendata catalog

You can use :

• The cloud version here http://www.openrecordz.com. Create a free account and use the platform.
• The on-premise version. Read the installation documentation.

Prerequisites

• Java 1.7
• Maven
• MongoDB
• MYSQL

Configuration

Settings

Optionally change the open-recordz server parameters (mongodb uri, mysql, domain, urls) here application-.properties

• For development application-development.properties
• For production application-production.properties

MongoDB

With a mongo client:

• Create an openrecordz schema.

• Create the admin person data:

db.person.insert({ "_id" : "admin", "_class" : "openrecordz.domain.Person", "fullName" : "Administrator", "email" : "admin@address.com", "photo" : "/default/avatar/avatar.png", "defaultPhoto" : true, "createdBy" : "admin", "createdOn" : ISODate("2016-10-17T13:58:03.715Z"), "modifiedBy" : "admin", "modifiedOn" : ISODate("2016-10-17T13:58:03.716Z"), "tenant" : "_register", "tenants" : [ "_register" ], "publishOnFb" : false, "properties" : {  }, "tags" : [ ], "type" : "Person" })

• Create the mongodb indexes with:

db.customData.createIndex({ _location: "2dsphere" })
db.customData.createIndex({"_tenants":1});
db.customData.createIndex({"_dataset_ref_id":1});
db.customData.createIndex({"_status":1});
db.customData.createIndex({"_createdby":1});
db.customData.createIndex({"_modifiedby":1});

• Create the mongodb fulltext index with:

db.customData.createIndex( { "$**": "text" }, { name: "ORTextIndex" },  { default_language: "italian" })
db.person.createIndex( { "$**": "text" }, { name: "ORPeopleTextIndex" },  { default_language: "italian" })

MYSQL

Go to ./bin/dbscripts and run from command line :

mysql -uroot -proot < 1_create-schema.sql
mysql -uroot -proot openrecordz < 2_tenant.sql 
mysql -uroot -proot openrecordz < 3_scriptDB.sql
mysql -uroot -proot openrecordz < 4_spring-security-persistent-login.sql 
mysql -uroot -proot openrecordz < 5_spring-security.sql 
mysql -uroot -proot openrecordz < 6_url.sql     
mysql -uroot -proot openrecordz < 7_spring-security-data.sql 

HornetQ

• HornetQ data is automatically saved to ../openrecordz-data folder
• If you want you can change it on ./src/main/resources/hornetq-configuration.xml

Run

Run in development mode

run $ mvn clean install tomcat7:run -Dmy.env=development

Run in production mode

run $ mvn clean install tomcat7:run -Dmy.env=production&

Verify

Open the browser to : http://localhost:9090/service/v1/datasets. The server must reply with '[]' json data.

Usage

Create a user

curl -X POST -d 'fullName=Andrea Leo&username=andrealeo&email=andrealeo@address.com&password=123456' http://localhost:9090/service/v1/signup

Create a new dataset

curl -H "Content-Type: application/json" -X POST -u andrealeo:123456 -d '{"_slug":"city-monuments"}' http://localhost:9090/service/v1/datasets

Add records to the datasets

curl -H "Content-Type: application/json" -X POST -u andrealeo:123456 -d '{"name":"Colosseo","city":"Rome", "address": "Via dei Fori Imperiali"}' http://localhost:9090/service/v1/datasets/city-monuments?byslug=true

and

curl -H "Content-Type: application/json" -X POST -u andrealeo:123456 -d '{"name":"San Pietro","city":"Rome", "address": "Piazza san Pietro"}' http://localhost:9090/service/v1/datasets/city-monuments?byslug=true

Retrieve the datasets

curl -H "Content-Type: application/json" http://localhost:9090/service/v1/datasets

Retrieve the records of the dataset

curl -H "Content-Type: application/json" http://localhost:9090/service/v1/datasets/city-monuments.map?byslug=true

Read REST API documentation here: http://www.openrecordz.com/documentazione/api/