Outbound File Handling
Succeed Insurance needs to send files to external systems as part of the integrations with InsuranceSuite. Because of this they will need to understand how outbound file handing integration is performed with InsuranceSuite.
Learning Objectives
The learning objectives for this module are:
- Understand the different files types that are supported with outbound file handling.
- Understand how to use work queues with outbound file handling.
- Understand how to implement an outbound file integration.
- Understand how the standards around outbound file processing.
Overview of outbound file handing
The base configuration of InsuranceSuite includes a framework that supports
creating files for external systems. The files are created from records in a
database. InsuranceSuite provides the framework with a general processing
mechanism and the OutboundFileHandler
interface
which describes how to process data in the records.
Supported file types
The support types of files that are support with OutboundFileHandler
. They are:
Local Files are transferred to a directory in the local file system.
Amazon S3 Files are transferred to an Amazon S3 bucket. S3 is the preferred option. Please note that S3 buckets cannot be accessed by configuration developers working on a non-Guidewire Cloud Platform environment, such as a clone of the product repository on a laptop or virtual machine. Instead, they must use their local filesystem as shared access storage.
Outbound files integration process
Outbound files integration proceeds in the following stages.
- Outbound files batch process.
Outbound records are loaded from the database.
Outbound files are created and saved in the specified location.
- Work queue.
- The work queue writes file records to the specified outbound file with the dedicated OutboundFileHandler implementation.
Implementing an outbound files integration
To implement an integration, create an implementation of the OutboundFileHandler
interface. Then, configure outbound
files integration.
To implement an integration the followings steps should be followed:
Extend the
BaseOutboundFileHandler
class.Implement the open and process methods.
Deploy your changes.
In the base configuration, BaseOutboundFileHandler
implements OutboundFileHandler
. The details about
the methods can be found here.
There are a number of configuration parameters to be considered when implementing outbound configuration. The following documentation outlines the most common options.
Standards
Be sure to read the following SurePath documentation for Working Locally With Outbound File-Based Integrations.
Also, read this SurePath Standard for working with S3 buckets.
Knowledge Check
To validate your knowledge please complete this Knowledge Check of the information you just read.
Was this page helpful?