You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/explore-and-author/link-rules/index.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
icon: eccenca/application-queries
3
+
status: new
3
4
tags:
4
5
- LinkRules
5
6
- KnowledgeGraph
@@ -64,10 +65,11 @@ Create a new graph that holds templates for Link Rules. The graph IRI will be ne
64
65
!!! info
65
66
66
67
Suggestion for Template Catalog Graph IRI: `https://ns.eccenca.com/data/linkruletemplates/`. You may use [this file](./CMEM_Link_Rule_Template_Catalog.ttl) as the graphs content.
68
+
If you use `cmemc` you can run:
67
69
68
-
!!! info
69
-
70
-
This graph could be prepared even it is not used in many setups.
@@ -79,9 +81,9 @@ Create a new project in Build that holds all linking tasks created in the Link R
79
81
80
82
{ class="bordered" }
81
83
82
-
In the *Advanced Options* section set a *Project Identifier* as this needs to be configured in the next steps.
84
+
In the *Advanced Options* section set a *Project Identifier* as this needs to be configured in the next steps (we will be using `linkrules` in this example).
83
85
84
-
Inside this project create a new workflow that will be used to register all published rules, so that all these rules can be executed at once. Again it is recommended to set a *Item Identifier* as this needs to be configured in the next steps.
86
+
Inside this project create a new workflow that will be used to register all published rules, so that all these rules can be executed at once. Again it is recommended to set a *Item Identifier* as this needs to be configured in the next steps (we will be using `execute-published-rules` in this example).
85
87
86
88
{ class="bordered" }
87
89
@@ -105,16 +107,16 @@ This access conditions is used by the Link Rules module to grant write access to
105
107
106
108
In order to enable users to use the Link Rules Module, the following must be allowed (this can be granted in this rule or be defined separately):
107
109
108
-
-**Allow reading graph**
110
+
-**Allow reading graph**
109
111
- Respective data graphs
110
-
-**Allow writing graph**
112
+
-**Allow writing graph**
111
113
-*CMEM DI Project Config* graph of the "Link Rules" project
112
-
-`{IRI of the Link Rules project}_meta`
113
-
-**Allowed action**
114
+
-`{IRI of the Link Rules project}-meta` (e.g., `http://di.eccenca.com/project/linkrules-meta` according to the project identifier in this example)
115
+
-**Allowed action**
114
116
-*Build - Workspace*
115
117
-*Explore - Knowledge Graph Exploration*
116
118
-*Explore - Link Rules Module*
117
-
-**Graph pattern for granting write access**
119
+
-**Graph pattern for granting write access**
118
120
- Pattern according to the *Output Graph Template*, e.g. `http://eccenca.com/user_rules/result_*`
119
121
120
122
### Workspace configuration
@@ -124,13 +126,13 @@ Enable the *Link Rules* module.
124
126
In the following let us walk through the configuration options.
125
127
126
128
-**Order**: The position of the Link Rules module in the menu.
127
-
-**Template Catalog IRI**: The IRI of the template catalog we just created. As the name implies, the Template Catalog holds all templates for usage in the Link Rules module. Templates allow preselecting patterns for easier rule creation.
128
-
-**Project ID**: The *Project Identifier* of the Link Rules Build project we just created. Link Rules will be managing this project and add the rules to it. To get the id of a project, open the project in the build component, select the project and choose 'Show identifier' in the context menu, in the top right. The project needs to have a workflow, which is used to execute the rules and has to be configured in this section. Furthermore, the projects needs one or more Datasets, which can be selected in the templates.
129
+
-**Template Catalog IRI**: The IRI of the template catalog we just created. As the name implies, the Template Catalog holds all templates for usage in the Link Rules module. Templates allow preselecting patterns for easier rule creation. (`https://ns.eccenca.com/data/linkruletemplates/` in this example)
130
+
-**Project ID**: The *Project Identifier* of the Link Rules Build project we just created. Link Rules will be managing this project and add the rules to it. To get the id of a project, open the project in the build component, select the project and choose 'Show identifier' in the context menu, in the top right. The project needs to have a workflow, which is used to execute the rules and has to be configured in this section. Furthermore, the projects needs one or more Datasets, which can be selected in the templates. (`linkrules` in this example)
131
+
-**Access Condition IRI**: The IRI of the Access Condition we just created. Explore the `CMEM Access Conditions` graph to find the `Access Condition` rule and its respective IRI.
129
132
-**Published Rules Workflow ID**: The *Item Identifier* of the workflow in the Link Rules Build project we just created.
130
-
-**Access Condition IRI**: The IRI of the Access Condition we just created.
131
133
-**Output Graph Template**: A jinja template for the graph IRIs which will hold the results of a linking rule. It needs to include the placeholder `{name}`, for example `http://eccenca.com/user_rules/result_{name}`.
132
134
-**Publication Graph Template**: A jinja template, that generates the IRI of the graph, into which the output graph is imported via an `owl:imports`. This can be a simple graph IRI, for example `http://eccenca.com/user_rules/results_published`.
133
-
-**Result Download Query**: A query that will be used to download the results of a linking rule. By default all resource IRIs will be listed as `resource1` and `resource2`. Whenever you want to provide other data via the *Download results* function, such as a specific identifier or a label instead of the IRI, this query can be adapted here.
135
+
-**Result Download Query** (optional): A query that will be used to download the results of a linking rule. By default all resource IRIs will be listed as `resource1` and `resource2`. Whenever you want to provide other data via the *Download results* function, such as a specific identifier or a label instead of the IRI, this query can be adapted here.
134
136
-**Annotation Class IRI** (optional): Rule results can be enriched with annotations. Instances of this class can be selected in the link rules interface. Instances have both a connection to the rule and the result. The connection is defined by the *Annotation Link Property IRI*. The values of the annotation are defined by the *Annotation Value Property IRI*. This relation is materialized as `rdf:value` in the output graph upon execution.
135
137
-**Annotation Value Property IRI** (optional): Values of sub-properties of this property are actually connected as `rdf:values` to the generated links of a rule.
136
138
-**Annotation Link Property IRI** (optional): The connection between a rule and an annotation resource (i.e. instance of *Annotation Class IRI*) is defined by this property.
@@ -144,13 +146,13 @@ Templates can be managed at *Link Rules module* -> *Manage Templates*.
144
146
145
147
Create a new Link Rule Template. Such a template describes an abstract link rule with pre-defined settings.
146
148
147
-
-**Label**: A mandatory label for the template.
148
-
-**Target Property**: The (default) connecting property for the derived link rules. The property can be individually set for each link rule later on.
149
-
-**Input** group: The datasets which hold the subjects (source) and objects (target) to link.
150
-
-**Source/Target Dataset**: The dataset holding the resources to link.
151
-
-**Source/Target Resource Pattern**: A filter description template for the resources to link. This is a JSON object as described in [Graph Resource Pattern](#graph-resource-pattern). When creating a Link Rule based on this template these resource patterns can be altered. So this template may remain simple, but should provide sufficient help for the end user to define a proper resource selection.
152
-
-**Output** group: The dataset which will hold the Link Rule results.
153
-
-**Output Graph**: The graph IRI where to write the Link Rule results. Available placeholders: `{name}` for the Link Rules name.
149
+
-**Label**: A mandatory label for the template.
150
+
-**Target Property**: The (default) connecting property for the derived link rules. The property can be individually set for each link rule later on.
151
+
-**Input** group: The datasets which hold the subjects (source) and objects (target) to link.
152
+
-**Source/Target Dataset**: The dataset holding the resources to link.
153
+
-**Source/Target Resource Pattern**: A filter description template for the resources to link. This is a JSON object as described in [Graph Resource Pattern](#graph-resource-pattern). When creating a Link Rule based on this template these resource patterns can be altered. So this template may remain simple, but should provide sufficient help for the end user to define a proper resource selection.
154
+
-**Output** group: The dataset which will hold the Link Rule results.
155
+
-**Output Graph**: The graph IRI where to write the Link Rule results. Available placeholders: `{name}` for the Link Rules name.
0 commit comments