Skip to content

Commit 7162ea5

Browse files
committed
update XP/DP shape reference, CMEM-6230
1 parent d5de0f0 commit 7162ea5

File tree

3 files changed

+100
-37
lines changed
  • docs/explore-and-author/graph-exploration/building-a-customized-user-interface

3 files changed

+100
-37
lines changed

docs/explore-and-author/graph-exploration/building-a-customized-user-interface/datatype-reference/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -238,13 +238,6 @@ normalizedString represents white space normalized strings. The ·value space·
238238

239239
IRI: `http://www.w3.org/2001/XMLSchema#normalizedString`
240240

241-
#### PlainLiteral
242-
243-
244-
The class of plain (i.e. untyped) literal values, as used in RIF and OWL 2
245-
246-
IRI: `http://www.w3.org/1999/02/22-rdf-syntax-ns#PlainLiteral`
247-
248241
#### positiveInteger
249242

250243

docs/explore-and-author/graph-exploration/building-a-customized-user-interface/node-shapes/index.md

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,18 @@ Used Path: `shacl:order`
6767
### Chart Visualization
6868

6969

70-
Integrates a chart visualization in the node shape area.
70+
Integrates a chart visualization in the node shape area. This Property is deprecated - charts on node shape level are not supported anymore.
7171

7272
Used Path: `shui:provideChartVisualization`
7373

74+
75+
### Widgets
76+
77+
78+
Integrate non-validating visualization widget in the node shape area.
79+
80+
Used Path: `shui:WidgetIntegration_integrate`
81+
7482
## Vocabulary
7583

7684
!!! info
@@ -112,6 +120,14 @@ The URI template which is used, when a user manually creates new resources with
112120
Used Path: `shui:uriTemplate`
113121

114122

123+
### SPARQL Constraints
124+
125+
126+
Add additional SPARQL based validation to your Node Shape.
127+
128+
Used Path: `shacl:sparql`
129+
130+
115131
### Closed Node
116132

117133

@@ -120,42 +136,58 @@ Enabling this will result in failing validation if the resource / node has prope
120136
Used Path: `shacl:closed`
121137

122138

123-
### On delete update
139+
### Query: On delete update
124140

125141

126142
A query which is executed when the resource the node shape applies to gets deleted.
127143

128144
The following placeholder can be used in the query text of the SPARQL query:
129145

130-
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
131-
- `{{shuiGraph}}` - the currently used graph.
146+
- `{{shuiGraph}}` - the currently used graph
147+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
148+
- `{{shuiAccountName}}` - the user name/ID of the active user account
149+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
132150

133151

134152
Used Path: `shui:onDeleteUpdate`
135153

136154

137-
### On update update
155+
### Target Graph Template
138156

139157

158+
Graph templates can be used to enforce writing statement in specific graphs rather than into the selected graph. Graph templates can be added to node and property shapes. A template on a property shape is used only for overwriting a template on a node shape (without a node shape graph template, they do not have an effect).
140159

141-
A query which is executed when this nodeshape is submitted.
160+
Used Path: `shui:targetGraphTemplate`
161+
162+
163+
### Query: On update update
164+
165+
166+
167+
A query which is executed when this node shape is submitted.
142168
The query should be saved in the same graph as the shape (or imported).
143169

144170
The query can use these placeholders:
145171

146-
- `{{shuiResource}}` - the resource currently shown with the node shape of this property shape,
147-
- `{{shuiGraph}}` - the currently used graph.
172+
- `{{shuiGraph}}` - the currently used graph
173+
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape)
174+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
175+
- `{{shuiAccountName}}` - the user name/ID of the active user account
176+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
148177

149178

150179
Used Path: `shui:onUpdateUpdate`
151180

152181

153-
### Target Graph Template
182+
### On update trigger workflow
154183

155184

156-
Graph templates can be used to enforce writing statement in specific graphs rather than into the selected graph. Graph templates can be added to node and property shapes. A template on a property shape is used only for overwriting a template on a node shape (without a node shape graph template, they do not have an effect).
157185

158-
Used Path: `shui:targetGraphTemplate`
186+
A workflow trigger which is executed when this nodeshape is submitted. The workflow(s) run
187+
instantaneously upon submitting the form.
188+
189+
190+
Used Path: `shui:onUpdateTriggerWorkflow`
159191

160192
## Statement Annotation
161193

docs/explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,11 @@ Use this property to provide a tabular report of a custom SPARQL query at the pl
4242

4343
The following placeholder can be used in the query text of the SPARQL query:
4444

45-
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
46-
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape) ;
47-
- `{{shuiGraph}}` - the currently used graph.
45+
- `{{shuiGraph}}` - the currently used graph
46+
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape)
47+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
48+
- `{{shuiAccountName}}` - the user name/ID of the active user account
49+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
4850

4951
Beta Feature: This query will be used as well to populate the related resources for the advanced editor. In this case, you need to have the projection variables `resource` (the resource IRI which is linked to the shaped resource) and `graph` or _graph (the graph IRI where the relation statement is saved) in your query.
5052

@@ -102,19 +104,22 @@ Default is false. A value of true means the properties are not editable by the u
102104
Used Path: `shui:readOnly`
103105

104106

