EasyGraph developer Manual

Create workspace

To create your own workspace click button on the left and enter name and description of your workspace.

Add scenarios and requests

In a new workspace click the ADD SCENARIO button to add first scenario. button to add your first scenario. In the dialog enter a name and a description and then click the ADD button. This will create a new scenario which will show under the Scenarios tab. To add more scenarios click the button.

To add a first request to a scenario, select the required scenario, then click the button in the center of the Scenario Details screen. From the menu select the type of request you want to create.

Create request

A create request is used to create new resources. Once you add a create request you can build the payload of the request using the Build tab. Click the Build tab and then ADD TYPE BLOCK. In the newly added block select the type of resource you want to create. Based on the type a form is displayed as in the example below. By default all the mandatory fields are added to the form. You can add other fields by clicking ADD in the property block.

To generate mock data you can click MOCK ALL. This will generate random values for all the fields in the form. To configure the strategy for mock value generation please refer to the section on Mock setup.

You can also use the Request tab to manually enter the body of the request. Note that if you have used the builder the request body is generated from it.

Note that in type selection some of the types might be disabled as shown in the screenshot below. This is due to the ID Setup as configured in the Bootstrap application.

Search request

A search request is used to search resources in a graph. You can build a search request using the tools in the Build tab.

Filters

Under this tab you can build the query parameters used in a search. Click on ADD FILTER to add a block. In the Property field select the name of the property from the list or type a few characters to find a property. Once a property is selected then, depending on the type of property, a list of operators may be shown. Depending on which operator you select a Value field, Language Field and Object Field might be shown.

With the Text Search block you can specify the criteria for text search. You can select multiple properties to perform text search across. If you want to perform text search against all properties then leave this option empty. You can also specify the language for text search using the Language field. To add another value for text search click the ADD button. If you want to search multiple text values you can click ADD to add more value fields.

Search allows you to filter resources by specifying constraints on connected resources. Connected resources are resources connected via an object property. Using the builder you can easily build a query using the Matches operator. For example, let us say we want to build a query to find all organisations where its members have an image with width 100. Below are the steps to build such a query.

• Click on ADD FILTER to add a block and select type in the Property field, eq in the Operator field and Organisation in the Value field. Your filters tab should look as below
• Click on ADD FILTER again to add a block and select member in the Property field and Matches in the Operator field. When you select the Matches operator you should see that a nested block is displayed. In the Property list of the nested block you will see a list of all the properties that are related to the ImageObject class. Select width in the Property field, eq in the Operator field and type 100 in the Value field. Your filters screen should look as below.
• This is all you need to do to build the query mentioned above. To view the query click on the Request tab where you will see the query parameter value. It should look as shown in the shot below.

Data

Using this tab you can build a Prefer header to specify the data that you want in the response. For example, let us say we want search to return both member and image data. You can build the request as below.

• Click on the Data tab. You should be presented with a screen similar to that shown below.
• Click on ADD CONNECTION to add a block and select member in the Connection Property field. This should load a nested block. Click on ADD CONNECTION in the nested block and in the nested Connection Property field select image. Your screen should look as below.
• This is all you need to do to build the header. To view the header click on the Request tab where you will see the Prefer header value. It should look as shown in the shot below.

If you want a search response to return only specific properties you can select the 'Selected Properties' option in the Data Filter block. For example, you may want a search result to return description and name for organisations, any givenName property for member objects connected to any organisation as well as height and width properties from any ImageObject connected to a member. You can build the request as below.

• Click on the "Selected Properties" option in the Data Filter block.
• In the Search Results block and within the Properties field type "des" and from the presented options select description. Then type "na" and select the name option. Your screen should look as below.
• Click on the ADD CONNECTION button in the Connected block. In the Connection Property field select member. This should display a nested block with a Properties field. Select givenName and click on the ADD CONNECTION button in the nested block. This should add another nested block. In the newly added block select image in the Connected Property field and select both the height and width properties. Your screen should look as below.
• To view the header click on the Request tab where you will see a Prefer header value. It should look as shown in the shot below.

Facet

Using this tab you can build facet parameters for a search. For example, let us say that with our previous search request we also want to facet on the organisation, description and member properties. You can build the request as below.

• Click on the Facet tab. You should be presented with a screen as shown below.
• Click on ADD Property to add a block and select description in the Property field.
• Click on ADD Property to add another block and select memeber in the Property field. This should display a field allowing you to select the Label Property. Select givenName. Your screen should look as below.
• This is all you need to do to build facet parameters. To view the parameters click on the Request tab where you will see the facet parameter value. It should look as shown in the shot below.

Sort

Using this tab you can build the sortBy parameter for search results sorting. The steps to build this parameter are the same as described in the above sections.

Paging Counting

Using this tab you can specify the page, pageSize and countUpto parameters for a search. For each of these parameters there is a field under the Paging Counting tab as shown below. Simply enter the values for these fields. You can view the request parameters under the Request tab.

Language

