CODE-1 Plus v4.3.0 Installation Guide - Pitney Bowes · 2019. 4. 4. · databases on optical and magnetic media. The following trademarks are owned by the United States Post al Service:

pitney bowes 11

CODE-1 Plus™ Version 4.3.0

Installation Guide For All Platforms

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 writtenpermission of Pitney Bowes, 3001 Summer Street, Stamford CT 06926-0700.

© 2018, Pitney Bowes Software Inc. All rights reserved.

MapInfo, Group 1, and Group 1 Software are trademarks of Pitney Bowes Software Inc. All other marks and trademarks are property of their respective holders.

Pitney Bowes Inc. 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 Inc. is a non-exclusive licensee of USPS® for NCOALink® processing.

Prices for Pitney Bowes Inc. products, options and services are not established, controlled or approved by the 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.

3001 Summer Street Stamford CT 06926-0700 USA

www.pitneybowes.com

www.pitneybowes.com

Table of Contents

Chapter 1: Installing on Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Before You Begin the Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 Windows Naming Convention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Setting Environment Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Contents of the *.ZIP or *.EXE File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Default Installation Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Installed Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 CODE-1 Plus Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Verifying the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Installing Product Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Chapter 2: Installing on UNIX/Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Before You Begin the UNIX/Linux Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Important Installation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17 Determining Installation Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Creating the /opt/pitneybowes Product Registration Area . . . . . . . . . . . . . . . . . . . . . . .18 Re-Installation and New Release Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 Contents of the *.ZIP or *.EXE File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Patch Installs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Contents of the Compressed tar file (*.taz). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 CODE-1 Plus Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Verifying the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Permanent Keys and the lminstall Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24 License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing Product Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Special Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

Runtime Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

NFS Mounted File Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Sorted Raw Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Temporary Directories (/tmp) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Special Notes for Uninstalling Products. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Chapter 3: Installing on z/OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Before You Begin the z/OS Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

CODE-1 Plus Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30 If Your Product Has License Management... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Release 4.3.0 3 Installation Guide - All Platforms

Table of Contents

Contents of the .exe File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 Installing CICS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

Configuring CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Installing Product Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 The Next Step - Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Chapter 4: Installing on IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Before You Begin the IMS Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

CODE-1 Plus Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 If Your Product Has License Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 Contents of the Downloaded File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Installing Product Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 The Next Step — Running Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Chapter 5: Installing on IBM i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Before You Begin the IBM i Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 Will Any Objects Be Changed? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 License Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47 Selecting the Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 Global Library Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49 Product Installation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 Locked Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Completing the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51 Defining Custom Screen Headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53

Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 What You Need to Know.... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 File Size Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 CODE-1 Plus Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 Installing Downloaded (IDS) Database Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56 Changing the Default Library Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

Verifying the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Installing Product Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57 Additional Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Chapter 6: License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Understanding CODE-1 Plus License Management . . . . . . . . . . . . . . . . . . . . . . . . . . .62 License Management Process for Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Finding Your System ID for Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

License Management Screen Error Messages for Windows . . . . . . . . . . . . . . . . . . . . .62


Table of Contents

