AddEmptyUserSchemaIfNotExists.ps1
AddEmptyUserSchemaIfNotExists.ps1 Script name
<InstallationFolder>\PST\Analytics Data Server\PowerShell Scripts
Location
Adds a schema "user" to the database (if it isn't there already) Purpose
AddEmptyUserSchemaIfNotExists.ps1 [-SetAsSchemaForDefaultUser] Syntax
where:
• -SetAsSchemaForDefaultUseris a flag to indicate that the new schema should be made the schema for the default user.
TheAddEmptyUserSchemaIfNotExists.ps1script makes use the following separate PowerShell cmdlet. If required, it can be run individually in place of the script:
cmdlets
• Add-EmptyUserSchemaIfNotExists
You can choose to run individual cmdlets in place of the script if that is more efficient. For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
Note: AdminSettings.ps1 AdminSettings.ps1 Script name <PSS Installation Folder>\Administration Location
To set the Portrait HQ display language, enable or disable HQ campaign approval, or manage HQ logging levels.
[-PSSUserAccountName] <String> [-PSSUserAccountPassword] <String> [[-UICulture] <String>] [[-Culture] <String>] [[-CampaignApprovalEnabled] <String>] [[-LogLevel] <String>] where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• UICultureis the language code for the language to be used when displaying language strings in the HQ. Must be set toen.
• Cultureis the language code for the language to be used by culture-dependent functions, such as date, number and currency formatting. Must be set toen. • CampaignApprovalEnabledis the flag to specify whether to enable campaign
approval in the HQ. If omitted, defaulted tofalse.
• LogLevelis the level of information logged by the HQ. Choice ofCritical, Error,Warning,InformationorVerbose. If omitted, defaulted toVerbose.
This script uses the following PowerShell cmdlets. If required, these cmdlets can be run individually in place of the script.
Cmdlets
• Set-LanguageSetting
• Set-CampaignApproval
• Set-LogSetting
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailedin the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Server\PSSModules.config. Edit this file to change these defaults. Notes CreatePortraitDatabases.ps1 CreatePortraitDatabases.ps1 Script name <PSS Installation Folder>\Administration Location
Creates the Portrait Shared Repository and Portrait Data Warehouse databases. Purpose
CreatePortraitDatabases.ps1 [-DWDatabaseName] <String> [-PSRDatabaseName] <String> [-DBAccessUsername] <String> Syntax
[-IntegratedSecurity] <String>[-DBUsername] <String>
[-DBPassword] <String> [-DBServerName] <String> [-Sourceroot] <String>
where:
• DWDatabaseNameName of the Portrait Data Warehouse database • PSRDatabaseNameName of the Portrait Shared Repository database • DBAccessUsernameThis is the identity under which the Portrait Shared
Services will access the Portrait Shared Repository and Datawarehouse databases.
• IntegratedSecurityFlag to be set to enable (true) or disable (false) connecting to the database using Windows authentication.
• DBUsernameUser name for connecting to the database. Mandatory if integrated security is NOT enabled.
• DBPasswordPassword for the user to connect to the SQL Server. Mandatory if integrated security is NOT enabled.
• DBServerNameName or IP of the database server.
• SourcerootRoot location of the database sql scripts. Uses install folder when not specified.
TheCreatePortraitDatabases.ps1script makes use of two separate PowerShell cmdlets. If required, they can be run individually in place of the script. cmdlets
• New-DatabaseDW: sets up the Portrait Data Warehouse database. • New-DatabasePSR: sets up the Portrait Shared Repository database.
For more information on cmdlets, type Get-Help <cmdlet name> -Detailed in the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Server\DbModules.config . Edit this file to change these defaults. Notes DialogueIntegration.ps1 DialogueIntegration.ps1 Script name <PSS InstallationFolder>\Administration Location
To enable or disable Portrait Dialogue on Portrait Shared Server. Purpose
[-PSSUserAcountName] <String> [-PSSUserAcountPassword] <String> [[-DialogueIntegrationEnabled] <String>] [[-DialogueServerURL] <String>][[-DialogueInstanceName] <String>]
where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• DialogueIntegrationEnabledspecifies whether to enable (true) or disable (false) Portrait Dialogue integration with Portrait Shared Server.
• DialogueServerURLis the URL of the Portrait Dialogue Server API. For
example,http://my-pd-server/mhdialogserverapi.
• DialogueInstanceNameis the name of the Portrait Dialogue instance.
TheDialogueIntegration.ps1script makes use of one PowerShell cmdlet. If required, it can be run individually in place of the script.
Cmdlets
• Set-DialogueIntegration: sets the integration with Dialogue.
For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
Note:
Notes
• Caution: Running this script will re-start the Portrait Shared Server application pool. This has the effect of ending any open Portrait Shared Server sessions. Any users logged on to the HQ when the script is run will be forced to log in again.
• Any arguments not entered are read from %programdata%/\Pitney Bowes Software\Portrait Shared Services\PSSModules.config.
• This script enablesordisables integration between Portrait Dialogue and PSS.
ExplorerIntegration.ps1
ExplorerIntegration.ps1 Script name
<InstallationFolder>\PST\Portrait Shared Server\Administration Location
To enable or disable Portrait Explorer on Portrait Shared Server. Purpose
ExplorerIntegration.ps1 [[-WindowsAuthentication] <String>] [-PSSUserAcountName] <String> [-PSSUserAcountPassword] Syntax
<String> [[-ExplorerIntegrationEnabled] <String>] [[-ExplorerAnalyticsDataServerURL] <String>] where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• ExplorerIntegrationEnabledallows you to enable (true) or disable (false) Portrait Explorer integration with PSS.
• ExplorerAnalyticsDataServerURLis the Analytics Data Server Server URL.
Notes
• Any arguments not entered are read from %programdata%/\Pitney Bowes Software\Portrait Shared Services\PSSModules.config.
• This script enablesordisables integration between Portrait Explorer and PSS.
InstallADSServices.ps1
InstallADSServices.ps1 Script name
<InstallationFolder>\PST\Analytics Data Server\PowerShell Scripts
Location
To start the Analytics Data Server services required by Portrait Explorer. The Analytics Data Server consists of two services:
Purpose
• The Analytics Data Server service hosts the available analytics services, and • The Analytics Data Repository service allows access to the associated database.
Both services must be configured and started in the correct order (Analytics Data Repository started first).
-DBFarmPath <value> -ADSServiceName <value> -ADSPort <value> where:
• ADRServiceNameis the name assigned to the Analytics Data Repository service.
• ADRPortis the port number the Analytics Data Repository service listens on. • DBFarmPathis the directory where the database is stored on the file system. • ADSServiceNameis the name assigned to the Analytics Data Server service. • ADSPortis the port number the Analytics Data Server is hosted on.
TheInstallADSServices.ps1script makes use of two separate PowerShell cmdlets. If required, they can be run individually in place of the script:
cmdlets
• Add-AnalyticsDataRepository
• Add-AnalyticsDataServerService
You can choose to run individual cmdlets in place of the script if that is more efficient. For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
Note: IOIntegration.ps1 IOIntegration.ps1 Script name <PSS Installation Folder>\Administration Location
To enable or disable Interaction Optimizer on Portrait Shared Server. Purpose
IOIntegration.ps1 [[-WindowsAuthentication] <String>] [-PSSUserAccountName] <String> [-PSSUserAccountPassword] Syntax
<String> [[-IOIntegrationEnabled] <String>] [[-IOServerURL] <String>]
where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• IOIntegrationEnabledspecifies whether to enable (true) or disable (false) Interaction Optimizer integration with Portrait Shared Server.
• IOServerURLis the URL of the web server hosting the Interaction Optimizer web service API. For example,http://my-io-server.
TheIOIntegration.ps1script makes use of one PowerShell cmdlet. If required, it can be run individually in place of the script.
Cmdlets
• Set-IOIntegration: sets the integration with Interaction Optimizer.
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailed in the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Services\PSSModules.config. Edit this file to change these defaults. Notes ReportIntegration.ps1 ReportIntegration.ps1 Script name <PSS Installation Folder>\Administration Location
To enable or disable Portrait Reports on Portrait Shared Server. Purpose
[[-PSSUserAcountName] <String>] [[-PSSUserAcountPassword] <String>] [[-ReportIntegrationEnabled] <String>]
[[-ReportServerWebServiceURL] <String>] where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• ReportIntegrationEnabledis Whether to integrate SSRS reports with the HQ. Eithertrueorfalse. If omitted, defaulted tofalse.
• ReportServerURLis SSRS Report Server URL. If omitted, defaulted to http://localhost/ReportServer.
This script uses the following PowerShell cmdlets. If required, these cmdlets can be run individually in place of the script.
Cmdlets
• Set-ReportIntegration
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailedin the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Services\PSSModules.config. Edit this file to change these defaults. Notes SetPSSDatabaseConnections.ps1 SetPSSDatabaseConnections.ps1 Script name <PSS Installation Folder>\Administration\ Location
Sets Portrait Shared Server's database connection details to the Portrait Shared Repository and Portrait Data Warehouse databases.
Purpose
SetPSSDatabaseConnections.ps1 [[-PSRDatabaseName] <String>] [[-DWDatabaseName] <String>] [[-DBUsername] <String>] Syntax
[[-DBPassword] <String>] [-DBServerName] <String> [-IntegratedSecurity] <String>
Parameters:
-PSRDatabaseName. Name of the Portrait Shared Repository database. If omitted, defaulted to PortraitPSR.
-DWDatabaseName. Name of the Portrait Data Warehouse database. If omitted, defaulted to PortraitDW.
-DBUsername. User name for connecting to SQL server. Mandatory if IntegratedSecurity is false.
-DBPassword. Password for connecting to SQL Server. Mandatory if IntegratedSecurity is false.
-DBServerName. Name of database server instance. If omitted, defaulted to (local).
-IntegratedSecurity. Flag to be set to enable (true) or disable (false) connecting to the database using Windows authentication..
This script uses the following PowerShell cmdlets. If required, these cmdlets can be run individually in place of the script.
cmdlets
• Set-ConnectionDW
• Set-ConnectionPSR
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailedin the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Services\DbModules.config. Edit this file to change these defaults. Notes SetupWebsites.ps1 SetupWebsites.ps1 Script name <PSS Installation Folder>\Administration\ Location
To add the Portrait Shared Services and HQ web applications to IIS. Purpose
[-PSSWebAppPoolAccountName] <String>
[-PSSWebAppPoolAccountPassword] <String> [[-IISWebsite] <String>]] [[-HQWebApplicationPhysicalPath] <String>] [[-PSSWebApplicationPhysicalPath] <String>]
Parameters:
-PSSWebAppPoolAccountDomain. The account domain for the app pool identity. -PSSWebAppPoolAccountName. The account name for the app pool identity. -PSSWebAppPoolAccountPassword. The account password for the app pool identity.
-IISWebsite. The IIS website under which the web application exists. If omitted, defaulted to Default Web Site.
-HQWebApplicationPhysicalPath. The physical path for the web application to be created. If omitted, defaulted to<PSS Installation
Folder>\Marketing HQ.
-PSSWebApplicationPhysicalPath. The physical path for the web application to be created. If omitted, defaulted to<PSS Installation folder>\Portrait Shared Services.
TheSetupWebsites.ps1script makes use of five separate PowerShell cmdlets. If required, they can be run individually in place of the script.
cmdlets • New-PSSWebAppPool • New-HQWebApplication • New-PSSWebApplication • Set-HQWebApplicationSettings • Set-PSSWebApplicationSettings
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailsin the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Server\PSSModules.config. Edit this file to change these defaults. Notes
This script does not validate that the account credentials you provide are correct. Take care when entering this information.
SharepointIntegration.ps1
SharepointIntegration.ps1 Script name
<InstallationFolder>\PST\Portrait Shared Server\Administration Location
To enable or disable Portrait Tasks on Portrait Shared Server. Purpose
SharePointIntegration.ps1 [[-WindowsAuthentication] <String>] [-PSSUserAcountName] <String> [-PSSUserAcountPassword] Syntax
<String> [[-SharePointIntegrationEnabled] <String>] [[-SharePointServerURL] <String>]]
where:
• WindowsAuthenticationspecifies whether or not to use Windows authentication to log on to Portrait Shared Services. Set totrueto use the current Windows user account to log on to Portrait Shared Services. • PSSUserAccountNameis the user name for connecting to Portrait Shared
Services. Required only ifWindowsAuthenticationset tofalse.
• PSSUserAccountPasswordis the password for connecting to Portrait Shared Services. Required only ifWindowsAuthenticationset tofalse.
• SharePointIntegrationEnabledis the flag to be set to enable (true) or disable (false) SharePoint integration with PSS.
• SharePointServerURLis the SharePoint Server URL.
TheSharePointIntegration.ps1script makes use of one PowerShell cmdlet. If required, it can be run individually in place of the script.
Cmdlets
• Set-SharePointIntegration- sets the integration with SharePoint.
For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
Note:
Notes
• Any arguments not entered are read from %programdata%/\Pitney Bowes Software\Portrait Shared Services\PSSModules.config.
• This script enablesordisables integration between SharePoint and PSS.
UpdateAnalyticsDataRepositorySchema.ps1
UpdateAnalyticsDataRepositorySchema.ps1 Script name
<InstallationFolder>\PST\Analytics Data Server\PowerShell Scripts
Location
Creates/updates the Analytics Data Repository "adr" schema to the latest schema version.
where:
• -BackupDbis an optional flag to indicate that the existing DB schema be backed up before updating an existing schema
TheUpdateAnalyticsDataRepositorySchema.ps1script makes use the following separate PowerShell cmdlet. If required, it can be run individually in place of the script:
cmdlets
• Update-AnalyticsDataRepositorySchema
You can choose to run individual cmdlets in place of the script if that is more efficient. For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
Note:
Advanced uninstallation
Uninstall scripts
RemoveAnalyticsDataRepositorySchema.ps1 RemoveAnalyticsDataRepositorySchema.ps1 Script name<InstallationFolder>\PST\Analytics Data Server\PowerShell Scripts
Location
This command will attempt to remove the "adr" schema from the Analytics Data Repository database. The command will fail if no schema called "adr" exists in the database when the cmdlet is called."
Purpose
RemoveAnalyticsDataRepositorySchema.ps1 Syntax
TheRemoveAnalyticsDataRepositorySchema.ps1script makes use of the following PowerShell cmdlets. If required, they can be run individually in place of the script:
cmdlets
• Remove-AnalyticsDataRepositorySchema
You can choose to run individual cmdlets in place of the script if that is more efficient. For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.
RemovePortraitDatabases.ps1
RemovePortraitDatabases.ps1 Script name
<PSS Installation Folder>\Administration Location
Removes the Portrait Shared Repository and Portrait Data Warehouse databases from the database server.
Purpose
RemovePortraitdatabases.ps1 -DBServerName <string> -DWDatabaseNameForDrop <string> -PSRDatabaseNameForDrop Syntax
<string> -IntegratedSecurity <string> -DBUsername <string> -DBPassword <string> -Sourceroot <string>
where:
• DBServerName: Name of the database server.
• DWDatabaseNameForDrop: Name of the Portrait Data Warehouse database to remove.
• PSRDatabaseNameForDrop: Name of the Portrait Shared Repository database to remove.
• IntegratedSecurity: Flag to be set to enable (true) or disable (false) connecting to the database using Windows authentication.
• DBUsername: User name for connecting to SQL server. Mandatory if IntegratedSecurity is false.
• DBPassword: Password for connecting to SQL Server. Mandatory if IntegratedSecurity is false.
• Sourceroot: Root location of the the database SQL scripts. Defaults to install folder when not specified.
Remove-PSSDatabases cmdlets
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailed in the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Services\DbModules.config. Edit this file to change these defaults. Notes RemoveWebsites.ps1 RemoveWebsites.ps1 Script name <PSS Installation Folder>\Administration Location
Removes the Portrait HQ and PSS web applications and the application pool used to run them from IIS.
where:
• IISWebsiteThe IIS website under which the web application exists.
TheRemoveWebsites.ps1script makes use of three separate PowerShell cmdlets. If required, they can be run individually in place of the script. cmdlets
• Remove-HQWebApplication: removes the web application for the HQ website. • Remove-PSSWebApplication: removes the web application for the PSS
website.
• Remove-PSSWebAppPool: removes the app pool used by the HQ and PSS web applications.
For more information on cmdlets, typeGet-Help <cmdlet name> -Detailed in the Windows PowerShell console.
Tip:
The default values used when script parameters are omitted are read from the file %PROGRAMDATA%\Pitney Bowes Software\Portrait Shared
Services\PSSModules.config. Edit this file to change these defaults. Notes
UninstallADSServices.ps1
UninstallADSServices.ps1 Script name
<InstallationFolder>\PST\Analytics Data Server\PowerShell Scripts
Location
To uninstall the Analytics Data Server services required by Portrait Explorer. The Analytics Data Server consists of two services:
Purpose
• The Analytics Data Server service hosts the available analytics services, and • The Analytics Data Repository service allows access to the associated database.
UninstallADSServices.ps1 [-KeepLogFiles] Syntax
TheUninstallADSServices.ps1script makes use of two separate PowerShell cmdlets. If required, they can be run individually in place of the script:
cmdlets
• Remove-AnalyticsDataServerService
• Remove-AnalyticsDataRepository
You can choose to run individual cmdlets in place of the script if that is more efficient. For more information on cmdlets, type Get-Help <cmdletname> in the Windows PowerShell console.