Jira Align Self-Hosted Enterprise Insights installation

Installation Prerequisites

Team and Permission Requirements

Before installing Jira Align Enterprise Insights (EI), ensure that these individuals with the required permissions are informed of and prepared for the installation:

  • Database administrator:
    • SQL Administration of the existing Jira Align OLTP instance and the EI OLAP Data Warehouse instance
    • SSIS and ETL Job Administration
  • Data analyst:
    • GRANT SELECT ON SCHEMA :: current_dw TO {Insert Analyst User Name} WITH GRANT OPTION;
    • GRANT SELECT ON SCHEMA :: export_dw TO {Insert Analyst User Name} WITH GRANT OPTION;
    • GRANT SELECT ON SCHEMA :: time TO {Insert Analyst User Name} WITH GRANT OPTION;

Hardware Requirements

Atlassian strongly recommends adding a separate and dedicated Microsoft SQL Server for the EI ETL job and SQL Data Warehouse for production workloads.

EI requires local Windows credentials to run the ETL job from SQL Server Integration Services, which mandates an on-premise Windows server for running the EI ETL Job. The following minimum hardware requirements are recommended for a Microsoft SQL Server running EI:

Items Values
Memory 16.0 GB or more
Processors 4 64-bit cores or more
Hard disc space 80 GB of SSD or more


Optionally, the Data Warehouse database can exist anywhere that the ETL job is able to connect to, including Azure. If you choose to utilize Azure SQL Database for the EI SQL Data Warehouse, choose a tier of at least S3, or an elastic pool of at least 100 eDTUs. This is mandatory, as COLUMNSTORE indexes are not supported on lower tiers.

Software Requirements for ETL Job Server

  • Microsoft SQL Server 2019 is required, with Mixed Mode authentication. Both Windows and SQL Server authentication must be enabled.
  • Microsoft SQL Server Agent must be enabled and running.
  • Microsoft SQL Server Integration Services must be enabled.
  • The SqlServer Powershell module must be installed. If it is not already on the EI ETL Job server, it is included with the package and will automatically be installed.
  • Enable CLR on the SSIS catalog server. You can do so by running the following command:

    EXEC sp_configure 'clr enabled', 1; RECONFIGURE;
    GO

Note: Ensure that all Jira Align and EI servers are set to the same regional settings.

Jira Align Requirements and Licensing
An existing on-premise Jira Align instance is required. Ensure that your Jira Align instance has been updated to the latest version before adding Jira Align Enterprise Insights.

A current Jira Align license is required to license the EI product for production and non-production environments. For more information on Jira Align licensing for on-premise instances, see the Jira Align Self-Hosted Guide.

Worksheet

Fill out the worksheet below with the appropriate values for the parameters needed to complete the installation. 

Setting Example Purpose
[DW_USERNAME] SystemAdmin

EI Data Warehouse DB user account. The installation script will require this account to be able to create and populate the Data Warehouse database.

This account will need db_owner permissions on the Data Warehouse database that exists.

If the database does not exist yet, the account will need sysadmin permissions on the instance.

[DW_PASSWORD] JiraAlign! EI Data Warehouse DB user account password
[DW_SERVER_NAME] localhost EI Data Warehouse DB server FQDN

[DW_SERVER_PORT]

1433

Port for the Data Warehouse server

[DW_DB_NAME] datawarehouse EI Data Warehouse DB name
[TRUST_SERVER_CERTIFICATE] y

Enter yto trust self-signed certificates when using the interactive prompt installation method.

For unattended installs using Install.Answers.psd1, set a PowerShell boolean: TrustServerCertificate = $true or $false.

This setting applies to all SQL connections the installer makes:

  • Data Warehouse

  • SSIS catalog

  • ETL

[SSIS_USERNAME] SystemAdmin

This account will be created automatically if it does not already exist.

The account will be added to the local Users group.

The installer will grant this account the necessary SQL permissions for running SSIS packages and reading SQL Agent job history (ssis_admin in SSISDB and JAEIUser in msdb)

Maps to SsisWindowsAccount in Install.Answers.psd1

[SSIS_PASSWORD]   Windows password for SSIS package install user
[WINDOWS_ACCOUNT_DOMAIN] MYDOMAIN Domain or machine name for the SSIS Windows account
[SSIS_SERVER_NAME] localhost Server name where the SSIS catalog resides
[SSIS_SERVER_PORT] 1433 Port for the SSIS server
[SQL_ADMIN_USERNAME]  

Credential used by the installer as the install-time SQL Server sysadmin on the SSIS catalog server. It is used to create SQL logins, grant ssis_admin in SSISDB, configure the SSISDB catalog, and run pre-flight environment checks.

It is not stored or used after installation

Maps to SqlServerAdmin in Install.Answers.psd1

