Modifying a folder

About this task

This subcommand modifies the specified folders. The folders must be modifiable by you.

When you define a folder query, the -custom, -platform, -release, -subsystem, and
-task_scope options contribute to the final generated task query. You can use the
-platform, -release and -subsystem options multiple times. When you use an option more than once, the query expression relating to each usage is combined with an "or". For example, if you specify -release 1.0 -release 2.0, this contributes a query expression of (release='1.0' or release='2.0). Contributions from different options are combined with "and". For example, if you specify -release 1.0 -platform windows, this contributes a query expression of (release='1.0') and (platform='windows'). The -task_scope option also results in a contribution to the task query based on the specified scope, and this is modified by any -database_id options specified. The final task query used combines all of these elements in a single query expression.

ccm folder -m|-modify [-n|-name folder_name]
          [-mode ((man|manual) | (uq|use_query))]
          [-w|-writable (owner | (build_mgr|build_manager|buildmanager) | 
          all | none)] [-cus|-custom custom_query]
          [(-db|-dbid|-database_id database_spec)...]
          [(-plat|-platform platform)...] [(-purpose purpose)...] 
          [(-rel|-release release_spec)...]
          [(-sub|-subsystem subsystem)...] [-ts|-scope|-task_scope
          (user_defined | (all_my_assigned|all_owners_assigned) |
          (all_my_assigned_or_completed|all_owners_assigned_or_completed) |
          (all_my_completed|all_owners_completed) |
          (all_my_tasks|all_owners_tasks) | all_completed | all_tasks)]
          (ct_projs|ct_projects|component_task_projects) | 
          (ct_prods|ct_products|component_task_products) | 
          (ct_projs_prods|ct_projects_products|
          component_task_projects_products))]
          [(-at|-add_task|-add_tasks task_spec)...]
          [(-rt|-remove_task|-remove_tasks task_spec)...]
          [-up|-update] folder_spec...
-at|-add_task|-add_tasks task_spec
Adds the specified tasks to the specified folders. See Task specification for details.
-cus|-custom custom_query
Specifies to update the folder query to include the specified custom query expression.
-db|-dbid|-database_id database_spec
When used with the -task_scope option, specifies a database identifier that modifies the query generated from the task scope. See -ts|-scope|-task_scope and Database specification for further details.
folder_spec
Specifies the folder to modify. See Folder specification for details.
-mode ((man|manual) | (uq|use_query))
Specifies whether to modify folders to add tasks manually or by using a query.

If you modify a folder from manual to query-based, never defined a task query, and didn’t specify any available options, then the folder is created as query-based with a default_task_query defined as follows:

  • If you have defined a default task query, it is used.
  • If you haven’t defined a default query, the task scope All my assigned and completed tasks is used.
-n|-name folder_name
Specifies to rename the specified folders to the specified folder name. The folder_name cannot contain newline characters.
-plat|-platform platform
Specifies to update the folder query to use a query expression for the specified platform.
-purpose purpose
Specifies to create the folder with a task query that includes a query for the specified purpose. See the project_purpose command Description and uses for a detailed description of purposes.

This option typically applies to queries for component tasks that are specified with one of these scopes: component_task_projects, component_task_products, or component_task_projects_products.

-rel|-release release_spec
Specifies to update the folder query to use a query expression for the specified release. You can set the release_spec to multiple releases. See Release specification for details.
-rt|-remove_task|-remove_tasks task_spec
Removes the specified tasks from the specified folders.See Task specification for details.
-sub|-subsystem subsystem
Specifies to update the folder query to use a query expression for task subsystem.
-ts|-scope|-task_scope
Specifies to use a task query. The task query will include a query expression that depends on the specified scope. The query expression associated with the specified scope also depends on the -database_id option. You can use the following scopes:
  • user_defined

    This scope is defined by the default_task_query option. If you specify
    -database_id, the query also includes a query expression for tasks modifiable in or completed in the specified database.

  • all_my_assigned|all_owners_assigned

    This scope queries for all tasks assigned to you. If you specify -database_id, the query is for all tasks assigned to you that are modifiable in the specified database.

  • all_my_assigned_or_completed|all_owners_assigned_or_completed

    This scope queries for all tasks assigned to you or completed by you. If you specify -database_id, the query is for all tasks assigned to you and modifiable in the specified database, or completed by you in the specified database.

  • all_my_completed|all_owners_completed

    This scope queries for all tasks completed by you. If you specify -database_id, the query is for all tasks completed by you in the specified database.

  • all_my_tasks|all_owners_tasks

    This scope queries for all tasks for which you are the task resolver. If you specify -database_id, the query is for all tasks for which you are the task resolver and that are modifiable in the specified database or were completed in the specified database.

  • all_completed

    This scope queries for all completed tasks. If you specify -database_id, the query is for all tasks completed in the specified database.

  • all_tasks

    This scope queries for all tasks. If you specify -database_id, the query is for all tasks that are modifiable in the specified database or that were completed in the specified database.

  • component_task_projects|component_task_products| component_task_projects_products

    This scope queries for component tasks for projects, products, or projects and products. If you specify -database_id, the query is for all component tasks that were created in the specified database. If you specify -purpose, the query is for component tasks with the specified purpose.

-up|-update
Specifies to update a query-based folder by running the folder's query. If a specified folder is not query-based, an error is reported.
-w|-writable (owner | (build_mgr|build_manager|buildmanager) | all | none)
Specifies who can modify the specified folder.

Examples

About this task

  • Add tasks 5-9 to folder 95.

    ccm folder -modify -at 5-9 95

    Updating folder 95: Tested Tasks for Release 3.2 ...

    Added task 5
    Added task 6
    Added task 7
    Added task 8
    Task 9 is already in the folder
    Added 4 tasks.

  • Remove tasks 5-9 from folder 95.

    ccm folder -modify -rt 5-9 95

    Updating folder 95: Tested Tasks for Release 3.2 ...

    Removed task 5
    Removed task 6
    Removed task 7
    Removed task 8
    Removed task 9
    Removed 5 tasks.

  • Add multiple tasks (5, 12, 14) to folder 51.

    ccm folder -modify -add_task 5,12,14 51

  • Update the contents of folder 160.

    ccm folder -m -up 160

    Updated folder '160: My Tasks for Release 3.5'.

  • Change the mode of folder 111 so that it uses a query to add tasks.

    ccm folder -modify -mode use_query 111

  • Change folder 111 so that it uses the all_my_tasks scope and release 3.5 to add tasks.

    ccm folder -modify -ts all_my_tasks -rel 3.5 111

    The query for folder '111: bob's Insulated Development Folder' has been changed to: owner='bob' and release='3.5'

  • Change the name of folder 85 to Completed tasks for release 3.5.

    ccm folder -modify -name "Completed tasks for release 3.5" 85


Feedback