How Install App Using PowerShell in SharePoint 2013.


Sathish Nadarajan
SharePoint MVP
Published On :   29 Aug 2015
Visit Count
Today :  2    Total :   5412



We saw some time back itself, how to install the App using PowerShell here. But again, this time also, let us see the same thing, but with a simpler version. Recently I created this script for one of my colleague and I thought of sharing the same to the SharePoint Community as well.

The script is very straight forward and very simple. There is nothing much to explain on this.

 ##================================================================================================
 ## Description             : Install the App 
 ## Author                  : Sathish Nadarajan
 ## Date                    : -Aug-2015
 ##================================================================================================
 
 # ============================================ Setup Input Paths ===========================================================
 
 
 $Host.UI.RawUI.WindowTitle = "-- Install App --"
 
 $StartDate = Get-Date
 Write-Host -ForegroundColor White "------------------------------------"
 Write-Host -ForegroundColor White "| Install App |"
 Write-Host -ForegroundColor White "| Started on: $StartDate |"
 Write-Host -ForegroundColor White "------------------------------------"
 
 $LogTime = Get-Date -Format yyyy-MM-dd_hh-mm
 $LogFile = ".\InstallApp-$LogTime.rtf"
 
 #start-transcript $logfile
 
 $scriptBase = split-path $SCRIPT:MyInvocation.MyCommand.Path -parent
 Set-Location $scriptBase
 
 $ErrorActionPreference = "Stop"
 
 function AddPowerShellSnapin()
 {
     try
     {
         Write-Host "Adding PowerShell Snap-in" -ForegroundColor Green
         # Try to get the PowerShell Snappin.  If not, then adding the PowerShell snappin on the Catch Block
         Get-PSSnapin "Microsoft.SharePoint.PowerShell" 
     }
     catch
     {
         if($Error[0].Exception.Message.Contains("No Windows PowerShell snap-ins matching the pattern 'Microsoft.SharePoint.PowerShell' were found"))
         {
             Add-PSSnapin "Microsoft.SharePoint.PowerShell"
         }
     }
     Write-Host "Finished Adding PowerShell Snap-in" -ForegroundColor Green
 
 }
 
 
 
 function InstallApp
 {
     try 
     {     
         Write-Host "Entering into Installation Method" -ForegroundColor Green 
 
         # Get the SiteURL
         $SiteUrl = $SiteConfig.Config.SiteURL;
 
         # Get the WebURL
         $WebUrl = $SiteConfig.Config.WebURL;
         Write-Host "WebUrl : $WebUrl" -ForegroundColor Green 
 
          
 
          # Initialize the Site Object
         $Site = Get-SPSite $SiteUrl
         Write-Host "Site: $Site" -ForegroundColor Green
 
         # Get the SPWeb Object
         $Web = Get-SPWeb $WebUrl
          Write-Host "Web: $Web" -ForegroundColor Green
         
         
          $app = Import-SPAppPackage -Path "MyAPP.app" -Site $Site -Source ObjectModel
      
          $appInstance = Install-SPApp -Web $Web -Identity $app
 
          $AppName = $appInstance.Title;
 
          $retrievedAppInstance = Get-SPAppInstance -Web $Web | where-object {$_.Title -eq $AppName};
 
 
     } 
     catch 
     { 
         Write-Host "Custom Exception Happened : " + $Error[0].Exception.Message -ForegroundColor Red  
     } 
 }
 
 try
 {
     $ConfigXmlPath = $scriptBase + "\" + "AppConfig.xml"
 
     Write-Host "Read the Config Values" -ForegroundColor Green 
 
     # Get the Content of the Config Xml
     [Xml]$SiteConfig = Get-Content $ConfigXmlPath  
 
     AddPowerShellSnapin
 
     InstallApp
 
     Write-Host "Script Execution Completed Successfully" -ForegroundColor Green 
 }
 catch
 {
     Write-Host "Custom Exception Happened on Main : " + $Error[0].Exception.Message -ForegroundColor Red  
 }
 

And only thing is, I am getting the Values of the SiteURL and the WebURL from the Config File. Even the AppName also, we can take it from the config to make it more generic.

The Config File looks like

 <?xml version="1.0" encoding="utf-8"?>
 
 <Config>
 
   <SiteURL>https://MySiteCollectionURL</SiteURL>
 
   <WebURL>https://sitecollection/webURL</WebURL>
 
   <ErrorMessage>Some Exception Occured During the Install App Process</ErrorMessage>
 
    
 
 </Config>
 

Hope this is straight forward..

Happy Coding,

Sathish Nadarajan.

Categories