Background

Requirements

Remove the text "Type" from the UCO ontology for the following Facet:

tool.ttl:ToolConfigurationTypeFacet

so that it becomes

tool.ttl:ToolConfigurationFacet

Requirement 1

Replace all occurances of the text "ToolConfigurationTypeFacet" with "ToolConfigurationFacet" e.g. *.replace(current="ToolConfigurationTypeFacet", new="ToolConfigurationFacet") within the:

tool.ttl file (current)

  359   tool:ToolConfigurationTypeFacet
                      :
365       rdfs:label "ToolConfigurationTypeFacet"@en ;
                      :
379       sh:targetClass tool:ToolConfigurationTypeFacet ;

tool.ttl file (after change)

  359   tool:ToolConfigurationFacet
                      :
365       rdfs:label "ToolConfigurationFacet"@en ;
                      :
379       sh:targetClass tool:ToolConfigurationFacet ;

Requirement 2

Check all examples within the master branch of: https://github.com/casework/CASE-Examples/tree/master/examples/

for any references affected by the change. i.e. run a keyword search across all the files in the above folder, and all its sub-folders, for "ToolConfigurationTypeFacet" Known changes:

master/examples/illustrations/configured_tool/configured_tool.json (3 changes)

   24   {
25       "@id": "kb:Tool-be707329-48fe-4d5d-84f3-7978ba63869e",
                    :
35               "@type": "uco-tool:ToolConfigurationTypeFacet",

   92   {
   93       "@id": "kb:Tool-f40e2a5f-7fdf-491f-8c87-b4cb766a6377",
                        :
  103               "@type": "uco-tool:ToolConfigurationTypeFacet",

  160   {
  161       "@id": "kb:Tool-134e3cc0-7f74-4ea2-9ac1-3c447f4f6195",
                        :
  171              "@type": "uco-tool:ToolConfigurationTypeFacet",

master/examples/illustrations/Oresteia/Oresteia.json (2 changes)

 1110    {
1111       "@id": "kb:tool2-uuid",
                    :
1121               "@type": "uco-tool:ToolConfigurationTypeFacet",

 1172    {
 1173       "@id": "kb:tool3-uuid",
                   :
 1182               "@type": "uco-tool:ToolConfigurationTypeFacet",

Risk / Benefit analysis

Benefits

The changes provides better conformance with the standard CASE Facet guidance

Risks

Any developer code which currently hard codes the json-ld output using the existing "ToolConfigurationTypeFacet" name will need to amended to allow compability with future UCO\CASE versions.
Note: Code which automatically generates output data directly from the versioned *.ttl files will be unaffected by the change.
Forked examples may not, by default, have the change in their existing copy.

Competencies demonstrated

After the change, re-run a text search across all the files in the following repositories:

https://github.com/ucoProject/UCO (master)

https://github.com/casework/CASE-Examples (master)

Competency 1

Competency Question 1.1

Check that no hits are generated for the text pattern "ToolConfigurationTypeFacet" (case insensitive)

Result 1.1

The result should not return any Hits

Competency Question 1.2

Check that hits are generated for the text pattern "ToolConfigurationFacet" (case insensitive)

Result 1.2

Check that all hits are an exact match for "ToolConfigurationFacet" (case sensitive)

tool.ttl (3 hits)
configured_tool.json (3 hits)
Oresteia.json (2 hits)

Solution suggestion

Make the changes suggested above.

Coordination

Tracking in Jira ticket OC-260
[x] Administrative review completed
[ ] Requirements to be discussed in OC meeting, 2022-08-16
[ ] Requirements Review vote has not occurred

casework / CASE

Update CASE examples which reference tool.ttl Facet 'ToolConfigurationTypeFacet' (previously named 'ToolConfigurationTypeFacet') #97