engageone smart view · 2019-04-07 · 3 software release contents the engageone smart view...

EngageOne Smart View Document Version 601-00003-001

US English Edition

Installation Guide

ii

____________________________________________________________________________________

Copyright ©2016 Pitney Bowes All rights reserved.

This publication and the software described in its supplied under license and may only be used or copied in accordance with the terms of such license. The information in this publication is provided for information only, is subject to change without notice, and should not be construed as a commitment by Pitney Bowes Software. Inc. (PB). To the fullest extent permitted by applicable laws PB excludes all warranties, representations and undertakings (express or implied) in relation to this publication and assumes no liability or responsibility for any errors or inaccuracies that may appear in this publication and shall not be liable for loss or damage of any kind arising from its use.

Except as permitted by such license, reproduction or any part of this publication by mechanical, electronic, recording means or otherwise, including fax transmission, without the express permission of PB is prohibited to the fullest extent permitted by applicable laws.

Nothing in this notice shall limit or exclude PB liability in respect of fraud or for death or personal injury arising from its negligence. Statutory rights of the user, if any, are unaffected.

*TALO Hyphenators and Spellers are used. Developed by TALO B.V., Bussum, Netherlands

Copyright © 1998 * TALO B.V., Bussum, NL

*TALO is a registered trademark ®

Encryption algorithms licensed from Unisys Corp. under U.S. Patent No. 4, 558,302 and foreign counterparts

Security algorithms Copyright ©

1991 – 1992 RSA Data Security Inc.

Copyright © DL Technology Ltd 1992-2010

Barcode fonts Copyright © 1997 Terrapin Solutions Ltd. with NRB Systems Ltd.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

Artifex and the Ghostscript logo are registered trademarks and the Artifex logo and Ghostscript are trademarks of Artifex Software, Inc.

