userlessbuild

This tool is used to add jobs to Headless Designer 9.0.1. Please, have a look at designer wiki for background information.

http://www-10.lotus.com/ldd/ddwiki.nsf/dx/Headless_Designer_Wiki

This tool can be installed into domino Designer using standard procedure. It also provides a set of ant tasks that allows you to automate the generation of your NSF files and update sites.

Download update site and jar file

A ready to install version of the update site is available at :

Update Site for Designer plugins

And a ready to use version of the jar that contains the ant tasks is available at :

Ant Tasks for Headless Designer

Compile it yourself

• Import projects into Designer (right click into package explorer / Import / Existing project into Workspace)
• You will have to add dependencies on ant jars and on notes.jar to compile the project that contains the ant tasks. But event if it does not compile, you will be able to add the commands into your designer.
• Compile update site:
  • Open fr.asi.designer.userlessbuild.site/site.xml file
  • Click on "Build All". This will work even if the ant tasks project contains compilation errors.
• Use Domino Designer File/Application/Install (check preferences if menu entry is not present)
  • Add new feature
  • Add Folder Update Site that points to fr.asi.designer.userlessbuild.site
• Accept licenses, and restart Designer

Additional Designer Commands

Compile update site

This job can be used to compile an already imported update site. This is the exact equivalent of opening the site.xml file, and clicking "Build All".

Example command file :

config,true,true
fr.asi.designer.userlessbuild.HDBuildSiteJob,<name of the project to build>
exit

Wait for automatic build to finish

This job can be used to wait for build jobs to stop. Very usefull after importer a bunch of java projects, and you want that eclipse only exits when compilation is over.

Example command file :

config,true,true
com.ibm.designer.domino.tools.userlessbuild.jobs.ImportOnDiskProjectJob,<path to .project file>
fr.asi.designer.userlessbuild.WaitForBuildJob,<name of the project to build>
exit

Check for errors

This job will check if there are some errors into a given project. It will work on java projects (your Library plugins for example), and on Domino projects.

Note that the job will simply fail with an ERROR state. So will have to define "config,true,true" at the beginning of your command file to make it work.

Example command file :

config,true,true
importandbuild,d:/Sources/mydatabase-ondisk/.project,mydatabase.nsf
wait,mydatabase.nsf,20
fr.asi.designer.userlessbuild.CheckErrorJob,mydatabase.nsf
exit

This command file will fail with errors if mydatabase.nsf contains errors.

Additionnal Ant tasks

Running ant tasks

First of all, you will have to install ant. This is pretty simple.

Next, you will have to ask ant to run build.xml files using the local Notes Client JVM. For this, make the JAVA_HOME environment variable point to

${NOTES_ROOT}/jvm  

Where NOTES_ROOT is where you installed your notes client.

Declaring the tasks in a build.xml file

Put the jar file in a "lib" folder, next to the build.xml file.

To include the tasks, just use a standard taskdef tag :

<project name="test">
	...
	<path id="project.class.path">
		<fileset dir="lib" includes="*.jar" />
	</path>
	<taskdef
			resource="userlessbuild-ant-tasks.properties"
			classpathref="project.class.path"/>
	...
</project>

Tasks to manipulate source code

runDesignerCommands

This command will :

• Launch Domino Designer in headless mode
• Make it execute the commands you put inside the tag
• It will then loop until Designer stop
• While looping, it will check for the log files, and send their content to the console.

If an error is detected inside the log file, the task will fail.

<runDesignerCommands designerPath="C:\Notes\">
	config,true,true
	exit
</runDesignerCommands>

waitForDesigner

Will wait for designer to shutdown. This task doesn't need any parameters.

<waitForDesigner/>

setManifestVersion

Will update the version inside a MANIFEST.MF file

<setManifestVersion version="4.6.0" manifestFile="${basedir}/fr.asi.test/META-INF/MANIFEST.MF"/>

setFeatureVersion

Will update the version defined in a feature.xml file

<setFeatureVersion version="4.6.0" featureXmlFile="${basedir}/fr.asi.test.feature/feature.xml"/>

setUpdateSiteVersion

Will update the features versions inside a site.xml file.

<setUpdateSiteVersion version="4.6.0" siteXmlFile="${basedir}/fr.asi.test.site/site.xml"/>

setOnDiskTitle

This task will update a ondisk project (mirror of the design of an NSF file) to change the database title.

<setOnDiskTitle onDiskPath="${basedir}/mydatabase-ondisk" title="New Title"/>

