Documentation Center

Baseline 2.5 CompleteReportByCandidateAndMode

This method will generate a baseline report for the starting points selecting the versions in the following order:
  1. The highest version with a Candidate for baseline specified
  2. The version specified in the provided baseline report
  3. The version matching the auto complete mode

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.
psXMLBaselineReportStringInA Baseline Report XML structure.
psExtendBaselineIdStringInThe element name of the baseline which will be used to complete the Baseline (Report) XML.
peAutoCompleteModeeBaselineAutoCompleteModeInIndicates which auto complete mode must be used to select the version in the baseline report.
pasStartLogicalIdsStringArrayInString list with the logical identifiers that are used as starting points in the baseline reporting methods.
pasStartResourceLogicalIdsStringArrayInString list with the logical identifiers of the resources that are used as (extra) starting points in the baseline reporting methods.
pasLanguagesStringArrayInString list with the languages.
pasIllustrationLanguagesStringArrayInString list with the languages used for illustrations.
pasResourceLanguagesStringArrayInString list with the languages used for resources.
pasResolutionsStringArrayInString list with the resolutions.
psOutXMLBaselineReportStringOutA Baseline Report XML structure.

Requirements are:
  • The user must have read access for the baseline.
Note that:
  • When no extend baseline is provided, the incoming baseline report is auto completed using the auto complete mode.
  • The parameters pasIllustrationLanguages and pasResourceLanguages contain extra (fallback) languages for the illustrations and the resources.
  • The pasResourceLanguages is not only used for the objects which are specified in the pasStartResourceLogicalIds parameter but also for all objects which are referenced by those objects.
  • When a library is referenced by a resource, the language information is retrieved in all languages which are specified in the parameters pasLanguages and pasResourceLanguages.
  • When an illustration is referenced by a resource, the language information is retrieved in all languages which are specified in the parameters pasLanguages, pasResourceLanguages AND pasIllustrationLanguages.
  • Objects which are present in the baseline but not referenced by one of the starting objects, are not returned in the Baseline Report XML.

Example

Start situation
ISHTypeNameReferencesVersionRemarks
ISHIllustrationI1 1 Candidate for baseline not set
ISHIllustrationI2 1 Candidate for baseline not set
ISHModuleT1I11 Candidate for baseline equal to baseline B1
ISHModuleT1I12 Candidate for baseline equal to baseline B1
ISHModuleT1I23 Candidate for baseline not set
ISHModuleT2 1 Candidate for baseline not set
ISHModuleT2 2 Candidate for baseline not set
ISHMasterDocM1T1, T21 Candidate for baseline equal to baseline B1
ISHMasterDocM1T1, T22 Candidate for baseline not set
ISHBaselineB1M1  
Results for an incoming baseline report with version 2 of map M1 and version 1 of topic T2:
ExtendBaselineIdAutoCompleteModeStartLogicalIdsResultHow are the versions selected?
B1ISHLatestAvailableM1Baseline report with:
  • Version 1 of map M1
  • Version 2 of topic T1
  • Version 1 of topic T2
  • Version 1 of illustration I1
  • For the starting point M1, we use version 1 which has candidate for baseline B1 specified.
  • For topic T1 referenced by version 1 of map M1, we use version 2 which is the highest version with candidate for baseline B1 specified
  • For topic T2 referenced by version 1 of map M1, there is no version with candidate for baseline B1 specified but version 1 is used since it was specified in the incoming baseline report.
  • For illustration I1 referenced by version 2 of topic T1, there is no version with candidate for baseline B1 specified.

    Since there was no version specified in the incoming baseline report neither, this illustration is auto completed with latest available which results in version 1.

B1ISHNoneM1Baseline report with:
  • Version 1 of map M1
  • Version 2 of topic T1
  • Version 1 of topic T2
  • No version selected for illustration I1
  • For the starting point M1, we use version 1 which has candidate for baseline B1 specified.
  • For topic T1 referenced by version 1 of map M1, we use version 2 which is the highest version with candidate for baseline B1 specified
  • For topic T2 referenced by version 1 of map M1, there is no version with candidate for baseline B1 specified but version 1 is used since it was specified in the incoming baseline report.
  • For illustration I1 referenced by version 2 of topic T1, there is no version with candidate for baseline B1 specified.

    Since there was no version specified in the incoming baseline report neither and there is no auto complete mode specified, we cannot selected any version for this illustration.

 ISHLatestAvailableM1Baseline report with:
  • Version 2 of map M1
  • Version 3 of topic T1
  • Version 1 of topic T2
  • Version 1 of illustration I2
  • For the starting point M1, we use version 2 which was present in the incoming baseline report
  • For topic T1 referenced by version 2 of map M1, we have no version in the incoming baseline report. So, we will use the latest available version which is version 3.
  • For topic T2 referenced by version 2 of map M1, we use version 1 which was present in the incoming baseline report
  • For illustration I2 referenced by version 3 of topic T1, we have no version in the incoming baseline report. So, we will use the latest available version which is version 1.
 ISHNoneM1Baseline report with:
  • Version 2 of map M1
  • No version selected for topic T1
  • Version 1 of topic T2
  • For the starting point M1, we use version 2 which was present in the incoming baseline report
  • We cannot select a version for topic T1 referenced by version 2 of map M1, because we have no version in the incoming baseline report and no auto complete mode specified.
  • For topic T2 referenced by version 2 of map M1, we use version 1 which was present in the incoming baseline report