More documentation, resolved newline issue in logs

Author: AngryProgrammerInside

Agent/Lib/InstallAgent-Core.psm1

@@ -129,7 +129,7 @@ function Quit {
     if ($Code -match $SC.Validation.InternalErrorCode) {
         $Script.Results.Function = $Function.Name
         $Script.Results.LineNumber = $Function.LineNumber
-        $Script.Results.Details += @("`Name== Error Details ==")
+        $Script.Results.Details += @("`n== Error Details ==")
         $Script.Results.Details += @($SC.Exit.$LCode.ExitMessage)
         $Script.Results.Details +=
         if ($null -ne $Script.Results.Function)
@@ -146,7 +146,7 @@ function Quit {
     }
     ### Format the Message Data for the Event Log
     # Add the Overall Script Result
-    $Script.Results.EventMessage += @("Overall Script Result:  " + $SC.Exit.$LCode.ExitType + "`Name")
+    $Script.Results.EventMessage += @("Overall Script Result:  " + $SC.Exit.$LCode.ExitType + "`n")
     # Add the Completion Status of Each Sequence
     $Script.Sequence.Order |
     ForEach-Object {
@@ -156,20 +156,20 @@ function Quit {
         ) -join ' - '
     }
     # Add the Detailed Messages for Each Sequence
-    $Script.Results.EventMessage += @("`Name" + ($Script.Results.Details -join "`Name"))
+    $Script.Results.EventMessage += @("`n" + ($Script.Results.Details -join "`n"))
     # For Typical Errors, Add the Branded Error Contact Message from Partner Configuration
     if (
         ($Code -ne 999) -and
         ($Code -ne 0) -and
         ($null -ne $Config.ErrorContactInfo)
     ) {
         $Script.Results.EventMessage +=
-        "`Name--=========================--",
-        "`nTo report this documented issue, please submit this Event Log entry to:`Name",
+        "`n--=========================--",
+        "`nTo report this documented issue, please submit this Event Log entry to:`n",
         $Config.ErrorContactInfo
     }
     # Combine All Message Items
-    $Script.Results.EventMessage = ($Script.Results.EventMessage -join "`Name").TrimEnd('')
+    $Script.Results.EventMessage = ($Script.Results.EventMessage -join "`n").TrimEnd('')
     ### Publish Execution Results to the Event Log
     # Create a New Key for the Event Source if Required
     if ((Test-Path $Script.Results.ScriptEventKey) -eq $false)
@@ -235,7 +235,7 @@ function Log {
                 ($Message -is [Array]))
         ) {
             if ($Message -is [Array])
-            { $Message = $Message -join "`Name" }
+            { $Message = $Message -join "`n" }
         }
         else {
             # ERROR - Invalid Parameter
@@ -299,15 +299,15 @@ function Log {
             { ($SC.SequenceStatus.B + " ($Code)"); break }
         }
         # Add Detail Message to Current Sequence
-        $Script.Results.Details += @("`Name" + $Message)
+        $Script.Results.Details += @("`n" + $Message)
     }
     if ($EndSequence -eq $true) {
         # Change Status to COMPLETE Unless Otherwise Specified
         $Status =
         if ($Script.Sequence.Status[-1] -eq $SC.SequenceStatus.C)
         { $SC.SequenceStatus.A } else { $Script.Sequence.Status[-1] }
         # Add Sequence Footer After Detail Message
-        $Script.Results.Details += @("--== " + $Script.Execution.ScriptSequence + " Finished ==--`Name")
+        $Script.Results.Details += @("--== " + $Script.Execution.ScriptSequence + " Finished ==--`n")
     }
     # Update the Event Log Sequence Status
     $SelectedStatus = [Array]::IndexOf($Script.Sequence.Order, $Sequence)
@@ -354,11 +354,11 @@ function CatchError {
             $Out += 
             "== Command Details ==",
             ("Faulting Line Number:  " + $ExcCmdLN),
-            ("Faulting Command:  " + $ExcCmd + "`Name")
+            ("Faulting Command:  " + $ExcCmd + "`n")
         }
         $Out +=
         "== Error Message ==",
-        ($ExcMsg -join "`Name")
+        ($ExcMsg -join "`n")
     }
     Log E $Code $Out
     if ($Exit -eq $true) { Quit $Code }