License Management Report Error Messages for Windows . . . . . . . . . . . . . . . . . . . . .63 CODE-1 Plus™ Execution Log File (XLG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 CODE-1 Plus™ License Management Execution Log File (LMREPORT.XLG) . . . . . . . . . . . 63 CODE-1 Plus™ License Management Report (LMREPORT.RPT) . . . . . . . . . . . . . . . . . . . . 64

License Management Process for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Finding Your System ID for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 AIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 SunOS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Display Error Messages for UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 License Management Report Error Messages for UNIX . . . . . . . . . . . . . . . . . . . . . . . .66

License Management Process for Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 Finding Your System ID for Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Red Hat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 SuSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Linux Display Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Linux License Management Report Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . .67

License Management for z/OS and IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Finding Your System ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

z/OS and IMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 License Management Error Messages for z/OS and IMS . . . . . . . . . . . . . . . . . . . . . . .68

License Management for IBM i. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69 Finding Your System ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

IBM i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Interactive Processing License Management Error Messages . . . . . . . . . . . . . . . . . . .70 Batch Processing License Management Error Messages . . . . . . . . . . . . . . . . . . . . . . .70

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71


Table of Contents


1

Installing on Windows

In this chapter...

Before You Begin the Windows Installation . . . . . . . . . . . . . . . . . .8 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Verifying the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Installing Product Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Before You Begin the Windows Installation

Before You Begin the Windows Installation Pitney Bowes delivers CODE-1 Plus software for the Windows platform via internet download from the Pitney Bowes estore.

IMPORTANT: The CODE-1 Plus Windows® installation procedure supports Windows Server 2008 or later versions. If you attempt to install on an unsupported version, the installation will end and issue a warning message. Job scripts used with previous releases of CODE-1 Plus will no longer run because of variable name changes. Please review this chapter for information on the required variable names. Before installing CODE-1 Plus, we recommend that you back up any library locations that contain custom scripts.

System Requirements The requirements for installing CODE-1 Plus on a Windows platform are:

• An account with Administrator privileges. Since CODE-1 Plus uses system environment variables, you must be logged on as an administrator to successfully install software and databases.

• A supported platform. For a list of supported platforms, see the “Supported Platforms” document available on the Pitney Bowes Support site.

• A minimum of 32 MB RAM. This memory requirement does not include memory for your application code and data.

• A minimum of 20 MB of free hard disk space to install the software. • Additional hard disk space to install all databases on disk as noted below:

Database Space Required

U. S. Postal database 1.1 GB

Early Warning System (EWS) 300 KB

Line of Travel (LOT) 350 MB

Delivery Point Validation (DPV) The space required for the DPV database depends on the database type: • FULL - 1.0 GB • SPLIT - 1.6 GB • FLAT - 2.2 GB

LACSLink 375 MB

SuiteLink 525 MB

Residential Delivery Indicator (RDI) 48 MB

• If you are upgrading an installed product, be sure to back up any files you have changed. • Permanent License Key available (for a new installation, if required). The Access Key only

allows temporary use of the software. The Access Key that appears on the Download Software screen is valid for ten days. If your Access Key expires, contact Pitney Bowes to get a new Access Key or obtain your permanent license file.

• Product documentation and release notes downloaded from the Pitney Bowes Support site.


Chapter 1: Installing on Windows Before You Begin the Windows Installation

Installing more than one Pitney Bowes product in the same library is not advised. There are several modules that have common names that are used by more than one product. These modules are periodically updated to accommodate added functionality in one software product, and may cause conflicts if shared with other Pitney Bowes applications. We highly recommend that each application's programs are put into separate application libraries.

Windows Naming Convention When installing software on Windows Server 2012 or later, ensure that the file system supports the 8.3 naming convention.

If you are installing your product and databases for the first time, perform a check on the status of 8.3 format support. From a Windows command line, use the following command, assuming drive "c" for this example: fsutil 8dot3name query c:

Windows will display a message with 8.3 file name support status. If 8.3 file name support is disabled, use this command to enable that feature, replacing "c" with your drive letter: fsutil 8dot3name set c: 0

Setting Environment Variables The following variables are either set at installation ("Required") or are user-defined ("Optional"). You can overwrite default paths during installation.

Variable Description Default Required or Optional?

PBC1P Path of the product softwaredirectory containing the lib and rts folders. Set at installation.

[Program Files]\Pitney Bowes\CODE-1 Plus

Required

PBC1PDB Path of the database/reference filedirectory. Set at installation.

[Public Documents]\Pitney Bowes\CODE-1 Plus\DB

Required

PBC1PDOCS Top-level directory for user-modifiable files (*.bat scripts,parameters, data). This directory contains the CODE-1 Plus bin and data folders. Set at installation.

[Public Documents]\Pitney Bowes\CODE-1 Plus

Required

PBCD Source location for media. Set at installation.

First media drive found on your machine, if present. Defaults tothe directory containing the installation media if no media drive is found.

Required

PBEDIT Defines the text editor to use for jobs and parameters using the edit icon.Set this as a user variable. If not explicitly set by user, the defaultvalue is used.

Notepad™ Optional

PBPAUSE Defines whether to pause at the endof the job when running in Windowed mode. If not explicitly set by user, the default value is used.

By default, jobs do not run inWindowed mode. Jobs run in the background

Optional

PBTMP Location for temporary files. If notexplicitly set by user, the defaultvalue is used.

%PBC1PDOCS%\data Optional


Installing the Software

Contents of the *.ZIP or *.EXE File Pitney Bowes delivers software releases in a zipped or executable file named C1Pnnn.ZIP or C1Pnnn.EXE, where nnn is the release number. The file name may also contain additional characters, following the C1Pnnn structure, that indicate post-release build numbers and other important internal information. This file contains an install image (which in turn contains setup.exe) that must be downloaded to a temporary folder you define.

Software updates (also called “fixes” or "patches") may also be identified by a fix level, along with the product code and release number; for example: C1PnnnCaabbcc.zip or C1PnnnSaabbcc.zip (or with the *.exe extension).

Default Installation Directories The default installation directory for installing CODE-1 Plus on a 32-bit operating system is C:\Program Files\Pitney Bowes\CODE-1 Plus.

The default installation directory for installing CODE-1 Plus on a 64-bit operating system is C:\Program Files (x86)\Pitney Bowes\CODE-1 Plus.

Installing the Software To download and install your CODE-1 Plus software, follow these steps:

1. Download the software via the estore. You will receive an automatic notification via email with special links to the CODE-1 Plus release for supported platforms. Click on the desired link and follow the instructions carefully in the FAQ section of the email to complete the download. Backup media may be ordered for a fee. New users to the estore will need to establish a new estore account for the first download transaction.

2. Download the installation .ZIP file.

3. Use the "Save-As" option to save the .ZIP file to your system.

4. Extract the files.

5. Locate the setup.exe file and double-click to start the software installation process.

6. Follow the prompts to complete the software installation process.


Chapter 1: Installing on Windows Installing the Databases

Installed Folders 1. Locate the folder that contains the scripts and data for running CODE-1 Plus jobs. By default,

this folder is identified by the PBC1PDOCS environment variable as [Public Documents]\Pitney Bowes\CODE-1 Plus).

Folder Description

bin Contains files, scripts, and icons used to run/edit CODE-1 Plus jobs. • Batch files (.bat)

– SAMPLE.bat - batch installation verification procedure that runs the SAMPLE job • Visual basic scripts (.vbs)

– C1PJOB.VBS - Utility to edit CODE-1 Plus job batch file – C1PRun.VBS - Runs a CODE-1 Plus job

• Icon files (.ico)

data Contains job parameters, report files, input name/address file, and output files generatedby the job

DB Contains databases

2. Locate the folder that contains the CODE-1 Plus application and runtime. By default, this folder is identified by the PBC1P environment variable as [Program Files]\Pitney Bowes\CODE-1 Plus.

Folder or File Description

bin Contains the CODE-1 Plus help files.

lib Contains the CODE-1 Plus program files

rts Contains the runtime system

README.TXT File containing late-breaking information from the Pitney Bowes programming team

Installing the Databases After installing the software, follow these steps to install the databases:

1. Review the README file and/or the product documentation for detailed information on installing the appropriate databases for your product.

2. Download the databases via the estore. You will receive an automatic notification via email with special links to the CODE-1 Plus databases for supported platforms. Click on the desired link and follow the instructions carefully in the FAQ section of the email to complete the download. Backup media may be ordered for a fee. New users to the estore will need to establish a new estore account for the first download transaction.

3. Download the database .ZIP file.

4. Use the "Save-As" option to save the .ZIP file to your system.

5. Extract the files.

6. Follow the instructions provided by the installation program for a successful database installation.


Installing the Databases

CODE-1 Plus Databases The following table describes the databases available for use with CODE-1 Plus.

Required or Database Recommended Description

U.S. Postal Required Contains U.S. Postal data in a Pitney Bowes proprietary Database format. This database contains every house number range

in the United States and is updated on a monthly basis. The database files contain the following information: • ZIP + 4 Code • Standardized address elements • City and state information Data needed to perform Enhanced Street Matching (ESM) and All Street Matching (ASM). ESM and ASM apply extra matching logic to any input address that is not matched through the regular address validation process.

SuiteLink Required to The SuiteLink database corrects secondary address generate a USPS information for U.S. business addresses whose secondary Form 3553 address information could not be validated. (CASS Summary Report)

LACSLink Required to The LACSLink database allows you to correct addresses thatgenerate a USPS have changed as a result of a rural route address convertingForm 3553 to street-style address, a PO Box renumbering, or a street-(CASS Summary style address update. Report)

DPV Required togenerate a USPS Form 3553 (CASS Summary Report)

The Delivery Point Validation (DPV) database allows you tocheck the validity of individual U.S. mailing addresses. This database enhances the U.S. Postal database's ability tovalidate mailing addresses. Select the DPV file format for your environment: • Full (often called "Hash") — Use DPV Full when

database storage space is the most critical factor. • Split — Use DPV Split for a medium-sized space storage

