Open.ControlTier > ModuleForge
 

RdbProjectBuilder

Builds and manages projects that use the content library

Overview

Open in Workbench RdbProjectBuilder: Builds and manages projects that use the content library

RdbProjectBuilder is derived from ProjectBuilder providing the ability to manage a ControlTier project. If you are new to ProjectBuilder see the tutorial starting with: Getting started using ProjectBuilder

The following sections describe how to obtain, install and use the data Module Library.

Obtaining the data library

Follow the steps below to obtain and install the data library.

1) Download the desired library jar file from Sourceforge:

data Module Library file release

2) Run the Register command specifying the following arguments:

ad -p project -t ProjectBuilder -o data -c Register -- \
	 -basedir /path/to/basedir -installroot /path/to/targetdir

3) Run the load-library command specifying the following arguments:

ad -p project -t ProjectBuilder -o data -c load-library -- \
        -jar /path/to/downloaded/data-version.jar

The destination project should now have the data library types loaded.

Using the data library

If you do not have the data types loaded, see the preceding section.

After the data library is installed, begin using the types in the library beginning with RdbProjectBuilder:

1) Run the Register command specifying the following arguments:

 ad -p project -t RdbProjectBuilder -o name -c Register -- \
        -basedir /path/to/module/srcdir -installroot /path/to/build/targetdir -install

2) Run the generate-objects command specifying the following arguments:

 ad -p project -t RdbProjectBuilder -o name -c generate-objects -- \
        -name aName -defaults /path/to/your/defaults.properties -load

The -name argument is used as the name for each generated object. The -load flag specifies to have loaded the object definitions loaded on the server.

3) Run the depot-setup command to deploy the objects in AntDepo:

depot-setup -p project -a deploy

The objects are now ready for use either via the AntDepo CLI command, ad, or via JobCenter webapp GUI.

The objects are now ready for use either via the AntDepo CLI command, ad, or via JobCenter webapp GUI.

4) Run the BuildAndUpdate command that will use the newly generated set of objects:

ad -p project -t dataUpdater -o aName -c BuildAndUpdate -- \
        -buildstamp buildstamp

Note
Optionally, you can upload the job definition to Job Center. The generate-objects command will have also generated a name-job.xml. Login to JobCenter and push the "Create a new Job" button and upload the name-job.xml file.

Design

Super Type
ProjectBuilder

Extends ProjectBuilder

Role Concrete. (Objects can be created.)
Instance Names Unique
Notification false
Template Directory
Data View Children, proximity: 1
Logger Name RdbProjectBuilder

Constraints

Allowed Child Dependencies

  • BuilderBuildFile1
  • BuilderBuildTarget1
  • BuilderScmBinding1
  • BuilderScmConnection1
  • BuilderScmLabel1
  • BuilderScmModule1
  • BuilderStageExtension1
  • BuilderStageFilebase1
  • ProjectBuilderDocBase1
  • ProjectBuilderForrestHome1
  • ProjectBuilderOrganizationDescription1
  • ProjectBuilderOrganizationName1
  • ProjectBuilderOrganizationURL1
  • ProjectBuilderProjectDescription1
  • ProjectBuilderProjectName1
  • ProjectBuilderProjectURL1
  • RdbProjectBuilderDefaults1
  • RdbProjectBuilderTemplateDir1

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

  • Node

Attributes

Exported Attributes

Name Property
basedir deployment-basedir
targetdir deployment-install-root

Defaults for Imported Attributes

Name Default
buildfile ${modules.dir}/RdbProjectBuilder/lib/build.xml
buildtarget all
defaults ${modules.dir}/RdbProjectBuilder/templates/defaults.properties
organizationDescription Maker of the ControlTier software
organizationName ControlTier
organizationURL http://www.controltier.com
projectDescription The data deployment types
projectName atg
projectURL http://open.controltier.com
scmConnection https://moduleforge.svn.sourceforge.net/svnroot/moduleforge/trunk
scmModule atg
stageextension jar
stagefilebase .*
templateDir ${modules.dir}/RdbProjectBuilder/templates

Commands

Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

Related Types

The following types are defined for use with RdbProjectBuilder.

RdbProjectBuilderSetting

Overview

Open in Workbench RdbProjectBuilderSetting: A RdbProjectBuilder setting.

Design

Super Type
Setting
Role Abstract. (Objects cannot be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies
  • Builder