Introduction #

Redmineflux Gantt Chart plugin is a powerful Redmine plugin that helps visualize project schedules, tasks, and dependencies in a clear and organized manner. By presenting tasks as horizontal bars along a timeline, Gantt charts offer a visual representation of project activities, their start and end dates, and how they interrelate. Redmineflux Gantt Chart has become an essential asset for project managers, teams, and stakeholders to effectively plan, monitor, and track project progress. 

Installation

To install the Redmineflux Gantt Chart Plugin  follow these steps

• 1. Make sure you have a working installation of Redmine. 
  2. Extract the downloaded Gantt Chart  archive to the “Plugins” directory of your Redmine installation.
  3. Run the following command from the Redmine root directory to install the plugin dependencies:
     bundle install
  4. Run migrate command for database migration:
     ->In Production
     RAILS_ENV=production bundle exec rake redmine:plugins:migrate
     ->In Development
     RAILS_ENV=development bundle exec rake redmine:plugins:migrate
  5. Run the below two rake command to create dependencies:
     ->In Production
     RAILS_ENV=production bundle exec rake colors:update_issue_colors
RAILS_ENV=production bundle exec rake updatedates:update
     ->In Development
     RAILS_ENV=development bundle exec rake colors:update_issue_colors
RAILS_ENV=development bundle exec rake updatedates:update
  6. Restart the Redmine server to load the plugin
     rails s  

Configuration #

Step 1:  To Enable REST API #

1. Login as a administrator.
2. Navigate to Administration tab from top menu.
3. Click on Settings and find the API tab and enable the rest API.

Step 2: Ensure that default values are set for the following attributes #

1. Establish a default priority value by selecting one from the available issue priorities.
2. Choose a default tracker value from the list of available trackers.
3. Specify a default status value by selecting one from the available issue statuses.

Step 3: Enabling Gantt Chart Plugin in a project #

1. Navigate to projects tab on top menu.
2. Click on any project from the list.
3. Navigate to project settings
4. Enable the Redmineflux Gantt Chart from the modules and click on save to apply the changes.
5. Now you can see the Gantt Chart plugin on project menu.

Step 4:  Create a new Version/Release #

1. Click on Add release button, enter the desired result and click on save to create.
2. Provide the desired information such as name, description, due date and click on save.
3. The start date of version will be created date.

Step 5:  Enable baseline in Gantt chart plugin #

1. Navigate to projects tab on top menu.
2. Click on any project from the list.
3. Navigate to project settings
4. Enable the Redmineflux Gantt Chart from the modules and click on save to apply the changes.
5. Now you can see the Gantt Chart plugin on project menu.
6. To enable the baseline feature in the Gantt chart, go to the project settings and check the ‘Baselines’ module. 

How to use Gantt Chart Plugin? #

How to View Gantt Chart ? #

1. Login to Redmine using your credentials. 
2. Navigate to the desired project for which you want to view the Gantt Chart. 
3. Click on “Flux Gantt” tab to access the Gantt Chart of specific Project.

How to Create a Release Using Gantt Chart?  #

1. To create a new Release using Redmineflux Gantt Chart click on “Add Release” button. 
2. A popup will appear with name, description and due date field. 
3. Fill all the fields and click on “Save” button. 
4. A new release will be visible in the Gantt dashboard. 
5. Click on “Cancel” button to discard the changes.

How to Update Release Using Gantt Chart?  #

To update release in the Gantt Chart, follow these steps: 

1. Double-click on the release name. 
2. A popup will appear displaying fields release name, description and due date. 
3. Update the desired field and click on “Save” button. 
4. If you wish to discard the changes, you can click the “Cancel” button to revert the changes and close the popup window.

How to Add Task to the releases in the Gantt Chart?  #

1. To add a task to a release in the Gantt Chart click on the “Add Issue”button. 
2. Upon clicking, a popup window will appear, displaying fields such as subject, start date, due date, and more. 
3. Fille in all the required fields and click on “Save” button.
4. This action will result in the addition of a new task to the specified release, and it will become visible on the Gantt dashboard. 
5. If you need to abandon the changes, you can click on the “Cancel” button to revert the changes and close the popup window.

How to Update Task Using Gantt Chart ? #

To update task in Gantt Chart follow these steps 

1. Double-click on the task bars within the timeline area. 
2. A popup will appear, displaying fields like subject, start date, release, and more. 
3. Update the desired field and click the “Save” button. 
4. The selected task will be updated and will be reflected in the Gantt dashboard. 
5. If you wish to discard the changes, you can click the“Cancel” button to revert the changes and close the popup window.

