The following topics define the settings, describe how to change
them, and explain any interaction between the settings.
add_object_task_assoc
When set to TRUE, the add_object_task_assoc option
ensures that an existing object being added to a project is associated
with the specified or current task. This option is used with the Add
Object procedure (from the GUI) or the ccm use command
(from the CLI).
add_used_subcomponents_to_task
When the add_used_subcomponents_to_task setting
is set to TRUE on a manual use operation,
the following occurs. If the object being used is a subproject or
a product, and the component part of the release of the object being
used is different from the parent project where it is used, the new
version is associated with the current task. If another version of
the subproject or product was previously associated with the current
task, the other version is disassociated from the current task. When
this setting is FALSE, a manual use of
a subproject or a product does not change the objects associated with
the current task.
admin_user
The admin_user setting has a
value that is the name of the Rational Synergy
administrator user (for example, ccm_root).
allow_delimiter_in_name
The allow_delimiter_in_name option
controls whether the version delimiter is a restricted character in
the names of non-project objects. When set to TRUE,
the current version delimiter is no longer a restricted character
for non-project object names. The version delimiter is still restricted
for versions, types, instances, and projects.
allow_prep
When the allow_prep setting is TRUE,
prep subprojects are considered valid candidates in an update members
operation on a working project. When this setting is FALSE,
prep subprojects are not valid candidates in an update members operation
on a working project.
auto_create_component_tasks
When the auto_create_component_tasks option
is set to TRUE, component tasks are automatically
created when a baseline is created. This setting is overridden by
a corresponding property defined on the release definition associated
with the release of the baseline.
baseline_template
The baseline_template setting
specifies the version template to be used for project and products
in a baseline when none is explicitly specified in the create baseline
or modify baseline operation. The baseline template syntax is defined
in the help for the ccm baseline -create command.
baseline_template_date_format
The baseline_template_date_format setting
specifies the date format to be used when creating a baseline when
expanding the date keyword in the baseline_template.
baseline_template_repl_char
The baseline_template_repl_char option
specifies the default version string replacement character that is
used if the instantiated baseline template for any project or product
in the baseline contains characters that are not allowed in a version string.
check_release
When the check_release setting is TRUE,
the release of an object is compared with the release of its associated
task. If the releases do not match, a message is reported.
ccm.cli.format.date
When the ccm.cli.format.date setting is
defined, it is used as the default output format for dates. Also,
on data input, the setting is used as the first attempt to convert
a date string to a date value. By default, a client locale-dependent
setting is used.
ccm.cli.start.defaultrole
The ccm.cli.start.defaultrole setting
defines the default role when a Rational Synergy
CLI session is started and no role is explicitly specified with the -r
role option.
ccm.cli.tools.compare.*
The ccm.cli.tools.compare.* setting defines
the compare tool command that is used.
ccm.cli.tools.compare.*.checkstatus
The ccm.cli.tools.compare.*.checkstatus setting
specifies whether the exit status of the compare tool msut be checked.
If set to true and the tool exits with a non-zero
exit status value, the Rational Synergy
CLI reports an error message.
ccm.cli.tools.merge.*
The ccm.cli.tools.merge.* setting defines
the merge tool command that is used.
ccm.cli.tools.merge.*.checkstatus
The ccm.cli.tools.merge.*.checkstatus setting
defines whether the exit status of the merge tool must be checked.
If set to true and the tool exits with a non-zero
exit status value, the Rational Synergy
CLI reports an error message.
ccm.cli.tools.merge.conflict.content
The ccm.cli.tools.merge.conflict.content setting
specifies a regular expression that, when matched in the output merge
result file, indicates that merge conflicts were detected.
ccm.cli.tools.merge.unix.conflict.status / ccm.cli.tools.merge.windows.conflict.status
This setting specifies the exit status value of the merge
tool that indicates that the merge was successful but one or more
merge conflicts were detected. If not set, the Rational Synergy CLI does not check the
exit status of the merge tool to determine whether merge conflicts
were found.
ccm.cli.tool.shell.unix / ccm.cli.tool.shell.windows
This setting specifies whether tool commands executed by
the Rational Synergy CLI
are wrapped and executed within an operating system shell. The default
is to wrap commands on UNIX clients
with sh -c and on Windows clients
with cmd /c. This setting allows commands to use
shell features such as stream redirection and pipes. On Windows, if a shell is specified, the Rational Synergy CLI creates
a temporary batch file for the command to be executed and the Windows shell is executed on
that temporary batch file.
ccm.migrate.default.type
The ccm.migrate.default.type setting specifies
the default Rational Synergy
type that is used when mapping rules are evaluated but no mapping
rule explicitly sets a type. This setting is used when migrating,
when detecting work area conflicts, or when creating an object without
a specified Rational Synergy
type.
ccm.migrate.new_project.purpose
The ccm.migrate.new_project.purpose setting
specifies the project purpose that is used for projects when migrate
generates an import package.
ccm.migrate.replacement.character
The ccm.migrate.replacement.character setting
specifies the replacement character that is used when an object to
be migrated contains a Rational Synergy
restricted character.
ccm.migrate.source.export
The ccm.migrate.source.export setting
specifies the temporary client location where the import package generated
by migrate is constructed. The %temp keyword expands
to a client platform-dependent location.
cli_compare_cmd
The cli_compare_cmd setting specifies
the command to be used when comparing files. If not set, the Rational Synergy CLI uses the
preference value of ccm.cli.tools.compare.ascii.unix on UNIX clients, and ccm.cli.tools.compare.ascii.windows on Windows clients.
cli_dir_compare_cmd
The cli_dir_compare_cmd setting specifies
the command to be used when comparing directories. If not set, the Rational Synergy CLI uses the
preference value of ccm.cli.tools.compare.dir.unix on UNIX clients, and ccm.cli.tools.compare.dir.windows on Windows clients.
cli_proj_compare_cmd
The cli_proj_compare_cmd setting specifies
the command to be used when comparing projects. If not set, the Rational Synergy CLI uses the
preference value of ccm.cli.tools.compare.project.unix on UNIX clients, and ccm.cli.tools.compare.project.windows on Windows clients.
cli_symlink_compare_cmd
The cli_symlink_compare_cmd setting specifies
the command to be used when comparing symlink objects. If not set,
the Rational Synergy CLI
uses the preference value of ccm.cli.tools.compare.symlink.unix on UNIX clients, and ccm.cli.tools.compare.symlink.windows on Windows clients.
conflict_exclude_rules
The conflict_exclude_rules attribute
controls the conditions under which membership conflicts are excluded
from membership conflict reports
conflict_parameters
The conflict_parameters setting
specifies which types of membership conflicts are reported. The attribute
value consists of lines in the format: conflict_number:
TRUE|FALSE. Lines that begin with the pound character (#)
are treated as comments.
database
This read-only setting has a value that is the Rational Synergy database path
associated with the current CLI session.
dcm_broadcast_dbid
The dcm_broadcast_dbid setting specifies
the database identifier used to signify broadcast transfer packages.
A setting of a blank string disables receive of broadcast packages.
If you use a non-default value, you must also create a corresponding
DCM database definition using that database identifier. Additionally,
apply the same changes to other databases in the DCM cluster so that
all databases use the same setting.
dcm_log_enabled
When set to TRUE, the dcm_log_enabled option
specifies to create and update a dcm_log attribute
as part of a DCM receive operation. The dcm_log attribute
is used to record details relating to when the object was updated
by a DCM receive, or when handover of control was performed. This
setting is a diagnostic aid for Rational Technical
Support to understand why, how, and when an object was updated by
DCM.
dcm_time_sync_tolerance
The dcm_time_sync_tolerance setting specifies
the time tolerance in seconds that DCM allows when determining the
delta to be included for a transfer set and package during DCM generate.
If machines running the Rational Synergy
server and engine processes have a system time that is synchronized
within the specified tolerance time, then DCM replicates updates.
However, if the system time across machines exceeds this time, modified
objects might not be included in a transfer package.
dcm_update_recon_temp
The dcm_update_recon_temp setting controls
whether the DCM receive operation processes process rules and folder
templates. If you do not want local reconfigure templates and folder
templates of a database to be updated from another database, set the
model attribute to the value FALSE.
deep_conflict_detection
The deep_conflict_detection setting specifies
whether membership conflict detection must be deep or shallow. Shallow
detection stops at the versions in the baseline use in the project.
Deep detection considers versions before the baseline used in the
project.
default_version
The default_version setting specifies
the default version to use when creating an instance of a file or
directory.
error
The error setting has a value that is
the error status value of the last CLI command that was executed.
expand_on_checkin
When set to TRUE on a type definition,
the expand_on_checkin setting specifies that files
of that type, or a type that is a sub-type, without binary contents
have keyword expansion performed when the file is checked in. By default,
base model type definitions do not define this setting, and the overall
model default specifies not to perform keyword expansion on check
in.
include_required_tasks
When set to TRUE, the include_required_tasks setting
specifies that when a task is added to a project grouping, the required
tasks on which that task depends are computed and added as well.
mail_cmd
Rational Synergy
uses a default mail tool for DCM email notification. To use your own
mailer instead of the default tool, enter the following line in the [Options] section
of the server installation ccm.ini file.
mapping_rules
Rational Synergy
uses mapping rules to determine whether files and directories must
be ignored during a migrate, or when detecting work area conflicts.
The system also uses mapping rules to determine the type of
an object during migrate, when an object is created without explicitly
specifying a type, or when an object is created by resolving a work
area conflict.
max_object_name_length
The max_object_name_length option
limits the length of object names.
max_object_version_length
The max_object_version_length option
limits the length of object versions.
multiple_local_proj_instances
When set to TRUE, the multiple_local_proj_instances setting
specifies that users can create projects even if another instance
of a project that was created locally has the same name. The new projects
use different instance values.
objreg_address
The objreg_address setting has a value
that is the address of the Rational Synergy
object registrar associated with the database used for the current
CLI session.
parallel_exclude_rules
The parallel_exclude_rules option
contains a set of rules that define which version is excluded from
parallel notification.
platforms
The platforms setting has a value that
is a list of the valid platform names for an object.
project_purpose_mgr
The project_purpose_mgr setting contains
a list of roles that can create or delete a project purpose defined
in a database. Roles must be separated by at least one space character.
project_subdir_template
The project_subdir_template setting
specifies the template for the part of the work area path that represents
the project-specific part of the path. This template is used when
creating or copying a project. You can also change the template for
specified projects using the ccm wa -pst|-project_subdir_template command.
range_for_keyword_expand
The range_for_keyword_expand option establishes
how many characters in a file are scanned for keywords when an object
is created or derived, starting from the beginning of the file.
reconcile.control_files_below_new_project
The reconcile.control_files_below_new_project setting
specifies whether uncontrolled files are added to new projects derived
from directories during the sync/reconcile operation.
reconcile.save_uncontrolled
The reconcile.save_uncontrolled setting
specifies whether uncontrolled files removed from the work area due
to conflict resolution must be saved in the work area wastebasket.
Setting the option to TRUE stores an uncontrolled
file in the work area wastebasket if the file is removed from the
work area by an Update Work Area from Database resolution.
reconf_consider_all_cands
The reconf_consider_all_cands setting
specifies to populate a directory with the best match when no candidates
in the update properties of the project are found. If this attribute
does not exist or if the value is FALSE, the directory
entries are left empty when there are no candidates in the update properties
of the project.
reconf_prop_mgr
The reconf_prop_mgr setting defines the
roles that can create or edit an update template.
reconf_stop_on_fail
The reconf_stop_on_fail setting
specifies whether update members must stop and abandon further processing
when an error is encountered. By default, on encountering an error,
update members report the error and stop.
release_phase_list
The release_phase_list feature defines
the phases of development or deployment of a release. Use this feature
to track the status of a release during the development process. You
can customize the list to match the development phases of your products,
or use the default list.
require_actual_time
The require_actual_time setting specifies
whether users are required to complete the actual time it took to
complete a task before designating a task as complete.
required_attributes
The required_attributes setting
specifies whether users are required to complete certain fields before
designating a task as complete. If one of the required task fields
is missing or contains an invalid value, the task does not transition
to the completed state and an error message is reported.
restricted_chars
The restricted_chars setting has a value
that is a list of restricted characters that cannot be used in the
names or versions of objects.
restricted_task_admin_roles
The restricted_task_admin_roles setting
specifies which roles are restricted from administering tasks. Its
value is a space-separated list of the roles that are not allowed
to create, register, and assign tasks. By default, all roles are allowed
to administer tasks.
role
The role setting specifies the
current role for the current Rational Synergy
CLI session.
role_definitions
The role_definitions setting specifies
what privileges are available to users in the various roles.
router_address
The router_address setting shows the address
of the Rational Synergy
router associated with the database used for the current CLI session.
save_to_wastebasket
The save_to_wastebasket setting
specifies to move all files in your work area to a wastebasket directory.
shared_project_directory_checkin
The shared_project_directory_checkin setting
controls whether non-writable directories in shared projects are checked
in to the integrate state automatically when objects
are added to or deleted from such directories.
start_day_of_week
The start_day_of_week setting specifies
the start day of the week to be used when calculating queries that
use relative time keywords: %this_week_begin, %this_week_end, %last_week_begin,
and %last_week_end. Valid entries are integers 0
- 6, with 0 being Sunday, 1 being Monday, and so on.
task_platforms
The task_platforms setting lists the valid
platform values for tasks. This information is defined by the configuration
file databasePath/pt/attrange.dft.
task_priorities
The task_priorities setting lists the
valid task priority values. This information is defined by the configuration
file databasePath/pt/attrange.dft.
task_release_propagate
When this feature is turned on and you modify the release
on a task using the ccm task -modify -release command
or the Properties dialog in the GUI, then the change in the release
propagates to the associated objects of the task, according to the
following rules.
task_resolvers
The task_resolvers setting lists the valid
resolver values for tasks. This information is defined by the configuration
files databasePath/pt/attrange.dft and databasePath/pt/extusers.dft.
task_subsystems
The task_subsystems setting lists the
valid task subsystem values. This information is defined by the configuration
file databasePath/pt/attrange.dft.
text_editor
The text_editor setting specifies the
command to be used when comparing files. If not set, the Rational Synergy CLI uses the preference
value of ccm.cli.tools.edit.unix on UNIX clients and ccm.cli.tools.edit.windows on Windows clients.
update_baseline_on_update
The update_baseline_on_update setting
specifies whether an update member uses the baseline of the new project,
or the previously defined baseline, upon check in.
update_on_checkin_if_equal
The update_on_checkin_if_equal setting
specifies the timestamp that takes precedence. When you use some editors
or you perform scripted check-outs and check-ins, the timestamps on
the database and work area versions of a file can show as identical.
When set to TRUE, the update_on_checkin_if_equal option
forces Rational Synergy
to copy such files from the work area to the database, even though
their timestamps indicate that they are not newer than their database
versions.
update_parallel_check
The update_parallel_check setting
specifies whether parallel version notification is given on update
members. This option can have the value TRUE, FALSE,
or FULL to obtain a more verbose notification.
update_replace_subprojects
The update_replace_subprojects setting
defines the default behavior when the update members action is performed
on a project. When enabled, update evaluates the best candidate subproject
and can replace the current version of a subproject with a better
candidate. When disabled, the current version of subproject is unchanged.
user
The user setting shows the Rational Synergy user name associated with
the current CLI session.
valid_create_roles
The valid_create_roles setting specifies
which roles are allowed to check out projects. The value is a list
of the roles that are allowed to check out projects, separated by
spaces.
wa_template
The wa_template setting specifies the
template for the part of the work area path that represents the non-project-specific
part of the path. This template is used when creating or copying a
project. You can also change the work area path for specified projects
using the ccm wa -set|-path|-setpath command.
wastebasket
The wastebasket setting specifies
the location of your wastebasket directory.
work_area_products_writable
The work_area_products_writable setting
specifies the writability of copy-based work areas. When this setting
is set to TRUE, products are always modifiable in
copy-based work areas even if the modifiable copies work area property
is turned off. The default of FALSE means that the writability
of products in copy-based work areas is determined by the modifiable
copies work area property and the status, or both, of the object.