Time Tracker App

Introduction #

The Redmineflux Time Tracker Plugin is a powerful tool that enhances real-time time-tracking capabilities within the Redmine project management system. This user guide walks you through the installation, configuration, and usage of the plugin, enabling you to efficiently track, manage, and analyze time-related data for your projects.

The plugin provides an intuitive, modern interface for a seamless experience when logging work hours.

Version Compatibility #

Supported Redmine versions:

• 5.0.x
• 5.1.x
• 6.0.x

Installation #

To install the Redmineflux Time Tracker Plugin:

1. Ensure you have a working installation of Redmine.
2. Unzip the plugin archive.
3. Upload the Time Tracker folder to Redmine/plugins.
4. Do not change the plugin folder name.
5. Install required dependencies:bundle install
6. Run database migrations.For production:RAILS_ENV=production bundle exec rails redmine:plugins:migrateFor development:

   RAILS_ENV=development bundle exec rails redmine:plugins:migrate

7. Restart the Redmine server.Example:bundle exec rails server

Configuration #

To configure the Time Tracker plugin:

1. Log in to Redmine using administrative credentials.
2. Navigate to Administration.
3. Open Plugins.
4. Locate Redmineflux Time Tracker.
5. Click Configure.
6. Configure the available options.
7. Click Apply to save the changes.

Available configuration options:

• Require Location Permission When enabled, users must allow location access when starting or stopping the timer. You can specify users who must enable location tracking. If no users are selected, location tracking is required for all users.
• Enable Manual Time Entry Allows users to manually enter time entries with custom start and end times.
• Google Maps API Key Required to display user locations on the map view.
• Time Tracker Page Design Choose from:
• Modern Card
• Compact Layout
• Detailed Expanded

You can preview each design before selecting.

Roles and Permissions #

The plugin provides the following role permissions:

• View Time Tracker Activity Allows users to access the activity module.
• View Time Tracker Reports Enables access to all reports within the plugin.
• Manage Time Tracker Tags Allows users to create, edit, and delete tags.

How to View the Time Tracker #

To open the Time Tracker:

1. Open your web browser and navigate to the Redmine login page.
2. Log in using your username and password.
3. From the dashboard or home page, click Time Tracker in the navigation menu.

On the Time Tracker page, you can:

• Start a timer
• Add a manual time entry
• View current and previous time entries by scrolling

How to Run the Timer #

To start and stop the timer:

1. Select the Project, Issue, Tag, and Activity.
2. Click the Start button. The timer begins running and a Stop button appears.
3. To stop the timer:
   • Click Stop.
   • Enter a comment, if required by Redmine settings.
   • Fill any required custom fields.
   • Click Stop to save the time entry.

Note:

• If location tracking is required and the user denies location access, the timer will not start.

How to Update Time Entries from the Time Tracker #

You can update the following fields inline:

• Comment
• Tag
• Activity
• Start Time
• End Time
• Date

To update a field:

1. Click on the field you want to edit.
2. Update the value.
3. Press Enter to save the changes.

How to Log Time Manually #

To log time manually:

1. Go to the Time Tracker page.
2. Click Manual Time Log.
3. Select the project, issue, and required fields.
4. Enter the Start Time, End Time, and Date.
5. Click Add to save the entry.

Note:

• Manual time entry must be enabled by the admin in plugin configuration.

How to Duplicate a Time Entry #

To duplicate a time entry:

1. Go to the Time Tracker page.
2. Locate the time entry you want to duplicate.
3. Click the context menu (three vertical dots).
4. Select Duplicate.
5. Confirm the action.

Note:

• Entries with the same data on the same day are automatically combined.

How to Delete a Time Entry #

To delete a time entry:

1. Go to the Time Tracker page.
2. Locate the time entry to delete.
3. Click the context menu (three vertical dots).
4. Select Delete.
5. Confirm the deletion.

How to Log Time from the Calendar #

To log time from the calendar view:

1. Open the Time Tracker page.
2. Click the Calendar icon from the sidebar.
3. Click Add Time Entry.
4. Fill in the required fields.
5. Click Log Time to save the entry for the selected time range.

How to Edit Time Entries from the Calendar #

You can edit time entries from the calendar in multiple ways:

• Extend or reduce time by dragging the start or end of the entry.
• Double-click the entry to edit details.
• Drag and drop entries to move them between dates.

How to View Activity in the Time Tracker Plugin #

To view activity logs:

1. Go to the Time Tracker page.
2. Open the Activity tab.
3. View activity logs for all users.
4. Apply filters based on:
   • Project
   • User
   • Custom date range
5. Use Map View to see user locations, when location data is available.

Reports in the Time Tracker Plugin #

The plugin provides three types of reports.

Summary Report #

