Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Hornbill Task Canceller

Overview

The utility provides a simple way to either cancel tasks from within the Hornbill Collaboration Tool. The tool is designed to run behind your corporate firewall, and requires access to your Hornbill instance.

The tool connects to your Hornbill instance in the cloud over HTTPS/SSL, so as long as you have standard internet access then you should be able to use the tool without the need to make any firewall configuration changes.

When the tool is executed, depending on configuration, a list of tasks will be canceled.

Installation Overview

Windows Installation

  • Download the OS and architecture specific ZIP archive
  • Extract zip into a folder you would like the application to run from e.g. C:\data\
  • Open a Command Line Prompt as Administrator
  • Change Directory to the folder containing the utility C:\data\
  • Determine the appropriate executable and possibly rename it to remove confusion.
  • Run the command relevant to the OS of the machine you are running this on:

Windows:

taskCanceller.exe -instance=testinstance -api=abc...def -listfile=C:\data\tasks.csv

taskCanceller.exe -instance=testinstance -api=abc...def -taskref=TSK1234567

Command Line Arguments

  • instance string : ID of the instance to connect to
  • *api string : The API Key to use to authenticate against your Hornbill instance
  • taskref string : Single Task Reference (format: TSK###)
  • listfile string : File name of file containing list of task references (one per line)
  • delete boolean : Set to true to delete the task(s), defaults to false and the cancelation of the task(s)

API Key Rules

Important

We strongly recommend that you create a Service Account in your Hornbill instance, and API Keys against that account which can then be used to perform the required API calls back into Hornbill. Please read the API Key documentation and best practice guide before creating API keys against your user records. The service account that you create must be of type User (not Basic), and be granted the following roles:

This utility requires access to the following Hornbill Platform APIs, and your API Key rules should reflect those, plus additional security hardening in the form of IP rules:

task:taskCancel
task:taskDelete

Network

The utility connects to the Hornbill instance in the cloud over HTTPS/SSL, so as long as you have standard internet access then you should be able to use it without the need to make any proxy or firewall configuration changes.

HTTP Proxies

If you use a proxy for all of your internet traffic, the HTTP_PROXY and HTTPS_PROXY Environment variables need to be set. These environment variables hold the hostname or IP address of your proxy server. It is a standard environment variable and like any such variable, the specific steps you use to set it depends on your operating system.

For Windows machines, it can be set from the command line using the following:

set HTTP_PROXY=HOST:PORT
set HTTPS_PROXY=HOST:PORT

Where HOST is the IP address or hostname of your Proxy Server and PORT is the specific port number. If you require a username and password to go through the proxy, the format for the setting is as follows:

set HTTP_PROXY=username:password@HOST:PORT
set HTTPS_PROXY=username:password@HOST:PORT

URLs to White List

Occasionally, on top of setting the HTTP_PROXY and HTTPS_PROXY variables, the following URLs may need to be white-listed to allow access out from your network to the required endpoints in the Hornbill network:

  • https://files.hornbill.com/instances/INSTANCENAME/zoneinfo - Allows access to lookup your Instance API Endpoint
  • https://files.hornbill.co/instances/INSTANCENAME/zoneinfo - Backup URL for when files.hornbill.com is unavailable
  • https://mdh-p01-api.hornbill.com/INSTANCENAME/xmlmc/ - This is your Instance API Endpoint, where mdh-p01-api is specific to your region and instance. See the API Concepts documentation for more information.
  • https://api.github.com/repos/hornbill/asset-rel-import/tags- Allows the utility to self-update. Optional
  • https://\*.hornbill.com/\* - allows access to the required Hornbill instance information and API endpoints
  • https://api.github.com/repos/hornbill/\* - allows the utility to self-update

Troubleshooting

Logging Overview

No logging apart from a summary at the end and errors/issues will be reflected in the command terminal

Extras

Bundled with the app is a file open-tasks-on-cancelled-requests.report.txt which is a Service Manager report export which can be imported to identify orphaned tasks (i.e. live tasks which which identifies all Task IDs of tasks which are not completed/canceled to canceled requests).

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document