Skip to main content

Upload Plugin Guide

This guide walks you through uploading the Fuel Analysis Plugin bundle and configuring it to appear in the Tracking portal sidebar. After completing these steps, users will be able to access the Fuel Analysis feature directly from the Tracking sidebar navigation.

Prerequisites

Before starting, ensure you have:

  • Access to the Management Portal with admin privileges
  • The Fuel Analysis plugin JavaScript bundle file (.js), available from either:
    • Local build: fmdp-plugins/fuel-analysis-plugin/dist/test/ directory
    • GitHub repository: fmdp-plugins (download the latest build artifact from the fuel-analysis-plugin package)

Step 1: Navigate to Plugins Settings

  1. Log in to the platform
  2. On the Application Selection page, select a client (e.g., "Fmdp") and click Management Portal
  3. Once inside the Management Portal, click the profile menu on the top-right corner of the header
  4. Select Settings from the dropdown menu
  5. Click on the Plugins tab in the Settings navigation menu

You will see the Plugins Manager page listing all registered plugins.

Settings - Plugins Menu

Step 2: Add New Plugin

  1. Click the ADD NEW button (green button at the top-right corner)

The "Add Plugin" dialog will appear with the following fields:

Add Plugin Form

  1. Fill in the plugin details:
FieldValueNotes
JavaScript bundleClick "Choose File" and browse to the .js bundleNavigate to the build output folder or use the file from GitHub
Plugin NameFuel AnalysisThe display name shown in the plugin list
URL Path(auto-generated)Automatically populated based on the plugin name
Scope(auto-generated)Automatically populated from the bundle metadata
Module(auto-generated)Automatically populated from the bundle metadata
DescriptionFuel Analysis PluginBrief description of the plugin functionality
Author NameYour name (e.g., Sandi Hermawan)The plugin author
Version1.0Plugin version number
Applications(leave empty)Do not select any application at this step
Container(leave empty)Do not select any container at this step
EnabledToggle ONEnable the plugin immediately
Important

Leave the Applications and Container fields empty at this step. The container will be configured separately in Step 3.

  1. Toggle the Enabled switch to ON
  2. Click Save

Add Plugin Form Filled

After saving, the plugin will appear in the Plugins list with a green checkmark indicating it is enabled.

Plugin Created Successfully

Step 3: Create a Container

A container defines how and where the plugin is displayed in the portal navigation. To show the Fuel Analysis plugin in the Tracking sidebar, you need to create a container for it.

  1. In the Settings page, click on the Containers tab

Settings - Containers Menu

  1. Click the ADD NEW button

The "Add Custom Plugin Container" dialog will appear:

Add Container Form

  1. Fill in the container details:
FieldValueNotes
Container NameFuel AnalysisDisplay name shown in the sidebar
Container Pathfuel_analysisURL path segment (use underscores, no spaces)
PluginsSelect the plugin created in Step 2Click the "+" icon and choose "Fuel Analysis"
IconChoose an appropriate iconSelect from the available icon list
AppsSelect TrackingThis determines which portal sidebar shows the container

Add Container Form Filled

  1. Click Save
tip

The Container Path value (fuel_analysis) becomes part of the URL. For example, the plugin will be accessible at /tracking_portal/container/fuel_analysis.

Step 4: Verify in Tracking Sidebar

After creating the container with the "Tracking" app selected, the Fuel Analysis menu item will appear at the bottom of the Tracking portal sidebar.

  1. Navigate to the Tracking portal (switch apps using the app switcher in the header)
  2. Look at the sidebar navigation — you should see Fuel Analysis at the bottom

Fuel Analysis in Tracking Sidebar

  1. Click on Fuel Analysis to open the plugin interface
info

The plugin will load inside the Tracking portal layout, maintaining the same sidebar navigation and header. Users can switch between Tracking features and the Fuel Analysis plugin seamlessly.

Summary

StepActionLocation
1Log in, select client, open Settings → PluginsApplication Selection → Management Portal → Profile Menu → Settings → Plugins
2Upload plugin bundle and configureAdd New Plugin dialog
3Create container with Tracking appSettings → Containers → Add New
4Verify in Tracking sidebarTracking Portal → Sidebar

Troubleshooting

IssueCauseSolution
Plugin not appearing in sidebarContainer not linked to "Tracking" appEdit the container and ensure "Tracking" is selected in the Apps field
Plugin shows blank pageJavaScript bundle not loaded correctlyVerify the .js file was uploaded successfully and the plugin is enabled
"Add Plugin" save failsMissing required fieldsEnsure Plugin Name, JavaScript bundle, and Enabled toggle are set
Container path conflictPath already used by another containerChoose a unique path value (e.g., fuel_analysis_v2)