Introduction

The Insights Adapter is a key component of the ConnectALL Value Stream Insights product and services offering. The Insights Adapter creates and populates the Insights Data Model for the purposes of the various dashboards in Insights Analytics.

The Insights Common Data Model is a collection store for the important data items needed for the metrics dashboard. The model is designed to allow you to query the information in the data store in a simple and efficient way to generate the metrics charts. This easily queryable data source is optimal and allows for multiple reporting tool options.


Supported Databases

        (tick) Microsoft SQL Server

        (tick) MySQL

        (tick) PostgreSQL


Connection Properties

URL Format

The following URL formats are recommended for the below listed databases:

DatabaseFormat
MySQLjdbc:mysql://<server ip>:3306/
MSSQLjdbc:sqlserver://<server ip>:1433
PostgreSQLjdbc:postgresql://<server ip>:5432/<database name>

Note: Ensure that you create a database before creating a PostgreSQL connection. The user needs to have create/update/delete privileges to create a connection, and that is the same privilege required for all the databases mentioned above.

Additional Properties

The DEFAULT_MAXIMUM_POOL_SIZE property refers to the Maximum pool size for creating a connection. By default, the value it is set as 20 in ConnectALL. If you want to change it, enter the value that you wish to have in the following format.

DEFAULT_MAXIMUM_POOL_SIZE=25


The additional properties that you enter here will vary according to the database that you use. Refer to the below table:

Database Type

When you create a connection, enter the database type that you are using in the Database Type field. If you are using:

DatabaseEnter as
MySQLmysql
MS SQLmssql
PostgreSQLpostgres

Note: Starting from version 2.10.26, ConnectALL allows you to add the database name and modify an existing database’s name in the Save Connections screen. It is recommended that, if you are modifying a database’s name in an existing connection, modify the name in the database also (and vice-versa). It's essential that the database name is the same in both places. 
The reason is, if there is a mismatch in the database name it will result in a discrepancy in the existing records due to the difference (in the name). For example, if you have created records using ‘Database 1’ and if the database name is changed to ‘Database 2’, then, the record update will not happen for the existing records as the database name is changed. Note that, if you have one license, you will be able to use only one database.


Mapping 

You can create mappings between the Insights adapter and any standard adapter. ConnectALL creates the schema on the connected database instance once you have created a new connection. The database schema name will be “Insights” and it will have four vertical tables (listed below) which can be mapped to the issue types depending on the adapter. The four tables are:

  • work_management (e.g. Jira, Digital.ai Agility (Formerly VersionOne), and Azure DevOps)
  • test_management (e.g. Micro Focus ALM, Tosca, QMetry)
  • code_management (e.g. Git, BitBucket, Perforce)
  • product_management (e.g. Micro Focus PPM, Clarity, Jira portfolio)


Flow Properties 

The Insights adapter supports only writing into the adapter. Hence the Poll and the Push options are disabled. Likewise, the Time Difference field does not have to be configured for Insights Adapter. The reason being, Timezone configuration is required only when modified records are queried. ConnectALL's Insights adapter is a write-only adapter.  i.e., changes and modifications are not queried from the adapter but data is written into it.





Fields Configuration

While creating a new app-link between Insights and a destination adapter, click Configure Fields to automatically map the matching fields.  

Note that the Insights adapter supports only unidirectional field mapping, which is from any application/adapter to the Insights adapter. 

We have provided below a fields type table. The table has the field types used by the Insights adapter.




Field Types Table

The Field Types table contains the default types for all the fields which will be created by ConnectALL during the Install/Upgrade.

Field Type

Description

ACCOUNT

Account field

ACTUAL_COST

Actual cost logged in field

APPLICATION_LINK_NAME

Field to store the application_link_name

ASSIGNEE

Assignee field

ATTACHMENT

Attachment Field

BRANCH

Branch field of the adapter

BUDGET

Total budget of the project

BUDGET_TYPE

Budget type field

CHANGE_DATE

Field from which the modified date can be retrieved

CHECKIN_DATE

Checkin date field

CHECKIN_USER

Checkin by user

CHECKOUT_DATE

Checkout date field

CHECKOUT_USER

Checked out by user field

COMMENT

Comment Field

COMPLEXITY

Complexity of the issue field

CREATED_DATE

Created date field of the adapter

DEPLOYED_DATE

Deployed date

DESCRIPTION

Description field

DUE_DATE

Due Date field

END_DATE

Work End date Field

ENVIRONMENT

Environment

EXECUTION_PERCENTAGE

Execution percentage of test case field

EXECUTION_TYPE

Execution test case type field

ID

Record ID of the row in the Database. 

ARTIFACT_TYPE

Artifact type field of the adapter

MODIFIED_DATE

Modified date

MODIFIED_USER

Modified user field

PARENT_ID

Parent field id

PARENT_TYPE

Parent issue type field

PAY_RATE

Pay rate in the adapter

PRIORITY

Priority field

PROJECT

Project field of the adapter

RELEASE_VERSION

Release Field in the adapter eg: FixVersions, TargetRelease

REPORTER

Reporter field

RESOLUTION

Resolution Field

RESOLUTION_DATE

Resolution Date field

ROLE

User role field

SEVERITY

Severity field

SOURCE_APPLICATION

Field to store the adapter type

SOURCE_ISSUE_TYPE

Issue type field to store the Source issue type

SOURCE_PROJECT

Project field to store the Source project

SOURCE_RECORD_ID

Field to store the ID field of the linked adapter

START_DATE

Work start date field

STATUS

Status field of the adapter

SUMMARY

Summary/Title field of the record

TEST_RESULT

Actual test result field

TEST_TYPE

Test type field

timestamp

       System generated time stamp for the record that the system generated

Event Configuration

PostgreSQL

Manual configuration is required to configure the events in the Insights data model if you are using PostgreSQL as it does not provide any scheduling options or options to configure events. 

Provided below is the function name that has to be triggered by the scheduler.

Function Name - build_hierarchy_dim()

Interval - Every one hour

To learn how to configure the events, click here.

Un-Supported Fields

        (error) Attachment

        (error) Comment

        (error) Issue Link

Note: Time Difference or Timezone configuration is not required as polling is not supported.


Troubleshooting

ProblemWorkaround
The error ''Unable to Connect INSIGHTS' is displayed when you create a connection for the Insights adapter.

This problem may arise if the database type that you are using for ConnectALL and the Insights Adapter is different. For example, you may be using Oracle for ConnectALL and MySQL for the Insights Adapter. In such a scenario, you need to place a JDBC driver jar for MySQL in the following path:

<TOMCAT_HOME>/lib and the <MULE_HOME>/lib/user folder

Follow this procedure for any database (Microsoft SQL Server/MySQL/PostgreSQL) that you are going to use for the Insights Adapter.

While creating an Insights connection for MYSQL8, the following error is generated:

'Failed to initialize pool: Unable to load authentication plugin 'caching_sha2_password'.

Run the below query in the MYSQL8 server to solve the issue.

ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY '<your password>';
GRANT ALL PRIVILEGES ON * . * TO 'root'@'localhost';