INFORMED VISIBILITY. Provisioning Enterprise Payment and Package Platform Data

Transcription

1 INFORMED VISIBILITY Provisioning Enterprise Payment and Package Platform Data V1.2, January 31, 2019

2 Contents Overview Get Access to IV-MTR, EPS, and PPC Access the IV-MTR Application Manage Data Delegation Request Delegation Approve Requests Create Delegation View Delegations Create a Data Feed Select Initial Options Select Entities Define Fields Retrieve Data Manage a Data Feed Resources Appendix Change History File Characteristics File Naming Convention Manage the Address Book 2

3 Overview With the Informed Visibility Mail Tracking & Reporting (IV -MTR) application (iv.usps.com), mailers are able to get: Mail tracking data for letter and flat containers, handling units (trays, tubs, and sacks), bundles, and pieces Mail quality data Functionality has been added to allow users to get Enterprise Payment System (EPS) and Package Platform Concept (PPC) data through an IV-MTR data feed (subscription). Data is available in the delimited file format: This format is a text file for which you can specify the data fields and the delimiter character. You specify the send frequency and start time for files to be generated and sent. Files can be sent to your server through Secure FTP* (SFTP) or set up to download from the IV-MTR application. Additional details about the file format are available in the appendix. Visibility of EPS and PPC data can be delegated between Customer Registration IDs (CRIDs). * If using SFTP, to ensure your system can receive data from IV-MTR, add the IV-MTR-specific IP addresses to your server firewall. Please contact the IV Solutions Center for the IP addresses. 3

4 Get Access to IV-MTR, EPS, and PPC 1. Register for a Business Customer Gateway (BCG) account*. 2. Request the Informed Visibility service in the BCG*. 3. Request access to EPS and/or PPC data: EPS: Follow these instructions to create your EPS account. PPC: Request the Manage Mailing Activity** service in the BCG. * See the Applying for Access to IV-MTR document for instructions. ** The Manage Mailing Activity service is part of the core suite of services that most users receive when registering for the BCG. If you have one of the following sub-services, you have the Manage Mailing Activity service: Balance & Feeds, Dashboard, Electronic Data Exchange, Mailing Reports, Manage Permits, or Postal Wizard. 4

5 Get Access to IV-MTR, EPS, and PPC 4. Enter the IV-MTR authorization code (BSA for the IV-MTR service needs to do this): Access the IV-MTR application through the BCG or at IV.USPS.COM. When prompted to enter the authorization code for each CRID, click Code to IV BSA. You receive an with the authorization code. Return to the IV-MTR application, enter the code for each CRID, and click Submit. If the code was entered correctly, the CRID is successfully set up within the application. Note: If you have already entered the authorization code in IV-MTR for a particular CRID, skip this step. 5

6 Access the IV-MTR Application Option 1: Directly 1. Go to 2. Click Log In and enter your credentials. Option 2: Through the BCG 1. Log into 2. Go to Mailing Services > Informed Visibility. 3. Click Go to Service. 6

7 Create a Data Feed To get EPS or PPC data, click the Create & Manage Data Feeds tab within Queries & Feeds. The Your Feeds section on the left displays existing data feeds. Here you can view or modify the details of a data feed and view a data feed s output history. All users can view the CRID s data feeds and retrieve files as needed. The Create a New Feed section on the right is where you create a new data feed. Only an IV-MTR BSA, BSA Delegate, or Subscription Manager can create a new feed. 7

8 Create a Data Feed: Select Initial Options To create a data feed, start by selecting the initial options under Create a New Feed. 1. First, select a Subscription Owner CRID. This is the CRID the data feed belongs to, meaning the IV-MTR BSA, BSA Delegates, and Subscription Managers for the selected CRID would be able to modify or delete the data feed in the future. This also determines which entities are available to select on the next screen. 2. Under Feed Data Type, select Payment Transactions (for EPS data) or Package Attributes (for PPC data). Note: If you do not see the needed option, you do not have the necessary access. See the instructions for getting access. 8