@@ -1076,7 +1076,7 @@ function ValidatePartnerConfig {
     # Report on any Invalid Configuration Items
     if ($null -ne $InvalidConfig) {
         $Out =
-        "One or more items in the Partner Configuration was invalid.`Name",
+        "One or more items in the Partner Configuration was invalid.`n",
         "Please verify the following values:"
         $InvalidConfig |
         Sort-Object |
@@ -1154,7 +1154,7 @@ function ValidateExecution {
             Select-Object -ExpandProperty TotalSeconds
         )
         $Out =
-        ("Windows has booted within the " + $Config.BootTimeWaitPeriod + "-second Wait Period specified in the Partner Config.`Name"),
+        ("Windows has booted within the " + $Config.BootTimeWaitPeriod + "-second Wait Period specified in the Partner Config.`n"),
         ("Waiting the remaining " + $WaitTime + " seconds before Diagnosis...")
         Log I 0 $Out
         Start-Sleep -Seconds $WaitTime
@@ -1522,9 +1522,9 @@ function TestNCServer {
             $Out = @(
                 switch ($GoogleResult) {
                     $false
-                    { "Device appears not to have Internet connectivity at present.`Name"; break }
+                    { "Device appears not to have Internet connectivity at present.`n"; break }
                     $true
-                    { ("Device appears to have Internet connectivity, but is unable to reliably connect to the " + $NC.Products.NCServer.Name + ".`Name"); break }
+                    { ("Device appears to have Internet connectivity, but is unable to reliably connect to the " + $NC.Products.NCServer.Name + ".`n"); break }
                 },
                 "The Script will assess and perform Offline Repairs where possible until connectivity is restored."
             )
@@ -2821,7 +2821,7 @@ function SelectInstallMethod {
         # ERROR - No Installation Methods Remaining
         MethodSummary
         $Out =
-        ("All available Methods and Attempts to install the " + $NC.Products.Agent.Name + " were unsuccessful.`Name"),
+        ("All available Methods and Attempts to install the " + $NC.Products.Agent.Name + " were unsuccessful.`n"),
         ("Review the Event Log for any entries made by the " + $NC.Products.Agent.InstallerName + " Event Source for more details.")
         Log E 12 $Out -Exit
     }
@@ -2875,7 +2875,7 @@ function CheckMSIService {
         # Exit - Windows Installer Service Unavailable
         $Out = (
             "The Windows Installer Service has been unavailable for the timeout period of " +
-            $Config.InstallTimeoutPeriod + " minutes.`Name`Name" +
+            $Config.InstallTimeoutPeriod + " minutes.`n`n" +
             "This could be due to an Installer that is requesting user input to continue. "
         )
         $Out +=
@@ -2931,7 +2931,7 @@ function InstallNET {
     )
     if ($Device.NETProduct -lt (ValidateVersion $Config.NETVersion 2)) {
         # Exit - .NET Framework Installation Failed
-        $Out += ". An error occurred during installation.`Name`nReview the Event Log for relevant details."
+        $Out += ". An error occurred during installation.`n`nReview the Event Log for relevant details."
         Log E 10 $Out -Exit
     }
     $Out += " and was installed successfully."
@@ -2985,7 +2985,7 @@ function VerifyPrerequisites {
     if ($Install.NCServerAccess -eq $false) {
         # Exit - Installer will Fail to Authenticate with Server
         $Out =
-        ("The Device is currently unable to reliably reach the " + $NC.Products.NCServer.Name + ". Installation attempts will fail authentication.`Name"),
+        ("The Device is currently unable to reliably reach the " + $NC.Products.NCServer.Name + ". Installation attempts will fail authentication.`n"),
         "This may be caused by lack of Internet connectivity, a poor connection, or DNS is unavailable or unable to resolve the address.",
         "If this issue persists, verify the <NCServerAddress> value in the Partner Configuration is correct."
         Log E 6 $Out -Exit
@@ -3005,11 +3005,11 @@ function VerifyPrerequisites {
         # Exit - No Available Installation Methods
         $Out =
         if ($null -eq $CustomerID) {
-            @("An " + $NC.Products.Agent.IDName + " was not provided to the Script and is required for Installation.`Name")
+            @("An " + $NC.Products.Agent.IDName + " was not provided to the Script and is required for Installation.`n")
             $ExitCode = 7
         }
         else {
-            @("The " + $NC.Products.Agent.IDName + " provided to the Script [" + $CustomerID + "] is invalid. A valid Customer ID is required for Installation.`Name")
+            @("The " + $NC.Products.Agent.IDName + " provided to the Script [" + $CustomerID + "] is invalid. A valid Customer ID is required for Installation.`n")
             $ExitCode = 8
         }
         $Out +=

ReadMe.md

@@ -254,12 +254,14 @@ Scenario 3: The package is deployed as above. LaunchInstaller is set to read par
 
 # Preparation
 
-## 1 - Update the Partner Configuration
+## 1 - Updating the Partner Configuration
 
 **The developers recommend editing the Partner Configuration (PartnerConfig.xml) with Visual Studio Code, however feel free to use your favorite text editor that supports "UTF-8 w/ BOM" Encoding.**
 
 Open **PartnerConfig.xml** to begin. This **Partner Configuration** is your one-stop shop for configuring the **Deployment Package.** Enter data for each value between the relevant XML Tags (many values are already assigned Defaults to serve as an example). Information about the Expected Format and Purpose of each Configuration Value is contained above each value itself. Consider the table below a desk reference.
 
+In normal circumstances you would configure values like Service Behavior and Script Behavior, then the rest will be updated/injected via the provided AMPs.
+
 | Category | Value Name | Default Value | Mandatory | Purpose |
 | -------- | ---------- | ------------- | --------- | ------- |
 | **Branding** | *ErrorContactInfo* | | No | This is a space for your business contact info (Company Name, Address, Support Phone Number, etc.). This will be printed at the bottom of the Event Log entry when a documented error occurs. If using multiple lines, start your information at the **beginning of each line** (no indent) in the tag space. |
@@ -299,7 +301,6 @@ A small amount of customization can also be made in the **Agent Launcher Script*
 | Value Name | Default Value | Mandatory | Purpose |
 | ---------- | ------------- | --------- | ------- |
 | *TempFolder* | C:\Windows\Temp\AGPO | Yes | This should be a Local Folder on the system where the **Deployment Package** components work from, **NOT to be confused with the *LocalFolder* value in the Partner Configuration.** Whether run by Group Policy or On-Demand (click-to-run), the required components are dropped here during execution and then **removed upon termination of the Package.** |
-| *DLThreshold* | 3 | Yes | This is the maximum number of attempts the **Agent Setup Launcher** will make to download any prerequisite components needed for Agent installation. If this value is exceeded, the **Launcher will terminate, and it must be run again.** |
 | *NoArgs* | 0 | Yes | Disable the usage of arguments passed to this script. This way you can **not** pass CustomerID and Token through arguments, but if you have an older GPO that still uses a domainname or the term AUTO, you can set this value to 1. This way you don't need to change all those GPO's. **If set to 1, you do need another way to pass CustomerID and Token, or through the PartnerConfig.xml, or through azNableProxy** |
 
 If you elect to make any changes, you will need to adjust the values **immediately following the equals (=) sign** in their relevant **SET** statements. For example:

ReleaseNotes.md

@@ -1,5 +1,4 @@
 # 2020-02-xx
-New and updated features:
 *   Registration token install method:
     *   Activation Key methods for upgrades
     *   Registration Key methods for new installs/repairs
@@ -11,6 +10,7 @@ New and updated features:
 *   Functioning N-Central AMP scripts that support 2 methods for updating the configuration file used for installation
     *   Direct update of Customer ID/Registration Token and other values from N-Central Custom Property (CP) injected via N-Central API See: [How to N-Central API Automation](https://github.com/AngryProgrammerInside/NC-API-Documentation) for examples
     *   Automatic update of Customer ID/Registration token from values pulled from local Agent/Maintenance XML along with provided JWT (see above documentation)
+*   Functioning N-Central AMP script to update/renew expired/expiring tokens
 *   Legacy Support: If you still have old values within your GPO, you can use a flag within the LaunchInstaller.bat to ignore provided parameters and rely upon the configuration file
 *   Custom installation method data
     *   Through additional modules you can use your own source for CustomerID/Registration Token enumeration
@@ -21,7 +21,7 @@ New and updated features:
 *   Quality of Life for development and debugging:
     *   Added debugmode to the InstallAgent.ps1 to avoid self destruct and reload of modules
     *   Added debug function to provide Gridviews of common tables
-    *   For more details on development debugging of this script, [check out this readme](DevelopmentAndDebugging.md)
+    *   For more details on development debugging of this script, check out this page on GitHub
 
 # 2019-08-26