# Topics

## Overview

Topics are data schemas that define and standardize the payload of messages sent between different actors in the platform. Topics are grouped under [Applications ](https://docs.energyweb.org/energy-solutions/digital-spine-by-energy-web/component-guides/self-sovereign-identities/technical-guide/applications)and administered by Application owners (specifically Admin Users in the Client Gateway). They can be updated over time to accommodate changes in the data schema through versioning.

There are 4 types of data schema supported in the Client Gateway topics which are:

* JSD7
* XML
* CSV
* TSV

***

## User Guide

### Pre-requisites

* Authorization to Client Gateway
* `topiccreator` role

### Create a Topic

1. Navigate to `Topic Management` and select an application for your new topic

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FsGfORD66BMiISqfnnGVs%2FScreenshot%202025-05-07%20at%2011.29.31%E2%80%AFAM.png?alt=media&#x26;token=80bc27d9-839a-4706-911d-0e9e1018331b" alt=""><figcaption><p>Apps and Topics</p></figcaption></figure>

2. Click `Create`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fac1joOZS9e4tgivj3x76%2FScreenshot%202025-05-07%20at%2011.34.04%E2%80%AFAM.png?alt=media&#x26;token=4e432d62-a369-43f6-b0c8-ee74ff44c4b4" alt=""><figcaption><p>Topic List</p></figcaption></figure>

3. Fill up the create topic form and click `Save`&#x20;

{% hint style="success" %}
Organize your topics effectively by using tags
{% endhint %}

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FtrakaKpOW8FECuGIgUU6%2FScreenshot%202025-05-07%20at%2011.41.33%E2%80%AFAM.png?alt=media&#x26;token=8508d307-fdc0-4326-9f72-0ef759eff430" alt=""><figcaption><p>Create topic form</p></figcaption></figure>

4. Success message will be shown, click `Dismiss` to close modal and view the topic list

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F6SW96juiiNKNmiUJ6g9X%2FScreenshot%202025-05-07%20at%2011.48.00%E2%80%AFAM.png?alt=media&#x26;token=1670de6a-12e8-498d-a34e-8bea00a453db" alt="" width="375"><figcaption><p>Successfully created topic</p></figcaption></figure>

### Modify a Topic

1. Search for the topic that you would like to modify. Click on the `︙` button at the end of the record row and choose `View version history`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FGHuhVxa1Zwmc7JV7W9Zt%2FScreenshot%202025-05-07%20at%2011.55.49%E2%80%AFAM.png?alt=media&#x26;token=6665522d-c5e3-4f21-abec-027926400bb0" alt=""><figcaption><p>View version history</p></figcaption></figure>

2. Click on the `︙` button of the topic version you would like to update and choose  `Update`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FhJEnO9WNh8Y1XkE7Z210%2FScreenshot%202025-05-07%20at%2011.57.33%E2%80%AFAM.png?alt=media&#x26;token=bcfd2d66-c6db-44bb-bfc3-833a4b852812" alt=""><figcaption><p>Update topic</p></figcaption></figure>

3. Make changes to the schema, you may also bump the version and the older version will keep the original schema instead

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FuU5dP5m7SqKWxKdT7UPJ%2FScreenshot%202025-05-07%20at%2012.00.21%E2%80%AFPM.png?alt=media&#x26;token=4a7661a6-341f-42ac-a452-0b70b5c36c5e" alt=""><figcaption><p>Update topic form</p></figcaption></figure>

4. Success message will be shown, click `Dismiss` to close modal and view the version history list

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F6y9rSrPOriRwG1imEJvi%2Fimage.png?alt=media&#x26;token=6984f22f-fc05-42fa-a663-fac07b37c0e8" alt="" width="375"><figcaption><p>Successfully updated topic</p></figcaption></figure>

### Remove a Version History

1. Click on the `︙` button of the topic version you would like to remove and choose  `Remove`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F83D8AB4dXB4sb0y0uwiI%2FScreenshot%202025-05-07%20at%2012.10.04%E2%80%AFPM.png?alt=media&#x26;token=7f518b7c-6274-40b4-8a83-0da8958b138f" alt=""><figcaption><p>Remove a version history</p></figcaption></figure>

2. A confirmation modal will appear, click `Confirm` to remove the version history from topic or `Cancel`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F1FfpJwLeqyKTwa18hQ7a%2Fimage.png?alt=media&#x26;token=0b1db729-bb5f-4523-b9fe-d6daed365fe1" alt="" width="375"><figcaption><p>Delete version history confirmation modal</p></figcaption></figure>

3. Success message will be shown, click `Dismiss` to close modal and view the version history list

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F1f8Yy0X3wmskgLVjgM5D%2Fimage.png?alt=media&#x26;token=aeb13886-d0ef-413a-b8db-d3d83c03336a" alt="" width="375"><figcaption><p>Successfully deleted version history</p></figcaption></figure>

### Remove a Topic

1. Search for the topic that you would like to remove. Click on the `︙` button at the end of the record row and choose `Remove`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F7d5Y8zIWdC9lew2yAQRY%2FScreenshot%202025-05-07%20at%2012.14.13%E2%80%AFPM.png?alt=media&#x26;token=dba040e9-d685-486e-a0be-c13e78c7848d" alt=""><figcaption><p>Remove topic</p></figcaption></figure>

2. A confirmation modal will appear, click `Confirm` to remove the topic or `Cancel`&#x20;

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F1FfpJwLeqyKTwa18hQ7a%2Fimage.png?alt=media&#x26;token=0b1db729-bb5f-4523-b9fe-d6daed365fe1" alt="" width="375"><figcaption><p>Delete topic confirmation modal</p></figcaption></figure>

3. Success message will be shown, click `Dismiss` to close modal and view the topics list

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F1f8Yy0X3wmskgLVjgM5D%2Fimage.png?alt=media&#x26;token=aeb13886-d0ef-413a-b8db-d3d83c03336a" alt="" width="375"><figcaption><p>Successfully deleted topics</p></figcaption></figure>