• Group data by Project, User, or Activity
• View chart-based summaries
• Export reports in PDF, CSV, or XML

Detailed Report #

• View detailed time entry data
• Filter by project, user, and activity

Weekly Report #

• View weekly time data
• Filter by user and project

Managing Tags in the Time Tracker Plugin #

To manage tags:

1. Open the Time Tracker plugin.
2. Navigate to the Tags section.
3. Create a tag by entering a name and clicking Add.
4. Filter tags by Used or Unused.
5. Edit or delete tags as needed.

How to Use the Time Tracker Browser Extension #

To configure and use the browser extension:

1. Open the Extension
   • Click the Time Tracker extension icon in your browser.
2. Configure Settings
   • Enter the Base URL of your application.
   • Provide your API Key.
   • Click Test Connection to verify the setup.
   • If the connection is successful, click Save Settings.
3. Start Tracking Time
   • Select the Project from the dropdown.
   • Click Start to begin the timer.
   • The timer runs in the background.
4. Stop Tracking Time
   • You can close the extension while the timer is running.
   • When you want to stop tracking, reopen the extension.
   • Click Stop.
5. Time Log Recorded
   • Your time entry is saved in the system.

Troubleshooting #

If you face issues with the plugin, try the following.

1. Ensure the plugin is installed correctly.
   • Verify that the Redmineflux Time Tracker Plugin folder exists in Redmine/plugins.
   • If the folder name was changed, the plugin may not load. Use the exact folder name provided in the plugin package.
   • After installation or updates, always run:bundle installRAILS_ENV=production bundle exec rails redmine:plugins:migrate
   • Restart the Redmine server after installation.
2. Confirm user roles and permissions..
   • Go to Administration.
   • Open Roles and Permissions.
   • Verify the required permissions are enabled:
     • View Time Tracker Activity
     • View others’ time entries, if needed
     • View Time Tracker Reports
     • Manage Time Tracker Tags
3. Check location permissions.
   • The plugin may require location access based on admin settings.
   • If location access is denied, the timer will not start.
   • Check the browser location permission settings.
4. Verify the Google Maps API Key.
   • Confirm that a valid Google Maps API Key is entered in the plugin configuration.
   • Ensure the key has the required Maps API services enabled.
5. Resolve layout or display issues.
   • Clear browser cache.
   • Verify the selected layout: Modern Card, Compact Layout, or Detailed Expanded.
   • Refresh the Time Tracker page.
   • Switch to another layout to isolate UI issues.
6. Resolve layout or display issues.
   • Ensure the user has edit permissions.
   • Check required custom fields.
   • Make sure required Redmine fields are not missing.
   • Reload the page and try again.
7. Migration or database issues.
   • Re-run plugin migration.
   • Ensure no old database schema conflicts exist.
   • Restart Redmine after migration.

Frequently Asked Questions #

Q1. How do I install the Redmineflux Time Tracker Plugin?

Upload the plugin folder to Redmine/plugins, run bundle install, run plugin migration, and restart the Redmine server. The full installation guide is included in this document.

Q2. Where can I access the Time Tracker?

After logging in, go to the top navigation and click Time Tracker. You will see the timer, manual timer, and the list of time entries.

Q3. Can I manually enter time?

Yes. Enable Manual Time Entry from plugin configuration to allow users to add custom start and end times.

Q4. How do I start and stop the timer?

Select project, issue, tag, and activity, click Start, fill required custom fields if enabled, and click Stop. The time entry is saved.

Q5. Can I edit time entries inline?

Yes. You can edit comments, tag, activity, start time, end time, and date. Click the field, edit the value, and press Enter.

Q6. Does the plugin track user location?

Yes, if enabled by the admin. Users must allow browser location access.

Q7. Can I view or manage tags?

Yes. Users with the Manage Time Tracker Tags permission can manage tags in the plugin.

Q8. Can I view reports?

Only if the role has the View Time Tracker Reports permission enabled.

Q9. I switched domains. How can I reactivate the plugin?

Update the domain URL in your Redmineflux account’s Order section, then re-enter your License Key and Security Key in Redmine.

Uninstallation #

To uninstall the plugin:

1. Go to Redmine/plugins.
2. Delete the Time Tracker plugin folder.
3. If migrations were applied, revert them:bundle exec rake redmine:plugins:migrate NAME=plugin_name VERSION=0
4. Restart the Redmine server.

This will completely remove the plugin from your Redmine instance.

Take a database backup before rollback or uninstallation.

Conclusion #

The Redmineflux Time Tracker Plugin provides a modern, intuitive solution for tracking and managing work hours across projects. With features like real-time tracking, manual entry, location logging, customizable layouts, and permission-based access, it streamlines time management in Redmine. Following this guide ensures a smooth installation, configuration, and daily use experience.