Using this tab you can specify the lang parameter for a search. If you start typing the language code autocomplete will show any matching codes. If you want to enter a language code other than those in the options list you can type the code and click "Add". You can view the lang parameter under the Request tab.

Conditional GET

Using this tab you can specify the If-None-Match header and add a Prefer header to get etags for search results. If you add these headers you can view them under the Request tab.

Variables builder

To build scenarios for Search, Update, Delete and Batch you might want to use some values from previous request responses within a scenario. For example, in an update request you need to specify the eTag of the resource being updated. As eTags are returned in a response body a mechanism is required to store the value in a variable and then refer to these variables in subsequent requests. This can be done by setting variables under the Response tab. In the image below you can see two blocks at the end to set variables from a response body or a response header. Note that to set variables you need to run the request first.

Set a variable from a response header

To store a value of an eTag header in a variable first execute the request then click SET ETAG FROM HEADER. This will populate the Header Name and Preview Value fields. You need to enter a Variable Name that will be used to store the value. After typing the variable name you can then save the request.

Set variable from response body

Similarly to setting variables from a response header, you can also set them from a response body. Click ADD and enter a Variable Name and a JSON Path. You will be able to see the current value for the JSON Path in the Preview Value field. After adding a variable remember to save the request otherwise you will lose any changes if you load another workspace or refresh the page.

Using variables

To use a variable in a request body enclose the variable name in double curly braces {{variable name}} as shown below.

You can also use variables in the builders. In the below screenshot the If None Match field value is a variable.

To preview the substituted value you can select 'Preview with Global Variables Substitution' under the Request tab as shown in the screenshot below.

Import and export

As an API developer you might want to create examples to share with API users. The Playground allows you to export workspace and scenarios.

To export a workspace open it and click . This should download the workspace to your system.

To export a scenario select it and click .

To import a workspace click . This will open the import dialog. Click BROWSE FILES or drag and drop a workspace file on to the appropriate area of the screen. The screenshot below shows the Select File step with a selected file.

Click NEXT to Preview the name and description of a workspace, along with its scenarios and requests. The screenshot below shows the Preview screen.

Click NEXT. This will show the Import Successful message.

Click FINISH to go to the Playground dashboard, where the newly imported workspace will show up.

Scenarios can be only imported into a workspace. Therefore, to import scenarios first open a workspace and then click the Import button. This will open a dialog similar to workspace import. Note that you can import multiple scenarios.

Mock setup

Under the Mock Setup tab within a workspace you can control how mock data is generated for datatype properties. To change the default regular expression (regex) click the button in the appropriate property card. This will display a dialog where you can change the regex and test the values generated by it.

GraphQL

When you switch to GraphQL mode the Request tab shows the GraphQL query and variables editor. If you have built the request using the Build tab then, depending on the type of request, the GraphQL query is autogenerated and can be viewed under the Request tab. If you wish to manually create a query you can type it in the query block and specify any variables in the variables block.

If you execute a GraphQL request the Response tab shows the result of the request.

Create schema

To get started click Schema Builder in the dashboard. Your screen should look as below.

Click the Add New Schema button and fill in the form as shown below.

Name : Give your schema a name.

Namespace Prefix : A prefix is a short name for the base IRI. EasyGraph uses prefixes when there are conflicts in generating property and class names for IRIs. For more details see prefixes

Base IRI : The base IRI is used to generate IRIs for properties and classes defined in the schema.

Description : A description for your schema.

Click the Add button to create a new schema. Your screen should look as shown below.

To view/edit schema details you can click on schema name.

To view all the schemas click on the icon in the menu on the left.

Add a class

In the new schema click Add Class to add the first class. In the dialog enter a name and, if desired, a description and then click Add. This will create a new class which will show under the Classes tab. To add more classes click .

Delete a class

To delete a class click Delete button in the class details.

Graph view

Using graph view you can view the class hierarchy and how classes are connected to other classes through properties. To open the graph view click on the top right hand side of the screen.

To view details of any class click on the node in graph view.

To reset the graph click . For other options click the button. The screenshot below shows all the options.

To go back to the form view click on the top right of the screen.

Add subclass

Schema builder allows you to create a class hierarchy. To create a subclass hover over the class node and click as shown below.

This will open a dialog with options to create a new subclass or to choose an existing class to use as a subclass.

To create a new class as a subclass select the Create New Class option as shown below. Enter a name and, optionally, a description of the class and click the Add button. To add multiple subclasses you can click Multiple. This will add the class and keep the dialog open to add additional subclasses.

A subclass inherits properties from its super classes. To view all the inherited properties you can turn on the Inherited Properties switch.

To remove the relationship between a subclass and its superclass, hover over the subclass node and click . You can also remove the relationship by clicking on the delete button on the chip in the Hierarchy tab.

Note that in graph view you can hover over the edge connecting a subclass and its superclass and this will show the remove icon button.

Add property

To add a property to a class click Add in the properties block on the right of the screen. In the dialog enter a name and, optionally, a description for the property. In the Property Type field select a type for the property.

Property type

Object

