Setting Up ENAPSO media free

Welcome to the comprehensive setup and usage guide for ENAPSO together Free, specifically tailored for broadcasters. This document provides step-by-step instructions to get started with the Docker platform, from installation to managing your data with ENAPSO together free services.

Prerequisites

Before you begin, ensure the following requirements are met:

Docker Installed: Docker must be installed and running on your machine to facilitate the deployment of applications within containers. For optimal performance and compatibility, ensure that your Docker installation is version 20.10 or above. To check your Docker version, open your command prompt or terminal and enter:
```
docker --version
```
Internet Connection: Necessary to pull the Docker image from the repository.
Credentials: To request your username and access token, send an email to support@innotrade.de with the subject line "Request for Credentials."

Docker Setup

Docker Login

Open your command prompt or terminal. Log in to the Docker registry to access the ENAPSO together image using the following command:

docker login registry.innotrade.com -u [username] -p [Personal Access Token]

Replace [username] and [Personal Access Token] with your credentials.

Pull Docker Image

Still, in your command prompt or terminal, pull the latest version of ENAPSO together free:

docker pull registry.innotrade.com/innotrade/enapso-together-free

Run Docker Container

Now, run the Docker container to deploy the platform locally using this command:

docker run -p 80:80 registry.innotrade.com/innotrade/enapso-together-free

This maps the container's port 80 to your local machine's port 80.

Verify Docker Image

To confirm that the Docker image is running correctly on your machine, use the following command in your command prompt or terminal:

docker ps

This command will list all running containers. Please verify that the ENAPSO together free container appears in the list, indicating it is active and running.

Swagger Documentation Access

Access the Swagger documentation for ENAPSO together free services through your web browser:

Service Name	Description	Access Link
View Management Service	API documentation for View Management	View Management Docs
GraphDB Management Service	API documentation for GraphDB Management	GraphDB Management Docs

Uploading Your Ontology

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 the Download 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. <= 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 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

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 class http://www.ebu.ch/metadata/ontologies/ebucoreplus#EditorialObject, the endpoint will create four SPARQL templates: readEditorialObject, createEditorialObject, updateEditorialObject, and deleteEditorialObject. 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 the "http://ont.enapso.com/dotnetpro#Person" associated with "cls" 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 the Execute 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.

Executing CRUD Operations

After generating your CRUD templates, you'll need to use them to manage data. This section explains how to execute the "read", "create", "update" and "delete" templates for the EditorialObject class.

Executing the Read Template

To view existing instances of the EditorialObject class, follow these steps:

Access Template Execution API: Navigate to the API documentation where you can execute templates by name. This is typically found under the same View Management Service documentation.
Prepare to Execute the Read Template:
- Locate the "execute-template by name" endpoint.
- Click the Try it out button to enable input.
- In the templateName field, enter readEditorialObject, which is the name of the read template for the EditorialObject class.
- Ensure that any existing variables are cleared out before executing to avoid any unintended filtering.
- Click the Execute button to send the request.
- Upon successful execution, the API will return a response displaying all instances of the EditorialObject class. This verifies that the read operation is functioning correctly.

Creating a New Instance

To create a new instance of the EditorialObject class, follow these instructions:

Set Up Creation Request:
- Go back to the "execute-template by name" endpoint if you aren't already there.
- Click Try it out button again to set up a new request.
- Enter createEditorialObject in the templateName field, which is the name of the create template for the EditorialObject class.
- Provide necessary variables for the new instance. Typically, this would be in JSON format in the body of the request, such as { "label": "New Editorial Object" }. Make sure to replace "New Editorial Object" with the actual data you wish to use for the new instance.
- Click the Execute button to send the creation request.
- The response will confirm that the new instance has been successfully created. Look for a success message and any details provided about the newly created instance.

Verifying the Creation of a New Instance

After creating a new instance of the EditorialObject class, it's important to confirm that the instance has indeed been added to the graph database. Follow these steps to verify the creation:

Re-execute the Read Template:
- Navigate back to the "execute-template by name" endpoint in the View Management Service documentation.
- Click the Try it out button to enable input for a new request.
- In the templateName field, enter readEditorialObject again. This is the same read template you used earlier to view instances.
- Click the Execute button to send the request once more.
- The response will now include the list of all current instances of the EditorialObject class. Look through the list to find the newly created instance. You should see the details you entered for the instance, such as the label or any other identifiers, confirming that it has been successfully persisted in the database.

This process of re-executing the read template serves as a straightforward method to ensure that your CRUD operations are impacting the graph database as expected, providing clear evidence of successful data management within the ENAPSO platform.

Updating an Instance

To update an existing instance within your graph database, you need to specify which instance to update and what changes to make:

Access Update Template Execution:
- Navigate to the "execute-template by name" endpoint in the View Management Service documentation.
- Click the Try it out button.
- Enter the name of the update template (e.g., updateEditorialObject) in the templateName field.
- In the variables object, specify the iri of the instance you wish to update and the properties you want to change. For example, you would provide the iri and other properties you are updating.
- Click the Execute button to send the update request.
- The response should indicate whether the update was successful, including confirmation of the changes.

Deleting an Instance

To delete an instance from your ontology, you need to specify which instance to remove:

Access Delete Template Execution:
- Go to the "execute-template by name" endpoint in the View Management Service documentation.
- Click the Try it out button.
- Enter the name of the delete template (e.g., deleteEditorialObject) in the templateName field.
- In the variables object, provide the IRI of the instance you wish to delete.
- Click the Execute button to send the delete request.
- The response should confirm that the instance has been successfully deleted from the database.

Conclusion

Congratulations on successfully setting up and starting to use the ENAPSO Together Free platform for broadcasters. You've learned how to upload an ontology and manage data through CRUD operations, which are crucial for effective data handling within the platform.

As you continue to work with ENAPSO, explore further features and functionalities to enhance your data management capabilities. Remember, the documentation and support are there to help you maximize the platform's potential.

Thank you for following this guide, and happy data managing!