Configure outbound files integration with OutboundConfigPlugin

Add or edit a configuration with OutboundConfigPlugin. This plugin can load all configurations from the config/outbound/OutboundFileConfiguration.xml file or from an external file specified during server startup.

The OutboundConfigPlugin plugin

OutboundConfigPlugin and all its parameters are in the OutboundConfigPlugin.gwp file.

<?xml version="1.0"?>
<plugin
  interface="IStartablePlugin"
  name="OutboundConfigPlugin">
  <plugin-java
    javaclass="com.guidewire.outboundfile.plugin.OutboundConfigPlugin">
    <param
        name="externalConfigFileLocation"
        value="/tmp/guidewire/outbound/config/OutboundFileConfiguration.xml"/>
    <param
        name="updateExisting"
        value="false"/>
  </plugin-java>
</plugin>
Where:
  • externalConfigFileLocation – Valid path to the external file with configuration definitions.
  • updateExisting – Parameter specifying whether existing configurations in the database must be updated.

External configuration file

The external configuration file must be based on an .xsd definition file.

<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://guidewire.com/outbound" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://guidewire.com/outbound" elementFormDefault="qualified">
   <xs:element name="OutboundConfigurations">
    <xs:complexType>
      <xs:sequence>
        <xs:element type="OutboundLocalConfiguration" name="LocalConfiguration" minOccurs="0" maxOccurs="unbounded" />
        <xs:element type="OutboundS3Configuration" name="S3Configuration" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
   <xs:complexType name="OutboundConfigurationBase">
    <xs:sequence>
      <xs:element type="xs:string" name="Name"/>
      <xs:element type="xs:string" name="Prefix"/>
      <xs:element type="xs:string" name="Extension"/>
      <xs:element type="xs:string" name="FileHandlerClass"/>
      <xs:element type="xs:integer" name="DaysTillPurge"/>
      <xs:element type="xs:string" name="TemporaryDirectory"/>
    </xs:sequence>
    <xs:attribute name="env" type="xs:string"/>
  </xs:complexType>
   <xs:complexType name="OutboundLocalConfiguration">
    <xs:complexContent>
      <xs:extension base="OutboundConfigurationBase">
        <xs:sequence>
          <xs:element type="xs:string" name="PermanentDirectory"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
   <xs:complexType name="OutboundS3Configuration">
    <xs:complexContent>
      <xs:extension base="OutboundConfigurationBase">
        <xs:sequence>
          <xs:element type="xs:string" name="ProfileName" minOccurs="0"/>
          <xs:element type="xs:string" name="PermanentBucketName"/>
          <xs:element type="xs:string" name="PermanentPrefix"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
   </xs:schema>