bbtools.tcl Annotations

Procedure Detail

::bbtools::avgCompleted

proc ::bbtools::avgCompleted { db pj }

Defined in:

bbtools.tcl, line 544

::bbtools::bb-mean

proc ::bbtools::bb-mean { db proj state start end ops_id hlsum hloss }

Gets a performance index for all operators working on the specified project related to the specified state (stato).

Parameters:

db - database connectionhandler

proj - project's id (on the db)

state - specify the 'situation' to look for as a four element list (each element is a list itself)

start - when do I have to start to look for?

end - when do I have to stop to look for?

ops_id - list of 'valid' users (i.e. users that are working on proj)

hlsum - sum of the previous list

hloss - osservation period's duration

Returns:

a performance index for all operators working on a specified project related to a specific state On error returns -1.

Defined in:

bbtools.tcl, line 401

::bbtools::bb-stato

proc ::bbtools::bb-stato { db proj op state start ops_id hls hlsum }

Gets a performance index for operator op. This is the command used by op's GUI.

Parameters:

db - database connection handler

proj - project's id (on the db)

op - operator's id (on the db)

state - specify the 'situation' to look for into a four elements list

start - when do I have to start to look for?

ops_id - list of 'valid' users (i.e. users that are working on proj)

hls - list of minutes worked by each operators on proj (inside the current turn)

hlsum - sum of the previous list

Returns:

a performance index for the operator op. For more details on performance indexes refer to YaaCs's doc. On error returns -1.

Defined in:

bbtools.tcl, line 643

::bbtools::bb_work_hard

proc ::bbtools::bb_work_hard { db proj start {end {}} }

Get a list of users which are working on a specified project and how much time they are working on a period inside a specified scheduled turn.

Parameters:

db - database connection handler

proj - project's id (on the db)

start - when do I have to start to look for?

end - when do I have to end to look for?

Returns:

It returns a list of two lists. The first list reports the amount of time each users have spent on this projects during the current turn; the second one reports operator's id. Obviously times and ids are in the same order so if you refer to the second element of each lists you'll get the amount of time and the id of the same user :) On error returns -1.

Defined in:

bbtools.tcl, line 248

::bbtools::blockType

proc ::bbtools::blockType { db block_id }

Get a string describing the block's type.

Parameters:

db - a database handler to perform the query

block_id - block's id (on the db)

Returns:

a string describing the block's type; return -1 on error.

Defined in:

bbtools.tcl, line 200

::bbtools::checkBlock

proc ::bbtools::checkBlock { db proj uid }

check for user's block on a project

Parameters:

db - - db con handler

proj - - project's id

uid - - user id return number of blocks (if any), -1 on error

Defined in:

bbtools.tcl, line 70

::bbtools::getBlock

proc ::bbtools::getBlock { db id }

Defined in:

bbtools.tcl, line 91

::bbtools::getBlocked

proc ::bbtools::getBlocked { db proj }

Defined in:

bbtools.tcl, line 43

::bbtools::hour_per_int

proc ::bbtools::hour_per_int { db proj start end ossStart op }

Gets the number of hour that a specifed operator has worked on a project starting from start till end.

Parameters:

db - database connection handler

proj - project's id (on the db)

start - when do I have to start to count? (this is a turn start)

end - when do I have to stop?

ossStart - Osservation period start

op - operator's id (on the db)

Returns:

the amount of time (in minutes) spent by op on proj from start to end. On error returns -1.

Defined in:

bbtools.tcl, line 829

::bbtools::howManyBlocked

proc ::bbtools::howManyBlocked { db proj }

Get the number of users blocked.

Parameters:

db - a database handler to perform the query

proj - project's id (on the db)

Returns:

the number of users blocked; return -1 on error.

Defined in:

bbtools.tcl, line 118

::bbtools::lastNCompPerf

proc ::bbtools::lastNCompPerf { db user n }

get the last n user's perfomance indexes related to a 'Completed' outcome.