Object properties allow you to connect data of different types. For example, if you have a Person class and an Image class, then you can define an Object type property to link images to a person.

List

List allows you to create ordered lists. This uses rdf:List under the covers.

Datatype

Use a datatype property for other class attributes.

Literal

If you do not want to define a datatype you can choose literal as the property type. This means that the value of this property can be a language tagged string, a string or a value with a datatype.

For example, if you want to add a givenName property to the Person class, enter "givenName" in the name field and select "String" in the property type field. Click the Add button. Your screen should look as below.

To remove a property from a class click the button in that property. Note that this will only remove the property from the selected class. If you want to delete a property from all the classes it is used on see the Delete Property section.

You can view a list of all the properties under the Properties tab as shown below.

To create a new property click the button and enter details in the dialog. The same property can be used in multiple classes.

To view property details click on the property. From the property details on the right you can change the property type and any inverse property.

Delete property

To delete a property click in the property details.

Property constraints

Depending on the type of the property, constraints can be defined for that property as used on that class. Any API request not satisfying the constraints as defined on the property will be rejected.

Inverse property

For object type properties an inverse property can be defined. For more details how inverse properties work in EasyGraph see Inverse.

Import and export

You can export a schema by clicking the button. An exported schema can be imported into another schema or in the schema dashboard.

To import a schema into another schema first open the schema in which you want to import your schema. Then click the button in the left menu. This will open an import dialog. Click the Browse File button or drag and drop a schema file onto the appropriate area of the screen. The screenshot below shows the Select File step with a selected file. .

Click Next to preview the name and description of schema along with its classes and properties. The screenshot below shows the Preview screen.

To preview existing classes or properties along with the imported classes and properties click .

Click Next. This will show an Import Successful message. Click FINISH and you should see the newly imported classes and properties.

To import a schema as a new schema click the button in the left menu on the schema dashboard. The rest of the steps are the same as explained above. Once imported you will see the newly imported schema in the schema dashboard

Bootstrap with schema

For details on bootstrap please see Bootstrap

To bootstrap an API with a schema select the schema in the Load Model step of the bootstrap.

Once you have selected your schema you will see the name and description of the selected schema as shown below.

Click Next and complete the rest of the steps as described in the bootstrap section.

HTTP API

Prefer : return=representation;data="{description}";dataFilter=paths
                

Prefer : return=representation;data="{member}"
                

Prefer : return=representation;data="{ description  name  member { givenName  image { height  width }}}";dataFilter=paths
                

Prefer : return=representation;data="{ member { image } }"
                

{
    "id": "http://example.com/organisation/12ee6359-5056-4ecb-ade2-adde0c84f940",
    "description": null,
    "member": null,
    "slogan": null,
    "egETag": "W/\"1589628122689\""
}
            

"description": {
    "es": [
        "Hola mundo",
        "Hola  prueba"
    ],
    "fr": "Bonjour tester"
}
            

"description": {
    "es": [
        "Hola mundo",
        "Hola  prueba"
    ],
    "en": "Hello test"
}
            

GraphQL server

EasyGraph automatically generates GraphQL schema and GraphQL spec compliant server endpoint is made available at {base-url}/graphql.

query search($query: String!,
  $page: Int = 1,
  $pageSize: Int = 10,
  $countUpto: Int = 10,
  $sortBy: String!,
  $lang: String!,
  $facet: String!,
  $labelPropertyLang: String!) {
      search(query: $query,
        page: $page,
        pageSize: $pageSize,
        countUpto: $countUpto,
        sortBy: $sortBy,
        lang: $lang) @hint(queryType: PATHS) {
            egHasNextPage
            egHasMoreToCount
            egTotalCount
            egFacets(query: $facet, labelPropertyLang: $labelPropertyLang) {
              egFacetLabel
              egFacetResults {
                egFacetValue {
                  type
                  value
                }
                egFacetValueCount
                egFacetValueLabel {
                  lang
                  value
                }
              }
            }

      }
}
    

    {
        "query": "{  member{   image } }",
        "facet": "{ givenName }",
        "sortBy": "{ givenName }",
        "page": "2",
        "pageSize": "2",
        "countUpto": "100",
        "lang": "fr"
    }
                    

{
  search(query: "{  type(eq:[\"Organisation\"] ) }") {
    egHasNextPage
    egHasMoreToCount
    egTotalCount
    egResults {
      __typename
      ... on Organisation {
        id
        type
        egETag
        description {
          lang
          value
        }
        member {
          id
          egETag
          givenName
        }
      }
    }
  }
}
                

"description": {
    "en": [
        "Hello world",
        "Hello test"
    ],
    "fr": "Bonjour tester"
}
                

"description": [
    {
        "lang": "en",
        "value": "Hello world"
    },
    {
        "lang": "en",
        "value": "Hello test"
    },
    {
        "lang": "fr",
        "value": "Bonjour tester"
    }
]
                

          {
            search(query: "{  type(eq:[\"Person\" \"Organisation\" \"ImageObject\"] ) }")  {
              egHasNextPage
              egHasMoreToCount
              egTotalCount
              egResults {
                __typename
                ... on Person {
                  id
                }
                ... on Organisation {
                  id
                }
                ... on ImageObject {
                  id
                }
              }
            }
          }
                        

