Installation

Sandbox Environment

It is recommended that you prepare a sandbox environment to test your Tasktop Integration Hub configuration before deploying it in production.

The sandbox environment should include the following:

  • A sandbox server to install Tasktop Integration Hub on
  • Sandbox instances of all repositories you will be integrating
    • These instances should include the same project structure and customizations as your production repositories.
    • These instance should also include a comparable number of artifacts to your production repositories.

After you have configured Tasktop Integration Hub on the sandbox server and are satisfied with the way it is running with your sandbox repositories, you can install Tasktop Integration Hub on your production server and recreate the configuration for your production repositories.

Installation

Where to Download Tasktop Integration Hub

To get the latest version of Tasktop Integration Hub, create an account on our Customer Portal, then contact your Solutions Architect or Tasktop Support.

Once logged in to the Customer Portal, click Product Downloads.

Click 'Product Downloads' in the Customer Portal

This will lead you to the Downloads section, where you can download the latest version of Tasktop Integration Hub.

Downloads Page



Click the Windows download link on the Product Downloads page of the Customer Portal.

You will be provided with an installation package for Tasktop Integration Hub as a standard Windows MSI installer.

If prompted, click Save File and open the file once downloaded.

Run Installer

The Tasktop Setup Wizard will guide you through the installation process.

(warning) Note: If you decide to change the location of the ProgramData directory, do not include spaces in the new directory name. If the directory includes spaces, Tasktop's UI will not be accessible.

Install Wizard

After installing Tasktop, open the Start menu and click Start Tasktop to start both Tasktop and User Management services.

To stop both Tasktop and User Management services, click Stop Tasktop.

Start Tasktop

(warning) Note: The Tasktop application is available via HTTPS on port 8443. A default SSL certificate is provided for testing purposes, however this SSL certificate is insecure. Before using in a production environment, the provided SSL certificate must be replaced. Please see details in the SSL Certificate Installation section below.

(lightbulb) TipPlease follow the steps in the Getting Started section when starting Tasktop Integration Hub for the first time.

For Direct Customers

Click the Linux download link on the Product Downloads page of the Customer Portal.

You will be provided with an installation package for Tasktop Integration Hub as a .tar.gz archive.

To extract this archive to your desired location, copy the archive to the correct location on your Linux system.

You must choose a location with no spaces in its path and use the following command to extract:

$ tar -xzvf tasktop-linux-x64-<version>.tar.gz

After extracting, run the start-tasktop.sh script from the installation directory (see note on permissions below) to start Tasktop and User Management services.

To stop Tasktop and User Management services, use the stop-tasktop.sh script in the same folder.

(lightbulb) TipBe sure to follow the steps in the Getting Started section when starting Tasktop Integration Hub for the first time.


For OEM Customers

You will be provided with an installation package for Tasktop Integration Hub with no file extension in the name. 

To execute the file, run these commands:

chmod +x tasktop-linux-x64-<version>
./tasktop-linux-x64-<version>

After approving the End User License Agreement, the file will automatically unzip, allowing you to run Tasktop Integration Hub.

Run the start-tasktop.sh script from the installation directory (see note on permissions below) to start Tasktop and Keycloak User Management services.

To stop Tasktop and User Management services, use the stop-tasktop.sh script in the same folder.

(warning) The Tasktop application is available via HTTPS on port 8443. A default SSL certificate is provided for testing purposes, however this SSL certificate is insecure. Before use in a production environment, the provided SSL certificate must be replaced.  Please see details in the SSL Certificate Installation section below.

(lightbulb) Tip: Be sure to follow the steps in the Getting Started section when starting Tasktop Integration Hub for the first time.


Note on Permissions

We recommend creating a dedicated user for running Tasktop Integration Hub. We do not recommend running Tasktop Integration Hub as root, as it may create files that cannot be accessed when running Tasktop as another user. Running an application on a Linux system as root may also interfere with your system's security.

For this reason, start-tasktop.sh will not start if it detects the current user is root.