How to Delete Task Using Gantt Chart ?  #

To Delete task from Gantt Chart, follow these steps: 

1. Double-click the task you wish to delete in the Gantt Chart. 
2. A popup will appear; within this popup, you will find a “Delete” button. 
3. A confirmation popup will subsequently appear; click the “Delete” button within this confirmation popup to remove the task from the Gantt Chart. 
4. Should you need to discard the changes, you can click the “Cancel” button to undo the changes and close the popup window.

How to Add Task Relation Using Gantt Chart? #

To establish task relations (links) in the Gantt Chart, follow these steps: 

1. Open your Redmine project and navigate to the Gantt Chart view. 
2. Identify the task you want to link with another task. Click on the task bar to select it. 
3. While holding down the mouse button, drag the selected task’s bar to the target task’s bar. This initiates the process of creating a task relation. 
4. Once you’ve positioned the selected task’s bar over the target task’s bar, release the mouse button. This action will trigger a context menu. 
5. The task relation will then be established between the two tasks. 
6. The Gantt Chart will now illustrate the established task relation, providing a clear representation of the interdependency between the tasks.

How to Delete Task Relation (link) Using Gantt Chart?   #

To delete task relations (links) in the Gantt Chart, follow these steps: 

1. A confirmation popup will appear. Click the “Delete” button to remove the task relation. 
2. Once you have clicked the “Delete” button, task relation will be removed from the Gantt Chart.

How to customize columns Using Gantt Chart?   #

To customize columns in the Gantt chart, follow these steps: 

1. Upon clicking it, you will see a list of columns you can add to the Gantt Chart, such as task progress, assignee and estimated hours. 
2. If you check the checkboxes besides column names, the selected column names will be added to the Gantt Chart. 
3. If you uncheck the checkbox, the selected column will be removed from the Gantt Chart.

How to change task bar colors Using Gantt Chart?   #

To view Gantt Chart in Full Screen Mode, follow these steps: 

1. Open your Redmine project and navigate to the Gantt Chart view. 
2. Click on the task bar to change the color as per our requirement.

How to move task from one release to other release Using Gantt Chart?  #

To move task from one release to another using Redmineflux Gantt Chart, follow these steps: 

1. Choose the task that you intend to move from its current release to another one. 
2. Click and hold the selected task, then drag it to the section corresponding to the desired release. 
3. Release the mouse button to drop the task into the chosen release section. 
4. After dropping the task, the release associated with the task will be automatically updated. You will now see this change reflected in the Gantt Dashboard

How to Expand and Collapse Gantt Chart? #

1. To Collapse Gantt Chart, simply click on “Collapse All” option. 
2. To Expand Gantt Chart, simply click on “Expand All” option.

How to Search for Tasks or Releases in the Gantt Chart?  #

The Redmineflux Gantt Chart feature allows users to conveniently search for tasks within the Gantt dashboard using task ID or subject. Additionally, users can search for specific release by utilizing release ID or name. 

How to View the Gantt Chart for a Custom Date Range in Gantt Chart? #

To view the Gantt Chart for a custom date range in Redmineflux Gantt Chart, follow these steps: 

1. Locate the date range selector or date picker option. 
2. Click on the date range selector to open the calendar. 
3. Choose the start date and end date that define your desired custom date range. 
4. Once you have selected the appropriate dates, the Gantt Chart will automatically update to display the tasks and release allocation within the specified custom date range. 

By selecting a custom date range, you can easily analyze and monitor the Gantt Chart of your team or project within a specific timeframe, allowing for better planning and release management. 

How can I change the zoom level options to view the Gantt Chart differently?  #

To adjust the zoom level and view the Gantt Chart with different levels of detail, follow these steps: 

1. Click on the “Zoom Level” option in the Gantt Chart interface. 
2. From the dropdown menu, select your desired option, which may include choices like day, hour, week, month, or year. 
3. As you make your selection, the Gantt Chart will automatically adjust to display tasks and timeframes in the chosen zoom level, providing you with a different level of detail tailored to your selection.

How to create a milestone task in Gantt Chart ? #

To create a milestone task in Gantt Chart, follow these steps:  

1. Add a task in the Gantt Chart. 
2. Set both the start and due dates to be the same.
3. In the task subject, include the word “milestone” or “Milestone” within parentheses. For example: (milestone), (Milestone). 

Alternatively, users can directly enter “(milestone)” in the task subject and ensure that the start and end dates are identical. This way, the task will be considered a milestone in the Gantt Chart. 

