Custom Dashboard Plugin

Introduction  #

The Redmineflux Dashboard Plugin is a powerful tool that provides a visual representation of data and information in the form of interactive dashboards. It is designed to enhance the user experience by displaying key metrics, charts, graphs, and other relevant information in a centralized location. Create informative charts and visualizations based on project data, track progress, and make data-driven decisions. Customize chart types, data filters, and date ranges to create visually appealing and informative dashboards. 

Version Compatibility #

Redmine Versions

  • 4.0.x, 4.1.x, 4.2.x
  • 5.0.x
  • 6.0.x(coming soon)

Installation  #

To install Redmineflux Dashboard Plugin follow these steps

  1. Make sure you have a working installation of Redmine.
  2. Download the Dashboard Plugin from the redmineflux.com website. The plugin typically comes in the form of a ZIP file.
  3. Extract the Dashboard Plugin zip file to Redmine’s plugins directory (/path/to/redmine/plugins) and do not change the plugin folder name.
  4. Run the following command to install the required dependencies
    Bundle install 
  5. Run migrate command for database migration  
    -> In Production 
    RAILS_ENV=Production bundle exec rails redmine:plugins:migrate  
    > In Development
    RAILS_ENV=Development bundle exec rails redmine:plugins:migrate  
  6. If you already have a project created in your Redmine instance, run this command to populate default data:  
    -> In Production 
    RAILS_ENV=Production bundle exec rake grid_data:populate_grid_data   
    > In Development
    RAILS_ENV=Development bundle exec rake grid_data:populate_grid_data   
  7. If you don’t have a project created, you can skip the ‘rake task’ step and proceed directly to restarting the Redmine server. 
    rails s  

Configuration  #

  1. Log in to your Redmine instance using administrative credentials.  
  2. Access the Settings form Administration >> Settings >> API 
  3. Check the checkbox and save the changes to enable the REST API.
  4. Navigate to the project tab, choose the project where you want to use the dashboard plugin. 
  5. Find for the “Dashboard” tab from project menu. 
  6. Click on the “Dashboard” tab, to access the Custom dashboard. 
  7. You’ll be instantly redirected to the project’s specific dashboard page, where you can access all the project insights and information. 
Redmineflux custom dashboard 1

How To  #

How to Create the Chart  #

  1. To navigate to the project tab where you want to use the dashboard plugin
  2. Go to the header tab and click on the “Dashboard” tab.
  3. You will see empty charts on the page.
  4. To create a chart with data, click on the (+)plus icon within the empty chart.
  5. This will open a popup window displaying a list of available queries.
  6. Select a specific query from the list by clicking on it. This will generate the chart with data based on the selected query.

How to Delete the Chart  #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the (x)cross icon to delete the chart.
  5. Confirm the deletion if prompted and delete the chart.

How to Change the Chart Type #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying an option to choose the chart type like bar chart, pie chart, line chart, donut chart and more.
  6. Choose the desired chart type and Click on the save button to change the chart type

How to Change the Chart Legends Position #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying an option to choose the legends position like top, bottom, right, and left.
  6. Choose the desired chart legend position and Click on the save button to change the chart legend.

How to Change the Chart Color #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying an option to choose the chart color light or dark.
  6. Choose the desired chart color and Click on the save button to change the chart color.

How to Change the Chart Status #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying an option to select status like open , close and All.
  6. Select the chart status and Click on the save button to change the status of chart.

How to Choose the Values for Customize the Chart Visualization #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying a drop-down menu where you can choose values for specific query status values to display the chart data accordingly.
  6. Select the chart status values and Click on the save button to change the status of the chart.

How to Select the Date Range #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. You will see the charts on the page. 
  4. Click on the “Setting” icon on the chart.
  5. This will open a popup window displaying presets and custom date range tabs to select the date range.
  6. Select the dates and Click on the save button to display the data according to the date range.

How to Resize the Chart #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab. 
  3. Open the dashboard that contains the chart you want to resize.
  4. Click and drag the resize icon or handles icon to resize the chart.
  5. As you resize the chart, you may see the new size of the chart.

How to Drag-and-Drop the Chart #

  1. Navigate to the header tab and click on the “Dashboard” tab. 
  2. Open the dashboard that contains the chart you want to move.
  3. Click and hold the chart with your mouse or pointer.
  4. Drag the chart to the desired location within the dashboard.
  5. As you move the chart, you should see a visual indicator or placeholder showing where the chart will be positioned once you release the mouse button.
  6. Release the mouse button to drop the chart in the new location.
  7. The chart should now be repositioned within the dashboard based on your drag-and-drop action.

How to Refresh Chart and Enable Full-Screen Mode #

  1. Navigate to the project tab where you want to use the dashboard plugin.
  2. Navigate to the header tab and click on the “Dashboard” tab.
  3. Two icons are located on the right side of the dashboard – “Refresh” and “Full Screen.”.
  4. Click the “Refresh” icon to update all present charts and view the latest data on them.
  5. Click the “Full Screen” icon to enable full-screen mode for the dashboard. To exit full-screen mode, press the “F11” key or the “Esc key.”