query IntrospectionQuery {
  __schema {
    types {
      kind
      name
      description
    }
  }
}
        

{
  leftSearch : search(query:"{  givenName(eq:[\"Left Org Member\"] ) }") {
    egResults {
      ... personFields
    }
  }
  rightSearch : search(query:"{  givenName(eq:[\"Right Org Member\"] ) }") {
    egResults {
      ... personFields
    }
  }
}

fragment personFields on Person {
  id
  givenName
}
            

{
  "data": {
    "leftSearch": {
      "egResults": []
    },
    "rightSearch": {
      "egResults": []
    }
  }
}

{
  "errors": [
    {
      "message": "reason : 'FORBIDDEN' httpStatusCode : '403'",
      "extensions": {
        "id": "_:node1e82c5uqnx8120",
        "type": "EgApiError",
        "rdfsLabel": {
          "lang": "en",
          "value": "UUID values [da2bfd55-d616-4d7d-941a-2787d3e0f093, 35334a2d-10d1-4cba-833e-fcef9c6d7cb6, 367a6c56-9255-4d06-852a-47e492b5f5ff] are already used for other resources."
        }
      }
    }
  ]
}
            

Batch API

Batch API allows you to perform create, update and delete in one HTTP API call. Depending on the feature of underlying database used with EasyGraph this means that entire operation can be executed in one transaction. For examples see requests under 'Batch API features' in autogenerated workspace.

In GraphQL, Batch API equivalent is to send multiple mutation operations in one call. For examples change the request mode to GraphQL for requests under 'Batch API features' in autogenerated workspace.

API activity

For each API call for create, update and delete EasyGraph records what IRI's has been changed in a resource of type EgApiActivity. Below are the properties which are added to EgApiActivity

• egStartedAtTime This property records server side activity start time.
• egGenerated This property records IRI's of the newly created resources.
• egUsed This property records IRI's of the updated resources.
• egInvalidated This property records IRI's of the deleted resources.

For examples see requests under scenario 'Activities' in autogenerated workspace.

Admin API

EasyGraph admin API can be used to perform API admin functions programmatically.

Bootstrap From Ontology

API Endpoint to bootstrap EasyGraph from ontology is {base-url}/administration/ontology/bootstrap

Body of the request should be multipart request with below request parameter.

• baseIRIForData This is same as Base IRI of Data field in Bootstrap Application.
• baseIRIForSchema This is same as Base IRI of Schema field in Bootstrap Application.
• defaultLanguageCode This is same as Default Language field in Bootstrap Application.Value of this parameter should be valid language code.
• enableDataReset This is same as Enable Data Reset field in Bootstrap Application. If you want to enable data reset specify value "YES" otherwise do not specify this parameter value.
• idSetup Allowed values for this parameter are "readOnly" to setup read only API and "lowestClasses" to setup id generation with lowest classes in the hierarchy.
• inverses To exclude inverse property IRIs from materialisation specify "exclude" as value of this parameter.
• inversePropertiesList This parameter is used in combination with parameter "inverses". For example if value "exclude" is specified for parameter inverse then you can specify a comma separated list of property IRIs for this parameter.

Below is the curl example to bootstrap with example ontology. Please replace value of JWT_TOKEN and PATH_TO_FILE before running the request.

curl --request POST 'http://localhost:9982/TestDataset/administration/ontology/bootstrap' --header 'Authorization: Bearer {JWT_TOKEN}' --form 'files=@"{PATH_TO_FILE}/example-ontology.ttl"' --form 'baseIRIForData=http://example.com/data/' --form 'baseIRIForSchema=http://example.com/schema/' --form 'defaultLanguageCode=en' --form 'enableDataReset=YES' --form 'idSetup=lowestClasses'

Or if you use Postman below is how the request looks like in Postman. Please note you will need to add Authorization header with value "Bearer {JWT_TOKEN}" under the header tab.

curl --request POST 'http://localhost:9982/TestDataset/administration/ontology/bootstrap' --header 'Authorization: Bearer {JWT_TOKEN}' --form 'files=@"{PATH_TO_FILE}/example-ontology.ttl"' --form 'existingConfiguration=merge-classes-in-payload-leave-other'

curl 'http://localhost:9982/TestDataset/administration/configuration' \
  -X 'PUT' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"id":"https://easygraph.graphifi.com/data/role/d5e41983-1b36-4e82-88ee-fcb9154018ba","type":["EgRole"],"egLabel":"TestRole","egDescription":"","@context":"http://localhost:9982/egContext/eg-v1.jsonld"}'

curl 'http://localhost:9982/TestDataset/administration/configuration' \
  -X 'PUT' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"id":"https://easygraph.graphifi.com/data/role/d5e41983-1b36-4e82-88ee-fcb9154018ba","type":"EgRole","egDescription":"","egIsConfigurationResourceOf":"https://easygraph.graphifi.com/data/api-configuration/9615d3a3-d0f4-49ac-8ffa-138fe699ab11","egLabel":"TestRole","egAssignedTo":["https://easygraph.graphifi.com/data/user/1ddcdde6-14dd-4ed2-91fd-ec4dd2812e4d"],"@context":"http://localhost:9982/egContext/eg-v1.jsonld"}'

curl 'http://localhost:9982/egmManagement/dataset?' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"@context":"http://localhost:9982/egmManagement/egContext/api.jsonld","type":"Dataset","label":"DatasetLabel","description":"Dataset description."}'

curl 'http://localhost:9982/egmManagement/dataset/search?' \
  -H 'Authorization: Bearer {JWT_TOKEN}'

curl 'http://localhost:9982/egmManagement/dataset' \
  -X 'PATCH' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"@context":"http://localhost:9982/egContext/eg-v1.jsonld","id":"https://easygraph.graphifi.com/data/dataset/bcbc0ada-fac0-4305-912d-d8db5d3ad6d7","egETag":"W/\"1619430452161\"","description":"Description"}'

curl 'http://localhost:9982/egmManagement/dataset' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"@context":"http://localhost:9982/egContext/eg-v1.jsonld","id":"https://easygraph.graphifi.com/data/dataset/bcbc0ada-fac0-4305-912d-d8db5d3ad6d7","egETag":"W/\"1619430452161\""}'

curl 'http://localhost:9982/egmManagement/user?' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"type":["User"],"username":"TestUser","password":"TestUser1$","description":"A test user.","@context":"http://localhost:9982/egmManagement/egContext/api.jsonld"}'

curl 'http://localhost:9982/egmManagement/user?' \
  -X 'PATCH' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"@context":"http://localhost:9982/egmManagement/egContext/api.jsonld","id":"https://easygraph.graphifi.com/data/user/1ddcdde6-14dd-4ed2-91fd-ec4dd2812e4d","egETag":"W/\"1619430944595\"","canView":["https://easygraph.graphifi.com/data/dataset/edef38cd-751f-4def-8d2f-e7d86957f6c5"]}'

curl 'http://localhost:9982/egmManagement/user?' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {JWT_TOKEN}' \
  -H 'Content-Type: application/ld+json' \
  --data-raw '{"@context":"http://localhost:9982/egmManagement/egContext/api.jsonld","id":"https://easygraph.graphifi.com/data/user/1ddcdde6-14dd-4ed2-91fd-ec4dd2812e4d","egETag":"W/\"1619430944595\""}'

SHACL validation

For both create and update requests, resources are validated to check if there is any SHACL constraint violation. If create/update request violates any constraint defined in SHACL shape then request is rejected and SHACL report is returned in the response.

Conditional GET

With Conditional Requests you can specify eTag as If-None-Match header value for search and result is returned only if server side eTag value is different. This is very useful for caching. Scenario 'Search and conditional GET' in autogenerated workspace has examples for it.

Text search

Behaviour of the text search depends on the features provided by backend database. If the underlying database does not support text search then SPARQL regex function is used. Note that depending on the size of the database text search performance can with SPARQL regex can be very slow.

DB specific optimisations

EasyGraph can be easily configured to work with any triple-store which provides SPARQL HTTP endpoint. We have also implemented some custom repository connectors for StarDog, MarkLogic, Fuseki and GraphDB and it is very easy to customise the repository layer to utilise db specific optimisations. For more details please get in touch with us.

OWL to SHACL

Below are the main points about how SHACL shapes are generated from OWL.

• owl:cardinality is mapped to sh:minCount and sh:maxCount
• owl:minCardinality is mapped to sh:minCount
• owl:maxCardinality is mapped to sh:maxCount
• For range of property is xsd:boolean then it is mapped to sh:maxCount with value 1
• owl:FunctionalProperty is mapped to sh:maxCount with value 1
• If owl:Restriction is defined with owl:someValuesFrom then sh:minCount with value 1 is added to shape
• if no rdfs:range and no owl:Restriction is defined for datatype property then it is mapped to sh:nodeKind of type sh:Literal
• if single type is defined rdfs:range but no owl:Restriction is defined for datatype property then rdfs:range is mapped to sh:datatype with type of rdfs:range
• if no rdfs:range and no owl:Restriction is defined on type for object property then it is mapped to sh:nodeKind of type sh:IRI
• if single type is defined for rdfs:range but no owl:Restriction is defined for object property then rdfs:range type is mapped to sh:class with type of rdfs:range
• if multiple types are defined for rdfs:range usind owl:unionOf but no owl:Restriction is defined on type for object property then types from owl:unionOf are mapped to sh:or types
• if a class is defined with owl:Restriction on datatype property with a single type for owl:allValuesFrom then owl:allValuesFrom value is added to sh:datatype
• if a class is defined with owl:Restriction on object property with a single type for owl:allValuesFrom then owl:allValuesFrom type is added to sh:class
• if a class is defined with owl:Restriction on object property with a multiple types for owl:allValuesFrom through owl:unionOf then owl:allValuesFrom types are added to sh:or

