Hedera Topic Management Tool

Introduction

The Hedera Topic Management Tool plugin allows you to create, update, delete topics, and submit messages to topics on the Hedera Distributed Ledger Technology (DLT). For more information, see Hedera Consensus Service.

Note:

  • Ensure that the admin account has sufficient balance for the required transaction fee to create topics and send messages to a topic.
  • To update or delete a topic, an Admin Key must be specified during creating the topic.

Get started

Prerequisites

  • You need a valid Operator ID and Operator Key for authentication.
  • The appropriate network type (Mainnet or Testnet) must be selected.
  • Ensure sufficient funds in the operator’s account to cover transaction fees.

Where to get the plugin

Download the Hedera Token Management Tool from the JogetOSS GitHub repository.

How to install

  1. Click Download on this plugin screen (It will be a .jar file).
  2. Go to your Joget localhost or server. In the Joget Console, go to Admin Bar > Systems Settings > Manage Plugins and click the Upload Plugins button.
  3. Under Upload Plugin, select the plugin .jar file you downloaded and click Upload.
  4. Depending on the plugin type, you can now view your new plugin in your form, List, or UI Builder.
  5. Remember to uninstall the old plugin before uploading a new version.
  6. The Joget Knowledge Base has more information on managing and developing plugins.

Configure hedera topic management tool properties

  • Operator ID: This corresponds to your Hedera Operator ID. For further details, see the Hedera Default Backend Configuration.
  • Operator Key: Enter your Hedera Operator Key to create an account.
  • Network Type: Choose PreviewnetTestnet, or Mainnet based on your environment.
  • Operation Type: Select an operation type to perform:
    • Submit Message
    • Create Topic
    • Update Topic
    • Delete Topic
Operation (submit message)
  • Topic ID: The unique ID of an existing topic on the Hedera DLT. You can use a Hash Variable that points to a topic ID.
  • Message: Insert a custom message to submit to the specified topic ID. Supports Hash Variable.
  • Require Submit Key: Check this option if you interact with a private topic.
  • Submit Key: This field appears if the Require Submit Key is checked. Only accepts Hash Variable that points to the topic's submit key.
Operation (create topic)
  • Admin Key: Select an admin to allow update and deletion of topics:
    • Disabled
    • Operator
    • Custom
  • Admin Account Mnemonic Phrase: This property will only appear when the Admin Key is Custom.

    Only accepts Hash Variable that points to the admin account's encrypted stored mnemonic phrase.

  • Set as Private Topic: Check this option to create a private topic.
    By enabling private topics, a submit key will be auto-generated.
    Submitting any messages to private topics requires this submit key.
  • Topic Memo: Insert a custom topic memo. Supports Hash Variable.
Operation (update topic)
  • Topic ID: The unique ID of an existing topic. You can use a Hash Variable.
  • Admin Key: Select the admin that controls this topic:
    • Operator
    • Custom
  • Admin Account Mnemonic Phrase: This property will only appear when the Admin Key is Custom.
    Only accepts Hash Variable that points to the admin account's encrypted stored mnemonic phrase.
  • Modify Admin Key: Select option to modify Admin Key:
    • No Change
    • Remove
    • Replace to Operator
    • Replace to Custom
  • New Admin Account Mnemonic Phrase: This property will only appear when the Admin Key is Replace to Custom.
  • Only accepts Hash Variable that points to the new admin account's encrypted stored mnemonic phrase.
  • Modify Submit Key: Select the option to modify Admin Key:
    • No Change
    • Remove
    • Replace
  • Modify Topic Memo: Select the option to modify Admin Key:
    • No Change
    • Remove
    • Replace
  • New Topic Memo: This property will only appear when Modify Topic Memo is Replace.

    Insert new topic memo to replace old topic memo. Supports Hash Variable.

Operation (delete topic)
  • Topic ID: The unique ID of an existing topic to mark as deleted on the Hedera DLT. You can use a Hash Variable.
  • Admin Key: Select the admin that controls this topic:
    • Operator
    • Custom
  • Admin Account Mnemonic Phrase: This property will only appear when the Admin Key is Custom.

    Only accepts Hash Variable that points to the admin account's encrypted stored mnemonic phrase.

Store response to workflow variable
  • Topic ID: This property will only appear when the Operation Type is Create Topic.
    To store the topic ID of the created topic.
  • Submit Key: This property will only appear when Operation Type is Create Topic when Set as Private Topic is checked, and Update Topic when Modify Submit Key is Remove or Replace.
    To store the Submit Key created for a private topic.
  • Topic Current Sequence: This property will only appear when the Operation Type is Submit Message.
    To indicate the latest sequence number of messages on the topic.
  • Topic Current Hash: This property will only appear when the Operation Type is Submit Message.
    To indicate the latest SHA-384 running hash of the topic.
  • Is Transaction Validated: To indicate if this transaction has been successfully validated.
  • Consensus Timestamp: To store the timestamp of when the majority of the network members received the transaction. At this point, the transaction becomes final and verifiable.
  • Transaction ID: To store the transaction ID of the transaction performed.
  • Transaction Explorer URL: To store an auto-generated URL to see transaction details on a public ledger explorer. The default is Hashscan.

Download plugin

Created by Julieth Last modified by Aadrian on Nov 19, 2024