Property Shapes¤
Property Shapes are resources of type shacl:PropertyShape.
They are used to specify constraints and UI options that need to be met in the context of a Node Shape.
The following Property Shape properties are supported:
Naming and Presentation¤
Info
In this group, presentation and naming properties are collected. Most of the properties are straight forward to use, other properties provide more complex features, such as table reports.
Name¤
This name will be shown to the user.
Used Path: shacl:name
Description¤
This text will be shown to the user in a tooltip. You can use new and blank lines for basic text structuring.
Used Path: shacl:description
Order¤
Specifies the order of the property in the UI. Ordering is separate for each group.
Used Path: shacl:order
Group¤
Group to which the property belongs to.
Used Path: shacl:group
Show always¤
Default is false. A value of true let optional properties (min count = 0) show up by default.
Used Path: shui:showAlways
Read only¤
Default is false. A value of true means the properties are not editable by the user. Useful for displaying system properties.
Used Path: shui:readOnly
Chart Visualization (deprecated)¤
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.
Used Path: shui:provideChartVisualization
Provide Workflow Trigger (deprecated)¤
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.
This property is deprecated - use a Widget Integration instead.
Used Path: shui:provideWorkflowTrigger
Vocabulary¤
Info
In this group, property paths as well cardinality restrictions are managed.
Property of¤
The node shape this property shape belongs to.
Used Path: shacl:property
Path¤
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 the Business Knowledge Editor, this path can always be used for exploration.
Used Path: shacl:path
Query: Path Builder¤
Use this property to define a dynamic set of target resources or literals using a custom SPARQL query. This allows for advanced selection logic, including filtering, transitive relationships, or specific path sequences as well as the definition of a result set order.
The values bound to the first variable in the query’s projection will be treated as directly connected via the sh:path specified in this property shape. This enables simple backward-chaining inference. Note that the infererred connections are not (yet) included in SHACL validation.
The following placeholder can be used in the query text of the SPARQL query:
{{shuiGraph}}- the currently used graph{{shuiResource}}- refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape){{shuiAccount}}- the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only){{shuiAccountName}}- the user name/ID of the active user account{{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)
Note that for a proper usage of this feature, you additionally need to have the projection variables ?graph or ?_graph (the graph IRI where the relation statement is saved resp. in the context of which it was inferred) in your query.
If the connected property value is a resource, the variables in the projection of this query will be used to populate the columns in the complex widget and the advanced editor.
Used Path: shui:valueQuery
Node kind¤
The type of the linked nodes. In the Business Knowledge Editor, if these nodes are literals, they cannot be explored, but will be shown as metadata.
Used Path: shacl:nodeKind
Min count¤
Min cardinality, 0 will show this property under optionals unless ‘Show always = true’
Used Path: shacl:minCount
Max count¤
Max cardinality
Used Path: shacl:maxCount
Datatype Property Specific¤
Info
In this group, all shape properties are managed, which only have effects on datatype properties.
Datatype¤
The datatype of the property.
Used Path: shacl:datatype
Use textarea¤
Default is false. A value of true enables multiline editing capabilities for Literals via a textarea widget.
Used Path: shui:textarea
Regex Pattern¤
A XPath regular expression (Perl like) that all literal strings need to match.
Used Path: shacl:pattern
Regex Flags¤
An optional string of flags for the regular expression pattern (e.g. ‘i’ for case-insensitive mode)
Used Path: shacl:flags
Languages allowed¤
This limits the given Literals to a list of languages. This property works only in combination with the datatype rdf:langString. Note that the expression for this property only allows for ‘2 Char ISO-639-1-Codes’ only (no sub-tags).
Used Path: shui:languageIn
Languages Unique¤
Default is false. A value of true enforces that no pair of Literals may use the same language tag.
Used Path: shacl:uniqueLang
Object Property Specific¤
Info
In this group, all shape properties are managed, which only have effects on object properties.
Class¤
Class of the connected IRI if its nodeKind is sh:IRI. In the Business Knowledge Editor, any new node that a user creates by means of this property shape, will be an instance this class.
Used Path: shacl:class
Used Class for Resource Creation¤
Use this property to overrule which class is used when a user creates a new resource inside of this property shape on-the-fly.
Used Path: shui:usedClassForResourceCreation
Disable default sorting of values¤
Per default, related resources are shown ordered by its IRI. This ordering can have a performance impact with large lists. Setting this property to true will disable this default behaviour. In case a path builder query with an order statement is used, this property has no effect.
Used Path: shui:disableDefaultValueSorting
Query: Selectable Resources¤
This query allows for listing selectable resources in the dropdown list for this property shape.
You need to provide the projection variable resource in your query.
The following placeholder can be used in the query text of the SPARQL query:
{{shuiGraph}}- the currently used graph{{shuiResource}}- refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape){{shuiAccount}}- the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only){{shuiAccountName}}- the user name/ID of the active user account{{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)
Beta Feature: This query will be used as well to populate the selectable resources for the advanced editor and the candidate resources in the Business Knowledge Editor.
Used Path: shui:uiQuery
Inverse Path¤
Default is false. A value of true inverts the expected / created direction of a relation.
Used Path: shui:inversePath
Deny new resources¤
A value of true disables the option to create new resources.
Used Path: shui:denyNewResources
Resource viewer widget¤
Selects default object relation resource viewer widget. (NOTE: shacl2 only)
Used Path: shui:viewResourcesWithWidget
Node shape¤
This shape will be used to create an embedded view of the linked resource.
Used Path: shacl:node
Processing / User Interaction¤
Info
In this group all shape properties are managed, which have an effect on how new or existing resources are processed or created.
Message¤
If there is a message value, then all validation results produced as a result of this shape will have exactly this message.
Used Path: shacl:message
Severity¤
Categorize validation results (:Info, :Warning, :Violation). Defaults to :Violation.
Used Path: shacl:severity
Ignore on clone¤
Disables reusing the value(s) when creating a clone of the resource. Note: This feature was named ‘copy’ before.
Used Path: shui:ignoreOnCopy
Query: On insert update¤
This query is executed when a property value is added or changed.
The following placeholder can be used in the query text of the SPARQL query:
{{shuiGraph}}- the currently used graph{{shuiResource}}- refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape){{shuiAccount}}- the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only){{shuiAccountName}}- the user name/ID of the active user account{{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){{shuiObject}}- the object value of the statement matched by the property shape{{shuiProperty}}- the IRI of the property of the statement matched by the property shape
Used Path: shui:onInsertUpdate
Query: On delete update¤
A query which is executed when the statement the property shape applies to gets deleted.
The following placeholder can be used in the query text of the SPARQL query:
{{shuiGraph}}- the currently used graph{{shuiResource}}- refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape){{shuiAccount}}- the account IRI of the active user, this includes the username (use a SUBSTR() function if you need the name only){{shuiAccountName}}- the user name/ID of the active user account{{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){{shuiObject}}- the object value of the statement matched by the property shape{{shuiProperty}}- the IRI of the property of the statement matched by the property shape
Used Path: shui:onDeleteUpdate
Target Graph Template¤
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).
Used Path: shui:targetGraphTemplate
Statement Annotation¤
Info
Statement Annotations provide a way to express knowledge about statements. This group is dedicated to properties which configure the Statement Annotation feature.
Enable¤
A value of true enables visualisation and management capabilities of statement annotations (reification) for all statements which are shown via this shape.
Used Path: shui:enableStatementLevelMetadata
Provided Shapes¤
Instead of providing all possible statement annotation node shapes for the creation of new statement annotations, this property will limit the list to the selected shapes only.
Used Path: shui:provideStatementLevelMetadataShapes