Creating folder templates

About this task

This subcommand creates a folder template. You must be in the build_mgr or ccm_admin role to use this subcommand.

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').

ccm ft|folder_temp|folder_template -c|-create
       [-w|-writable (owner | (build_mgr|build_manager|buildmanager) |
       all | none)] [-mode ((man|manual) | (uq|use_query))]
       ([-must_be_local] | [-nomust_be_local])
       [-desc|-description description] [-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)] name
       (ct_projs|ct_projects|component_task_projects) | 
       (ct_prods|ct_products|component_task_products) | 
       (ct_projs_prods|ct_projects_products | 
       component_task_projects_products))] name
-cus|-custom custom_query
Includes the specified custom query expression in the new folder template query.
-desc|-description description
When creating folders from the folder template, specifies a string used after keyword expansion. The description cannot contain newline characters. If you do not specify description, the folder template name is the default value. For details about keyword expansion, see sc_t_h_show_folder_template_info.html#wp972159__wp972532.
-db|-dbid|-database_id database_spec
Specifies the database ID that is associated with the folder template you are creating. See Database specification for further details.
-mode ((man|manual) | (uq|use_query))
Defines the folder template contents to be either manual or query-based.

If you have not defined a query, default_task_query is used.

-must_be_local
Specifies that the folder template must use a local folder for update properties of locally created projects. The default is -nomust_be_local.
name
Specifies the name of the new folder template to be created. The name cannot contain newline characters.
-nomust_be_local
Specifies that the folder template can use a non-local folder for update properties of locally created projects. This is the default.
-plat|-platform platform
Specifies a query for folders created from the folder template that includes platform='platform'. The platform choices are defined in the CCM_HOME\etc\om_hosts.cfg file (Windows), or $CCM_HOME/etc/om_hosts.cfg file (UNIX). If a folder template applies to multiple platforms, you do not set a platform value.
-purpose purpose
Specifies to create the folder with a task query that includes a query for the specified purpose. See the project_purpose command sc_t_h_show_project_purpose.html#wp922354__wp900914 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 a query for folders created from the folder template that includes release='releasename'. You can set release_spec to multiple releases. See Release specification for further details.
-sub|-subsystem subsystem
Specifies a query for folders created from the folder template that includes task_subsys='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.

-w|-writable (owner | (build_mgr|build_manager|buildmanager) | all | none)
Specifies who can modify folders created using the folder template. If not specified, the default is owner, and only the owner of the folder can modify it.

Examples

About this task

  • Create a folder template whose description is "%owner’s Completed Tasks for Release %release from Database X", set the folder template to use a query, and enter a folder query. You do not need to set who can write and use the folder template because the default setting is owner.

    ccm folder_template -create -description "%owner’s Completed Tasks for Release %release from Database X" -task_scope all_owners_completed
    -release "%release" -database_id X "Tasks completed by %owner for Release %release from Database X"

  • To define a default query that a folder template will use to populate its folders with tasks:
    • Set the scope.
    • Set the release.

    For parallel development and folder template management reasons, be sure to set this attribute.

  • Set the subsystem, if necessary.
  • Set the platform, if necessary.

    If a folder applies to multiple platforms, you do not need to set the platform value.

  • Set the database, if it is initialized to use DCM. For example, create a new folder template. Folders created from this template will collect all completed tasks for the current release, and will be writable by build managers.

    ccm folder_template -create -desc "All Completed Tasks for Release %release" -task_scope all_completed -release "%" -writable build_manager


Feedback