Renamed sample script to AzureADConnectSyncDocumenter-Contoso.cmd

Author: NileshGhodekar

ChangeLog.md

@@ -8,6 +8,13 @@ All notable changes to AADConnectConfigDocumenter project will be documented in
 
 ------------
 
+### Version 1.18.0928.0
+
+#### Fixed
+- Fixed issue where the "Download Sync Rule Changes Script" link was not working in Chrome / Firefox.
+
+------------
+
 ### Version 1.18.0613.0
 
 #### Fixed

README.md

@@ -25,9 +25,11 @@ Prerequisites:
 
 How to use the tool:
 
-* Download the latest release AzureADConnectSyncDocumenter.zip from the [releases](https://github.com/Microsoft/AADConnectConfigDocumenter/releases) tab under the Code tab tab, UNBLOCK the downloaded zip file and extract the zip file to an empty local folder on a machine which has .NET Framework 4.5 installed.
+* Download the latest release AzureADConnectSyncDocumenter.zip from the [**releases**](https://github.com/Microsoft/AADConnectConfigDocumenter/releases) tab under the Code tab tab.
+* UNBLOCK the downloaded zip file using the **Right Click** | **Properties** menu and then checking the **Unblock** check-box from the **General** tab.
+* Extract the zip file to an empty local folder on a machine which has .NET Framework 4.5 installed.
 	* This will extract the Documenter application binaries along with the sample data files for "Contoso".
-	* Make sure that the tool runs by double-clicking on the cmd file AzureADConnectSyncDocumenter.cmd.
+	* Make sure that the tool runs by double-clicking on the cmd file AzureADConnectSyncDocumenter-Contoso.cmd.
 * Export the Server Configuration of your pilot / test Azure AD Connect sync server by running Get-ADSyncServerConfiguration cmdlet defined in ADSync module shipped with Azure AD Connect.
 
 ```PowerShell
@@ -38,14 +40,14 @@ How to use the tool:
 ```
 
 * Copy the configuration export files produced in the previous step to a folder under the "Data" directory of the Documenter tool.
-	* e.g. the "Pilot" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Pilot" folder.
+	* e.g. the "Pilot" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Pilot" folder. This is the folder where the files of the ***to be*** or ***end-state*** configuration are located. So, for example, in a swing migration project the "Pilot" or "Target" configuration will be the configuration of the "old" server, since the goal is to build a new server with the configuration as close to the old server as possible.
 * If you want to document the changes from a specific baseline, export the server configuration of your baseline / production Azure AD Connect server and copy the output to a folder under the Documenter "Data" directory.
-	* e.g. the "Production" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Production" folder.
-* Edit AzureADConnectSyncDocumenter.cmd for the values of "Pilot" and "Production" directories.
+	* e.g. the "Production" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Production" folder. This is the folder where the files of the ***as-is*** or ***baseline*** configuration are located.
+* Make a copy of AzureADConnectSyncDocumenter-Contoso.cmd with a name appropriate for your enviroment (say AzureADConnectSyncDocumenter-Fabrikam.cmd) and edit your copy for the values of "Pilot" and "Production" directories.
 	* If you don't have a baseline / production config, specify the same path as the "Pilot" config.
-* Run the updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder. 
+* Run your updated updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder. 
 
-**!!NOTE!!** _**If the names of the connector(s) do(es) not exactly match between the supplied "Pilot"  and "Production" configuration files, then before running the tool, "prep" the exported config files by manually editing the xml files located in the "Connectors" folder so that the name of the connector(s) match. The name of the connector is located inside the "name" element at the start of the content.**_
+**!!NOTE!!** _**If the name(s) of the connector(s) do(es) not exactly match between the supplied "Pilot"  and "Production" configuration files, then before running the tool, "prep" the exported config files by manually editing the xml files located in the "Connectors" folder so that the name of the connector(s) match. The name of the connector is located inside the "name" element at the start of the content.**_
 
 A sample report generated by the tool can be found listed in the [Wiki](https://github.com/Microsoft/AADConnectConfigDocumenter/wiki/Sample-Report) section.
 

src/AzureADConnectSyncDocumenter-Contoso.cmd

@@ -0,0 +1,15 @@
+AzureADConnectSyncDocumenterCmd.exe "Contoso\Pilot" "Contoso\Production"
+
+ECHO OFF
+
+IF %ERRORLEVEL% EQU 9009 (
+	ECHO ****************************************************************************************************
+	ECHO It seems you may have downloaded the source code instead of a release package. Please download the latest release from https://github.com/Microsoft/AADConnectConfigDocumenter/releases...
+	ECHO ****************************************************************************************************
+) ELSE (
+	ECHO ****************************************************************************************************
+	ECHO Execution complete. Please check any errors or warnings in the AADConnectSyncDocumenter-Error.log...
+	ECHO ****************************************************************************************************
+)
+
+@pause

src/AzureADConnectSyncDocumenter.cmd

@@ -1,13 +1,13 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 2013
-VisualStudioVersion = 12.0.31101.0
+# Visual Studio 14
+VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AzureADConnectSyncDocumenterCmd", "AzureADConnectSyncDocumenterCmd\AzureADConnectSyncDocumenterCmd.csproj", "{C6098A15-5BAC-4FD1-BD5A-9E44315D6C09}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{BE2A6C7E-C38D-4210-8966-66CF07CB5C03}"
 	ProjectSection(SolutionItems) = preProject
-		AzureADConnectSyncDocumenter.cmd = AzureADConnectSyncDocumenter.cmd
+		AzureADConnectSyncDocumenter-Contoso.cmd = AzureADConnectSyncDocumenter-Contoso.cmd
 		CodeAnalysisDictionary.xml = CodeAnalysisDictionary.xml
 		Documenter.snk = Documenter.snk
 		Settings.StyleCop = Settings.StyleCop

src/AzureADConnectSyncDocumenter.sln

@@ -1337,7 +1337,7 @@ protected void WriteReport(string reportHeader, string reportHtml, string tocHtm
                     this.ReportWriter.WriteBeginTag("span");
                     this.ReportWriter.WriteAttribute("class", cellClass);
                     this.ReportWriter.WriteLine(HtmlTextWriter.TagRightChar);
-                    this.ReportWriter.Write("(" + syncVersionPilot + ")");
+                    this.ReportWriter.Write("(" + syncVersionPilot + "):");
                     this.ReportWriter.WriteEndTag("span");
                 }
 
@@ -1358,7 +1358,7 @@ protected void WriteReport(string reportHeader, string reportHtml, string tocHtm
                     this.ReportWriter.WriteBeginTag("span");
                     this.ReportWriter.WriteAttribute("class", cellClass);
                     this.ReportWriter.WriteLine(HtmlTextWriter.TagRightChar);
-                    this.ReportWriter.Write("(" + syncVersionProduction + ")");
+                    this.ReportWriter.Write("(" + syncVersionProduction + "):");
                     this.ReportWriter.WriteEndTag("span");
                 }
 

src/AzureADConnectSyncDocumenter/Documenter.cs

@@ -80,7 +80,7 @@
   <PropertyGroup>
     <PostBuildEvent>xcopy /I /Y "$(TargetDir)$(TargetName).exe" "$(SolutionDir)SolutionOutput"
 xcopy /I /Y "$(TargetDir)$(TargetName).exe.config" "$(SolutionDir)SolutionOutput"
-xcopy /I /Y "$(SolutionDir)AzureADConnectSyncDocumenter.cmd" "$(SolutionDir)SolutionOutput"
+xcopy /I /Y "$(SolutionDir)AzureADConnectSyncDocumenter-Contoso.cmd" "$(SolutionDir)SolutionOutput"
 </PostBuildEvent>
   </PropertyGroup>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

src/AzureADConnectSyncDocumenterCmd/AzureADConnectSyncDocumenterCmd.csproj

@@ -29,8 +29,12 @@ public static void Main(string[] args)
             {
                 if (args == null || args.Length < 2)
                 {
-                    string errorMsg = string.Format(CultureInfo.CurrentUICulture, "Missing commnad-line arguments. Usage: {0} {1} {2}.", new object[] { Assembly.GetExecutingAssembly().GetName().Name, "{Pilot / Target Config Folder}", "{Production / Reference / Baseline Config Folder}" });
+                    var errorMsg = string.Format(CultureInfo.CurrentUICulture, "Missing commnad-line arguments. Usage: {0} {1} {2}.", new object[] { Assembly.GetExecutingAssembly().GetName().Name, "{Pilot / Target Config Folder}", "{Production / Reference / Baseline Config Folder}" });
                     Console.Error.WriteLine(errorMsg);
+
+                    errorMsg = string.Format(CultureInfo.CurrentUICulture, "Example: \t{0} {1} {2} {3}", new object[] { Environment.NewLine, Assembly.GetExecutingAssembly().GetName().Name, "\"Contoso\\Pilot\"", "\"Contoso\\Production\"" });
+                    Console.Error.WriteLine(errorMsg);
+
                     Console.ReadKey();
                     return;
                 }

src/AzureADConnectSyncDocumenterCmd/Program.cs

@@ -22,7 +22,7 @@ internal static class VersionInfo
         ///      Build Number (MMDD)
         ///      Revision (if any on the same day)
         /// </summary>
-        internal const string Version = "1.18.0613.0";
+        internal const string Version = "1.18.0928.0";
 
         /// <summary>
         /// File Version information for the assembly consists of the following four values:
@@ -31,6 +31,6 @@ internal static class VersionInfo
         ///      Build Number (MMDD)
         ///      Revision (if any on the same day)
         /// </summary>
-        internal const string FileVersion = "1.18.0613.0";
+        internal const string FileVersion = "1.18.0928.0";
     }
 }