Help Center/ CodeArts/ User Guide/ Preparations/ Creating a CodeArts Project
Updated on 2025-08-15 GMT+08:00
View PDF
Share

Creating a CodeArts Project

A project consists of a series of coordinated and controlled activities in a certain process. The objective of a project is to meet specific requirements under specific time and resource restrictions.

In CodeArts, projects are the basis for using various services, allowing you to manage requirements, code, and artifacts, check and build code, and deploy and test applications.

For more information about projects, see Project.

Constraints

  • Each account can create a maximum of 100,000 projects (including programs) in a single region.
  • Each IAM user in an account can create a maximum of 10,000 projects (including programs) in a single region.
  • IPD projects can be created only in the AP-Singapore region.

Procedure

Step

Description

Step 1: Set Project Creators

To create projects, IAM users must be granted the project creator permission by an administrator.

To authorize IAM users, the administrator must have the Tenant Administrator role. For details about how to grant the Tenant Administrator role to a user, see Creating a User Group and Assigning Permissions.

Step 2: Create a Project

Create a project. Ensure that you have the Project Creator permission.

Step 3: Edit a Project

Users modify the project's basic information and menus as needed. To do this, they must have the DevUC > project > edit permission in the CodeArts project. For details, see How Do I Check and Obtain Required Project Permissions?

Step 1: Set Project Creators

  1. Go to the CodeArts homepage.

    1. Log in to the CodeArts console, click , and select a region where you have enabled CodeArts.
    2. Click Go to Workspace.

      If your account uses the old billing mode (see Old Billing Modes), click Access Service.

  2. Click the username on the top navigation bar and choose All Account Settings.
  3. Choose General > Project Creators.

    Two options are available:

    • All members can create projects: All IAM users in your account can create projects.
    • Set some members to be able to create projects: Toggle on or off the Status switch for each IAM user. IAM users with the switch in the state cannot create projects.

  4. Configure permissions for each user as required. When a success message shows up, the setting is complete.

Step 2: Create a Project

  1. Go to the CodeArts homepage.

    1. Log in to the CodeArts console, click , and select a region where you have enabled CodeArts.
    2. Click Go to Workspace.

      If your account uses the old billing mode (see Old Billing Modes), click Access Service.

  2. On the CodeArts homepage, click Create > Create Project and select a template.

    If you have not joined any project yet, the message "Start by creating a project or program." is displayed. Select a template on the Project tab.

  3. Set the project information and click OK.

    Table 1 Creating a project

    Parameter

    Description

    Work Item Template

    Available when you select the Scrum template. Select a Scrum project work item template.

    For details about work item templates, see Configuring Common Settings for a Scrum Project.

    Name

    The name of the CodeArts project. Enter 1–128 characters. Letters, digits, and special characters are supported. The name must be unique.

    Work Configuration Data

    Available when the IPD-System Device, IPD-Self-Operated Software/Cloud Service, or IPD-Standalone Software template is selected. Determine whether to reuse the work configuration data of another project of the same type. The data includes all settings except Import/Export and Basic Configuration > Work Configuration Data.

    This parameter is optional. Configure it as needed.

    For details about work configuration data, see:

    Code

    The code of the CodeArts project. Enter a maximum of 200 characters. Digits, letters, hyphens (-), and underscores (_) are supported.

    This parameter is optional. Configure it as needed.

    Description

    Describe the CodeArts project. Enter a maximum of 1,024 characters.

    This parameter is optional. Configure it as needed.

    After the project is created, the Req service page is automatically displayed.

Step 3: Edit a Project

Table 2 Editing a project

Operation

Procedure

Modifying basic project information
  1. Go to the target project, and choose Settings > General > Basic Information from the navigation pane.
  2. Modify the project name, code, and description as needed, and click Save.

    The modified information is displayed.

Transferring the project creator
  1. Go to the target project, and choose Settings > General > Basic Information from the navigation pane.
  2. Select the member to transfer the project to from the Creator drop-down list, and click Save.

    The new creator is displayed.

Archiving a project
WARNING:

Archived projects are read-only to all members. Members cannot add, delete, or modify work items in these projects. If they need to do so, unarchive the projects first.

Scrum and Kanban projects can be archived.

  1. Go to the target project, and choose Settings > General > Basic Information from the navigation pane.
  2. Click Archive.

    Then the button changes to Unarchive.

Deleting a project
WARNING:
  • Deleting a project will also delete its code repositories, check tasks, build tasks, and test cases.
  • The deletion cannot be undone. Exercise caution when performing this operation.
  1. Go to the target project, and choose Settings > General > Basic Information from the navigation pane.
  2. Click Delete Project, enter the project name, and click Delete.

    The deleted project is no longer displayed on the homepage.

Managing service menus
  1. Go to the target project, and choose Settings > General > Services from the navigation pane.
  2. Select the menus to display.

    Refresh the page. The updated menus are displayed in the navigation pane.

Helpful Links

Parent Topic: Preparations