TDIing out loud, ok SDIing as well

Ramblings on the paradigm-shift that is TDI.

Saturday, February 6, 2010

What Is The Solution Directory?

The Solution Directory is the personal working folder for a TDI Server. Each TDI Server running on the same machine must have it's own Solution Directory. The reason for this is that a TDI Server gets it's configuration settings, including settings for the JVM, from a file in the Solution Directory named solution.properties. After reading the solution properties file then the Server reads the global.properties file in the etc sub-folder of the TDI installation directory. Settings in solution.properties override those in global.properties.

If you open solution.properties in a text editor you can find two important properties that are personal to any running TDI Server:

  • The port that the Server listens to for RMI API calls: api.remote.naming.port
  • The port that the Server listens to web calls: web.server.port (dashboard, FDS, CURI and REST APIs)

This is also where you provide the paths to keystores and truststores. By default, those for the TDI Server itself are named 'testserver' and found in the Solution Directory. Those used for SSL connections are by default under the serverapi sub-folder and are called 'testadmin'. The password for 'testserver' is 'server, and for 'testadmin' is 'administrator'. To import your own certificates use keytool (found under the jvm/jre/bin sub-folder of your TDI installation directory) or the Key Manager button in the TDI CE (Configuration Editor).

If you remove all properties in solution.properties that you are not explicitly setting, then a TDI version upgrade could affect settings for your Server.

Leveraging the Solution Properties folder to make your solutions more portable

The Solution Directory is also the "current path" whenever you run TDI, either the CE or the Server. As a result, if you use relative filepaths then your solution is easily moved between TDI Servers. For example, edit the Editor tab of your Resources > Properties > <Project PropertyStore> and set the Collection Path/URL to a filepath that is relative to your Solution Directory - for example: MyProject/MyProject.properties. Also, always use forward-slashes for paths, that way your solution runs on Windows and *nix.

Once your properties are stored relative, right-click on the topmost folder of your Project in the CE Navigator View and select Properties. Choose Tivoli Directory Integrator properties at the bottom and set the Linked File parameter to a relative path that points to a config file under this same folder, like MyProjext/MyProject.xml.

Make sure you also put any other support files in this folder so you can easily move the solution by simply compressing this folder and then uncompressing it in the Solution Directory of the target TDI installation.

The ReadMe.txt file you make in your project directory could look something like this:

To install this solution:

1) Unzip ADSync.zip to your Solution Directory;
2) Edit ADSync.properties to configure connections
3) Run the solution with this commandline:

ibmdisrv -c ADSync/ADSync.xml -r ADSync

Violá, you have something that you can hand to the operations team for deployment, pass on to a colleague, and even publish it online (and get yourself a Metamerge pen by sending me the link).

Pointing to a specific Solution Directory

Stephen Swann pointed out to me that I need to mention the ibmdisrv and ibmditk commandline argument for specifying the Solution Directory to use: the -s argument. In additon, in those cases where TDI has been installed via automated scripts and the CE is not going to be started in order to prepare the Solution Directory, there is also the -g argument to instruct the TDI Server to do this job.

    ibmdisrv -s /MyOtherSolDir -g

The above command line will instruct the TDI Server to prepare the MyOtherSolDir folder as a Solution Directory.

Your Eclipse workspace

So the Solution Directory is a tool for making solutions portable, and it is independent of where you put your TDI 7 workspace. The workspace is where the Eclipse part of TDI organizes your source files, and the directory structure there mirrors what you see in the CE Navigator. It is not recommended that you work directly with source files, apart from tying them to a Source Management tool.

What if..?

But what if you chose the program directory or "current location" when you installed, or want to move the Solution Directory for some other reason? No problem. Go to the TDI installation folder and edit the batch-file (script) bin/defaultSolDir and change the path set there. This single line sets up the TDI_SOLDIR environment variable used further down in the launcher script. So if you want to move your Solution Directory, simply change this assignment. Note that if you craft your own scripts/batch-files, also set TDI_SOLDER at the top and then refer to this variable to invoke TDI launch scripts. This makes your own scripts easier to re-use.

Changing TDI_SOLDER is only half the job. You also have to instruct the CE where the new Solution Directory is when it automatically starts up your local TDI Server, called 'Default'. You do this by right-clicking on 'Default' in the Server view and selecting Properties and making the change here too.

Final note about the Servers view

The view is not called Servers for nothing. TDI lets you define new Servers, allowing you to start multiple Servers on your PC, or connect to those running on other platforms. You can point a Project at any Server by editing its settings (right-click > Properties). This lets you test and debug the ALs there. Each Server has its own Solution Directory settings, so using relative paths means you can build your ALs on your laptop and then run them elsewhere. You will also want to use forward slashes for filepaths, since backslash only works on Windows and TDI runs a lot of other places as well.

And while I'm on the soapbox here are some additional tips: Define Logging for where your task.logmsg() messages are written; Code Error Hooks and log enough info for manual intervention; Write status messages to the command line by using main.logmsg(); And set up Connector Auto-Reconnect (Connection Errors).