Instructions for installing the plugin «KPI»

Before installation

  1. Make sure that your server meets the system requirements for plugin «KPI»

Redmine Ruby Rails Database The Browser
Guaranteed 2.6, 3.0, 3.1, 3.2 1.9.3, 2.0, 2.1, 2.2 3.2, 4.2 MySQL Chrome, Firefox, Opera, Internet explorer 9, 10
Should work > 3.2 > 2.2 x PostgreSQL, MSSQL Any modern browser

  1. Make sure that you transfer files to the server in the binary mode if copying files via ftp or ssh-client.

Installation

  1. All the files used in the instructions, you can download in your personal account page.
  2. Unzip the archive with the plugin «KPI»
  3. Copy the folder with the plugin «KPI» in the plugins folder of «Redmine» — «plugins»
  4. Copy the folder «ldap_users_sync» in the plugins folder «Redmine» — «plugins»
  5. Copy the folder «global_roles» in the plugins folder «Redmine» — «plugins».
  6. Copy the folder «a_common_libs» in the plugins folder «Redmine» — «plugins».
  7. Copy the folder «ajax_counters» in the plugins folder «Redmine» — «plugins».
  8. Clone plugin «mathjax» in the plugins folder «Redmine» — «plugins» from «GitHub»: git clone https://github.com/SkiF91/mathjax.git
  9. Copy folder «rgloader» to the root directory of «Redmine»
  10. Ensure that the user, under which you run the web-server, has access to the root installation folder of «Redmine». As possible solution for UNIX operating systems, run the following commands:
    sudo chmod 775 -R your_redmine_root_folder
    sudo chown -R your_web_server_group:your_web_server_user your_redmine_folder
  1. Run `bundle install` to install missing gems (make sure performing command in the root installation folder of «Redmine»)
    bundle install
  1. Perform plugin migrations (make sure performing command in the root installation folder of «Redmine»):
    rake redmine:plugins:migrate RAILS_ENV=production
    
  1. Fill in the database with the necessary data (specify the language correctly)
    rake redmine:fill_kpi_values LANG=ru RAILS_ENV=production
  1. For proper work of plugin, it`s highly desirable to transfer storage of session data to database instead of cookies.
    To do this you need: Edit redmine file: your_redmine_dir/config/application.rb. Comment line with session storage in cookies and write new line with session storage in DB.
    # config.session_store :cookie_store, :key => '_redmine_session'
    config.session_store :active_record_store

After installation

  1. Go to the «A common libs» plugin settings and make sure that libraries «Select2», «jqPlot» and «Bootstrap» are enabled. Also checkboxes «Enable javascript patches» and «Enable tiny modals» should be turned-on.
  2. Go to menu «Departments» in Administration menu and create departments structure of your company. Use button Add department to create department.
  3. Go to menu «Positions» in Administration menu and create positions structure of your company. Use button Add position to create position.

After this manipulations you can go to menu «KPI» in top menu and configure kpi calculations. For example you can use: http://kpi.demo.rmplus.pro/kpi/

Create Performance indicators and KPI patterns. Then you can create calculation periods based on KPI patterns.

To correct calculation of period you should include clock rate in it on tab Salary. You can write it manually, or take it from through indicators that can be set each month by special person.

To made through indicator visible in clock rate field of calculation period - you should set up flag «It`s a clock rate» on window of creation/editing of through indicator.

Configuring of plugin KPI step by step

Details of the configuration steps for KPI you can find in the manual: Configuring of plugin KPI step by step