| Task Linking Configuration | ||
|---|---|---|
|
|
|
| Task Synchronization Configuration | Maintenance and Inspection | |
This section documents the steps required to configure Task Linking.
To initially configure your OSLC Adapter, complete the following steps:
OSC Linking in the Services view and selecting “Properties”
protocol, use the URL protocol (probably
http) users will connect to your computer with.
hostname, you should pick a hostname that is resolvable by DNS and that must not change once task relationships begin getting persisted. Users will need to be able to reach it when they link tasks.
port, you can choose any port which does not conflict with another port and which will not be blocked by security software.
bindIP, you need to choose which IP address (of several that your server might have) that the Task Linking service should bind to. If you set
bindIP to 0.0.0.0 it will bind to all configured IP addresses on the computer.
disableAuthentication should be
false if you want authentication and
true if you want to disable authentication. (See authentication note below.)
authenticationRepositories, give a space-separated list of URLs of configured task repositories that can be used to authenticate the user’s name/password. (See authentication note below.) URLs may have a trailing ‘*’, in which case a wildcard match is applied.
allowedRemoteHosts, give a space-separated list of IP addresses that can access the OSLC Adapter without authentication. If unspecified, all IP addresses must authenticate.
OAuth Consumer Secret must be a randomized 40 character hex string, used to allow OSLC consumers to create an OAuth connection via Task Linking. We suggest that you replace some digits of the example string with hex gibberish.
autoStart, you should leave it “false” (or unspecified) until you are satisfied that your configuration is correct. Afterwards, setting
autoStart to “true” will cause Tasktop Linking to start as soon as Tasktop Sync is launched.
If you will be using TLS/HTTPS (SSL) to serve Tasktop Linking traffic there are a few more properties that you need to set.
Note: You should read http://docs.codehaus.org/display/JETTY/How+to+configure+SSL for information on generating a keystore from your existing certificates or using keytool to generate self-signed certificates.
keystore is the file where the keystore will be kept. The keystore contains certificates that are used to encrypt the Tasktop Linking traffic between the client and server. It defaults to
$TASKTOP_SYNC_HOME/workspace/tasktop/.keystore if unspecified.
keystorePassword is the password used to access the keystore. Note that as this is a Java .properties file, you do not need to quote the password.
keystoreKeyPassword is the password for individual records. This may be the same as
keystorePassword.
truststore is the file where the truststore containing trusted certificates will be kept. This information will be used to authenticate trusted remote users. It also defaults to
$TASKTOP_SYNC_HOME/workspace/tasktop/.keystore. It can be the same as the
keystore or a different file if desired.
truststorePassword is the password used to access the truststore.
Next, start test your configuration with the Task Linking server controls — start, stop, and restart. These are in a dropdown menu in the Tasktop Sync toolbar with an OSLC icon:
Once you are happy with your configuration, you can set the
autoStart property to
true so that Task Linking will start automatically.
Authentication Note: In the unauthenticated mode (
disableAuthentication=true), Task Linking will be open to any traffic and is unauthenticated. It is not recommended to use this mode in production or on any network that is open to the public. However, it can be useful for testing and initial configuration inside a firewall.
In the authenticated mode (
disableAuthentication=false), Task Linking will present a login form to users and require that they authenticate using a username and password of one of the configured task repositories on the Sync server. We recommend that you normally run the service in this mode. The
oslcAdapter.authenticationRepositories configuration field specifies which task repositories are used for authentication. If unspecified, Tasktop Sync will attempt to authenticate against all task repositories that are configured in the Sync server, one by one until a login validates.
To add Task Linking as a service that provides links to related tasks, complete the following steps:
Navigate to the Jazz Team Server
Administration Home:
Click on
Application under
Change and Configuration Management, and you will get to the Change and Configuration Management page:
Click on
Friends (Outbound) section in the left sidebar. When the
Friends page appears, click
Add and complete the form using values from your
oslc.properties file. These values much match the values in the
oslc.properties file exactly.
Tasktop OSLC Adapter.
protocol://
hostname:
port/oslc/rootservices
consumerSecret
The filled-in form will look something like this:
Click on the
Finish button, and you will get confirmation that the service has been registered as a
Friend:
Click on the
Create Friend button, and you will get a dialog which should confirm that the friend was created with a provisional 32 character hex key:
Click on
Finish, and you will see the Tasktop Sync service show up in the Friends List:
For each Project Area that you wish to enable the consumption of remote tasks using Task Linking, complete the following steps:
Navigate to the
Project Area Administration Page on the top tab bar, then navigate to a project area:
Navigate to the bottom section,
Associations:
Click on
Add... at the right of the
Associations header bar:
Select an Application: “Tasktop OSLC Adapter” or whatever you named your server on the
Friends page.
Select the desired Association (e.g.,
Provides - Related Change Requests), and the desired source Artifact Container (e.g.,
HP ALM 11 Quality Center).
The Artifact Container is where your remote task will be sourced from. The available Artifact Containers are the Task Repositories that are configured in your running Tasktop Sync workspace.
Click on the
OK, then the
Save button.
To link a remote task to an IBM RTC CCM task, complete the following steps:
Open a task (create one if you need to).
Navigate to the task’s
Links tab and select
Related Change Request or another association name from the dropdown menu:
You might get a dialog which asks about secure content; Ensure that you allow mixed secure and non-secure content to be displayed.
Enter a search term and press
Search.
Select a search result you would like to link to.
Press
OK.
Save the task.
You can now see a small preview of the task by hovering over the link:
You can see more detail by clicking the
See more link:
You can click on the hyperlinked task ID in the ID field to open the target task in a new browser.
To add Task Linking as a service that provides links to related tasks, complete the following steps:
Navigate to the Jazz Team Server
Administration Home:
Click on
Jazz Team Server - Server Administration under
Manage the Servers, and you will get to the Server Administration page:
Click on
Friends (Outbound) section in the left sidebar. When the
Friends page appears, click
Add and complete the form using values from your
oslc.properties file. These values much match the values in the
oslc.properties file exactly.
Tasktop OSLC Adapter.
protocol://
hostname:
port/oslc/rootservices
consumerSecret
The filled-in form will look something like this:
Click on the
Finish button, and you will get confirmation that the service has been registered as a
Friend:
Click on the
Create Friend button, and you will get a dialog which should confirm that the friend was created with a provisional 32 character hex key:
Click on
Finish, and you will see the Tasktop Sync service show up in the Friends List:
For each Project Area that you wish to enable the consumption of remote tasks using Task Linking, complete the following steps:
Navigate to the
Project Area Administration Page on the top tab bar, then navigate to a project area:
Navigate to the bottom section,
Associations:
Click on
Add... at the right of the
Associations header bar:
Select an Application: “Tasktop OSLC Adapter” or whatever you named your server on the
Friends page.
Select the desired Association (e.g.,
Provides - Related Change Requests), and the desired source Artifact Container (e.g.,
HP ALM 11 Quality Center).
The Artifact Container is where your remote task will be sourced from. The available Artifact Containers are the Task Repositories that are configured in your running Tasktop Sync workspace.
Click on the
OK, then the
Save button.
To link a remote task to an IBM RTC RRC artifact, complete the following steps:
Open an requirement artifact (create one if you need to).
From the requirement’s
Links section, select
Related Change Request or another association name from the dropdown menu:
Enter a search term and press
Search.
Select a search result you would like to link to.
Press
OK.
Save the task.
You can now see a small preview of the task by hovering over the link:
You can see more detail by clicking the
See more link:
You can click on the hyperlinked task ID in the ID field to open the target task in a new browser.
|
|
|
| Task Synchronization Configuration | Maintenance and Inspection |