Creating Projects From CSV
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.
About Creating Project From CSV
What you can create from CSV
Standard Projects
Package-Based Projects
Up to 100 Projects per upload
Projects with 1 Git based sources or No sources.
Folders for Projects
Git Instances for Project Sources
What you cannot create from CSV
Utility Projects
Container Projects
More than 100 Projects per upload
Projects with Non-Git Sources
Projects with multiple sources
Packages for Package-Based Projects
Triggers for Projects
More than one Branch for Projects
Target Groups
Build and Deploy Workflows
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 Header | Data Type | Required | 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 in the CSV, a standard project is created. If populated, a Package-Based project will be created of the selected type. You will not be able to change between Standard and Package Based Classifications after upload. The available options are below. Project Type Name or Code to enter in the CSV. EBS - EBS |
DeploySequence | Integer | No | Optionally sets the deploy sequence for the project. |
NextProjectBuildNumber | Integer | No | Optionally sets the next build number for the project. Defaults to 1. |
BranchName | String | No | Optionally sets the branch name for the project. Defaults to the default branch from project defaults. |
VersionNameSyntax | String | No | Groovy Script Options sets the version name syntax (groovy) for the project. Defaults to the value from project defaults. |
NextBranchBuildNumber | Integer | No | Optionally sets the next build number for the main branch. Defaults to 1. |
SparseCheckoutFolders | String | No | Groovy Script Set’s the sparse checkout folder for the project. |
FDGIT_URL | String | Yes | Git URL you would like for the project source. If the URL matches an existing Git Instance, the instance will be used for project creation. If no Git Instance is found, the Git Instance will be required to create the project. If no matching Git instance exists, the current FlexDeploy user will be used to create one. As a result, you may want to assign create/modify integration instance permission to users that you want to create projects in bulk. |
FDGIT_USER | String | Yes | Git User. This is only required if a Git Instance is not found and one is being created on project creation. |
FDGIT_PASSWORD | String | Yes | Git Password. This is only required if a Git Instance is not found and one is being created on project creation. |
BuildWorkflow | String | Yes | The name of the workflow that you wish to use for building the project. A Valid Build Workflow is required in the CSV File in order to upload. Workflow is not editable after upload. |
DeployWorkflow | String | Yes | The name of the workflow that you wish to use for deploying the project. A Valid Deploy Workflow is required in the CSV File in order to upload. Workflow is not editable after upload. |
BuildTargetGroup | String | Yes | The Target Group Code of the target group that you wish to use for builds. Note - this is Code and not Name. |
DeployTargetGroup | String | Yes | The Target Group Code(s) of the target group that you wish to use for deployment. More than one value can be entered separated by comma, in which case double quotes will be required around entire value. Tools like Excel will add the quotes automatically. Note - this is Code and not Name. |
Additional Properties
Additional properties for each project can be included in the CSV as additional headers after the above data. These additional properties are dependent on the workflows that are being supplied for each project in the CSV that is uploaded.
The header for a column in the CSV pertaining to an addition property is the property code (FDEBS_APPLICATION_SHORT_NAME for example).
Property value must be valid as per Data Type.
All required properties must be populated before the project is considered valid for creation.
If a Property requires a Credential (is encrypted), then the Credential Name may be provided as the CSV value. It can be selected or changed after upload as well.
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.
- style