Assumptions

This section gives details about assumptions and some of the limitations.

Download

Go to https://easygraph.graphifi.com

To sign up click on the SIGN UP button and fill the sign up form. Once you have signed up you can can login using your username and password.

If you want to use your LinkedIn account, you must accept the Terms and Conditions. This will enable the SIGN IN WITH LINKEDIN button. Click on it to complete the login process.

Once logged in select 'Download' option and download EasyGraph by clicking the DOWNLOAD EASYGRAPH button.

RDF4J native store

EasyGraph package comes with RDF4J native store. To start EasyGraph with RDF4J native store follow the steps below

• Download the zip file.
• Unzip the file.
• Change directory to the root of unzipped directory. You should see below files/directories

  README.txt              conf                    data                    easygraph.jar           run-easygraph.bat       run-easygraph.sh

• If you are on OSX/Linux platform, edit conf/setenv.sh uncomment line to set EG_JWT_SECRET env variable and set its value. If you do not set this value a random key will be used everytime you start the instance.
• If you are on Windows platform, edit conf/setenv.bat uncomment line to set EG_JWT_SECRET env variable and set its value. If you do not set this value a random key will be used everytime you start the instance.
• If you are on OSX/Linux platform, run run-easygraph.sh from terminal. Your screen should look as below
• If you are on Windows platform, run run-easygraph.bat from command prompt. Your screen should look as below
• When you see Tomcat started on port(s): 9982 message, open your browser and paste the URL http://localhost:9982/. Default login username is root and password is Password1$

Once you have EasyGraph running follow the steps in Bootstrap

Stardog

EasyGraph can be configured to store data in Stardog. Below are the steps to run EasyGraph with Stardog.

• Run all the steps mentioned in RDF4J native store section and make sure EasyGraph starts up without any error.
• Create a database named "egData" and create another database named "egmManagement". For both databases ensure that property "Query All Graphs" is checked. Below is the screen shot of StarDog studio to set this property.

  Shot below shows old version of StarDog webconsole.

  
• If you are on OSX/Linux platform, edit conf/setenv.sh and add/update env variables exports as shown below.

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=stardog_triplestore
  export DB_SERVER_REPOSITORY_AUTOCREATE=false
  export MANAGEMENT_DB_IMPLEMENTATION=stardog_triplestore
  export MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  export SPRING_PROFILES_ACTIVE=stardog_triplestore
  
  export DB_SERVER_URL=http://localhost:5820/
  export DB_SERVER_REPOSITORYID=egData
  export DB_USERNAME=admin
  export DB_PASSWORD=admin
  
  export MANAGEMENT_DB_SERVER_URL=http://localhost:5820/
  export MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  export MANAGEMENT_DB_USERNAME=admin
  export MANAGEMENT_DB_PASSWORD=admin
  
  

• If you are on Windows platform, edit conf/setenv.bat and add/update env variables exports as shown below.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=stardog_triplestore
  set DB_SERVER_REPOSITORY_AUTOCREATE=false
  set MANAGEMENT_DB_IMPLEMENTATION=stardog_triplestore
  set MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  set SPRING_PROFILES_ACTIVE=stardog_triplestore
  
  set DB_SERVER_URL=http://localhost:5820/
  set DB_SERVER_REPOSITORYID=egData
  set DB_USERNAME=admin
  set DB_PASSWORD=admin
  
  set MANAGEMENT_DB_SERVER_URL=http://localhost:5820/
  set MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  set MANAGEMENT_DB_USERNAME=admin
  set MANAGEMENT_DB_PASSWORD=admin
  

• Start EasyGraph.

Once you have EasyGraph running follow the steps in Bootstrap

MarkLogic

EasyGraph can be configured to store data in MarkLogic. Below are the steps to setup EasyGraph with MarkLogic.

• Run all the steps mentioned in RDF4J native store section and make sure EasyGraph starts up without any error.
• Next we need to setup database and http server in MarkLogic. For our example setup we are going to use ml-gradle. To setup ml-gradle visit https://github.com/marklogic-community/ml-gradle/wiki/Getting-started .
• Run gradle mlNewProject to create new project. For "Application name" use "egData" and for "REST API port (leave blank for no REST API server)" use 8251. On success you should have gradle.properties file as shown below

  mlAppName=egData
  mlHost=localhost
  mlUsername=admin
  mlPassword=admin
  mlRestPort=8251
  

• Run gradle mlDeploy. This action should create HTTP server, Databases and forests in MarkLogic.
• Repeat above steps again but use "egmManagement" for Application name and 8252 for REST PORT.
• Change directory to where you have unzipped EasyGraph.
• If you are on OSX/Linux platform, edit conf/setenv.sh and add/update env variables exports as shown below.

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=marklogic_triplestore
  export DB_SERVER_REPOSITORY_AUTOCREATE=false
  export MANAGEMENT_DB_IMPLEMENTATION=marklogic_triplestore
  export MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  export SPRING_PROFILES_ACTIVE=marklogic_triplestore
  
  export DB_SERVER_HOST=localhost
  export DB_SERVER_PORT=8251
  export DB_USERNAME=admin
  export DB_PASSWORD=admin
  
  export MANAGEMENT_DB_SERVER_HOST=localhost
  export MANAGEMENT_DB_SERVER_PORT=8252
  export MANAGEMENT_DB_USERNAME=admin
  export MANAGEMENT_DB_PASSWORD=admin
  

