README-public.md

cmem-plugin-pyshacl

Validate your Knowledge Graphs based on tests generated from SHACL shapes.

This is a plugin for eccenca Corporate Memory. You can install it with the cmemc command line clients like this:

cmemc admin workspace python install cmem-plugin-pyshacl

Parameters

Data graph URI

The URI of the data graph to be validated. The graph URI is selected from a list of graphs of types:

• di:Dataset
• dsm:ThesaurusProject
• owl:Ontology
• shui:ShapeCatalog
• void:Dataset

SHACL graph URI

The URI of the graph containing the SHACL shapes to be validated against. The graph URI is selected from a list of graphs of type shui:ShapeCatalog

Generate validation graph

If enabled, the validation graph is posted to the CMEM instance with the graph URI specified with the validation graph URI option. Default value: false

Validation graph URI

If the generate validation graph option is enabled the validation graph is posted to the CMEM instance with this graph URI

Output entities

If enabled, the plugin outputs the validation results and can be connected to, for instance, a CSV dataset to produce a results table. Default value: false

Clear validation graph

If enabled, the validation graph is cleared before workflow execution. Default value: true.

Advanced Options

Resolve owl:imports

If enabled, the graph tree defined with owl:imports in the data graph is resolved. Default value: true

Blank node skolemization

If enabled, blank nodes in the validation graph are skolemized into URIs. Default value: true

Add labels

If enabled, rdfs:label triples are added to the validation graph for instances of sh:ValidationReport and sh:ValidationResult. Default value: true

Add labels from data and SHACL graphs

If enabled along with the add labels option, rdfs:label triples are added for the focus nodes, values and SHACL shapes in the validation graph. The labels are taken from the specified data and SHACL graphs. Default value: false

Add shui:conforms flag to focus node resources

If enabled, shui:conforms false triples are added to the focus nodes in the validation graph. Default value: false

Meta-SHACL

If enabled, the SHACL shapes graph is validated against the SHACL-SHACL shapes graph before validating the data graph. Default value: false

Ontology graph URI

The URI of a graph containing extra ontological information. RDFS and OWL definitions from this are used to inoculate the data graph. The graph URI is selected from a list of graphs of type owl:Ontology

Inference

If enabled, OWL inferencing expansion of the data graph is performed before validation. Options are RDFS, OWLRL, Both, None. Default value: None

SHACL advanced features

Enable SHACL Advanced Features. Default value: false.

SHACL-JS features

Enable SHACL-JS features. Default value: false.

Remove graph type http://rdfs.org/ns/void#Dataset from data graph

Before validating, remove the triple <data_graph_uri> a <http://rdfs.org/ns/void#Dataset> from the in-memory data graph.

Remove graph type https://vocab.eccenca.com/dsm/ThesaurusProject from data graph

Before validating, remove the triple <data_graph_uri> a <https://vocab.eccenca.com/dsm/ThesaurusProject> from the in-memory data graph.

Remove graph type https://vocab.eccenca.com/shui/ShapeCatalog from data graph

Before validating, remove the triple <data_graph_uri> a <https://vocab.eccenca.com/shui/ShapeCatalog> from the in-memory data graph.

Maximum evaluation depth

The maximum number of SHACL shapes "deep" that the validator can go before reaching an "endpoint" constraint (1-999). Default value: 15

Parameter Input

In order to set options via the input the following parameter names can be used:

Option	Name
Data graph URI	data_graph_uri
SHACL graph URI	shacl_graph_uri
Generate validation graph	generate_graph
Validation graph URI	validation_graph_uri
Output entities	output_entities
Clear validation graph	clear_validation_graph
Resolve owl:imports	owl_imports
Blank node skolemization	skolemize
Add labels	add_labels
Add labels from data and SHACL graphs	include_graphs_labels
Add shui:conforms flag to focus node resources	add_shui_conforms
Meta-SHACL	meta_shacl
Ontology graph URI	ontology_graph_uri
Inference	inference
SHACL advanced features	advanced
SHACl-JS features	js
Remove graph type http://rdfs.org/ns/void#Dataset from data graph	remove_dataset_graph_type
Remove graph type https://vocab.eccenca.com/dsm/ThesaurusProject from data graph	remove_thesaurus_graph_type
Remove graph type https://vocab.eccenca.com/shui/ShapeCatalog from data graph	remove_shape_catalog_graph_type
Maximum evaluation depth	max_evaluation_depth