Waiting for engine...
Skip to main content

Connector configuration file

The connector configuration file (connector-config.xml) is an XML file that is used to bootstrap the connector loading process within the Runtime. This file determines which class is the Connector implementation class.

Runtime configuration​

When you create a local connector project, the connector-config.xml file is automatically generated for you as part of the build/distributions/*.car.zip file. Use an XML editor to update it with relevant information for the Platform runtime, including:

  • The class name for the Connector implementation class.
  • The target version of the Connector SDK.
  • Optional information such as cookie scope.

When packaging a connector in preparation for deployment, include connector-config.xml as part of your build.

Sample connector configuration file​

<?xml version="1.0" encoding="UTF-8"?>
<GenericConnector sdkApiVersion="2.28.3">
    <connectorClassName>com.example.connector.ExampleConnector</connectorClassName>
</GenericConnector>

Connector configuration content​

The following connector configuration file content will help you when you update it for your connector. Each bullet describes an XML element unless prefixed with an "@", in which case it is an attribute.

  • GenericConnector — The document element for the configuration content.

    • @sdkApiVersion (string) — Optional version number indicating which version of the SDK API the connector was built with. This controls interactions with the connector to enable backwards compatible behavior. Your connector implementation does not have to include this version number unless you want access to features added in later Connector SDK API versions.

      note

      The default SDK API version is 1.0.0. If you do not specify a version, the connector you build may not be able to take advantage of features offered in later versions. Ideally, your configuration should match the SDK API version you are using.

      To know the latest version of the Connector SDK, refer to the Changelog page.

    • connectorClassName (string) — The name of the class in this connector implementation which implements the com.boomi.connector.api.Connector interface.

      note
      • The connectorClassName is populated based on the className mentioned in the build.gradle file.
      • If you're building the connector using the Gradle Open API DSL plugin, there's no need to mention the className in the build.gradle file. By default, com.boomi.connector.openapi.dsl.OpenAPIDslConnector gets populated as the connectorClassName.

    • networkConfig — Optional element used with the following attribute.

      • @cookieScope (string) — An optional value that sets the persistence of cookies:
      • GLOBAL is the default in which cookies are shared in all processes throughout the Atom JVM lifecycle.
      • CONNECTOR_SHAPE isolates and shares cookies for the duration of the connector shape execution.
      • IGNORED discards cookies, even if they are requested by the server.
The connector configuration file must adhere to genericconnector.xsd:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:jxb="http://java.sun.com/xml/ns/jaxb" jxb:version="2.0">

    <!-- Copyright (c) 2008 Boomi, Inc. -->

    <xs:element name="GenericConnector">
        <xs:annotation>
            <xs:appinfo>
                <jxb:class name="GenericConnectorConfig" />
            </xs:appinfo>
            <xs:documentation xml:lang="en">
                Basic information necessary to load this connector package in the {conKeyRefs.UC_Atom_Runtime}.
            </xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="connectorClassName" type="xs:string">
                    <xs:annotation>
                        <xs:appinfo>
                            <jxb:property>
                                <jxb:javadoc>
                                    Name of the class which implements the com.boomi.connector.api.Connector class
                                    for this connector package.
                                </jxb:javadoc>
                            </jxb:property>
                        </xs:appinfo>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
            <xs:attribute name="sdkApiVersion" type="xs:string" default="1.0.0">
                <xs:annotation>
                    <xs:appinfo>
                        <jxb:property>
                            <jxb:javadoc>
                                Optional version of the Connector SDK API with which this connector implementation is
                                compatible, defaults to {@code "1.0.0"}.
                            </jxb:javadoc>
                        </jxb:property>
                    </xs:appinfo>
                </xs:annotation>
            </xs:attribute>
        </xs:complexType>
    </xs:element>
</xs:schema>
On this Page