Many project configuration options are available to the templates screen. This page seeks to list all of the available methods and enough information to use them in your templates.
Script Variables
| Variable Name | Description |
|---|
| Project | Project being created. This corresponds to one row in input CSV file and will eventually create one single Project. |
| <Custom Inputs> | Inputs defined on Template. |
General Project Methods
...
...
...
| Description |
|---|
| Project.setProjectPath(String |
...
...
| Yes |
|
| Project.setProjectName(String |
...
...
| Yes |
|
| Project.setDeployPriority(Integer |
...
...
| No |
|
| Project.setDeployPriorityScope(String |
...
...
| No |
|
| Project.setDescription(String |
...
...
| No |
|
| Project.addProperty(String |
...
...
...
...
...
...
...
Workflow Methods
...
...
...
| Description |
|---|
| Project.setBuildWorkflowName(String |
...
...
| Yes |
|
| Project.setDeployWorkflowName(String |
...
...
Instance Methods
| Code Block |
|---|
|
//All these methods take instance Codes, not Names as the methods suggest.
| Tip |
|---|
All these methods take instance Codes, not Names as the methods suggest. |
| Method | Required | Description |
|---|
| Project.setBuildInstanceName(String |
...
...
| Yes | Set Build Instance Code to be used for Project. |
| Project.addDeployInstances(String |
...
...
| Yes | Set one or more Deploy Instance Code to be used for Project. |
...
...
...
| ) if you are passing more than one Deploy instance codes or call method more than once with single value. |
SCM Methods
SCM Type
| Code Block |
|---|
| title | Setting the SCM Type for the Projects |
|---|
|
Project.setSCMType("SCM Type") // Valid Strings for the "SCM Type" are SVN, GIT, TFS, CVS, PERF, CCUCM, PVCS
// Or, use one of these methods instead:
Project.setSVNForSCM()
Project.setGITForSCM()
Project.setTFVCForSCM()
Project.setCVSForSCM()
Project.setPERFForSCM()
Project.setCCUCMForSCM()
Project.setPVCSForSCM() |
Stream Settings
Add additional project streams if necessary. These streams are what the int pSequenceNumber in the SCM details section below refer to.
| Code Block |
|---|
|
Project.createStreamFromMainStream(String pStreamName)
Project.createStream(String pStreamName, String pVersionSyntaxScript)
Project.createStream(String pStreamName, String pVersionSyntaxScript, String pDescription)
Project.createStream(String pStreamName, String pVersionSyntaxScript, String pDescription, String pAttribute1, String pAttribute2, String pAttribute3) |
...
SCM Details
Next, configure the SCM details for your selected SCM Type. Choose one of the methods that contains the options that you need to configure for your projects from the list.
...
| SCM Type | Supported Methods |
|---|
| SVN |
| Code Block |
|---|
Project.addSVNConfig(int pSequenceNumber, String pInstanceCode)
Project.addSVNConfig(int pSequenceNumber, String pInstanceCode, String pTrunkPathScript, String pBranchPathScript, String pTagPathScript, String pCheckoutDirectory) |
|
| GIT |
| Code Block |
|---|
Project.addGITConfig(int pSequenceNumber, String pInstanceCode)
Project.addGITConfig(int pSequenceNumber, String pInstanceCode, String pBranchPathScript, String pTagPathScript, String pCheckoutDirectory, String pSparseCheckoutFoldersScript) |
|
| TFVC |
| Code Block |
|---|
Project.addTFVCConfig(int pSequenceNumber, String pInstanceCode)
Project.addTFVCConfig(int pSequenceNumber, String pInstanceCode, String pMainPathScript, String pBranchPathScript, String pLabelNameScript, String pCheckoutFolderScript) |
|
| PERF |
| Code Block |
|---|
Project.addPERFConfig(int pSequenceNumber, String pInstanceCode)
Project.addPERFConfig(int pSequenceNumber, String pInstanceCode, String pMainPathScript, String pBranchPathScript, String pLabelNameScript, String pCheckoutFolderScript) |
|
| CVS |
| Code Block |
|---|
Project.addCVSConfig(int pSequenceNumber, String pInstanceCode)
Project.addCVSConfig(int pSequenceNumber, String pInstanceCode, String pModuleNameScript, String pBranchNameScript, String pTagScript, String pCheckoutFolderScript) |
|
| CCUCM |
| Code Block |
|---|
Project.addCCUCMConfig(int pSequenceNumber, String pInstanceCode)
Project.addCCUCMConfig(int pSequenceNumber, String pInstanceCode, String pProjectVobScript, String pVobPathsScript, String pStreamScript, String pLabelNameScript, String pCheckoutFolderScript) |
|
| PVCS |
| Code Block |
|---|
Project.addPVCSConfig(int pSequenceNumber, String pInstanceCode)
Project.addPVCSConfig(int pSequenceNumber, String pInstanceCode, String pProjectPathScript, String pPromotionGroupScript, String pUsingPGScript, String pBranchPathScript, String pLabelNameScript, String pCheckoutFolderScript) |
|
...
Continuous Integration Methods
...