9 Create a Data Feed: Select Initial Options 3. Under File Format, select Delimited. Then, make a selection from the Delimiter drop-down menu. 4. Under Define Target, select where to send the files: To send files to a server via SFTP, select the name of the server. Note: Servers in your IV-MTR address book are listed. To add a new server, click Add a server. To download files from the IV-MTR application, select Online download. The drop-down menu becomes grayed out because you cannot also select a server. 9

10 Create a Data Feed: Select Initial Options 5. Under Frequency, select how often you will receive data from this feed. For EPS data, select hourly, daily, weekly, or monthly. For PPC data, enter a value and select minutes, hours, or days. The default is every 4 hours, but you may receive data as often as every minute up to every 31 days. EPS Options PPC Options 6. Under Start Time / Time Zone, enter a time value, select AM or PM, and select a time zone. The data feed will be active once it is created. The feed will send data according to the selected frequency and start time. 10

11 Create a Data Feed: Select Initial Options 7. Under Name This Feed, enter a name for the data feed. This is how your feed will display in the Your Feeds list. Note: The data type and sub-type, if applicable, are automatically appended to the feed name upon creation. For example, if you name the feed Data Feed 1 and then select the Commercial Mailings data type for the feed, the resulting feed name will be Data Feed 1 Transactions Commercial Mailings. 8. When finished selecting these initial options, click Continue. 11

12 Create a Data Feed: Select Entity(s) The Select CRID(s) area displays the Subscription Owner CRID and any CRIDs delegated to it. 1. Select a CRID for which to get data by clicking the CRID company name or number. The CRID moves to Your selected CRIDs. 2. Repeat as needed. Then, click Next Step. 12

13 Create a Data Feed: Define Fields On this screen, select the data type(s) and fields for which to receive data: 1. Under Data Type, select a data type and sub-type, if applicable. The data fields area below populates with the attributes available. 2. In the Data Fields section, select the data fields to receive for each data type or sub-type. The fields on the left are available, and those on the right are selected to be included in your data feed. Drag or double-click attributes to move them from one side to the other. 3. Once you have selected the data fields to be included, arrange them in your preferred order by dragging and dropping them on the right side of the Data Fields section. Note: For information about the available data feeds, see the EPS IV-MTR Data Elements document and the Package Platform Data Dictionary. 13

14 Create a Data Feed: Define Fields 4. When finished, click Create Feed. A pop-up appears confirming creation of the feed(s). Note: Data feeds are activated upon creation to begin delivering data according to the selected start time and frequency. 5. Close the window by clicking OK or the X icon. Note: If you selected more than one data type or sub-type, a separate data feed will be created for each. For example, if you selected both Commercial Mailings and PO Boxes under Transactions, two data feeds would be created one for Commercial Mailings and one for PO Boxes. You can distinguish between the two feeds because the data type is appended to the data feed name. 14

15 Create a Data Feed: Retrieve Data To retrieve files for a data feed, go to the Your Feeds list. In the Output History column, click the icon for the appropriate data feed. The Output History window opens. Click Download to download the file. 15

16 Manage a Data Feed To view the settings of a data feed, in the Details column, click the details icon for the appropriate data feed. The Details window opens. 16

17 Manage a Data Feed To modify the settings of a data feed: 1. In the Details column, click the modify icon for the data feed. A window opens. 2. Make changes as needed. 3. Scroll to the bottom of the window and click Update Feed. IMPORTANT: To save changes, you must click Update Feed. 17

18 Manage the Address Book To send data to a server, it must be added to the IV-MTR address book. You can add a server before or while creating a data feed. To add a server before creating a data feed: 1. Go to Address Book > Servers. 2. On the left side of the screen, select the Protocol Type and complete the remaining fields. 3. When finished, click Add to Address Book. The new server or web service is now available from the Define Target menu when you create a data feed. 18