setOnDiskTemplate

This task will change the name of the template that a given database is declaring. It will make the needed changes inside an ondisk project (mirror of the design of an NSF file).

<setOnDiskTemplate onDiskPath="${basedir}/mydatabase-ondisk" masterTemplateName="mytmpl"/>

Tasks to manipulate Domino Servers

These tasks are using the standard notes apis. They will open sessions to the Notes server using the local Notes client. For this, you will have to give them the password of the local ID file.

DatabaseSet

Some tasks supports a nested tag which allows the task to run on multiple databases. On these tasks, you can also define the following properties :

• server: the server to find the database
• password: Password of the local ID file to access to the database
• database: A database to run on. This is a shortcut when processing only one database.

Launch a task on a single database :

<atask server="SERVER/ASI" password="mypassword" database="db.nsf"/>

Same a previous task :

<atask server="SERVER/ASI" password="mypassword">
	<databaseSet database="mydb.nsf"/>
</atask>

Run on multiple databases :

<atask server="SERVER/ASI" password="mypassword">
	<databaseSet database="mydb1.nsf"/>
	<databaseSet database="mydb2.nsf"/>
</atask>

Run on all databases that inherits from template "tmpl" :

<atask server="SERVER/ASI" password="mypassword">
	<databaseSet template="tmpl"/>
</atask>

Run on db1, db2 and on all database that inherits from tmpl :

<atask server="SERVER/ASI" password="mypassword" database="db1.nsf">
	<databaseSet database="db2.nsf"/>
	<databaseSet template="tmpl"/>
</atask>

httpStop

Will stop the http task. Password is the password of your local ID file.

<httpStop server="SERVER/ASI" password="mypassword"/>

httpStart

Will start the http task. Password is the password of your local ID file.

<httpStart server="SERVER/ASI" password="mypassword"/>

databaseDelete

Will remove a database

<databaseDelete server="SERVER/ASI" database="mydatabase.nsf" password="mypassword"/>

databaseCopy

Will copy a database.

<databaseCopy srcServer="" srcDatabase="mydb.ntf" destServer="SERVER/ASI" destDatabase="mydb.ntf" password="mypassword" templateCheck="mytmpl"/>

The "templatecheck" parameter will make the task check that the copied database is declaring the given template name (after copy). This will fail if the server already contains a database that declares the same template name. Yes, I love Domino...

signWithServerId

Will sign the given database with the server ID. This task will create an administration request, and wait for adminp to process it.

<signWithServerId server="SERVER/ASI" database="mydatabase.nsf" password="mypassword"/>

clearUpdateSiteDb

This task will clear an update site database.

<clearUpdateSiteDb server="SERVER/ASI" database="updateSite.nsf" password="mypassword"/>

runAgent

This task will run an agent. It will make it run on a context document, on which you will be able to add fields using nested contextDocField tags.

<runAgent server="SERVER/ASI" database="db.nsf" agent="myagent" password="mypassword">
	<contextDocField name="MyField" value="my value"/>
	<contextDocField name="MyField2" value="my other value"/>
</runAgent>

refreshDesign

This task will refresh the design of the given database. The refresh is done via the domino "designer" task. The task will end when it will detect that the domino "designer" task ends.

<refreshDesign server="SERVER/ASI" database="mydb.nsf" password="mypassword"/>

This task also support nested tags.

<refreshDesign server="SERVER/ASI" password="mypassword">
	<databaseSet template="tmpl"/>
</refreshDesign>

setOnBehalfOf

This task will make an agent run "on behalf of" a given user.

<setOnBehalfOf server="SERVER/ASI" database="mydb.nsf" agent="myagent" onBehalfOf="CN=Lionel HERVIER/O=ASI" password="mypassword"/>

This task also support nested tags.

<setOnBehalfOf server="SERVER/ASI" agent="myagent" onBehalfOf="CN=Lionel HERVIER/O=ASI" password="mypassword">
	<databaseSet template="tmpl"/>
</setOnBehalfOf>

enableAgent

This task will allows you to enable an agent

<enableAgent server="SERVER/ASI" database="mydb.nsf" agent="myagent" serverToRun="SERVER2/ASI" password="mypassword"/>

The "serverToRun" is the name of the server the agent will be activated on.

This task also support nested tags.

<enableAgent server="SERVER/ASI" agent="myagent" serverToRun="SERVER2/ASI" password="mypassword">
	<databaseSet template="tmpl"/>
</enableAgent>