Fairsail Payflow Cookbook for CSV Record Downloads

Transcription

1 Fairsail Payflow Cookbook for CSV Record Downloads Version 10 FS-PF-CSV-CB R010.00

2 Fairsail All rights reserved. This document contains information proprietary to Fairsail and may not be reproduced, disclosed, or used in whole or in part without the written permission of Fairsail. 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. Fairsail takes care to ensure that the information in this document is accurate, but Fairsail 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. Fairsail, 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 Fairsail as set out in the contract existing between us. This document may contain screenshots captured from a standard Fairsail 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. FS-PF-CSV-CB R Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

3 Contents Contents About this Guide 4 Related Guides 4 Fairsail Payflow Implementer's Guide 4 What You Need to Know About the Third Party System 5 Information From the Customer 6 Configuration 7 Download Configure 7 File Configure 8 Field Mapping 9 Translations for Mapped Fields 10 Index 11 Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

4 About this Guide This Payflow Cookbook provides implementation guidance for configuring Payflow to manage a CSV record file download from Fairsail for supply to a third party system. Related Guides Fairsail Payflow Implementer's Guide Coverage summary How to set up, manage, and maintain data flows between Fairsail and other systems, typically for data related to compensation and benefits. The guide includes sections on setting up a benefit selection system on Fairsail. Typical target audience You have responsibility for the implementation of an interface between Fairsail and one or more external services. Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

5 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 Fairsail. You must ensure that the extracted Fairsail 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 Fairsail server by the third party system. Supply the Fairsail SFTP server details. Push mode: the data transfer is initiated by Fairsail and sent to the server for the third party system. Request the SFTP server details for the third party system. Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

6 Information From the Customer Related Guides Information From the Customer Fairsail 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 Fairsail: 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 Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

7 Configuration Download Configure Configuration This section provides selective information to help you set up a download file with comma separated value records. For full information on all fields, see the Payflow Implementer's Guide. Download Configure To configure the download: 1. On the Payflow Services Home page click the Name of the Service you want to configure. Fairsail displays the Payflow Service Console. 2. On the Payflow Service Console for the Service, click Configure. Fairsail displays the Configure page for the service. 3. In the Download Files section click Download Configure. Fairsail displays the Download Configure page. 4. In the Options section leave all fields blank: Download Record Delimiter defaults to \r\n for return and line feed. Download Field Delimiter defaults to, (comma). Both defaults are correct for a csv file. 5. Complete other fields on the Download Configure page as necessary. Use the Payflow Implementer's Guide for reference. 6. Click Save. Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

8 Configuration File Configure File Configure 1. On the Configure page for the service, in the Download Files section, click New to create the Download File: Fairsail displays the Create Download File page. 2. In Download File Name enter the name for the file as agreed with the third party system. 3. Header and Footer are typically blank for csv files. 4. Complete other fields on the Create Download File page as necessary. Use the Payflow Implementer's Guide for reference. 5. Click Save. Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

9 Configuration Field Mapping Field Mapping 1. On the Create Download File page for the file, in the Mapping HCM to File section, click New. Fairsail displays the Mapping HCM to Download Files Configure page. 2. Key fields are: Order Length Character Set Defines the sequence in which fields are placed in the record, working from left to right, from lower numbers to higher numbers. 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, Fairsail redisplays the Create Download File page with the new mapping added to the list at the foot of the page. Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

10 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. Fairsail displays the Configure page for the mapping. 2. At the bottom of the page in the Translations for this value section, click New. Fairsail displays the Configure Translation page: 3. In Current Value enter the value stored in Fairsail. 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: Fairsail Payflow Cookbook for CSV Record Downloads Fairsail

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