[SQL_ADMIN_PASSWORD]  

Credential used by the installer as the install-time SQL Server sysadmin on the SSIS catalog server. It is used to create SQL logins, grant ssis_admin in SSISDB, configure the SSISDB catalog, and run pre-flight environment checks.

It is not stored or used after installation

[ETL_JOB_NAME] Align ETL Job EI ETL job name
[ETL_SERVER_NAME] localhost EI ETL database server FQDN
[ETL_SERVER_PORT] 1433 Port for the ETL server
[ETL_USERNAME] SystemAdmin

SQL login used to create and manage the  ETL Agent job on msdb. Requires SQLAgentOperatorRole permissions.

Maps to EtlJob.EtlDbAdminUsername in Install.Answers.psd1

[ETL_PASSWORD] JiraAlign! EI ETL job Windows account password
[JA_SERVER_NAME] localhost Existing Jira Align DB server FQDN
[JA_SERVER_PORT] 1433 Port for the Jira Align server
[JA_DB_NAME] ja Existing Jira Align DB name
[JA_USERNAME] SystemAdmin

Existing Jira Align DB user account

Note: This SQL or Windows user account will require at minimum db_datareader access to the existing [JA_DB_NAME] database.

[JA_PASSWORD] JiraAlign! Existing Jira Align DB user account password

Installation steps

There are two ways to install Enterprise Insights: using an answer/helper file for an unattended install, or by answering interactive prompts.

Option 1: unattended installation

  1. Download the Enterprise Insights (EI) installation package. Verify it includes:
    1. Install.ps1 file
    2. Install.Helpers.ps1 file
    3. Install.Answers.psd1 file
    4. SqlPack folder
    5. ETL folder
    6. Warehouse folder
    7. SqlServer powershell module
  2. Open Install.Answers.psd1 in a text editor.
  3. Fill in all required values in the configuration file, using the worksheet above.
  4. Run the installation using the answer file:

    .\Install.ps1 -AnswerFile .\Install.Answers.psd1

     

Notes:

  • Any value left blank will prompt interactively. For fully unattended operation, ensure that:

    • The -Force flag is included in the install command, to skip the upgrade pre-flight prompt.

    • Inside of the Install.Answers.psd1 file, the SkipClrConfirmation and SkipJobReplacementPrompt are both set to $true. These are set to true by default when downloading the installation package.

  • For security, answer files containing credentials should be stored securely and excluded from source control.

Option 2: interactive installation

  1. Download the Enterprise Insights (EI) installation package. Verify it includes:
    1. Install.ps1 file
    2. Install.Helpers.ps1 file
    3. Install.Answers.psd1 file
    4. SqlPack folder
    5. ETL folder
    6. Warehouse folder
    7. SqlServer powershell module
  2. Open an elevated Powershell window and run .\Install.ps1.

  3. Follow the prompts to enter the values from your worksheet.

    1. New in 11.23.X: You will be prompted for Server Ports (default 1433) and whether to Trust Server Certificates (y/n).

    2. Upgrade Detection: If an existing ETL job is found, the installer will ask for confirmation before replacing it. If the job is currently running, the installer will stop it automatically.

Post-installation checks

After the installation script finishes, perform the following steps to verify that the Enterprise Insights (EI) ETL job is configured correctly and running:

  1. Verify the ETL Job Execution
    1. Open Microsoft SQL Server Management Studio (SSMS) as an administrator.
    2. In the Object Explorer, navigate to:
      Integration Services Catalog > SSISDB > Jira Align EI ETL > Projects > BI ETL.
    3. Right-click the project name and select Reports > Standard Reports > All Executions.SQL_Server_Management_1.jpg
    4. Review the report to ensure the status is Succeeded.
      Note: If the installation just finished, the job may still be executing. It may take several minutes for the first run to complete and appear in the report.SQL_Server_Management_2.jpg
  2. Review the ETL Schedule

    • By default, the installer creates an hourly ETL job schedule.
    • If your organization requires a different frequency, your DBA team can manually modify the schedule in SQL Server Agent.Job_Schedule_Properties_EI_ETL.png
  3. Troubleshooting
    • If the installation fails or the job does not succeed, check the installation logs in the Log subfolder of the installation directory.
    • For further assistance, contact the Atlassian Support Team at https://support.atlassian.com/contact/.
       
Was this article helpful?
1 out of 1 found this helpful
Print Friendly Version of this pagePrint Get a PDF version of this webpagePDF

Join the Atlassian Community!

The Atlassian Community is a unique, highly collaborative space where customers and Atlassians come together. Ask questions and get answers, start discussions, and collaborate with thousands of other Jira Align customers. Visit the Jira Align Community Collection today.

Need to contact Jira Align Support? Please open a support request.