If you would like to run Tasktop Integration Hub as root despite these risks, you can do so by deleting or commenting lines 3-7 of start-tasktop.sh as shown below: 

#!/bin/sh
#if [ "`id -u`" -eq "0" ]
#then
#    echo "Tasktop should not be run as root"
#    exit 1
#fi
currentdir="$( cd "$(dirname "$0")" ; pwd -P )"
keycloak_running() {
  pgrep -n -f "${currentdir}"/keycloak/bin/standalone.sh
}


Tasktop Integration Hub Service on Linux

There are several ways to configure a Tasktop Service that starts automatically on system startup. We recommend using a dedicated account for running Tasktop Integration Hub.

You can see the examples below for SysVinit and Systemd.

Tasktop Integration Hub Service with Systemd
  1. Navigate to /etc/systemd/system
  2. Create a file named tasktop.service
  3. Paste the following into the file: 

    # Systemd unit file for tasktop
    [Unit]
    Description=Tasktop Integration Hub
    After=syslog.target network.target
     
    [Service]
    Type=forking
     
    ExecStart=/path/to/tasktop/start-tasktop.sh
    ExecStop=/path/to/tasktop/stop-tasktop.sh
     
    User=user
    Group=group
     
    [Install]
    WantedBy=multi-user.target

    a. Change both instances of /path/to/tasktop to the full path to your Tasktop Integration Hub installation directory
    b. Change the User and Group variables to the username and group of the account you want to run the Tasktop Integration Hub service

  4. Reload Systemd 

    $ systemctl daemon-reload
  5. Enable the new Tasktop Integration Hub service to start on system startup 

    $ systemctl enable tasktop

(lightbulb) Tip: To manually start and stop the Tasktop Integration Hub Service, use the following commands: 

$ systemctl start tasktop
$ systemctl stop tasktop
Tasktop Integration Hub Service with SysVinit
  1. Navigate to /etc/init.d
  2. Create a file named tasktop
  3. Paste the following into the file: 

    #!/bin/bash
    # description: Tasktop Start Stop Restart
    # processname: tasktop
    # chkconfig: 2345 20 80
    TASKTOP_HOME=/path/to/tasktop
    case $1 in
    start)
    sh $TASKTOP_HOME/start-tasktop.sh
    ;;
    stop)
    sh $TASKTOP_HOME/stop-tasktop.sh
    ;;
    restart)
    sh $TASKTOP_HOME/stop-tasktop.sh
    sh $TASKTOP_HOME/start-tasktop.sh
    ;;
    esac
    exit 0

    a. Change the TASKTOP_HOME variable to the full path to your Tasktop Integration Hub installation directory
    b. If you'd like, you can change the chkconfig run levels and start and stop priorities

  4. Set the permissions of Tasktop to make it executable: 

    $ chmod 755 tasktop
  5. Use the chkconfig utility to enable Tasktop Integration Hub start at system startup

    $ chkconfig --add tasktop
    $ chkconfig --level 2345 tasktop on
    1. If you'd like, you can change the run levels in this command


(lightbulb) Tip: To manually start and stop the Tasktop Integration Hub Service, use the following commands: 

$ service tasktop start
$ service tasktop stop
$ service tasktop restart


SSL Certificate Installation 

(warning)The Tasktop application is available via HTTPS on port 8443. A default SSL certificate is provided for testing purposes and should be replaced after installation.

Replacing the default SSL certificate used by Tasktop Integration Hub involves the following:

  1. Preparing a Java keystore file with all keys and certificates
    1. The Tasktop and Keycloak SSL configuration require a JKS format keystore.
      1. If your corporate CA provides a JKS keystore file, you can skip to the Configure Tasktop to use the keystore section and follow the steps using the JKS keystore file from your CA.
      2. If your CA requires you to provide a CSR and returns a certificate response to you, use the following steps to generate your own keystore file and CSR:
        1. Create a Java keystore file and generate a new key pair
        2. Generate a certificate request file
        3. Submit the file to a Certificate Authority (CA) and obtain the certificate and CA certificate trust chain
        4. Import the certificates to the keystore file
  2. Configuring Tasktop to use the keystore (i.e., new key and certificate)


