mail360 manager v2.3.0 user and reference guide - all ... · information in this document is...

MAIL360 Manager™

Release 2.3.0 - December 2012 User’s and Reference Guide

Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its representatives. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, without the writtenpermission of Pitney Bowes Software Inc., One Global View, Troy, New York 12180-8399.

© 2009 - 2012 Pitney Bowes Software, Inc.

All rights reserved. MAIL360, MailStream Plus and Palletization Plus are trademarks of Pitney Bowes Software. Group 1 and the Group 1 logo are registered trademarks of Pitney Bowes Software. Pitney Bowes and “Engineering the flow of communication” are registered trademarks of Pitney Bowes,Inc. All other marks are trademarks or registered trademarks of their respective owners. Pitney Bowes Software holds a non-exclusive license to publish and sell ZIP + 4® databases on optical and magnetic media. The following trademarks are owned by the United States Postal Service®: CASS, CASS Certified, DPV, eLOT, FASTforward, First-Class Mail, Intelligent Mail, LACSLink, NCOALink, PAVE, PLANET Code, Postal Service, POSTNET, Post Office, RDI, SuiteLink, United States Postal Service, Standard Mail, United States Post Office, USPS, ZIP Code, and ZIP + 4. This list is not exhaustive of the trademarks belonging to the Postal Service. Pitney Bowes Software is a non-exclusive licensee of USPS® for NCOALink® processing. Prices for Pitney Bowes Software products, options and services are not established, controlled or approved by USPS® or United States Government. When utilizing RDI™ data to determine parcel-shipping costs, the business decision on which parcel delivery company to use is not made by the USPS® or United States Government.

Do you have a product idea? Go to pbinsight.force.com/pbideas and select your product on the left side of the page.

Pitney Bowes Software Documentation Team [email protected] One Global View Troy, New York 12180 www.pbinsight.com www.g1.com/support [email protected] or http://go.pbinsight.com/online-case-management Support: +1 (800) 367-6950 pbinsight.com

Canada: Phone: 416.594.5200 Fax: 416.594.5201 Sales: 800.268.3282 Technical Support:.518.285.7283 Technical Support Fax: 518.285.6080 pbinsight.ca

http://www.pbinsight.comhttp://www.pbinsight.cahttp://go.pbinsight.com/online-case-managementhttp://go.pbinsight.com/online-case-managementhttp://pbinsight.force.com/pbideasmailto:[email protected]

Table of Contents

Chapter 1: Introduction to the Intelligent Mail® Barcode. . . . . . . . . . . . . . . . . . . . 1 MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Intelligent Mail® Mailpiece Barcode Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Intelligent Mail® Package Barcode Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Chapter 2: MAIL360 Manager™ Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Overview of MAIL360 Manager™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Automatic Handling of New Mailer IDs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Configuring Partitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Allocation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Returning TADF Barcode Strings - Mailpiece Barcodes Only. . . . . . . . . . . . . . . . . . . . . . . . . . 8 Installing MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 MAIL360 Manager™ for Windows - A Tour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Running the Test Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

UNIX and Linux Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 MAIL360 Manager for UNIX and Linux - A Tour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Running the Test Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

z/OS Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 Learning About the Installed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Running the IVPL Test Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Running the Demo Program - IMBDEMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Running the IVPR Test Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

IBM® i Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 Working with the Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Chapter 3: MAIL360™ Callable Functions Interface Reference . . . . . . . . . . . . . 17 Introduction to the MAIL360 Callable Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Callable Functions - Quick Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Files Included with MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Language Variables and Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 IMBConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Release 2.3.0 iii MAIL360 Manager™ User’s and Reference Guide

IMBContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 IMBError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 IMBExtOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 IMBHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 IMBIPAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 IMBMailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Basic Service and User-Defined Intelligent Mail Barcode Allocation . . . . . . . . . . . . . . . . . . . 28 Tips for using mailer.BlockSizeExt = 0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

IMBMailPiece . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 IMBMailPieceSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 IMBParsedAddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 IMBPersonalName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 IMBRange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 IMBRangeExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 IMBTrackingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 IMBTray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 IMBVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 C Language Interface Callable Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

IMBCreate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

IMBGetFull() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

IMBGetRangeExt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

IMBGetRangeN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

IMBGetSingle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

IMBGetSingleContainer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

IMBGetSingleTray() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

IMBGetTADF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 C Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