19 Manage the Address Book To add a server or web service while creating a data feed: 1. Under the Define Target drop-down, click Add a server. A window opens. 2. Select the Protocol Type and complete the remaining fields. 3. When finished, click Add to Address Book. The new server or web service is added to your IV-MTR address book and is now available from the Define Target menu. 19

20 Manage Data Delegation Data delegation allows you to provide data visibility to another CRID or receive data visibility from another CRID. Company A CRID 1 Delegated Company B CRID 4 CRID 2 CRID 3 Delegated Company C CRID 5 Visibility of EPS or PPC data can be requested by any IV-MTR user or provided to any CRID, even if the user or CRID does not have the EPS or PPC service(s). However, the user or CRID who wants to retrieve the data would need to have the EPS or PPC service(s) to create a data feed. All of a CRID s users are able to see what delegations have been requested and what delegation rules currently exist to provide visibility to the CRID. However, only an IV-MTR BSA, BSA Delegate, or user with certain administrative roles (e.g., Data Delegation Manager) can manage requests and rules to provide visibility to or receive visibility from another CRID. 20

21 Manage Data Delegation There are four tabs within Data Delegation. Some users will only see two: Request Data Delegation: Request to receive visibility from another CRID, view the history of such requests, and cancel a pending request Manage Data Delegation: View, approve, and deny requests to provide visibility to another CRID; view the history of such requests; and modify or delete an existing rule providing visibility to another CRID Delegate Data to Others: Create a delegation rule to provide visibility to another CRID Data Delegated to My CRID: View active data delegation rules for which your CRID is receiving visibility from another CRID and delete such rules 21

22 Manage Data Delegation: Request Delegation Only an IV-MTR BSA, BSA Delegate, Data Delegation Manager, or Report Manager can submit a data delegation request for his or her CRID to receive visibility from another CRID. To request data delegation: 1. On the Select Entity(s) screen: a. Select the Delegation Data Type. b. Search for and add the CRID(s) for which you want to receive visibility. c. When finished, click Next Step. 22

23 Manage Data Delegation: Request Delegation 2. On the Define Filters & Fields screen: a. Select the data type(s), sub-type(s), and effective date range. b. When finished, click Next Step. 23

24 Manage Data Delegation: Request Delegation 3. On the Select Recipient(s) screen: a. Select the CRID(s) you would like to receive visibility of the data. b. When finished, click Submit Request. 4. Review your selections, and click Confirm. Your request is sent to the Delegating CRID for approval. 24

25 Manage Data Delegation: Request Delegation You may check the status of the request in the Request History section of this tab. 25

26 Manage Data Delegation: Approve Requests Only an IV-MTR BSA, BSA Delegate, or Data Delegation Manager can access the Manage Data Delegation tab. If there are pending requests, a tab icon shows the number pending. If there are multiple requests from one receiving CRID, you can approve them all at once or approve each individual request. To approve all requests for one Receiving CRID: 1. On the top row of the grouped requests for one Receiving CRID, click the green checkmark icon in the Action column. A window appears. 2. Review the warning that approving the requests as a group means you are approving them exactly as submitted. 3. If you wish to approve the requests as a group, click Approve. Data delegation rules are created providing visibility to the Receiving CRID as approved. 26

27 Manage Data Delegation: Approve Requests To approve an individual request: 1. On the row for the request you wish to approve, click the green checkmark icon in the Action column. A window appears. 2. In the window, make any necessary changes. 3. Click Approve. A data delegation rule is created providing visibility to the Receiving CRID as approved. 27

28 Manage Data Delegation: Approve Requests To modify or delete an approved data delegation rule for which your CRID is providing visibility to another CRID, see the Data Delegation Authorization History section of the tab. Click the modify icon in the Details column to modify or delete an existing rule. 28

