FlexDeploy lets users create many projects in a single action using a CSV template. This process allows users to create a number of project and associated Git Repositories from an import. Permissions to create projects in the desired folders and to create Git Repositories are necessary to complete the creation process.
If you wish to create multiple projects at the same time, click Create From CSV on the Project creation page.
Create the CSV file with Appropriate Headers
Projects are created from a CSV file (Comma Separated Values) that contains data for the projects you are going to create. A CSV file with the headers that you need can be downloaded from FlexDeploy by pressing the Download Sample CSV button.
Select a build and deploy workflow to generate the Sample CSV. The column headers are generated in the file indicating all the data that must be populated to meet the requirements of the workflows.
Fill in Data Rows
Some of the columns in the CSV depend on the workflows that you selected. Others will appear in the file no matter which workflows you choose. The table below lists all the columns that you will have and explains that they are for and if they are optional for creating a project.
Column | Data Type | Required to Create the project | Description |
|---|---|---|---|
ProjectName | String | Yes | The name of the project you wish to create |
FolderPath | String | Yes | The folder path to locate the project. Must start with FlexDeploy/ You can use a nested folder structure. The folders will be created, if you have permission to create them. |
Description | String | No | An optional description for the project. |
ProjectType | Enum Values | No | The type of the project you wish to create. If it is left blank a standard project is created. If populated, a Package Based project will be created of selected types. Selectable types are as follows: EBS |
DeploySequence | Integer | No | |
NextProjectBuildNumber | Integer | No | |
BranchName | String | No | |
VersionNameSyntax | String | No | |
NextBranchBuildNumber | Integer | No | |
SparseCheckoutFolders | String | No | |
FDGIT_URL | String | Yes | Git URL you would like the project source to be |
FDGIT_USER | String | Yes | Git User |
FDGIT_PASSWORD | String | No | Git Password |
BuildWorkflow | String | Yes | The name of the workflow that you wish to use for building the project. |
DeployWorkflow | String | Yes | The name of the workflow that you wish to use for deploying the project. |
BuildTargetGroup | String | Yes | The Target Group Code of the target group that you wish to use for builds. |
DeployTargetGroup | String | Yes | The Target Group Code of the target group that you wish to use for deployment. |
Upload the CSV
Once you add your data into the CSV, click on the Upload CSV button to select the file. No projects are created at this step, the CSV is only parsed to check for validation errors, formatting errors, and missing inputs. Press Upload to check your data and review the import.
Review and Edit the uploaded data
After the data is uploaded, a list of the parsed projects will appear on the left side of the screen. A status indicator will appear on the left of each row denoting the status of the project. Hovering over the indicator will give a quick heads up to possible issues that arose during parsing.
The projects can be selected to view or edit the details by clicking on the rows on the left. You are able to edit any of the attributes here before the project is created. This is the time to fix any errors. Any changes you make here will take effect when you create the projects. If you leave the screen, you will need to upload the CSV again, and all your changes will be lost. You may want to create some projects before reviewing others. This is easy to do and is explained in the following screenshots. Any projects you have created will remain if you leave the screen. You can create some, then upload the file again to work on other rows if desired.
The status indicator will be changed when the input becomes valid.
Create Projects from the uploaded data
After errors are resolved for the projects you would like to create, select projects for creation. You are able to select projects by either clicking the checkboxes on each row or by clicking the Select All check box to select all Valid project inputs. You cannot attempt to create projects which have validation errors.
After your desired projects are selected, click the Create Selected Projects button. Decide if you would like to stop the creation of projects if an error arises during creation, or if you would like to continue even if a project causes an error.
Review the Project Creation Results
After projects are created successfully, their status indicator will turn green. Each project is also read-only on the right side indicating that you are done working on it. There is also a link to the created project on the left if you wish to view it after creation.