105-
### Chart Visualization
107+
### Chart Visualization (deprecated)
106108

107109

108-
Integrates a chart visualization in the property shape area. Shapes with an integrated chart are ALWAYS shown in read mode and NEVER shown in edit mode.
110+
Integrates a chart visualization in the property shape area. Shapes with an integrated chart are ALWAYS shown in read mode and NEVER shown in edit mode. This Property is deprecated - please use a Widget Integration instead.
109111

110112
Used Path: `shui:provideChartVisualization`
111113

112114

113-
### Provide Workflow Trigger
115+
### Provide Workflow Trigger (deprecated)
114116

115117

116118
Integrates a workflow trigger button in order to execute workflows from or with this resource. Shapes with an integrated workflow trigger are ALWAYS shown in read mode and NEVER shown in edit mode.
117119

120+
This property is deprecated - use a Widget Integration instead.
121+
122+
118123
Used Path: `shui:provideWorkflowTrigger`
119124

120125
## Vocabulary
@@ -134,15 +139,15 @@ Used Path: `shacl:property`
134139
### Path
135140

136141

137-
The datatype or object property used in this shape. This path will be ignored if there is a table report defined for the property shape. However, in Business Knowledge Editor, this path can always be used for exploration.
142+
The datatype or object property used in this shape. This path will be ignored if there is a table report defined for the property shape. However, in Easynav, this path can always be used for exploration.
138143

139144
Used Path: `shacl:path`
140145

141146

142147
### Node kind
143148

144149

145-
The type of the linked nodes. In Business Knowledge Editor, if these nodes are literals, they cannot be explored, but will be shown as metadata.
150+
The type of the linked nodes. In BKE, if these nodes are literals, they cannot be explored, but will be shown as metadata.
146151

147152
Used Path: `shacl:nodeKind`
148153

@@ -224,19 +229,35 @@ Used Path: `shacl:uniqueLang`
224229
### Class
225230

226231

227-
Class of the connected IRI if its nodeKind is sh:IRI. In Business Knowledge Editor, any new node that a user creates by means of this property shape, will be an instance this class.
232+
Class of the connected IRI if its nodeKind is sh:IRI. In Easynav, any new node that a user creates by means of this property shape, will be an instance this class.
228233

229234
Used Path: `shacl:class`
230235

231236

237+
### Used Class for Resource Creation
238+
239+
240+
Use this property to overrule which class is used when a user creates a new resource inside of this property shape on-the-fly.
241+
242+
Used Path: `shui:usedClassForResourceCreation`
243+
244+
232245
### Query: Selectable Resources
233246

234247

235248
This query allows for listing selectable resources in the dropdown list for this property shape.
236249

237250
You need to provide the projection variable `resource` in your query.
238251

239-
Beta Feature: This query will be used as well to populate the selectable resources for the advanced editor and the candidate resources in Business Knowledge Editor.
252+
The following placeholder can be used in the query text of the SPARQL query:
253+
254+
- `{{shuiGraph}}` - the currently used graph
255+
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape)
256+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
257+
- `{{shuiAccountName}}` - the user name/ID of the active user account
258+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
259+
260+
Beta Feature: This query will be used as well to populate the selectable resources for the advanced editor and the candidate resources in EasyNav.
240261

241262
Used Path: `shui:uiQuery`
242263

@@ -286,6 +307,14 @@ Categorize validation results (:Info, :Warning, :Violation). Defaults to :Violat
286307
Used Path: `shacl:severity`
287308

288309

310+
### Message
311+
312+
313+
If there is a message value, then all validation results produced as a result of this shape will have exactly this message.
314+
315+
Used Path: `shacl:message`
316+
317+
289318
### Ignore on copy
290319

291320

@@ -301,24 +330,33 @@ This query is executed when a property value is added or changed.
301330

302331
The following placeholder can be used in the query text of the SPARQL query:
303332

304-
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
305-
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape) ;
306-
- `{{shuiGraph}}` - the currently used graph.
307-
333+
- `{{shuiGraph}}` - the currently used graph
334+
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape)
335+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
336+
- `{{shuiAccountName}}` - the user name/ID of the active user account
337+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
338+
- `{{shuiObject}}` - the object value of the statement matched by the property shape
339+
- `{{shuiProperty}}` - the IRI of the property of the statement matched by the property shape
340+
308341

309342
Used Path: `shui:onInsertUpdate`
310343

311344

312-
### On delete update
345+
### Query: On delete update
313346

314347

315-
A query which is executed when the resource the node shape applies to gets deleted.
348+
A query which is executed when the statement the property shape applies to gets deleted.
316349

317350
The following placeholder can be used in the query text of the SPARQL query:
318351

319-
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
320-
- `{{shuiGraph}}` - the currently used graph.
321-
352+
- `{{shuiGraph}}` - the currently used graph
353+
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape)
354+
- `{{shuiAccount}}` - the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only)
355+
- `{{shuiAccountName}}` - the user name/ID of the active user account
356+
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage)
357+
- `{{shuiObject}}` - the object value of the statement matched by the property shape
358+
- `{{shuiProperty}}` - the IRI of the property of the statement matched by the property shape
359+
322360

323361
Used Path: `shui:onDeleteUpdate`
324362

0 commit comments

Comments
 (0)