Configure outbound files integration

To configure outbound files integration, you must provide configuration parameters. You can do this in the user interface of a deployed application or with a configuration file.

You can specify two types of integrations:

• To test your changes locally, configure a local integration.
• To configure outbound files integration in the cloud, configure a managed Amazon S3 integration.

Amazon S3 integrations

To use outbound files integration with Amazon S3, provide the following configuration details.

Note:

Local configurations aren't compatible with the cloud environment. Amazon S3 configurations aren't compatible with the local environment. To use one XML configuration file for multiple environment types, specify the env parameter for local and cloud environments.

Configuration parameters

To use outbound files integration with Amazon S3, provide the following configuration parameters:

• Name

  Name of an integration.

  This value must be unique.

• Prefix

  Prefix for the batch identifier and the output file.

• Extension

  Extension of the output file.

• File handler class

  Fully qualified name of a class containing the outbound file handler logic.

  For example: gw.OutboundFileHandler.

• Days till purge

  Number of days before the processed outbound files and records are purged from the database. The value must be between 0 and 730. The default value is 365.

In the managed Amazon S3 configuration, Guidewire provides the following details:

• Temporary directory

  Path to the temporary directory for the output file.

  Optionally, you can override the temporary directory with the PLUGIN_OUTBOUND_TEMP_DIR variable.

  For details, see Variables.

• Permanent directory bucket

  Name of the Amazon S3 bucket for the outbound files.

• Permanent directory prefix

  Full Amazon S3 bucket path where the outbound files will be transferred.

Local testing

You can test your changes on a local instance of the InsuranceSuite application.

Note:

Local configurations aren't compatible with the cloud environment. Amazon S3 configurations aren't compatible with the local environment. To use one XML configuration file for multiple environment types, specify the env parameter for local and cloud environments.

Configuration parameters

For local integrations, provide the following configuration details:

• Name

  Name of an integration.

  This value must be unique.

• Temporary directory

  Path to the temporary directory for the output file.

• Permanent directory

  Path to the permanent directory for the output file.

• Prefix

  Prefix for the batch identifier and the output file.

• Extension

  Extension of the output file.

• File handler class

  Fully qualified name of a class containing the outbound file handler logic.

  For example: gw.OutboundFileHandler.

• Days till purge

  Number of days before the processed outbound files and records are purged from the database. The value must be between 0 and 730. The default value is 365.

Configure outbound files integration in the user interface

Provide configuration details using the InsuranceSuite application interface.

1. Select a star system.

2. From Apps , select Planets or select it from your pinned apps.

3. Select the planet with the deployed application.

4. From Applications and add-ons, select InsuranceSuite.

5. In the Deployment tab, in the application tile, select the link under Status.

6. Log in to the application.

7. Go to Administration → Utilities → Outbound Files.

8. Select Outbound File Configs.

9. Select a tab.

   Option	Description
   Amazon S3 Storage Configs	Specify configuration parameters for the managed Amazon S3 bucket.
   Local Storage Configs	Specify configuration parameters for testing your changes on a local instance of an InsuranceSuite application.

10. Select Add.

11. Specify configuration parameters and select Update.

Configure outbound files integration with ManagedS3OutboundConfigPlugin

You can add or edit a configuration of outbound files integration with ManagedS3OutboundConfigPlugin. During server startup, this plugin loads all configuration details from the OutboundFileConfiguration.xml file and from an external file location specified in the plugin.

Specify configuration file sources

By default, the plugin ManagedS3OutboundConfigPlugin loads values from the following file:

 modules/configuration/config/outbound/OutboundFileConfiguration.xml

Additionally, you can specify a path to an external file location. The path to the external file location must be relative to the modules/configuration folder.

For more information about using an external definition file, see InsuranceSuite documentation.

Edit the configuration file

In the configuration file, provide the parameters. Depending on the configuration type, use the following sections:

• ManagedS3Configuration

  Configure a managed Amazon S3 configuration.

• LocalConfiguration

  Configure a local integration for testing.

For example, to configure a managed Amazon S3 configuration, use the following structure:

<ManagedS3Configuration>
    <Name>Name</Name>
    <FileHandlerClass>gw.HandlerClass</FileHandlerClass>
    <ChunkSize>0</ChunkSize>
    <DaysTillPurge>123</DaysTillPurge>
</ManagedS3Configuration>

Note:

Local configurations are not compatible with cloud environments and managed Amazon S3 configurations are not compatible with local environments. If you are using a single XML file to configure both local and managed Amazon S3 integrations, use the env attribute to specify the environments.

To implement the changes, redeploy the related application.

env attribute

The env attribute specifies the environment for which you are configuring the integration.

When you configure an integration in the XML file, the application reads the following:

• Configurations with the env attribute that matches the application's environment
• Configurations without the env attribute

To use a single XML file when configuring both local and managed Amazon S3 integrations, specify the env attribute for each configuration.

For managed Amazon S3 configurations, the value must be the same as the env value for the cloud environment. To check the env value, navigate to the Runtime Environment Info screen in the deployed application.

For more information, see Access deployed applications.

For local integrations, the value must be the same as the env value for the local instance of your InsuranceSuite application. The value must be different than the env value for the cloud environment.

For more information, see the InsuranceSuite documentation.