IMBGetVersion(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

C Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

IMBWriteMailpieceExt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 C Language. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 COBOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter A: Configuring MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Configuring Your Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 Configuration File Samples: Windows, Unix, and Linux, IBM® i . . . . . . . . . . . . . . . . .58

MAIL360 Manager Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58 MAIL360 Manager Sample - Remote Numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59

Configuration File Sample for z/OS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59 Introducing the MAIL360 Batch Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63 Specifying Parameters Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

Parameter Field Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65 Commenting Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

ADDRES Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

ADJRDW Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

ADQUAL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

APP ID Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

CACERT Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

DROPZP Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

E KEY Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

EXITIN Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

EXITOP Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

FILEDF Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

FRMNAM Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

HEADER Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

IMBCTL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Release 2.3.0 v MAIL360 Manager™ User’s and Reference Guide

IMBINB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

IMBOUT Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

IP NUM Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

JOBDSC Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

JOBNAM Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

LABLN Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

ML 360 Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

MLDATE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

MOVE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

PAGESZ Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

PERNAM Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

POWNID Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

RANGE Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

SRVFRQ Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

UDATAI Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

UDATAS Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

UFTxx Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

UHDxx Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

ZIP IN Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

ZIPINB Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Running the MAIL360 Batch Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 The z/OS Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Using IVPLFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Running the Batch Driver on Unix or Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Creating Your Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Defining Jobs Through Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

The Windows Platform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112 Creating Your Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Defining Jobs Through Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Chapter C: MAIL360 Manager™ Processing Messages. . . . . . . . . . . . . . . . . . . 113 Overview of MAIL360 Manager Processing Messages . . . . . . . . . . . . . . . . . . . . . . . .114

Valid Message Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114 File I/O Messages: 1000-1499 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114 XML Parameter Validation: 1500-1999 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116 Configuration File Properties Validation: 2000-2199 . . . . . . . . . . . . . . . . . . . . . . . . . .118 Other Validation: 2200-2499 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 User Data Errors: 2500-2999 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118 Communication Domain Messages: 3000-3499 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 Thread Messages: 4600-4799 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 General System Messages: 5000-5999. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119 Internal Process Exceptions: 6000-6499 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121 Application Domain Messages: 8000-8099 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123 General Codes: 0001-0500 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Release 2.3.0 vii MAIL360 Manager™ User’s and Reference Guide

1

Introduction to the Intelligent Mail® Barcode

In this chapter...

MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Intelligent Mail® Mailpiece Barcode Components . . . . . . . . . . . . . .2 Intelligent Mail® Package Barcode Components. . . . . . . . . . . . . . .4

MAIL360 Manager™

MAIL360 Manager™

For optimal automation discounts, mailers must meet full service Intelligent Mail® rules. In-house presorts must meet electronic documentation and container labeling requirements.

While some products provide users with the ability to manually assign the serial numbers for the Intelligent Mail® barcode, many customers require a tool to automate the process, such as MAIL360 Manager™, from Pitney Bowes Software.

MAIL360 Manager offers a basic numbering engine that assigns and manages Intelligent Mail® barcodes for each unique mailer ID. This will include automated number management for MailStream Plus and StreamWeaver users, among other applications. MAIL360 Manager™ supports enterprise-wide mailer ID-sharing to assist in maintaining unique serial numbers.

MAIL360 Manager™ basic numbering does not guarantee 45-day uniqueness number tracking. To fully realize the benefits of Intelligent Mail® barcode tracking, you must use MAIL360 remote numbering server.

Intelligent Mail® Mailpiece Barcode Components

Figure 1: Layout of the Intelligent Mail® Mailpiece Barcode

Release 2.3.0 2 MAIL360 Manager™ User’s and Reference Guide

Chapter 1: Introduction to the Intelligent Mail® Barcode

Intelligent Mail® Mailpiece Barcode Components

The Intelligent Mail® mailpiece barcode consists of these elements:

According to the USPS®, the “... barcode ID identifies the presort makeup [with] an Optional Endorsement Line.“

• Barcode ID (two digits) - (For USPS internal use only) The barcode ID identifies the mailpiece presort level. It eventually replaces the Optional Endorsement Line (OEL) for flats. Letters currently start with '00'.

• Service Type Identifier (ID) (three digits) - The next three digits identify the USPS® mail class service code for destination (outbound) and origin (inbound) mail. This ID indicates the class of mail and indicates special services such as tracking and address correction.

• Mailer ID (six or nine digits) - This is a value assigned by the USPS® for the mailer or the company that “owns” the mail. The USPS® assigns six-digit mailer IDs to mailers sending 10,000,000 or more mailpieces per year. Lower volume mailers receive nine-digit mailer IDs.

• All six-digit mailer IDs start with a number from 0 through 8. Nine-digit mailer IDs begin with a 9. • Serial Number (nine or six digits) - This number allows mailers to identify specific recipients for

ConfirmTM or OneCode ACSTM purposes and/or to identify unique mailings. The USPS® specifies that this serial number cannot be reused in any mailing for 45 days for Full Service automation discounts. MAIL360 Manager™ allows you to fully manage your numbering schemes. The serial number lengths are “flipped” depending upon the length of the mailer ID: If you have a six-digit mailer ID your serial number contains nine digits; mailers with nine digit-mailer IDs have six-digit serial numbers.

• Delivery Point ZIP Code™ (zero, five, nine, or 11 digits) - This number represents the ZIP Code.


Intelligent Mail® Package Barcode Components

Intelligent Mail® Package Barcode Components

SAMPLE - DO NOT SCAN

The Intelligent Mail® Package barcode consists of these elements (up to 34 digits):

• Routing Information: • Postal Routine Code Application Identifier (three digits) — Must be used if with a destination

ZIP Code, Not displayed or printed in the readable form • Destination ZIP Code (five or nine digits) — Not displayed or printed in readable text version

• Tracking Information: • Channel Application Identifier (two digits) — This is “92” when a 9-digit Mailer Identifier is

used and is “93” when a 6-digit Mailer Identifier is used.

• Service Type Code (three digits) — Identifies the USPS® mail class service code for destination (outbound) and origin (inbound) mail. This ID indicates the class of mail and indicates special services such as tracking and address correction.

• Mailer ID (six or nine digits) — This is a value assigned by the USPS® for the mailer or the company that “owns” the mail. The USPS® assigns six-digit mailer IDs to mailers sending 10,000,000 or more mailpieces per year. Lower volume mailers receive nine-digit mailer IDs.

• Serial Number (seven, 10, 11, or 14 digits) — This number allows mailers to identify specific recipients for ConfirmTM or OneCode ACSTM purposes and/or to identify unique mailings. The USPS® specifies that this serial number cannot be reused in any mailing for 45 days for Full Service automation discounts. MAIL360 Manager™ allows you to fully manage your numbering schemes.

• Mod 10 Check Digit (one digit)


2

MAIL360 Manager™Basics

In this chapter...

Overview of MAIL360 Manager™ . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Automatic Handling of New Mailer IDs . . . . . . . . . . . . . . . . . . . . .6 Configuring Partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Allocation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Installing MAIL360 Manager™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 UNIX and Linux Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 z/OS Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 IBM® i Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Working with the Configuration File. . . . . . . . . . . . . . . . . . . . . . . .15

Overview of MAIL360 Manager™

Overview of MAIL360 Manager™ MAIL360 Manager™ provides an application programming interface (API) and batch driver that update and enrich data to increase mailing efficiency.

The batch driver supports Intelligent Mail® Barcodes, only.

This open API supports legacy products (such as MailStream Plus and StreamWeaver), as well as third-party applications and processes. MAIL360 Manager allows you to:

• Assign and manage Intelligent Mail® barcodes and Intelligent Mail® package barcodes. • Configure jobs for both known and unfamiliar mailer IDs. • Integrate enterprise-wide correspondence to improve internal business processes. • Assign and manage Intelligent Mail® barcodes through a C interface. • Automate the generation of Mailpiece Files for use in MAIL360 Data Manager™ processing.

For more information on the C Interface, see Chapter 3.

MAIL360 offers communication with the MAIL360 server(s). This feature assigns Intelligent Mail® barcodes for mailpieces as a stand-alone numbering engine or as a link to the MAIL360 Server.

The mailer ID is central to the allocation and management of Intelligent Mail barcode numbers. MAIL360 Manager™ contains features that allow you to specify numbering for mailer IDs.

Automatic Handling of New Mailer IDs MAIL360 Manager users can either automatically add new mailer IDs or return errors when new mailer IDs are encountered.

Configuring Partitions Your processing environment may require you to use partitions. When making multiple, concurrent job requests, some users may wish to guarantee that the assigned numbers are contiguous. Partitioning helps by segmenting the available serial numbers into mutually exclusive blocks.

If your site is using multiple instances of MAIL360 for concurrent Intelligent Mail Barcode numbering jobs, you run the risk of duplicate number assignments. Also, when multiple job requests are made to the same server, you need to preserve consecutive serial numbers. Partitioning can help by segmenting the available serial numbers into unique blocks and assigning each block a partition name. Specify this partition name in the IMBMailer structure so that serial numbers are drawn from the correct partition.

MAIL360 Manager users can divide mailer IDs into partitions to support Intelligent Mail barcode uniqueness across multiple servers or business units and to assign contiguous blocks of numbers. These partitions are identified by the first two digits (the partition ID) of the Intelligent Mail barcode serial number.


Chapter 2: MAIL360 Manager™ Basics Overview of MAIL360 Manager™

Example: one department of a business may be assigned a partition ID of 01 for mailer ID 123456, while another department is assigned 02. This prevents overlaps in number usage for a mailer ID. Using a partition ID reduces the size of the serial number range for all sub-mailers within a mailer ID by a power of one hundred.

Are you using partitions? If so, How will those partitions be organized? This section provides the details you need to plan and implement Intelligent Mail barcode numbering.

The sample mailpiece Intelligent Mail® barcode below illustrates the use of the partition ID. All jobs that draw on partition “01” will draw from the same pool of numbers, from 010000000 to 019999999.

Figure 2-1: Sample Mailpiece Partition ID

Once partitions are created, they are permanent. A mailer ID that has been configured to use partitions must always be accompanied by a partition ID. However, administrative procedures are available for removing partitioning from a mailer ID. Please contact Pitney Bowes Software Technical Support for instructions and procedures.

For more information on using partitions, see the IMBMailer structure.

Allocation Options Depending on your processing needs, you have the option of requesting:

• Single serial numbers – mailpiece, tray, or container • Intelligent Mail barcode – mailpiece • Intelligent Mail barcode – tray or container • Single-piece and range allocations – MAIL360 Manager users may assign serial numbers, one-

at-a-time, or in ranges, to suit individual processing needs. • Intelligent Mail package barcode – For single mailpieces • TADF in a single call (optionally, using IMBGetSingle()) – For mailpiece IM® barcodes only • Ranges of serial numbers ONLY – For mailpieces, trays, or containers

Numbering Tips: • If you choose to work with ranges, you also have the ability to set minimum and maximum range

sizes for allocation. • Smaller values decrease the likelihood of reaching the end of the partition or number pool during

processing.


Overview of MAIL360 Manager™

• Larger values prevent fragmenting of the available number pool. • If you breach your numbering boundary during processing, the job adjusts your range request to

the given limits. • You may also specify the initial range size and range size increment value when using

IMBGetSingle() to allocate ranges of numbers and improve run-time performance.

For more information on single-number allocation algorithms, see:

• IMBGetSingle() to request a single mailpiece barcode. • IMBGetSingleTray() to request a single tray barcode. • IMBGetSingleContainer() to request a single container barcode.

For more information on obtaining a range of serial numbers, see:

• IMBGetRangeN() to request a range of serial numbers for a mailpiece for use in an IM® Barcode • IMBGetRangeExt() to request a range of serial numbers for a mailpiece, tray, or container. • IMBGetRangeN() to a range of serial numbers to be used for the creation of an IM® Barcode,

IM® package Barcode, or tray/container barcode.

Returning TADF Barcode Strings - Mailpiece Barcodes Only

MAIL360 Manager returns a TADF barcode string based on the Intelligent Mail Barcode payload data.

This feature is available only when running in remote mode using the remote numbering server.


Chapter 2: MAIL360 Manager™ Basics Installing MAIL360 Manager™

Installing MAIL360 Manager™ The distribution media or online installation package for your release contains all the information needed to install and run MAIL360 Manager™. Follow the instructions for your platform.

Windows Installation Install MAIL360 Manager using the Windows Product Installation Guide. To access the Windows Product Installation Guide:

1. Access the Technical Support Web site at www.g1.com/Support and log in. If you do not have a user ID and password, contact Technical Support at 1-800-367-6950.

2. Select the Documentation link and then select the Installation Guides link.

3. Select the Windows Product Installation Guide. Follow the instructions in this guide for a successful installation.

After completing the installation, you may need to make additional changes to the settings in your MAIL360 Manager™configuration file. The sample configuration file, g1imb.cfg, is in the MAIL360 Manager™data directory. Edit the configuration file with your preferred text editor. For information on the configuration file changes you may need to make, see Configuring Your Software in Appendix A of this guide.

If you are calling the MAIL360 API from your own program and that program is not located in the same folder as G1IMBAPI.dll then you must set the following environment variables:

SET CODE_PREFIX="%G1IMB%\lib" SET SHARED_LIBRARY_PREFIX="%G1IMB%\lib" SET SHARED_LIBRARY_LIST=G1PIOMGR.dll;g1imbapi.dll

MAIL360 Manager™ for Windows - A Tour

The Windows installer creates a data folder for MAIL360 Manager, and sets a path to that location in the environment variable G1IMBDATA. It also creates a main program folder and will set the path contained in the G1IMB variable to that folder. The G1IMBBATCH environment variable is also created to point to the Batch drives Job folder. The contents of these folders are described below.

• data (The default path is C:\Group 1 Data\MAIL360) • bin: Contains Batch file And VB Script that support MAIL360 Manager • test: Contains files pertaining to the test job • include: Contains the header file (g1imbapi.h) and COBOL Copybook (G1IMBAPI.CPY) • sample: Contains sample program source code in C++ and Cobol languages.

• batch (The default path is C:\Group 1 Data\MAIL360) • Data: Folder for the Batch Driver Jobs Data and report file • Jobs: Folder for the *.bat files that run Batch jobs

• Main program folder (The default path for this is C:\Program Files\Group1\MAIL360) • lib: Contains the MAIL360 executable and DLL files • README file


http://www.g1/com/supporthttp://www.g1.com/supporthttp://www.g1.com/Supporthttp://www.g1.com/support

Installing MAIL360 Manager™

Running the Test Job

To run the IMBTEST program:

1. Go to Programs > Group 1 Software > MAIL360.

2. Select Run MAIL360 Test Job. This opens a DOS window displaying the job progress.

3. Go to C:\Group 1 Data\MAIL360\test to view the output files.

UNIX and Linux Installation Install your software using the UNIX/Linux Product Installation Guide. To access the Unix/Linux Product Installation Guide:

1. Access the Technical Support Web site at www.g1.com/Support and log in. If you do not have a user ID and password, contact Technical Support at 1-800-367-6950.

2. Select the Documentation link, then select the Installation Guides link.

3. Select the UNIX Product Installation Guide. Follow the instructions in this guide for a successful installation.

After completing the installation, you may need to make additional changes to the settings in your configuration file. The configuration file, g1imb.cfg, can be found in the data directory. The configuration file is a text file that you can edit with vi or any other Unix text editor. For information on the configuration file changes you may need to make, please see Configuring Your Software in Appendix A of this guide. If you are calling MAIL360 API from your own program you must source the setup file, which is located in the bin folder before you run your program.

After you complete the installation process, please review the README file in the product installation library for any late-breaking product changes.

MAIL360 Manager for UNIX and Linux - A Tour The UNIX and Linux directory structure and test job scenario for MAIL360 Manager™are described below.

Some installed components are described here. Please review your local installation to see all of the installed components.

The Unix installer creates the following standard directories:

• bin: Contains a setup shell script that: • Sets the G1IMBDATA environment variable, which points to the data directory • Sets the G1IMB variable, which points to the root installation directory for MAIL360

These variables are used by the runm360 driver script the runconvert script and the runtest, runtestcob, and rundemo test scripts, or any job script you create for your own use.


http://www.g1.com/Supporthttp://www.g1/com/supporthttp://www.g1.com/Supporthttp://www.g1/com/supporthttp://www.g1.com/Supporthttp://www.g1.com/supporthttp://www.g1.com/supporthttp://www.g1.com/support


• data: Contains the error message reference file (g1imb.msg) and MAIL360 data set file (g1imb.ds)

• data/test: Contains the following: • The error message data structure (g1imb.msg) and MAIL360 data set file (g1imb.ds) for the

imbtest program • For production runs, the g1imb.msg and g1imb.ds files, are in the data directory • Test data files, to avoid interference with the production data files

• include: Contains the header file (g1imbapi.h) • lib: Contains the executable MAIL360 files • sample: Contains program source code in C++ and Cobol languages

Running the Test Job

To run imbtest:

1. Source the setup script. . ./setup or source ./setup.csh for the C shell

2. Run the appropriate imbtest script located in the $G1IMB/bin area. Enter ./runtest

3. The return status code should be 0 (zero). The test output files can be found in $G1IMB/data/test. If the return status code is not 0, look at the test output files in $G1IMB/data/test to determine the cause of the error. Run the runtest script again once the problem has been identified. If you continue to encounter a non-zero status code, please contact Technical Support at 1-800-367-6950 for assistance.

4. Run the Demo test. Enter ./rundemo • If the return code is 0, go to $G1IMB/data/test.

Check the imbdemo.log file for valid numbers and messages. • If the return code is not 0, check the imdemo.ini file, and correct if necessary.

5. Run the IVPL job: ./runm360 ivpl

6. Navigate to $G1IMB/data. When the job has completed, check the ivpl.log file to determine the status return code. It should be zero. The report files are located in this directory as well. They are ivpl.rpt and ivpl.xlg.

7. Ensure that your Numbering Server is available to accept calls by the client. Ensure that your configuration file references the correct IP Address.

8. Run the IVPR test: ./runm360 ivpr


http:g1imb.dshttp:g1imb.dshttp:g1imb.ds


9. Navigate to $G1IMB/data. When the job has completed, check the ivpr.log file to determine the status return code. It should be zero. The report files are located in this directory as well. They are ivpr.rpt and ivpr.xlg.

You must have a valid MAIL360 Server available to run this job, and the ivpr.prm file must be modified to access this server.

z/OS Installation 1. Access the Technical Support Web site at www.g1.com/Support and log in. If you do not have a

user ID and password, contact Technical Support at 1-800-367-6950.

2. Select the Documentation link and then select the Installation Guides link. Before completing installation, the IDSINSTL.JCL places a sample configuration file in the G1IMBCFG member of the sample PDS.

3. If necessary, make changes to the configuration file and to the in-stream configuration data (DD name G1IMBCFG) used by the IVPFILE member of the installation JCL library. For more information, see Configuring Your Software in Appendix A of this guide.

Learning About the Installed Components

The IDSINSTL.JCL job will install the components listed below. The variable DSNs from IDSINSTL.JCL are noted in parentheses.

• The MAIL360 Manager™ messages file (yourhlq2.MAIL360.MESSAGES); see the Return Value Constants, and MAIL360 Manager Processing Messages (Appendix C), for more information on processing messages

• The C header and COBOL copybook PDSE files (yourhlq2.MAIL360.CHEADERS and yourhlq2.MAIL360.COBCPY, respectively)

• The load library (PDSE) containing the MAIL360 DLL and load modules (yourhlq2.MAIL360.LOADLIB)

• A PDS containing sample source and configuration members (yourhlq2.MAIL360.SAMPLIB) • An installation JCL library (yourhlq2.MAIL360.INSTALL.JCL) • The MAIL360 Manager™ object library (yourhlq2.MAIL360.OBJLIB) • The IMBTEST input data (yourhlq2.MAIL360.IMBTEST) • The batch drivers IVP Input file (yourhlq2.MAIL360.IVP.NAMEADDR) • The MAIL360 temporary license file (yourhlq2.MAIL360.TEMPLICN) • A PDS containing linkage editor IMPORT statements for linking with the MAIL360 DLL

(yourhlq2.MAIL360.SIDE.DECK)


http://www.g1.com/Supporthttp://www.g1/com/supporthttp://www.g1.com/supporthttp://www.g1.com/support


The following DD names must be defined with the given attributes and pointed to sequential data files. User- or application-defined names should be passed to MAIL360 Manager™ via the IMBConfig data structure (see IMBConfig for more information).

DD Names for z/OS

DD Name Record Length Description

Referenced or Generated?

80 Configuration file Referenced

G1IMBMSG 256 The MAIL360 Manager™ error message file

Referenced

G1IMBDS 1028 Intelligent Mail Barcode Dataset Generated (firsttime MAIL360 Manager is invoked)

G1IMBXRF (set Mailpiece File: Generated internally) • Flat File

– Record format = Fixed block – Logical record length = 1629 – Block size = 27693

• XML (no longer supported) – Record format = Undefined – Block size = 27998

NOTE: MAIL360 ignores LRECL, RECFM, or BLKSIZE parametersspecified for this DD name in your JCL. We recommend that you omit or remove these existing parameters from your MAIL360 JCL.

133 Log file Generated

z/OS users should note that the Mailpiece File (referenced as G1IMBXRF in the table above) is written in ASCII format when the XML layout option is set, and may not be readable on a z/OS platform. Transmit the file generated on z/OS in binary mode to MAIL360 Data Manager for processing. NOTE ALSO that the Mailpiece in XML file format is obsolete as of Release 2.1.0. We suggest using the flat file format. If you are running z/OS 1.8 or higher you must add XPLINK(ON) as an LE runtime argument. If you are running a COBOL program, specify: //STEP4OF4 EXEC PGM=MSDR00,REGION=0M,COND=(0,NE,STEP2OF4), // PARM='/XPLINK(ON)'



If you are running C or C++, specify: //STEP2OF2 EXEC PGM=IMBTEST,REGION=0M, // PARM='XPLINK(ON)/G1IMBCFG' A forward slash, /, separates required parameters from the LE runtime parameters. For C/C++ programs, the LE parameters precede the forward slash. For COBOL programs, the LE parameters follow the forward slash.

Running the IVPL Test Job

After you've completed your z/OS MAIL360 Manager product installation, go to the JCL library created by the installation, and locate the member IVPLFILE. This is an installation verification job that you can use to verify that the product installation was successful.

1. Locate member IVPFILE.

2. Add a job card and replace the lower-case variable names with your site-specific ones: • Your high-level qualifier (yourhlq) • The location of the Language Environment (LE) runtime library • The designated volume (VSAM DASD pack volser) in which the job will run

3. Define the pointers for the location of the STEPLIBS and the location of the USPS reference files.

4. Submit the IVPFILE JCL for processing.

5. Once the IVP job runs, use your SDSF (Systems Display and Search Facility), or IOF (Interactive Output Facility), or use your preferred display tool, to view reports, logs, system messages, and other job details.

6. Select the job ID for the IVPFILE job that you just ran.

Running the Demo Program - IMBDEMO

1. Go to Programs > Group 1 Software > MAIL360.

2. Select Run MAIL360 Demo to open a DOS window that shows various API test calls and results.

Running the IVPR Test Job

The IVPR job tests installation of the remote numbering engine. It:

• Executes IDCAMS to remove allocated files from a prior run. • Allocates a test numbering dataset. • Executes Mail360 Manager using the sample name/address file (NAMEADDR) copied from the

installation media.

1. Locate member IVPRFILE in the installation JCL PDS.


Chapter 2: MAIL360 Manager™ Basics Working with the Configuration File

2. Add a job card and replace the lower-case variable names with your site-specific ones: • Your high-level qualifier (yourhlq) • The location of the Language Environment (LE) runtime library • The designated volume (VSAM DASD pack volser) in which the job will run

3. Define the pointers for the location of the STEPLIBS and the location of the USPS reference files.

4. Submit the IVPRFILE JCL for processing.

5. Once the IVPR job runs, use your SDSF (Systems Display and Search Facility), or IOF (Interactive Output Facility), or use your preferred display tool, to view reports, logs, system messages, and other job details.

6. Select the job ID for the IVPRFILE job that you just ran.

IBM® i Installation The product is delivered on CD-ROM. To install the software, follow the instructions in the IBM® i Product Installation Guide, available at www.g1.com.

If you are reinstalling or upgrading MAIL360 product, be sure to back up G1IMBDS *FILE before proceeding.

Working with the Configuration File In addition to offering access to the MAIL360 API toolkit of numbering functions, MAIL360 Manager™ provides a configuration file (see IMBConfig) that allows end users to override configuration parameters at run time.

The IMBConfig settings take precedence over the values submitted to the IMBCreate() function, via IMBConfig.

For more information, see Configuring Your Software in Appendix A of this guide.


http:www.g1.com

Working with the Configuration File


3

MAIL360™ Callable Functions Interface Reference

In this chapter...

Introduction to the MAIL360 Callable Functions . . . . . . . . . . . . . .18 C Language Interface Callable Functions . . . . . . . . . . . . . . . . . .40 Files Included with MAIL360 Manager™ . . . . . . . . . . . . . . . . . .18 Language Variables and Data Types . . . . . . . . . . . . . . . . . . . . .19

Data Structures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 IMBConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19 IMBContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 IMBError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23 IMBExtOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24 IMBHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24 IMBIPAddr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 IMBMailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25 IMBMailPiece . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 IMBMailPieceSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30 IMBParsedAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30 IMBPersonalName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31 IMBRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31 IMBRangeExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31 IMBTrackingInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 IMBTray. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33 IMBVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 C Language Interface Callable Functions . . . . . . . . . . . . . . . . . . .40

IMBCreate(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 IMBGetFull() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41 IMBGetRangeExt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 IMBGetRangeN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44 IMBGetSingle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46 IMBGetSingleContainer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48 IMBGetSingleTray(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50 IMBGetTADF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52 IMBGetVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53 IMBTerminate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54 IMBWriteMailpieceExt(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

Introduction to the MAIL360 Callable Functions

Introduction to the MAIL360 Callable Functions This chapter is a reference to the structures, constants, and callable functions that make up the MAIL360 API/callable interface.

This API allows for the concurrent operation of multiple processes but not multiple threads.

This chapter describes all callable functions and provides C language and COBOL calling examples for those functions.

Callable Functions - Quick Overview This chapter describes the callable functions that manage numbering for any user application that must comply with USPS Intelligent Mail® barcode Full Service regulations:

• IMBCreate() creates an instance of the MAIL360 numbering engine • IMBGetFull() returns a TADF barcode string only, based on IMB payload data provided • IMBGetRangeExt() returns a range of one or more unique serial numbers for a mailpiece, tray

or container

• IMBGetRangeN() returns a range of one or more unique Intelligent Mail® barcode serial numbers

• IMBGetSingle() returns a single Intelligent Mail® barcode number or a TADF, formatted to USPS rules

• IMBGetSingleContainer() returns a single Intelligent Mail container number and/or an IMB payload

• IMBGetSingleTray() returns a single IMB tray number and/or an IMB payload, fully formatted to USPS rules

• IMBGetTADF() returns a TADF barcode string, derived from Intelligent Mail® barcode payload data

• IMBGetVersion() returns current software release details • IMBTerminate() ends the current instance of the Intelligent Mail® barcode numbering engine • IMBWriteMailpieceExt() constructs a mailpiece set that is appended to the mailpiece file for use

with addrQualInd2 data field

The following flow diagram shows how the MAIL360 Manager Interface works with the local numbering database:

Files Included with MAIL360 Manager™ The MAIL360 Manager™ installation process creates Dynamic Load Libraries (DLLs) also known as “Shared Object Libraries,” executable sample programs and source codes, run time scripts, and other supporting files that support the API functions:

• g1imbapi.h (in the include folder) – the API specification file for the MAIL360 product installation library.

• imbtest.cpp (in the sample folder) – sample C++ program source code that invokes MAIL360 Manager API functions.


Chapter 3: MAIL360™ Callable Functions Interface Reference Data Structures

• G1IMBAPI.CPY (in the include folder) – COBOL Copybook for MAIL360 API. • IMBCOBOL.COB (in the sample folder) – sample COBOL program that invokes MAIL360

Manager API functions. • imbdemo.cpp (in the sample folder) – sample C++ program source code that invokes MAIL360

Manager API functions.

Language Variables and Data Types The examples in this chapter use the following variables for C language and COBOL code. These objects, except for retVal, extInput and extOutput, are defined in the g1imbapi.h file.

Data Structures

IMBConfig This structure supplies MAIL360 with your desired configuration information. All configuration parameters are optional, but the default values may not be optimal for your application.

Some fields that are part of the IMBConfig structure are reserved for MAIL360 remote numbering. Users of MAIL360 Manager do not need to read from or write to these fields. Note that some of these fields may apply to remote numbering if security is implemented.

Data Fields for IMBConfig (Part 1 of 4)

Field Description Data Type Max. Length

apiRev API version string defined by the G1IMB_API_REV constant

char 20+1

cfgFilePath The path for the configuration file or the DD name

char 1024+1

autoAddMailerPolicy Enable automatic addition of non-existent mailer ID in database? A Add mailer that does not exist E Return an error if mailer does not exist NOTE: This field is required for to define the connectionType.

char 1

partitionExceptionPolicy Code specifying how to handle partitionexceptions: E Return error L Use lowest partition Valid for local numbering only

char See IMBIPAddr for more information

minRangeSize field removed: Use minRangeSizeExt

maxRangeSize field removed: Use maxRangeSizeExt


Data Structures



initialRangeSize field removed: Use initialRangeSizeExt

imbIPAddrWS Applies to MAIL360 remote numbering if you are using MAIL360 Data Manager - IP address and port number for the web service


IMBIPAddrxrefWS Applies to MAIL360 remote numbering -Cross-reference IP Address and port for Web Service


minRangeSizeExt Minimum range size that can be allocated;default = 1 Valid values are 0000000000001 to 9999999999999 NOTE: If you are running MAIL360 locallyand using partitions, the values defined here must allow for the partition ID.

char 12+1

rangeSizeIncrement Range size increment refers to the size of nextblock of numbers that will be allocated after initial allocation; default = 1 Valid values are 000000001 to 99999999 If you are running MAIL360 locally and using partitions, the values defined here must allow for the partition ID.

char 9+1

xrefFilePath Cross-Reference file path or DD Name. char 1024+1

connectionType Code specifying the Intelligent Mail barcode connection type: R Remote - MAIL360 Manager™ remote

numbering users: Select R to accessall of the MAIL360 numbering features.

L Local

char 1

logFilePath Location of the processing log file char 1024+1

logLevel Specifies the logging level, which may be any combination of the following: E Log errors I Log informational messages S Log set-up information and

configuration parameters T Log traces (for debugging only) W Log warnings The logging level is set to EW (errors and warnings) by default.

char 9+1

imbRootDir Location of the Intelligent Mail barcode installation root directory.

char 1024+1





imbDataDir Required for Unix, Linux, and Windows - Location of the Intelligent Mail barcode installation data directory NOTE: You must pass the directory path ofthe installation data directory to the IMBConfig structure or specify it in the configuration file.

char 1024+1

rejectRangeRequestGreaterThanMax

Code indicating whether to allocate a range ofserial numbers, for a single job/mailing, that isgreater than the maximum available range for the provided mailer ID or partition: Y Yes, reject over-allocation requests

(default) N No, allow over-allocation requests.

Note that this will cause multiple, non-unique numbers in the same job/mailing.

NOTE: We recommend not using this option,as this may generate invalid numbers.

char 1

jobName A user-specified identifier for the current job. char 50+1

jobDescription Description of the current job char 260+1

trackingPolicy Enable or disable tracking: Y Yes, enable tracking N No, do not use tracking (default)

char 1

licenseFilePath Path or DDNAME for the license file char 1024+1

reportFilePath Report file path or DD name char 1024+1

securityFilePath Security file (certificate) path or DD name char 1024+1

appId Name or ID of the calling program char 36+1

ownerID Owner ID for Mailpiece File used byMAIL360™ Data Manager (see the MAIL360 Data Manager User’s Guide for requirements).

char

partitionIdOverride Partition ID that overrides all partition ID fieldspassed through the IMBMailer structure. This parameter is intended for systems where the same partition ID is assigned to an entire job or to all jobs running on that system. NOTE: Any value defined here overrides partitions passed in the program. The localversion of MAIL360 Manager™ parameter partitionIdOverride must be 2 bytes.

char 20+1

mailingDate Job-level mailing date, format YYYY-MM-DD char 10+1


Data Structures



minRangeSizeExt The minimum range size that can be allocated.Valid values are 000000000001 to 999999999999.

char 12+1

maxRangeSizeExt Maximum range size that can be allocated: char 12+1 • Mailpiece mode default = 999999999 • Tray mode default = 99999999 • Container mode default = 999999999999. • Valid values are 0000000000001 to

9999999999999 NOTE: If you are running MAIL360 locallyand using partitions, the values defined here must allow for the partition ID.

initialRangeSizeExt Initial or default range size that can be char 12+1 allocated; default = 1 Valid values are 0000000000001 to 9999999999999 NOTE: If you are running MAIL360 locallyand using partitions, the values defined here must allow for the partition ID.

IMBContainer This structure supports container-based Intelligent Mail barcodes.

Data Fields for IMBContainer

Max. Field Description Data Type Length

uuid 36-byte Container ID generated by MAIL360 char 36+1 server

containerID Container ID code char 10+1

payloadData 21-digit payload data string char 21+1

serialNumber Serial number component of the container-based barcode

char 12+1

Reserved char 1024



IMBError IMBError provides the output error codes and descriptions when the API fails to process the required function. When an API function returns a value other than G1IMB_SUCCESS, the IMBError structure will contain additional information about the error (See Constants, in this chapter, and review Appendix C).

Data Fields for IMBError


code A code indicating the success or failure of thecurrent job. This will be in the following format:Annnn, where A is one of the following: E Error W Warning and the n values make up the related error number.

char 5+1

description The list of all possible error messages can befound in the Messages file. See Constants and Appendix C for a listing of processing messages. The error messages generated by MAIL360 are written to the log file.

char 256+1


Data Structures

IMBExtOptions

This structure is for future use only. Current users of MAIL360 Manager™ do not need to configure IMBExtOptions.

IMBExtOptions is a structure that allows for the future extension of the MAIL360 interface without affecting the client application. IMBExtOptions contains parameters to use with two extensibility fields that are referenced in the MAIL360 function calls. These extensibility fields will contain a list of name-value pairs (for example, accountNumber=12345678|statementDat=20110502).

Data Fields for IMBExtOptions


nameValueDelimiter Defines the delimiter that separates the name from the value. The default is = (equal sign).

char 1

npvDelimiter Defines the delimiter that separates the name-value pairs. The default is | (pipe character).

char 1

escapeChar Defines the character that “escapes” character conflicts with delimiters. The default is \ (back slash character).

char 1

inputLength Defines the allocated length of the input extensibility field, including the null terminator.

char 10+1

outputLength Defines the allocated length of the outputextensibility field, including the null terminator.

char 10+1

Reserved Reserved for future use char 100

IMBHandle IMBHandle defines the Intelligent Mail barcode handle structure, required for managing low-level I/O.

Data Fields for IMBHandle


msb Most significant bit UINT32 n/a

lsb Least significant bit UINT32 n/a



IMBIPAddr IMBIPAddr defines the domain and port information for the MAIL360 Web service. This data structure is used in remote configuration only (using MAIL360 remote numbering).

Data Fields for IMBIPAddr


domain The IP address or host name for the web server; If the communication channel between the MAIL360 Manager and MAIL360 Server is secured with SSL, the domain name should be prefixed with“https://”

char 50+1

port The port number for the web service char 5+1

IMBMailer IMBMailer supplies the information for an individual mailpiece or a mailing.

Data Fields for IMBMailer (Part 1 of 3)


barcodeId The 2-digit barcode ID for the mailer char 2+1

serviceType The 3-digit service type code char 3+1

mailerId The 6- or 9-digit mailer ID assigned by theUSPS. 6-digit mailer IDs always start with a numeral from 0-8, and 9-digit mailer IDsalways start with a 9.

char 9+1


Data Structures



partitionId An identifier specifying the numbering scheme for the mailer.

char 20+1

• When Connection Type is “L” (see connectionType): – Two-digit number - The partition ID,

which will take up the first two digitsof the Intelligent Mail barcode serialnumber.

– blank - No partitions. NOTE: If you do not use partitions at your site, do not enter anything here. Partitions are permanent once they are created. For more information on partitions, see Configuring Partitions in Chapter 2 of this guide. • When Connection Type is “R” (see

connectionType) use an identifier specifying the numbering scheme for the mailer: – If the first byte is an alphabetic

character, this indicates that a pre-defined number scheme name has been provided.

– If the first byte is numeric, then that number serves as the mailer sub-id, which is added after the mailer ID in the Intelligent Mail barcode.

– If this field is blank, no partitions are used.

routingZip The 5-, 9-, or 11-digit routing ZIP Code char 11+1

blockSize Requested range length NOTE: This field is obsolete.

char 12+1

mailingDate For Connection Type “R” (see connectionType for more information), the mailing date, in YYYYMMDD format

char 8+1

uniquenessDuration Number of days before the sequence numbers expire

char 3+1

userDefinedSN For Basic Intelligent Mail Barcode char 12+1 service: Type serial number should be validfor the length of the Mailer ID. For auto generating serial number, fill with blanks ornull string. • For Basic Intelligent Mail barcode

service, fill with zero or zeros. • For user-defined serial numbers,

populate with the desired serial number. NOTE: This field is obsolete.





blockSizeExt Requested range length (extended length) char 12+1

userDefinedSNExt For Basic Intelligent Mail Barcode char 12+1 service: Type serial number should be validfor the length of the Mailer ID. For auto generating serial number, fill with blanks ornull string. • For Basic Intelligent Mail barcode

service, fill with zero or zeros. • For user-defined serial numbers,

populate with the desired serial number.

cin

processingCode

Content Identifier Number for tray-basedIntelligent Mail barcodes. Describes the trayor sack based on the 3-digit CIN listed in theDMM. Three zeroes are used if no listing for the tray contents is found.

Used for Tray Intelligent Mail barcodes: 1 Automation Compatible, Barcoded,

and Machinable Mail 7 All other mail

char

char

3+1

1+1

labelType Used as a qualifier for systems to recognize and parse the data within the barcode. For tray-based barcodes, value is 1 when usedwith a, 6-digit Mailer ID. value is 8 when used with a 9-digit Mailer ID.

char 1+1

containerAppId Used for container-based barcodes; Allowable value is 99 only

char 2+1

typeIndicator

channelApplicationID

reserved

Used for Container-based barcodes; Allowable value is M only

IM® Barcode data serial number

Reserved for future use

char

char

char

1+1

2+1

687


Data Structures

Basic Service and User-Defined Intelligent Mail Barcode Allocation

Applies to the Intelligent Mail barcode basic service.

Your application may pass values to the IMBGetSingle function through the IMBMailer structure and receive results through the IMBMailPiece structure as described below:

Input to userDefinedSN of the IMBMailer Structure

Input to userDefinedSN of IMBMailer structure Output from IMBMailPiece structure

0, 000000 or 000000000 Uses all zeros as the serial number component of IntelligentMail barcode. Returns the TADF.

any 6- or 9- digit numeric value Validates for the given mailer ID and uses, if valid, as serialnumber component of Intelligent Mail barcode. Returns the TADF.

blank or null string Returns a new and unique Intelligent Mail barcode number, TADF and serial number from MAIL360 dataset for the given Mailer ID and Partition (if used).

serialNumber member of IMBMailPiece structure returned bya previous call to IMBGetSingle

Validates for the given mailer ID and uses, if valid, as serialnumber component of Intelligent Mail barcode for the current Intelligent Mail barcode processing request. This would be the technique used to assign the same serial number to aninbound mailpiece as an outbound mailpiece. Returns theTADF

The following table describes how sequence numbers are allocated using these parameters:

mailer.blockSize Details

mailer.blockSize Allocation and Delivery Scheme

1 Allocates one serial number from the Intelligent Mail barcode numberingdataset.

0 Allocates config.initialRangeSizeExt serial numbers from the MAIL360 dataset the first time it is called and delivers single Intelligent Mail barcodenumbers from the allocated range until all numbers are used up. On all subsequent calls, it allocates config.rangeSizeIncrementExt serial numbers one at a time (when needed) and again delivers single Intelligent Mailbarcode numbers from the allocated range until all numbers are consumed.

>1 Allocates mailer.blockSizeExt serial numbers, when needed, from the MAIL360 dataset and delivers single Intelligent Mail barcode numbers from the allocated range until all numbers are consumed.

Tips for using mailer.BlockSizeExt = 0

The initialRangeSizeExt and rangeSizeIncrementExt configuration parameters apply to the entire job, not to each mailer. When you define a block size of 0, the configuration settings for config.initialRangeSize and config.rangeSizeIncrement can improve job performance.



• If you are running one job that contains one mailer ID or a mailer ID and a single partition, we recommend that you set the initial range size to the number of records in the job, and the range size increment to a much smaller value, to minimize serial number requests and improve performance.

• If your job contains multiple mailer IDs and/or mailer IDs with multiple partitions, we recommend that you set the initial range size to the smallest group of mailer IDs or the smallest combination of mailer IDs and partitions. Set the range size increment to the same value as the initial range size.

• If you do not know the size of the job before you run it, set both range parameters to 10,000 for the best performance.

• If performance and over allocation of serial numbers are not issues, set the range parameters to 10,000.

IMBMailPiece This structure provides the TADF and Intelligent Mail barcode for a single mailpiece.

Data Fields for IMBMailPiece


uuid For Connection Type “R” (see connectionType): A unique 36-byte mailpiece ID generated by MAIL360 Server.This field allows you to track a specificmailpiece as it travels through the mailstream. For mailpiece tracking, thisvalue is returned by MAIL360 Server, along with the serial number.

char 36+1

payloadData The payload data (up to 31 digits) thatgenerates the TADF barcode string (left-justified, padded with trailing spaces).

char 31+1

barcodeString The 65-digit barcode string generated from the payload data. Ignore if you do not wantMAIL360 Manager™ to calculate and populate this field.

char 65+1

serialNumber For Basic Intelligent Mail Barcode service - Use this value in the userDefinedSN member of the IMBMailer structure to use the same serial number in the next Intelligent Mail barcode numbering request.For example, use this value when you wantto assign the same serial number to an inbound mailpiece as a previous outbound mailpiece.

char 9+1

reserved Reserved for future use char 990


Data Structures

IMBMailPieceSet This structure specifies the mailpiece set type.

Data Fields for IMBMailPieceSet


mpsetType Specify the mailpiece set type. O Outbound Mailpiece Set I Inbound Mailpiece Set M Outbound with Remittances

Mailpiece Set

char 1

ownerID Owner ID or Owner Code for the mailpiece char 64+1

eKey1 Enterprise Key 1 char 64+1



data1 Data1 char 64+1




IMBParsedAddress This structure contains the parsed components of a mailpiece address.

Data Fields for IMBParsedAddress


addressLine1 Primary address line char 64+1

addressLine2 Secondary address line char 64+1

city Standardized city name char 28+1

state USPS state abbreviation char 2+1

zip5 5-digit ZIP Code char 5+1

zip4 ZIP + 4 add-on code char 4+1



IMBPersonalName This structure contains the parsed components of a recipient name in a mailpiece file.

Data Fields for IMBPersonalName


prefix Title of recipient. char 10+1

firstName First name of recipient char 20+1

lastName Last name of recipient char 20+1

suffix Suffix of recipient (Jr., Sr., etc.) char 10+1

IMBRange This output structure indicates the allocation information for users working with ranges.

Data Fields for IMBRange


startingNumber The starting sequence number of theallocated range (padded with leading zeroes)

char 9+1

allocatedBlockSize The number of serial numbers that were actually assigned (padded with leadingzeroes)

char 9+1

remainderBlockSize The number of serial numbers that were not allocated (padded with leading zeroes)

char 9+1


IMBRangeExt This structure defines the allocation information for users working with ranges.

Data Fields for IMBRangeExt (Part 1 of 2)


startingNumber Starting sequence number of the allocatedrange (padded with leading zeroes)

char 12+1

allocatedBlockSize Number of serial numbers that were actuallyassigned (padded with leading zeroes)

char 12+1


Data Structures

Data Fields for IMBRangeExt (Part 2 of 2)


remainderBlockSize Number of serial numbers that were not allocated (padded with leading zeroes)

char 12+1


IMBTrackingInfo This output structure provides tracking information for the Mailpiece.

Data Fields for IMBTrackingInfo (Part 1 of 2)


name Name char 260+1

address Address char 512+1




dropZip The ZIP Code at the post office where mailer introduces the mailpiece

char 9+1

addrQualInd Enter address quality indicators as follows: char 64+1 • Position 0: CASS Result - Y, A, B, H, M, S,

Z or blank (no data) • Position 1: LACSLink Corrected - Y, N or

blank (no data) • Position 2: DPV Indicator - Y, S, D, M, N or

blank (no data) • Position 3: Vacant Address - Y, N or blank

(no data)

mailpieceDirection Specify the direction of the mailpiece. char 1 O Outbound I Inbound Only X Last Join Inbound



Data Fields for IMBTrackingInfo (Part 2 of 2)


addrQualInd2 Address Quality Indicator used with the char 64+1 IMBWriteMailpieceExt() function. This is NOT compatible with the IMBWriteMailpiece function: • Position 0 - DPVConfirm - Y, S, D, M, N • Position 1 - DPVacant - Y, N • Position 2 - DPVCMRA - Y, N • Position 3 - DPVFALSEPOSITIVE - Y, N • Position 4 - LACSLINK - Y, N, F, S • Position 5-6 - LACSLINKCODE - A, 00, 14,

92 • Position 7-46 - DPVFOOTNOTE - AA, A1,

BB, CC, F1, G1, M1, M3, N1, P1, P3, RR, R1

parsedAddress Populated with parsed address components in the mailpiece; See IMBParsedAddress

IMBParsedAddress

companyName Unparsed company name char 260 +1

personalName Populated with parsed personal name components in the mailpiece. See IMBPersonalName for more information

IMBPersonalName


IMBTray This structure supports tray-based Intelligent Mail barcodes.

Data Fields for IMBTray


uuid 36-byte Container ID generated by MAIL360 char 36+1 server

trayID Tray ID code char 10+1

payloadData 21-digit payload data string char 21+1

serialNumber Serial number component of the tray-based barcode

char 12+1

reserved char 1024


Data Structures

IMBVersion This data structure provides MAIL360 version information.

Data Fields for IMBVersion


versionStr The full version number, in the following format: MM.mm.rr.bb, where MM = Major release number mm = Minor release number rr = Revision number bb = Build number

char 20+1

buildNum The module build number. The format of this field is $Revision: n$ where n is the build number.

char 20+1

apiRev The API revision number. The format of this field is $Revision: n$ where n is the revision number.

char 20+1

buildDate The module build date. The format of this field is:”Month Day Year” with no punctuation.

char 20+1


Chapter 3: MAIL360™ Callable Functions Interface Reference Constants

Constants This section describes the constants that are set up using the C language #define command.

Constants (Part 1 of 5)

Name Value Description

G1IMB_ADDRESS_MAXCHARSIZE 512 Maximum number of characters for the address field.

G1IMB_ADDRLINE_MAXCHARSIZE 64 Maximum number of characters for either primary or secondary parsed address line.

G1IMB_ADDRQUALIND_MAXCHARSIZE 64 Define the length of the address quality fields

G1IMB_API_REV “$Revision: The API version. This number will changenn$” (where nn from release to release. is the current version)

G1IMB_APPID_MAXCHARSIZE 36 Applies to MAIL360 running in remotemode only - Maximum number of characters for the application ID

G1IMB_AUTOADDMAILER_POLICY_ADDMAILER “A” The policy for automatically adding a mailer ID if it does not already exist.

G1IMB_AUTOADDMAILER_POLICY_RETURNERROR “E” The policy for returning an error if an unfamiliar mailer is encountered.

G1IMB_BARCODE_MAXCHARSIZE 65 Maximum number of characters for the 65-character barcode data.

G1IMB_BARCODEID_MAXCHARSIZE 2 Maximum number of characters for the barcode ID parameter.

G1IMB_CIN_MAXCHARSIZE 3 Maximum number of characters for Tray Content Identifier Number

G1IMB_CITY_MAXCHARSIZE 28 Maximum number of characters for parsed standardized city name.

G1IMB_CONTAINER_APP_ID_MAXCHARSIZE 2 Maximum number of characters for Container Application ID

G1IMB_CONTAINER_ID_MAXCHARSIZE 10 Maximum number of characters for Tray 24-digit payload data.

G1IMB_CONTAINER_PAYLOAD_MAXCHARSIZE 21 Maximum number of characters for Container 21-digit payload data.

G1IMB_CONTAINER_TYPE “C” The USPS container type.

G1IMB_DESCRIPTION_MAXCHARSIZE 260 Maximum number of characters for the job description


Constants

Constants (Part 2 of 5)

Name Value Description

G1IMB_DOMAIN_MAX

mail360 manager v2.3.0 user and reference guide - all ... · information in this document is...

Documents