How to Search Query #

  1. Navigate to the project tab where you want to use the dashboard plugin. 
  2. Navigate to the header tab and click on the “Dashboard” tab.
  3. To search query, click on the (+) plus icon within the empty card.
  4. This will open a popup window displaying a search field to search query.
  5. How to Add 2d-table According to Custom Queries.
  6. Navigate to the project tab where you want to use the dashboard plugin.
  7. Navigate to the header tab and click on the “Dashboard” tab.
  8. To create a 2d-Table in cards, click on the (+) plus icon within the empty card.
  9. This will open a popup window displaying a list of available queries – “Default Queries” for charts and “Custom Queries” for 2d-Table.

How to Create Multiple Dashboards #

  1. Navigate to the project tab where you want to use the dashboard plugin.
  2. Navigate to the header tab and click on the “Dashboard” tab.
  3. Click on the “Create New Dashboard” button to generate a new dashboard.
  4. This action will prompt a pop-up window where you should create the dashboard.
  5. Enter the dashboard name in the provided text field and then click the “Create” button to generate the new dashboard.
  6. Afterward, you will be directed to the newly created dashboard where you can add charts.
  7. Click on the menu icon within the dashboard heading. This will display a list of newly created dashboards. Click on the desired dashboard to open it.

How to Update Query Heading #

  1. Navigate to the project tab where you want to use the dashboard plugin.
  2. Navigate to the header tab and click on the “Dashboard” tab.
  3. Click the “Settings” icon on the chart or table to update the heading of the chart or table.
  4. Then, click on the pencil icon within the heading to modify the query.
  5. Edit the “Query Name” and press “Enter” to save. Finally, click on the save button to update the query name.
  6. Remember to also update headings across multiple dashboards.
  7. To do this, navigate to the desired dashboard, click on the corresponding dashboard heading, edit the “Query Name,” and press “Enter” to save the query name.

How to Set Global Date Ranges in all Charts #

  1. Navigate to the project tab where you want to use the dashboard plugin.
  2. Navigate to the header tab and click on the “Dashboard” tab.
  3. You will see charts displaying data for the current date, which covers a 60-day period (approximately 2 months).
  4. Click on the date field to select the custom date range.
  5. After selecting your desired date range, click on the “Apply” button to display all the charts that correspond to the selected custom date range.

Troubleshooting #

Check plugin compatibility: Ensure that the plugin version is compatible with your Redmine installation. Refer to the plugin documentation, redmineflux.com website, or the official Redmine plugins repository for compatibility information.

Clear cache: If you made any changes to the plugin or Redmine configuration, clear the Redmine cache and restart the application.

Check for conflicts: Disable any other plugins that modify the same fields or interfere with the inline editing feature. Test if the issue persists without those plugins.

Frequently Asked Questions (FAQ) #

Q: Can I customize the appearance of my dashboard?
A: Yes, Dashboard Plugin often offer customization options to personalize the appearance of your dashboard. This may include customizing color , legend position, Change status, chart type, custom range dates and more.

Q: Can I Resize the charts on my dashboard?
A: Yes, the Dashboard now includes a feature that allows you to resize the charts. When you hover over a chart, you will see a resize icon. Simply use the resize icon to adjust the size of the chart according to your needs.

Q: Can I rearrange the positions of charts on the dashboard?
A: Yes, Click and hold the chart with your mouse or pointer. Drag the chart to the desired location within the dashboard. As you move the chart, you should see a visual indicator or placeholder showing where the chart will be positioned once you release the mouse button. Release the mouse button to drop the chart in the new location. The chart should now be repositioned within the dashboard based on your drag-and-drop action.

Uninstallation of Plugin  #

  1. Go to the Dashboard Plugin directory in Redmine. 
  2. Delete the entire dashboard plugin directory from Redmine/plugins directory. This step removes the plugin files from your Redmine installation. 
  3. If the plugin required a migration, run the following command to downgrade your database (make a db backup before): 
    Bundle exec rake redmine:plugins:migrate Name=plugin name VERSION=0 RAILS_ENV=production 
  4. Restart the Redmine server to see the changes. 
  5. This will uninstall the Redmineflux Dashboard Plugin from Redmine.

Updates and Revisions #

  • Plugin Updates: Keep track of plugin updates and new releases. Visit the redmineflux.com or official plugin website, plugin repository, Plugin updates may include bug fixes, performance improvements, or new features related to tag management.
  • Documentation Revisions: Regularly review the plugin’s official documentation for any revisions or updates. Documentation may be revised to reflect changes in the plugin’s functionality, configuration options, or integration with the latest versions of Redmine.

Powered by BetterDocs