Click or drag to resize

IUrlMapRebuild(String, Boolean, IStructuredUrlSettings, IUser, DictionaryString, Int32, Boolean, String, DictionaryString, AliasMetaData) Method


Rebuilds the complete collection of URL maps and outputs the XML file to a specific location, with an explicitly specified list of marked Pages.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
void Rebuild(
	string publishFolder,
	bool primeTarget,
	IStructuredUrlSettings surlSettings,
	IUser user,
	Dictionary<string, int> markedPages,
	bool incremental = false,
	string publishingTargetId = "",
	Dictionary<string, AliasMetaData> aliasMetaData = null
)

Parameters

publishFolder  String
The full path of the Folder in which to place the generated URL map XML file
primeTarget  Boolean
Determines the name of the URL map XML file. When true, the file name is just "urlmap.xml"; when false, the file name is this entity's unique ID plus ".xml"
surlSettings  IStructuredUrlSettings
The structured URL settings. These typically come from the Publishing Target that this collection belongs to. Exposed as parameter so it can be customized.
user  IUser
The User that will perform the rebuild
markedPages  DictionaryString, Int32
Dictionary of marked Pages for the given Publishing Target. The keys of the dictionary are xIDs; the values are marked version numbers.
incremental  Boolean  (Optional)
Whether the rebuild is incremental or full
publishingTargetId  String  (Optional)
ID of the publishing target being rebuilt for to properly fetch marked version names in SURL generation
aliasMetaData  DictionaryString, AliasMetaData  (Optional)

[Missing <param name="aliasMetaData"/> documentation for "M:Ingeniux.CMS.IUrlMap.Rebuild(System.String,System.Boolean,Ingeniux.CMS.IStructuredUrlSettings,Ingeniux.CMS.IUser,System.Collections.Generic.Dictionary{System.String,System.Int32},System.Boolean,System.String,System.Collections.Generic.Dictionary{System.String,Ingeniux.CMS.AliasMetaData})"]

Remarks

The generated URL maps file will be placed in the App_Data/pub/[pub target folder]/settings folder.

Example
Generated urlmap.xml example:
XML
<?xml version="1.0" encoding="utf-8"?>
<Site HomePageID="x2" ForceLowerCaseURL="false" AutoRedirectCanonicalURL="true" EnabledExtensions="" URLExtension="" UseStructuredURL="true">
  <Page ID="x11" Path="/Champlain" Schema="CaseStudy" />
  <Page ID="x12" Path="/Mica" Schema="CaseStudy" />
  <Page ID="x13" Path="/Midwestern" Schema="CaseStudy" />
  <Page ID="x14" Path="/Company/News" Schema="NewsandEventsFront" />
  <Page ID="x15" Path="/Company/News/News-Archive" Schema="NewsArchive" />
  <Page ID="x17" Path="/Company/News/News-Archive/Ingeniux-Announces-Dates-for-2014-User-Conference" Schema="NewsDetail" />
  <Page ID="x2" Path="/" Schema="Home" />
  <Page ID="x28" Path="/Company" Schema="SectionDetail" />
  <Page ID="x34" Path="/Products" Schema="ProductFront" />
  <Page ID="x35" Path="/Products/Cartella-x35" Schema="ProductDetail">
  <Renamed Path="/Products/Cartella" Canonical="true" />
  </Page>
  <Page ID="x41" Path="/Solutions" Schema="SolutionsFront" />
  <Page ID="x43" Path="/Products/Cartella-x43" Schema="ProductDetail" />
  <Page ID="x44" Path="/Products/CMS" Schema="ProductDetail" />
  <Page ID="x47" Path="/Solutions/Mainstream" Schema="SolutionsDetail" />
</Site>
See Also