CostControl

Use the new Cost Control section to enable currencies and budgeting in Kanboard. Get live currency rates automatically for over 120 currencies allowing users to compare with manually saved rates. This plugin replaces and extends the features from the original Budget plugin enabling projects to have an associated cost element.

[↓ Bottom] [→ Next] [↑ Top]

Features

• Introducing a new Cost Control section allowing access for all users to use and update all currency rates
  • Access directly from the dashboard or from the user dropdown menu
  • New menu template hook for developers: template:cost-control:sidebar
• Quickly filter through all the currencies
• Application Currency is known as Base Currency (can only be edited by admins)
• Save a favorite currency as Reference Currency (can only be edited by admins)
• Choose from over 120 currencies in your projects
  • 101 New currencies in addition to the 25 standard default currencies
  • All currency codes are ISO 4217 three letter currency format
  • Includes XDR - International Monetary Fund (IMF) Special Drawing Rights
• Budget Management - Budget plugin imported feature
  • Budget management is based on subtask time tracking, the user timetable and the user hourly rate
• Budget Lines - Budget plugin imported feature
  • Budget lines are used to define a budget for the project
  • Budgets can be adjusted by adding a new entry with an effective date
• Cost Breakdown - Budget plugin imported feature
  • Individual costs of each subtask are shown
  • Time spent is rounded to the nearest quarter
• Budget Chart - Budget plugin imported feature
  • Show expenses representing user costs
  • Show budget lines as the provisioned budget
  • Display the remaining budget at any given time
• User Hourly Rate - Budget plugin imported feature
  • Each user can have a set hourly rate in User Profile ⥂ Hourly Rate
  • This feature is used for budget calculation
  • Each hourly rate shows an effective date with different currencies
• Live Currency Rates
  • Live updated currency rates are retrieved daily from ExchangeRate-API
  • Show the last updated time when each currency was updated (except for currencies with a rate of 1.0)
  • Show an alert notification to inform the user of the next update
• Manual Currency Rates
  • Show the last modified date for manual currency rates
  • Add a comment for each manual rate for easy reference
    • Replace previous comments directly when modifying manual rates
  • Add and edit comments individually

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Screenshots

Cost Control

Reference Currency with Manual and Live Rates

All Rates

Options

Settings

Budget Lines

Cost Breakdown

Budget Graph

Hourly Rate

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Usage

Go to Project ⥂ Budget

Go to Settings ⥂ Currency Rates

Go to Dashboard ⥂ Cost Control

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Installation & Compatibility

Installation

• Install via the Kanboard Plugin Directory or see INSTALL.md
• Read the full Changelog to see the latest updates

Compatibility

• Requires Kanboard ≥1.2.20
• Other Plugins & Action Plugins
  • Compatible with URLCleaner, PluginManager
  • Migrating data from the Budget plugin
    • Uninstall the Budget plugin
      • The data in the database is not deleted by default
    • Install the CostControl plugin
      • Database tables for the imported features are identical therefore data should be preserved
      • The clean URLs will change therefore any saved bookmarks must be updated
• Core Files & Templates
  • 03 Template overrides
  • Database Changes:
    • 01 New database table created as budget_lines
    • 01 New database table created as hourly_rates
    • 04 New columns added to the currencies table as last_modified, comment, live_rate, live_rate_updated

Translations

• Starter template available

[↓ Bottom] [← Previous] [→ Next] [↑ Top]

Authors & Contributors

• @aljawaid - Author
• Craig Crosby - Contributor
• Frédéric Guillot - Author (imported features from the Budget plugin)
• Contributors welcome

[↓ Bottom] [← Previous] [↑ Top]

License

• This project is distributed under the MIT License

---

[↑ Top]