factor. • Flat — Use DPV Flat for the largest space storage factor.

RDI Recommended The Residential Delivery Indicator (RDI™) database contains data that identifies whether an address is a residential or a business address.

EWS Recommended The Early Warning System (EWS) database provides earlyalerts to address changes that could impact your address file.

eLOT Recommended The Enhanced Line Of Travel or eLOT processing provides routing information for your coded addresses. While eLOT processing is not required for CASS certification, it isrequired to obtain discounts. To accomplish this, perform eLOT processing as part of your address hygiene processing or separately as part of your presort processing.


Chapter 1: Installing on Windows Verifying the Installation

Verifying the Installation For new product releases, we recommend you run the installation verification procedure (IVP) SAMPLE job before running your own production jobs.

1. Go to the Start button and choose Programs > Pitney Bowes CODE-1 Plus > Run CODE-1 Plus Job.

2. Enter the job name, SAMPLE, and click OK. The job takes a few minutes to run.

3. When the job is complete, you will receive notification via a dialog box. Click Yes to review the output for errors.

4. To ensure that output files were produced, you can check the execution log (JobName.xlg) in the data directory where you loaded the software (for example, in [Public Documents]\Pitney Bowes\CODE-1 Plus\Data). The execution log/report lists the number of records processed.

5. If the SAMPLE job did not run to completion, contact Technical Support for assistance.

Installing Product Updates To install a product update, follow these steps:

1. Back up your lib subdirectory.

2. Download the appropriate files from the Pitney Bowes estore.

3. Extract the objects contained in the .ZIP file to a temporary directory on the same computer as your product installation. If the update contains an install.bat file, simply execute this file to install the update. If install.bat is not included in the update, copy the objects extracted from the .ZIP file to the lib subdirectory of your existing product installation. When prompted to overwrite existing files, reply Yes to all.

4. Check to see if the files updated successfully.

If You Need More Help If you are unable to resolve a problem, contact Technical Support for assistance. Please have the following information ready:

• A description of the task you were performing. • The resulting reports (specifically, the Execution Log and Parameter Record Listing).

The Technical Support Hot line number for customers in the United States and Canada is 800-367-6950. You can also obtain product information and updates from https://www.pitneybowes.com/us/support.html.


https://www.pitneybowes.com/us/support.html

If You Need More Help


2

Installing on UNIX/Linux

In this chapter...

Before You Begin the UNIX/Linux Installation . . . . . . . . . . . . . . . .16 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Verifying the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Installing Product Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 Special Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Special Notes for Uninstalling Products . . . . . . . . . . . . . . . . . . . .27 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Before You Begin the UNIX/Linux Installation

Before You Begin the UNIX/Linux Installation Pitney Bowes delivers CODE-1 Plus software and databases via Internet download from the Pitney Bowes estore.

IMPORTANT: Job scripts used with CODE-1 Plus releases prior to the CODE-1 Plus 4.2.0 release will no longer run because of variable name changes. Please review this chapter for information on required variable names.

Archive your installed CODE-1 Plus prior to installing a newer version. If you install into an area that contains an earlier version of CODE-1 Plus, the install program overwrites existing files. For example, if you have installed in /usr/pb, and you then install a new version or copy into /usr/pb, the newer version deletes the previous release. We also recommend that you back up any library locations that contain custom scripts.

System Requirements The requirements for installing CODE-1 Plus on a UNIX or Linux platform are:

• An account with Administrative privileges to prepare the install environment. Specifically, the individual installing must have write access to the product install area of the target machine as well as write access to the /opt/pitneybowes shared registry area. Please refer to the "Determining Installation Permissions” on page 18 and "Creating the /opt/pitneybowes Product Registration Area” on page 18 for help with permission issues and the shared registry area.

• A supported platform. For a list of supported platforms, see the “Supported Platforms” document available on the Pitney Bowes Support site.

• A minimum of 32 MB RAM. This memory requirement does not include memory for your application code and data.

• A minimum of 20 MB of free hard disk space to install the software. • Additional hard disk space to install all databases on disk as noted below:

Database Space Required

U. S. Postal database 1.1 GB

Early Warning System (EWS) 300 KB

Line of Travel (LOT) 350 MB

Delivery Point Validation (DPV) The space required for the DPV database depends on the database type: • FULL - 1.0 GB • SPLIT - 1.6 GB • FLAT - 2.2 GB

LACSLink 375 MB

SuiteLink 525 MB

Residential Delivery Indicator (RDI) 48 MB

• Permissions and privileges to access, read, and write to the target install area for Pitney Bowes products (including user:group permissions).

• Establish the /opt/pitneybowes area and grant write permission for the installer.


Chapter 2: Installing on UNIX/Linux Before You Begin the UNIX/Linux Installation

• Run the optional permtest utility (see Determining Installation Permissions) to determine if the target install area is writable by the person installing. You can skip this step if you know the area you are installing into and the /opt/pitneybowes area is writable by the person installing.

• If you are upgrading an installed product, be sure to back up any files you change. • Permanent License Key available (for a new installation, if required). The Access Key only

allows temporary use of the software. The Access Key that appears on the Download Software screen is valid for ten days. If your Access Key expires, contact Pitney Bowes to get a new Access Key or obtain your permanent license file.

• Download the product documentation and release notes from https://www.pitneybowes.com/us/support.html.

Installing more than one Pitney Bowes product in the same library is not advised. There are several modules that have common names that are used by more than one product. These modules are periodically updated to accommodate added functionality in one software product, and may cause conflicts if shared with other Pitney Bowes applications. Pitney Bowes highly recommends that each application's programs are put into separate application libraries.

Important Installation Notes Before you install, verify that you have these checks in place to ensure a successful installation:

• You must have appropriate privileges to install, re-install, or update the CODE-1 Plus software. If not, it is possible that the installation may not update all files.

• Set up the proper user:group permissions for the area where CODE-1 Plus is installed. If you do NOT have write access to the area where you are installing CODE-1 Plus, the install process will not run to normal completion.

• You must establish a shared license area in /opt/pitneybowes. You only need to create this area once per target machine. You can use the shared license area to manage software licenses for multiple Pitney Bowes products.

• Verify that the /opt/pitneybowes area is present AND writeable by the person installing so the installation process runs to normal completion. You can use the optional utility pbprep, found in the same area as the install script, to create the /opt/pitneybowes area for you. If you have installed an earlier version of CODE-1 Plus, the install process will attempt to create this area for you assuming the individual installing has permissions to create the /opt/pitneybowes area.

