ref - https://tools.publicis.sapient.com/confluence/pages/viewpage.action?pageId=951429194
similar content for all tools
All tools data are pulled over API, all connected tools must allow API access for the authentication credentials used to connect that tool.
JIRA
Jira is project management tool that well integrate with KnowHOW application and provides user a seamless experience of managing and understanding the flow of work being done in current and past project iteration/sprints.
Based on the default setting of KnowHOW, all of the required fields will be populated. If a user wants to change the default setting, below are some key points to be considered.
SCRUM Dashboard Filters operates on the basis of Sprint and on KPIs, last 5 sprints data are shown.
...
Iteration Board KPI’s
Iteration board is configured to seek data from different Scrum projects. Based on selected projects and sprint, Iteration KPI’s shall populate with corresponding data points.
Points To Be Remember-
Only Scrum projects are supported.
The selected project needs to have at least one sprint available for the KPI’s to show up.
Any user other than Superadmin shall have access to a Scrum project for data to be displayed on Iteration board.
Any update on Iteration board shall be followed by running Jira processor from Misc. Settings, subject to availability of new information/data. To know more about Jira processor, click here.
KPI’s Based on Defects
Defects should be linked to Stories. defects which are not linked with stories will not be considered for these KPI data calculation.
For DSR, the defect should have identifier for discovered on production.
All defects should be linked with a story, even if the story is part of the previous Sprint which has been closed.
Defect status should be reflected via the appropriate stage in the workflow, rather than using comments or using another status.
Resolved defects should be reflected via their status as done/closed.
Rejected defects should be reflected via their status as canceled or resolution as configured in KnowHOW.
Similarly, it should be followed for other stages in the defect life cycle like Open, In Progress, In Development, Ready for QA, etc.
RCA drop-down field should be added in the Defect issue type. RCA values drive the info for RCA KPI.
Any Defect/Story that is being considered to work upon in a particular sprint, shall be tagged to same.
KPI’s Based on Test Cases
All Test cases should be linked with a Story (to get In Sprint Automation Percentage value).
if custom fields are used to identify regression and in-sprint test cases, check the custom fields related to it on the setting screen of KnowHOW.
Regression KPI can either be set up by Label or Customfield and is not dependent on Sprint.
Only those Test Cases which are to be automated will be considered for calculation and check the corresponding setting.
Test Execution Percentage and Capacity to be updated manually from the settings > upload.
Azure
Repository--
KnowHOW understand how important it is to keep track of changes made to your code repository. It provides user an ability to keep a watch over code check 'ins, different Merge Requests raised and Build Failure.
To know more about KPI’s that drives with available Repo tools, Click Here.
GitHub
KnowHOW supports GitHub to keep track of activities in different repos and branches.
Prerequisite to Setup GitHub in KnowHOW:
...
A verified and hosted Repository on GitHub domain.
Verified Repo Owner Username and updated Access token.
Base URL to hit the repo.
Repository and respective branch name.
GitLab
To improve the scope of KPI’s with different tools, KnowHOW supports GitLab as well which is also one the major code repository tool in market.
...
Prerequisite to Setup GitLab in KnowHOW:
A verified and hosted Repository on GitLab domain.
Valid username and KPI access token
Base URL to and Repo URL along with Project ID.
Repository and respective branch name.
Azure Repo
Similar to GitHub and GitLab, KnowHOW allows user to track changes to their repository hosted at Azure domain.
...
Prerequisite to Setup GitHub in KnowHOW:
A verified and hosted Repository on Azure domain.
Verified Repo Owner Username and updated PAT Access token.
URL to the repo.
API version (API use to hit the repo tool) and respective branch name.
Build Tools--
KnowHOW support a variety of build tools like Jenkins, BAMBOO and Azure Pipelines. These tools are used for different purposes like creating build or deployment pipeline that make different SCRUM/KANBAN projects operation more viable.
KnowHOW, understanding the vast utilities of these applications, have dedicated KPI’s that ensure user keep track of different Build and Deployment activities.
To know the different SCRUM and KANBAN KPI’s that support these build tools, Click Here.
JENKINS
KnowHOW application supports Jenkins tool that enhances user’s capability to seek data like Number of Check ’ins, Deployment frequency etc. It can be setup for SCRUM and KANBAN projects which depends upon Jenkins for build and deploy operations.
...
Prerequisite to Setup Jenkins in KnowHOW:
An active port where user is hosting Jenkins application, ex: Port 8080
Base URI and API End Point to establish connection between Jenkins and KnowHOW.
Valid user identity with username and password.
CI/CD pipelines shall be available and have prior setup in Jenkins.
BAMBOO
Similar to Jenkins, Bamboo is also a continues integration tool that is well supported by KnowHOW.
...
Prerequisite to Setup BAMBOO in KnowHOW:
Base URL to establish connection between BAMBOO and KnowHOW.
Valid user identity with username and password.
Plan Name and Branches shall be created prior in BAMBOO.
AZURE PIPELINES
KnowHOW support the Azure pipelines to keep track of build activities in project.
...
Prerequisite to Setup Azure Pipeline in KnowHOW:
Base URL and PAT token to access pipelines in Azure.
Pipelines shall be created in prior in Azure in order to seek the corresponding data.
...
It is recommended to use Service Accounts for Authentication.
The service account should have read only permission if supported by the tool else lowest level of permissions
The PSknowHOW hosting server/env must have web connectivity with tools, PSknowHOW pulls data via REST API with all supported tools
If the connected tools are not available over internet (operates within private network), PSknowHOW is recoemmeded to be setup in the same network.
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...