Custom Widgets Operations
  • 05 May 2023
  • 2 Minutes to read
  • Dark
  • PDF

Custom Widgets Operations

  • Dark
  • PDF

Article Summary

In this article, we will take a comprehensive look at the steps involved to add a Custom Widget to the Administration dashboard. In BizTalk360, users can create custom widgets and associate them with their dashboard. Through the custom widget, the user can (for example) integrate the BizTalk360 API, third-party APIs (like SalesForce, Power BI, and Azure, etc), and create the database queries by using Secure SQL Queries. Let's assume a real-time scenario for monitoring the SQL Jobs which is normally a tedious one. In the BizTalk environment, multiple SQL Jobs are configured like BizTalk server management Database SQL Jobs, purging Jobs, etc. A custom widget can be removed from the dashboard in two different ways:

Method 1

Follow the steps as shown below to create a custom widget to monitor the SQL Jobs and pin it to the Administration dashboard. This will enable the operations team to monitor all the activities from the dashboard.

  • Log in to BizTalk360
  • Select the environment from the environmental panel
  • On the Administration screen, click Add Widget
  • You will notice the Add/Remove Widget blade on the right-hand side of the screen. Click Add Custom Widget.
  • The Add New Custom Widget blade will request the basic configurations details like:
  1. Widget Name - Enter a friendly name that helps to identify the custom widget. Ex. DTA Purging Job 
  2. Description - Enter a short description of the widget
  3. Widget Icon - This section allows the user to add a logo for the custom widget
  4. Script - Type the script into the space provided
  5. Insert Placeholder - While using external API codes, there may be occasions when you will be forced to use credentials (such as username, password) or confidential information. Instead of hardcoding the information, you can create them as a placeholder, and simply refer them to the code.
  6. Save - Click the Save & Pin to Dashboard button to close the Add New Custom Widget blade. Once the blade is closed, you will notice a confirmation message as Configuration Saved Successfully
  7. Cancel - Click Cancel to cancel the custom widget creation process

Method 2

  1. Log in to the application (as a Superuser)
  2. Click the Settings icon at the top of the page
  3. Expand Custom Development and select Custom Widgets
  4. Click the Create Custom Widget button. The Add New Custom Widget blade will open on the right side of the screen
  5. Follow step 4 mentioned in Method 1 to complete the process

To remove a custom widget from BizTalk360 Dashboard, follow the steps in this section.

Access Restriction
  • Custom widgets can only be created by a superuser
  •  Normal users cannot create a new custom widget, though the user has full access to manage the dashboard and widgets. However, a normal user can add the custom widgets created by super users.

Was this article helpful?


Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses