Creating a folder template#

About this task

Folder templates provide a pattern used to create folders.

The following steps show you how to create a folder template.

Procedure

  1. In the Task menu, point to New and choose Folder Template.

    The Create Folder Template dialog box appears.

  2. In the Name field, type the name of the folder template.
  3. This field is required and must be unique. Quotation marks are not allowed.
  4. Type a description of the folder.

    The description specifies a string that is used after keyword expansion when creating folders from the folder template. If you do not specify a description, the folder template name is used as a default value.

    You can give a folder template any description, using any character, except the pipe (|) character. The folder template description can include the following three keywords in any combination: %owner, %release, %database. A folder template's description does not have to include keywords. When the description of a folder template does not contain a keyword, all folders created from this folder template will have the same description.

    For example, if you create a folder template whose description is Completed Tasks for Release %release, the keyword %release is expanded to the release value of the projects that are using a process rule containing this folder template. The keyword %release is expanded when this folder template creates a folder. For instance, when a project with release 2.0 uses a process rule that contains a folder template whose description is Completed Tasks for Release %release, the folder created from this template and added to the project's update properties will have a description of Completed Tasks for Release 2.0.

    The %owner keyword expands to the owner of the project whose update properties contain folders created from a folder template. For example, if a project owned by ann with a release of 3.1 uses a process rule that contains a folder template whose description is %owner's Completed Tasks for Release %release, a folder whose description is ann's Completed Tasks for Release 3.1 will be created from this folder template and added to the project's update properties.

    The %database keyword expands to the DCM database identifier of the database in which the project that is using the folder that is being created was created. For example, if a project owned by ann with a release of 3.1 is in a DCM database called Bristol, and is using a process rule that contains a folder template whose description is %owner's Completed Tasks for Release %release from Database %database, a folder whose description is ann's Completed Tasks for Release 3.1 from Database Bristol will be created from this folder template and added to the project's update properties.

  5. Specify which users will be able to modify the folder(s) created from this folder template. Your choices include Build Managers, Everyone, or Owner. The default is Build Managers.
  6. Specify whether the folders created from this folder template should use a query or if tasks should be added manually by clicking the appropriate button.
  7. If the folder template will use a query, enter the folder template query.

    If you want to use an existing query, click Copy Query and select an existing query to use.

    Alternatively, you can set up a query by using the query builder. Note that if your query contains keywords (without values) and you click the Query icon, the Choose Test Values dialog box will appear.

    Use this dialog box to enter values for the keywords, then click OK to run a test query to see if the keywords you entered are appropriate.

    For detailed information on building a custom query, see Customizing a query.

  8. Create the folder template by clicking OK.

Feedback