The SSL certificate should contain DNS names where the Tasktop server is accessible. The user's browser will verify that the name in the address bar matches the names listed in the certificate. Certificate Authority may be your internal corporate service, or you may use a public CA (e.g., Comodo, Let’s Encrypt). If you are planning to use a certificate from a public CA, your Tasktop instance must have a publicly recognizable DNS name that is owned by your organization.

SSL-related instructions on this page are provided as a reference only. Your Certificate Authority will have more detailed instructions on creating and importing certificates. These instructions are based on the use of a GUI tool Portecle, which can be downloaded here.

Note that Tasktop does not provide support for this third-party tool beyond the instructions shown below.

(lightbulb) Tip: You can create the Java keystore file on any machine and move the file to the server running Tasktop software; there is no need to install Portecle on the server running Tasktop.

If you cannot use Portecle and need to utilize standard Java command line utility keytool, please refer to Tomcat documentationUpon following the documentation, use JRE installed with Tasktop software in the Tasktop installation directory (default C:\Program Files\Tasktop). Tasktop’s server.xml file is located in Tasktop's data directory (default: C:\ProgramData\Tasktop, or the location where Tasktop is installed on Linux) under container/conf/server.xml.

Running Portecle for SSL certificate installation

To run Portecle for SSL certificate installation, see the instructions below:

  1. Download and unzip Portecle.
  2. Open the command prompt.
    1. For Windows, navigate to C:\Program Files\Tasktop\jre\bin\
    2. For Linux, navigate to <tasktop-install>/jre/bin/
  3. Run the following command (changing /path/to/portecle/ to the location where you unzipped Portecle):
    1. java -jar /path/to/portecle/portecle.jar

Prepare a Java keystore file with all the keys and certificates 

To replace Tasktop’s default SSL certificate using Portecle, follow the instructions below:

(lightbulb) Tip: Details on accessing Portecle can be found in the section above.

  1. Create a key pair and keystore:

    1. Start Portecle and click New Keystore in the toolbar and select JKS as the keystore type. 

    2. Click Generate Key Pair in the toolbar. You can leave the default settings for 2118 bit RSA key, or choose different settings if required by your company’s security policy. 

    3. In the Generate Certificate pop-up, enter the Fully Qualified Domain Name (FQDN) of your Tasktop server in the Common Name (CN) field and enter other fields as needed.

      1. In the Subject Alternative DNS Name field, enter the alternative domain name of the server, if one exists. Your certificate should include all DNS names that your users may use to connect to Tasktop. For internal corporate CA you can also use “short” names (i.e., tasktop, in addition to tasktop.acme.corp). In CA, these additional DNS names are called Subject Alternative Names, or SAN. You can specify one SAN at this point, and can usually add more names later when submitting your request to the CA.

    4. Enter tomcat as alias.

    5. Create a new password for the key pair.

      1. (lightbulb) Tip: You will need this password later when configuring Tomcat.

    6. You will see your newly created key pair in the list.

    7. Click Save Keystore in the toolbar to save the newly created keystore file. Here, use the same password that you entered for the key pair earlier.

  2. To generate a certificate request file (also known as Certificate Signing Request or CSR), right click on the tasktop key and select Generate Certification Request and save it to a file.

  3. Submit your CSR to a CA to obtain a Certificate.

    (lightbulb) Note: For some CAs you will need to provide the list of all DNS names for your Tasktop server separately as they will ignore the SAN values in the certificate request. See your CA's documentation for more information.
  4. Import the certificates to the keystore file.

    1. If your CA provided a separate file with the CA certificate or trust chain, import it by selecting Import Trusted Certificate in the toolbar. If your CA provided only one file in response to your CSR, skip to 4b.

    2. Import the server certificate by right clicking on the tasktop key, selecting Import CA Reply and choosing the server certificate file received from the CA.

    3. To verify the certificate chain, click Tools and then click Keystore Report.

