System Requirements
Beginning in April 2022, the following operating systems will be no longer supported by Hub:
Windows Server 2012 R2
Windows Server 2012
Red Hat Enterprise Linux 6.x
Ubuntu Linux 14.04 LTS
SUSE Linux Enterprise Server 11.x
Beginning in Hub version 21.4, TLS 1.2 is required for all encrypted connections. The database used for storing Hub operational data and any repositories being used must support TLS 1.2.
If you have any questions, please contact Support.
General Requirements
Planview Tasktop Hub is a web application which runs centrally on a server. Users interact with it through a web browser from any computer that has network access to the server.
For best results, Hub should be deployed in an environment that has good network throughput and low latency to its operational databases and all repositories involved in an integration.
Below are general requirements to meet the needs of typical deployment scenarios.
- Hub must be installed in a server environment and only one instance of Hub should be installed on each server.
The Hub operational database should have its own machine and should be co-located with the Hub server to reduce latency.
User Requirements
To install and configure Hub, you need an account with administrative privileges on your server. The account must also have read/write access to the default file locations.
Supported Operating Systems
Note: For Windows, Powershell 4 must be installed on your server.
The following 64-bit operating systems and versions are supported:
- Windows 10
- Windows 11
- Windows Server 2019
- Windows Server 2022
- Oracle Enterprise Linux 7+
- Oracle Enterprise Linux 8+
- Red Hat Enterprise Linux 8.x
Ubuntu Linux 18.04 LTS
Ubuntu Linux 20.04 LTS
- Ubuntu Linux 22.04 LTS
- SUSE Linux Enterprise Server 12.x
SUSE Linux Enterprise Server 15.x
Available under Extended support:
- Windows Server 2016 (End-of-Service-Life Date: )
Red Hat Enterprise Linux 7.x (End-of-Service-Life Date: )
Ubuntu Linux 16.04 LTS (End-of-Service-Life Date: )
Note that certain connectors (e.g., IBM DOORS) only run on Windows operating systems. Before installing Hub, we recommend consulting with support to determine which operating system best fits your integration scenario.
Supported Browsers
Note: Hub runs with a minimum screen resolution of 1280 pixels x 800 pixels.
The Hub web interface is supported on the following browsers:
- Firefox 111+
Google Chrome 111+
Microsoft Edge 111+
Available under Extended Support:
- Firefox 101 (End-of-Service-Life Date: )
- Google Chrome 102-105 (End-of-Service-Life Date: )
- Microsoft Edge 102-105 (End-of-Service-Life Date: )
Firefox 102 (End-of-Service-Life Date: )
Google Chrome 106+ (End-of-Service-Life Date: )
Microsoft Edge 106+ (End-of-Service-Life Date: )
If you are interested in extended support, please reach out to support.
Supported Databases for storing Hub Operational Data
This feature is not applicable to Hub Cloud.
Hub automatically stores operational data to a pre-configured Derby database. This is suitable for evaluation purposes only, and is not supported for production environments. Configuring Hub to utilize an external database enables you to perform frequent back-ups without stopping Hub, and ensures that your Hub practices are consistent with your existing disaster and recovery process.
Note: The database used for Hub operational data must support TLS 1.2.
To reduce latency, the Hub operational database should have its own machine and should be co-located with the Hub server.
Minimal User Permissions
For all supported databases, the user must have sufficient permissions to connect, create, alter and drop tables and indexes and create temporary tables. Users must also have sufficient permissions to select, insert, update, delete, and truncate tables.
Hub supports this operational database policy for scenarios where your database is on any cloud infrastructure like AWS or Azure. You can refer to the resources below for more information on encrypting communication between Hub and Database:
- For AWS, we recommend implementing a VPC. Click here for more information.
- For Azure, we recommend a VPN gateway. Click here for more information.
Note: A separate database must be used for Hub Operational Data and Enterprise Data Stream integrations.
Operational Database Recommendations
The recommendations below offer a general guideline only. We recommend consulting with Tasktop Support to determine the exact needs for your integration scenario, and for guidance on how to efficiently configure Hub.
You can see guidelines regarding external database sizing here.
We strongly recommend using the latest supported version of PostgreSQL for storing Hub Operational Data. At scale, Hub performs better, more reliably, and requires fewer resources with PostgreSQL than with the other available database options.
Supported Versions and Configuration Details
In the tabs below, you will find supported database versions for storing Hub Operational Data and configuration details for each database.
Supported Versions
- 10
- 11
- 12
- 13
- 14
- 15
Extended Support
- 9.6 (End-of-Service-Life Date: )
If you are interested in extended support, please reach out to support.
Configuration Settings
- The database must be case-sensitive (this is the default configuration).
- The database must be configured with the UTF8 character set.
CREATE DATABASE dbName ENCODING 'UTF8' LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' TEMPLATE template0
Necessary User Permissions
The following provides sufficient permissions for the tasktop_hub
user on the tasktop_hub
database, when using a public schema:
REVOKE ALL PRIVILEGES ON DATABASE tasktop_hub FROM tasktop_hub; GRANT CONNECT, TEMP ON DATABASE tasktop_hub TO tasktop_hub; GRANT CREATE ON SCHEMA public TO tasktop_hub; GRANT SELECT, INSERT, UPDATE, DELETE, TRUNCATE ON ALL TABLES IN SCHEMA public TO tasktop_hub;
The following provides sufficient permissions for the tasktop_hub
user on the tasktop_hub
database, when using a custom schema:
If you use a custom schema, please note that when configuring the external database connection you will need to add "
?currentSchema=tasktop
" to the database connection URL, e.g. jdbc:postgresql://example.com:5432/dbName?currentSchema=tasktop
CREATE SCHEMA TASKTOP; REVOKE ALL PRIVILEGES ON DATABASE tasktop_hub FROM tasktop_hub; GRANT CONNECT, TEMP ON DATABASE tasktop_hub TO tasktop_hub; GRANT CREATE ON SCHEMA Tasktop TO tasktop_hub; GRANT SELECT, INSERT, UPDATE, DELETE, TRUNCATE ON ALL TABLES IN SCHEMA Tasktop TO tasktop_hub;
Supported Versions
- 2017
- 2019
Extended Support
N/A
Configuration Settings
- The database must be case sensitive. We recommend Latin1_General_100_CS_AS_KS_WS.
This can be configured using the following command (replace dbName with the name of your database):
ALTER DATABASE dbName COLLATE Latin1_General_100_CS_AS_KS_WS;
- We recommend monitoring the size of your transaction log, as very large transaction logs can cause database connection errors.
- We recommend using JDBC driver
mssql-jdbc-7.0.0.jre8.jar
when transferring from operational database to SQL Server.
Necessary User Permissions
- The user must be a SQL authenticated user (not a Windows authenticated user)
- Additionally, the user must have the following roles granted:
db_datareader
db_datawriter
db_ddladmin
Note: Instance and Database name options can be specified by attaching "
;instanceName=;databaseName=
" to the end of the JDBC URL in Hub. If using JDBC driver mssql-jdbc-10.2.x
or later, the “;trustServerCertificate=
“ parameter and its corresponding value is required by the driver.
Supported Versions
- 19c
- 21c
Extended Support
- 18c (End-of-Service-Life Date: )
If you are interested in extended support, please reach out to support.
Configuration Settings
- The database must be case-sensitive (this is the default configuration).
- The database must be configured with the AL32UTF8 character set.
ALTER DATABASE dbName CHARACTER SET AL32UTF8;
Necessary User Permissions:
User must have CREATE SEQUENCE
, CREATE TABLE
, CREATE SESSION
permissions, as well as sufficient quota. Typical user creation might look as follows:
CREATE USER tasktop_hub IDENTIFIED BY a_password DEFAULT TABLESPACE tasktop_hub; GRANT CREATE SESSION TO tasktop_hub; GRANT CREATE SEQUENCE, CREATE TABLE TO tasktop_hub; ALTER USER tasktop_hub QUOTA UNLIMITED ON tasktop_hub;
Troubleshooting
- To resolve error ORA-30036 (UNABLE TO EXTEND SEGMENT BY 8 IN UNDO TABLESPACE), please refer to the following documentation.
Supported Versions
- 5.7.7+ (excluding 5.7.0 - 5.7.6) (Enterprise Edition only)
- 8.0 (Enterprise Edition and Community Edition)
Extended Support
- N/A
Configuration Settings
The following settings must be applied before connecting Hub to MySQL:
- The database must be case sensitive.
This can be configured using the following command (replace dbName with the name of your database):
ALTER DATABASE dbName COLLATE = 'utf8_bin'
- The database default charset must be UTF-8,
ALTER DATABASE dbName CHARACTER SET
= 'utf8'- You can also create the database with these settings:
CREATE DATABASE dbName CHARACTER SET
= 'utf8'
- You can also create the database with these settings:
- We recommend using JDBC driver version 8.0 or later when transferring from an operational database to MySQL Server.
innodb_default_row_format
must beDYNAMIC
innodb_file_format
must beBarracuda
innodb_file_per_table
must beON
innodb_large_prefix
must beON
innodb_buffer_pool_size
must be minimum 1G- This size is highly dependent on customer hardware and data size — the number above is only a recommendation. Please consult with Tasktop Support if you have any questions.
max_allowed_packet
property must be minimum 64M- If this is set too low, you will see a Packet for query is too large error on the Activity screen.
max_connections
property should be minimum 500- Note: The number of connections Hub uses is highly dependent on customer configuration, hardware, and load — the number above is only a recommendation. Please consult with Tasktop Support if you have any questions.
Note:
innodb
settings are the default settings for MySQL, so you will not need to make any changes to those settings unless they have been changed previously. The innodb
settings apply globally to all MySQL databases on the server, while the character set
is specific to the database.
Configuring Hub with the MySQL external operational database will prohibit the synchronization of 4-byte characters due to MySQL's default UTF8 encoding being limited to 3 bytes. Examples of 4-byte characters include but are not limited to some emojis and some Chinese characters. If you may be synchronizing 4-byte characters, consider using another supported database.
Necessary User Permissions
The following provides sufficient permissions for the tasktop_hub
user on the tasktop_hub database
:
REVOKE ALL PRIVILEGES, GRANT OPTION FROM tasktop_hub; GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, INDEX, LOCK TABLES, REFERENCES ON tasktop_hub.* TO tasktop_hub
Supported Databases for use in Enterprise Data Stream Integrations
The Hub Database add-on allows you to create integrations that send artifact information to one central database.
Note: A separate database must be used for Hub Operational Data and Enterprise Data Stream integrations.
You can see guidelines regarding external database sizing here.
Supported Versions
If your license includes the Hub Database add-on and you would like to configure an Enterprise Data Stream Integration, the following databases and versions are supported:
General Support
- 10
- 11
- 12
- 13
- 14
- 15
Extended Support
- 9.6 (End-of-Service-Life Date: )
If you are interested in extended support, please reach out to support.
General Support
- 2017
- 2019
Extended Support
N/A
General Support
- 19c
- 21c
Extended Support
- 18c (End-of-Service-Life Date: )
We recommend using JDBC driver version 8.0 or later when creating a SQL connection for Enterprise Data Stream integrations.
General Support
- 5.7.7+
- 8.0
Extended Support
- N/A
Note: The user must be a SQL authenticated user (and not a Windows authenticated user)
Database Connections and Encryption
The following section describes different ways to configure your database connection. If you choose not to encrypt your connection, data will be transmitted over the network unprotected and will be at risk of being intercepted. Likewise use of self-signed certificates or other certificates not signed by a trusted Certificate Authority puts your data at risk as Hub cannot verify the identity of the server at the end of the connection.
Please ensure your connection is configured in a way that is aligned with your security policy and the associated risks are understood and accepted.
Configuration Details
For PostgreSQL, please refer to PostgreSQL documentation for more information.
Location
- Example Format: jdbc:postgresql://hostServerName:postgreSqlServerPort/MyDatabaseName
You can enable encrypted connections by setting ‘ssl=true' (e.g., jdbc:postgresql://<server-name>:<port>/?ssl=true).
If the certificate for the PostgreSQL server is self-signed you'll need to set ‘sslfactory=org.postgresql.ssl.NonValidatingFactory' and ‘sslmode=require’ (e.g., jdbc:postgresql://<server-name>:<port>/?ssl=true&sslmode=require&sslfactory=org.postgresql.ssl.NonValidatingFactory).
If the certificate for the PostgreSQL server is not self-signed you'll need to add the certificate to the JDBC’s truststore.
For SQL Server, please refer to Microsoft documentation for more information.
Location
- Example Format: jdbc:sqlserver://hostServerName;instanceName=MyInstance;databasename=MyDatabaseName
You can enable encrypted connections by setting 'encrypt=true' (e.g., jdbc:sqlserver://<server-name>:1433;encrypt=true;trustServerCertificate=false). If the certificate for the MySQL server is self-signed you'll need to set 'trustServerCertificate=true' (e.g., jdbc:sqlserver://<server-name>:1433;encrypt=true;trustServerCertificate=true)
If using JDBC driver mssql-jdbc-10.2.x
or later, the “;trustServerCertificate=
“ parameter and its corresponding value is required by the driver.
Note: Some older editions may be missing security updates and will need to apply security service packs to use a self-signed certificate and encryption. You may experience certificate errors if the SQL Server is using a self-signed or corporate certificate. To work around this, you will need to disable certificate validation in the JDBC driver or add the certificate to the JDBC’s truststore.
For Oracle, please refer to this whitepaper for an overview of how to set up connections to encrypted Oracle server. For a guide to configuring the Oracle server to support SSL, please refer to Oracle documentation.
Location
- Example Format: jdbc:oracle:thin:@hostServerName:oracleServerPort/SID
For the most part assuming that the server is set up properly, you can follow Case#2 in the white paper and simply use a URL with the following format: jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(PORT=2484)(HOST=<hostname>))(CONNECT_DATA=(SERVICE_NAME=<servicename>))). On the server, make sure to disable client authentication by setting 'SSL_CLIENT_AUTHENTICATION=FALSE ' in the listener.ora and sqlnet.ora files.
For unencrypted connections, the protocol should be TCP and the port would generally be 1521, but the URL would otherwise be the same. The above example connection string is formatted in the 'Oracle Net connection descriptor' format, but Hub also accepts 'Thin-style service name' connection strings such as jdbc:oracle:thin:@<hostname>:1521:<servicename>.
If the certificate for the Oracle server is self-signed, but you still want to use SSL, you will need to follow Case#1 in the white paper. As described in the paper, only anonymous cipher suites are permitted when trying to use SSL without server authentication. You can specify the cipher suites in the sqlnet.ora file on the Oracle server.
Note: Some versions of Oracle do not by default support anonymous cipher suites. Thus, they will need to be imported to the server before enabling them.
For MySQL, refer to MySQL documentation for the details on how to set up your connection.
Location
- Example Format: jdbc:mysql://hostServerName:mysqlServerPort/MyDatabaseName
To enable encryption on older MySQL servers (5.6.25 and earlier or 5.7.5 and earlier) you need to set the connection property 'useSSL=true' (e.g., jdbc:mysql://<server-name>:3306?useSSL=true). Later versions will implicitly try to connect using an encrypted connection. Regardless of the version, the client will only enforce that the server uses TLS if the property 'requireSSL=true' is set.
If the certificate for the MySQL server is self-signed you will need to set 'verifyServerCertificate=false' (e.g., jdbc:mysql://<server-name>:3306?useSSL=true&verifyServerCertificate=false).
Java Runtime Environment
Hub is packaged with a JRE; there is no need to install a JRE separately. Hub uses and ships with Oracle Java.
Note: Partner branded editions of Hub use and ship with Azul OpenJDK.
Deploying Hub on a Cloud Environment
To ensure reliable performance, all virtual machines (on-prem and private cloud) must meet the requirements listed in the General Requirements section.
Hub can be deployed in operating systems on physical servers within virtual machines hosted on dedicated on-prem virtual machine hosts. Hub can also be deployed within private cloud deployments, such as AWS or Azure. If deploying on a private cloud environment, Hub and its operational database must be deployed using a full image and not a container, with the exception of AWS RDS PostgreSQL. Hub cannot run in containerized deployments (Kubernetes, OpenShift, etc.).
Tasktop has qualified AWS RDS PostgreSQL deployments for use as the operational database for Hub instances hosted in AWS private cloud environments. Tasktop does not offer direct support for private cloud hosting infrastructure (i.e., AWS networking and configuration) beyond the operation of Tasktop’s own products within the hosted environment. See the section below for recommended configuration settings.
AWS RDS PostgreSQL Recommendations
The recommendations below offer a general guideline only. We recommend consulting with Tasktop Support to determine the exact needs for your integration scenario, and for guidance on how to efficiently configure Hub.
Note: Tasktop does not troubleshoot or maintain AWS RDS PostgreSQL. Please ensure your database is configured in a way that is aligned with your security policy and that the associated risks are understood and accepted.
Setting | Recommended Value |
---|---|
"DBInstanceClass" | "db.t3.small" |
"Engine" | "postgres" |
"AllocatedStorage" | 50 |
"BackupRetentionPeriod" | 30 |
"MultiAZ" | true |
"EngineVersion" | "13.6" |
"AutoMinorVersionUpgrade" | false |
"PubliclyAccessible" | false |
"StorageType" | "gp2" |
"StorageEncrypted" | true |
"CopyTagsToSnapshot" | true |
Hardware Sizing for Deployment Scenarios
General Notes and Considerations
Below are recommendations on sizing hardware and virtual machine capacity to meet the needs of typical deployment scenarios.
These recommendations are guidelines intended to provide a starting point when deciding on hardware allocation for a specific deployment. We recommend monitoring system load including CPU usage, memory pressure and disk queue length, and adjusting the system sizing accordingly.
For best results, Hub should be deployed in an environment that has good network throughput and low latency to all repositories and databases involved in an integration.
Based on real-life metrics, we approximate database sizing at about 40 KB per artifact. For 100,000 artifacts total (including artifacts on both sides of an integration), that equates to about 4 GB of database storage, not including log files, rollback space, etc.
This is a rough estimate, and will depend on customer-specific configuration and usage. For example, artifacts that have hundreds of fields and many large comments will require more space. Likewise, short change detection intervals, frequent full scans, or frequent changes to large numbers of artifacts will require more processing power.
Hub Server Sizing Recommendations
The recommendations below offer a general guideline only. The performance needs of Hub integrations depend on how integrations are configured, the specifications of connected end systems, and the volume and type of changes made in the end systems.
Note that it is possible for a deployment to have a low number of integrations and users, but a high number of artifact updates (or vice versa). We recommend consulting with Tasktop Support to determine the exact sizing needs for your integration scenario, and for guidance on how to efficiently configure Hub.
A deployment managing up to 20,000 artifacts in up to 100 projects with up to 10,000 updates/month (typically up to 200 active users, and up to 5 integrations).
- 4 GB system memory
- 3 GHz processor, 2 cores
- 50 GB free disk space
A deployment managing up to 150,000 artifacts in up to 500 projects with up to 50,000 updates/month (typically up to 1,000 active users, and up to 15 integrations).
- 8 GB system memory
- 2 x 3 GHz processor, 4 cores
- 150 GB free disk space
A deployment managing up to 1,000,000 artifacts in up to 2000 projects with up to 200,000 updates/month (typically more than 2,000 active users, and 20+ integrations).
- 16 GB system memory
- 4 x 3 GHz processors, 8 cores
- 250 GB free disk space
If your deployment exceeds any of the guidelines from the Large Deployment, please consult with Tasktop Support.
For extra-large deployments, the specific characteristics of the integrations are crucial when determining proper instance sizing. As a result, no general recommendations can be offered for extra-large deployments.
External Database Sizing
The system that the external database is deployed on should also follow the sizing recommendations listed above. For example, the database for a large deployment should run on a separate machine with 16 GB of memory, 8 cores, and 250 GB of disk space.
Java Heap Size
We recommend setting the maximum Java heap size value to 50-75% of your system’s memory.
Learn more about setting Java heap size here.