Configuration Package Installation

Overview

There are two options for the Configuration Package installation: upload package and run installation via the user interface or run the installation directly on the application server with the PowerShell script.

Install Package Action

To install Configuration Package via user interface proceed to the Administration application → Extensions → Installed Packages → click Install Package action: 

Uploaded and ready for installation Configuration Package details preview

Additionally, a digitally signed package is marked on the preview as follows:

See also What is a Digital Signature page.

1. Upload the archive of Configuration Package in the suggested field;
2. Wait for the Configuration Package details preview, depending on a package size the upload may take a while.
3. Handle warnings, if there are any;
4. Click Start Installation. The Installation Progress view shows more details about the current installation processing stage and occurring errors.
5. Click Finish to complete the package installation.

The page reloads and the installed package is available in the system.

Configuration Package Installation Progress view: successfully finished installation example

Installation with cmdlet PowerShell script

To install the package:

1. Upload the package archive to the application server;
2. Enable maintenance mode (optional, depending on the package);
3. Run the PowerShell script as an Administrator to install the package:

Import-Module "<PathToYourInstallation>\bin\matrix42.maintenance.cmdlets.dll" -force
$Credentials = Get-Credential
New-WMConfigurationSession -Credentials $Credentials
Enable-WMMaintenance             #Switching Maintenance Mode On (optional)
Install-ConfigurationPackage -File "<PathToYourPackageZipArchive>" -Log packages.log -ExitOnError
Disable-WMMaintenance            #Turning Maintenance Mode Off (optional)

The successfully completed Configuration Package installation may look as follows:

Installation with API

It is also possible to install a Configuration Package using API

Package Components Installation sequence

Package Installation regardless of the installation type (via user interface or PowerShell script) involves standard for the Configuration Packaging processing stages.

The overall sequence includes the following steps:

1. Check Configuration Package Prerequisites compliance
2. Enable maintenance mode
3. Stop services
4. Files copy (including assemblies)
5. Applying Schema Scripts
6. Applying SQL script
7. Applying PowerShell script
8. Automatic compliance rule processing
9. Automatic workflow publishing
10. Report deploy
11. Service restart
12. Application pool recycle
13. Remove maintenance mode

Installation Troubleshooting & Recovery Console

Installed Packages

The Installed Packages are listed on a dedicated page of the Administration application:

• Name of the package;
• Version: package version with major and minor numbers, for instance: 2.1;
• Vendor: identifies the author or the company that developed the package, in case of DWP it's "Matrix42 AG";
• Last Updated: date and time of the package installation or last update;
• Licensing Status: current status of the package licensing with one of the possible options
  • Not Required: package licensing was not configured for the package and thus is not required;
  • Valid: the installed package has a valid license certificate;
  • Invalid: license certificate of the package is no longer valid.
• Signed by: shows the digital signature that validates the authenticity of the installed package. It's the digital equivalent of a handwritten signature or stamped seal, but it offers far more inherent security. The signed package is shown as follows:
  
   

Click on the Configuration Package object for more details:

The installed package preview includes such details as the package name, signature (if available), installed version, vendor, installation date, last update, dependent packages, or shows which packages depend on the current package, and description.