Installation Guide
Version 5.0
©2015 Pitney Bowes Software Inc. All rights reserved.
This document may contain confidential and proprietary information belonging to Pitney Bowes Inc. and/or its subsidiaries and associated companies.
Portrait Software, the Portrait Software logo, Portrait, and Portrait Software’s Portrait brand are the trademarks of Portrait Software International Limited and may not be used or exploited in any way without the prior express written authorization of Portrait Software International Limited.
Acknowledgement of trademarks
Other product names, company names, marks, logos and symbols referenced herein may be the trademarks or registered trademarks of their registered owners.
Portrait Software Support
If you need help with something that’s not covered by this documentation, try the Knowledge Base on our web site.http://support.portraitsoftware.comand follow the links to your product.
You can also download other Portrait Software documentation from the site. If you don’t have a username and password—or you’ve forgotten them—please contact us through one of the channels below.
If you find a problem with the use, installation, or documentation of this product, please contact us using any of the following methods:
Email:[email protected] Phone
• USA/Canada 1-800-335-3860 (toll-free) • Rest of world +44 800 840 0001
When you report a problem, it helps if you can tell us: • The name of the software application
• The circumstances in which the problem arose • What error messages you saw (if any);
• The version of the software that you were using. Pitney Bowes Software Inc.
Chapter 1: Introduction...5
Purpose...6
Intended audience...6
Related documentation...6
Chapter 2: Product overview...7
About Portrait Explorer ...8
Architecture...9
Key components...9
Portrait Shared Server...9
Analytics Data Server (ADS)...10
Chapter 3: Installing Portrait Explorer...11
Installation overview...12
Installation prerequisites...12
Before you begin...13
Portrait suite compatibility...13
Installation procedures...14
Configuring your Windows servers...14
Installing Portrait Shared Server...15
Installing Analytics Data Server (ADS)...18
Enable Portrait Explorer...19
Chapter 4: Upgrading Portrait Explorer...21
Upgrading overview...22
Upgrade procedures...22
Upgrading Portrait Shared Server...22
Chapter 5: Uninstalling Portrait Explorer...27
Uninstallation overview...28
Uninstallation procedures...28
Uninstalling Portrait Shared Server...28
Preparing to uninstall ADS...28
Uninstalling Analytics Data Server (ADS)...29
Appendix...31
Advanced installation...32
Install scripts...32
Advanced uninstallation...43
Uninstall scripts...43
Portrait Shared Server silent install scripts...46
InstallPortraitHQ.ps1 ...46
ConfigurePortraitHQ.ps1...46
Additional settings and defaults...50
Portrait HQ datasheet...53
1
Introduction
In this section:
•
Purpose . . . .6
•
Intended audience . . . .6
•
Related documentation . . . .6
Purpose
This document describes how to install Portrait Explorer.
Intended audience
This guide is provided for system administrators and data analysts who need to install and integrate Portrait Explorer with existing systems.
Related documentation
Media (ZIP/DVD) and location Document
Portrait Explorer media in:
\Documentation\<language_code>\suite_installation\
Portrait Suite Installation Guide(for multi-product installations)
Portrait Explorer media in:
\Documentation\<language_code>\
Portrait Explorer Administration Guide
These documents and others can be downloaded from the Pitney Bowes Software website: http://www.pbinsight.com/support/product-documentation/p/
Note: Purpose
2
Product overview
In this section:
•
About Portrait Explorer . . . .8
•
Architecture . . . .9
•
Key components . . . .9
About Portrait Explorer
Portrait Explorer is an easy-to-use, browser-based, customer data exploration tool. It allows business users to access their customer data quickly and easily without the need for advanced analytical or statistical help.
Portrait Explorer allows for fast interactive visualization, selection and profiling of very large customer bases. It provides a unique blend of summary, aggregate and individual level information to aid customer insight, and guide you through making better decisions on targeting and treatment of a customer base. Portrait Explorer allows business users to:
• Search for customers or groups of customers across an enterprise.
• Drill down on individual customers to confirm their personal details and data.
• Use key selection criteria (e.g. age, sex, income) to expose customers and groups of customers for potential review or campaign actions.
• Segment customers via an ordered list of pre-defined selections and determine the impact of the selection priority in terms of which segment an individual customer is assigned to.
Portrait Explorer provides tooling to allow data analysts to:
• prepare the data
• prepare views on the data • monitor application performance About Portrait Explorer
Architecture
Key components
Portrait Shared Server
Portrait Shared Server consists of three key components:
• Portrait Shared Services (PSS). Provides the set of web services that allow Portrait Suite applications (Portrait Explorer, Miner, Dialogue and Interaction Optimizer) to communicate with each other. • Portrait Shared Repository (PSR). Provides the Portrait Shared Repository and Portrait Data
Warehouse databases.
• Portrait HQ. Provides a central dashboard for planning, launching and monitoring large scale (1 to 1) marketing campaigns. In addition to providing live (up-to-the-minute) summary views of your overall marketing position, Portrait HQ also provides real-time data enabling you to evaluate campaign progress and take immediate action if required.
Databases
Portrait Explorer uses the Portrait Shared Repository SQL Server database to store selections and lists created in Explorer. This database also stores the definition of the common customer data logical model that allows selections created in Explorer to be shared with other Portrait systems.
Analytics Data Server (ADS)
The Analytics Data Server is the server-side component of Portrait Explorer, acting as the primary data source for all calculations and selections performed on the customer data. The server consists of two major components, the Analytics Data Server, a set of Web Services hosted in an Apache Tomcat Web Server instance; and the Analytics Data Server Repository, the data store used to hold both customer and system data.
The Analytics Data Server provides command line tools for creating and modifying the customer data model. The data model is imported into the Portrait Shared Repository for use by Explorer and, in an integrated environment, will be merged with the data model definitions from Interaction Optimizer and Portrait Dialogue systems to create a logical data model. The merged logical data model allows users to define customer segments and utilize these definitions operationally in inbound and outbound marketing campaigns.
The Analytics Data Server and Analytics Data Repository components can be installed on the same physical server as the Portrait Shared Services, although we generally recommend installation onto a separate server for performance reasons.
ADS service
The Analytics Data Server web services provide SOAP based web services to provide access to analytics query services, metadata query and management services and performance monitoring services. The services are hosted in an Apache Tomcat Application Server running as a Windows Service.
Analytics Data Repository
The Analytics Data Repository is an instance of a custom MonetDB database engine running as a Windows Service. The Analytics Data Repository is used to store both the customer data displayed to users in Explorer to view and select their customers and as a storage space for metadata definitions and caching of operational data for Explorer. In order to maximize system performance, it is recommended that the Analytics Data Repository and the ADS services are hosted on the same physical machine and not hosted on the same server as the PSR/PSS.
3
Installing Portrait Explorer
In this section:
•
Installation overview . . . .12
•
Installation prerequisites . . . .12
•
Before you begin . . . .13
•
Portrait suite compatibility . . . .13
Installation overview
To install Portrait Explorer for the first time, complete the procedures listed below. If upgrading to a new version of Explorer seeUpgrading overviewon page 22.
Time estimate Installation procedure
30 minutes Configuring your servers
30 minutes Installing Portrait Shared Serveron page 15
30 minutes Configuring Portrait Shared Server
20 minutes Installing Analytics Data Server (ADS)on page 18
10 minutes Configuring Analytics Data Server (ADS)on page 19
Installation prerequisites
The Portrait Explorer installation procedures assume that the following software has been installed.
Software level Software
Server
Portrait Explorer can be installed onanyof the following: Microsoft Windows
Server All servers
• Standard and Datacenter Editions of Windows Server 2012 •
Microsoft.Net Framework All servers
• v4.5 on all servers, and
IIS Web server
• v8.0 on Windows Server 2012 • v8.5 on Windows Server 2012 R2
2012 SP1 and 2014, for Standard and Enterprise Editions and either case-sensitive or case-insensitive master databases.Note:The following features must be installed: Microsoft SQL
Server Database server
• Database Engine Services • Management Tools - Basic • Management Tools - Complete • Client Tools Connectivity
v1.7 64-bit Java Runtime Environment Analytics Data Server Installation overview
Software level Software
Client
v5.0 Microsoft Silverlight All clients
Before you begin
Before starting the installation, you need to:
1. Source all required software and associated documentation.
Media location (ZIP file/DVD) Software + documentation
Portrait Explorer media in:\Portrait Shared Server\ Portrait Shared Server
Portrait Explorer media in:\ADS\ Analytics Data Server
Portrait Explorer media in:\Documentation\ Portrait Explorer Installation Guide (this
guide)
2. Collect all information required to configure the installation. The information required is listed in the installation datasheet in the Appendix.
Installation considerations:
• When running the Portrait Shared Server installer, select the Custom Setup Type and install only the Database AdministrationandPortrait Shared Serverfeatures. (The other features are not required for Portrait Explorer.)
• It is recommended that you use the same account to run the HQ and PSS application pool as that used by the PSS to connect to the Portrait Shared Repository database. This account should be on a network domain, rather than a local machine.
Portrait suite compatibility
Portrait Explorer is compatible with the following Portrait Software.
Software level Software
5.0 Update 1 Portrait Foundation
7.0B Portrait Miner
6.1 Portrait Dialogue
5.6 Interaction Optimizer
The installation part of this guide takes you through installing Portrait Explorer as a standalone application. If you want to install or integrate Portrait Explorer with other Portrait Software applications, see thePortrait Suite Installation Guide.
Note:
Installation procedures
Configuring your Windows servers
Configuring your application servers
Windows Server 2012
Use the following procedure to configure your application server roles, role services and features. If you have multiple application servers, you need to repeat the procedures on all machines.
1. Log on to your Windows Server 2012 machine.
2. On the Windows 2012Startscreen, clickServer Manager.
3. On the Server ManagerDashboard, clickManagefrom the top right menu to open theAdd Roles and Featureswizard.
4. ClickNextand ensureRole-based or Feature-based installationis selected. 5. ClickNextand select all servers you want to configure.
6. ClickNextand ensure the roleApplication Serverhas been installed. If not, check the box. 7. Open the Application Server sub-section, and ensure the following services have been enabled. If
not, check the relevant items. • Web Server (IIS) Support • TCP Port Sharing
• Windows Process Activation Service Support • HTTP Activation
• Message Queuing Activation • TCP Activation
• Named Pipes Activation • COM+ Network Access
8. ClickNexttwice and thenInstall. If all items have already been set up, close the wizard.
Configuring your web servers
Windows Server 2012
Use the following procedure to configure your web server roles, role services and features. If you have multiple web servers, you need to repeat the procedures on all machines.
1. Log on to your Windows Server 2012 machine.
2. On the Windows 2012Startscreen, clickServer Manager. Installation procedures
3. On the Server ManagerDashboard, clickManagefrom the top right menu to open theAdd Roles and Featureswizard.
4. ClickNextand ensureRole-based or Feature-based installationis selected. 5. ClickNextand select all servers you want to configure.
6. ClickNextand ensure the roleWeb Server (IIS)has been installed. If not, check the box.
7. Open the Web Server (IIS) sub-section, and ensure the following services have been enabled. If not, check the relevant items.
• Management Tools
• IIS 6 Management Compatibility • IIS 6 Metabase Compatibility • IIS 6 WMI Compatibility • IIS 6 Scripting Tools • IIS 6 Management Console • Windows Authentication • ASP.NET 3.5
• ASP.NET 4.5
8. ClickNextand ensure the featureMessage Queueinghas been enabled. If not, add it. 9. ClickNextand thenInstall. If all items have already been set up, close the wizard.
Verifying the SQL agent service is running
Use this procedure to verify the SQL agent service is running.
1. Log on to your SQL Server machine.
2. ClickStart>All Programs>Microsoft SQL Server>SQL Server Management Studio. 3. Connect to the instance of the Database Engine as a database user (requiressysadminrole). In the
Object Explorerwindow, right-clickSQL Server Agent (Agent XPs disabled)and selectStart.
Verifying Names Pipes and TCP/IP protocols are enabled
Use the following procedure to ensure that SQL Server is enabled to accept TCP/IP connections on port 1433. You can do this using SQL Server Configuration Manager.
1. On your SQL Server machine, openSQL Server Configuration Managerand, in the left pane, expandSQL Native Client Configurationand selectClient Protocols.
2. In the right pane, check ifNamed Pipes and TCP/IPare enabled. If not, right-click them and select Enable. When the warning tells you to restart, clickOK.
Installing Portrait Shared Server
Installing PSS features
The Portrait Shared Server installer can install any of the following features:
• Portrait Shared Server. Provides the HQ web application and the Portrait Shared Services web services that integrate the Portrait product suite.
• Database Administration. Enables administration of the databases used by Portrait Shared Server. Install this feature on the SQL Server database server.
• Data Warehouse Refresh. Provides the SQL Server Integration Services packages that populate the Portrait Data Warehouse. Install this feature on the Integration Services server.
• Reports. Provides SQL Server Reporting Services reports that report on campaign performance. Install this feature on the Reporting Services server.
• Tasks. Provides a SharePoint site that manages tasks created when working with campaigns. Install this feature on the SharePoint server.
To install any of these features:
1. Log on to the server where Portrait Shared Server feature(s) are to be installed.
2. Open File Explorer and navigate toPortrait Shared Serveron the release media (.iso). 3. Right-click setup.exe and clickRun as administrator.
4. ClickNexton theWelcomepage.
5. Accept the license terms and conditions and clickNext. 6. Accept the default destination folder and clickNext.
7. Choose the installation type and clickNext. When installing the full set of Portrait Shared Server features, clickComplete, otherwise clickCustom.
8. On theCustom Setupscreen (shown if a custom installation type was selected in the previous step), selectThis feature will be installed on local hard drivefor the features you wish to install. Select This feature will be not be availablefor features you do not wish to install. ClickNext.
9. ClickInstallon theReady to Install the Programdialog. 10.On theInstallShield Wizard Completedscreen, clickFinish.
Creating the PSS databases
The PSS has a dependency on the Portrait Shared Repository and Portrait Data Warehouse databases that must be created following the install. These databases are created using the steps shown below:
1. Run the Windows PowerShell application as Administrator and navigate to the PowerShell scripts directory of the installation.
By default this is found at:
C:\Program Files (x86)\PST\Portrait Shared Server\Administration\ 2. Run the PowerShell scriptCreatePortraitDatabases.ps1
The script takes the following parameters:
• -DWDatabaseName
The name given to the Portrait Data Warehouse database [defaults to PortraitDW]
• -PSRDatabaseName
The name given to the Portrait Shared Repository database [defaults to PortraitPSR]
• -DBAccessUsername
The name of the user account that will be used to access the databases by the web applications (this should generally be the same Windows account as the Application Pool user used in the SetupWebsites script). This login must already exist in the SQL Server database
• -IntegratedSecurity
Flag used to indicate whether the user running the script is the user account used to connect to the database server or not. If set to TRUE, the user account used to run the PowerShell script must have rights to create databases on the target SQL Server
• -DBUsername
The name of the SQL Server account to connect to the database server and create the databases (only required if IntegratedSercurity is FALSE)
• -DBPassword
The password for the SQL Server account to connect to the database server and create the databases (only required if IntegratedSercurity is FALSE)
• -DBServerName
The name of the SQL Server on which the databases are to be created • -Sourceroot
The path to the database creation scripts (only required if not installed to the default location)
Example:
>CreatePortraitDatabases.ps1 -DBAccessUsername MyDomain\AppPoolUser -DBServerName MYSERVER\MSSQLSERVER
3. Confirm the databases have been created by connecting to the target database server using SQL Server Management Studio and confirm the databases are present and the specified user account is a valid user of the new databases
Creating the PSS web sites
The Portrait Shared Server comprises of two web applications. Both of these application containers must be created before the Portrait HQ can be accessed. A PowerShell script is provided to allow the web applications to be created and the application pool for the new web applications created and assigned.
1. Log onto the application server with an account that has permission to create databases on the target SQL server database server.
2. Run the Windows PowerShell application as Administrator and navigate to the PowerShell scripts directory of the installation.
By default this is found at:
C:\Program Files (x86)\PST\Portrait Shared Server\Administration\ 3. Run the PowerShell scriptSetupWebsites.ps1
The script takes the following parameters:
• -PSSWebAppPoolAccountDomain
The Windows Active Directory domain for the IIS application pool user account
• -PSSWebAppPoolAccountName
The username for the application pool identity
• -PSSWebAppPoolAccountPassword
• -IISWebsite
The IIS website to which web applications will be installed [defaults to Default Web Site]
• -HQWebApplicationPhysicalPath
The path for the HQ web application (only required when installed to a non-default location) [defaults
toC:\Program Files (x86)\PST\Portrait Shared Server\MarketingHQ]
• -PSSWebApplicationPhysicalPath
The path for the PSS web application (only required when installed to a non-default location) [defaults toC:\Program Files (x86)\PST\Portrait Shared Server\Portrait Shared Services]
Example:
>SetupWebsites.ps1 -PSSWebAppPoolAccountDomain MyDomain
-PSSWebAppPoolAccountName AppPoolUser -PSSWebAppPoolAccountPassword password
4. Confirm the web applications have been installed successfully by starting up a web browser navigating to the URL of the PSS analytics web services URL.
The default location from the application server is
http://localhost/PortraitSharedServices/AnalyticsServices.svc
Installing Analytics Data Server (ADS)
The Analytics Data Server installer is included in the installation media at: .\Analytics Data Server
Running the Analytics Data Server (ADS) installer
The Analytics Data Server consists of two distinct components, both of which are installed (but not configured) by the installersetup.exefile located in the installation media. The Analytics Data Server is an Apache Tomcat web server that hosts the web services used by Explorer. The Analytics Data Repository is the database engine component that is used to store and query the customer data that is displayed in Explorer. Neither of the two services will be ready for use before the configuration step has been run.
1. Run thesetup.exein the\Analytics Data Serverdirectory on your installation media (.iso). Ensure you right-click thesetup.exeand selectRun as Administrator.
2. Select the display language for your installation
3. If not present, InstallShield will identify missing pre-requisite software and will attempt to install them. Press theInstallbutton to continue with the installation of the required components.
4. ClickNexton theWelcomedialog.
5. Accept the license agreement and clickNext.
6. Choose the install location (the default isC:\Program Files\PST\Analytics Data Server\) and clickNext.
7. Under theReady to Install the Program, click onInstall.
During the installation theInstalling Analytics Data Serverpage shows a progress indicator. 8. On the final page, clickFinishto exit the wizard.
Configuring Analytics Data Server (ADS)
In order to create the two new Windows services that form the Analytics Data Server, the services need to be configured. The configuration is performed using PowerShell scripts that are installed by the InstallShield installer. A single Setup script is supplied that allows the user to configure the most common parameters for the services. Additional scripts are available for more advanced configuration tasks. The advanced configuration scripts are detailed in the Appendices of this document.
1. Launch the PowerShell command prompt window (running the process as Administrator).
2. Navigate to thePowerShell Scriptsdirectory of the Analytics Data Server installation (typically C:\Program Files\PST\Analytics Data Server\PowerShell Scripts)
3. At the command prompt run theSetupscript (the following parameters are optional):
• -ADRPort
The TCP port that the analytics Data Repository will listen on [default value is 50000] • -DBFarmPath
The file location on the server that the Analytics Data Repository will store it's data files [defaults
to theC:\Program Files\PST\Analytics Data Server\MonetDB\dbfarm]
• -ADSPort
The TCP port for accessing the web services [default value is 8080]
Example:
>Setup -ADRPort 40000 -DBFarmPath 'C:\Program Files\PST\Analytics Data Server\DBFarm\' -ADSPort 8888
See thePortrait Explorer Administration Guidefor instructions on to describe the customer data you wish to explore (setting up metadata), plus how to load customer data into Explorer.
Enable Portrait Explorer
In order to enable the Explorer application within the HQ, the PSS must be configured to enable Explorer and the location of the ADS services must be specified.
1. Run the Windows PowerShell application as Administrator and navigate to the PowerShell scripts directory of the installation.
By default this is found at:
C:\Program Files (x86)\PST\Portrait Shared Server\Administration\ 2. Run the PowerShell scriptExplorerIntgration.ps1
The script takes the following parameters:
• -PSSUserAcountName
The user name for connecting to Portrait Shared Services
• -PSSUserAcountPassword
The password for the user account
Flag to indicate whether to enable or disable Explorer
• -ExplorerAnalyticsDataServerURL
The Analytics Data Server web services URL
Example:
>ExplorerIntegration.ps1 -PSSUserAcountName MyDomain\ExplorerUser -PSSUserAcountPassword password -ExplorerIntegrationEnabled TRUE
-ExplorerAnalyticsDataServerURL http://ADSSERVER:8080/analytics-data-server Enable Portrait Explorer
4
Upgrading Portrait Explorer
In this section:
•
Upgrading overview . . . .22
•
Upgrade procedures . . . .22
Upgrading overview
To upgrade Portrait Explorer, complete the procedures listed below.
Time estimate Upgrade procedure
10 minutes Upgrading Portrait Shared Serveron page 22
10 minutes Upgrading Analytics Data Server (ADS)on page 26
Upgrade procedures
Upgrading Portrait Shared Server
The introduction of the Analytics Data Server in this release of Explorer affects:
• Reports. As the Excel reports generated from Explorer relied on the use of Datasets, all reports will now no longer be valid and will not be capable of being refreshed once the upgrade has been completed. Any report templates stored in the Portrait Shared Repository will need to be manually deleted once the upgrade has been completed.
• Card Visualizations. Customer card visualizations may no longer be valid due to the changes to allow Explorer to work with its own database. The cards may need to be re-created depending upon the nature of the card.
Uninstalling Portrait HQ components
Use the following procedure to uninstall your Portrait Shared Server (PSS) component. 1. Log on to your Portrait Shared Server machine.
2. Back up configuration files that you have modified since the original installation. The configuration files that you may have modified include:
• C:\Program Files (x86)\PST\Portrait Shared Server\Marketing HQ\web.config
• C:\Program Files (x86)\PST\Portrait Shared Server\Portrait Shared
Services\web.config
• C:\Program Files (x86)\PST\Portrait Shared Server\Portrait Shared
Services\bin\config\Portrait.Mas.Cms.Services.Authorization.config
• C:\Program Files (x86)\PST\Portrait Shared Server\Portrait Shared
Services\bin\config\Portrait.Mas.Cms.Services.IO.configfor version 5.5
• C:\Program Files (x86)\PST\Portrait Shared
Server\SSIS\DWPopulate.dtsConfig 3. ClickStart>Control Panel>Uninstall a program.
4. SelectPortrait Shared Serverand follow the wizard prompts to uninstall the Portrait Shared Server. Upgrading overview
Installing PSS features
The Portrait Shared Server installer can install any of the following features:
• Portrait Shared Server. Provides the HQ web application and the Portrait Shared Services web services that integrate the Portrait product suite.
• Database Administration. Enables administration of the databases used by Portrait Shared Server. Install this feature on the SQL Server database server.
• Data Warehouse Refresh. Provides the SQL Server Integration Services packages that populate the Portrait Data Warehouse. Install this feature on the Integration Services server.
• Reports. Provides SQL Server Reporting Services reports that report on campaign performance. Install this feature on the Reporting Services server.
• Tasks. Provides a SharePoint site that manages tasks created when working with campaigns. Install this feature on the SharePoint server.
To install any of these features:
1. Log on to the server where Portrait Shared Server feature(s) are to be installed.
2. Open File Explorer and navigate toPortrait Shared Serveron the release media (.iso). 3. Right-click setup.exe and clickRun as administrator.
4. ClickNexton theWelcomepage.
5. Accept the license terms and conditions and clickNext. 6. Accept the default destination folder and clickNext.
7. Choose the installation type and clickNext. When installing the full set of Portrait Shared Server features, clickComplete, otherwise clickCustom.
8. On theCustom Setupscreen (shown if a custom installation type was selected in the previous step), selectThis feature will be installed on local hard drivefor the features you wish to install. Select This feature will be not be availablefor features you do not wish to install. ClickNext.
9. ClickInstallon theReady to Install the Programdialog. 10.On theInstallShield Wizard Completedscreen, clickFinish.
Review Portrait Shared Server AppPool settings
This release of the Portrait Shared Server implements session management within the dedicated Portrait Shared Server AppPool worker process. It is necessary to manage the way IIS recycles the AppPool worker process to ensure that user sessions do not encounter unexpected errors. It is recommended that AppPool recycling is configured to occur once a day during quiet periods e.g. at 1 a.m. to cause as little disruption as possible.
To configure Portrait Shared Server AppPool recycling as recommended above:
a) Open a Powershell prompt with elevated permissions and enter the following commands: b) Clear-ItemProperty ("IIS:\AppPools\Portrait Shared Server AppPool")
-Name recycling.periodicRestart.schedule
c) New-ItemProperty ("IIS:\AppPools\Portrait Shared Server AppPool") -Name recycling.periodicRestart.schedule -Value ( [TimeSpan]::FromHours(1)) d) Set-ItemProperty ("IIS:\AppPools\Portrait Shared Server AppPool") -Name
e) Set-ItemProperty ("IIS:\AppPools\Portrait Shared Server AppPool") -Name processModel.idleTimeout -Value ( [TimeSpan]::FromHours(24))
Review custom PSS settings
It is necessary to identify which PSS settings have been changed in your environment, so that the same values can be re-applied to the upgraded installation. The table below summarizes all settings you may have changed.
Default Value Identifier in config
file Property Name
Config File Name
EN UICulture UI Culture HQ Web.config EN Culture Culture HQ Web.config False CampaignApprovalEnabled CampaignApprovalEnabled HQ Web.config Verbose LogLevel LogLevel HQ Web.config False ShowReportsLink ReportIntegrationEnabled HQ Web.config http://localhost/ReportServer ReportsUri ReportServerURL HQ Web.config False AnalyticsIntegrationEnabled AnalyticsIntegrationEnabled PSS Web.config http://localhost:8080/analytics-data-server Endpoint url section
AnalyticsDataServerURL PSS Web.config False DialogueIntegrationEnabled DialogueIntegrationEnabled PSS Web.config http://localhost/MHDialogServerAPI Endpoint url section
DialogueServerURL PSS Web.config Default PCM.InstanceName DialogueInstanceName PSS Web.config False IOIntegrationEnabled IOIntegrationEnabled PSS Web.config http:\\localhost Endpoint url section
IOServerURL PSS Web.config False SharePointIntegrationEnabled SharePointIntegrationEnabled PSS Web.config None Endpoint url section SharePointServerURL PSS Web.config Provider=SQLNCLI11;Data Source=LOCALHOST;Integrated DW_ConnectionString DWPopulate.dtsConfig Security=SSPI;Initial Catalog=PortraitDW . InstallationDirectory DWPopulate.dtsConfig 2000 IO_BatchCopySize DWPopulate.dtsConfig Provider=SQLNCLI11;Data Source=localhost;Integrated IO_ConnectionString DWPopulate.dtsConfig Security=SSPI;Initial Catalog=PortraitIO 2000 IO_MinSourceHistoryRows DWPopulate.dtsConfig
Default Value Identifier in config
file Property Name
Config File Name
1 IO_Present DWPopulate.dtsConfig Provider=OraOLEDB.Oracle;Data Source=[data PD_ConnectionString DWPopulate.dtsConfig source];Password=[password];User ID=[User id] Data Source=localhost;Initial Catalog=PDSystemReportSampleData1;Provider=SQLNCLI11;Integrated Security=SSPI; PD_SQL_ConnectionString DWPopulate.dtsConfig 0 PD_IsOracle DWPopulate.dtsConfig 0 PD_Present DWPopulate.dtsConfig Data Source=[Data source];Persist Security PDADO_ConnectionString DWPopulate.dtsConfig Info=True;User ID=[User ID];Password=[password];Unicode=True Provider=SQLNCLI11;Data Source=LOCALHOST;Integrated PSR_ConnectionString DWPopulate.dtsConfig Security=SSPI;Initial Catalog=PortraitPSR 0 TransferOnly DWPopulate.dtsConfig
Take note of any setting value that differs from the default.
Configuring PSS features
1. Log on to the application server.
2. RunPortrait Powershellas an administrator.
3. Run commandcd "C:\Program Files (x86)\PST\Portrait Shared Server\Administration"
4. Run commandCreatePortraitDatabases.ps1with existing PSR and PDW database names to upgrade the databases. SeeCreatePortraitDatabases.ps1on page 33 for a description of the arguments to this script.
5. Run commandSetPSSDatabaseConnections.ps1. See SetPSSDatabaseConnections.ps1
on page 39 for a description of the arguments to this script.
6. Run commandSetupWebsites.ps1. SeeSetupWebsites.ps1on page 40 for a description of the arguments to this script.
Reapply custom PSS settings
To re-apply the Portrait Shared Server custom settings you identified inReview custom PSS settings on page 24:
1. Go toC:\Program Files (x86)\PST\Portrait Shared Server\Portrait Shared Services\bin\configand copy file
Portrait.Mas.Cms.Services.Authorization.config.templateand
Portrait.Mas.Cms.Services.IO.config.templateand paste at%PROGRAMDATA%\Pitney Bowes Software\Portrait Shared Services. Delete the.templateextension of both files. 2. If you have custom settings for field segmentations, field exclusions, external field look-ups or
secondary audiences (inPortrait.Mas.Cms.Services.IO.config), then this configuration needs to be applied to the file%PROGRAMDATA%\Pitney Bowes Software\Portrait Shared Services\Portrait.Mas.Cms.Services.IO.config.
3. If you have custom settings for elementsDomain,DomainGroupRoleMappings,RolePermissions andOperationPermissions(inPortrait.Mas.Cms.Services.Authorization.config), then this configuration needs to be applied to the file%PROGRAMDATA%\Pitney Bowes
Software\Portrait Shared
Services\Portrait.Mas.Cms.Services.Authorization.config.
4. If you have any custom HQ settings for logging levels, Campaign Approval or display language, then run scriptAdminSettings.ps1to apply your settings. SeeAdminSettings.ps1on page 32 for a details on how to run this script.
5. If you have a custom ReportIntegrationEnabled setting, run scriptReportIntegration.ps1to apply your setting. SeeReportIntegration.ps1on page 38 for a details on how to run this script. 6. If you have custom configuration for the AnalyticsIntegrationEnabled setting, run script
ExplorerIntegration.ps1to apply your setting. SeeExplorerIntegration.ps1on page 35 for a details on how to run this script.
7. If you have custom configuration for the PDIntegrationEnabled setting, run script
DialogueIntegration.ps1to apply your setting. SeeDialogueIntegration.ps1on page 34 for a details on how to run this script.
8. If you have custom configuration for the IOIntegrationEnabled setting, run scriptIOIntegration.ps1 to apply your setting. SeeIOIntegration.ps1on page 37 for a details on how to run this script. 9. If you have custom configuration for the SharePointIntegrationEnabled setting, run script
SharepointIntegration.ps1to apply your setting. SeeSharepointIntegration.ps1on page 41 for a details on how to run this script.
Upgrading Analytics Data Server (ADS)
As the Analytics Data Server is a new component in Explorer 5.0, there are no upgrade instructions for this component. It is recommended that as part of an upgrade of Explorer, that the existing PAWS component is uninstalled from the system. As the new ADS does not use PAWS datasets, any datasets that are to be kept should be copied from the PAWS repository before uninstalling.
1. Copy any required datasets from the PAWS repository (default locationC:\Program Files (x86)\PST\PAWS\ext\PAWS\Repository)
2. Open the Windows Control Panel 3. Navigate to the Programs section 4. SelectUninstall a programlink
5. Right click on thePortrait Analytics Web Servicesentry in the list of installed programs and select Uninstallfrom the menu
6. Follow the procedures inInstalling Portrait Explorerto install the Analytics Data Server. Upgrading Analytics Data Server (ADS)
5
Uninstalling Portrait
Explorer
In this section:
•
Uninstallation overview . . . .28
•
Uninstallation procedures . . . .28
Uninstallation overview
To uninstall Portrait Explorer, complete the procedures listed below.
Time estimate Uninstallation procedure
10 minutes Uninstalling Portrait Shared Serveron page 28
10 minutes Uninstalling Analytics Data Server (ADS)on page 29
Uninstallation procedures
Uninstalling Portrait Shared Server
Removal of Portrait Shared Server will remove both the HQ and the Portrait Shared Services web applications from the web server, as well as the Portrait Shared Repositoryand Portrait Data Warehouse databases from the database server.
Portrait Shared Server is a component that is shared by Portrait products. It should only be uninstalled when removingallPortrait products.
Caution:
To remove Portrait Shared Server:
1. Log on to the web server.
2. Run applicationPortrait Powershellas an administrator.
3. Run commandRemoveWebsites.ps1. SeeRemoveWebsites.ps1on page 44 for a description of the parameters to this script.
4. Run commandRemoveDatabases.ps1. SeeRemovePortraitDatabases.ps1on page 44 for a description of the parameters to this script.
5. Open the Programs and Features application. Right-clickPortrait Shared Serverin the list of installed programs and clickUninstall.
Preparing to uninstall ADS
Before uninstalling the Analytics Data Server component, the following steps should be followed.
1. Ensure that the Explorer instance that was using the ADS install has been disabled. This requires that the PSS configuration settings have been updated to ensure that Explorer has been removed and is no longer accessible.
2. Run theUninstallADSServicesPowerShell script from thePowerShell Scriptsdirectory of the Analytics Data Server installation. NOTE: This script should be run automatically by the uninstaller. Uninstallation overview
Uninstalling Analytics Data Server (ADS)
It is recommended that the ADS is uninstalled using thePrograms and Featurescontrol panel in Windows
1. In thePrograms and Featurescontrol panel, click on the line containing Analytics Data Server to highlight the program.
Appendix
In this section:
•
Advanced installation . . . .32
•
Advanced uninstallation . . . .43
•
Portrait Shared Server silent install scripts . . . .46
•
Portrait HQ datasheet . . . .53
•
Explorer Acknowledgments . . . .54
Advanced installation
Install scripts
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.
Portrait Shared Server silent install scripts
InstallPortraitHQ.ps1
The/Silent Install Samples/PSS/InstallPortraitHQ.ps1script on the release media (.iso) silently installs the Portrait Shared Server software on a web server.
Syntax:
InstallPortraitHQ.ps1 [-UICulture <string>] -InstallLocation <string> [-FeatureList <string>] [-InstallDirectory <string>]
Description Parameter
The language used when reporting installation errors. Must be set toEN. -UICulture
Path to the Portrait Shared Server installer within the release media (.iso). For example,F:\Portrait Shared Server.
-InstallLocation
Comma-separated list of Portrait Shared Server features to install. Any combination ofCommon,DBAdministration,DataWarehouseRefresh andPortraitSharedServices. Defaults toALL.
-FeatureList
Path to install Portrait Shared Server to. Defaults toC:\Program Files (x86)\PST\Portrait Shared Server\
-InstallDirectory
ConfigurePortraitHQ.ps1
The/Silent Install Samples/PSS/ConfigurePortraitHQ.ps1script on the release media (.iso) silently configures Portrait Shared Server. This script can be used for the following administration tasks:
• Creating or upgrading the Portrait Shared Repository and Portrait Data Warehouse databases. • Configuring Portrait Shared Server's connection to the database server.
• Creating the HQ and PSS web applications.
• Enabling or disabling IO, PD or PE capabilities within the HQ. • Creating a SharePoint site to hold HQ tasks.
• Enabling or disabling task support within the HQ. • Deploying SSRS reports to a Report Server
• Adding or removing links to view reports from the HQ. • Enabling or disabling campaign approval in the HQ.
A single execution ofConfigurePortraitHQ.ps1can perform all of these tasks, or run
ConfigurePortraitHQ.ps1multiple times to perform any subset of the tasks on each execution. Syntax: