Modifying your Smart Previews Hybrid Configuration using PowerShell

You can modify your Smart Previews Hybrid configuration through PowerShell. To do so, use the following steps and commands:

  1. Open PowerShell as an administrator.

  2. Run the following command: Import-Module "C:\Program Files\Upland BA Insight\Smart Previews Hybrid\bin\BAInsight.SmartPreviewsHybrid.PowerShell.dll"

  3. Refer to the table below and run any of the listed commands.

  4. If required, provide values for the parameters.

Command/Parameters Details Example
Get-SmartPreviewsHybridConfiguration
-TenantInformation

This displays the configuration of the Smart Previews Hybrid component.

The parameters are not required, but if a parameter is specified, only the configuration for that part is displayed.

Get-SmartPreviewsHybridConfiguration

-SmartPreviewsConnectionData
-FetchersConfiguration
Get-SmartPreviewsHybridConnectionData
 

This displays the configuration of the Smart Previews Hybrid Connection Data.

There are no parameters for this command.

Get-SmartPreviewsHybridConnectionData

Set-SmartPreviewsHybridConnectionData
-SmartPreviewsDBConnectionString This sets or updates the configuration of the Smart Previews Hybrid Connection Data. Set-SmartPreviewsHybridConnectionData -SmartPreviewsDBConnectionString "Server=servername; Database=SmartPreviews_Configuration_sql; Trusted_Connection=True; Pooling=false;" -SmartPreviewsGenerationServiceAddress "http://localhost:1238/PreviewGeneratorService"
-SmartPreviewsGenerationServiceAddress
Get-SmartPreviewsHybridTenantInformation
 

This displays the certificate friendly name, subject and expiration date.

There are no parameters for this command.

Get-SmartPreviewsHybridTenantInformation

Set-SmartPreviewsHybridTenantInformation
-CertificateFriendlyName

This sets or updates the certificate used by the Smart Previews Hybrid component.

You must ensure that the certificate is installed on the server under LocalMachine storage.

Set-SmartPreviewsHybridTenantInformation -CertificateFriendlyName "BAInsightGeneratedCertificate"

Get-SmartPreviewsHybridFetchersConfiguration
 

This displays the fetchers configuration.

There are no parameters for this command.

Get-SmartPreviewsHybridFetchersConfiguration

Set-SmartPreviewsHybridFetcherConfiguration
-UrlPrefix

This updates the value of the specified setting for a specific fetcher.

All of the parameters are required.

Set-SmartPreviewsHybridFetcherConfiguration -UrlPrefix spworks:// -SettingName password -SettingValue 1234

-SettingName
-SettingValue
Add-SmartPreviewsHybridFetcher
-FetcherName

This adds a new fetcher.

All of the parameters are required.

Add-SmartPreviewsHybridFetcher -FetcherName "Sample Fetcher" -AssemblyName "BAInsight.SmartPreviewHybrid.OnPrem, Version=1.0.0.0, Culture=neutral, PublicKeyToken=bd5ed2e4b6962cd0" -ClassName "SmartPreviewService.Fetchers.FileSystemFetcher" -URLPrefix file://test -Settings "name:servername\username;password:1234;authenticationMode:basicAuth"

-AssemblyName
-ClassName
-URLPrefix
-Settings