diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/adding-new-graph.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/adding-new-graph.png new file mode 100644 index 000000000..3cc200dd5 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/adding-new-graph.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/bke-select-graph.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/bke-select-graph.png new file mode 100644 index 000000000..33b31faeb Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/bke-select-graph.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/classes.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/classes.png new file mode 100644 index 000000000..651755240 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/classes.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/create-ontology-graph.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/create-ontology-graph.png new file mode 100644 index 000000000..54d288511 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/create-ontology-graph.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/datatype-range-not-supported.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/datatype-range-not-supported.png new file mode 100644 index 000000000..2863d3203 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/datatype-range-not-supported.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/diagram_product_expert.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/diagram_product_expert.png new file mode 100644 index 000000000..2aa07ee13 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/diagram_product_expert.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/drag-drop-new-class.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/drag-drop-new-class.png new file mode 100644 index 000000000..c52278f04 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/drag-drop-new-class.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/edge-type.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/edge-type.png new file mode 100644 index 000000000..5e0abf666 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/edge-type.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-class.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-class.png new file mode 100644 index 000000000..217ec3f70 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-class.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-in-form.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-in-form.png new file mode 100644 index 000000000..28eaf68f0 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/expert-in-form.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-bke.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-bke.png new file mode 100644 index 000000000..de97e1b6f Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-bke.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-kgs.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-kgs.png new file mode 100644 index 000000000..600372ed6 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/explore-kgs.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-product.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-product.png new file mode 100644 index 000000000..355eb9f2d Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-product.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-property.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-property.png new file mode 100644 index 000000000..e8366531f Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/form-property.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/index.md b/docs/explore-and-author/bke-module/visually-authoring-ontologies/index.md new file mode 100644 index 000000000..c5188ede5 --- /dev/null +++ b/docs/explore-and-author/bke-module/visually-authoring-ontologies/index.md @@ -0,0 +1,192 @@ +--- +icon: material/cog-outline +subtitle: using BKE interface +tags: + - BeginnersTutorial + - Vocabulary +--- +# Visually Authoring Ontologies + +## Introduction + +This beginner-level tutorial shows how to use Business Knowledge Editor (BKE) to create new ontology (vocabulary) **classes** and **predicates** (object property, data property) visually. + +There are other way of creating new classes and properties within Corporate Memory (using shacl shapes), but BKE allows for an intuitive "diagram" approach, simplifying the creation. + +The tutorial consists of the following steps, which are described in detail below: + +1. Initializing a new ontology +2. Opening a new BKE visualisation +3. Creating classes +4. Linking related classes through object properties +5. Adding data properties +6. Saving the changes + +## Class Diagram + +This tutorial will go through the example of creating an ontology modeling the following diagram: + +![](diagram_product_expert.png) + +Two classes will be related to each other through an `expertIn` object property. + +Each class will have its own data property. + +--- + +## 1 Initializing a new ontology + +The "to-be-created" classes and properties will be saved in a given Knowledge Graph, a new ontology graph will be initialized for this tutorial. + +!!!info + + It is also possible to extend an existing vocabulary, in that case directly go to step 2 + +To create a new ontology graph : + + 1. In Corporate Memory, click **Knowledge graphs** under **EXPLORE** in the navigation on the left side of the page. + +![](explore-kgs.png){ class="bordered" width="50%" } + + 2. In the **Graphs** drop-down menu click the **(+)** button and select **New Ontology (owl:Ontology)**. + +![](adding-new-graph.png){ class="bordered" width="50%" } ![](create-ontology-graph.png){ class="bordered" width="50%" } + +3. Define a **Name** and a **Graph URI** for the ontology. _In this example we will use:_ + - Label: `Custom Dprod` + - Graph URI: `http://ld.company.org/custom-dprod/` +--- + +## 2 Opening a new BKE visualisation + +1. In Corporate Memory, click **Business knowledge editor** under **EXPLORE** in the navigation on the left side of the page. + + ![](explore-bke.png){ class="bordered" width="50%" } + +2. Select the target graph using the drop-down menu. + + ![](bke-select-graph.png){ class="bordered" width="50%" } + +3. Create an empty visualization. + +!!!success + + If you see an empty canvas you are ready to use BKE to create classes and properties + +--- + +## 3 Creating classes + +New elements can be created by using the concepts defined in `Classes` visible in the left side of the canvas + +1. Drag and drop **Class** from the bottom left list into the canvas. + + ![](classes.png){ class="bordered" width="50%" } + +!!!info + + If you don't see Class within the first entries you can use the text search bar to find it + +2. Click the newly created **Untitled (Class)** in the canvas to bring up a form on the right side. + + ![](untitled-class.png){ class="bordered" width="50%" } + + +3. Fill out the form with the required (*) and optional values . + + ![](expert-class.png){ class="bordered" width="50%" } + +--- + +## 4 Linking related classes through object properties + + +1. Drag and drop **owl:ObjectProperty** from the bottom left list into the canvas. + +!!!info + + If you don't see owl:ObjectProperty within the first entries you can use the text search bar to find it + + +2. Click the newly created **Untitled (Object Property)** in the canvas to bring up a form on the right side. + +3. Fill out the form with the required (*) and optional values . + + ![](expert-in-form.png){ class="bordered" width="50%" } + +4. Click and hold the edge of the Class to begin drawing an arrow. Link that to the created property's edge. + + ![](pointer-click-hold.png){ class="bordered" width="50%" } + +5. Inside the edge type selection window that pops up, select **In Domain Of** + + ![](edge-type.png){ class="bordered" width="50%" } + +!!!info + + This is one way of associating a property with an existing class, below is shown another way (creating new class from an existing property) + +6. Click the right side edge of the object property and select **Range** from the selection so that it brings an additional **New Class** on the right side + + ![](range-created-new-class.png){ class="bordered" width="50%" } + +7. Drag and drop **New Class** into the canvas. + + ![](drag-drop-new-class.png){ class="bordered" width="50%" } + +8. Click the newly created class to bring out the form and fill out with the required (*) and optional values . + + ![](form-product.png){ class="bordered" width="50%" } + +!!!success + + The property is now succesfully linking the two concepts together through the use of Domain and Range + +--- + +## 5 Adding data properties + +Datatype properties can be added to the canvas the same way as an object property, + +1. Drag and drop **owl:DatatypeProperty** from the bottom left list into the canvas. + +!!!info + + If you don't see owl:DatatypeProperty within the first entries you can use the text search bar to find it + +2. Click the newly created **Untitled (Data Property)** in the canvas to bring up a form on the right side. + +3. Fill out the form with the required (*) and optional values . + + ![](form-property.png){ class="bordered" width="50%" } + +4. Click and hold the edge of the Class to begin drawing an arrow. Link that to the created property's edge. + +5. Inside the edge type selection window that pops up, select **In Domain Of** + + ![](linking-datatype-property.png){ class="bordered" width="50%" } + +!!!warning + + At the time of writing this tutorial, setting up a datatype range (languaged string, float, date ...) is not possible from within BKE directly. + We recommend saving the changes and finish the datatype edition using the shacl shapes approach. + + ![](datatype-range-not-supported.png){ class="bordered" width="30%" } + +## 6 Saving the changes + +It is recommended to save the changes by using a named visualisation, in case you need to edit your classes and properties later. + +1. Click **Save** from the top right section of the canvas + +2. Using the Graph drop-down selector, choose your ontology (vocabulary) + +3. Fill out the name + + ![](save-changes.png) + +4. Click Save + +!!!success + + You have successfully created new concepts and properties inside your ontology using BKE's canvas. diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/linking-datatype-property.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/linking-datatype-property.png new file mode 100644 index 000000000..6c1a3d60e Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/linking-datatype-property.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/pointer-click-hold.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/pointer-click-hold.png new file mode 100644 index 000000000..f6297efac Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/pointer-click-hold.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/range-created-new-class.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/range-created-new-class.png new file mode 100644 index 000000000..1277bec02 Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/range-created-new-class.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/save-changes.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/save-changes.png new file mode 100644 index 000000000..61e67ad1a Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/save-changes.png differ diff --git a/docs/explore-and-author/bke-module/visually-authoring-ontologies/untitled-class.png b/docs/explore-and-author/bke-module/visually-authoring-ontologies/untitled-class.png new file mode 100644 index 000000000..248a1f1fb Binary files /dev/null and b/docs/explore-and-author/bke-module/visually-authoring-ontologies/untitled-class.png differ