Payflow Cookbook for Fixed Length Record Downloads

Transcription

1 Payflow Cookbook for Fixed Length Record Downloads Version 23 SP-PF-FLR-CB R023.00

2 Sage All rights reserved. This document contains information proprietary to Sage and may not be reproduced, disclosed, or used in whole or in part without the written permission of Sage. Software, including but not limited to the code, user interface, structure, sequence, and organization, and documentation are protected by national copyright laws and international treaty provisions. This document is subject to U.S. and other national export regulations. Sage takes care to ensure that the information in this document is accurate, but Sage does not guarantee the accuracy of the information or that use of the information will ensure correct and faultless operation of the service to which it relates. Sage, its agents and employees, shall not be held liable to or through any user for any loss or damage whatsoever resulting from reliance on the information contained in this document. Nothing in this document alters the legal obligations, responsibilities or relationship between you and Sage as set out in the contract existing between us. This document may contain screenshots captured from a standard Sage system populated with fictional characters and using licensed personal images. Any resemblance to real people is coincidental and unintended. All trademarks and service marks mentioned in this document belong to their corresponding owners. SP-PF-FLR-CB R Sage

3 Contents Contents About this Guide 4 Related Guides 5 What You Need to Know About the Third Party System 6 Information From the Customer 7 Configuration 8 Download Configure 9 File Configure 10 Field Mapping 11 Translations for Mapped Fields 12 Index 13 Sage

4 About this Guide This Payflow Cookbook provides implementation guidance for configuring Payflow to manage a fixed length record file download from Sage People for supply to a third party system. Sage

5 About this Guide Related Guides Related Guides Payflow Implementer's Guide Coverage summary How to set up, manage, and maintain data flows between Sage People and other systems, typically for data related to compensation and benefits. The guide includes sections on setting up a benefit selection system on Sage People. Typical target audience You have responsibility for implementing an interface between Sage People and one or more external services. Sage

6 What You Need to Know About the Third Party System Related Guides What You Need to Know About the Third Party System The third party system receives the data from Sage People. You must ensure that the extracted Sage People data maps accurately to the requirements of the other system. File specification for the third party system Record length Required fields with field positions in the record Formatting rules for fields such as: Dates Social Security Numbers Include rules for separator characters such as "-": are these required or not permitted, if required find out if different characters can be used. Header and footer requirements File naming rules Feed frequency and timing Testing process For many third party systems testing can be lengthy. Make sure the customer is aware of the potential impact on the implementation, and manage their expectations. Delivery Secure SFTP Pull mode is preferred: the data is requested from the Sage People server by the third party system. Supply the Sage People SFTP server details. Push mode: the data transfer is initiated by Sage People and sent to the server for the third party system. Request the SFTP server details for the third party system. Sage

7 Information From the Customer Related Guides Information From the Customer Sage People fields to map to the third party system The customer may not know all available fields; be prepared to help. Additional custom fields may be required. Translations For example, the third party system may need numeric codes for fields held as text on Sage People: Relationship field holds the values Spouse, Partner, Child... Third party system may require 01, 02, New Starter Process Start date for benefits, for example: On sign up End of month Beginning of month Notice period required by the third party system for new starters. Terminations When do benefits expire for terminated employees? For example: On the termination date At the end of the month when they terminated A fixed period after termination Opting Out When does benefits cover expire for employees who opt out mid-term? For example: On the opt out date At the end of the month when they opted out A fixed period after opting out Sage

8 Configuration Related Guides Configuration This section provides selective information to help you set up a download file with fixed length records. For full information on all fields, see the Payflow Implementer's Guide. Sage

9 Configuration Download Configure Download Configure To configure the download: 1. On the Payflow Services Home page click the Name of the Service you want to configure. Sage People displays the Payflow Service Console. 2. On the Payflow Service Console for the Service, click Configure. Sage People displays the Configure page for the service. 3. In the Download Files section click Download Configure. Sage People displays the Download Configure page. 4. In the Options section complete Download Record Length: Leave Download Record Delimiter blank: this field is not relevant for fixed length records. 5. Complete other fields on the Download Configure page as necessary. Use the Payflow Implementer's Guide for reference. 6. Click Save. Sage

10 Configuration File Configure File Configure 1. On the Configure page for the service, in the Download Files section, click the Name of the file that carries the fixed length records. Sage People displays the Create Download File page for the file. 2. Enter Header: The header is one record in the file. It must be set up to occupy the full defined length of a record, in this case 2000 characters. Because the values in the header occupy 60 characters, the space character is repeated 1940 times to complete the record. 3. Enter Footer: The footer is one record in the file. It must be set up to occupy the full defined length of a record, in this case 2000 characters. Because the values in the footer occupy 17 characters, the space character is repeated 1983 times to complete the record. 4. Complete other fields on the Create Download File page as necessary. Use the Payflow Implementer's Guide for reference. 5. Click Save. Sage

11 Configuration Field Mapping Field Mapping 1. On the Create Download File page for the file, in the Mapping HCM to File section, click New. Sage People displays the Mapping HCM to Download Files Configure page. 2. Key fields are: Position Length Character Set Defines the position of the field in the record, as defined by the requirements of the third party system. Defines the length of the field, as defined by the requirements of the third party system. Use with Character Set to constrain field content. For example, with Length 9 and Character Set you can constrain the field to hold 9 purely numeric characters. If applied to the Social Security Number field this example removes hyphens (-) or other separator characters from the data. Defines the characters that are permitted in the field. If used, any characters not included are removed from the data. Use with Length to tightly define field content. 3. Complete other fields on the Mapping HCM to Download Files Configure page as necessary. Use the Payflow Implementer's Guide for reference. 4. Click Save. 5. Repeat for all mappings required. When you save each mapping, Sage People redisplays the Create Download File page with the new mapping added to the list at the foot of the page. Sage

12 Configuration Translations for Mapped Fields Translations for Mapped Fields 1. On the Create Download File page for the file, in the Mapping HCM to File section, click the Name of the mapped field. Sage People displays the Configure page for the mapping. 2. At the bottom of the page in the Translations for this value section, click New. Sage People displays the Configure Translation page: 3. In Current Value enter the value stored in Sage People. 4. In Replacement enter the value to be used in the file for the third party. 5. Click Save. 6. For multiple values in the same field, repeat steps 2 to 5 as necessary to define the set of translations you want to apply. Translations for this value displays the translations you have loaded: Sage

13 Index A About this Guide 4 C Configuration 8 D Download Configure 9 F Field Mapping 11 File Configure 10 I Information From the Customer 7 P Payflow Implementer's Guide 5 R Related Guides 5 T Translations for Mapped Fields 12 W What You Need to Know About the Third Party System 6 Sage