Configure Tasktop to use the keystore 

  1. Place your keystore file in a protected location that will not be wiped on Tasktop upgrade. We suggest using Tasktop data directory (default C:\ProgramData\Tasktop, or the home directory of the user that Tasktop service is running as on Linux).
  2. Open the tasktop-hub.properties file and configure the following properties:
    1. server.ssl.key-store - Location where the keystore file exists
    2. server.ssl.key-store-password - Password of keystore file
    3. server.ssl.key-store-type - Type of keystore file (e.g., JKS, PKCS12)
  3. Restart Tasktop Integration Hub Service

(lightbulb) To learn more about creating a tasktop-hub.properties file, please see the section below.

By default, the SSL configuration has been configured to disable known weak ciphers. As new security information becomes available, the list of enabled ciphers should be updated accordingly.

Configure Keycloak User Management to use and trust Tasktop's keystore

In Tasktop Integration Hub 20.4, both Tomcat and Jboss share the same properties in the tasktop-hub.properties file as they share the same keystore file. See more details above.

(lightbulb) To learn more about creating a tasktop-hub.properties file, please see the section below.

Port Configuration

By default, Tasktop utilizes the ports listed in the table below.

If any of those ports are already being utilized for other purposes, you will need to change them. To view a list of all ports being used on your system, you can use the netstat-a command. This will help you determine which available ports you would like to use for Tasktop.

Here is a summary of each port Tasktop utilizes and the location where you can change it if it is already being used:

PortLocationPurpose

8080

8443

tasktop-hub.properties
    #server.port=8443

    #server.redirect.port=8080

More details here

Default port Tasktop uses for HTTP (8080) / HTTPS (8443)

8081

8444

tasktop-hub.properties
    #jboss.http.port=8081

    #jboss.https.port=8444

More details here

User Management (Keycloak) HTTP Ports

Additional Keycloak Ports:

  • 9990
  • 9993
  • 8009
  • 4712
  • 4713
  • 25

More details here

(Note: the following ports have been modified from the Keycloak defaults: 8080→8081, 8443→ 8444)

tasktop-hub.properties
    #jboss.ajp.port=8009

    #jboss.management.http.port=9990

    #jboss.management.https.port=9993

    #jboss.txn.recovery.environment.port=4712

    #jboss.txn.status.manager.port=4713

    #jboss.mail.smtp.port=25



User Management (Keycloak)

More details here

8005tasktop-hub.properties
    #server.shutdown.port=8005
