Clear filter
Announcement
Anastasia Dyubaylo · Jun 17, 2022
Hello and welcome to the 21st InterSystems programming contest!
🏆 InterSystems Full Stack Contest 2022 🏆
Duration: June 27 - July 17, 2022
In prizes: $10,000
The topic
💡 Full Stack Applications 💡
Develop a Full Stack solution using the InterSystems IRIS, InterSystems IRIS For Health, or IRIS Cloud Service as a backend. By full stack we mean a frontend web or mobile application which inserts, updates, or deletes data in InterSystems IRIS via REST API, Native API, ODBC/JDBC, or Embedded Python.
What's more?
This time we decided to invite developers to try their skills in solving one of the global challenges. We encourage you to join this contest with solutions focused on tackling climate change issues:1) You will receive a special bonus if your application can solve problems related to global warming and climate change. 2) There will also be another bonus if you prepare and submit to Open Exchange a dataset related to the global warming and climate change.
So! We’re looking forward to your innovative contributions for an even more sustainable world. Hone your digital skills to develop solutions for climate issues!
General Requirements:
Accepted applications: new to Open Exchange apps or existing ones, but with a significant improvement. Our team will review all applications before approving them for the contest.
The application should work either on IRIS Community Edition or IRIS for Health Community Edition or IRIS Advanced Analytics Community Edition.
The application should be Open Source and published on GitHub.
The README file to the application should be in English, contain the installation steps, and contain either the video demo or/and a description of how the application works.
Contest Prizes:
1. Experts Nomination – winners will be selected by the team of InterSystems experts:
🥇 1st place - $4,000
🥈 2nd place - $2,000
🥉 3rd place - $1,000
🌟 4-15th places - $100
2. Community winners – applications that will receive the most votes in total:
🥇 1st place - $1,000
🥈 2nd place - $750
🥉 3rd place - $500
✨ Global Masters badges for all winners included!
Note: If several participants score the same amount of votes, they all are considered winners, and the money prize is shared among the winners.
Important Deadlines:
🛠 Application development and registration phase:
June 27, 2022 (00:00 EST): Contest begins.
July 10, 2022 (23:59 EST): Deadline for submissions.
✅ Voting period:
July 11, 2022 (00:00 EST): Voting begins.
July 17, 2022 (23:59 EST): Voting ends.
Note: Developers can improve their apps throughout the entire registration and voting period.
Who Can Participate?
Any Developer Community member, except for InterSystems employees (ISC contractors allowed). Create an account!
Developers can team up to create a collaborative application. Allowed from 2 to 5 developers in one team.
Do not forget to highlight your team members in the README of your application – DC user profiles.
Helpful Resources:
✓ InterSystems IRIS Docker templates suitable for a Full Stack application:
IRIS Full Stack template
Basic InterSystems IRIS Docker template
IRIS REST API template
Native API template
IntegratedML template
IRIS Analytics template
isc-ipm-js
isc-perf-ui
isc-json
isc-rest
isc-codetidy
✓ Online courses:
Implementing RESTful Applications
✓ Videos:
REST API design and Development
REST API in 5 minutes
Data-Driven Web Apps
✓ For beginners with IRIS:
Build a Server-Side Application with InterSystems IRIS
Learning Path for beginners
✓ For beginners with ObjectScript Package Manager (ZPM):
How to Build, Test and Publish ZPM Package with REST Application for InterSystems IRIS
Package First Development Approach with InterSystems IRIS and ZPM
✓ How to submit your app to the contest:
How to publish an application on Open Exchange
How to submit an application for the contest
Need Help?
Join the contest channel on InterSystems' Discord server or talk with us in the comment to this post.
We can't wait to see your projects! Good luck 👍
By participating in this contest, you agree to the competition terms laid out here. Please read them carefully before proceeding. Developers!
Don't miss the opportunity to join the Full Stack Contest Kick-off Webinar!
The webinar starts on Monday, June 27 – at 09:00 AM EDT.
We are waiting for your participation! https://www.worldbank.org/en/topic/climatechange can help contestants identify important issues.
NOAA is the first place to look for climate data: https://www.climate.gov/maps-data
USGS is a great source of free satellite imagery: https://earthexplorer.usgs.gov/
Hey Community,
Please check out Three new Open Exchange packages by @Timothy.Leavitt! That can really help accelerate modern full-stack application development on IRIS. Developers!
There are only five days until the end of the registration phase!
Don't miss the opportunity to join the InterSystems Full Stack Contest 2022! Hi everyone!
I’m happy to see that corporation where I worked for 12 years is really care about problem of climate change.
Now I’m studying in the University and my major is close to climate change topic. That’s why I want to add my 2 cents and share my opinion which applications done be developers could help with climate change issue.
First, I want to say that analysis of UN, World Bank and other organizations data related to climate change in my opinion will not change anything, just give information that “something is happening”.
But developers can make a real positive change in this area implementing applications which help decrease energy consumption. Because largest part of global warming is related to warming produced during energy production in energy production plants from non-renewable energy sources like coal, oil products, gas. That’s why in my point of view all applications which help to decrease warming which is produced during energy production or decrease energy consumption are helpful.
For health industry related applications examples are:
Telemedicine
Hospitalization planning applications
…
And all others which minimize patients travel especially for large distance to minimize petrol consumption by cars and planes, and electricity for trains and metro.
Non-industry related applications like:
Distant learning and certification
Teleconference
Applications which support remote work for workgroups
And others – for the same reason: minimization energy consumption for travel.
Health trackers which motivate people to use feet and bicycle for short term travel and don’t use cars.
Food production and consumption is energy intensive process as well. It looks small for one person, but for billions of people it is huge. Dietary related applications which help to decrease losses of products on each stage of production, delivery chain and consumption, decrease meat consumption and use more balanced diet, because meat production requires is at least 10 time more energy compared to vegetable proteins.
Smart City applications which optimize energy consumption on city level. It includes traffic monitoring and control to minimize traffic jams (decreasing petrol and electricity consumption), and motivates people to use public transport which decreases further energy consumption.
Smart Home applications which help to optimize energy consumption on level of house.
Applications which help people to use right way to recycle old electric and electronic equipment, especially fridges and freezers. Old fridges and freezers contain old standard refrigerating medium, which are 1000 times more dangerous for ozone layer and climate change compared to carbon dioxide.
I hope this text will help developers to understand that small and ordinary applications which they implement now could really help to solve global important problem of climate change.
Good luck in the Contest! I agree! We all have to do our part! Hey, Devs!
Today is the last day to upload your applications!
Three apps have been uploaded to the contest:
interoperability-manager by @Oliver.Wilms iris-for-money by @Oliver.Wilms iris-climate-change by @Muhammad.Waseem
Who is going to be the next contester?Only a few hours left to know!
Article
Yuri Marx · Jan 12, 2022
The JSON is a data document free of types and validation rules. However, in some scenarios it is important that the JSON document has type and business rules validation, especially in interoperability scenarios. This article demonstrates how you can leverage a market-defined JSONSchema technology that is open for everyone to use and do advanced validations.
About JSON
According to json.org, “JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language Standard ECMA-262 3rd Edition - December 1999. JSON is a text format that is completely language independent but uses conventions that are familiar to programmers of the C-family of languages, including C, C++, C#, Java, JavaScript, Perl, Python, and many others. These properties make JSON an ideal data-interchange language”. (Source: https://www.json.org/json-en.html). An example of a JSON document could be:
About JSON Schema
According to json-schema.org, “JSON Schema is a vocabulary that allows you to annotate and validate JSON documents.”.If JSON is easy for humans to read, write and understand, why do we need to apply a schema to validate JSON documents/content? The main reasons are:
To define a clear contract to interoperate JSON based data between partners and their applications.
To detail, document and describe your JSON files, making it easier to use.
To validate JSON data for automated testing, ensuring the quality of the requests and responses.
To generate JSON sample and/or real data from the JSON Schema.
To apply business/validation rules into JSON content, instead of creating language dependent validations.
To support the “contract first approach” on the development of REST API. More details on https://swagger.io/blog/api-design/design-first-or-code-first-api-development/.
JSON Syntax
To understand the role of JSON Schema in a JSON game, it is necessary to know more about JSON syntax. The JSON syntax is derived from JavaScript object notation syntax, so, the syntax rules are equal to JavaScript objects. The JSON rules are next (source: https://www.w3schools.com/js/js_json_syntax.asp):
Data must be specified in name/value pairs.
Data must be separated by commas.
Curly braces hold objects.
Square brackets hold arrays.
The JSON Data consists of a name/value pair with a field name (in double quotes), followed by a colon and followed by a value. Example:
JSON names require double quotes and refers to JavaScript objects and to InterSystems IRIS ObjectScript Dynamic Object (%Library.DynamicObject) too. More details in https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=GJSON_intro#GJSON_intro_methods.
In JSON, values must be one of the following data types:
A string, must be between “”. Sample: “a string”.
A number, must be integer or decimal values. Sample: 10 or 20.23.
An object, must be between {}. Sample: {“firstName”: “John”}.
An array, must be between []. Sample: [{“firstName: “John”},{“firstName”: “Anna”}].
A Boolean, must be true or false. Sample: {“isDead”: false}.
A null, to set no value.
When you apply a JSON document to a language object, these syntax rules are validated, but sometimes, it is necessary to establish business rules too. JSON Schema is used for this, to expand JSON basic rules with rules specified in JSON Schema documents.The InterSystems IRIS has full support for JSON basic rules, and JSON content is very elegant to read or write.. It is easier than any other programming language, see a sample:
InterSystems IRIS Object Script writing JSON
Java writing JSON
set dynObject1 = ##class(%DynamicObject).%New()set dynObject1.SomeNumber = 42set dynObject1.SomeString = "a string"set dynObject1.SomeArray = ##class(%DynamicArray).%New()set dynObject1.SomeArray."0" = "an array element"set dynObject1.SomeArray."1" = 123dynObject1.%ToJSON()
//First EmployeeJSONObject employeeDetails = new JSONObject();employeeDetails.put("firstName","Lokesh");employeeDetails.put("lastName", "Gupta");employeeDetails.put("website","howtodoinjava.com");JSONObject employeeObject = new JSONObject(); employeeObject.put("employee", employeeDetails);
//Second EmployeeJSONObject employeeDetails2 = new JSONObject();employeeDetails2.put("firstName", "Brian");employeeDetails2.put("lastName", "Schultz");employeeDetails2.put("website", "example.com");
JSONObject employeeObject2 = new JSONObject(); employeeObject2.put("employee", employeeDetails2);
//Add employees to listJSONArray employeeList = new JSONArray();employeeList.add(employeeObject);employeeList.add(employeeObject2);employeeList.toJSONString();
While ObjectScript is a dynamic language, allowing setting JSON properties as object properties, other languages, like Java, force you to set key and values inside objects. On the other hand, Java and other languages support JSON Schema using open source and commercial packages, but the ObjectScript does not support JSON Schema at the moment. See the list from json-schema.org (source: https://json-schema.org/implementations.html):
NET
Json.NET Schema 2019-09, draft-07, -06, -04, -03 (AGPL-3.0-only)
JsonSchema.Net 2020-12, 2019-09, draft-07, -06 (MIT)
C++
f5-json-schema draft-07 (Boost Software License 1.0)
JSON schema validator for JSON for Modern C++ draft-07 (MIT)
Valijson draft-07 header-only library, works with many JSON parser implementations (BSD-2-Clause)
Jsoncons draft-07 header-only library (Boost Software License 1.0)
Java
Snow 2019-09, draft-07, -06 Uses Maven for the project and Gson under the hood. (GNU Affero General Public License v3.0)
Vert.x Json Schema 2019-09, draft-07 includes custom keywords support, custom dialect support, asynchronous validation (Apache License, Version 2.0)
Everit-org/json-schema draft-07, -06, -04 (Apache License 2.0)
Justify draft-07, -06, -04 (Apache License 2.0)
Networknt/json-schema-validator draft-07, -06, -04 Support OpenAPI 3.0 with Jackson parser (Apache License 2.0)
Jsonschemafriend 2019-09, draft-07, -06, -04, -03 (Apache License 2.0)
JavaScript
Ajv 2019-09, 2020-12, draft-07, -06, -04 for Node.js and browsers - supports user-defined keywords and $data reference (MIT)
Djv draft-06, -04 for Node.js and browsers (MIT)
Hyperjump JSV 2019-09, 2020-12, draft-07, -06, -04 Built for Node.js and browsers. Includes support for custom vocabularies. (MIT)
Vue-vuelidate-jsonschema draft-06 (MIT)
@cfworker/json-schema 2019-09, draft-07, -06, -04 Built for Cloudflare workers, browsers, and Node.js (MIT)
Python
jschon 2019-09, 2020-12 (MIT)
jsonschema 2019-09, 2020-12, draft-07, -06, -04, -03 (MIT)
fastjsonschema draft-07, -06, -04 Great performance thanks to code generation. (BSD-3-Clause)
jsonschema-rs draft-07, -06, -04 Python bindings to Rust’s jsonschema crate (MIT)
This is a sample how to use JSON schema to validate JSON content (using Python, source: https://jschon.readthedocs.io/en/latest/):
Fortunately, IRIS allows you to create packages or frameworks using the programming language of your choice (.NET or Java using PEX or Language Server). So, it is possible to create an IRIS extension package to handle JSON Schema in IRIS. Another possibility is to use Embedded Python and create a JSON validation method class (in the version 2021.2+).
Extending the InterSystems IRIS to support JSON Schema using Java Language Server (Java Gateway)
Among Java frameworks, the networknt/json-schema-validator is used the most to validate JSON using JSON Schema.To use this Java framework, you can get the application https://openexchange.intersystems.com/package/IRIS-JSON-Schema-Validator. This application has the following files and folders:
1. The folder jgw has the necessary files to create a Java Gateway (bridge to allow communication between Java and IRIS classes);
2. The iris-json-schema-1.0.0.jar has the Java classes and libraries (including json-schema-validator) to service JSON Schema validations;
3. The JSONSchemaValidator.cls has the ObjectScript code to use the Java class and do JSON validations using JSON schema by the validation rules;
4. The Dockerfile and docker-compose.yml run the Java Gateway and the IRIS as docker instances.
The Java Class has a validation method, which uses the framework json-schema-validator to validate the JSON Schema and the JSON, and to return the validation results. See the Java Code:
Java Class for JSON Schema Validation
package dc.irisjsonschema;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Set;
import java.util.stream.Collectors;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.networknt.schema.JsonSchema;
import com.networknt.schema.JsonSchemaFactory;
import com.networknt.schema.SpecVersion;
import com.networknt.schema.ValidationMessage;
public class JSONSchemaService {
public String validate(String jsonSchemaContent, String jsonContent) {
// create instance of the ObjectMapper class
ObjectMapper objectMapper = new ObjectMapper();
// create an instance of the JsonSchemaFactory using version flag
JsonSchemaFactory schemaFactory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909);
try {
// read data from the stream and store it into JsonNode
JsonNode json = objectMapper.readTree(jsonContent);
// get schema from the schemaStream and store it into JsonSchema
JsonSchema schema = schemaFactory.getSchema(jsonSchemaContent);
// create set of validation message and store result in it
Set<ValidationMessage> validationResult = schema.validate(json);
if(validationResult.isEmpty()) {
return "{\"message\": \"JSON is valid\", \"valid\":true}";
} else {
return "{\"message\": \"" +
validationResult.toString() + "\", \"valid\":false}";
}
} catch (JsonProcessingException e) {
return e.getMessage();
}
}
}
The InterSystems IRIS uses this Java validation method to validate JSON content. To do that it is necessary to create a JAR file with the validate class inside (iris-json-schema-1.0.0.jar) and to configure a Java Gateway (bridge between Java and IRIS communication), allowing ObjectScript to call the Java methods.The ObjectScript code which uses the Java Class and the JSONSchemaValidator class is presented here:
Final Java Class read to Validate JSON inside IRIS
/// Validate JSON documents using JSON Schema documents
Class dc.irisjsonschema.JSONSchemaValidator
{
/// Get json and json schema em return validation results
ClassMethod Validate(JSONSchemaContent As %String, JSONContent As %String, Output ValidationResult As %String) As %Status
{
Set sc = $$$OK
// Connect a Gateway instance to server JavaGateway on the host machine
set GW = ##class(%Net.Remote.Gateway).%New()
set st = GW.%Connect("jgw", "55555", "IRISAPP",,)
//instantiate java class
set JSONSchemaValidator = ##class(%Net.Remote.Object).%New(GW,"dc.irisjsonschema.JSONSchemaService")
//validate the JSON using a JSON Schema
set ValidationResult = JSONSchemaValidator.validate(JSONSchemaContent, JSONContent)
Write ValidationResult
Return sc
}
With this ObjectScript class and the Validate class method, it is possible to use any JSON content and any JSON Schema definition to validate basic and advanced validation rules.To see this, execute these steps:
1. Go to https://openexchange.intersystems.com/package/IRIS-JSON-Schema-Validator
2. Git-clone the repository into any local directory
$ git clone https://github.com/yurimarx/iris-json-schema.git
3. Open the terminal in this directory and run it:
$ docker-compose build
4. Run the IRIS container with your project:
$ docker-compose up
5. Go to the IRIS terminal (open a new VSCode Terminal)
docker exec -it iris-json-schema_iris_1 bash iris session iris
6. Change to the IRISAPP namespace
set $namespace = "IRISAPP"
7. Get a sample JSON Schema
set jsonSchema = ##class(dc.irisjsonschema.JSONSchemaValidator).GetJSONSchema()
8. Get a sample valid JSON
set jsonContent = ##class(dc.irisjsonschema.JSONSchemaValidator).GetValidSampleJSON()
9. Get a validation equals to valid
set st = ##class(dc.irisjsonschema.JSONSchemaValidator).Validate(jsonSchema,jsonContent,.result)
write result
10. Now, get a sample INVALID JSON
set jsonContent = ##class(dc.irisjsonschema.JSONSchemaValidator).GetInvalidSampleJSON()
11. After that, get validation equals to INVALID
set st = ##class(dc.irisjsonschema.JSONSchemaValidator).Validate(jsonSchema,jsonContent,.result)
write result
12. The JSON Schema used was:
JSON Schema used to define the validation rules
{ "$schema": "https://json-schema.org/draft/2019-09/schema#", "type": "object", "title": "Movie art", "description": "Information about actors", "additionalProperties": true, "required": [ "name", "artist", "description", "tags" ], "properties": { "name": { "type": "string", "description": "Painting name" }, "artist": { "type": "string", "maxLength": 50, "description": "Name of the artist" }, "description": { "type": [ "string", "null" ], "description": "Painting description" }, "tags": { "type": "array", "items": { "$ref": "#/$defs/tag" } } }, "$defs": { "tag": { "type": "string", "enum": [ "action", "suspense", "UK", "famous", "license", "kill" ] } }}
This JSON Schema configured the fields and the tags array with limited values (enum) as required.
The types of the JSON fields are defined too. So, for this schema the following JSON Object is valid:
set obj = {}set obj.name = "Agent 007"set obj.artist = "Pierce Brosman"set obj.description = "007 actor"set tags = ["license","kill"]set obj.tags = tags
All properties use the right data type and the tags use values inside values allowed in the Schema for this array. Now, see a JSON Object invalid:
set obj = {}set obj.name = "Agent 007"set obj.artist = "Pierce Brosman"set obj.description = 1set tags = []set tags."0" = "license" set tags."1" = "love"set obj.tags = tags
This object sets an integer property to a description (the valid type is string) and sets the value “love”, out of valid values allowed to array tags.The site https://json-schema.org/ has tools, samples and learning resources to learn on how to validate and write advanced validation rules using JSON Schema.
