Skip to Content

Via B2B Connector

Summary

The Harmony Via B2B Connector establishes access to Via B2B.

The Via B2B connector provides an interface for creating a Via B2B connection, the foundation used for generating instances of Via B2B activities. These activities, once configured, interact with Via B2B through the connection.

The Via B2B connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Via B2B connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Via B2B connection and its activities are referred to as a Via B2B endpoint:

Via B2B activity types

  • Read: Retrieves object data from Via B2B and is intended to be used as a source in an operation.

  • Initial Load: Loads partner object data from Via B2B using the partner ID (idParceiro) and the partner ZIP file (fileName) containing the data (retrieved using the Via B2B Read activity). This activity is intended to be used as a source in an operation.

  • Create: Creates object data in Via B2B and is intended to be used as a target in an operation.

  • Update: Updates object data in Via B2B and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Via B2B connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Via B2B APIs have controlled security through allowlisting. To allow access to Via B2B's APIs while using this connector with a Private Agent, contact Via B2B and request the inclusion of any Private Agent IP addresses in Via B2B's firewall allowlist. Jitterbit's Cloud Agents are already allowlisted with Via B2B.

The Via B2B connector uses the Via B2B REST API v5.5. Refer to the API documentation for information on the schema nodes and fields.

The Initial Load activity loads partner data from a .zip file retrieved using a Via B2B Read activity and returns XML in its response. For more information on this process, see the Carga inicial and Download de Arquivos sections in the Via B2B documentation.

Troubleshooting

If you experience issues with the Via B2B connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.viab2b" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.