VTEX connection

Introduction

A VTEX connection, created using the VTEX connector, establishes access to VTEX. Once a connection is configured, you can create instances of VTEX activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a VTEX connection

A new VTEX connection is created using the VTEX connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing VTEX connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a VTEX connection

Each user interface element of the VTEX connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each VTEX connection and must not contain forward slashes / or colons :. This name is also used to identify the VTEX endpoint, which refers to both a specific connection and its activities.

• Account Name: Enter the account name for the VTEX instance.

• App Key: Enter the application key for the VTEX instance.

• App Token: Enter the application token for the VTEX instance.

• Environment: Select the VTEX environment to use with the VTEX connection:

  • VTEXCOMMERCESTABLE: The main environment (selected by default).

  • VTEXCOMMERCEBETA: The beta environment.

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the following occurs:

  • The connection is validated with a GET call to the vlm/account resource.

  • The latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a VTEX connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

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

• Upsert: Updates existing object data or creates new object data in VTEX and is intended to be used as a target in an operation.

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

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

• Delete: Deletes object data from VTEX and is intended to be used as a target in an operation.