Agent-Enabled Dataspace Connector
For participating in Semantic-Web Driven Dataspace Applications following the Catena-X Knowledge Agents Standard, we recommend deploying an Agent-Enabled Tractus-X EDC
For more information see
- Our Adoption guidelines
- The Implementation documentation
- The Deployment overview
- The Conformity testbed
- A Data Sovereignity & Graph Policy discussion
Quick Setup Guide for Agent-Enabled EDC (KA-EDC)
Add a helm dependency to your umbrella/infrastructure Chart.yaml (this example uses the postgresql-hashicorp variant but abstracts away from vault and SSI settings - vaultsettings andssisettings as well as the persistence config, see here for more options and full details).
- name: agent-connector
repository: https://eclipse-tractusx.github.io/charts/dev
version: 1.11.16
alias: my-agent-connector
Then configure the connector in the values.yaml
my-agent-connector:
participant:
id: {{MYBPNL}}
nameOverride: my-agent-connector
fullnameOverride: "my-agent-connector"
vault: *vaultsettings
controlplane:
image:
pullPolicy: Always
ssi: *ssisettings
endpoints:
management:
authKey: "{{EDC_API_KEY}}"
## Ingress declaration to expose the network service.
ingresses:
- enabled: true
# -- The hostname to be used to precisely map incoming traffic onto the underlying network service
hostname: "{{controlPlaneName}}"
# -- EDC endpoints exposed by this ingress resource
endpoints:
- protocol
- management
- control
# -- Enables TLS on the ingress resource
tls:
enabled: true
dataplanes:
dataplane:
configs:
dataspace.ttl: |-
################################################
# Catena-X Agent Bootstrap
################################################
@prefix : <GraphAsset?local=Dataspace> .
@prefix cx-core: <https://w3id.org/catenax/ontology/core#> .
@prefix cx-common: <https://w3id.org/catenax/ontology/common#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix bpnl: <bpn:legal:> .
@base <GraphAsset?local=Dataspace> .
bpnl:{{PARTNERBPNL}} cx-common:hasBusinessPartnerNumber "{{PARTNERBPNL}}"^^xsd:string;
cx-common:hasConnector <edcs://{{partnerControlPlanePublic}}>.
bpnl:{{MYBPNL}} cx-common:hasBusinessPartnerNumber "MYBPNL"^^xsd:string;
cx-common:hasConnector <edcs://{{controlPlaneName}}>.
agent:
synchronization: 60000
connectors:
- [https://{{controlPlaneName}}]https://{{partnerControlPlanePublic}}
## Ingress declaration to expose the network service.
ingresses:
- enabled: true
hostname: "{{agentPlaneName}}"
# -- EDC endpoints exposed by this ingress resource
endpoints:
- public
- default
- control
- callback
# -- Enables TLS on the ingress resource
tls:
enabled: true
Quick Setup Guide for Registering A Skill
We demonstrate the steps by interacting with the EDC Control Plane Management API and the EDC Data Plane Agent Endpoint
Register A Skill Policy
curl --location --globoff '{{controlPlaneName}}/management/v2/policydefinitions' \
--header 'X-Api-Key: {{EDC_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"@context": {
"odrl": "http://www.w3.org/ns/odrl/2/",
"cx-common": "https://w3id.org/catenax/ontology/common#"
},
"@type": "PolicyDefinitionRequestDto",
"@id": "Policy?me=SkillPolicy",
"policy": {
"@type": "Policy",
"odrl:permission" : [{
"odrl:action" : "USE",
"odrl:constraint" : {
"@type": "LogicalConstraint",
"odrl:or" : [{
"@type" : "Constraint",
"odrl:leftOperand" : "BusinessPartnerNumber",
"odrl:operator" : {
"@id": "odrl:eq"
},
"odrl:rightOperand" : "{{PARTNERBPNL}}"
},
{
"@type" : "Constraint",
"odrl:leftOperand" : "BusinessPartnerNumber",
"odrl:operator" : {
"@id": "odrl:eq"
},
"odrl:rightOperand" : "{{MYBPNL}}"
}]
}
}]
}
}
'
Register A Skill Contract
curl --location --globoff '{{controlPlaneName}}/management/v2/policydefinitions' \
--header 'X-Api-Key: {{EDC_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"@context": {
"cx-common": "https://w3id.org/catenax/ontology/common#"
},
"@id": "Contract?me=SkillContract",
"@type": "ContractDefinition",
"accessPolicyId": "Policy?me=SkillPolicy",
"contractPolicyId": "Policy?me=SkillPolicy",
"assetsSelector" : {
"@type" : "CriterionDto",
"operandLeft": "https://w3id.org/catenax/ontology/common#publishedUnderContract",
"operator": "=",
"operandRight": "Contract?me=Skill"
}
}
'
Register a Skill Asset
curl --location --globoff '{{dataPlaneName}}/api/agent/skill?asset=SkillAsset%3Fsupplier%3DRemainingUsefulLife&distributionMode=ALL&contract=Contract?me=SkillContract' \
--header 'Content-Type: application/sparql-query' \
--header '{{DATA_PLANE_KEY}}: {{DATA_PLANE_TOKEN}}' \
--data-raw 'PREFIX cx-common: <https://w3id.org/catenax/ontology/common#>
PREFIX cx-core: <https://w3id.org/catenax/ontology/core#>
PREFIX cx-vehicle: <https://w3id.org/catenax/ontology/vehicle#>
PREFIX cx-reliability: <https://w3id.org/catenax/ontology/reliability#>
PREFIX cx-behaviour: <https://w3id.org/catenax/ontology/behaviour#>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
PREFIX json: <https://json-schema.org/draft/2020-12/schema#>
PREFIX bpnl: <bpn:legal:>
PREFIX oem: <GraphAsset?oem=>
PREFIX supplier: <GraphAsset?supplier=>
################################################################
# Sample for a Federated (Consumer-Deployed) SparQL Skill which
# - Jumps into an OEM-owned reliability asset given a set of candidate VANs
# - Feeds the gathered data back into the respective supplier connector/agent
#. to perform a health indication
# Author: cgjung
# (c) 2023 Catena-X assocation
################################################################
SELECT ?vehicle ?van ?aggregate ?assembly ?supplier ?lc ?operatingTime ?mileage ?recordDate ?ls_type ?ls_name ?ls_value ?ls_unit ?ls_method ?ls_channels ?ls_classes ?ls_values ?distanceKm ?timeHours WHERE {
VALUES (?van ?aggregate ?ls_type) {
("@van"^^xsd:string "Differential Gear"^^xsd:string "GearOil"^^xsd:string)
}
bpnl:BPNL00000003AYRE cx-common:hasConnector ?oemEDC.
?oemEDC cx-common:offers [ rdfs:isDefinedBy <https://w3id.org/catenax/ontology/reliability>; cx-common:id ?reliabilityAssetId].
SERVICE ?oemEDC {
GRAPH ?reliabilityAssetId {
?vehicle rdf:type cx-vehicle:Vehicle;
cx-vehicle:vehicleIdentificationNumber ?van.
?assembly rdf:type cx-vehicle:Part;
cx-vehicle:name ?aggregate;
cx-vehicle:isPartOf ?vehicle;
cx-vehicle:supplier ?supplier.
?teleAnalysis rdf:type cx-reliability:Analysis;
cx-reliability:analysedObject ?assembly;
cx-reliability:operatingHoursOfVehicle ?operatingTime;
cx-reliability:mileageOfVehicle ?mileage;
cx-core:startDateTime ?recordDate;
cx-reliability:result [
cx-core:id ?ls_type;
cx-core:name ?ls_name;
cx-reliability:countingValue ?ls_value;
cx-reliability:countingUnit ?ls_unit;
cx-reliability:countingMethod ?ls_method;
cx-reliability:channels ?ls_channels;
cx-reliability:classes ?ls_classes;
cx-reliability:values ?ls_values
].
} # OEM#GRAPH
?supplier cx-common:hasConnector ?supplierEDC.
?supplierEDC cx-common:offers [ rdfs:isDefinedBy <https://w3id.org/catenax/ontology/behaviour>; cx-common:id ?prognosisAssetId].
SERVICE ?supplierEDC {
GRAPH ?prognosisAssetId {
?invocation a cx-behaviour:RemainingUsefulLife;
cx-behaviour:sender bpnl:BPNL00000003AYRE;
cx-behaviour:senderConnector ?oemEDC;
cx-behaviour:recipient ?supplier;
cx-behaviour:recipientConnector ?supplierEDC;
cx-behaviour:targetDate ?recordDate;
cx-behaviour:timeStamp ?recordDate;
cx-behaviour:component "GearBox";
cx-behaviour:statusDate ?recordDate;
cx-behaviour:statusOperatingHours ?operatingTime;
cx-behaviour:statusMileage ?mileage;
cx-behaviour:countingValue ?ls_value;
cx-behaviour:countingUnit ?ls_unit;
cx-behaviour:countingMethod ?ls_method;
cx-behaviour:headerChannels ?ls_channels;
cx-behaviour:bodyClasses ?ls_classes;
cx-behaviour:bodyCountsList ?ls_values;
cx-behaviour:remainingOperatingHours ?timeHours;
cx-behaviour:remainingRunningDistance ?distanceKm.
} # SUPPLIER#GRAPH
} # SUPPLIER#CATALOG
} # OEM#CATALOG
} # SELECT
'
Quick Setup Guide for Calling A Skill
We demonstrate the steps by interacting with the EDC Data Plane Agent Endpoint
Calling A Local Skill
curl --location --globoff '{{agentPlaneName}}/api/agent?asset=SkillAsset%3Fsupplier%3DRemainingUsefulLife' \
--header 'Content-Type: application/sparql-results+json' \
--header 'Accept: application/json' \
--header '{{DATA_PLANE_KEY}}: {{DATA_PLANE_TOKEN}}' \
--data '{
"head": {
"vars": [
"van"
]
},
"results": {
"bindings": [
{
"van": {
"type": "literal",
"value": "FNLQNRVCOFLHAQ"
}
},
{
"van": {
"type": "literal",
"value": "FGPTXINYZAVJYK"
}
},
{
"van": {
"type": "literal",
"value": "DVAJDTLJMKKZGY"
}
}
]
}
}'
Calling A Remote Skill
curl --location --globoff '{{agentPlaneName}}/api/agent?asset={{URLENCODED_PARTNER_CONTROL_PLANE}}%23SkillAsset%3Fsupplier%3DRemainingUsefulLife' \
--header 'Content-Type: application/sparql-results+json' \
--header 'Accept: application/json' \
--header '{{DATA_PLANE_KEY}}: {{DATA_PLANE_TOKEN}}' \
--data '{
"head": {
"vars": [
"van"
]
},
"results": {
"bindings": [
{
"van": {
"type": "literal",
"value": "FNLQNRVCOFLHAQ"
}
},
{
"van": {
"type": "literal",
"value": "FGPTXINYZAVJYK"
}
},
{
"van": {
"type": "literal",
"value": "DVAJDTLJMKKZGY"
}
}
]
}
}'