Versions Compared

Key

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

https://tools.publicis.sapient.com/confluence/pages/viewpage.action?pageId=1202716763

Table of Contents
minLevel1
maxLevel7

Introduction

This user manual provides step-by-step instructions on how to configure 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: Navigating to the Connections Screen

Once you are on the Settings page, follow these steps to access the Connections screen:

...

Introduction

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 minimize the number of connection needed for same data source , just ensure that the configured account has required access.

  • It is recommended to use service account for authentication.

Navigating to the Connections Screen

  • Select "Settings" from the breadcrumb menu in top right corner menu options.

  • 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:

...

  • Connections tab will list all available connections and with an option to add new connection or to edit existing connections.

...

Adding a New Connection

From the drop-down menu, select the

...

source tool for the connection you want to create (e.g., Jira, Bitbucket, Sonar Jenkins, etc.).

...

Click on the "New Connection" button.

...

...

A pop-up window will appear, prompting you to fill in the connection details.

3.1.4. Enter all the required information in the respective fields. Note that mandatory fields will be indicated by an asterisk (*) symbol.

3.1.5. Before saving the connection, ensure that all mandatory fields are filled correctly. If any required field is empty, a validation message will be displayed below the corresponding text box.

3.1.6. To verify whether the connection is valid or not, you can test the connection before saving it.

Image Removed
Image Removed

...

Once all the details are filled and the connection is tested successfully, click on the "Save" button to add the new connection.

3.1.8. Congratulations! You have successfully added a new connection.

...

Edit/Delete an Existing Connection

To edit an existing connection, follow these steps:

...

On the Connections screen, find the connection you want to edit under the respective

...

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. You can also test the connection to ensure that the updated details are correct and valid.

3.2.6. 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 configure connections on the PSknowHOW dashboard. By following the provided instructions, you can add new connections and edit existing connections effortlessly. Properly configured connections will enhance your experience and allow seamless data integration between PSknowHOW and various services.

FAQ

  1. How do I add a new connection?

    • Go to Settings > Connections.

    • Select connection type from the dropdown.

    • Click "New Connection" and fill details.

  2. What fields are mandatory when adding a connection?

    • Fill all required fields marked with (*).

  3. Can I test a connection before adding it?

    • Yes, test the connection's validity before saving.

  4. How do I edit an existing connection?

    • Click the edit icon for the connection you want to edit.

  5. Can I have multiple connections of the same type?

    • Yes, you can add multiple connections of the same type.

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:

  1. Add new connection

  2. 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.

Image Removed

Image Removed

Image Removed

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.

...

tool section .

For each connection you have option to edit or delete the connection.

...

Deleting the connection doesn't delete the existing data collected from the source tool being deleted.