Cardano Explorer Link Form Element

Introduction

The Cardano Explorer Link Form Element is a customizable button or hyperlink that allows you to navigate to a public Cardano blockchain explorer to inspect account, transaction, and asset-related activities performed in Joget. The plugin checks the validity of the retrieved value and can either disable or hide the button/link based on the value's validity.

Get started

Prerequisites

  • You must have a valid Blockfrost Project Key to access the Cardano blockchain.
  • A supported Cardano blockchain explorer such as cardanoscan.io or cexplorer.io.

Where to get the plugin

You can download the Cardano Explorer Link Form Element 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.

Configure cardano explorer link properties

Drag and drop the Cardano Explorer link element from the Form Builder onto Canva. Then, click the Cardano Explorer link element to open the Configure Cardano Explorer link properties.

Fields to configure:

  • Network Type: Select the type of Cardano network:
  • Backend Service: Configure the backend service. 
    Type
    • Blockfrost
    • Koios
  • Blockfrost Project Key: Use the Blockfrost Project Key to connect your app with the Cardano blockchain.
  • Transaction ID: Also known as Transaction Hash. Transactions that contain metadata are expected here.

    Typically, a Hash Variable is used here.

Value retrieval

Fields to configure:

  • Explorer Type: Select the public Cardano blockchain explorer of your choice:
    • cardanoscan.io
    • cexplorer.io
      Unofficial Cardano Explorer websites may contain errors or mistakes. Please use them at your OWN risk.
      Note that explorers typically have a short time syncing to the latest blockchain state. Relatively recent transactions performed may take some time to reflect in the explorer.
  • Value Type: Select the type of value you are checking for:
    • Transaction ID
    • Account Address
    • Policy ID
    • Asset ID
  • Get Value Via: Select the method you wish to retrieve the value:
    • Field ID
    • Hash Variable
    • Workflow Variable
  • Field ID: This property will only appear when Get Value Via is Field ID.
    Retrieves the value via an existing field in the current form. 
    Selections here will show all available fields in the current form.
  • Hash Variable: This property will only appear when Get Value Via is Hash Variable.
    Retrieves the value via Hash Variable.
  • Workflow Variable: This property will only appear when Get Value Via is a Workflow Variable.

    Retrieves the value via workflow variable. Type in a related workflow variable name to display a convenient autocomplete dropdown.
    Note that this method only works when the current form is within an activity of a process flow.

Customize link UI

Fields to configure:

  • Display As: Display this explorer link as:
    • Button
    • Hyperlink
      Note that for Button, the button design follows the userview theme of the current app.
  • Button Label: This property will only appear when Display As is Button. It is the button label of this link.
  • Hyperlink Label: This property will only appear when Display As is Hyperlink.
    The hyperlink label of this link. If this property is blank, the hyperlink label will be the URL.
  • Link Target: Choose to open the explorer link in a new browser tab or the current browser window.
  • Invalid Value Behavior: If the retrieved value is invalid, you can choose to:
    • Show As Is
    • Disable Link
    • Hide Link

Download plugin

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