Copyright (c) 2000 - 2015 The Legion of the Bouncy Castle Inc. (http://www.bouncycastle.org

This product contains the Regex++ library. Copyright © 1998-2000 by Dr. John Maddock

PostScript is a trademark of Adobe Systems Incorporated.

PCL is a trademark of Hewlett Packard Company.

ICU License - ICU 1.8.1 and later Copyright (c) 1995-2006 International Business Machines Corporation and others. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Software and that both the above copyright notice(s) and this permission notice appear in supporting documentation.

Matra 0.8b (http://matra.sourceforge.net/) The contents of this documentation are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this documentation except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

Otherwise all product names are trademarks or registered trademarks of their respective holders.

iii

Table of Contents 1 Overview ............................................................................................................................................... 1

2 Document Layout, Design, and Audience ............................................................................................. 1

3 Software Release Contents ................................................................................................................... 2

4 Am I Capable of Installing EngageOne Smart View? ............................................................................. 2

5 What Components Are Available After EngageOne Smart View Installation? ..................................... 2

6 EngageOne Smart View Solution Architecture ..................................................................................... 3

6.1 Software Structure ........................................................................................................................ 3

6.2 Infrastructure Design .................................................................................................................... 4

7 EngageOne Smart View Software Preparation ..................................................................................... 5

7.1 Operating System, Production Server Installation ........................................................................ 6

7.2 Database ....................................................................................................................................... 6

7.3 Application Server ......................................................................................................................... 6

7.4 Browser Support ........................................................................................................................... 6

8 Licenses and Third-Party Software ....................................................................................................... 7

9 Installation Checklists ........................................................................................................................... 7

9.1 MySQL ........................................................................................................................................... 8

9.2 PostgreSQL .................................................................................................................................. 10

9.3 Oracle .......................................................................................................................................... 13

10 EngageOne Smart View Database Installation .................................................................................... 16

10.1 MySQL Community Server .......................................................................................................... 16

10.1.1 Java Cryptography Extension Unlimited Strength Jurisdiction Policy Files Download ....... 17

10.1.2 Digital Self-Service Database Installation ........................................................................... 17

10.2 PostgreSQL Database Installation ............................................................................................... 23



10.3 Oracle .......................................................................................................................................... 32

10.3.1 JDBC Driver Installation ....................................................................................................... 32



11 EngageOne Smart View Software Installation .................................................................................... 41

11.1 Installation .................................................................................................................................. 41

11.2 Validation .................................................................................................................................... 56

iv

12 EngageOne Vault File Exportation to EngageOne SmartView ............................................................ 64

13 EngageOne Smart View Server Configuration .................................................................................... 65

13.1 System Administrator Login ........................................................................................................ 65

13.2 Configuration Process, In Short .................................................................................................. 66

13.3 Connect to SMTP Server ............................................................................................................. 67

13.4 Load Custom Brand ..................................................................................................................... 68

13.5 Configure E-mail .......................................................................................................................... 70

13.6 Configure Language Support ....................................................................................................... 72

13.7 Configure Registration and Sign-in ............................................................................................. 74

13.8 Configure Current Balance .......................................................................................................... 76

13.9 Configure Third Party Authentication ......................................................................................... 78

13.10 Configure Payment ................................................................................................................. 79

14 Apache Web Server Configuration ..................................................................................................... 80

14.1 Load Balancing ............................................................................................................................ 80

14.2 Protection ................................................................................................................................... 81

14.3 HTTP Headers .............................................................................................................................. 81

14.4 Web Server Configuration........................................................................................................... 81

14.4.1 Configure Static Resource Caching ..................................................................................... 81

14.4.2 Configure Load Balancing .................................................................................................... 82

15 Establish Agent Portal Role Designations ........................................................................................... 82

15.1 Role Designations ........................................................................................................................ 82

15.2 Establish Roles ............................................................................................................................. 83

16 Troubleshooting .................................................................................................................................. 87

16.1 Unable to Register ...................................................................................................................... 87

16.2 Changing the Port ....................................................................................................................... 88

16.3 Unable to Access DSS Applications from Other Machines (Windows Only) ............................... 89

16.3.1 Potential Cause ................................................................................................................... 89

16.3.2 Solution (if Windows is blocking access to port) ................................................................ 89

16.3.3 Solution (if Windows is specifically blocking Java) .............................................................. 90

16.4 Customer Portal Displays Database Error Upon Access ............................................................. 90

16.4.1 Potential Cause ................................................................................................................... 90

16.4.2 Additional Logs .................................................................................................................... 90

16.4.3 Solution (if database is down) ............................................................................................. 91

v

16.4.4 Solution (if firewall is blocking the connection) .................................................................. 91

16.4.5 Solution (if Digital Self Service is configured improperly) ................................................... 91

16.5 Batch Jobs in Scheduler Report Failure When Run ..................................................................... 92

16.5.1 Potential Cause ................................................................................................................... 92

16.5.2 Additional Logs .................................................................................................................... 92

16.5.3 Solution (if database is down) ............................................................................................. 93

16.5.4 Solution (if firewall is blocking the connection) .................................................................. 93

16.5.5 Solution (if Digital Self Service is configured improperly) ................................................... 93

16.6 Jobs Not Available (and Do Not Install) in Jenkins Job Scheduler ............................................... 94

16.6.1 Potential Cause ................................................................................................................... 94

16.6.2 Solution ............................................................................................................................... 94

16.7 Tomcat Does Not Start (and Message Display Prevents Customer Portal Access)..................... 94

16.7.1 Potential Cause ................................................................................................................... 94

16.7.2 Verify the Problem .............................................................................................................. 94

16.7.3 Change Digital Self Service Port .......................................................................................... 95

16.8 Unable to Receive E-mails ........................................................................................................... 95

16.8.1 Potential Cause ................................................................................................................... 95

16.8.2 Check the Logs .................................................................................................................... 95

16.8.3 Verify the Servers are Running ........................................................................................... 95

16.8.4 Start (or Restart) the Notification Servers .......................................................................... 96

16.8.5 Verify the SMTP Config ....................................................................................................... 96

1

1 Overview EngageOne SmartView provides users with a secure online view of documents stored in the Pitney Bowes EngageOne Vault repository. Through EngageOne SmartView, end customers and business support personnel can search for, retrieve, and view a variety of documents including account statements, contracts, policy materials, and other correspondence - both recent and historical. EngageOne SmartView presents these documents in a simple and organized format, making them easy to find while enabling effective and efficient task completion.

The EngageOne SmartView Installation Guide provides step-by-step instructions that allow you to install and configure this software.

2 Document Layout, Design, and Audience The EngageOne Smart View Installation Guide is divided into four primary sections: Software Preparation, Database Installation, Software Installation, and Server Configuration.

• Software Preparation o Ensuring system requirements and other prerequisites are satisfied prior to database

and software installation. • Database Installation

o Choosing MySQL, PostgreSQL, or Oracle then installing the selected database system. This database system will house the Digital Self-Service (DSS) database product. The DSS database product also will house user authentication information, user profiles, document details, and audit logs.

o Running the dss_db.exe file to install the DSS database product. • Software Installation

o Running the install.exe file to load the EngageOne Smart View software. • Server Configuration

o Setting up the server, which involves signing into EngageOne Smart View and navigating a series of pages to establish application and connection settings.

The chronological layout of this document provides the sequence of instructions that allows you to install and configure EngageOne Smart View, completely and successfully.

This document is intended for system administrators and other authorized (and qualified) users who need to understand the EngageOne Smart View installation and configuration processes.

2

3 Software Release Contents The EngageOne Smart View software release contains:

• Sizing Sheets – A form that provides additional specifications as to ensure you configure hardware that is sufficient to support your needs.

• dss_db.exe – The executable file that allows you to install the DSS database. • install.exe – The executable file that allows you to install EngageOne Smart View. • The EngageOne Smart View Installation Guide – The document that provides instructions for

software installation and configuration.

All release contents will be shipped on a single electronic medium.

4 Am I Capable of Installing EngageOne Smart View? To install EngageOne Smart View successfully, you must have knowledge of the system administration and database installation processes on the machine where you will load this software; in addition, you must be familiar with the Java Development Kit (JDK) and server installation processes for this machine. For example, you must have an understanding of the systems administration process for the machine on which you will install this software – be it Windows 7, 8, 10, or Linux. If you perform this installation on a Windows platform, you will need to be part of the systems administration group. If you perform this installation on a Linux platform, you will need root access. In addition to knowledge of the systems administration and database installation processes, you must have a solid understanding of web application servers and contemporary browsers.

Note: Going forward, this document will use the reference – UN*X – to represent a Unix-like platform or operating system. UN*X platforms (such as Linux, for example) behave similarly to Unix.

5 What Components Are Available After EngageOne Smart View Installation? Upon software installation completion, you will have access to several primary EngageOne Smart View components:

• Customer Portal o The online location that allows you to search for account information and documents,

view document content, modify personal profile settings, receive notifications, and print materials.

• Agent Portal o The application that allows agents to search for customer records while also allowing

these agents to provide customers with troubleshooting assistance. This assistance includes impersonation which allows an agent to view customer information in the Customer portal, exactly as that customer would view it.

• Core Platform o The primary environment on which EngageOne Smart View resides, where batch jobs

run and monitoring software exists to ensure the site is up, running, and operational.

3

Meticulously planned and developed, the design of the EngageOne Smart View user interface (like all EngageOne Liaison solutions) facilitates the ease by which you can navigate this software. Simple and clean, the layout of each page contains a well-evaluated placement of buttons, drop-down list boxes, and fields along with relevant content and images that allow you to use the application with efficiency.

EngageOne Smart View fits easily into your existing online environment. In addition, you can integrate EngageOne Smart View with the EngageOne Smart Bill and EngageOne Smart Pay solutions.

This software runs in a standard Java server, supports a variety of database platforms, and is easily branded to your online standards; in addition, it provides secure access through your existing authenticated portal or on its own as a secure, stand-alone solution.

EngageOne Smart View comes with the open source Jenkins job scheduler, pre-configured and accessible through a web URL. As a system administrator, you can use the Jenkins job scheduler to select specific jobs (such as file purges, software updates, and utility loads) and determine when (and how often) they run. When a job runs, you can monitor the job status (by viewing a progress bar) and – contingent upon exactly when and how long the job runs (daily, nightly, every 5 minutes) – observe its completion. In addition, you can configure the Jenkins job scheduler to notify you when a job fails for any reason.

Since many IT organizations have a preferred enterprise job scheduler, EngageOne Smart View batch and background processes are configured through shell scripts that you can implement as part of your preferred scheduler. If you choose this option, you can configure your scheduler in an approximately 2-day timeframe.

6 EngageOne Smart View Solution Architecture This section describes EngageOne Smart View as a two-part architecture:

• Software Structure • Infrastructure Design

6.1 Software Structure As one of several modular components that comprises the EngageOne Liaison suite of self-service applications, EngageOne Smart View is a deployment-ready solution – requiring no programming or integration. Each module follows a common design and implementation architecture aligned with a Java servlet-based platform.

A patented use case engine forms the foundation of all EngageOne Liaison solutions. This use case engine, which emphasizes user and system interactions, is at the heart of the application suite. This engine uses system and data resources, formulates web pages in real time, and drives the application flow. The platform lets developers express a web application as a set of formalized, goal-oriented use cases. The EngageOne Liaison use cases are declarative (less procedural), allowing developers to focus more on describing what needs to happen rather than being consumed with the coding details specific to how it happens. The roots of this style – describing business use cases – was pioneered by Computer Scientist Alistair Cockburn.

4

Use Case-Based Benefits

A clear delineation of software components allows you to brand, localize, and configure the solution without code modifications.

A unified modular design allows you to add other EngageOne Liaison modules (such as Smart Bill and Smart View) without additional coding.

An architecture that allows you to move to a fully configurable enterprise solution where you can develop use cases that meet your specific business needs. Style, brand, and localization all fit the architecture; likewise, your custom configured modules fit seamlessly with existing product modules.

A structured software architecture shields you from most technology changes by allowing control and maintenance of platform changes, web technology changes, and enhancements to rest solely in the hands of the client ─ a product company committed to the platform.

Key technical components include:

• A standard platform web archive (WAR) ─ File that contains the use case engine and core platform services. Use case applications are stored outside the WAR, so platform upgrades are straightforward. The standard WAR runs in a variety of Java application servers including Apache Tomcat, JBoss, Oracle WebLogic, and IBM Websphere.

• Spring Framework-based database queries ─ Queries that allow the product to support a variety of databases without affecting other components. Supported databases include MySQL, PostgreSQL, and Oracle.

• Jenkins-based background and batch services platform ─ Open source scheduler with all jobs written in a manner that allows easy integration into your enterprise job scheduler.

• Bootstrap 3 Cascading Style Sheet (CSS) ─ This popular package allows EngageOne Smart View to implement a responsive web design. You can apply any Bootstrap or template, or you can create your own when branding EngageOne Smart View for your business. The result is an application that works equally well on smartphones, tablets, and computers.

• Angular JavaScript (JS) framework ─ Framework that allows EngageOne Smart View to implement advanced client-side user interactions across all modern browsers. The result is a sophisticated, modern user experience that provides fast and dynamic user interaction without numerous screen refreshes.

6.2 Infrastructure Design EngageOne Smart View's proven n-tier deployment model supports configurations with millions of user visits per month. Based on capacity requirements, your installation can reside on a single server or clustered across servers that specialize in managing web access, application functions, database functions, and batch/background operations. EngageOne Smart View runs appropriately on realized hardware as well as virtualized systems. The image below depicts the structure of this n-tier architecture.

5

n-Tier Architecture

EngageOne Smart View follows best practices in implementing an n-tier architecture. The tiers are as follows:

• Web Tier ─ Web servers with caching for frequently accessed static information and images. External access is via HTTPs.

• Application Tier ─ Application servers running a Java servlet application server. The standard WAR platform and all applications reside on these servers.

• Database Tier ─ Database servers running your selected database system. Servers can be configured in any fail-over scenario supported by your selected database server.

• Batch and Background Tier ─ Typically, one or two servers that load data, manage application-specific information, and provide e-mail services.

7 EngageOne Smart View Software Preparation

6

This section includes the system requirements for EngageOne Smart View. In addition to the system requirements referenced below, you must have reviewed the sizing sheets (specifications provided with this software) to ensure you configure hardware that is sufficient to support your needs. You also must have installed EngageOne Vault (minimum version 7.2), and you must have data in this repository. Next, ensure that you have a mail server installed. (Sites such as https://mailtrap.io/ allow you to create an SMTP server for testing purposes.) Finally, you must have installed Java (minimum version 8) along with the JDK (minimum version 1.8).

7.1 Operating System, Production Server Installation • Redhat Enterprise Linux Versions 6 and 7 • Solaris 10 and Solaris 9 • HP/UX 11i (v2, v3) • IBM AIX 7, AIX 6 • Windows 7, 8, or 10 • 4g RAM (minimum) • ANT installation (required)

7.2 Database • Oracle Enterprise Edition 11g or 12g • MySQL 5.5 - 5.7 • PostgreSQL 9.5 - 9.6 • Database Storage - 100g (typical)

7.3 Application Server • Apache Tomcat: Version 7.0 - 9.0 • JBoss Enterprise Application Platform: Version 6.2 - 7.0.0 • JBoss Application Server (Community Version) - renamed WildFly: Version 8.2 - 10.0.0 • Oracle WebLogic Server (Standard Edition or Enterprise Edition): Version 12.1.2 - 12.2.1 • WebSphere Application Server: Version 8.5 - 8.5.5

Note: This document provides instructions specific to the Apache Tomcat application server. If you are using a different application server, you must collaborate with your appropriate application administrator.

7.4 Browser Support EngageOne Smart View is compatible with current and previous versions of major browsers for desktops, mobile devices, and tablets. Since all modern browsers implement an auto update feature, these versions are generally sufficient. Browser and OS support are summarized below:

• Chrome ─ Current version and previous version; OS includes Android, IOS, Mac OS X, Linux, and Windows.

• Internet Explorer ─ Version 11; OS includes Windows. • Microsoft Edge ─ Current version; OS includes Windows. • Firefox ─ Current version and previous version; OS includes Android, Mac OS X, Linux,

and Windows.

https://mailtrap.io/

7

• Safari ─ Current version and previous version; OS includes IOS and Mac OS X.

8 Licenses and Third-Party Software You must have a properly licensed version of the operating system, database, application server, and any other supporting software you install ─ abiding by all license agreement terms and conditions.

9 Installation Checklists As a prerequisite to database system installation, you must have the following:

• Adequate web tier server(s), application server(s), SMTP e-mail server, and operating system (and login credentials to access each system).

• A license to install EngageOne Smart View. • A database system (MySQL, PostgreSQL, or Oracle).

After satisfying the hardware, system, licensing, and third-party software requirements, you should complete the Installation Checklist below (based on your selected database system). This checklist references information required during the installation processes. With access to this information beforehand, you can progress smoothly through the software and database installation processes without interruption.

You should document all requested information in your selected checklist below (and maintain immediate access to this table data), as you will be prompted to answer specific questions during the installation processes. Having this information at your fingertips will expedite the installation processes.

8

9.1 MySQL Task

Complete? Information Required Information Retrieval Location Action

□

Pre-designated Location for the MySQL Database System

MySQL Installation (Internal Directory Structure)

Enter the directory location. MySQL Directory Path: ___________________________________________________________

□

MySQL Root Password MySQL Installation (Create) During the database installation process, you will be prompted for a MySQL Root Password that you must create. It is critical that you remember this password, as you will need it when you install the database product. MySQL Root Password: ____________________________________________________________

□

Pre-designated Location for the Database Product

Digital Self-Service Database Installation (Internal Directory Structure)

During database installation, you must store the database file. In addition, you must enter the previously designated MySQL Root Password (in the MySQL Server window in the DBA password field). In this same window, you (optionally) may edit the Database host and Database port fields as well as the Schema name field in the Digital Self-Service Information window (or accept the default data). In the Digital Self-Service Information window, you must recall the data you enter in the User name and Password fields - as you must enter this information in the corresponding fields during EngageOne SmartView installation. Database Directory Path: _____________________________________________________________________ User name (also use for EngageOne SmartView installation): __________________________________________________________________________________________ Password (also use for EngageOne SmartView installation): __________________________________________________________________________________________

□

Product Installer Directory Path, Pitney Bowes License File (Directory Location), Base URL (or External Host), and Database Password.

Product Installation (Internal Directory Structure) IT Team

During the EngageOne SmartView installation process, you must enter the directory path to store the EngageOne SmartView installation files along with the directory path of the Pitney Bowes license file; in addition, you must enter the JDK directory path. You also must enter a base URL (or external host). For example, www.yourcompany.com might represent an external host; http://localhost:8080 might represent an internal or demo configuration. Next, you must create a database password. EngageOne SmartView Directory Path: __________________________________________________________ PB License Directory Path: ____________________________________________________________________ JDK Directory Path: __________________________________________________________________________________________

9

Task Complete?

Information Required Information Retrieval Location Action

URL/External Host: __________________________________________________________________________ Database User (from DSS database installation): ___________________________________________________________________________________________ Database Password (from DSS database installation): ___________________________________________________________________________________________

□

IP Address, Port Number, EngageOne Vault Database Name, SMTP Mail User, and SMTP Mail User Password along with Directory Paths for the Custom brand/e-mail templates/localization/registration .zip files

IT Team

To complete the configuration process, you will need to enter the EngageOne Vault IP address or URL, the Port Number on which EngageOne Vault is listening, and the EngageOne Vault database name. If you enable authentication, you must enter an SMTP Mail User and SMTP Mail User Password. In addition, you will need the directory paths for your custom brand, e-mail templates, localization files, and registration .zip files. IPV4, IPV6, or DNS host name (for Storage server): ___________________________________________________________________________________________ IPV4, IPV6, or DNS host name (for SMTP server): ___________________________________________________________________________________________ Port Number: ____________________________________________________________________________ (SMTP) Mail User: ____________________________________________________________________________ (SMTP) User Password: _______________________________________________________________________ Custom Brand Directory Path: _______________________________________________________________ Custom E-mail Templates Directory Path: _________________________________________________________ Custom Localization Directory Path: ______________________________________________________________ Custom Registration File Directory Path ___________________________________________________________

□ Testing and Validation of Data Uploads for Server Configuration

IT Team As you upload data (such as custom brands, e-mail templates, localization files, and registration files), you (previously) must have tested and validated this information on a non-production system. All configuration uploads into the production environment exclude testing, as testing exceeds the scope of this document.

MySQL Checklist

10

9.2 PostgreSQL Task

Complete? Information Required Information Retrieval

Location Action

□

Pre-designated Location for the PostgreSQL Database System. Upon Installation, Record Location of Newly Created data Directory

PostgreSQL Installation (Internal Directory Structure)

Enter the directory locations. PostgreSQL Directory Path: _________________________________________________ PostgreSQL data Directory Path: _____________________________________________

□

PostgreSQL Database Superuser Password PostgreSQL Installation (Create) During the database installation process, you will be prompted for a PostgreSQL Password that you must create. It is critical that you remember this password, as you will need it when you install the Digital Self-Service database product. DBA Superuser Password: _________________________________________________

□

Pre-designated Location for the Database Product Digital Self-Service Database Installation (Internal Directory Structure)

During database installation, you must store the database file. In addition, you must enter the previously designated DBA Superuser Password (in the PostgreSQL Server window in the DBA password field). In this same window, you (optionally) may edit the Database host and Database port fields as well as the Directory for the table space and Prefix for the table space fields in the Digital Self-Service Information window (or accept the default data). In the Digital Self-Service Information window, you must recall the data you enter in the Name and Password fields - as you must enter this information in the corresponding fields during EngageOne SmartView installation. In the Directory for the table space field (in the Digital Self-Service Information window), you must enter the path of the data directory; you established this path after PostgreSQL database system installation. Database Directory Path: __________________________________________________ Name (also use for EngageOne SmartView installation): _______________________________________________________________________ Password (also use for EngageOne SmartView installation): _______________________________________________________________________ Directory for the table space: _______________________________________________________________________

□

Product Installer Directory Path, Pitney Bowes License File (Directory Location), Base URL (or External Host), and Database Password

Product Installation (Internal Directory Structure) IT Team

During the EngageOne SmartView installation process, you must enter the directory path to store the EngageOne SmartView installation files along with the directory path of the Pitney Bowes license file; in addition, you must enter the JDK directory path. You also must enter a base URL (or external host). For example, www.yourcompany.com might represent an external host; http://localhost:8080 might represent an internal or demo configuration. Next, you must create a

11

Task Complete?

Information Required Information Retrieval Location

Action

database password. EngageOne SmartView Directory Path: ________________________________________________________________________ PB License Directory Path: _________________________________________________ JDK Directory Path: _______________________________________________________________________ URL/External Host: _______________________________________________________ Database User (from DSS database installation): _______________________________________________________________________ Database Password (from DSS database installation): _______________________________________________________________________

12

Task Complete?


Action

□


IT Team

To complete the configuration process, you will need to enter the EngageOne Vault IP address or URL, the Port Number on which EngageOne Vault is listening, and the EngageOne Vault database name. If you enable authentication, you must enter an SMTP Mail User and SMTP Mail User Password. In addition, you will need the directory paths for your custom brand, e-mail templates, localization files, and registration .zip files. IPV4, IPV6, or DNS host name (for Storage server): _______________________________________________________________________ IPV4, IPV6, or DNS host name (for SMTP server): _______________________________________________________________________ Port Number: ________________________________________________________ (SMTP) Mail User: _______________________________________________________ (SMTP) User Password: __________________________________________________ Custom Brand Directory Path: __________________________________________ Custom E-mail Templates Directory Path: _______________________________________________________________________ Custom Localization Directory Path: __________________________________________ Custom Registration File Directory Path: _______________________________________________________________________

□ Testing and Validation of Data Uploads for Server Configuration IT Team As you upload data (such as custom brands, e-mail templates, localization files, and registration files), you (previously) must have tested and validated this information on a non-production system. All configuration uploads into the production environment exclude testing, as testing exceeds the scope of this document.

PostgreSQL Checklist

13

9.3 Oracle Task

Complete? Information Required Information Retrieval

Location Action

□

Pre-designated Location for the Oracle Database System Oracle Installation (Internal Directory Structure)

Enter the directory location. (Typically, you will use the DB HOME directory. In the base directory for Oracle 11g/12g, this information commonly appears as: …\product\\db_1 or dbhome_1 directory.) Oracle Directory Path: ____________________________________________________________

□

Oracle SYSDBA User Name and Password Oracle Installation (Create) During the database installation process, you will be prompted for a User Name and Password that you must create. It is critical that you remember this information, as you will need it when you install the database product. Oracle SYSDBA User name: _______________________________________________________ Oracle SYSDBA Password: _______________________________________________________

□

Oracle JDBC Driver Directory Path IT Team During database installation, you must indicate the directory path of the JDBC driver (ojdbc7.jar). You must download this driver from the Oracle website. Oracle JDBC Driver Directory Path: __________________________________________________

□

Pre-designated Location for the Database Product Digital Self-Service Database Installation (Internal Directory Structure)

During database installation, you must store the database file. In addition, you must navigate to (and select) the JDBC driver. You also must enter the previously designated Oracle SYSDBA password (in the Oracle Server window in the DBA password field). In this same window, you (optionally) may edit the Database host, Database port, and Database name fields as well as the Directory for the table space and Prefix for the table space fields in the Digital Self-Service Information window (or accept the default data). In the Digital Self-Service Information window, you must recall the data you enter in the Name and Password fields - as you must enter this information in the corresponding fields during EngageOne SmartView installation. Database Directory Path: _________________________________________________________ Name (also use for EngageOne SmartView installation): ______________________________________________________________________________ Password (also use for EngageOne SmartView installation): ______________________________________________________________________________

□ Product Installer Directory Path, Pitney Bowes License File (Directory Location), Base URL (or External Host), and Database Product Installation (Internal During the EngageOne SmartView installation process, you must enter the directory path to store

the EngageOne SmartView installation files along with the directory path of the Pitney Bowes

14

Task Complete?


Action

Password Directory Structure) IT Team

license file; in addition, you must enter the JDK directory path. You also must enter a base URL (or external host). For example, www.yourcompany.com might represent an external host; http://localhost:8080 might represent an internal or demo configuration. Next, you must create a database password. EngageOne SmartView Directory Path: _______________________________________________ PB License Directory Path: _________________________________________________________ JDK Directory Path: _______________________________________________________________________________ Base URL/External Host: __________________________________________________________ Database User (from DSS database installation): ____________________________________________ Database Password (from DSS database installation): _______________________________________________________________________________

15

Task Complete?


Action

□


IT Team

To complete the configuration process, you will need to enter the EngageOne Vault IP address or URL, the Port Number on which EngageOne Vault is listening, and the EngageOne Vault database name. If you enable authentication, you must enter an SMTP Mail User and SMTP Mail User Password. In addition, you will need the directory paths for your custom brand, e-mail templates, localization files, and registration .zip files. IPV4, IPV6, or DNS host name (for Storage server): ______________________________________________________________________________ IPV4, IPV6, or DNS host name (for SMTP server): ______________________________________________________________________________ Port Number: _______________________________________________________________ (SMTP) Mail User: ______________________________________________________________ (SMTP) User Password: __________________________________________________________ Custom Brand Directory Path: __________________________________________________ Custom E-mail Templates Directory Path: ____________________________________________ Custom Localization Directory Path: _________________________________________________ Custom Registration File Directory Path: _____________________________________________

□ Testing and Validation of Data Uploads for Server Configuration IT Team As you upload data (such as custom brands, e-mail templates, localization files, and registration

files), you (previously) must have tested and validated this information on a non-production system. All configuration uploads into the production environment exclude testing, as testing exceeds the scope of this document.

Oracle Checklist

16

10 EngageOne Smart View Database Installation

This section provides installation instructions for the MySQL, PostgreSQL, and Oracle database systems. Contingent upon the database system you select, you must follow database system installation instructions for that particular database. Your selected database system (MySQL, PostgreSQL, or Oracle) will house the DSS database. The DSS database stores authentication information, user profiles, document details, and audit logs.

10.1 MySQL Community Server

Note for Installer or Database Administrator:

If the installer has access to the database administrator (DBA) credentials, the installer can: Create a database instance Create a database user

If the installer does not have access to the DBA credentials, then a DBA must perform these actions manually (if, in fact, the installer does not perform them). In the following statements, the values inside the < > symbols must be replaced with values that make sense for your environment. The person performing the DSS database installation requires these values as well. Command - Create the database SQL: create database Create the user SQL; create user identified by ''; grant ALL on . *to '@'%';

The MySQL database system installation process involves installing the current MySQL database version. To begin the download installation process, access the MySQL website at http://dev.mysql.com/downloads/mysql/ and follow the installation instructions.

When performing this installation:

• Select the custom installation. • Install the current version of MySQL Server and MySQL Workbench. • At the Type and Networking page, select Development Machine from the Config Type

drop-down list box. • Create (and record) the database password, as you must enter this information during

the DSS database installation process.

http://dev.mysql.com/downloads/mysql/

17

The EngageOne Smart View, DSS database, and Payment database installation processes contain the required JDBC drivers. As such, you do not have to install the JDBC drivers if you are using the MySQL database system.

Note: For UN*X users, after installing MySQL, perform the following actions -

1. Open terminal and edit /etc/mysql/my.cnf sudo nano /etc/mysql/my.cnf 2. After the mysqld section, add:

lower_case_table_names = 1 3. Restart mysql sudo /etc/init.d/mysql restart

10.1.1 Java Cryptography Extension Unlimited Strength Jurisdiction Policy Files Download The Java Cryptography Extension (JCE), an addition to the Java platform (with downloads available for Java 6, 7, and 8), supports the implementation of various security features to include encryption. To begin the JCE download process, access the Oracle website at http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html, accept the License agreement, and follow the download instructions for the most current file version. Upon download completion, you must extract the two .jar files (local_policy and US_export_policy) – overwriting the two existing files (by the same name) located in your JRE and JDK directories (if you have an existing Java version installed). Specifically, you must overwrite the local_policy and US_export_policy jar files located at JRE (lib/security) and JDK (jre/lib/security), respectively.

10.1.2 Digital Self-Service Database Installation Now that you have installed the MySQL database system, you must install the DSS database product. This database product will house user authentication information, user profiles, document details, and audit logs. The DSS database product will be available for download via an FTP link – pending client review and approval.

Note: The client must provide .exe and .jar files for its clients such that these files may be run in both a Windows and UN*X environment.

1. To begin the installation process in a Windows environment, click the installation executable (dss_db.exe). To begin the installation process in a UN*X environment, type java -jar dss_db.jar -console (on the console). The EngageOne Database Setup Welcome window appears.

http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html

18

Welcome: EngageOne Database Setup Wizard

2. To proceed with the DSS database installation, click the Next button. The Database Selection window appears.

Database Selection

19

3. Select the MySQL radio button before clicking the Next button to continue. The Installation Packs window appears. The checkboxes that are disabled (and unavailable for selection) are either required or not supported by the selected database type.

Installation Packs

Note: If this is your first installation, please be certain to select the Create database instance and Create user checkboxes (unless your database administrator has advised otherwise). If you are clearing all data from an existing database and re-installing a QA database, which is not recommended for production, then you should be able to use the existing database instance and user.

4. Accept the default checkbox selections (or select/clear your preferred checkboxes) before clicking the Next button to continue. The MySQL Server window appears.

20

MySQL Server

5. Enter the DBA password you created previously during the MySQL database system installation and configuration process (and edit any other fields as needed).

6. To continue, click the Next button. The Digital Self-Service Information window appears.

21

Digital Self-Service Information

7. Create (and enter) password information (and edit any other fields as needed) before clicking the Next button to continue. (You must recall this password, as you must enter this password during EngageOne Smart View installation. If you edit the User name field, you must recall this user name also – as you must enter this user name during EngageOne Smart View installation.) The Processing window appears, displaying several lines of continually changing code. Upon processing completion, the Next button becomes enabled.

22

Processing Begins

Processing Ends

8. To continue, click the Next button.

23

An installation window appears.

Digital Self-Service Database Installation Successful

9. To complete the installation, click the Done button. DSS database installation complete.

10. Proceed with EngageOne Smart View installation.

10.2 PostgreSQL Database Installation Note for Installer or Database Administrator:

If the installer has access to the database administrator (DBA) credentials, the installer can: Create a database instance Create a database user Create the database table spaces

If the installer does not have access to the DBA credentials, then a DBA must perform these actions manually (if, in fact, the installer does not perform them). In the following statements, the values inside the < > symbols must be replaced with values that make sense for your environment. The person performing the DSS database installation requires these values as well. Commands - Create the database SQL: create database encoding='UTF8' connection limit=-1 Create the table spaces SQL: create tablespace _data owner postgres location ''; create tablespace _idx owner postgres location '; Create the user SQL;

24

Note for Installer or Database Administrator:

create user PASSWORD ''; grant ALL on to ; grant ALL ON TABLESPACE _idx to

25




26

Database Selection

3. Accept the PostgreSQL default radio button selection and click the Next button to continue. The Installation Packs window appears. The checkboxes that are disabled (and unavailable for selection) are either required or not supported by the selected database type.

27

Installation Packs

Note: If this is your first installation, please be certain to select the Create database instance, Create table spaces, and the Create user checkboxes (unless your database administrator has advised otherwise). If you are clearing all data from an existing database and re-installing a QA database, which is not recommended for production, then you should be able to use the existing database instance and user.

4. Accept the default checkbox selections (or select/clear your preferred checkboxes) before clicking the Next button to continue. The PostgreSQL Server window appears.

28

PostgreSQL Server

5. Enter the DBA password you created previously during the PostgreSQL database system installation process (and edit any other fields as needed).


29


7. Create (and enter) password information (and edit any other fields as needed). (You must recall this password, as you must enter this password during EngageOne Smart View installation. If you edit the Name field, you must recall this user name also – as you must enter this user name during EngageOne Smart View installation).

8. Modify the Directory for the table space field to point to your PostgreSQL data directory where you manually created the ecare_data and ecare_idx directories.

9. To continue, click the Next button. The PostgreSQL Prep window appears. This window contains read-only information, which corresponds to the directory information you designated in the previous window.

30

PostgreSQL Prep

10. To continue, click the Next button. The Processing window appears, displaying several lines of continually changing code. Upon processing completion, the Next button becomes enabled.

31

Processing Ends

11. To continue, click the Next button. An installation window appears.


32



10.3 Oracle Note for Installer or Database Administrator:

If the installer has access to the database administrator (DBA) credentials, the installer can: Create a database user

If the installer does not have access to the DBA credentials, then a DBA must perform these actions manually (if, in fact, the installer does not perform them). In the following statements, the values inside the < > symbols must be replaced with values that make sense for your environment. The person performing the DSS database installation requires these values as well. Commands - Create the Table spaces SQL: create tablespace _data logging datafile '' size 4M reuse autoextend on next 4M maxsize unlimited extent management local; Create the user SQL; create user default tablespace _data identified by profile default; grant connect to ; grant alter session to ; grant create procedure to ; grant create sequence to ; grant create session to ; grant create table to ; grant create trigger to ; grant create view to ; grant create job to ; alter user quota unlimited on _data; alter user quota unlimited on _idx;

The Oracle database system installation process involves installing the current Oracle database version. To begin the download installation process, access the Oracle website at https://www.oracle.com/downloads/index.html and follow the installation instructions.

When performing this installation:

• Create (and record) the database password, as you must enter this information during the DSS database installation process.

Unlike the EngageOne Smart View, the DSS database installation processes for the MySQL and PostgreSQL database systems, and Payment database installation, the required JDBC drivers are not provided. As such, you must install the JDBC drivers if you are using the Oracle database system.

10.3.1 JDBC Driver Installation The JDBC driver allows the Oracle database system and the DSS database to interact. The DSS database houses user and audit trail information. To begin the JDBC driver download process, access the Oracle website at http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html and follow

https://www.oracle.com/downloads/index.htmlhttp://www.oracle.com/technetwork/database/features/jdbc/index-091264.html

33

the installation instructions for the most current version of ojdbc7.jar (which is certified with JDK7 and JDK8). You must accept the License agreement; in addition, when you click the ojdbc7.jar file to begin your download, you will be prompted to create an Oracle account (establishing a user name and password) before this download begins. During this account creation process, you also must enter your name and company-specific information.

10.3.2 Java Cryptography Extension Unlimited Strength Jurisdiction Policy Files Download The Java Cryptography Extension (JCE), an addition to the Java platform (with downloads available for Java 6, 7, and 8), supports the implementation of various security features to include encryption. To begin the JCE download process, access the Oracle website at http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html, accept the License agreement, and follow the download instructions for the most current file version. Upon download completion, you must extract the two .jar files (local_policy and US_export_policy) – overwriting the two existing files (by the same name) located in your JRE and JDK directories (if you have an existing Java version installed). Specifically, you must overwrite the local_policy and US_export_policy jar files located at JRE (lib/security) and JDK (jre/lib/security), respectively.

10.3.3 Digital Self-Service Database Installation Now that you have installed the Oracle database system and its associated JDBC driver, you must install the DSS database product. This database product will house user authentication information, user profiles, document details, and audit logs. The DSS database product will be available for download via an FTP link – pending client review and approval.

Note: The client must provide .exe and .jar files for their clients such that these files may be run in both a Windows and UN*X environment.

environment.


http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html

34



35

Database Selection

3. Select the Oracle radio button. The Oracle JDBC Driver Selection window appears.

Oracle JDBC Driver Selection

4. Click the Browse button, navigate to the appropriate file location, and double-click the file to populate the Oracle JDBC driver (ojdbc7.jar) field. The file name populates the Oracle JDBC driver (ojdbc7.jar) field.

36

ojdbc7.jar File Selection

5. To continue, click the Next button. The Installation Packs window appears. The checkboxes that are disabled (and unavailable for selection) are either required or not supported by the selected database type.

37

Installation Packs

Note: If this is your first installation, please be certain to select the Create table spaces and Create user checkboxes (unless your database administrator has advised otherwise). If you are clearing all data from an existing database and re-installing a QA database, which is not recommended for production, then you should be able to use the existing table spaces and user.

6. Accept the default checkbox selections (or select/clear your preferred checkboxes) before clicking the Next button to continue. The Oracle Server window appears.

38

Oracle Server

7. Enter the DBA password you created previously during the database system installation process (and edit any other fields as needed).


39


9. Create (and enter) password information (and edit any other fields as needed) before clicking the Next button to continue. (You must recall this password, as you must enter this password during EngageOne Smart View installation. If you edit the Name field, you must recall this user name also - as you must enter this user name during EngageOne Smart View installation.) The Processing window appears, displaying several lines of continually changing code. Upon processing completion, the Next button becomes enabled.

40

Processing Begins

Processing Ends

10. To continue, click the Next button.

41

An installation window appears.




11 EngageOne Smart View Software Installation

11.1 Installation This section guides you through the EngageOne SmartView installation process. The software will run on a Windows or UN*X platform. You may choose to use two machines, running batch jobs on one and the application on the other. You also may choose to use one machine, running both the batch jobs and the application on a single computer.

During the EngageOne SmartView installation process, you will be prompted to select your database system (MySQL, PostgreSQL, or Oracle) along with other specific information such as the JDK directory path, base URL, database password, SMTP mail user, Vault server, and Vault port.

42

1. To begin the EngageOne SmartView installation process in a Windows environment, click the installation executable (install.exe). If you installed EngageOne SmartView on a UN*X platform, type java -jar install.jar -console (on the console). The EngageOne Setup Welcome window appears.

Welcome: EngageOne Setup Wizard

1. To continue, click the Next button. The Install/Upgrade window appears, allowing you to click a radio button to choose between a new or existing server installation.

43

Install/Upgrade

2. Select the appropriate radio button. 3. To continue, click the Next button.

A License window appears, displaying a Browse button that allows you to navigate to (and select) the license file.

44

License File Selection

4. To navigate to the license file, click the Browse button. 5. Locate and highlight the license file then - to make your selection - click the Open button.

The file name populates the License file field.

45

License File

6. To continue, click the Next button. A window appears, allowing you to click a radio button to choose a server type for the installation.

46

Installation Server Selection

7. Accept the Application Server radio button (default). 8. To continue, click the Next button.

The Additional Demo/Development package(s) window appears.

Additional Packages

47

10. Select the checkbox (if preferred) The Profile application provides developers and sales engineers with easy access to registration information for development and demonstrations. Select the Profile application package ONLY when installing demo/development system installations with a small number of bills and/or users. NEVER install it on a production system since the application is not secured for production use and reads all bill variables and registration messages into memory when run.

11. To continue, click the Next button. A directory path window appears.

Installation Path

12. Accept the default or enter a directory path for the EngageOne Smart Pay installation files. For Windows, c:\Program Files\DSS - App is the default directory path. For UN*X, /home//selfservice is the default directory path.

13. To continue, click the Next button. A popup window appears, prompting you to confirm the DSS directory path location.

48

Target Directory Validation

14. To accept (and confirm) the location, click the OK button. A JDK directory selection window appears.

49

JDK Directory Path Selection

15. To navigate to the JDK directory location, click the Browse button. 16. Locate and highlight the JDK file then - to make your selection - click the Open button.

The file name populates the JDK directory field.

50

JDK File Selection 17. To continue, click the Next button.

The Configure Ports window appears.

Configure Ports

51

18. Edit the fields as necessary, particularly if the default ports are already in use. 19. To continue, click the Next button.

The URLs window appears.

URLs

20. Edit the fields (as necessary). 21. To continue and select your database system, click the Next button.

A database selection window appears with PostgreSQL as the default database system.

52

Database Selection

22. To make a selection, choose the appropriate radio button before clicking the Next button to continue. A database connection window appears, where you can enter a Database Password and modify existing data in other fields.

53

Database Connection

23. Enter information in the Database Password and Retype Password fields. Edit any other fields as needed. (The Database User and Database Password fields must contain the same content as the corresponding fields you modified during DSS database installation.)

24. To continue, click the Next button. An installation pack progress window appears.

54

Installation Begins

Installation Ends

55

Upon installation completion, the Next button becomes enabled. 25. To continue, click the Next button.

A shortcuts window appears. This window, however, will not be visible if you installed Smart Pay on a Linux platform; therefore, there will be no subsequent Start menu links. If you installed Smart Pay on a Windows platform, this Shortcuts window will be visible. Accepting the Default option allows the Smart Pay services (such as Start Digital Self Service, Stop Digital Self Service, Agent Portal, Customer Portal, Scheduler, and Batch & Server Jobs) to appear on the Start menu of your computer, which allows ease of access.

Establish Shortcuts for Start Menu

26. To continue, click the Next button. An installation completion window appears.

56

Smart View Installation Successful

27. To complete the installation process, click the Done button. Smart View installation complete.

11.2 Validation To validate successful software installation, you must start your application server. Next, you must ensure that you can view the Jenkins job scheduler and the EngageOne SmartView login pages. Upon confirmation that you can start your application server and view the Jenkins job scheduler as well as the EngageOne SmartView login pages (without issue), software installation validation is complete. Therefore, you have installed EngageOne SmartView, completely and successfully. If you selected the Default option in the Shortcuts window during the EngageOne SmartView installation process (an option that was only available if you installed this software on a Windows platform), you can navigate to the Start menu on your computer and select each option to ensure its availability. If you did not create Start menu shortcuts, you can access the EngageOne SmartView files (from your product installation directory location) and select the appropriate files to run these programs.

57

Start Menu Shortcuts

1. To start Tomcat, click Start Digital Self Service from the Start menu (or run startup.cmd in your product installation directory). If you installed EngageOne SmartView on a UN*X platform, you can start/stop this application by running start.sh and shutdown.sh (respectively) on the console; these commands call set_env.sh. The Start Digital Self Service window appears, executes a number of statements/commands, and then disappears.

Start Digital Self Service

Next, the Tomcat window appears (and remains). Ensure Tomcat continues to run as you access (and validate) the EngageOne SmartView application.

58

Tomcat

2. To access the Agent portal, choose this option from your computer's Start menu shortcut or by entering http://localmachine:/personaWeb/admin/ in your browser. The configured port is the port number you chose when installing the application (8080 by default). The Agent portal login window appears. You must enter login credentials and navigate the portal pages to ensure the application is working properly. The default login credentials are as follows: user name - superAdmin; password - superAdmin1; secret questions - 111111 (a series of six "ones" will be the default response to each secret question.)

59

Agent Portal Login Page

Agent Portal

3. Upon testing completion, log out of the application.

60

4. To access the Customer portal, choose this option from your computer's Start menu shortcut or by entering http://localmachine:/personaWeb/user/ in your browser. The configured port is the port number you chose when installing the application (8080 by default). The Customer portal login window appears. Since you must self-register, validation (for now) is complete - as you can access the login page without issue. At this point, you cannot proceed without registration/enrollment.

Customer Portal Login Page

5. Upon testing completion (which consists solely of Customer portal login page access), exit (or close) this application.

6. To open the Scheduler, choose this option from your computer's Start menu shortcut (or open https://localhost:/jenkins in a browser). The Jenkins (job scheduler) window appears.

http://dev.mysql.com/downloads/mysql/

61

Jenkins Job Scheduler

7. To run Batch & Server Jobs (if you installed EngageOne SmartView on a Windows platform), choose this option from your computer's Start menu (or open the command prompt, access your product installation directory, and run set_env.cmd). If you installed EngageOne SmartView on a UN*X platform, you (manually) must run set_env.sh on the console before installing jobs or running batch jobs. The Batch & Server Jobs window appears.

Batch & Server Jobs

8. From the command prompt, type ant -f jobs.xml. Executing this command will create eight jobs in the Jenkins job scheduler.

62

Create Batch Jobs

ant Execution (Begins)

63

ant Execution (Ends)

9. To view these jobs, return to the Jenkins job scheduler and refresh your browser.

64

Jenkins Job Scheduler Containing Eight Batch Jobs

Note: At least one job - notify_dq.status, for example - might display a recent failure. This is acceptable, as you have not completed the configuration process.

10. When you want to stop Tomcat, click Stop Digital Self Service from your computer's Start menu (or locate shutdown.cmd in your product installation directory). If you installed EngageOne SmartView on a UN*X platform, you can stop this application by running shutdown.sh at the console (or terminal).

Stop Digital Self Service

12 EngageOne Vault File Exportation to EngageOne SmartView To move files from EngageOne Vault to EngageOne SmartView, you must establish the proper configuration settings. As a first step, you must modify the .ini file to ensure it points to the EngageOne SmartView (or Liaison) database. Next, you must ensure that the Liaison field mappings are properly

65

configured for the export and that the Open Database Connectivity (ODBC) export runs each time new files arrive. The EngageOne Vault to EngageOne SmartView integration is performed via this ODBC export, which moves files into the EngageOne SmartView (or Liaison) database. A Liaison job – scheduled to run at your preferred time – moves these files from the export tables into the Liaison bill tables (or database).

The EngageOne SmartView Integration Guide, provided by Pitney Bowes, includes in-depth details associated with the EngageOne Vault to EngageOne SmartView export process. Please refer to this document for more information.

13 EngageOne Smart View Server Configuration

Configuring the server involves accessing EngageOne Smart View by logging in and navigating a series of pages to establish application and connection settings.

As a prerequisite to server configuration, you must ensure that you have tested and validated all data slated for upload (such as custom brands, e-mail templates, localization/property files, and registration files) in a non-production system. Testing data in a production environment exceeds the scope of this document, as all data uploads in this server configuration process are simply being moved into the production environment (with neither testing nor validation).

13.1 System Administrator Login 1. To begin the server configuration process, log into the Agent portal as a system administrator

and click the Configure Application tab. (The Configure Application tab solely is available (and visible) to system administrators.) The Configure Application window appears.

66

Configure Application

The Configure Application window displays nine configuration options (or wizards). You must select each link (and in any order) to execute the corresponding wizard, which allows you to establish application and connection settings for each of the following configuration processes:

• Connect to PB Vault rendering engine • Connect to SMTP server • Load custom brand • Configure e-mail • Configure language support • Configure registration and sign-in • Configure current balance • Configure third party authentication • Configure payment

Note: The Connect to PB Vault rendering engine option (referenced in the window above) is part of the EngageOne Smart View solution and, therefore, only available with the purchase of this software.

13.2 Configuration Process, In Short The configuration processes allow you to establish application and connection settings. The links on the left side of each window in this process, upon selection, trigger a configuration wizard for that specific option (or selection). The text in the center of the window provides the status of each configuration step. For example, a checkmark () denotes a COMPLETE status, and the gear symbol denotes an INCOMPLETE status. As you complete the configuration process (and, therefore, successfully execute and each of the six wizards as indicated by its status), you must upload custom templates, test the

67

application to ensure it is working properly and – ultimately – enable the site via the web portal to make it active.

As you complete each step in the configuration process, all data saves to the DSS database – as multiple servers must access this information. In addition, as you upload data (such as custom brands, e-mail templates, localization/property files, and registration files), you previously must have tested and validated this information on a non-production system. All configuration uploads into the production environment exclude testing, as testing exceeds the scope of this document.

You may return to the Configure Application page at any point to alter or adjust configuration settings.

Now, let us begin . . .

13.3 Connect to SMTP Server This wizard allows you to configure settings to connect to the SMTP server.

1. To begin this configuration, click the Connect to SMTP server link. The Connect to SMTP Server window appears. The SMTP server is an e-mail server. This window displays the Internet address option inclusive of three radio buttons: IPV4, IPV6, and DNS host name. This window also displays the IPV4 address, IPV6 address, or DNS host name field (contingent upon your Internet address radio button selection) along with the Port number field. In addition, this window displays the From/Reply to field as well as the Enable authentication and Enable SSL checkboxes; upon selection, the Enable authentication checkbox displays the Mail user, User password, and Retype password fields. This window also displays the Update and Cancel buttons. As you enter information on this page, you may click the Cancel button at any time to discard changes.

Connect to SMTP Server

68

2. Select a radio button associated with the Internet address before entering information in the IPV4 address, IPV6 address, or DNS host name field along with the Port number field.

3. To designate an e-mail address that e-mail recipients may reply to (or receive e-mails from), enter information in the From/Reply to field.

4. To designate an SMTP server login user name and password, select the Enable authentication checkbox. The Mail user, User password, and Retype password fields appear. While some e-mail servers require authentication prior to e-mail distribution, others do not; hence, the Enable authentication checkbox. If your server requires authentication, you must select this checkbox before providing a login user name and password. If your server does not require authentication, you do not need to select this checkbox.

5. To send encrypted e-mails, select the Enable SSL checkbox. This checkbox selection enables encryption when sending e-mails.

6. To save your changes, click the Update button or – to discard changes – click the Cancel button. 7. To proceed with the configuration process, click another configuration wizard link from the left

side of the existing Connect to SMTP Server window. SMTP server configuration is complete. Selecting a different link triggers display of a new window associated with the configuration wizard you selected.

8. To return to the primary configuration page, click the Configure Application tab at the top of the Connect to SMTP Server window. The configuration status updates accordingly.

13.4 Load Custom Brand This wizard allows you to configure a custom brand. This is a two-step process:

Download the default templates for customization. Upload your custom templates.

1. To begin this process, click the Load custom brand link.

The Load Custom Brand window appears.

69

Load Custom Brand

2. To retrieve the default brand .zip file, click the Download default brand link. This file downloads from the Application server and contains the app.css, brand.css, and customizations.css files; these files store content that you will use to help incorporate your brand throughout the EngageOne Smart View application.

3. To use the content from this downloaded file, create a new file (newbrand.zip, for example). Review the EngageOne Branding Guide and use its content as a reference to apply your brand. Specifically, use the app.css, brand.css, and customizations.css information as a guide to help you understand the rules and the manner by which you must apply these updates. These customizations will be contained in "newbrand.zip". Upon completion of your customizations, you may proceed to the next step which involves uploading this newly created file.

4. Return to the Load Custom Brand window in the Configure Application tab. 5. To locate and select your customized file, click the Browse button associated with the Select

brand to upload field. 6. To retrieve your newly created (and now customized) file, click the Upload button.

The system validates the content of the selected file before refreshing the page and displaying the file name in the Brand ready for publishing field. The Publish button also becomes enabled (if the custom file upload is successful). If this upload operation fails, a warning message appears. You must resolve this issue before proceeding. In this circumstance, the Publish button remains disabled and unavailable for selection.

7. To continue (after successful upload of the custom brand file), click the Publish button. The system publishes the brand file and refreshes the page with appropriate changes to the Currently published brand and Brand ready for publishing read-only fields. If you successfully uploaded and published a custom brand, "newbrand.zip" appears in the Currently published

70

brand field and the Brand ready for publishing field now contains no data. If the Publish operation fails, a warning message appears. You must resolve this issue before re-attempting to publish the file.

8. To publish more files, repeat the Upload and Publish processes as noted above. As you upload and publish files, the file names sequentially populate the Brand ready for publishing, Currently published brand, and Brand available for rollback fields. With regard to field population, this is the file rotation (or field population) sequence. The only action that disrupts this field population sequence is clicking the Rollback button. Clicking the Rollback button automatically moves a file from the Brand available for rollback field to the Currently published brand field. The rollback feature, therefore, allows you to retrieve a recently published file – making this file the active document. This action is helpful if, for example, you publish a file (whose file name would then populate the Currently published brand field) but need to revert to (and use) a previously published file.

9. To discard changes at any time, click the Cancel button. The system displays a cancellation confirmation message. (You may click the Yes button to proceed with the cancellation, or you may click the No button to disregard this action.)

1

engageone smart view · 2019-04-07 · 3 software release contents the engageone smart view...

Documents