[FAQ] What is the cfcUtility and where can I get it?

[SteffenBaierUK]

With the introduction of UCS 3.3.0 Polycom Phones no longer depended on the matching sip.cfg / phone1.cfg files.

When running a UCS release the Phone's software would always contain it’s standard values and would only need to be provisioned with additional files containing a customer configuration.

Customers who had been using their own specific sip/phone1 files in the past are recommended to utilize the Polycom cfcUtility from => here <=

Above DOS command line based tool enables the conversion of individual customer configuration files to strip / change standard values or changed parameters.

Usage:
%>  cfcUtility --target <path> [--extensions ext1[,ext2,ext3]
                     --changed <path> --nondefault <path> --removed <path>
                     --warning <path> --reportonly --force --append ]

Options:
    -t, --target     Required. Path to a file or directory to convert. When
                     pointing to a directory, all files in that directory
                     matching requirements will be converted.
                     Candidate files are xml (not encrypted or binary) files
                     with file extension .cfg.
                     (unless changed via the --extensions parameter.)
                     This utility will ignore MAC.cfg files and files that
                     have been previously converted.

    -r, --reportonly Optional. Setting this option will generate only reports
                     to files as configured (see below options). No files will
                     be modified. It is recommended you run this and assess the
                     reports before finalizing your changes.

    -w, --warning    Recommended. Filename where a report on specific warnings
                     about your configuration can be recorded. If this option
                     is not specified the default filename
                     IMPORTANT_UC330_WARNINGS.txt will be used.

    -c, --changed    Recommended. Filename where a report on all parameters
                     being removed or changed due to deprecation can be
                     written. If not set a default filename of
                     ChangedParameters.txt will be used.

    -n, --nondefault Recommended. Filename where a report on all parameters
                     found in your configurations that have non default values
                     when compared against the UC Software 3.3.0 values.
                     If not set a default filename of NonDefaultValues.txt
                     will be used.

    -x, --removed    Optional. Filename where a report on all parameters in
                     your configuration files whose values are obsolete,
                     unrecognized, or default as compared to UC Software
                     3.3.0 values. These parameters will be removed from your
                     files.
                     If not set a default filename of RemovedParameters.txt
                     will be used.


    -e, --extensions Recommended. When the target is a directory containing
                     more files than just configuration files, set this option
                     to specify the file extensions of your config files. If
                     unset, 'cfg' files will be assumed.
                     Format for this parameter is a comma separated list.
                     example: --extensions cfg,conf,xml

    -a, --append     Optional. By default, all the above reports will be
                     overwritten on subsequent executions of this utility.
                     Specify this option to append to the files rather than
                     overwrite them.

    -f, --force      Optional. On execution, a marker is placed in all
                     converted files. On subsequent executions, this utility
                     will ignore those files. Set this option to disregard
                     that marker and force a translation a second time.
                     This is not recommended and depending on your
                     configuration can create invalid unrecognized parameters.

    -h, --help       Show this text.

A typical command would look like this:

cfcUtility.exe –t sip.cfg -f

Above would convert a sip.cfg within the directory and remove all standard parameters and change any parameter that has a new syntax since UCS 3.3.0.

It will overwrite the exisiting sip.cfg and create additional files highlighting the removed files, any warnings that appear and keep a record of the changed values.

Note: Windows 7 enables to open a Command Window in the currently highlighted Directory within Explorer via pressing shift and right clicking on the name as shown below