Table of Contents | ||
---|---|---|
|
...
Still, in your command prompt or terminal, pull the latest version of ENAPSO together free:
Here we already need to add that a backup is required, since a new pull overwrites existing data!
Code Block | ||
---|---|---|
| ||
docker pull registry.innotrade.com/innotrade/enapso-together-free |
...
This maps the container's port 80 to your local machine's port 80.
If you encounter a port conflict when attempting to run the Docker container for the ENAPSO together Free platform, you have an option to resolve it and access the service:
Change the Host Port
If port 80 is already in use on your machine, you can map the container's internal port (80) to a different port on your host. For example, if you choose to use port 8080 on your host, you can modify your Docker run command like this:
...
Service Name | Description | Access Link |
---|---|---|
View Management Service | API documentation for View Management | |
GraphDB Management Service | API documentation for GraphDB Management |
Uploading Your Ontology
This guide outlines the steps to prepare and upload the EBUCorePlus
ontology to your graph database. Follow these instructions to ensure your graph database is properly set up to manage and utilize ontology data, from downloading the necessary files to configuring the upload through the GraphDB Management Service's endpoint.
Access Swagger Documentation: Navigate to the GraphDB Management Service documentation in your web browser.
Prepare Your Ontology File: Ensure the
ebucoreplus
ontology file is saved on your local machine. You can obtain the EBUCorePlus ontology from the EBU GitHub repository. Once you open the link, you will see the content of the ontology file displayed. To download it, locate theDownload
icon on the upper right side of the page and click on it. This will automatically save the file to the default download folder on your local machine.
If you want to clone the entire repository, ensure that Git is installed on your computer. You can check this by running
git --version
in your terminal. If Git is not installed, you will need to download and install it from the official Git website. Open your command prompt (CMD), and move to the directory where you want the repository to be cloned. You can do this by running the commandcd path/to/your/directory
, replacingpath/to/your/directory
with the path to the desired directory on your local machine. Once you're in the desired directory, run the following command to clone the repository:Code Block language bash git clone https://github.com/ebu/ebucoreplus.git
This will clone the entire ebucoreplus repository to your local machine. <= How does this work?
Upload the Ontology: Utilize the
upload-ontology-from-file
endpoint to upload the ontology to the graph database repository.Click the
Try it out
button.Fill out the following fields:
filename: Select and upload your
ebucoreplus
ontology file.format: Specify the format as
text/turtle
.baseIRI (Optional): Enter the base IRI for your ontology such as
http://www.ebu.ch/metadata/ontologies/ebucoreplus#
. Using this base IRI helps ensure consistent referencing within your ontology. If you need to use a specific or different IRI, replace the default with your custom IRI. Enter the base IRI for your ontology.context (Optional): Define the context (also known as a named graph) for your ontology within the graph database repository. The context is an identifier that organizes data within the graph database, such as
http://www.ebu.ch/metadata/ontologies/ebucoreplus
. If the context field is left empty, behavior varies by triplestore:In Fuseki, data will be added to the default context
http://ont.enapso.com/default
.In GraphDB by Ontotext, data will be added to the graph database's default context, as described in their documentation.
Execute the upload by clicking the
Execute
buttonUpon execution, the response will indicate that the ontology has been successfully uploaded. You will see a message or a status code in the Swagger interface confirming that the upload was successful.
Uploading Provided Demo DataProvided Demo Data
This guide outlines the steps to upload the pre-formatted Turtle (TTL) demo data for the EditorialObject
to your graph database. Follow these instructions to effectively populate your graph databases with instances of the EditorialObject
within the EBUCorePlus
ontology, using the GraphDB Management Service's provided API endpoints.
Caution! Re-Pulling Docker Images leads to data loss!
Access Swagger Documentation: Navigate to the GraphDB Management Service documentation in your web browser.
Editorial Object Demo Data: Below is the provided Turtle-formatted demo data for the Editorial Object. This data includes predefined instances that demonstrate the use and structure of the Editorial Object within ebucoreplus ontology.
...
Upload the Ontology Text: Utilize the
upload-ontology-from-text
endpoint to upload the demo data to the graph database repository.Click the
Try it out
button.Fill out the following fields:
fileData: Copy the Turtle text from the
EditorialObject Escaped Demo Data
section and paste it against thefileData
key. Make sure to include the entire text block to preserve the integrity of the data.format: Specify the format as
text/turtle
.baseIRI (Optional): Enter the base IRI for your ontology such as
http://www.ebu.ch/metadata/ontologies/ebucoreplus#
.context (Optional): Define the context (also known as a named graph) for your demo data, such as
http://www.ebu.ch/metadata/ontologies/ebucoreplus/demodata
.
Execute the upload by clicking the
Execute
button.Upon execution, the response will indicate that the ontology has been successfully uploaded. You will see a message or a status code in the Swagger interface confirming that the upload was successful.
CRUD Template Management
This section provides detailed instructions on how to generate CRUD (create
, read
, update
, delete
) templates for specific classes within your ontology using the View Management API. By following these steps, you can automate the creation of SPARQL templates that facilitate the management of instances of any specified class, such as the EditorialObject
from the EBUCorePlus
ontology. This process simplifies the implementation of CRUD operations in your graph database.
Access View Management API Docs: Use the link provided in the Swagger Documentation Access section.
Generate CRUD Templates: Find the
create-crud-sparql-template-4-class
endpoint in the documentation. This endpoint is used to automatically generate CRUD (create
,read
,update
,delete
) templates for a specific class you specify in the POST body. For instance, if you pass the classhttp://www.ebu.ch/metadata/ontologies/ebucoreplus#EditorialObject
, the endpoint will create four SPARQL templates:readEditorialObject
,createEditorialObject
,updateEditorialObject
, anddeleteEditorialObject
. These templates enable you to manage instances of the class easily, providing a streamlined approach to handle CRUD operations in your graph database.Click the
Try it out
button.In the displayed POST body, you will find a JSON object with a
cls
key. Replace thehttp://ont.enapso.com/dotnetpro#Person
associated withcls
with the class IRI you intend to manage. For example, to manage the EditorialObject class, input:http://www.ebu.ch/metadata/ontologies/ebucoreplus#EditorialObject
.After replacing the
cls
default value in the post body, click theExecute
button to send the request.Once executed, the response will confirm the creation of CRUD templates. You'll see a success message along with the names of the CRUD operations (
create,
read
,update
,delete
) for your class and their respective status codes.
...