• The install process creates a log file to assist our Technical Support Representatives in resolving problems you may encounter during the installation. The installation script places file “pbauto.log” in the /opt/pitneybowes/var/log directory. If the person installing the software does not have write access to the /opt/pitneybowes/var/log area, or if they do not have write access to an existing pbauto.log file, the install process terminates with a warning message.

• Root access is not required; however, you must have proper permissions for the area where you want to install CODE-1 Plus. If the installer does not have the proper privileges and authority, the install procedure terminates with a warning message.

• For new releases, you may want to establish separate TEST and PROD (Production) environments. Run the new software in the TEST environment until you are satisfied with the processing results of the new release before you delete the previous release.

HP-UX and AIX Users: If during the initial phase of the installation process the acushare license management daemon is running, the installation will issue a warning to the installer and stop. If this occurs, you must shut down the acushare daemon before the installation can continue. This is a precaution to ensure that the installation continues and does not “hang” while waiting for the acushare daemon to free up from memory.




Determining Installation Permissions The root area of the downloaded installation package includes the optional permtest utility to help you determine if your target installation area has proper permissions (is writable). You can run the permtest utility, using the target installation as an argument to determine the permission settings. It should also be used on the /opt/pitneybowes area to determine if that area is writable as well.

To find valid permtest arguments and usage information, run permtest without any arguments:

./permtest

To determine permissions, run permtest with a target area as the first argument followed by the appropriate option:

./permtest

where is the path in which to install the product or the /opt/pitneybowes license area. Both areas should be checked for proper permissions prior to running the installation process.

is -V, -v or blank.

Creating the /opt/pitneybowes Product Registration Area CODE-1 Plus requires a product registration area, located in the /opt directory, where third-party software should be located. This product registration area must be defined as /opt/pitneybowes. During installation, CODE-1 Plus accesses /opt/pitneybowes to track production installation versions. You can install product software in any location you choose. The product registration area requires less than 10 megabytes of space.

CODE-1 Plus provides a script, pbprep, to create the /opt/pitneybowes product registration area. A System Administrator, or someone with root privileges, must run the pbprep script. Run the pbprep script as:

pbprep

Where is the owner of the /opt/pitneybowes area and is the group id of the group to have write access to the /opt/pitneybowes. The /opt/pitneybowes product registration area is updated during the installation process and the person installing CODE-1 Plus must have write access to this area. We recommend against installing software into the /opt/pitneybowes area, since this location is at the root level, and CODE-1 Plus needs additional space during processing.

Anyone with root privileges, such as a system administrator, can create the /opt/pitneybowes product registration area. The product registration area must contain the following subdirectories:

• /etc • /man • /var • /var/log

If these directories are not present at the time of installation, the installation stops. The /opt/pitneybowes product registration area needs to be created only once per target machine.

During the installation process, the installation script provides these product registration area setup options:

• Install to a production area: Similar to a production installation, this area can be any location on the target machine, including NFS mounts. The product registration area tracks this product location.

• Install to a test area: The product registration file does not track the test area. Patches/updates are not applied to any test areas. You may create as many test areas as needed. Although TEST installations are not tracked by the shared product registration area, the /opt/pitneybowes directory structure must be present on the target machine, even for a TEST installation.


Chapter 2: Installing on UNIX/Linux Before You Begin the UNIX/Linux Installation

Re-Installation and New Release Information If you are re-installing or installing a newer release of CODE-1 Plus, you must have appropriate privileges. When replacing an old version of CODE-1 Plus with a new one, we suggest that you establish separate TEST and PROD (Production) areas and environments. Run the new software in the TEST environment until you are satisfied with the processing results of the new release before you delete or overlay the previous release. If you choose to re-install or install a newer release in an existing area, please be advised that certain scripts (setmedia and setup) will NOT be overwritten and the newer scripts will be named setmedia.new and setup.new. The original script will not be modified. However, you should compare (diff) the old and new scripts to see if there have been changes (for example, new DD file statements) in the .new script that you may have to incorporate into the original script.

Contents of the *.ZIP or *.EXE File

Patch Installs Pitney Bowes delivers software patch releases in a zipped or executable file named C1Pnnn.ZIP or C1Pnnn.EXE, where nnn is the release number. The file name may also contain additional characters, following the C1Pnnn structure, that indicate post-release build numbers and other important internal information. This file contains an install image (which in turn contains the install script) that must be downloaded to a temporary folder you define.

Software updates (also called “fixes”) may also be identified by a fix level, along with the product code and release number; for example: C1PnnnCaabbcc.zip or C1PnnnSaabbcc.zip (or with the *.exe extension).

Contents of the Compressed tar file (*.taz). Pitney Bowes delivers Internet software updates in compressed format as a zipped file containing the following files:

• install - installation script • Platform-specific .taz (compress tar’d and zipped product) files:

• c1paix.taz - AIX • aixacu.taz - AIX runtime • c1phpx.taz - HP-UX • hpxacu.taz - HP-UX runtime • c1plnx.taz - Linux • lnxacu.taz - Linux runtime • c1psol.taz - Solaris • solacu.taz - Solaris runtime

• permtest - Permissions Utility script (optional) • pbprep - Script to setup the Pitney Bowes Software /opt/pitneybowes shared registry area

(optional) • uninstall - Script to remove existing products • uninstall.main - Driver script for uninstall • README - Test file containing relevant installation notes





U.S. Postal Required Contains U.S. Postal data in a Pitney Bowes proprietary Database format. This database contains every house number range

in the United States and is updated on a monthly basis. The database files contain the following information: • ZIP + 4 Code • Standardized address elements • City and state information Data needed to perform Enhanced Street Matching (ESM) and All Street Matching (ASM). ESM and ASM apply extra matching logic to any input address that is not matched through the regular address validation process.

SuiteLink Required to The SuiteLink database corrects secondary address generate a USPS information for U.S. business addresses whose secondary Form 3553 address information could not be validated. (CASS Summary Report)

LACSLink Required to The LACSLink database allows you to correct addresses thatgenerate a USPS have changed as a result of a rural route address convertingForm 3553 to street-style address, a PO Box renumbering, or a street-(CASS Summary style address update. Report)









Chapter 2: Installing on UNIX/Linux Installing the Software


1. Download the software via the eStore. You will receive an automatic notification via email with special links to the CODE-1 Plus release for supported platforms. Click on the desired link and follow the instructions carefully in the FAQ section of the email to complete the download. Backup media may also be ordered via this channel for a fee. New users to the estore will need to establish a new estore account for the first download transaction.

2. Download the installation file.

3. Use the "Save-As" option to save the file to your system.

4. Extract the files, and FTP (in binary mode) all files to your system.

