Skip to Content

Via B2B Initial Load Activity

Introduction

A Via B2B Initial Load activity, using its Via B2B connection, 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 to provide data in an operation.

Note

When using the Via B2B connector, you must first use the Read activity's Initial Load object to retrieve object data from a Via B2B partner. Once you have retrieved the partner object data, you then use the Initial Load activity to load that data into the Via B2B instance. After the data has been loaded into the Via B2B instance, you can use the Read, Create, and Update activities to interact with the loaded data.

Create a Via B2B Initial Load Activity

An instance of a Via B2B Initial Load activity is created from a Via B2B connection using its Initial Load activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Via B2B Initial Load activity can be edited from these locations:

Configure a Via B2B Initial Load Activity

Follow these steps to configure a Via B2B Initial Load activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

Via B2B Initial Load Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Via B2B Initial Load activity and must not contain forward slashes / or colons :.

  • Select an Object: This section displays objects available in the Via B2B endpoint.

    • Selected Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Via B2B endpoint. This may be useful if objects have been added to Via B2B. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Via B2B endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available objects, the Via B2B connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Via B2B Initial Load Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Initial Load activity loads partner (idParceiro) data from a .zip file (fileName) 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.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Via B2B endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Via B2B Initial Load activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Via B2B Initial Load activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.