Apart from the mandatory commands described in using the Generate command to generate reports, you can use the following command arguments in the command line to generate a report from the Teamwork Cloud (TWCloud) server.
-usageelement specifies the name of one or more elements in the Project Usages of TWCloud project to be included in the report. Element entries must be separated by a semi-colon (;).
For TWCloud projects, -package / -element is used to select one or more packages/elements only in the Primary Model of TWCloud projects. To select packages/elements in Project Usages, specify -usagepackage / -usageelement. You can also set -includeAuxiliary as true if you want to make auxiliary resources available for selection. This -usagepackage / -usageelement argument can be used with -package / -element to select packages/elements in both Primary Model and Project Usages. |
If, for example, you want to generate a Web Publisher 2.0 report from a TWCloud project by getting the latest project version of the trunk branch, type the following:
generate -server "localhost" -login "Administrator" -password "Administrator" -servertype "twcloud" -project "MyProject" -package "SamplePackage" -template "Web Publisher 2.0" -output "D:\output\output.html" |
The following code generates a Class Specification Report report from the TWCloud project by getting the project version number 10 from MyBranch branch of the MyProject project.
generate -server "localhost" -login "Administrator" -password "Administrator" -servertype "twcloud" -project "MyProject" -branch "MyBranch" -pversion "10" -package "SamplePackage" -template "Web Publisher 2.0" -output "D:\output\output.html" |
The following code generates a specific project version by specifying tagName.
generate -project "MyProject" -branch "TestingLine" -tag "Finish" -incremental true -output "C:/output/out.docx" -template "Class Specification Report" -package "SamplePackage" -server "localhost" -servertype "twcloud" -login "Administrator" -password "Administrator" |
The following code generates a report through an SSL secured connection.
generate -project "MyProject" -package "Model" -template "Web Publisher 2.0" -output "D:\output\output.html" -server "localhost:1111" -login "Administrator" -password "Administrator" -ssl "true" |
The specified project version would be used to generate the report as a first priority, in case the specified project version does not belong in the specified branch. |
If the project version specified is not the latest, the -updatemodule option would not affect the generate command. |