System Requirements

Beginning in Tasktop Hub version 20.4, Windows Server 2008 R2 SP1 and Windows 7 SP1 operating systems are not supported by Tasktop.

Beginning in December 2021Red Hat Enterprise Linux 7.x and Ubuntu Linux 16.04 LTS will be removed from General Support and placed under Extended Support. 

Beginning in Tasktop Hub version 21.4, TLS 1.2 is required for all encrypted connections. The database used for storing Tasktop operational data and any repositories being used must support TLS 1.2.

If you have any questions, please contact Support.

General Requirements

Tasktop Integration Hub must be installed in a server environment.

(lightbulb)Note: Only one instance of Tasktop should be installed on each server.

User Requirements

To install and configure Tasktop Integration 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

(warning) 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

  • SUSE Linux Enterprise Server 12.x
  • SUSE Linux Enterprise Server 15.x

Available under Extended support: 

  •  Windows Server 2012 R2 

  •  Windows Server 2012 

  •  Red Hat Enterprise Linux 6.x 

  •  Ubuntu Linux 14.04 LTS 

  •  SUSE Linux Enterprise Server 11.x 

  •  Windows Server 2016

  •  Red Hat Enterprise Linux 7.x

  •  Ubuntu Linux 16.04 LTS

Supported Browsers 

(lightbulb)Note: Tasktop Integration Hub runs with a minimum screen resolution of 1280 pixels x 800 pixels.

The Tasktop Integration Hub web interface is supported on the following browsers:

  • Firefox 89.0+
  • Google Chrome 91.0+

  • Microsoft Edge Chromium 91.0+

Available under Extended Support:

  •  Firefox 77-88 

  •  Google Chrome 83-90 

  •  Microsoft Edge Chromium 85-90 

(lightbulb) If you are interested in extended support, please reach out to your Tasktop contact.

Supported Databases for storing Tasktop Operational Data 

This feature is not applicable to Tasktop Cloud.

(warning) Tasktop 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 Tasktop to utilize an external database enables you to perform frequent back-ups without stopping Tasktop Integration Hub, and ensures that your Tasktop Integration Hub practices are consistent with your existing disaster and recovery process

You can see guidelines regarding external database sizing here.

(warning) Note: The database used for Tasktop Hub operational data must support TLS 1.2.


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.

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

(lightbulb)Note: A separate database must be used for Tasktop Operational Data and Enterprise Data Stream integrations. 


The following databases and versions are supported for storing Tasktop Operational Data:

(lightbulb) Tip: We recommend using the latest supported version of PostgreSQL for storing Tasktop Operational Data. 


Supported Versions

  • 2017
  • 2019

Extended Support

  •  2016 SP2 

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

(lightbulb)Note: Instance and Database name options can be specified by attaching ";instanceName=;databaseName=" to the end of the JDBC URL in Tasktop Integration Hub.

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 Tasktop 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'
  • We recommend using JDBC driver version 8.0 or later when transferring from an operational database to MySQL Server.
  • innodb_default_row_format must be DYNAMIC
  • innodb_file_format must be Barracuda
  • innodb_file_per_table must be ON
  • innodb_large_prefix must be ON
  • 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 Tasktop 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.

(lightbulb) Noteinnodb 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.

(warning) Configuring Tasktop Integration 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 Versions

  • 18c
  • 19c

Extended Support

  •  12c Release 2 

(lightbulb) If you are interested in extended support, please reach out to your Tasktop contact.

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

  • 9.6
  • 10
  • 11
  • 12
  • 13

Extended Support

  •  9.5 

(lightbulb) If you are interested in extended support, please reach out to your Tasktop contact.

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:

(lightbulb) 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 Databases for use in Enterprise Data Stream Integrations 

The Tasktop Database add-on allows you to create integrations that send artifact information to one central database.

(lightbulb) Note: A separate database must be used for Tasktop Operational Data and Enterprise Data Stream integrations.

If your license includes the Tasktop Database add-on and you would like to configure an Enterprise Data Stream Integration, the following databases and versions are supported:

General Support

  • 2017
  • 2019

Extended Support

  • 2016 (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
  • 8.0

Extended Support

  • N/A

(lightbulb) Note: The user must be a SQL authenticated user (and not a Windows authenticated user)

General Support

  • 18c
  • 19c

Extended Support

  • 12c Release 2 (End-of-Service-Life Date: 

General Support

  • 9.6 - 13

Extended Support

  • 9.5 (End-of-Service-Life Date: 

(lightbulb) If you are interested in extended support, please reach out to your Tasktop contact.

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

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

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)

(lightbulb) Note: Some older editions may be missing security updates and will need to apply security service packs to use a self-signed certificate and encryptionYou 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 Tasktop 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.

(lightbulb) 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 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.

Java Runtime Environment

Tasktop Integration Hub is packaged with a JRE; there is no need to install a JRE separately. Tasktop Integration Hub uses and ships with Oracle Java. 

(lightbulb) Note: Partner branded editions of Tasktop Integration Hub use and ship with Azul OpenJDK.


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.

Tasktop Integration 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. These sizing recommendations apply to the server machine running Tasktop Integration Hub.

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, Tasktop Integration 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 spaceLikewise, short change detection intervals, frequent full scans, or frequent changes to large numbers of artifacts will require more processing power.  

Hub Server Sizing Recommendations 

(warning)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.