You can use the following command arguments in the command line to generate a report from Teamwork Server.
- -server, -login, and -password are key arguments to log on to Teamwork Server. You will be prompted for a password when trying to enter -server and -login without -password.
- If -spassword is used with a properties file, an encrypted password must be used for this property.
- -pversion is a key argument to specify a Teamwork project version. You can specify a project version after -pversion. If either you do not specify any version, or the version you specify does not match any version in Teamwork Server, Report Wizard will generate the latest project version.
- -tag is an option to specify a Teamwork project. You can specify tagName to search for a project version. The returned project version may be more than one. You may use this command argument with "-incremental true".
- You can specify a project name and its branch after -project. For example:
"MyProject" means generating MyProject without specifying its branch.
"MyProject##release" means generating MyProject from the branch ["release"].
"MyProject##release##sp1" means generating MyProject from the branch and sub-branch ["release", "sp1"].
See the following for more examples of how to generate a project from a specific branch and/or a specific version.
| Example | Command argument |
|---|---|
| Generating a project without specifying its branch. | generate -project "MyProject" -template "Web Publisher 2.0" -output "D:\output\output.html" -package "Model" -server "localhost" -login "Administrator" -password "Administrator" |
| Generating a project from the branch release. | generate -project "MyProject##release" -template "Web Publisher 2.0" -output "D:\output\output.html" -package "Model" -server "localhost" -login "Administrator" -password "Administrator" |
| Generating a specific version of a project without specifying its branch. | generate -project "MyProject" -pversion "2" -template "Web Publisher 2.0" -output "D:\output\output.html" -package "Model" -server "localhost" -login "Administrator" -password "Administrator" |
| Generating a specific version of a project from the branch release. | generate -project "MyProject##release" -pversion "2" -template "Web Publisher 2.0" -output "D:\output\output.html" -package "Model" -server "localhost" -login "Administrator" -password "Administrator" |
| Generating a set of reports from a specific tag. | generate -project "MyProject" -tag "Finish" -incremental true -ouput "C:/output/out.docx" -template "Class Specification Report" -package "Model" -server "localhost" -login "Administrator" -password "Administrator" |