Baseline version check-in. Not all management agents supported by MIM…

… / FIM are fully supported, so their documentation may be incomplete.

.gitignore

@@ -286,3 +286,8 @@ __pycache__/
 *.btm.cs
 *.odx.cs
 *.xsd.cs
+/src/SolutionOutput/MIMConfigDocumenterCmd.exe.config
+/src/SolutionOutput/MIMConfigDocumenterCmd.exe
+/src/SolutionOutput/MIMConfigDocumenter.psm1
+/src/SolutionOutput/MIMConfigDocumenter.dll
+/src/SolutionOutput/InvokeDocumenter-Contoso.ps1

ChangeLog.md

@@ -0,0 +1,13 @@
+## MIM Configuration Documenter Change Log
+
+All notable changes to MIMConfigDocumenter project will be documented in this file. The "Unreleased" section at the top is for keeping track of important changes that might make it to upcoming releases.
+
+------------
+
+### Version 1.17.0522.0
+
+#### Added
+
+* Baseline version check-in. Not all management agents supported by MIM / FIM are fully supported, so their documentation may be incomplete.
+
+------------

README.md

@@ -1,3 +1,34 @@
+# MIM Configuration Documenter
+
+MIM configuration documenter is a tool to generate documentation of a MIM / FIM synchronization or service installation.
+
+The goal of this project is to:
+
+* Document deployment configuration details for the MIM / FIM solution!
+* Track any configuration changes you have made since a specific baseline!!
+* Build confidence in getting things right when making changes to the deployed solution!!
+
+Prerequisites:
+
+1. .NET Framework 4.5 to be able to run the tool.
+2. FIMAutomation PowerShell snap-in installed locally when generating report for FIMService config.
+3. A modern browser (e.g. Microsoft Edge) to view the report.
+
+How to use the tool:
+
+* Download the latest release MIMConfigDocumenter.zip from the [releases](https://github.com/Microsoft/MIMConfigDocumenter/releases) tab under the Code tab tab, UNBLOCK the downloaded zip file and extract the zip file to an empty local folder.
+	* This will extract the Documenter application binaries along with the sample data files for "Contoso".
+	* Make sure that the tool runs by running the PowerShell script InvokeDocumenter-Contoso.ps1.
+* Export the FIM Sync Server and FIM Service Configuration of your two environments: PILOT / TARGET / END-STATE environment and PRODUCTION / BASELINE / REFERENCE environment.
+	* FIM Sync Server configuration is exported using File | Export Server Configuration menu in the FIM Sync Admin console.
+	* FIM Service configuration is exported using the ExportSchema.ps1 and ExportPolicy.ps1 scripts.
+	* If you have configuration files for only one enviorment, you can use any one set of the FIM or MIM config files provided with the tool as your PRODUCTION / BASELINE / REFERENCE environment.
+* Copy the configuration export files produced in the previous step to SyncConfig and ServiceConfig folders under the "Data" directory of the Documenter tool.
+	* As an example, the "Pilot" configuration files for the customer "Contoso" are provided as a sample in the "Data\Contoso\Pilot\SyncConfig" and "Data\Contoso\Pilot\ServiceConfig" folders.
+	* **NOTE:** The names of the FIM Service schema and policy export files must be schema.xml and policy.xml respectively.
+* Make a copy of the InvokeDocumenter-Contoso.ps1 script, name is appropriately and then open and edit the new script using the instructions provided in the script.
+* Run your script to generate the documentation report of your configuration exports. Upon successful execution, the report will be placed in the "Report" folder.
+
 # Contributing
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

src/CodeAnalysisDictionary.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+http://msdn.microsoft.com/en-us/library/bb514188.aspx
+
+Add words that should not cause a violation under the Dictionary/Words/Recognized path. 
+Add words that should cause a violation under the Dictionary/Words/Unrecognized path. 
+Add words that should be flagged as obsolete under the Dictionary/Words/Deprecated path. See the related rule topic "Use preferred terms" for more information. 
+Add exceptions to the acronym casing rules to the Dictionary/Acronyms/CasingExceptions path. 
+-->
+<Dictionary>
+  <Words>
+    <Unrecognized>
+      <Word>XPath</Word>
+    </Unrecognized>
+    <Recognized>
+      <Word>Metaverse</Word>
+      <Word>Diffgram</Word>
+      <Word>indexable</Word>
+      <Word>Dsml</Word>
+      <Word>Mms</Word>
+      <Word>GlobalSettings</Word>
+      <Word>SynchronizationRules</Word>
+      <Word>Span</Word>
+      <Word>Sync</Word>
+      <Word>Config</Word>
+      <Word>Multivalue</Word>
+    </Recognized>
+    <Deprecated>
+      <Term PreferredAlternate=""></Term>
+    </Deprecated>
+    <Compound>
+      <Term CompoundAlternate=""></Term>
+    </Compound>
+    <DiscreteExceptions>
+      <Term>Logon</Term>
+    </DiscreteExceptions>
+  </Words>
+  <Acronyms>
+    <CasingExceptions>
+      <Acronym>TOC</Acronym>
+      <Acronym>MIM</Acronym>
+      <Acronym>FIM</Acronym>
+    </CasingExceptions>
+  </Acronyms>
+</Dictionary>

src/MIMConfigDocumenter.sln

@@ -0,0 +1,47 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 14
+VisualStudioVersion = 14.0.25420.1
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MIMConfigDocumenterCmd", "MIMConfigDocumenterCmd\MIMConfigDocumenterCmd.csproj", "{C00797C0-20C8-44DA-BCD2-35955DC7C71F}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MIMConfigDocumenter", "MIMConfigDocumenter\MIMConfigDocumenter.csproj", "{8AA7E0B6-0D2A-4D18-B28C-E16AE42FAB2C}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{FF91F9F4-00F3-41E3-A515-AFF45CDB1EF0}"
+	ProjectSection(SolutionItems) = preProject
+		CodeAnalysisDictionary.xml = CodeAnalysisDictionary.xml
+		Documenter.snk = Documenter.snk
+		Settings.StyleCop = Settings.StyleCop
+		VersionInfo.cs = VersionInfo.cs
+	EndProjectSection
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SrcDocs", "SrcDocs", "{9E32BAF8-FF7E-49F4-B765-15997225B87A}"
+	ProjectSection(SolutionItems) = preProject
+		..\.gitignore = ..\.gitignore
+		..\ChangeLog.md = ..\ChangeLog.md
+		..\LICENSE = ..\LICENSE
+		..\README.md = ..\README.md
+	EndProjectSection
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{C00797C0-20C8-44DA-BCD2-35955DC7C71F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C00797C0-20C8-44DA-BCD2-35955DC7C71F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C00797C0-20C8-44DA-BCD2-35955DC7C71F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C00797C0-20C8-44DA-BCD2-35955DC7C71F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8AA7E0B6-0D2A-4D18-B28C-E16AE42FAB2C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8AA7E0B6-0D2A-4D18-B28C-E16AE42FAB2C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8AA7E0B6-0D2A-4D18-B28C-E16AE42FAB2C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8AA7E0B6-0D2A-4D18-B28C-E16AE42FAB2C}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{9E32BAF8-FF7E-49F4-B765-15997225B87A} = {FF91F9F4-00F3-41E3-A515-AFF45CDB1EF0}
+	EndGlobalSection
+EndGlobal