TargetProcess impediment widget

Author: Julian Kleinhans · Blog: http://blog.kj187.de

Dashing-JS is a NodeJS port of Dashing, an Sinatra based framework that lets you build beautiful dashboards.

The TargetProcess impediment widget is a small widget which provides the total amount of impediments of a specific sprint (acid). Below this amount a profile image of the responsible persons are shown.

Preview

Zero Impediments

Example Dashboard

Example

Requirements

Dashing-JS

$ npm install -g dashing-js

Widget dependencies

$ npm install tp-api
$ npm install cron

Installation

$ dashing-js install https://github.com/kj187/dashing-targetprocess_impediments/archive/master.zip

Create a new directory config on your root directory. Move the widgets/targetprocess_impediments/config.targetprocess_impediments.sample.js file to this directory and rename it to config.targetprocess_impediments.js.

assets/
  ...
config/
  config.targetprocess_impediments.js
  ...
dashboards/
  ...
jobs/
  ...
...

Usage

To include the widget on your dashboard, add the following snippet to the dashboard layout file:

<li data-row="1" data-col="1" data-sizex="1" data-sizey="1">
  <div data-title="Impediments" data-id="targetprocess_impediments" data-view="TargetprocessImpediments"></div>
  <i class="fa fa-clock-o icon-background"></i>
</li>

Or if you use Jade as your favorite template engine

li(data-row='1', data-col='1', data-sizex='1', data-sizey='1')
  div(data-title='Impediments', data-id='targetprocess_impediments', data-view='TargetprocessImpediments', class='widget')
  i(class='fa fa-exclamation-triangle icon-background')

Settings

module.exports = {

    eventName: 'targetprocess_impediments',
    cronInterval: '15 * * * * *',

    api: {
        host: 'www.host.com',
        context: '2439DD66D093095E290CF98FB987D4B7',
        version: '1',
        protocol: 'https',
        token: 'bcdefabcdefabcdefgbcdefabcdefabcdefg'
        // or instead of an API token
        // username: '',
        // password: '',
    },

    profileImageMapping: {
        // targetprocess user id : Profile image URL
        '85861': 'https://avatars0.githubusercontent.com/u/1647861?v=3&s=96',
    }
}

Global settings

Setting	Example	Description
eventName	targetprocess_impediments	Event name, must be the same as the `data-id` attribute
cronInterval	1 * * * * *	Click here for available cron patterns

API settings

Setting	Example	Description
host	www.host.com	Host of your TargetProcess
protocol	https	Http or https
context	2439DD66D093095E290CF98FB987D4B7	ACID ID of the specific project from where you fetch the impediments count
version	1	TargetProcess API version, dont change
token	bcdefabcdefabcdefgbcdefabcdefabcdefg	TargetProcess API token
username	julian.kleinhans	If you dont have an API token, you can also use your username/password. But I highly recommend to use an API token
password	xxxxxxx	Your TargetProcess password

profileImageMapping settings

TargetProcess user id	Profile image URL
85861	https://avatars0.githubusercontent.com/u/1647861?v=3&s=96

TargetProcess impediments