Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

setting section details

Setup threshold

Collection 'kpi_master' stores the information about all KPIs. One document refer to one KPI in this collection.

To change threshold value for any KPI, update the value for field 'thresholdValue' in 'kpi_master' collection against required KPI.

Setup Aggregation

In KnowHOW dashboard, admin can set different aggregation criteria for different KPIs. Supported aggregation criteria are - Average, Median, Sum and Percentile.

Aggregation criteria for each KPI is mentioned in collection 'kpi_master' under field 'aggregationCriteria'. To change this value, we need to update 'aggregationCriteria' field value in the database.

Properties File Configuration

 Sr

S. No.

Property

Field

Name

Purpose of

properties

property

Possible Values

Impacts

1

Impact

1

spring.data.mongodb.host

Used to create connection on MongoDB from application

<host-name> where db is hosted

Complete Application

2

spring.data.mongodb.port

<db_port>

3

spring.data.mongodb.database

<database_name>

4

spring.data.mongodb.username

<user_name> that can perform all actions on database

5

spring.data.mongodb.password

<password>

6

auth.accountLockedThreshold

Property used to set limit for wrong password entry. Account will be locked after this.

number [1-20]

limit of wrong password entry

7

auth.accountLockedPeriod

Property used to lock account for period (in minutes)

number [1-20]

lock account for some minutes

8

sprintCountForFilters

property used to control/limiting closed sprint count in boards

number [1-20]

limiting closed sprint for Jira

KPI

KPIs (scurm)

2

9

sonarWeekCount

property used to control X axis number for Sonar kpis

number [1-20]

Sonar

KPI

KPIs (scurm and kanban)

3

10

jenkinsWeekCount

property used to control x axis number for jenkins kpis

number [1-20]

Jenkins

KPI

KPIs (scurm and kanban)

4

11

repoXAxisCount

property used to control x axis number for Repo related kpis

number [1-20]

Repo related

KPI

KPIs (scurm and kanban)

5

12

repoXAxisCountForCheckInsAndMergeRequests

property used to control x-axis number for Repo related kpis

number [1-20]

Check-ins & Merge Requests Kpi

13

backlog.sprint.count

 property used to control x axis number of sprint count

number [1-15]

Backlog Reediness KPI

14

forgotPassword.expiryInterval

Property used to expire forgot password

number [1-n]

forgot password functionality

15

forgotPassword.emailSubject

Property used to define subject of forgot password email

String [a-z, A-Z]

forgot password email

16

corsFilterValidOrigin

Property used to provide valid origin

String [a-z, A-Z, 0-9] - localhost

CORS

17

speedyLatestVersionKey

property used to provide key in version api

String [a-z, A-Z] - latestVersion

version metadata api

18

applicationDefaultLogo

property used to define name of logo

String [a-z, A-Z]

logo

19

hierarchySelectionCount

property used to get the limit of selections on hierarchy level

number [1-5]

hierarchy selection

6

20

dateRangeFilter.types

property used to get date filter options of kanban board

Days, Weeks, Months

Date Filters

7

21

dateRangeFilter.counts

property used to get date filter value of kanban board

5,10,15

Date Filters

22

8

capacity.kanban.numberOfPastWeeks

property used to get data on kanban team capacity upload screen

number [1-20]

capacity KPI

9

23

capacity.kanban.numberOfFutureWeek

property used to get data on kanban team capacity upload screen

number [1-20]

capacity KPI

24

10

testExecution.kanban.numberOfPastDays

property used to get data on kanban test execution upload screen

number [1-20]

Test Execution KPI

11

25

testExecution.kanban.numberOfFutureDays

property used to get data on kanban test execution upload screen

number [1-25]

Test Execution KPI

26

12

jiraXaxisMonthCount

property used to control x axis number for jira kpis working on month basis

number [1-20]

Cost of delay,Release frequency KPI (scrum and kanban)

13

27

