Skip to content

B2Brouter Module Setup

In the B2Brouter Setup section, you configure the connection to your B2Brouter account. Here, you enter the required access data, specify whether to use the production or test environment, and can check the connection status of your configuration.

Information

Before you can configure the B2Brouter setup, you must first create a B2Brouter account and complete the initial setup in B2Brouter.

Information on registration and the first setup steps can be found at B2Brouter - Register as a User

Set Up Connection to B2Brouter

In the B2Brouter Main Information section, you enter the access data for the connection to your B2Brouter account.

  1. Open the role center Document Dispatch - Administrator.
  2. Under Setup, open Module Setup.
  3. Navigate to the B2Brouter Setup area.
  4. Enter the production data:
    • Account Id
    • API Key
  5. Optionally enter the staging data:
    • Account Id (Staging)
    • API Key (Staging)
  6. Activate Testmode if you want to work with staging.
  7. Check the connection indicators:
    • API Status (Production)
    • API Status (Staging)

Note

You can find the Account Id and API Key by logging into B2Brouter and navigating to the Developer section.

The Account Id and the displayed API Key are required for configuring the B2Brouter connection in Document Dispatch.

If you want to use a Staging Environment, it must first be created in your B2Brouter account.

The B2Brouter Setup section contains the account information that Document Dispatch uses when sending electronic invoices to B2Brouter.

Field Description
Account Id Specifies the B2Brouter account for production shipping processes.
API Key Specifies the API key for production shipping processes.
Account Id (Staging) Specifies the B2Brouter account for test shipping processes.
API Key (Staging) Specifies the API key for test shipping processes.
Testmode Sends B2Brouter requests to the staging environment instead of the production environment.
API Status Production Displays the connection status for the production setup.
API Status Staging Displays the connection status for the staging setup.

Display B2Brouter Counter in the Factbox (optional)

You can display an additional B2Brouter counter in the factbox. This allows users to see directly on the current record how many associated B2Brouter entries exist without having to leave the overview.

  1. Open the role center Document Dispatch - Administrator.
  2. In the Setup area, open Module Setup.
  3. Navigate to the Status Display area located in the Factbox Setup section.
  4. Activate the option B2Brouter Sent Counter.

Information

The B2Brouter counter shows the total number of all B2Brouter entries for the current record. All B2Brouter entries are considered, regardless of their processing status, such as successfully processed, pending, or erroneous entries.

This makes it easier to distinguish B2Brouter entries from other shipping or document entries.

Activate B2Brouter Test Mode

With Test Mode, you can test the connection to B2Brouter in a separate test environment (staging) without transferring data to the production environment. This allows you to safely test configuration changes and processes before going live.

When Testmode is activated, Document Dispatch uses the staging account and the associated staging API key. If Testmode is deactivated, communication occurs via the production account and the production API key.

Follow these steps to activate the B2Brouter Test Mode:

  1. Open the role center Document Dispatch - Administrator.
  2. In the Setup area, open Module Setup.
  3. Navigate to the B2Brouter Setup area.
  4. Activate the Test Mode toggle to use the communication with the B2Brouter staging environment.

Important

The Test Mode only works if a valid Account Id (Staging) and a corresponding API Key (Staging) have been entered.

If no valid staging access data is available, the error message "API Key must be specified." will appear during test shipping.

Before sending invoices, ensure that the correct environment is selected. Invoices sent with production access data will be transmitted to the production B2Brouter environment.

Check B2Brouter Availability

With the availability check, you can verify whether the entered B2Brouter access data is valid and whether a connection to the selected environment can be established. The displayed status fields indicate whether the configuration has been successfully verified and whether communication with B2Brouter is possible.

The availability for the B2Brouter production environment and the B2Brouter staging environment is displayed separately.

The status display is automatically updated as soon as you change the account ID or the API key. This allows you to directly verify the validity of the entered access data.

Status Description
Error The specified Account Id or API Key is invalid.
Not Configured No access data has been entered.
Connected The entered access data is valid, and Document Dispatch is successfully connected to B2Brouter.

B2Brouter Status Update Formula

With this field, you can specify which time period should be considered when updating the B2Brouter status. This allows you to narrow down the number of shipping entries to be checked and limit the status update to relevant entries. Only shipping entries that have already been submitted to B2Brouter are considered.

For the status update to be executed, the task queue item Document Dispatch Update B2Brouter Status must be set to Ready. If the field is left empty, all shipping entries submitted to B2Brouter will be considered, regardless of their creation date.

Follow these steps to restrict the B2Brouter Status Update to shipping entries:

  1. Open the role center Document Dispatch - Administrator.
  2. In the Setup area, open Module Setup.
  3. Navigate to the B2Brouter Setup area.
  4. Enter the date formula -2D in the Status Update Formula field.

This will ensure that only shipping entries created within the last two days are considered during the B2Brouter status update.

See also