How to Export Gantt Chart in PDF, PNG and Excel Format   #

To view and export the Gantt Chart in PDF, PNG, or Excel format, please follow these steps:

1. Click on the project whose Gantt chart you want to view
2. Click on the “Flux Gantt” tab in the project menu. 
3. Click on the download icon
4. You will see three options: Export to PDF, Export to PNG, and Export to Excel. 
5. Click on your desired format, and the Gantt chart in the selected format will be downloaded to your system. 

How to view Baseline in Gantt Chart Plugin  #

To view baselines in the Gantt Chart Plugin, follow these steps: 

1. Go to the project settings and enable the “Baselines” module if you have administrator access. 
2. Click on the “Flux Gantt” tab in the project menu. 
3. Click on the settings icon and check the “Baseline” checkbox to enable baseline options. 
4. Once enabled, click on “Create Baseline” to create a new baseline in the Gantt Chart Plugin. 
5. Newly created baselines will appear in the dropdown menu. 
6. To delete a baseline, click on the “Delete” option. A confirmation popup will appear, and after confirming, the selected baseline will be deleted from the Gantt chart. 
7. Once the baselines are created, you can view them in the Gantt chart view. 

Troubleshooting #

• Check Browser Compatibility: Ensure that you are using a supported web browser for the Redmineflux Gantt Chart. Some features might not work properly if you are using an outdated or unsupported browser. Consider using the latest versions of browsers like Google Chrome, Mozilla Firefox, or Microsoft Edge. 
• Clear Browser Cache: If you notice any unusual behavior, try clearing your browser’s cache and cookies. Cached data can sometimes cause display or functionality issues. 
• Update Redmine Plugin: Ensure that you are using the latest version of the Redmineflux Gantt Chart plugin. Outdated plugins might not be fully compatible with the latest versions of Redmine or might have bugs that have been fixed in newer releases. 
• Check Redmine Version Compatibility: Verify that the version of Redmine you are using is compatible with the version of the Flux Gantt Chart plugin. Some features might not work correctly if there is a compatibility mismatch. 
• Disable Conflicting Plugins: If you have multiple plugins installed in Redmine, there might be conflicts between them. Temporarily disable other plugins and check if the Gantt Chart issue persists. This can help identify if a specific plugin is causing the problem. 
• Check Permissions: Ensure that you have the necessary permissions to access and use the Gantt Chart feature. Check your user roles and settings in Redmine to make sure you have the required privileges. 

 Frequently Asked Questions (FAQ’s)  #

1. What is the Redmineflux Gantt Chart plugin?  

The Redmineflux Gantt Chart plugin enhances the project management capabilities of Redmine by providing an interactive Gantt Chart view. It helps visualize project timelines, tasks, dependencies, and resource allocation. 

2. How do I install the Flux Gantt Chart plugin in Redmine?  

To install the plugin, you typically need to download the plugin files, upload them to your Redmine installation, run database migrations, and then restart your Redmine instance. Detailed installation instructions can be found in the plugin’s documentation. 

3. Can I customize the appearance of the Gantt Chart?  

Yes, the plugin often offers customization options. You can usually adjust colors, date formats, and the way tasks are displayed on the Gantt Chart. Refer to the plugin’s documentation for details on available customization settings. 

4. Can I link tasks and set dependencies using the Gantt Chart?  

Yes, most Gantt Chart plugins allow you to define task dependencies and link them together. This helps represent the logical sequence of tasks within a project. 

5. Are there zoom options available in the Gantt Chart?  

Yes, zoom options are often provided to allow you to adjust the level of detail on the Gantt Chart.  

6. How can I move tasks on the Gantt Chart to different dates?

You can typically click and drag tasks to move them to different dates on the Gantt Chart. This is a convenient way to adjust timelines when project schedules change. 

7. Which task is considered a milestone task in Gantt Chart?

A milestone task in a Gantt Chart is one with both the start and due dates being the same. The task subject should include the word “milestone” or “Milestone” within parentheses. For example: (milestone), (Milestone) 

Uninstallation   #

To uninstall the Redmineflux Gantt Chart Plugin , follow these steps: 

1. Go to the Gantt Chart Plugins directory in Redmine. 
2. Delete the entire Gantt Chart 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 Gantt Chart Plugin from Redmine. 

Version Compatibility   #

Redmine Versions #

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

Conclusion  #

Redmineflux Gantt Chart plugin serves as an invaluable asset in your project management toolkit. By seamlessly integrating with your existing Redmine environment, it empowers you to visualize project timelines, track task progress, and manage dependencies with unprecedented clarity.