Mail360 Data Manager v3.1.0 Install Admin Guide

MAIL360 Data Manager v3.1.0 Installation and Administration GuideRelease 3.1.0 Installation and Administration Guide
Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its representatives. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, without the written permission of Pitney Bowes Software Inc., One Global View, Troy, New York 12180-8399.
© 2009 - 2016 Pitney Bowes Software
All rights reserved. Group 1 and the Group 1 logo are registered trademarks of Pitney Bowes Software. Pitney Bowes and “Engineering the flow of communication” are registered trademarks of Pitney Bowes, Inc. All other marks are trademarks or registered trademarks of their respective owners.
Pitney Bowes Software holds a non-exclusive license to publish and sell ZIP + 4® databases on optical and magnetic media.
The following trademarks are owned by the United States Postal Service®: CASS, CASS Certified, DPV, eLOT, FASTforward, First-Class Mail, Intelligent Mail, LACSLink, NCOALink, PAVE, PLANET Code, Postal Service, POSTNET, Post Office, RDI, SuiteLink, United States Postal Service, Standard Mail, United States Post Office, USPS, ZIP Code, and ZIP + 4. This list is not exhaustive of the trademarks belonging to the Postal Service.
Pitney Bowes Software is a non-exclusive licensee of USPS® for NCOALink® processing.
Prices for Pitney Bowes Software products, options and services are not established, controlled or approved by USPS® or United States Government. When utilizing RDI™ data to determine parcel-shipping costs, the business decision on which parcel delivery company to use is not made by the USPS® or United States Government.
Do you have a product idea? Go to pbinsight.force.com/pbideas and select your product on the left side of the page.
Pitney Bowes Software Documentation Team [email protected]
One Global View Troy, New York 12180-8371 www.pbinsight.com [email protected] or http://go.pbinsight.com/online-case-management Support: +1 (800) 367.6950 Sales: +1 (800) 327.8627
www.pb.com/software/
Canada: Phone: +1 (416) 594.5200 Fax: +1 (416) 594.5201
Technical Support: +1 (518) 285.7283 Technical Support Fax: +1 (518) 285.6080 www.pitneybowes.ca/software/
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Software Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Physical Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
Data Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
System Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
SMTP Server and E-mail Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Information You Will Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
Pre-Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services. . . . . . . . . . . 19
Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Post-Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Uninstalling via the Uninstall Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Uninstalling via the Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Configuring Your Data Manager Hub Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Entering Your Subscriber ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Importing and Configuring Your Unique Identity Certificate . . . . . . . . . . . . . . . . . . . . . .42
Importing the Hub Identity Certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Release 3.0.1 1 MAIL360 Data Manager™ Install & Admin Guide
Table of Contents
Renewing SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Chapter 3: Setting Up the MAIL360 Data ManagerTM Databases . . . . . . . . . . . . 45
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Partition Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Creating the Data Manager Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Upgrading the Data Manager Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Creating the Client Bus Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Upgrading the Client Bus Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Command Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Configuring SQL Server Reporting Services (SSRS) Security . . . . . . . . . . . . . . . . . . .54
Setting Up Database Clustering & Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
MAIL360 AlwaysOn Availability Groups Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Setting Up MAIL360 AlwaysOn Availability Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Chapter 4: Installing the MAIL360 Data ManagerTM User Interface (UI) . . . . . . . 81
System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
Pre-Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82
applicationHost Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83
Post-Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92
Uninstalling via Your Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
Uninstalling via the Uninstall Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
Importing and Configuring SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Chapter 5: Configuring MAIL360 Data ManagerTM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Configuring Production Tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
Configuring the MAIL360 Report Manager and Scheduler . . . . . . . . . . . . . . . . . . . . .103
Configuring the MAIL360 Report Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
Table of Contents
Configuring the Diagnostic Utility Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
Setting the Polling Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
Configuring the Diagnostic Utility UI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
Importing and Configuring SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
Configuring MAIL360 for OpenDJ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Integrating with EngageOne™ Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
About Vault. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Retrieving Mailpiece Tracking Content from Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
Sample File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
Setting Permissions for MAIL360 Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Setting the Logging Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Applying Access/License Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Obtain License Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Chapter 6: Installing and Configuring OpenAM and OpenDJ . . . . . . . . . . . . . . 127
Why OpenAM?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Environment Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Physical Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Installing and Configuring OpenAM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Preparing Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
Configuring OpenAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Creating Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137
Creating Authentication Chain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
Adding Certificates into OpenAM Server KeyStore . . . . . . . . . . . . . . . . . . . . . . . . . . .149
Configuring Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
Table of Contents
Configuring DNS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
Creating the Organizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
Providing Password Reset Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
Configuring Settings for OpenDJ REST Services . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
Configuring httpConfig.json Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Configuring Additional Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180
Chapter 7: Installing the MAIL360 Identity ServerTM Web UI. . . . . . . . . . . . . . . 183
System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
Post-Installation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191
Repairing MAIL360 Identity Server Web UI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Uninstalling the MAIL360 Identity Server Web UI . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
Uninstalling via Your Control Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
Uninstalling via the Uninstall Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
Chapter 8: MAIL360 Data ManagerTM Security . . . . . . . . . . . . . . . . . . . . . . . . . . 195
MAIL360 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196
Authenticating MAIL360 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
Computing the Client Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201
Invoking MAIL360 Web Services with the Access Token . . . . . . . . . . . . . . . . . . . . . .202
Appendix A: MAIL360 Data ManagerTM Configuration Settings . . . . . . . . . . . . 203
About the Data Manager Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
DataManager.config.xml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
ClientBus.config.xml. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
InputFileSources.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
IdentityProviders.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
Local Windows Identity Provider Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
Active Directory Identity Provider Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
machine.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212
Table of Contents
Windows Server 2012 R2 Failover Cluster Installation . . . . . . . . . . . . . . . . . . . . . . . .214
How to Upgrade Databases in Clustered Environment . . . . . . . . . . . . . . . . . . . . . . . .223
References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
Data Manager UI Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232
Not able to log in Data Manager or Identity Server Web UI . . . . . . . . . . . . . . . . . . . . .232
User not able to see login screens of the Web UIs . . . . . . . . . . . . . . . . . . . . . . . . . . .232
Data Manager Services Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
User not able to start the Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
Data Manager Database Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233
BCP Format Error While Running Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . .233
OpenAM Login Issue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
403 - Forbidden Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234
OpenDJ Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Clickjacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Implication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Fix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Table of Contents
1
Installation
In this chapter:
Planning For the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Software Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Physical Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Databases Hosted on the Microsoft® SQL Server . . . . . . . . . . 8 Data Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Installation and Configuration Overview . . . . . . . . . . . . . . . . . . . 10 System Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Deployment Environment Prerequisites . . . . . . . . . . . . . . . . . . . 12
MAIL360 Service Account . . . . . . . . . . . . . . . . . . . . . . . . . 12 Administrative Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . 12 X.509 SSL Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Internet Access for MAIL360 Data Manager Web services . . . 12 SMTP Server and E-mail Accounts . . . . . . . . . . . . . . . . . . . 13
Information You Will Need . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Pre-Installation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Planning For the Installation
Planning For the Installation
This section will explain the deployable components of MAIL360 Data Manager. The system includes a number of moving parts. However, the complexity buys you flexibility: you can distribute processing load and tailor system interactions according to your specific needs.
Software Applications
Component Name Description
Data Manager Application Services Web services and back-end processes for Data Manager
Data Manager User Interface Web application user interface for Data Manager
Identity Server User Interface Web application user interface for Identity Manager
Physical Servers
Application Server This box runs the Data Manager application.
Database Server This box hosts Microsoft® SQL Server® 2012 Enterprise Edition.
Reporting Server This box hosts SQL Server Reporting Services 2012 (SSRS). You may use the Application Server, a Database Server, or a third machine for this role, provided, Microsoft® SQL Server® 2012 Enterprise Edition including Reporting Services is up and running on that machine.
It is recommended to host the MAIL360 Data Manager database and application on separate servers. The Reporting server may often be co-located with the Database server.
Databases Hosted on the Microsoft® SQL Server
Database Name Description
Data Manager Main Data Manager application database, including identity management and report deployment data
Chapter 1: Preparing for MAIL360 Data ManagerTM Installation Planning For the Installation
Data Directories
These directories will be created by the Data Manager Application Services installer. You need to plan storage capacity, and decide where to put them.
Directory Description
bus-repository Stores compressed copies of all bus message attachments (job files). Typically, jobs compress about 2-5% of their original size.
jobs-hotfolder Hotfolder for the job files to be submitted to Data Manager for processing
mrdf-hotfolder Hotfolder for the MRDF files to be submitted to Data Manager for processing
mpdf-hotfolder Hotfolder for the MPDF files to be submitted to Data Manager for processing.
jobs-archive Houses job files as they are ingested by Data Manager
mrdf-archive Houses MRDF files as they are ingested by Data Manager
mpdf-archive Houses MPDFfiles as they are ingested by Data Manager
NOTE: jobs-archive, mrdf-archive, and mpdf-archive directories should be on the same file system as the jobs-hotfolder, mrdf-hotfolder, and mpdf-hotfolder respectively. Set up a periodic process to clean out these directories, as they can become large. Unless there is an error when ingesting a file, you will not actually need the contents of these directories.
mrdf-unprocessed Houses the MRDF files that are not processed successfully by Data Manager; should be on the same file system as the mrdf- hotfolder.
mpdf-unprocessed Houses the MPDFfiles that are not processed successfully by Data Manager; should be on the same file system as the mpdf- hotfolder.
maildat Shared directory containing the Mail.dat files used to collect spoilage and container/tray information; may contain subdirectories
logs Maintains a separate log for each Windows service; each service can put its log files into a different place; however, they are typically collected in the same directory.
temp Used as temporary storage for several purposes; is not typically large
Installation and Configuration Overview
Installation and Configuration Overview
Here is a high-level look at the MAIL360 Data Manager installation process.
• Ensure that you meet the System Prerequisites for the installation.
• Gather the necessary information for completing the install process. (Refer "Information You Will Need” on page 13.)
• Install the Data Manager services. (Refer "Installing the MAIL360 Data ManagerTM Web Services” on page 19)
• Configure the Data Manager hub subscription. (Refer "Configuring Your Data Manager Hub Subscription” on page 41)
• Set up your databases. (Refer "Setting Up the MAIL360 Data ManagerTM Databases” on page 45)
• Install the Data Manager User Interface, if desired. (Refer "Installing the MAIL360 Data
ManagerTM User Interface (UI)” on page 81)
• Configure your MAIL360 Data Manager. (Refer "Configuring MAIL360 Data ManagerTM” on page 97)
• Install and configure OpenAM for authentication. (Refer "Installing and Configuring OpenAM and OpenDJ” on page 127)
• Install and configure OpenDJ as an identity data store in single sign-on environment. (Refer "Installing and Configuring OpenDJ” on page 155)
• Configure your MAIL360 Reports and Scheduler options, if necessary, using the Configuration Utility. (Refer "Configuring the MAIL360 Report Manager and Scheduler” on page 103)
• Configure your MAIL360 Diagnostic Utility (service and UI) if necessary. (Refer "Configuring MAIL360 Diagnostic Utility” on page 110)
• Install the Identity Server User Interface, if desired. (Refer "Installing the MAIL360 Identity
ServerTM Web UI” on page 183)
• Review MAIL360 Data Manager security. (Refer "MAIL360 Data ManagerTM Security” on page 195)
Chapter 1: Preparing for MAIL360 Data ManagerTM Installation System Prerequisites
System Prerequisites
This section lists the items that are required for your MAIL360 Data ManagerTM installation:
• Microsoft® Windows Server 2012 Standard or Microsoft® Windows Server 2012 R2 with the latest updates
• Microsoft® .NET Framework 4.6.1 (available for download on the Microsoft Web site: http:// www.microsoft.com/) should be installed
• Microsoft® Message Queuing (MSMQ) must be installed, up, and running for use
• Internet Information Services (IIS) 8.0 must be up and running for use
• Microsoft® SQL Server® 2012 Enterprise Edition databases and users must be available for use by the MAIL360 Data Manager Web services
• Microsoft® SQL Server® 2012 Reporting Services should be available for use
• Microsoft® SQL Server® Agent should be up and running for use by a user having desired access permissions
• The Distributed Transaction Coordinator service must be started and Network DTC Access enabled before using the Data Manager system.
• Authentication certificates must be obtained from Pitney Bowes Software™ and installed before using the software. (For more information, refer "Configuring Your Data Manager Hub Subscription” on page 41.)
Deployment Environment Prerequisites
Deployment Environment Prerequisites
This section describes the items you must setup before installing MAIL360 Data Manager in your technical environment.
MAIL360 Service Account
MAIL360 Data Manager will typically run its Windows services using a domain account, for example “mail360svc”. This account is granted access to SQL Server databases, file system directories and URL ACLs via several groups that are defined locally on the application server. On the Application Server, it must have interactive, batch and service logon privileges.
Administrative Privileges
The person acting as Application Server Administrator will need unrestricted administrative access to the application server in order to install the system. This administrative identity will also need the ability to add the MAIL360 service account to local security policies, which requires the ability to look up the domain account in Active Directory.
X.509 SSL Certificate
Data Manager Web service communication is protected by SSL (Secure Sockets Layer). You will need to obtain a SSL certificate from a third-party for the application server. The common name for the certificate will reflect the DNS (Domain Name System) name chosen in the planning process for the MAIL360 Data Manager application server. You need to import this certificate at Personal, Trusted People, and Trusted Root Certification Authorities nodes.
Internet Access for MAIL360 Data Manager Web services
The MAIL360 Data Manager Web services running on the Application Server will need direct outbound access to the following:
• mail360hub.g1.com:8877
These ports communicate with the MAIL360 Hub to exchange status information and receive USPS® event data. This communication occurs via SOAP over HTTP, using message-level security. All connections are initiated from the MAIL360 Application Server; and no inbound connections are required.
Chapter 1: Preparing for MAIL360 Data ManagerTM Installation Information You Will Need
SMTP Server and E-mail Accounts
MAIL360 Data Manager requires access to an SMTP server to send e-mail messages. The SMTP server must be provisioned with a “from” address (typically a special-purpose account such as [email protected]) and a “to” address (such as a mailing list, or a mailbox from which messages are forwarded according to e-mail server rules).
Information You Will Need
You should gather the following information before proceeding with your installation. For this, you may need to contact Pitney Bowes Technical Support. The Customer Support Hot-line number is (800) 367-6950. The Customer Support Facsimile number is (301) 918-0462.
• Temporary access key, located on your packing slip
• The permanent license key that can be downloaded from the Pitney Bowes Software Web site
• The MAIL360 installation identity information from the Pitney Bowes Software Web site:
– MAIL360 Data Manager subscriber ID
– MAIL360 Data Manager identity certificate (the Hub certification)
• The location of the directory where your pre-installed IIS FTP service places received files (if applicable)
• The “Bridge Check Service URI” from the Pitney Bowes Technical Support
• List all Intelligent Mail® mailer IDs. For each, determine if:
– You will subscribe to Start-the-Clock
– You will subscribe to ACS™
– You will subscribe to Confirm®
– You will mail via full-service or just Basic Intelligent Mail® barcoding
• Determine your tracking needs:
– Are you tracking a mailpiece in production, postal, or both?
– Are you tracking outbound mail, inbound mail, remittances, or all, for each mailer ID?
– If tracking remittances, obtain the routing codes (9- or 11-digit) corresponding to each mailer ID with remittances.
• Will Data Manager collect spoilage and container/tray information via Mail.dat version 14-2 or 15-1 (requires Header, Piece Detail Record, Container Summary, and Container Quantity)? If yes:
– List all production facilities. For each:
– Name
– DNS name
– Diagnostic Web service (default:8888)
– DNS name
– SQL Server port number
• Gather the reporting server details:
– DNS name
– SSRS Web services URL scheme (http/https)
– SSRS folder name for MAIL360 directory (default: "mail360")
• Decide whether you want e-mail notifications for job processing (requires SMTP server)? If yes, you will need:
– SMTP server name
– SMTP server username/password (may not apply)
– "From" e-mail address
– "To" e-mail address (one address; use distribution list if appropriate)
– Need to check if the SMTP Server is configured over SSL
• Set up the Windows domain account for MAIL360 services:
– Account name ("mail360svc" is typical)
– Password
• Determine whether MAIL360 users will be setup with MAIL360 accounts. For the default user account (username and password), contact Pitney Bowes Technical Support.
• Determine whether MAIL360 users will be provisioned via Active Directory. If yes, you will need:
– Default MAIL360 user account (username and password) from Pitney Bowes Technical Support
– LDAP URL (for example, "LDAP://domain.mycompany.com")
– Windows domain name
– Windows security identifier (for example: "objectSid")
– First name (for example: "givenName")
– Last name (for example: "sn")
– E-mail address (for example: "mail")
– User principal name (for example: "userPrincipalName")
– Group membership (for example: "memberOf")
– Group name (for example: "name")
• What processes will submit input files (jobs/mrdf/mpdf) to Data Manager? For each, determine:
– Which computer does it run on?
– How will files be submitted: FTP? Shared network directory?
– What user credentials will be used to submit the job files? Possibilities include:
– Windows Domain account
– Anonymous FTP
• Determine the contact information to include in the Data Manager's Hub client certificate:
– Name
– Company
– Address
• Gather the shared directory information. These directories may be on individual computers and/ or SAN storage (list paths as they are seen from each relevant machine):
Directory Used From Machines
Bus Repository Application Server
Jobs Hot-folder, Application Server
MRDF Hot-folder • Any machines submitting via shares MPDF Hot-folder • As seen by an FTP server
Jobs Archive
MRDF Archive
MPDF Archive
Application Server
MRDF Unprocessed
MPDF Unprocessed
Application Server
• Identify/Assign people for each role
• Calculate your data volumes:
– Total outbound pieces
– Total inbound pieces
– Outbound with Start-the-Clock service
– Outbound with ACS™ service
– Outbound with Confirm® service
– Inbound with Confirm® service
– How many Mail.dat mailpieces will you process per month (may be less if not tracking spoilage for all mailstreams)?
Information You Will Need
– Size (mailpieces) and submission schedule for mail.dats
• Determine your data retention period for the following items:
– Job/MRDF/MPDF/mailpiece/event-oriented data in database
• Determine whether any firewalls exist inside organization or between application server and Hub?
Pre-Installation Checklist
You are recommended to go through the below checklists and verify whether the items listed in the checklists are available in your deployment environment or not. For more detailed information on the checklist items, refer the System Prerequisites, Deployment Environment Prerequisites, and
Information You Will Need sections of the Preparing for MAIL360 Data ManagerTM Installation chapter.
Checklist for Application Server
Minimum 8 GB RAM
Minimum 50 GB of free disk space
Microsoft® Windows Server 2012 Standard or Microsoft® Windows Server 2012 R2 with latest updates
Microsoft® .NET Framework 4.6.1
Microsoft® Message Queuing (MSMQ)
Distributed Transaction Coordinator service started and network DTC Access enabled.
Authentication certificates:
• X.509 SSL Certificate for MAIL360 Data Manager Web services
MAIL360 Data Manager Subscriber ID
Temporary access key/Permanent license key
Administrative access to the Application Server
Chapter 1: Preparing for MAIL360 Data ManagerTM Installation Information You Will Need
Checklist for Application Server
• Account name ("mail360svc" is typical)
• Password
TCP port numbers for:
• SMTP Server username/password (may not apply)
• "From" e-mail address
• "To" e-mail address (one address; use distribution list if appropriate)
• SSL enabled or not
Determine whether MAIL360 users will be provisioned via Active Directory. If yes, you need:
• LDAP URL (for example, "LDAP://domain.mycompany.com")
• Windows domain name
– Windows security identifier (for example: "objectSid")
– First name (for example: "givenName")
– Last name (for example: "sn")
– E-mail address (for example: "mail")
– User principal name (for example: "userPrincipalName")
– Group membership (for example: "memberOf")
– Group name (for example: "name")
Gather the shared directory information (Job Hot folder, Bus Repository, Jobs Archive, MRDF Hot-folder, MPDF Hot-folder, MRDF Archive, MPDF Archive, MRDF Unprocessed, MPDF Unprocessed, Logs, Temp, and Mail.dat Directory). These directories may be on individual computers and/or SAN storage
Checklist for Database Server
Microsoft® SQL Server® Agent
Database instance name for Data Manager and Client Bus
SQL Server port number
Checklist for Reporting Server
• SSRS Web services URL scheme (http/https)
• SSRS folder name for MAIL360 directory (default: "mail360")
2
In this chapter:
Minimum Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . 20 Installing the MAIL360 Data Manager Web Services . . . . . . . . . . 20 What Was Done by the Install Process? . . . . . . . . . . . . . . . . . . . 33 Post-Installation Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . 34 Upgrading the MAIL360 Data Manager Web Services . . . . . . . . . 36 Repairing the MAIL360 Data Manager Web Services . . . . . . . . . . 37 Uninstalling the MAIL360 Data Manager Web Services. . . . . . . . . 39
Uninstalling via the Uninstall Wizard . . . . . . . . . . . . . . . . . . 39 Uninstalling via the Control Panel . . . . . . . . . . . . . . . . . . . . 40
Configuring Your Data Manager Hub Subscription . . . . . . . . . . . . 41 Entering Your Subscriber ID . . . . . . . . . . . . . . . . . . . . . . . . 42 Importing and Configuring Your Unique Identity Certificate . . . 42 Importing the Hub Identity Certificate . . . . . . . . . . . . . . . . . . 43 Importing the Hub Certificate Authorities. . . . . . . . . . . . . . . . 44 Renewing SSL Certificates . . . . . . . . . . . . . . . . . . . . . . . . . 44
Minimum Hardware Requirements
Minimum Hardware Requirements
Following are the minimum hardware requirements for MAIL360 Data Manager Web services:
• Dual Core, 2.2 GHz 64-bit Processor
• 8 GB RAM
Installing the MAIL360 Data Manager Web Services
You are recommended to take a note of the Windows domain account that you have used for login into the server on which you are installing the MAIL360 Data Manager application (services). You will need this account in future while upgrading, repairing, or removing the application.
After verifying all the prerequisites, to install the MAIL360 Data Manager Web Services, complete the following steps:
While navigating through the installation wizard, you will be asked to specify different settings, such as Windows domain account, database, and e-mail server settings. However, if you do not specify some of these settings or you do specify them incorrectly, you can manually change them (apart from Windows domain account) later in the respective configuration files. To know more about various settings in different configuration files, refer "MAIL360 Data ManagerTM Configuration Settings” on page 203.
1. Navigate to the Services folder at the location where you extracted the MAIL360 Data Manager installation zip file and run the setup.exe with Administrator privileges. To run with Administrator privileges, right-click the setup.exe and select the Run as administrator option.
2. On the Welcome to the InstallShield Wizard for MAIL360 Data Manager Web Services screen, click Next.
If MAIL360 Data Manager Web services 3.1.0 already exists on your server, you will be prompted to repair or remove the application. To repair, refer "Repairing the MAIL360 Data Manager Web Services” on page 37; to remove, refer "Uninstalling the MAIL360 Data Manager Web Services” on page 39. However, if version 3.0.0 exists on your server, the application will be upgraded to version 3.1.0 (refer "Upgrading the MAIL360 Data Manager Web Services” on page 36).
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services Installing the MAIL360 Data Manager Web Services
a. If you do not have Microsoft Message Queue installed on your server, then you will be prompted to install it before proceeding.
b. On the Additional Required Components screen, click Cancel to abort the installation.
c. On the message box, click Yes.
d. On the InstallShield Wizard Completed screen, click Finish to exit the installer.
e. After successfully installing the Microsoft Message Queue feature, navigate to the Services folder of the MAIL360 Data Manager installation package and run the setup.exe with Administrator privileges.
f. On the Welcome to the InstallShield Wizard for MAIL360 Data Manager Web Services screen, click Next.
3. On the License Agreement screen, read and accept the license agreement. Click Next.
4. On the Installation Folder screen, if you do not wish to accept the default (C:\Program Files (x86)\Group1\Mail360 Data Manager Web Services\) location then you can change the installation path by clicking the Change button. Click Next.
5. On the Log File Folder screen, if you do not wish to accept the default (C:\Group 1 Data\MAIL360 Data Manager\logs\) location then you can change the path of log files by clicking the Change button. Click Next.
In case of any issues due to which installation process aborts, please look into the log files at the location specified in the previous step.
6. On the Service Account Settings screen, enter the following mandatory information and click Next.
• Account Name: The login name that the MAIL360 Data Manager Web services will use to run as a service process. If an organization has a domain, user should provide the domain name along with the username.
• Password: The password for the login name that the MAIL360 Data Manager Web services will use to run as a service process.
Please ensure that you have specified a valid username and correct password. Otherwise, the MAIL360 Data Manager services will not be installed successfully.
7. On the Database Configuration screen, enter the following information and click Next.
For the Data Manager database:
• Database server - The name of the SQL Server that will host the Data Manager database.
• Catalog name - The database name selected by the Database Administrator (DBA) as described under "Setting Up Your Databases” on page 49.
For the Client Bus database:
• Database server - The name of the SQL Server that will host your Client Bus database.
• Catalog name - The database name selected by the DBA as described under "Setting Up Your Databases” on page 49.
8. On the Additional Configuration for Data Manager screen, enter the following information and click Next.
• Access keys: Enter your access keys (for temporary licensing), separated by commas. The access keys are provided by Pitney Bowes Software and can be located on the packing slip. This is required field.
• Service host name: Enter the name of the host machine for your MAIL360 Data Manager Web services. This is the machine on which you are installing the MAIL360 Data Manager application. The above screen currently shows localhost as the service host name, but this could also be similar to “http:\\” or “https:\\” and mail360dmhost.company.com\mail360dm.
• Data manager port: Enter the TCP port on which the Data Manager system will provide Web services. The default port is 8884.
• Report manager port: Enter the TCP port on which the Report Manager system will provide web services. The default port is 8886.
• Identity server port: Enter the TCP port on which the Identity Server system will provide web services. The default port is 8887.
• Diagnostic service port: Enter the TCP port on which Diagnostic Utility system will provide web services. The default port is 8888.
• Data manager subscriber ID: Enter your Data Manager subscriber ID that was provided by Pitney Bowes Software.
• Temp file directory: This indicates the directory where temporary files will be stored locally. If you wish to change this directory, click Change...
9. On the Additional Configuration for Job Submission screen, specify the following information and click Next.
• Scanning interval: The time interval (in minutes) after which FTP Agent checks for newly uploaded files in the job hot folder from the FTP input directory.
• Jobs Input File Archive Directory: The directory into which incoming files are archived. When the FTP Agent processes files, it removes the files from the input directory and archives them in the archive directory. If you wish to change this directory, click Change...
• Jobs Hot Folder: The directory where the previously configured IIS FTP service stores incoming job files. The FTP Agent will search this directory for new files. If you wish to change this directory, click Change...
The installer also creates the following directories at the same location that you have specified for the jobs-hotfolder: mrdf-hotfolder, mpdf-hotfolder, mrdf-archive, mpdf- archive, mrdf-unprocessed, and mpdf-unprocessed.
• Mail.dat Input Directory: The directory containing the mail.dat files. If you wish to change this directory, click Change...
10. On the Additional Configuration for Message Receiver screen, specify the settings for the Message Receiver service that processes messages and incoming files. Click Next.
The Notification settings are only displayed when the Enable mail notification check box is selected. Diagnostic service will also use these settings to send e-mail notifications. However, you can manually change these settings in the Data Manager configuration file after installation.
• Enable mail notification: If this is checked, the Data Manager system will send e-mail notices when mailpiece files are processed.
• Sender e-mail address: The e-mail address of the account from which you wish to send the notifications.
• Subscriber e-mail address: The e-mail address of the recipient for the notifications.
• Mail server host: The host name of the SMTP mail server.
• Mail server port: The port on which the SMTP mail server listens.
• Email account username: The name (login) of the account used for sending the notifications.
• Email account password: The password for the account used for sending the notifications.
• SSL enabled on SMTP server: Need to be checked if the SMTP Server is configured over SSL.
11. On the Additional Configuration for Client Bus screen, enter the following settings for the Client Bus service that links the Data Manager installation with the Pitney Bowes Hub and click Next.
• Repository Path: The Client Bus logs and archives incoming and outgoing messages. Select the local directory where the messages will be archived. To change this directory, click Change...
• Bridge Check Service URI: Enter the URI provided by Pitney Bowes Software for accessing the Hub. It should be in the following format:
http://<server>:<port>/[path]
12. On the Permission Setting Confirmation screen, click Next. This reminds you that permissions on queues created by the installer must be manually configured before running the Data Manager system.
13. On the Ready to Install the Program screen, click Install. The installer will now install the Data Manager components according to your configurations.
As the installation proceeds, you may notice a command window flash up and disappear again. This is normal and indicates the execution of scripts that are configuring permissions on folders and queues.
14. On the InstallShield Wizard Completed screen, click Finish to exit the installer.
15. Start all of the MAIL360 Data Manager Web services after installing the databases (refer "Setting Up the MAIL360 Data ManagerTM Databases” on page 45). The services will not start if the Data Manager database has not been installed.
If the MAIL360 Data Manager services are not installed successfully, you may want to identify the issue by looking into the logs generated by the installer. Following two types of logs will be generated by the installer:
– MSI log: mail360_MSI.log
– Custom log: Mail360_DM_SERVICE_SetupLog_<mddyyyy_hhmmss>.log
You can locate these log files in the %temp% folder (for example: C:\Users\ADMIN\AppData\Local\Temp\2) of your server.
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services What Was Done by the Install Process?
What Was Done by the Install Process?
The following actions were performed by the installer:
• The software executable programs were installed on the machine. Configuration settings for each executable were stored in the installation directory.
• Following Windows services were created for the executable programs:
– MAIL360 Data Manager
– MAIL360 FTP Agent
– MAIL360 Message Receiver
– MAIL360 Client Bus
– MAIL360 Report Manager
– MAIL360 Identity Server
– MAIL360 Diagnostic Service
The services were not started; you will have to start them manually.
• The MAIL360 Identity Server handles user identification and management, including:
– Authentication and Authorization
– Group Management (Associating business roles and users to a group)
– User Management
• The following private message queues were created for use by the Data Manager system:
– mail360-datamanager-input
– mail360-datamanager-input-error
– mail360-ftpagent-input
– mail360-ftpagent-input-error
– mail360-messagereceiver-input
– mail360-messagereceiver-input-error
– mail360-clientbus-input
– mail360-clientbus-input-error
– mail360-clientbus-unroutable
– mail360-clientbus-bridge-intreceive
– mail360-clientbus-bridge-send
– mail360-messagereceiver-inputfiles
– mail360-hubmaileridnotifier-input
– mail360-hubmaileridnotifier-input-error
• Windows Workflow Foundation Services was configured to allow use of the Web services. Refer msdn.microsoft.com/en-us/library/bb924408.aspx for more information.
• The URL for the Web services (based on the host and port specified during installation) was added to the Windows URLACL store.
– MAIL360ClientBusRunAsUser
– MAIL360DataManagerRunAsUser
– MAIL360FtpAgentRunAsUser
– MAIL360MessageReceiverRunAsUser
– MAIL360IdentityServerRunAsUser
– MAIL360ReportManagerRunAsUser
– MAIL360IdentityServerRunAsUser
– MAIL360DiagnosticServiceRunAsUser
– MAIL360SchedulerRunAsUser
These groups contain the user accounts under which the MAIL360 software should be allowed to run, as they are associated with all necessary queue and file system permissions.
• Setup scripts were stored under <install directory>\setup. They can be used to re-create the databases or queues if they are removed for some reason.
• The installer placed the report definitions in the Reports folder.
• The Configuration Utility can be found under Start > DataManagerConfigurationTool. This can be used to access the Report Manager and Scheduler configuration settings.
Post-Installation Configuration
After installing the MAIL360 Data Manager Web Services successfully, you may need to modify some of the settings in different configuration files. You can locate these files in the main installation directory. Although, most of the settings are configured initially by the installer, you may need to change some of them manually in the following configuration files:
• DataManager.config.xml
• ClientBus.config.xml
• InputFileSources.xml
• IdentityProviders.xml
To do so, complete the following steps:
1. Navigate to <your MAIL360 Data Manager target install directory>. For example, C:\Program Files (x86)\Group1\MAIL360 Data Manager Web Services.
2. Open the DataManager.config.xml file in the edit mode and make the following changes, if required:
a. In the following key, specify the credentials (Windows or SQL Server) that you will use to connect with the Data Manager database:
<add key="DbConnectionString" value="server=hostname;database=Data Manager database;trusted_connection=true"></add>
or
<add key="DbConnectionString" value="server=hostname;database=Data Manager database;uid=username; pwd=password"></add>
b. Specify an appropriate value (port number) for the following key (default=80):
<add key="ssrs2005Port" value="80"></add>
c. Save and close the file. To apply the configuration changes, restart all the services.
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services Post-Installation Configuration
3. Open the ClientBus.config.xml file in the edit mode and make the following changes, if required:
a. In the following key, specify the credentials (Windows or SQL Server) that you will use to connect with the Client Bus database:
<add key="DbConnectionString" value="server=hostname;database=Client Bus database;trusted_connection=true"></add>
or
<add key="DbConnectionString" value="server=hostname;database=Client Bus database;uid=username; pwd=password"></add>
b. Verify that a path value exists for the following key-value pair:
<add key="RepositoryPath" value="C:\Group 1 Data\MAIL360 Data Manager\bus-repository\"></add>
c. Save and close the file. To apply the configuration changes, restart the MAIL360 Client Bus service.
4. Open the InputFileSources.xml file in the edit mode and make the following changes, if required:
a. Verify that a path value exists for the following keys:
<add key="jobs" value="C:\Group 1 Data\MAIL360 Data Manager\jobs- hotfolder\"></add> <add key="maildats" value="C:\Group 1 Data\MAIL360 Data Manager\maildat\"></add>
b. Save and close the file. To apply the configuration changes, restart the MAIL360 Data Manager and MAIL360 Message Receiver services.
5. Open the IdentityProviders.xml file in the edit mode and make the following changes if required:
a. Verify that the following configuration is there for one or more identity providers depending on the user account sources you wish to support:
<ref object="mail360IdentityProvider"/> <ref object="sampleActiveDirectoryIdentityProvider"/> <ref object="localWindowsIdentityProvider"/>
b. Depending on the identity providers you configured in the previous step, you may have to specify an appropriate value for the following property:
<property name="ParentOrganizationCode" value="TenantCode\OrgCode"/>
For more detailed information, you can refer IdentityProviders.xml and MAIL360 Identity Provider
Configuration under "MAIL360 Data ManagerTM Configuration Settings” on page 203.
You may also need to manually configure the application server’s Microsoft.NET transaction timeout setting in the machine.config file. For instructions, refer machine.config under "MAIL360 Data ManagerTM Configuration Settings” on page 203.
c. Save and close the file. To apply the configuration changes, restart the MAIL360 Identity Server service.
Upgrading the MAIL360 Data Manager Web Services
Upgrading the MAIL360 Data Manager Web Services
The Upgrade wizard is available when you launch the setup and a previous version (3.0.0) of the software already exists. You cannot upgrade to version 3.1.0, if you are currently using a version other than 3.0.0. If this is the case, then first upgrade to version 3.0.0 and then upgrade to version 3.1.0.
You need to log into the application server using the same Windows domain account that was used to install MAIL360 Data Manager version 3.0.0. However, if you want to upgrade using any other account, then make sure that the account has full access on the private message queues created by the previous version of MAIL360 Data Manager.
Before initiating the upgrade process, please ensure that:
• all the private MAIL360 MSMQs are empty.
• all MAIL360 Data Manager Web services are stopped.
• all configuration files are closed.
• the MAIL360 Data Manager installation directory is not open in the Windows Explorer.
• the MAIL360 Data Manager installation directory is not being accessed from the Command Prompt.
You are also recommended to backup the previous version files from the installation directory and Data Directories.
To upgrade MAIL360 Data Manager Web services from 3.0.0 to 3.1.0, complete the following steps:
1. Navigate to the Services folder at the location where you extracted the MAIL360 Data Manager installation zip file and run the setup.exe with Administrator privileges.
If any of the MAIL360 Data Manager Web services is running, then wizard will prompt a message, “One or more services are running. Please stop the services to proceed. The installation will abort now”. Stop the services using the Services Management Console (services.msc) and run the setup once again.
2. The instructions to upgrade are exactly similar to the instructions under Installing the MAIL360 Data Manager Web Services. The only difference between upgrade and fresh installation is that while upgrading the previous installation settings remain preserved and are displayed in the installation wizard.
In case, you are not able to upgrade the application successfully, you may need to revert back to the previous version, MAIL360 Data manager 3.0.0. To do so, please create a technical support case at http://go.pbinsight.com/online-case-management. The Customer Support Hot-line number is (800) 367-6950. The Customer Support Facsimile number is (301) 918-0462.
Repairing the MAIL360 Data Manager Web Services
You need to log into the MAIL360 Data Manager application server using the same Windows domain account that you used to install the application version 3.1.0 for the first time. However, if you want to repair using any other account, then make sure that the account has full access on the private message queues created by MAIL360 Data Manager 3.1.0.
The Repair option is available when you run the setup and MAIL360 Data Manager version 3.1.0 already exists on the application server.
Before initiating the repair process, please ensure that: - all the private MAIL360 MSMQs are empty. - all MAIL360 Data Manager Web services are stopped. - all configuration files are closed. - the MAIL360 Data Manager installation directory is not open in the Windows Explorer.
- the MAIL360 Data Manager installation directory is not being accessed from the Command Prompt.
3. On the Program Maintenance screen, select the Repair option and click Next.
Repairing the MAIL360 Data Manager Web Services
4. On the Service Account Settings screen, enter the following and click Next:
• Account Name: The login name that the MAIL360 services will use to run as a service process. If an organization has a domain, user should provide the domain name along with the user name.
• Password: The password for the login name that the MAIL360 services will use to run as a service process.
Ensure that you have specified a valid username and correct password. Otherwise, the MAIL360 Data Manager services will not be installed successfully.
5. On the Ready to Repair the Program screen, click Install.
6. On the InstallShield Wizard Completed screen, click Finish to complete the installation.
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services Uninstalling the MAIL360 Data Manager Web Services
Uninstalling the MAIL360 Data Manager Web Services
You can uninstall the MAIL360 Data Manager Web services either by using the uninstall wizard or by using the Control Panel.
Before initiating the uninstall process, please ensure that: - all the private MAIL360 MSMQs are empty. - all MAIL360 Data Manager Web services are stopped. - all configuration files are closed. - the MAIL360 Data Manager installation directory is not open in the Windows Explorer.
- the MAIL360 Data Manager installation directory is not being accessed from the Command Prompt.
Uninstalling via the Uninstall Wizard
You need to log into the MAIL360 application server using the same Windows domain account that you used to install MAIL360 Data Manager 3.1.0. However, if you want to uninstall using any other account, then make sure that the account has full access on the private message queues created by MAIL360 Data Manager 3.1.0.
The uninstall wizard is available is available when you run the setup and MAIL360 Data Manager version 3.1.0 already exists on the application server. To uninstall the application, complete the following steps:
3. On the Program Maintenance screen, select the Remove option and click Next.
4. On the Remove the Program screen, click Remove.
Uninstalling the MAIL360 Data Manager Web Services
5. On the InstallShield Wizard Completed screen, click Finish to complete the uninstallation.
Uninstalling via the Control Panel
To uninstall MAIL360 Data Manager using the Control Panel, complete the following steps:
1. Go to Start -> Control Panel.
2. Scroll down to select MAIL360 Data Manager Web Services and click Uninstall.
If any of the MAIL360 Data Manager Web services is running, then wizard will prompt a message, “One or more services are running. Please stop the services to proceed. The installation will abort now”. Stop the services using the Services Management Console (services.msc) and attempt to uninstall from the Control Panel once again.
3. Delete your logs from the Group 1 Data folder.
4. Reboot your server to complete the uninstall process.
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services Configuring Your Data Manager Hub Subscription
Configuring Your Data Manager Hub Subscription
As part of your MAIL360 Data Manager installation package, Pitney Bowes Software will issue the following subscriber information:
• A Subscriber ID, which is a string that will be entered into your application configuration (Refer "Entering Your Subscriber ID” on page 42). You are only required to enter this if you did not do so during the Data Manager installation process on the Additional Configuration for Data Manager screen in Step 8.
• A unique installation identity certificate, which will be used to identify the specific installation of MAIL360 Data Manager and to secure communication with the MAIL360 Hub.
• A Hub identity certificate, which will be used to verify the identity of the Hub to your Data Manager installation.
This information should only be used for a single Data Manager installation at a time; using it in multiple Data Manager instances may lead to data corruption. If you wish to make multiple installations of the Data Manager system, contact Pitney Bowes Software Support for assistance at 800-367-6950.
Most of the organizations maintain two or three separate environments:
• ‘development’ environment - is used for testing with their own integrations and product upgrades.
• ‘user acceptance test’ environment - is a replica of the production environment and used for final testing before moving to the production environment.
• ‘production’ environment - is used for doing real-time work.
If multiple MAIL360 Data Manager instances communicate with the Hub using the same identity, then each instance will receive same events. As a result, following issues may occur:
• The data in the logs generated on the Hub will be confusing while troubleshooting some issues. User will be able to see that a message has been delivered to the Data Manager, but, determining whether it was delivered to production or test environment will be difficult.
• The test environment will be loaded with a bunch of events, which will match nothing, while still not getting any matching events.
• The network load will be multiplied.
Therefore, Pitney Bowes Software issues two different Data Manager identity certificates to be used for Hub authentication. The certificates are named like:
• PBBI CI Bridge Client company_name_01 - to be used in production environment
• PBBI CI Bridge Client company_name_TEST_01 - to be used in test environment
By using separate identities for test environments, Hub will know that they are not the real customers. They are valid certificates; they will do all the handshakes. but there will not be any messages for them to receive.
Entering Your Subscriber ID
If you did not enter your subscriber ID during the Data Manager installation, you will need to modify the property “dmSubscriberId” within the configuration file, DataManager.config.xml (using a text editor such as Notepad). For example:
<add key="dmSubscriberId" value="cust_03"/>
Importing and Configuring Your Unique Identity Certificate
Your unique identity certificate will be provided as a .PFX file and can be imported using the “Certificates” snap-in of the Microsoft Management Console.
1. Run the “mmc” command to open the Management Console.
2. Click File -> Add/Remove Snap-in... to display the Add or Remove Snap-ins dialog box.
3. Under Available snap-ins, select Certificates and click Add.
4. On the Certificates snap-in dialog box, select Computer account and click Next.
5. On the Select Computer dialog box, select Local Computer and click Finish.
6. On the Add or Remove Snap-ins dialog box, click OK. This will produce a tree view of all the certificates installed on the Local Machine that will be available to the MAIL360 processes.
Ensure that you do not already have a certificate installed. If you do, please contact Pitney Bowes Software Support for assistance at 800-367-6950.
7. On the tree view, right-click the Personal node and select All Tasks->Import….
8. On the Welcome to the Certificate Import Wizard screen of Certificate Import Wizard, click Next.
9. On the File to Import screen, browse the location where you have saved the PBBI CI Bridge Client <company_name_01>.pfx file provided by Pitney Bowes Software. Click Next.
Chapter 2: Installing the MAIL360 Data ManagerTM Web Services Configuring Your Data Manager Hub Subscription
10. On the Password screen, enter the password provided by Pitney Bowes Software and select Mark this key as exportable. Click Next.
11. On the Certificate Store screen, click Next.
12. On Completing the Certificate Import Wizard screen, click Finish.
13. A confirmation box saying “The import was successful” appears. Click OK.
14. Verify that the Certificate Import Wizard places the certificate in the “Personal” store.
15. Next, you must run the InstallHelper application that came with your MAIL360 Data Manager distribution to make the unique identity certificate accessible to the Data Manager processes. To do this, open a DOS Command Prompt, and proceed to the folder where the Data Manager system has been installed.
16. Change to the sub-folder InstallHelper, then execute the following command line (as an Administrator):
Installhelper certificate set-permissions My “PBBI CI Bridge Client” Subject MAIL360ClientBusRunAsUser R
Importing the Hub Identity Certificate
The Hub identity certificate will be provided as a .PFX file and can also be imported using the “Certificates” snap-in of the Microsoft Management Console.
1. Complete Step 1 to Step 6 explained under Importing and Configuring Your Unique Identity Certificate to open the certificates tree view on the Microsoft Management Console.
2. On the tree view, right-click the Trusted People node and select Tasks>Import….
4. On the File to Import screen, browse to the location where you have saved the PBBI CI Production Bridge Server.pfx file provided by Pitney Bowes Software. Click Next.
8. Verify that the Certificate Import Wizard places the certificate in the “Trusted People” store.
Congratulations! Your subscription setup is now complete. You can now Start (or Restart) the MAIL360 Client Bus service. Check the application logs for errors that indicate that the Client Bus is (1) unable to connect to the Server Bus, or (2) unable to establish a secure connection to the Server Bus.
Importing the Hub Certificate Authorities
Pitney Bowes Software will provide you with two more .CER files that represent the certificate authorities (CA) used to digitally endorse your MAIL360 Data Manager installation’s personal identity certificate. These certificate authorities must be present in order for your MAIL360 Data Manager to successfully authenticate to the MAIL360 Hub when the Data Manager downloads data.
To import these certificate authorities:
1. Complete Step 1 to Step 6 explained under Importing and Configuring Your Unique Identity Certificate to open the certificates tree view on the Microsoft Management Console.
2. On the tree view, right-click the Trusted Root Certification Authorities node and select Tasks>Import….
4. On the File to Import screen, browse to the location where you have saved the PBBI CI Production Root CA.cer file provided by Pitney Bowes Software. Click Next.
6. On Completing the Certificate Import Wizard screen, click Finish. A confirmation box saying “The import was successful” appears. Click OK.
7. Verify that the Certificate Import Wizard places the certificate in the “Trusted Root Certification Authorities” store.
8. On the tree view, right-click the Intermediate Certification Authorities node and select Tasks>Import….
10. On the File to Import screen, browse to the location where you have saved the PBBI CI Production Bridge Client CA.cer file provided by Pitney Bowes Software. Click Next.
14. Verify that the Certificate Import Wizard places the certificate in the “Intermediate Certification Authorities” store.
Renewing SSL Certificates
X.509 certificates are used for secured communication between Data Manager and Hub. When these certificates expire, you need to replace them with new ones. The instructions for installing the new SSL certificate are same as those for installing the original certificate. Refer instructions under "Configuring Your Data Manager Hub Subscription” on page 41.
3
Databases
Partition Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Partition Scheme (File Groups) . . . . . . . . . . . . . . . . . . . . . . 48
Setting Up Your Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Creating the Data Manager Database . . . . . . . . . . . . . . . . . 50 Upgrading the Data Manager Database . . . . . . . . . . . . . . . . 50 Creating the Client Bus Database . . . . . . . . . . . . . . . . . . . . 51 Upgrading the Client Bus Database . . . . . . . . . . . . . . . . . . . 52 Command Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
SQL Server Agent Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Configuring SQL Server Reporting Services (SSRS) Security . . . . 54 Setting Up Database Clustering & Failover . . . . . . . . . . . . . . . . . 59
MAIL360 AlwaysOn Availability Groups Layout . . . . . . . . . . . 60 Setting Up MAIL360 AlwaysOn Availability Groups . . . . . . . . 62
Prerequisites
Prerequisites
The following items are required for setting up the MAIL360 Data Manager databases:
• Microsoft® SQL Server® 2012 Enterprise Edition, including Reporting Services
• The Distributed Transaction Coordinator Service must be started with network DTC Access enabled.
• Microsoft® SQL Server Agent is up and running on the database server.
Hardware Requirements
SQL Server hardware requirements depend on the size and usage of the data, as well as any high availability requirements. As a very rough guide for disk, allow 1.5 GB per million mailpieces, probably in a high-speed SAN with mirrored RAID 0+1.
Partitioning Your Data Manager Database
MAIL360 Data Manager partitions many tables by various fields, such as job_mailing_date and maildat_mailing_date. It may not be necessary for you to be involved in the partitioning decisions, but on the other hand, you do have the option of customizing the partitioning. This section describes automatic partitioning and how you can customize it.
Partition Function
• the partition functions used for partitioning.
• the Data Manager database tables that are partitioned using each partition function.
• the fields that are used as the basis to partition the tables.
The partition functions take datetime values and are range right.
Partition Functions
partitionfunction_job_mailing_d ate
partitionfunction_maildat_mailin g_date
Containers, container_stc_scans, tray_stc_scan
Chapter 3: Setting Up the MAIL360 Data ManagerTM Databases Partitioning Your Data Manager Database
Partition Functions Target Tables Table Field
partitionfunction_unmatched_m unmatched_mailpiece_scans unmatched_mailpiece_scan ailpiece_scans_insert_timesta s_insert_timestamp mp
report_executions, report_snapshots
The MAIL360 Data Manager system ignores the initial partition, which is unbounded on the left, and the final partition, which is unbounded on the right.
You have the option of pre-creating the partition function before running the Data Manager database objects install. If you do not pre-create it, the install will automatically create a partition of three weeks’ duration through the Saturday that ends the install week.
Example
If the install is run on Monday, January 5, 2009, then the install would issue the following statement to partition the tables using the partitionfunction_job_mailing_date function:
create partition function partitionfunction_job_mailing_date (datetime)
as range right for values ('2008-12-21T00:00:00','2009-01-11T00:00:00');
If you create a job with mailing dates two weeks prior to the install date, you should pre- create partitions before running the install.
During regular Data Manager processing, whenever a job is inserted with a job mailing date for which there does not exist a partition, the Data Manager system will check whether automatically creating a partition to include that date would be reasonable and, if so, will automatically create a new partition having the same duration as the last partition. A partition is automatically created, if the new job mailing date fits in a new partition immediately after the last partition or (if it does not fit in that partition) in a new partition that begins on the date when the job is entered.
Continuing the above example (which automatically installed a three week partition from December 21 until January 11), if a job is now entered with a job mailing date of January 13, 2009, then the Data Manager system will automatically issue the following statement to create a three week partition from January 11 until February 1:
alter partition function partitionfunction_job_mailing_date() split range
('2009-02-01T00:00:00');
Partitioning Your Data Manager Database
On the other hand, say that you had instead predefined a partition function with partitions of a two week duration until January 11. Then, when the new job is entered with a job mailing date of January 13, 2009, the Data Manager system will automatically create the new partition with only a two week duration: from January 11 until January 25.
Just as you can pre-create partitions before running the install, you can explicitly create partitions afterwards to prevent or influence automatic partition growth in your Data Manager database. That is, you can prevent automatic partition growth by occasionally adding partitions yourself. You can influence automatic partition growth by changing the duration of the last partition, because new partitions that are automatically created use the duration of the last partition.
Partition Scheme (File Groups)
• partitionscheme_job_mailing_date
• partitionscheme_maildat_mailing_date
• partitionscheme_unmatched_container_stc_scans_insert_timestamp
• partitionscheme_unmatched_mailpiece_scans_insert_timestamp
• partitionscheme_unmatched_scans_insert_timestamp
• partitionscheme_report_executions_start_date_as_int
• partitionscheme_user_audit_insert_timestamp
If you do not pre-create it before the install, the install automatically creates the partition scheme using the [PRIMARY] file group for all partitions. Pre-define it if you wish to place partitions in one or more other file group(s). (If you wish to place different partitioned objects in different partition schemes, manually revise the database install scripts.)
When Data Manager automatically adds new partitions, it first checks to see whether the partition scheme(s) has already provided a file group for the new partition. If not, it automatically executes alter partition... next used, specifying the same file group as was used by the last partition.
Chapter 3: Setting Up the MAIL360 Data ManagerTM Databases Setting Up Your Databases
Setting Up Your Databases
In this section, you will learn how to create databases. MAIL360 Data Manager uses the following databases:
MAIL360 Data Manager Databases
Database Suggested Name Description
Data Manager mail360dm This is the Data Manager database. It includes all mailpiece information and supports all Data Manager functionality.
Client Bus mail360_clientbus Contains messaging information pertaining to system messages that are passed between the MAIL360 Hub and the MAIL360 Data Manager system, as well as messages passed among components of MAIL360 Data Manager.
Important Points to Remember • The scripts to create/upgrade these databases are contained in the setup folder, both on the
installation media and in the file tree created by the application installer. The database scripts must be run under an account with at least db_owner access on the target database in both cases, Windows authentication or SQL Server authentication (for example: “sa”).
• If you are running the scripts from a remote machine, Microsoft® SQL Server® 2012 Enterprise Edition Client should be up and running on that remote machine. Otherwise, you have to copy the scripts from the installation directory of the application server to the database server. For example, if you have installed MAIL360 Data Manager in C:\Program Files (x86)\Group1\MAIL360 Data Manager Web Services, you would navigate to C:\Program Files (x86)\Group1\Mail360 Data Manager Web Services\setup\db, copy both, DataManager and ClientBus folders to your database server, and execute the scripts.
If previous versions of the databases already exist on your database server, then continue with the instructions under "Upgrading the Data Manager Database” on page 50 and "Upgrading the Client Bus Database” on page 52.
If your server has a case-sensitive collation, note that the Data Manager must be created with a case-insensitive collation. (This is optional for the Client Bus database.) For example, if you create an empty database manually, run the following, else it will be created automatically with a case insensitive collation when you will run the create database script:
CREATE DATABASE mail360dm COLLATE Latin1_General_CI_AS
Setting Up Your Databases
Creating the Data Manager Database
Before executing the database setup scripts, you can create an empty database that will be populated by the setup scripts. This will be the case if, for example, you choose to pre-create a different partition function (as described above). If you do not create the database manually, the create-database.bat script will create it for you.
To run the scripts for setting up the MAIL360 Data Manager database, open DOS Command Prompt and execute the batch file ‘create-database.bat’ located in the DataManager folder (Refer "Important Points to Remember” on page 49), specifying the following parameters:
• First parameter - Name of SQL Server Instance on which you want to create the database
• Second parameter - Name of the Data Manager database (Refer suggested names under "MAIL360 Data Manager Databases” on page 49)
• Third parameter - Windows account under which the MAIL360 services are running
• Fourth parameter - SQL Server login user name (for example, “sa”)
• Fifth parameter - SQL Server login password
For more information on parameters, refer Command Parameters.
If you are using Windows authentication, the Windows account running the install scripts must have at least db_owner access to the MAIL360 Data Manager database. In that case, the fourth and fifth parameters are omitted.
If you are running the install scripts under SQL Server authentication, then fourth and fifth parameters are mandatory. This SQL Server account must have at least db_owner access to the MAIL360 Data Manager database.
If you have trouble in knowing the parameters to pass to create-database.bat script, just type create-database.bat at the Command Prompt and press enter. The list of parameters that you need to pass to this script will be displayed.
Example
Upgrading the Data Manager Database
To upgrade the MAIL360 Data Manager database, complete the following steps:
1. Stop all MAIL360 Data Manager processing and programs, including all associated Windows services.
2. Back up the previous version of MAIL360 Data Manager database.
3. Open DOS Command Prompt and execute the following batch file. This batch file is located in the <Install directory>\setup\db\DataManager folder (Refer "Important Points to Remember” on page 49):
upgrade-database30To31.bat
Chapter 3: Setting Up the MAIL360 Data ManagerTM Databases Setting Up Your Databases
Example
upgrade-database30To31.bat localhost\instance mail360dm domain\mail360
For more information on parameters, refer Command Parameters. The Data Manager database upgrades to version 3.1.0.
4. If you previously used SQL Server 2008 for SSRS, you must now use Microsoft® SQL Server® 2012 Enterprise Edition. Follow the instructions under "Configuring SQL Server Reporting Services (SSRS) Security” on page 54.
5. Once you upgrade the database from version 3.0.0 to 3.1.0, some of the following indexes may not be created:
– ix_acs_address_changes_insert_timestamp
– ix_acs_nixies_insert_timestamp
– ix_outmailpiece_scans_insert_timestamp
– ix_inmailpiece_scans_insert_timestamp
– ix_outmailpieces_job_mailing_date

Mail360 Data Manager v3.1.0 Install Admin Guide

Documents

Transcript of Mail360 Data Manager v3.1.0 Install Admin Guide