• If you are on Windows platform, edit conf/setenv.bat and add/update env variables exports as shown below.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=marklogic_triplestore
  set DB_SERVER_REPOSITORY_AUTOCREATE=false
  set MANAGEMENT_DB_IMPLEMENTATION=marklogic_triplestore
  set MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  set SPRING_PROFILES_ACTIVE=marklogic_triplestore
  
  set DB_SERVER_HOST=localhost
  set DB_SERVER_PORT=8251
  set DB_USERNAME=admin
  set DB_PASSWORD=admin
  
  set MANAGEMENT_DB_SERVER_HOST=localhost
  set MANAGEMENT_DB_SERVER_PORT=8252
  set MANAGEMENT_DB_USERNAME=admin
  set MANAGEMENT_DB_PASSWORD=admin
  

• Start EasyGraph.

Once you have EasyGraph running follow the steps in Bootstrap

Apache Jena Fuseki

EasyGraph can be configured to store data in Fuseki. Below are the steps to run EasyGraph with Fuseki.

• Run all the steps mentioned in RDF4J native store section and make sure EasyGraph starts up without any error.
• Start Fuseki with flag tdb:unionDefaultGraph=true. Below is the full command and for more details see https://jena.apache.org/documentation/tdb/configuration.html

  ./fuseki-server --set tdb:unionDefaultGraph=true

• If you are on OSX/Linux platform, edit conf/setenv.sh and add/update env variables exports as shown below.

  export EG_MULTIPLE_DATASETS=true
  export DB_IMPLEMENTATION=fuseki_triplestore_multiuser
  export MANAGEMENT_DB_IMPLEMENTATION=fuseki_triplestore
  export SPRING_PROFILES_ACTIVE=fuseki_triplestore_multiuser
  
  export DB_SERVER_URL=http://localhost:3030/
  export DB_SERVER_REPOSITORYID=egData
  
  export MANAGEMENT_DB_SERVER_URL=http://localhost:3030/
  export MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  
  

  To run in single dataset mode add/update env variables exports as shown below.

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=fuseki_triplestore
  export MANAGEMENT_DB_IMPLEMENTATION=fuseki_triplestore
  export SPRING_PROFILES_ACTIVE=fuseki_triplestore
  
  export DB_SERVER_URL=http://localhost:3030/
  export DB_SERVER_REPOSITORYID=egData
  
  export MANAGEMENT_DB_SERVER_URL=http://localhost:3030/
  export MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  
  

• If you are on Windows platform, edit conf/setenv.bat and add/update env variables exports as shown below.

  set DB_IMPLEMENTATION=fuseki_triplestore_multiuser
  set MANAGEMENT_DB_IMPLEMENTATION=fuseki_triplestore
  set SPRING_PROFILES_ACTIVE=fuseki_triplestore_multiuser
  
  set DB_SERVER_URL=http://localhost:3030/
  set DB_SERVER_REPOSITORYID=egData
  
  set MANAGEMENT_DB_SERVER_URL=http://localhost:3030/
  set MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  

  To run in single dataset mode add/update env variables exports as shown below.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=fuseki_triplestore
  set MANAGEMENT_DB_IMPLEMENTATION=fuseki_triplestore
  set SPRING_PROFILES_ACTIVE=fuseki_triplestore
  
  set DB_SERVER_URL=http://localhost:3030/
  set DB_SERVER_REPOSITORYID=egData
  
  set MANAGEMENT_DB_SERVER_URL=http://localhost:3030/
  set MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  
  

• Start EasyGraph.

Once you have EasyGraph running follow the steps in Bootstrap

GraphDB

EasyGraph can be configured to store data in GraphDB. Below are the steps to run EasyGraph with GraphDB.

• Run all the steps mentioned in RDF4J native store section and make sure EasyGraph starts up without any error.
• Start GraphDB and create a new repository. In "Repository ID" field enter "egData", in the "Repository title" field enter "egData". In the "Ruleset" field select "No inference". Enable context index by selecting "Use context index" checkbox and click create button to create the repository.
• Create another repository and In "Repository ID" field enter "egmManagement", in the "Repository title" field enter "egmManagement". In the "Ruleset" field select "No inference". Enable context index by selecting "Use context index" checkbox and click create button to create the repository.
• If you are on OSX/Linux platform, edit conf/setenv.sh and add/update env variables exports as shown below.

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=sparql_http_triplestore
  export DB_SERVER_REPOSITORY_AUTOCREATE=false
  export MANAGEMENT_DB_IMPLEMENTATION=sparql_http_triplestore
  export MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  export SPRING_PROFILES_ACTIVE=sparql_http_triplestore
  
  export DB_SERVER_URL=http://localhost:7200/
  export DB_SERVER_REPOSITORYID=egData
  
  export MANAGEMENT_DB_SERVER_URL=http://localhost:7200/
  export MANAGEMENT_DB_SERVER_REPOSITORYID=egData
  

• If you are on Windows platform, edit conf/setenv.bat and add/update env variables exports as shown below.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=sparql_http_triplestore
  set DB_SERVER_REPOSITORY_AUTOCREATE=false
  set MANAGEMENT_DB_IMPLEMENTATION=sparql_http_triplestore
  set MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  set SPRING_PROFILES_ACTIVE=sparql_http_triplestore
  
  set DB_SERVER_URL=http://localhost:7200/
  set DB_SERVER_REPOSITORYID=egData
  
  set MANAGEMENT_DB_SERVER_URL=http://localhost:7200/
  set MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  

• Start EasyGraph.

Once you have EasyGraph running follow the steps in Bootstrap

SPARQL HTTP repository

EasyGraph can be configured to run with any store which provides SPARQL HTTP repository. Please see GraphDB section above. You just need to set the properties to point to SPARQL endpoint.

AWS Neptune(SPARQL Endpoint)

EasyGraph can be configured to run with SPARQL endpoint. For example using this setup you can use AWS Neptune as backend.

• Run all the steps mentioned in RDF4J native store section and make sure EasyGraph starts up without any error.
• From the AWS Console create a new Neptune Database.
• Download and copy EasyGraph to instance which can connect to Neptune SPARQL endpoint.
• If you are on OSX/Linux platform, edit conf/setenv.sh and add/update env variables exports as shown below. Replace value {WRITE_ENDPOINT_NAME} with Neptune endpoint name

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=sparql_endpoint_triplestore
  export DB_SERVER_REPOSITORY_AUTOCREATE=false
  export MANAGEMENT_DB_IMPLEMENTATION=rdf4j_nativestore_triplestore
  export MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=true
  export SPRING_PROFILES_ACTIVE=sparql_endpoint_triplestore
  
  export DB_SERVER_URL=https://{WRITE_ENDPOINT_NAME}:8182/sparql
  
  export MANAGEMENT_RDF4J_NATIVESTORE_FILEPATH=data
  export MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  
  

  If you want to store user data AWS Neptune database, just create another database and edit/override as below. Replace value {WRITE_ENDPOINT_NAME} and {MANAGEMENT_WRITE_ENDPOINT_NAME} with Neptune endpoints.

  export EG_MULTIPLE_DATASETS=false
  export DB_IMPLEMENTATION=sparql_endpoint_triplestore
  export DB_SERVER_REPOSITORY_AUTOCREATE=false
  export MANAGEMENT_DB_IMPLEMENTATION=sparql_endpoint_triplestore
  export MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  export SPRING_PROFILES_ACTIVE=sparql_endpoint_triplestore
  
  export DB_SERVER_URL=https://{WRITE_ENDPOINT_NAME}:8182/sparql
  
  export MANAGEMENT_DB_SERVER_URL=https://{MANAGEMENT_WRITE_ENDPOINT_NAME}:8182/sparql
  
  

• If you are on Windows platform, edit conf/setenv.bat and add/update env variables exports as shown below.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=sparql_endpoint_triplestore
  set DB_SERVER_REPOSITORY_AUTOCREATE=false
  set MANAGEMENT_DB_IMPLEMENTATION=rdf4j_nativestore_triplestore
  set MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=true
  set SPRING_PROFILES_ACTIVE=sparql_endpoint_triplestore
  
  set DB_SERVER_URL=https://{WRITE_ENDPOINT_NAME}:8182/sparql
  
  set MANAGEMENT_RDF4J_NATIVESTORE_FILEPATH=data
  set MANAGEMENT_DB_SERVER_REPOSITORYID=egmManagement
  

  If you want to store user data AWS Neptune database, just create another database and edit/override as below. Replace value {WRITE_ENDPOINT_NAME} and {MANAGEMENT_WRITE_ENDPOINT_NAME} with Neptune endpoints.

  set EG_MULTIPLE_DATASETS=false
  set DB_IMPLEMENTATION=sparql_endpoint_triplestore
  set DB_SERVER_REPOSITORY_AUTOCREATE=false
  set MANAGEMENT_DB_IMPLEMENTATION=sparql_endpoint_triplestore
  set MANAGEMENT_DB_SERVER_REPOSITORY_AUTOCREATE=false
  set SPRING_PROFILES_ACTIVE=sparql_endpoint_triplestore
  
  set DB_SERVER_URL=https://{WRITE_ENDPOINT_NAME}:8182/sparql
  
  set MANAGEMENT_DB_SERVER_URL=https://{MANAGEMENT_WRITE_ENDPOINT_NAME}:8182/sparql
  
  

• Start EasyGraph.

Once you have EasyGraph running follow the steps in Bootstrap