29 Manage Data Delegation: Create Delegation Only an IV-MTR BSA, BSA Delegate, or Data Delegation Manager can access the Delegate Data to Others tab. To create a data delegation rule to provide visibility of your CRID to another CRID: 1. On the Select Entity(s) screen: a. Select the Delegation Data Type. b. Search for and add the CRID(s) you want to provide visibility of. c. When finished, click Next Step. 29

30 Manage Data Delegation: Create Delegation 2. On the Define Filters & Fields screen: a. Select the data type(s), sub-type(s), and effective date range. b. When finished, click Next Step. 30

31 Manage Data Delegation: Create Delegation 3. On the Select Recipient(s) screen: a. Select the CRID(s) you would like to receive visibility of the data. b. When finished, click Submit. 4. Review your selections, and click Confirm. The data delegation rule is created. 31

32 Manage Data Delegation: Create Delegation To modify or delete the data delegation rule, see the Data Delegation Authorization History section on the Manage Data Delegation tab. Click the modify icon in the Details column to modify or delete an existing rule. 32

33 Manage Data Delegation: View Delegations This tab displays the active data delegation rules providing your CRID with visibility of another CRID. If you are an IV-MTR BSA, BSA Delegation, or Data Delegation Manager, you can delete an existing rule so your CRID no longer has visibility of a particular Delegated CRID. 33

34 Manage Data Delegation: View Delegations To delete an existing data delegation rule: 1. Click the delete icon in the Details column for the rule. A window appears. 2. To delete the data delegation rule, click Delete. 3. A window appears informing you the data delegation rule has been deleted. Close the window by clicking OK OR the X icon. 34

35 Resources Additional Documentation EPS IV-MTR Data Elements Package Platform Data Dictionary IV Solutions Center , Option #2 PostalPro Go to Search for: EPS for EPS IV for IV-MTR Returns for Package Platform 35

36 Appendix 36

37 Change History Date Version Description 2/1/ Added link to Applying for Access to IV-MTR document. Updated instructions for entering the IV-MTR authorization code to reflect the BSA no longer needing to contact the IV Solutions Center for the code. Added link to the Package Platform Data Dictionary. Updated link to the EPS IV-MTR Data Elements. Added PostalPro search term for Package Platform. 10/30/ Added hourly option for EPS data feed frequency. 7/24/ Initial version 37

38 File Characteristics Delivery Method Send to Server Download File Extension TXT TXT Compression Option for zipped or unzipped Always zipped File Naming Convention Example File Name YYYYMMDDhhmmss_CRID_AAA_BB_CC_DDDD.txt* _ _EPS_AW_HR_2XY4.txt Column Headers Included Included Delimiter Character End of Line Character Selected by user Line feed (LF) \n Escape Character \ \ Handling of Large Number of Records In-App Notification When Ready Displayed in Output History Behavior if No Records Multiple files created if more than 500,000 records Not available Yes * See the next slide for additional details. Blank file sent and appears in Output History YYYYMMDDhhmmss_CRID_AAA_BB_CC_DDDD.txt* _ _EPS_AW_HR_2XY4.txt Selected by user Line feed (LF) \n Multiple files created if more than 500,000 records Available Yes Blank file appears in Output History 38

39 File Naming Convention File name: YYYYMMDDhhmmss_CRID_AAA_BB_CC_DDDD.txt Key: YYYY = year MM = month DD = day hh = hour mm = minutes ss = seconds CRID = CRID number AAA = three letters for the system name (EPS or PPC) BB = two letters for the report name CC = two letters for the frequency DDDD = four alphanumeric characters representing the message ID (e.g., A2WU) Report Name Code Frequency Code Pricing Notification PN Hourly HR Final Notification FN Daily DA Transactions TR Weekly WK Postage Statement Details PP Monthly MN Bank Account Withdrawals AW Minutes MI Commercial Mailings Address Quality PC Postage PO Boxes NCMS Network Returns Deposits CM AQ PC PO NC NR DP 39