5. If you are in the directory where the files were FTP’d, proceed to the next step. Otherwise, change to the directory where those files are located.

6. Modify the permissions on the install script by using the chmod command: chmod -R 775 install

7. Type the install command: ./install

8. Follow the instructions provided in the installation script. The installation script is intended to be a conversational package that queries both you and your system for information. Based upon the operating system level, the installation script determines which product package to install. In most cases, you should use the installation defaults. Some additional points to consider: – If you install the new product over the existing product, the current setup script (found in the

bin subdirectory) is saved, and a new script with a file name extension of .new is installed. – Because there may have been significant changes since you last installed the product, we

recommend that you compare the current setup script with the setup.new script. Note the differences and modify the current script to include the new changes found in the .new script.

9. After you load the files, you may need to change the owner and group of each file via the chown command. chown -R owner:group * Change owner to your owner name, and group to your group name. The asterisk (*) modifies all files and directories and -R modifies all subdirectories. You may change file permissions to limit or expand access to product files; however, this is not required.

Installing the Databases After installing the software, follow these steps to install the database(s).

1. Download the database(s) from the Internet. The database(s) must be loaded before using the product.

2. For database files that are 2 GB or larger, remove the comment character (#) from the following commands in the setuprts script: USE_LARGE_FILE_API=1; export USE_LARGE_FILE_API


Verifying the Installation

3. If necessary, change the setmedia script to contain the correct information about the type and names of media.

4. If you specified a non-default directory for your database, you must change the $PBDB environment variable in the $PBDIR/c1p/bin/setup script. The database defaults to the directory $PBDIR/db.

5. Issue the appropriate source command to setup the environment: . bin/setup for Bourne shells source bin/setup.csh for C shell

6. Run the database installation script using one of the following commands: $PBDIR/c1p/bin/installdb or cd to $PBDIR/c1p/bin and type installdb

7. Follow the prompts generated from the installdb script to complete the database installation.

Verifying the Installation After installing the software and database(s), run the verification procedures to ensure that everything works properly.

1. Issue the appropriate source command to set up the environment: • . bin/setup for Bourne shells • source bin/setup.csh for C shell scripts.

You must issue this command every time you establish a new environment by either logging in or exiting the shell in which the source command was issued. Normally, you do this as soon as you have logged on so all subshells you create have the product environment variables defined. Pitney Bowes recommends that you add the source command to your *.profile or *.cshrc file. However, this is optional. During the product installation process, the various environment scripts needed to run CODE-1 Plus are customized for your hardware and software environment. These environment scripts include: • setup • setup.csh (for C shell)

On rare occasions, you may need to modify these scripts after CODE-1 Plus has been installed. However, most scripts do not need to be modified. If there is a need to modify these scripts, refer to the following list of environment variables that can be changed for each script name listed.

2. Make the product license keys available. The product licenses must be available before running the sample job. If you have a prior installation area where there are valid license files (found in c1p/data), and the product has been tracked by the product registration file found in the old /var/group1 area, the installation process copies the existing license files from the current area to the new install area. This only occurs if you are installing into a production installation area. The existing license files will NOT be copied for test areas.

If you have a current installation but have NOT used the /var/group1 product registration area, you must copy the current license files to the new installation area. The two license files (g1lmlic and g1lmlic.vix) can be found in the current c1p/data subdirectory.


Chapter 2: Installing on UNIX/Linux Verifying the Installation

CODE-1 Plus no longer includes a License Management process as part of the installation process. You must run the license management process after completing the software installation. License Management files must be present, active, and validated before running any CODE-1 Plus job.

3. If applicable, enter the 45-day access keys using the accesskeys script. If this is a first-time installation and you have obtained temporary access keys from Pitney Bowes, you may enter these keys to provide you with 45 days of CODE-1 Plus processing before you obtain your permanent keys. To install the temporary access keys: a. Change directories (cd) to the $PBDIR/c1p/bin area. b. Source the setup script. c. Run the accesskeys script. The accesskeys script will request one required key for CODE-1

Plus. After entering the key, you may proceed to run the sample job, assuming the database files have also been installed as mentioned above.

Typically, the following scripts will not have to be changed. These scripts are described here only to provide assistance if a script needs to be changed after the CODE-1 Plus installation.

Product Environment Variables - setup or setup.csh

Variable Refers to

PBSYS Type of OS (for example, AIX, SOLARIS, LINUX).

PBDIR Root path to where CODE-1 Plus is installed.

PBC1P Full path to where CODE-1 Plus is installed.

PBC1PDB Full path where the CODE-1 Plus database is located. This variable is modified in thesetup and setup.csh script under the $PBDIR/C1P/bin directory. This environmentvariable is used by the product batch drivers and sample programs.

COBOL Environment Variables - setup or setup.csh

Variable Refers to

PBC1PRTS Full path to the location of the COBOL runtime directories.

CODE_PREFIX Full path to the location of the Pitney Bowes programs.

PATH The COBOL bin directory should be added to the path.

LD_LIBRARY_PATH Used for UNIX/Linux SVR4 system only. Add $PBC1PRTS/lib to the existingLD_LIBRARY_PATH.

SHLIB_PATH Used for HP-UX systems only. Add $PBC1PRTS/lib to the existingSHLIB_PATH.

LIBPATH Used for AIX systems only. Add $PBC1PRTS/lib to the existing LIBPATH.


Verifying the Installation

Product Environment Variable - setmedia

Variable Refers to

PBCDDIR Full path to the location of the database files. Typically points to the local directory where the raw input database files are located; however, the path can be modified to point to an NFS mount or directory where the input files are located on a remote device.

4. Issue the appropriate source command to set up the environment: . ./setup

5. Set up the verification job (sample) environment variables by sourcing the sample job. Type the following product verification command. . ./sample

6. Submit the IVP or sample job by typing the following command. ./runc1bm00

The IVP/sample job runs in the background and takes up to 10 minutes to complete. You may monitor its progress using the ps command (ps -ef | grep sample | grep -v grep or for IVP jobs, ps-ef | grep ivp.job | grep -v grep) or by running the chkrun script found in the product bin subdirectory.

7. Verify that the job executed properly by running the script bin/chkrun or look at the sample log file created in $PBDIR/C1P/data.

You have successfully installed your software. You can use the IVP or sample jobs supplied by Pitney Bowes as templates for your own jobs. Please refer to your CODE-1 Plus documentation for instructions on setting up and running your first job.

Permanent Keys and the lminstall Script To install the permanent License Management files, follow these steps:

1. FTP the license (.txt file) you received from Pitney Bowes as ASCII to the /data directory.

2. Once the permanent license keys are in the /data subdirectory, cd to the $PBDIR/c1p/bin area.

3. Source the setup script then run the lminstall script.

4. The License Management files (g1lmlic, g1lmlic.vix) are, by default, loaded into the $PBDIR/c1p/data subdirectory area where the CODE-1 Plus product is installed.

The initial temporary Access Keys that are loaded and activated via the access keys process described above contain a 45-day key that allows you to run your CODE-1 Plus jobs. At the end of the 45-day period, you will be unable to run your CODE-1 Plus jobs unless you load your permanent license keys.

If this is an upgrade installation, and you have previous versions of CODE-1 Plus installed, your License Management files will be copied from the previous location to the new location, assuming you have used the default /var/group1 product registration area.

If you have installed prior CODE-1 Plus releases in an area that cannot be tracked via the /var/group1 product registration file, you have to copy the license files manually.


Chapter 2: Installing on UNIX/Linux License Management

License Management CODE-1 Plus requires license keys. To install License Management files, please follow these steps:

1. Change to directory (cd) $PBDIR/c1p/bin.

2. FTP the license file as ASCII to c1p/data.

3. Go to the bin directory and run the license management install: ./lminstall

4. Follow the prompts generated from the lminstall script to complete installation.

Installing Product Updates Before installing, verify that you have downloaded the correct version of the patch from the web site for your UNIX or Linux version. To install the product update:

1. Download the product update file. The downloaded file has a .zip or .exe extension.

2. Unzip the file. One of the files that will appear should be a .tar file. Use this file in the steps below.

3. Copy or FTP the .tar file to your UNIX or Linux platform and place it into the Pitney Bowes product $PBDIR/c1p/lib directory. If you FTP, be sure to use binary mode.

Make sure you back up or save your $PBDIR/c1p/lib directory before going to the next step.

4. Un-tar the file into the $PBDIR/c1p/lib area using the following command: tar -xvf c1pXnn.download.tar

where Xnn is the update designator (with X being the update type and nn being the update number). The person performing this step must have write privileges on all files in the current directory or the tar command will fail. Two new files should now be available: • c1pXnn.tar • install where Xnn is the update designator.

5. Run the install script ($PBDIR/c1p/lib/install) to install the product updates from the c1pPXnn.tar file. Do not manually un-tar the c1pXnn.tar file unless you are directed to do so by Pitney Bowes Technical Support.

The install script must be executed from the lib subdirectory of the product being updated. The tar file must also be present in this area.

A new file (for example, aix_O01rls, hpx_S02rls) will be placed under the $PBDIR/c1p/lib to verify the patch installation.

6. Run the IVP/sample job to verify a successful installation of the product update.


Special Considerations

Special Considerations

Runtime Changes The runtime that is installed with the product is no longer placed in a separate directory and shared by all installed Pitney Bowes products. Instead, each product has its own version of the runtime and it is placed in the product directory area. The runtime directory name is "rts" and can be found along with the bin, data and lib directories within the product installed root directory. With the inclusion of the runtime with the product there will be reduced compatibility issues when a product is updated with a new runtime version. In addition, the placing of the runtime with the product facilitates the process of supporting both 32-bit and 64-bit products on the same target machine.

Performance Considerations Please review the following performance considerations.

NFS Mounted File Systems Network File Systems (NFS) are mounted file systems that are used on most UNIX/Linux systems today. However, due to the performance issues concerning NFS mounts, we recommend that all files used in the production process of Pitney Bowes products be located on the target machine’s local file system. Although some Pitney Bowes products may run efficiently on NFS mounted files systems, performance and record locking issues can cause processing bottlenecks that cannot be tuned or modified for performance gains. If you choose to use NFS mounted file systems for your production processes, Pitney Bowes cannot assist in product efficiency or performance metrics.

Sorted Raw Input File If possible, all raw data input files into Pitney Bowes products, especially files with address information, should be pre-sorted on specific fields that your process uses for matching, merging, and duplicate record elimination. Unsorted raw data input files require more processing time due to normal sequential file batch processing and caching techniques. Sorted raw data files benefit from these caching techniques. If you need more information on sorting, please contact Pitney Bowes Technical Support for assistance.

Temporary Directories (/tmp) Pitney Bowes products use temporary directories for internal sorts and for record caching techniques. As noted above in the NFS section, if your temporary directory (typically /tmp) is located on an NFS mount for space reasons, please be aware of poor performance consequences. We recommend that your temp space be allocated on the local file system.

You can modify your temp directory on a product by product basis by changing the TMPDIR environment variable located in the setup script in the product bin subdirectory.


Chapter 2: Installing on UNIX/Linux Special Notes for Uninstalling Products

Special Notes for Uninstalling Products

Anyone who un-installs the software MUST have proper permissions to do so, or the uninstall will not complete successfully.

Un-install scripts are included in the /opt/pitneybowes/etc location. You can select any product from the list of available products.

It is important to note that running this script removes product files and ALL files within the product’s directory structure such as parameter files, input files, and output files. For this reason, it is a good idea to have a current backup before you uninstall your product.

Use the following steps to un-install your software:

1. Create a backup before uninstalling the product. This ensures that any user-created content is not lost.

2. Change the current directory to the /opt/pitneybowes/etc directory.

3. Issue ./uninstall from the command line.

4. Follow the on-screen prompts to remove the desired product.






3

Installing on z/OS

In this chapter:

Before You Begin the z/OS Installation . . . . . . . . . . . . . . . . . . . . .30 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 Installing CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 Installing Product Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34 The Next Step - Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Before You Begin the z/OS Installation

Before You Begin the z/OS Installation The CODE-1 Plus product and database releases are distributed via internet download from the Pitney Bowes estore. The individual installing CODE-1 Plus must:

• Have authority or permission to delete, replace, and allocate libraries and files • Have authority or permission to submit jobs • Know the site file/member naming conventions • Know how to FTP files to the mainframe • Be familiar with CICS maintenance (if performing a CICS installation) • Establish an account on the Pitney Bowes estore to download software and databases • Download the product documentation and release notes from

https://www.pitneybowes.com/us/support.html.

Installing more than one Pitney Bowes product in the same library is not advised. There are several modules that have common names that are used by more than one product. These modules are periodically updated to accommodate added functionality in one software product, and may cause conflicts if shared with other Pitney Bowes applications. Pitney Bowes highly recommends that each application's programs are put into separate application libraries.


Database Required or Recommended Description

U.S. Postal Database

Required Contains U.S. Postal data in a Pitney Bowes proprietary format. This database contains every house number range in the United States and is updated on a monthly basis. The database files contain the following information: • ZIP + 4 Code • Standardized address elements • City and state information Data needed to perform Enhanced Street Matching (ESM) and All Street Matching (ASM). ESM and ASM apply extra matching logic to any input address that is not matched through the regular address validation process.

SuiteLink Required togenerate a USPS Form 3553 (CASS Summary Report)

The SuiteLink Database corrects secondary addressinformation for U.S. business addresses whose secondary address information could not be validated.

LACSLink Required togenerate a USPS Form 3553 (CASS Summary Report)

The LACSLink database allows you to correct addresses thathave changed as a result of a rural route address convertingto street-style address, a PO Box renumbering, or a street-style address update.



Chapter 3: Installing on z/OS Before You Begin the z/OS Installation









If Your Product Has License Management... The Pitney Bowes License Management technology prohibits overwriting of the Pitney Bowes License File (G1LICEN). If you overwrite the License File, your product ceases to operate. Please carefully read the following upgrade procedures to ensure proper installation of your license-managed product.

WARNING! Do NOT delete or modify your production License File!

Installation to a Production System - If you install your Pitney Bowes product directly onto a production system, the installation routines will automatically account for an existing License File, and the product will operate as expected.

Copy From Test System to Production System - If you copy the product from a test system onto a production system, it is vital that you DO NOT COPY THE LICENSE FILE from the test environment as part of the upgrade process. You must not modify the production License File (G1LICEN) during the upgrade process. If you overwrite the License File, your Pitney Bowes product will cease to operate.

If license management is not yet installed in your production environment, you must obtain a permanent license key from Pitney Bowes and perform installation of the license file. For details, see the Pitney Bowes License Management Guide.


Installing the Software

Contents of the .exe File Pitney Bowes delivers Internet software updates in compressed format as a self-extracting file. This file includes:

• IDSINSTL.JCL, which is used to upload and install your new software release. • Installation JCL and the LE Runtime Option Macro (CEEUOPT) in effect for this product. The

$$READIN member will contain an index of all the members in the install library. • Load file containing load modules (available for only some products. You can check your

download for a file named pppCMVS.LOAD). • Load PDSE file containing PDSE (Partitioned DataSet Extended) load modules (available for

only some products. You can check your download for a file named pppCMVS.LOAD.PDSE). • Object file(s) containing the software (*.OBJ files). • Input data file for the installation verification procedure. • (Optional) SAMPLE library containing sample JCL, programs, copybooks, and text files. The

$$READSM member will contain an index of all the members in the optional sample library. • A Temporary License Management Key (if applicable). • Other files that may be pertinent to your release (*.DAT files).

The IDSINSTL JCL member is a complete job that will perform all functions required to upload a specific product’s libraries and support files to the mainframe. If your site does not use FTP as the preferred file transfer protocol, substitute the FTP step with the utility used at your site and the job will continue to be operational.


1. Download the software via the estore. You will receive an automatic notification via email with special links to the CODE-1 Plus release for supported platforms. Click on the desired link and follow the instructions carefully in the FAQ section of the email to complete the download. Backup media may be ordered for a fee. New users to the estore will need to establish a new estore account for the first download transaction.

2. Download the CODE-1 Plus software files.

3. Unzip the .exe or .zip file to extract the installation files.

4. Follow the steps below to FTP the IDSINSTL JCL to the mainframe: a. Use the following file transfer settings:

– EBCDIC - Translate to EBCDIC; the file is sent in ASCII format – NOCRLF - No Carriage Return/Line Feed – RECFM - FB (fixed-block) – BLKSIZE - 1600 or the blocksize of the receiving library – LRECL - 80

b. With your company’s file transfer protocol set to ASCII, upload IDSINSTL JCL to the mainframe.

5. Customize the IDSINSTL JCL. Customize the IDSINSTL as needed for your site requirements. Variables that you supply appear in lowercase (see the Variable Replacement Table in the IDSINSTL JCL).


Chapter 3: Installing on z/OS Installing the Databases

6. Run the IDSINSTL Job. To run the install job, submit the job and check the return codes. The job should complete with zero return codes.

Running the IDSINSTL install deletes all files associated with the installation of the product so it is important to create backups first.

7. Load the License Management Key (if applicable).

8. Load the Required Product Database Files (if any) At this point, you will load your new or updated database file(s). Please see Installing the Databases for more information.

9. Run the Installation Verification Procedure (IVP). Run the IVPFILE JCL member to ensure that the batch load modules function properly. The IVP job “exercises” a large number of programs in the system, so you can be sure that the verification process is comprehensive. Be sure to add the LE run time library reference to your steplib concatenation.

10. Configure/Test CICS (if applicable) If your product has a CICS component to install, please refer to ‘Configuring CICS” on page 34. CICS must be configured as part of the installation process if you wish to use the Interactive System.

Please see ‘Installing the Databases” on page 33 for instructions for loading a database downloaded from the Pitney Bowes web site.

Installing the Databases Pitney Bowes provides database images for downloading from the Pitney Bowes estore. To install the databases, follow these steps.

1. Review the README file and/or the product documentation for detailed information on installing the appropriate databases for your product.

2. Download the databases via the estore. You will receive an automatic notification via email with special links to the CODE-1 Plus databases for supported platforms. Click on the desired link and follow the instructions carefully in the FAQ section of the email to complete the download. Backup media may be ordered for a fee. New users to the estore will need to establish a new estore account for the first download transaction.

3. Locate the file(s) you wish to download and initiate the download. Once the download completes, the file(s) will be on your LAN in the location you specified.

4. Log onto your mainframe and locate the product's installation library.

5. Locate and customize the C1PALOCF member to suit your site standards. Then submit the member. The C1PALOCF member will allocate temporary/sequential file(s) on the mainframe, then upload the downloaded file(s) to the mainframe.

6. Locate and customize the C1PDBIND member to suit your site standards. Then submit the member. The C1PDBIND member creates the appropriate VSAM database file(s) from the sequential files uploaded in the prior step, then removes the flat files from the mainframe.


Installing CICS

Installing CICS This section describes the CICS installation process for CODE-1 Plus.

Configuring CICS CODE-1 Plus requires you to configure CICS as part of the installation process if you wish to use the Interactive System. These instructions assume that you are familiar with modifying the CICS environment. If you are not, please ask a CICS systems programmer for assistance.

For a list of supported CICS versions, see the "Supported Platforms" document available on the Pitney Bowes Support site.

Interactive components are not compatible with any prior releases of your Pitney Bowes product and cannot co-exist in the same CICS region or load library with prior releases.

The execution load library contains the load modules required for the interactive system. The install library (yourhlq.INSTALL.JCL) contains the JCL for updating the CSD entries.

To install the interactive system in CICS, follow these steps:

1. Install the Resource Definitions. a. Modify the C1PCSD member according to the instructions within the member. b. Submit the job and check the output.

2. Install the Customization File (optional). The following members in the install library assist you in installing the customization file G1xxFDF. Follow the instructions within the members to install this new file. • DEFCUSTM—Contains the JCL to define and initialize the file. • CUSTMUTL—Contains the JCL to repair, re-initialize, and display the password.

3. Define the Product Loadlib to CICS. Add the load library and PDSE load library unloaded above to the DFHRPL concatenation. On the next startup of that CICS region, the interactive system should be available.

4. Execute the Interactive System. You are ready to execute the interactive system. From a blank CICS screen, enter the transaction name. Please refer to your User's Guide for more information about running the software. Be sure to make copies of your programs, or recycle your CICS region to pick up the fixes and run the driver transaction to test the new programs.

Installing Product Updates To install product updates (also called "patches"), downloaded from the Pitney Bowes estore, follow these steps.

1. Configure Your File Transfer Utility. Before uploading the JCL from the PC to the mainframe, use the following settings to configure your installation-approved file transfer utility. • ASCII - file is provided in ASCII format • CRLF - Carriage Return/Line Feed • RECFM - FB (fixed-block) • BLKSIZE - 80 • LRECL - 80


Chapter 3: Installing on z/OS The Next Step - Running Jobs

2. Upload the MVSPATCH JCL member. Use your site's file transfer utility to upload the MVS PRODUCT UPDATE JCL member, MVSPATCH, to a location on your mainframe where it can be edited.

3. Determine whether MVSPATCH is applicable. Review the MVSPATCH JCL member and determine if you need to substitute or remove the FTP step from the job. If you are substituting another utility, or removing the step and using an interactive file transfer, be sure to use the following settings. File Transfer Settings for the .OBJ File: • BINARY - Binary transfer (the file is provided in EBCDIC format) • NOCRLF - No Carriage Return/Line Feed • RECFM - FB (fixed-block) • BLKSIZE - 1600 • LRECL - 80

4. Customize the MVSPATCH JCL member. Similar to all Pitney Bowes JCL, the MVSPATCH member contains a list of variables, enclosed in a “flower box,” at the start of the member. Review the variable requirements in the JCL member and follow the directions contained within.

5. Run the MVSPATCH JCL member. After you have performed the customization, submit the job. The job should complete with zero return codes.

6. Test the product update. If the product update was for the batch component of a Pitney Bowes product, run the IVPFILE provided with the original software or any existing job at your site to ensure that the batch load modules function properly. The IVPFILE job “exercises” a large number of programs in the system, so you can be sure that the verification process is comprehensive. If the product update was for the CICS component of a Pitney Bowes product, issue the “CEMT S PROGRAM (programid) NEW” command in the CICS region, or recycle the CICS partition. Then issue the startup transaction-id for the product and verify that the changes were applied. We recommend that you run this procedure before going on to the next step.

If you call Pitney Bowes programs from your applications statically, we suggest that you re-compile your programs at this point to pick up the new modules.

7. Implement the product update. After you test the new TEST load library and are satisfied with the results, copy the TEST libraries into production. You may use IEBCOPY or ISPF (or any other valid utility) to copy the TEST load and TEST object libraries into your respective production libraries. It is important that you use the replace option with either method.

The Next Step - Running Jobs You have successfully installed the software and database files. You’ve run the IVP job and looked at the execution log to ensure that the job ran to completion. Please refer to your CODE-1 Plus User's Guide for instructions on setting up and running your first job.


4

Installing on IMS

In this chapter:

Before You Begin the IMS Installation . . . . . . . . . . . . . . . . . . . . . .38 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 Installing the Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 Installing Product Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 The Next Step — Running Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . .43 If You Need More Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

Before You Begin the IMS Installation

Before You Begin the IMS Installation Chapter 4 provides instructions for installing CODE-1 Plus on an IMS platform. This chapter also includes information for installing product updates. The CODE-1 Plus product and database releases are distributed via internet download from the Pitney Bowes estore. Please refer to the appropriate section for instructions on installing your new product release or product update. The individual installing CODE-1 Plus must:

• Have the authority or permission to delete, replace, and allocate libraries and files • Have the authority or permission to submit jobs • Know the site file/member naming conventions • Know how to FTP files to the mainframe • Establish an account on the Pitney Bowes estore • Download the product documentation and release notes from

https://www.pitneybowes.com/us/support.html.



U.S. Postal Database

Required Contains U.S. Postal data in a Pitney Bowes proprietary format. This database contains every house number range in the United States and is updated on a monthly basis. The database files contain the following information: • ZIP + 4 Code • Standardized address elements • City and state information Data needed to perform Enhanced Street Matching (ESM) and All Street Matching (ASM). ESM and ASM apply extra matching logic to any input address that is not matched through the regular address validation process.

SuiteLink Required togenerate a USPS Form 3553 (CASS Summary Report)

The SuiteLink database corrects secondary address information for U.S. business addresses whose secondary address information could not be validated.

LACSLink Required togenerate a USPS Form 3553 (CASS Summary Report)

The LACSLink database allows you to correct addresses thathave changed as a result of a rural route address convertingto street-style address, a PO Box renumbering, or a street-style address update.








Chapter 4: Installing on IMS

Before You Begin the IMS Installation




If Your Product Has License Management. . . Pitney Bowes License Management technology prohibits overwriting of the License File (G1LICEN). If you overwrite the License File, your product ceases to operate. Please carefully read the following upgrade procedures to ensure proper installation of your license-managed product.

Do NOT delete or change your production License File!

• Installation to a Production System — If you install your product directly onto a production system, the installation routines will automatically account for an existing License File, and the product will operate as expected.

• Copy from Test System to Production System — If you copy the product from a test system onto a production system, it is vital that you DO NOT COPY THE LICENSE FILE from the test environment as part of the upgrade process. You must not modify the production License File (G1LICEN) during the upgrade process. If you overwrite the License File, your product will cease to operate.

If license management is not yet installed in your production environment, you must obtain a permanent license key from Pitney Bowes, and perform installation of the license file.

Contents of the Downloaded File Pitney Bowes delivers software releases in a compressed format as a self-extracting .zip or .exe files. This file includes:

• IDSINSTL.JCL, which is used to uploa