https://tools.publicis.sapient.com/confluence/pages/viewpage.action?pageId=1202716763
| Table of Contents | ||||
|---|---|---|---|---|
|
Introduction
This user manual provides step-by-step instructions on how to Add / Edit connections on the PSknowHOW dashboard. The Connections screen allows users to create new connections or edit existing ones for various services like Jira, Bitbucket, Sonar Jenkins, and more.
Why Add & Edit Connection Required?
Adding connections is essential for integrating PSknowHOW with various services and tools, which enables seamless data synchronization and enhances the overall user experience. Editing connections allows you to update the connection details when there are any changes in the service configuration or credentials.
Step 1: Accessing the Settings
To configure connections on the PSknowHOW application, follow these steps:
1.1. Log in to the PSknowHOW application using your credentials.
1.2. Click on the Navigation Bar, and then select "Settings" from the menu options.
Step 2: PSknowHOW connects with tools via REST API to collect data for KPI calculations. The connection defined the source tools and authentication details to consume REST API.
Private connections are accessible only to the account creating the connection.
Public connection are available for all logged in user. This allows to minimise the number of connection needed for same data source , just ensure that the configured account has required access.
It is recommened to use service account for authentication.
Step 1 - Navigating to the Connections Screen
Once you are on the Settings page, follow these steps to access the Connections screen:2.1.
Select "Settings" from the breadcrumb menu in top right cornermenu options.
After clicking on Settings, multiple tabs will appear. Find and click on the "Connections" tab.
2.2. The Connections screen will open, displaying a list of existing connections.
Step 3: Performing Actions on the Connections Screen
On the Connections screen, you can perform the following actions:
3.1. Adding a New Connection
To add a new connection, follow these steps:
3.1.1. From the drop-down menu, select the type of connection you want to create (e.g., Jira, Bitbucket, Sonar Jenkins, etc.).
3.1.2. Click on the "New Connection" button.
3.1.3. A pop-up window will appear, prompting you to fill in the connection details.
3.1.7. Once all the details are filled and the connection is tested successfully, click on the "Save" button to add the new connection.
3.2. Editing an Existing Connection
To edit an existing connection, follow these steps:
3.2.1. On the Connections screen, find the connection you want to edit under the respective connection type tab.
3.2.2. Click on the edit icon associated with that connection.
3.2.3. A pop-up window will open, displaying the current connection details.
3.2.4. Make the necessary changes to the connection information as required.
3.2.5. Once you have made the desired changes and tested the connection successfully, click on the "Update" button to save the edits.
3.2.7. Congratulations! You have successfully edited the existing connection.
Conclusion
In this user manual, you learned how to Add / Edit connections on the PSknowHOW dashboard effortlessly. By following the provided instructions.
OLD Content (Reference) To be Deleted
This screen allows users to configure connections on the PSknowHOW dashboard. Below listed are the steps for configuring connections on PSknowHOW.
Login to the PSknowHOW application --> Click on the Navigation Bar and then go to Settings:
Connections Screen
After clicking settings multiple tabs will open up, switch to the Connections tab as shown below. This screen allows the user to create a new connection or edit an existing connection.
User can perform the below activities on the Connections screen:
Add new connection
Edit existing connection
Add New Connection
To add a new connection, from the drop down, select the connection type like Jira, Bitbucket, Sonar Jenkins, etc and then click on the "New Connection" button a pop-up window will open.
To save a connection successfully, the user needs to fill all the required fields otherwise a validation message will be shown below the mandatory field textbox.
Before adding any connection, you can test that connection whether you are going to add a valid connection or not.
Edit Connection
To edit a connection, the user needs to click on the edit icon of the particular connection under the connection type tab on the connections screen (refer to the above screenshot), pop-up window will open now user can edit, test and update the existing connection details.
