Integration of the Bulk Add Tool into P4 Admin
In situations where the Bulk Add or Bulk Project Creator Tool is absent from P4 Admin, it is necessary to engage a Perforce administrator for its inclusion. Alternatively, if possessing the role of a P4 Admin Super User, the tool can be integrated by adhering to the installation instructions detailed in the repository found here.
Installation Steps:
- Repository Cloning: Initiate by cloning the tool's repository to a local directory.
- Tool Creation in P4 Admin:
- Navigate to
Tools > Manage Tools > Custom Tools...
after logging into P4 Admin with super user credentials.
- Navigate to
- Tool Registration:
- Within the Custom Tools window, opt for
New > Tool...
.
- Within the Custom Tools window, opt for
- Tool Configuration:
- In the ensuing Add Local Tool window, provide the necessary details for:
- Name: Assign a name to the tool.
- Application: Specify the path to the tool's executable file (.exe).
- Start In: Designate the path where the tool's configuration file (.ini) resides.
- Ensure the option
Refresh Helix Admin upon completion
is selected.
- In the ensuing Add Local Tool window, provide the necessary details for:
- Finalization:
- Confirm the settings by clicking
OK
, followed by applying the changes across all dialogue windows.
- Confirm the settings by clicking
Preparing the Project Details CSV
The Bulk Add Tool requires a CSV (comma delimited) file for parsing new users, groups, and depots. This file must adhere to a specific format to facilitate the creation of all new project components. An example CSV can be found here: good_example_list.xlsx
-
Components Explained
- Name: The student's full name.
- Drexel ID/Email: The student's Drexel email, typically in the format
abc123@drexel.edu
. - Group Name: A unique identifier for the student group, formatted as
Year_Quarter_ProjectType_GroupName
. Project types are categorized as either Unity (N_
) or Unreal (R_
). - Owner: Indicates the group depot owner. Mark one student (ideally the project lead or lead developer) as the Owner with
TRUE
. This student will have administrative responsibilities for the group's depot.- If a Student is not an owner, leave the cell blank.
- It is a good idea to place the Owner as the first group member.
Name | Group_Name | Owner | |
---|---|---|---|
John Doe | jdoe123@drexel.edu | 2024_FA_N_GroupA | TRUE |
Jane Smith | jsmith456@drexel.edu | 2024_FA_N_GroupA | |
Mike Brown | mbrown789@drexel.edu | 2024_FA_R_GroupB | TRUE |
Alex Johnson | ajohnson012@drexel.edu | 2024_FA_R_GroupB |
Utilizing the Bulk Add Tool in P4 Admin
For Super Users within P4 Admin, the Bulk Add Tool facilitates the mass creation of users, groups, and depots across numerous projects efficiently.
Execution Instructions:
- Initiation:
- Access the tool via
Tools > Bulk Add
from the main menu.
- Access the tool via
- CSV Importation:
- Utilize the
Load CSV file...
option to locate and upload the CSV file containing project details.- Post-upload, the interface displays a list of users including their Name, Email, Group, and Owner Status.
- Utilize the
- Template Selection:
- Choose a template project for depot setup, typically
Template_Unity
orTemplate_Unreal
.- Note: These templates correspond to Streams Depot Templates.
- Choose a template project for depot setup, typically
- Navigation to Creation Page:
- Click on
Go to Creation Page
to proceed.
- Click on
- Project Creation:
- The Creation Page provides details on output paths/locations for commands and log files, along with a count of Users to be created and available server seats. Follow the sequence to execute tasks by clicking the corresponding buttons:
Users
- Initiates user creation.Groups
- Begins group formation.Permissions
- Assigns appropriate permissions.Depots
- Starts depot creation.Populating Depots
- Fills depots with necessary data.
- The Creation Page provides details on output paths/locations for commands and log files, along with a count of Users to be created and available server seats. Follow the sequence to execute tasks by clicking the corresponding buttons:
- Completion:
- Upon successful execution of all tasks, close the tool. Refresh P4 Admin to view the newly added users, groups, and depots.
Passwords
By default, the initial password for all users will be ChangeMe123!
. New users will be required to reset their password on first login.
If a new default password is desired, the config.ini
can be changed to update the default passwords.
[DEFAULT]
EMAIL_DOMAIN = myuniversity.edu
DEFAULT_PASSWORD = myUniversitySecret#45
REQUIRE_PASSWORD_RESET = false
Link to Bulk Add GitHub Repo: https://github.com/vertigojc/p4_bulk_project_creator