Skip to main content

Inbound File Handling

Succeed Insurance needs to bring data into the InsuranceSuite applications using files from external systems. They need to understand how the inbound file handlers are implemented.

Learning Objectives

The learning objectives for this module are:

  • Understand the different files types that are supported with inbound file handling.
  • Understand how to use work queues with inbound file handling.
  • Understand how to implement an inbound file integration.
  • Understand how the standards around inbound file processing.

Inbound files integration

The base configuration of the InsuranceSuite applications includes a framework for configuring multiple integrations with external systems. This is achieved by processing file-based data. The InsuranceSuite applications provides the framework with a general processing mechanism and the InboundFileHandler interface which describes how to process data in the files.

Supported file types

The support types of files that are support with InboundFileHandler. They are:

Local Files are read and archived on a directory in the local file system.

Amazon S3 Files are read and archived using 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.

For additional information about how the inbound file integration process, read this information

Work queues for inbound files integration

There are two queues for processing inbound files. They are:

  • InboundChunkWorkQueue - The work queue InboundChunkWorkQueue processes records within one chunk.
  • InboundFilePurgeWorkQueue - The work queue InboundFilePurgeWorkQueue checks if there are any inbound files for which the purge date has elapsed. If there are such files, the work queue removes them and associated records from the database.

The status of the inbound records can be found in this table

Implementing an inbound files integration

To implement an integration the followings steps should be followed:

  1. Extend the BaseInboundFileHandler class.

  2. Implement the process method.

  3. Deploy your changes.

In the base configuration, BaseInboundFileHandler implements InboundFileHandler. The details about the methods can be found here.

There are a number of configuration parameters to be considered when implementing inbound configuration. The following documentation outlines the most common options.

Standards

Be sure to read the following SurePath documentation for the standards to use for inbound file processing.

Knowledge Check

To validate your knowledge please complete this Knowledge Check of the information you just read.