Documentation Center

Baseline 2.5 Freeze

Freezes a baseline. Once a baseline is frozen the objects in the baseline cannot be changed anymore.

Only when all objects have a version selected and all objects are released in the working language/resolution, the baseline can be frozen.


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psBaselineIdStringInThe element name of the baseline.
psOutXMLBaselineFreezeReportStringInOutThe Baseline Freeze Report XML indicates why the Baseline freeze could not be executed successfully
pbOutIsFrozenBooleanOutBoolean that indicates whether the baseline freeze action was executed successful or not. When the parameter is false, the reason why the baseline freeze was not executed successful can be found in the psOutXMLBaselineFreezeReport parameter.

Requirements are:
  • The user must have write access to the baseline.
Note that:
  • When no baseline is found with the supplied psBaselineId, an InvalidObjectException is thrown.
The algorithm is:
  • CanBeFrozen is executed to check that the baseline is valid for freeze.
  • If the baseline cannot be frozen, the method returns false and the parameter psOutXMLBaselineFreezeReport contains the Baseline Freeze Report XML with the reason why the baseline could not be frozen.
  • The unused version objects are removed from the baseline
  • All used version objects are labelled with the current baseline.
  • Finally, the baseline is frozen.