Tomcat Shutdown Port
The default port Tasktop uses is 8443 for HTTPS and 8080 for HTTP, which redirects to HTTPS. If you'd like to change these ports to ease access for your users, or to accommodate a proxy, follow these instructions:
  1. Open the tasktop-hub.properties file and configure the following properties:
    1. server.port - The http or https port
    2. server.redirect.port - The port that, if accessed, redirects to server.port
  2. After changing the port, the address used to access Tasktop (i.e., http://localhost:8080) will need to be updated with the new port number in place of '8080.'

Please refer to the official documentation for additional configuration options.

To learn more about creating a tasktop-hub.properties file, please see the section below.

The default port for User Management is 8081. If you'd like to change the port that User Management (Keycloak) utilizes, follow the instructions here. If your User Management (Keycloak) utilizes a port other than 8081, you can instruct Tasktop to access User Management (Keycloak) via the correct port by following the instructions below.
  1. Open the tasktop-hub.properties file and configure the following properties:
    1. jboss.http.port - Jboss http port
    2. jboss.https.port - Jboss https port

(lightbulb) Note: If you change the default jboss management-http port setting in the /keycloak/standalone/configuration/standalone.xml to something other than 9990, you must also update the port referenced in /keycloak/bin/jboss-cli.xml.

To learn more about creating a tasktop-hub.properties file, please see the section below.

Getting Started 

Once installation is complete, you can begin using Tasktop Integration Hub by opening https://localhost:8443/ in any of our supported browsers

Before logging on to Tasktop, you must log into the User Administration Console in order to create your admin user(s). The Tasktop User Administration Console can be accessed via the User Administration Console link at the bottom of the Tasktop Integration Hub login page. Please review the User Management section for detailed instructions on how to create a user, login, and manage your user accounts.

Once logged in, you will be prompted to set a Master Password, which will be used to encrypt your repository credentials.

You will also need to apply your license before configuring your integrations. You can learn how to apply your license here.

Externalized Configuration

Tasktop enables you to externalize configurations from Tomcat, Jboss/Keycloak, and certain application properties in a single place. This allows you to use property files to override default values such as:

  • Jboss: ports (e.g., http, https, management port), Keycloak database paths, Keycloak trust stores, java memory variables, and custom system properties
  • Tomcat: ports (e.g., http https), keystores (e.g., files, passwords, types), java memory variables, and custom system properties
  • Application Properties: Derby, Tasktop Hub, Liquibase, log4j, and keycloak host

To override default values through a properties file, you must provide the tasktop-hub.properties file in a directory that Hub can scan and read.

This can be done as follows:

  1. Rename the file tasktop-hub.properties.default to tasktop-hub.properties.

    1. For Windows, this file can be found in the App Data Directory.
    2. For Linux, this file can be found in the root level of the .tar.gz package.
      1. Note: For Linux users, we recommend creating an environment variable named TASKTOP_HOME with its value pointing to an exclusive directory where the tasktop-hub.properties file will be placed.
  2. Provide values to properties that need to be overridden.
    1. For example, if you'd like to change the Tomcat https port to port 9443, uncomment the property from #server.port=8443 to server.port=9443

Good to Know

  • Only properties/lines uncommented within the <AppDataDirectory>/tasktop-hub.properties file will be applied, otherwise Tasktop Hub will assume default values for commented properties.
  • Only properties at <AppDataDirectory>/tasktop-hub.properties file will be used; the file <AppDataDirectory>/tasktop-hub.properties.default is just a template and will not work in Tasktop Hub.

Upgrading

The tasktop-hub.properties file will not be replaced or deleted during the installation/upgrade process. For this reason, newer versions of Hub can retain settings automatically after upgrading.

Because the properties file is placed in the $TASKTOP_HOME directory, newer versions of Hub will automatically apply all configurations.

If the properties file is not placed in the $TASKTOP_HOME directory, it is necessary to copy the properties file from the old installation directory to the new installation directory.

Upgrading from a Version Earlier than 20.4

If you have made manual changes to Tomcat and/or Jboss files, you have two options upon upgrading to 20.4:

You can apply all configurations that have been applied manually to server.xml, standalone.xml, standalone.confstandalone.conf.batsetenv.sh, and Manage Tasktop -> Java -> Java Options to the tasktop-hub.properties file .

During an upgrade, it is not necessary to override the server.xml file from the old version to the new installation directory. This can be done by simply providing the tasktop-hub.properties file in a directory that Tasktop Hub is able to read and ensuring that there is an uncommented line as shown below:

...
server.port=9443
...

(lightbulb) Other properties can be configured the same way as shown in the example above. 

You can copy all configuration files from Tomcat and/or Jboss that were previously modified and override them in the new version directories.

Properties

The tasktop-hub.properties file contains three main blocks:

  • Jboss/Keycloak Properties
  • Tomcat Properties
  • Tasktop Hub Properties

The properties listed in the table below are used only if Tasktop Hub is using Keycloak as an Authentication Provider. When provided, the properties file will be passed as an argument of standalone.sh/standalone.bat (e.g., standalone.sh|bat --properties=<path>/tasktop-hub.properties), which means that the file will override Jboss variables.

PropertyPurposeNotes

jboss.ajp.port

Use this property to provide a value for the tag <socket-binding name="ajp" /> within the standalone.xml descriptor.


jboss.http.port 

Use this property to provide a value for the tag <socket-binding name="http" /> within the standalone.xml descriptor.


jboss.https.port

Use this property to provide a value for the tag <socket-binding name="https" /> within the standalone.xml descriptor.


jboss.management.http.port

Use this property to provide a value for the tag <socket-binding name="management-http"/> within the standalone.xml descriptor.

If this property is provided, the script <installation>/keycloak/bin/jboss-cli-tasktop.sh|bat will call the script <installation>/keycloak/bin/jboss-cli.sh|bat passing these arguments: --controller=localhost:<jboss.management.http.port> --properties=<path>/tasktop-hub.properties.

jboss.management.https.port

Use this property to provide a value for the tag <socket-binding name="management-https"/> within the standalone.xml descriptor.


jboss.txn.recovery.environment.port

Use this property to provide a value for the tag <socket-binding name="txn-recovery-environment"/> within the standalone.xml descriptor.


jboss.txn.status.manager.port

Use this property to provide a value for the tag <socket-binding name="txn-status-manager"/> within the standalone.xml descriptor.


jboss.mail.smtp.port

Use this property to provide a value for the tag <remote-destination host="localhost" /> within the standalone.xml descriptor.


jboss.server.data.dir

Use this property if you want to place the keycloak database in a custom directory.

This is the same directory where keycloak database lives.

For both Windows and Linux, the directory separator needs to be '/'.

jboss.java.memory

Use this property to change memory settings.


jboss.custom.system.properties

Use this property to load custom system properties. For example: -Djboss.*=value, -Dkey=value, -XX:key=value, -javaagent:value, -agentlib:value


The properties listed in the table below are used to override some properties from Tomcat.

Property

PurposeNotes

server.port

Use this property to provide a value for the attribute port in the tag <Connector/> within the server.xml descriptor.

After changing the port, if Keycloak is being used, you will need to go into the User Administration Console and adjust the client to the new port.

server.redirect.port

Use this property to provide a value for the attribute redirectPort in the tag <Connector/> within the server.xml descriptor.


server.shutdown.port

Use this property to provide a value for the attribute port in the tag <Server/> within the server.xml descriptor.


server.tomcat.connection-timeout

Use this property to provide a value for the attribute connectionTimeout in the tag <Connector/> within the server.xml descriptor.


server.ssl.key-store=/path/to/keystore-file

Use this property to provide a value for the attribute keystoreFile in the tag <Connector/> within the server.xml descriptor.

This property is shared with Jboss/Keycloak. The standalone.xml file is reading this property:

<spi name="truststore">

...

<property name="file" value="${server.ssl.key-store:${jboss.home.dir}/../insecureKeystore}"/>

...

server.ssl.key-store-password=changeit

Use this property to provide a value for the attribute keystorePass in the tag <Connector/> within the server.xml descriptor.

This property is shared with Jboss/Keycloak. The standalone.xml file is reading this property:

<spi name="truststore">

...

<property name="password" value="${server.ssl.key-store-password:changeit}"/>

...

server.ssl.key-store-type=JKS

Use this property to provide a value for the attribute keystoreType in the tag <Connector/> within the server.xml descriptor.


server.ssl.key-alias

Use this property to provide a value for the attribute keyAlias in the tag <Connector/> within the server.xml descriptor.

Enable this property only if your custom Keystore has an alias and it is different than Tomcat.

tomcat.java.memory=-Xms256M -Xmx2118M

Use this property to change memory settings.

For Windows: Initial memory pool size (-Xms) and maximum memory pool size (-Xmx) needs to be in MB. That means that the value needs to be suffixed with 'M'. 

Values suffixed with 'G' will cause an error at the start of Hub.

For Linux: Values can be specified in MB or GB. Both suffixes 'M' and 'G' work.

tomcat.java.endorsed.dirs=path/to/endorsed

Use this property to provide a custom path for java.endorsed.dirs directory.


tomcat.java.errorFile=/path/to/hs_err_pid%%p.log

Use this property to provide a custom path for -XX:ErrorFile.


tomcat.java.io.tmpdir=path/to/temp

Use this property to provide a custom path for java.io.tmpdir directory.


tomcat.java.util.logging.config.file=path/to/logging.properties

Use this property to provide a custom path for Tomcat’s logging.properties file.


tomcat.jdk.tls.rejectClientInitiatedRenegotiation=true

Use this property to provide jdk.tls.rejectClientInitiatedRenegotiation value.


tomcat.custom.system.properties

Use this property to load custom system properties such as:

-XX:key=value, -javaagent:value, -agentlib:value


The properties listed in the table below are used to override some Tasktop Hub values.

PropertyPurposeNotes
derby.storage.pageCacheSizeUse this property to change the data page cache in the database.Reference: https://db.apache.org/derby/docs/10.14/ref/rrefproper81359.html
derby.system.home=/path/to/dbUse this property to provide a custom path to the Derby database directory.Providing the Derby database directory is useful for Linux environments when upgrading, as you do not need to copy files from the old installation directory to the new installation directory.
hub.database.configuration.directory=/path/to/dbUse this property to provide a custom path to the Derby database.
liquibase.ignoreRecycleBinWarning=trueUse this property to whether or not suppress liquibase warnings.
log4j.configuration=file:/path/to/log4j2.xmlUse this property to provide a custom path to the log4j2.xml file.
log4j.configuration.verbose=file:/path/to/log4j2-troubleshooting.xmlUse this property to provide a custom path to the log4j2-troubleshooting.xml file.
hub.security.cors.exclusionPathsUse this property to provide a list of paths that will be excluded from the CORS verification.
For example: /first-path,/second-path
Prior to version 21.1, this property was configured in /tasktop/container/webapps/root/WEB-INF/web.xml


Good to Know

  • It is not possible to use environment variables to compound values. Properties related to paths must be configured using an absolute path.
  • Properties must be modified in the tasktop-hub.properties file as this file has more priority than properties modified in Manage Tasktop > Java > Java Options | Initial memory pool | Maximum memory pool.
  • It is possible to use environment variables to compound a specific value. As an example, it is possible to use $CATALINA_BASE to compound a path. 

    hub.database.configuration.directory=$CATALINA_BASE/../../directory
    log4j.configuration.verbose=file:$CATALINA_BASE/../../log4j2-troubleshooting.xml

Default File Locations 


When Tasktop Integration Hub is installed on Windows using the MSI installer, the program files (i.e., the executable files and binaries) are located in C:\Program Files\Tasktop; configuration files and logs are located in C:\ProgramData\Tasktop.

(lightbulb) Tip: ProgramData may be a hidden folder, so you will need to change your Windows Explorer settings to show hidden files and folders to find it.

(warning) Note: If you change the location of the ProgramData directory to an alternate location, do not include spaces in the name of the new directory. If the directory has spaces in its name, Tasktop's UI will not be accessible.

When Tasktop Integration Hub is installed on Linux, the program files (i.e., the executable files and binaries), configuration files, and logs are all located in the installation directory where you extracted the distribution archive.

(warning) Note: You must choose a location with no spaces in its path, or Tasktop's UI will not be accessible.

Repository Preparations

Preparing Your Repositories

In Tasktop, the term repository refers to the external tools Tasktop connects to (e.g., Atlassian Jira, ServiceNow, BMC Remedy, etc).

Before connecting Tasktop Integration Hub to your external repositories, you will need to perform some simple preparation on each repository you will be integrating. This preparation includes creating a user account for Tasktop Integration Hub with the appropriate permissions. Please refer to our Connector Docs for detailed instructions for each repository.

Firewalls and Proxies

If Tasktop is installed behind a firewall, you may need to connect to external repositories (e.g. hosted or cloud ALM tools) through a proxy. To create a connection to such external repositories in Tasktop, you can make Tasktop connect through your proxy by configuring the proxy settings when creating a new repository connection. It is recommended to create login credentials specifically for Tasktop on the proxy server.

(lightbulb) Note that the Proxy Location must be a URL in order for the proxy connection to work. If a .pac script is used in your browser, you will need to open the script and find the URL/port to enter in the Location field.

To use a proxy server, check the user proxy server box and fill in your proxy details in the Proxy Server section on the New Repository Screen:

Proxy Server Configuration