ProjectBuilder provides a set of utilities to define types, commands, build module libraries, load resource data, even generate a Forrest documentation site. For type and module development, ProjectBuilder supports a typical edit, build, test methodology familiar to most developers wherein, a set of source files maintained in a source code repository are developed using familiar text editing tools, and ProjectBuilder builds and deploys them, so that the results can be distributed and used.
To create types
ProjectBuilder provides two primary commands to create and build new modules:
- create-type — Creates a set of source files containing a boilerplate type definition
- build-type — Processes the type's source files and generates a Jar file that can be loaded into Workbench or distributed to CTL hosts.
If you are a new user (or new to ProjectBuilder) review the following pages:
- Use ProjectBuilder
- Introduces ProjectBuilder and how to configure it to manage a set of source files to maintain a project. See a screencast
- First custom type
- Describes how to use the
create-typecommand to create a new module source tree. See a screencast (part 1), (part 2)
You can of course use the graphical Graphical type editor to define your types and commands and then later export them as source files. See Converting Workbench modules for use with ProjectBuilder.
ProjectBuilder is a utility module based on Builder containing commands used to create and manage project artifacts such as types, resources and jobs. You can use ProjectBuilder commands on any host as it connects to the server over the network.
A ProjectBuilder can be registered in XML using the project.xml format.
See Use ProjectBuilder for a step by step example of defining a ProjectBuilder.
Use the ProjectBuilder
find-resources command to list all "ProjectBuilder" instances:
$ ctl -p demo -m ProjectBuilder -c find-resources -- -type ProjectBuilder | |--(ProjectBuilder) core
For a graphical alternative, you can use the Graphical resource editor and view the builders there.
Go to the Builder list. You will see it list all builders.