totalDefectCountAgingXAxisRange

Total Defect Count Aging chart x axis range. value is in month

0-1,1-3,3-6,6-12,>12

Open Ticket Ageing By Priority and Production Defects Ageing KPI

28

percentileValue

Percentile Value to use if aggregation criteria is percentile

number [10-90]

Any KPI

14

forgotPassword.expiryInterval

Property used to expire forgot password

number [1-20]

forgot password functionality

15

forgotPassword.emailSubject

Property used to define subject of forgot password emailProperty used to provide valid origin

for which aggregation criteria is percentile

29

applicationDetailedLogger

Property used for detailed logger

On, Off

Application logging

30

encryptionKey

31

aesEncryptionKey

Key used in AES encryption/decryption

256-bit keys

Password encryption

32

rsaPrivateKey

Key used to decrypt the password received in request at time of Login

RSA key

Application Login

33

auth.expirationTime

Property used to set token expiry time

number [n] – value in ms

User session timeout

34

auth.authenticationProviders

Property used to set different providers for authentication

LDAP,STANDARD

Application Login

35

auth.secret

Property used for connecting to LDAP

String [a-z, A-Z, 0-9]

forgot password email

16

corsFilterValidOrigin

LDAP Login

36

processorurl.<tool>

to configure customApi to connect with processors

String [a-z, A-Z

, 0-9

]

- localhost

CORS

17

speedyLatestVersionKey

property used to provide key in version api

Processor run from Dashboard

37

testconnection.<toolApi>

used in test connection feature.

String [a-z, A-Z]

- latestVersion

version metadata api

18

Ticket Priority

Test connections get API

38

Code Block
priority.P1, priority.P2, priority.P3, priority.P4, priority.P5

used in kpis, to group different values of same level priorities.

19

Kafka related Properties

P1- P5

Ticket Priority

39

spring.kafka.producer.bootstrap-servers

kafka.mailtopic

to run kafka on defined server and subject of the email

20

Notification properties

kafka:9092

mail-topic

Email Service

40

flag.mailWithoutKafka

set flag for send mail via Notification Kafka Service

true/false

Email Service

41

notificationSubject.accessRequest

notificationSubject.approvalRequest

notificationSubject.preApproval 

to use for email notification, the subject while approving or requesting.

String [a-z, A-Z]

Email Notification Subject

42

notification.switch

Property to enable/disable sending notification through email

false, true

Email Notification

43

analytics.switch

Property to enable/disable google analytics

false, true

Knowhow Analytics

44

approval.

21

Feedback properties

categories.emailSubject

User Approval functionality by Admin

String [a-z, A-Z]

User Approval Functionality

45

feedback.categories

feedback.categories.emailSubject

notification configuration while using feedback functionality

String [a-z, A-Z]

Feedback functionality

22

46

processorurl

pushDataLimit

to configure customApi to connect with processors

23

testconnection

used in test connection feature.

limit the data to be pushed via push data API

number [1-100]

expose push data api

47

exposeAPITokenExpiryDays

Expose Push data API Token Expriry days Limit 

number [1-365]

expose push data api

48

kpi.comments.max.store.count

max comment  store in db kpi wise

number [1-15]

comment Feature

49

limit.comments.shown.on.kpi.dashboard.count

limit of comment view on each KPI

number [1-15]

comment Feature

50

authCookieDuration

cookie validity duration in sec

number[1-10000]

API Security

51

authCookieHttpOnly

set http flag true

true/false

API Security

52

authCookieSecured

set secured cookie flag

true/false

API Security

53

authCookieSameSite

SameSite Cookie Attribute Changes

true/false

API Security

54

certhostpath

cert file Path for Ldap Certificate

file path

AD Login

55

keystorefile

key file Path for Ldap Certificate

file path

AD Login

56

keytoolalias

key tool file alias name

file name

AD Login

Database Configurations

please refer Information Regarding Access Management

...