Parameters:

db - database connection handler

user - user's id

n - how many indexes do you need?

Returns:

returns a list whose elements are array (i.e. lists :) with keys touch, idx_completed, idx_refused; -1 will be returned on error.

Defined in:

bbtools.tcl, line 612

::bbtools::meanCallTime

proc ::bbtools::meanCallTime { db proj statT state start {end {}} }

check the mean time needed to get a specific outcome on a project inside a certain time interval.

Parameters:

db - database connection handler

proj - project's id on db

statT - log table

state - outcome to look for

start - time interval's start point

end - (optional) time interval's end point, default setted to now().

Returns:

mean time to get the specified outcome

Defined in:

bbtools.tcl, line 499

::bbtools::meanCallTimeUser

proc ::bbtools::meanCallTimeUser { db proj user statT state start {end {}} }

get the mean time needed by a user to get a specified outcome on a project (inside a certain time interval).

Parameters:

db - database connection handler

proj - project's id on db

user - user's id

statT - log table

state - outcome to look for

start - time interval's start point

end - (optional) time interval's end point, default setted to now().

Returns:

mean time needed by a user to get the specified outcome.

Defined in:

bbtools.tcl, line 527

::bbtools::ossPeriod

proc ::bbtools::ossPeriod { db proj start end }

Check how many hours has been worked for a given project on a period you wanna watch.

Parameters:

db - database connection handler

proj - project's id

start - osservation period start

end - osservation period end @retutn hours amount; -1 on error.

Defined in:

bbtools.tcl, line 325

::bbtools::outcomeCases

proc ::bbtools::outcomeCases { db pj op start }

return all outcome cases for a user in a project (within the "current" turn).

Parameters:

db - database connection handler

pj - project's id on db

op - operator's id

start - current turn's start

Returns:

array of outcome cases; an empty array is returned on error;

Defined in:

bbtools.tcl, line 565

::bbtools::outcomesCases

proc ::bbtools::outcomesCases { db proj ops_id start statT }

Defined in:

bbtools.tcl, line 726

::bbtools::ownOutcomesCases

proc ::bbtools::ownOutcomesCases { db proj op start statT }

Defined in:

bbtools.tcl, line 747

::bbtools::statUserProj

proc ::bbtools::statUserProj { db login proj }

Get statistics on user's block.

Parameters:

db - a database handler to perform the query

login - user's login name

proj - project's id (on the db)

Returns:

an array with the specific values; if an error occurs while retriving one of the following values it'll be setted to 0 (cause for sure ;) this tell us that the user dosen't have blocks to count for). returned array has the following keys: single_count --> how many 'single' pause blocks did this user do on this project? sum_count --> how many 'sum' pause blocks did this user do on this project? pj_count --> how many blocks did this user get on this project? all_count --> how many blocks did this user get on all projects?

Defined in:

bbtools.tcl, line 140

::bbtools::turnHourPerInt

proc ::bbtools::turnHourPerInt { db proj turnStart start end op }

Get how many hours a specified user spent (or is spending) on a project's turn subset.

Parameters:

db - database connection handler

proj - project's id

turnStart - turn's start

end - osservation period end

op - operator's id

Returns:

hours spent on the specified project by the given user on a turn of a project and the end used to calculate that value packed into a list; It returns -1 on error.

Defined in:

bbtools.tcl, line 774

::bbtools::unlock

proc ::bbtools::unlock { db block_id }

Unlock the block identified by block_id.

Parameters:

db - a database handler to perform the query

block_id - block's id (on the db)

Returns:

0 on success -1 on error.

Defined in:

bbtools.tcl, line 107

::bbtools::whichTurn

proc ::bbtools::whichTurn { db start proj }

Get you turn's start and end of a period statring at start.

Parameters:

db - database connection handler

start - when did you start?

proj - project's id

Returns:

return a two elements list (start,end); -1 on erorr.

Defined in:

bbtools.tcl, line 220