Learn how to make tested and working AS2 Connections available in another Vault environment.

About Transferring AS2 Connections Between Vault Environments

When adding an AS2 Connection to an agency or partner, the best practice is to create, configure, and test the connection in a non-production Vault first to ensure it has the correct settings, certificates, and list of allowed IPs. Once the AS2 Connection is working correctly, you can transfer it to your Production Vault. This ensures that the connection works correctly once it is transferred to the correct Vault.

There are two (2) steps you must complete to transfer AS2 Connections between Vaults:

Considerations

The following constraints apply when transferring AS2 Connections between Vaults:

  • Your organization must be the owner of both the source and destination Vaults.
  • The source and destination Vaults must be in the same deployment region (for example, US-East-1).
  • The source and destination Vaults must have the same release type (either Limited Release or General Release).

Environment Transfer Status for AS2 Connections

An AS2 Connection record’s AS2 Environment Transfer Status field indicates its current transfer status (if any) as described in the table below.

Environment Transfer Status Applicable Vault (Source or Destination) AS2 Connection Description
n/a (or blank) Source The connection has not been involved in any transfers.
Transferring Out Source

Vault is currently transferring the AS2 Connection to the destination Vault.

For AS2 Connections in this state, the following restrictions apply:

  • The connection's settings (including the Connection Allowed List records) cannot be edited.
  • The Sync Connection to Gateway action is not available.
  • You cannot upload Partner or Sponsor certificates.
Transferred Out Source

Vault has transferred the AS2 Connection to the destination Vault.

For AS2 Connections in this state, the following restrictions apply:

  • The connection's settings (including the Connection Allowed List records) cannot be edited, but can be deleted.
  • The Sync Connection to Gateway action is not available.
  • You cannot upload Partner or Sponsor certificates.
Transferred In Destination The AS2 Connection was transferred from a source Vault.
Transfer Canceled Source A transfer action was initiated but was canceled before it was completed.

Transfer Connections from the Source Vault

To transfer one (1) or more AS2 Connections from a source Vault to a destination Vault, navigate to Admin > Connections in the source Vault and then complete the steps in this section for each AS2 Connection record you want to transfer to the destination Vault.

Prerequisites

The following must apply for each AS2 Connection in the source Vault you want to transfer:

  • The connection must be in the Registered state.
    For more information on synchronizing an AS2 Connection, see Configure Custom AS2 Connections.
  • The connection’s AS2 Transfer Vault Domain field must contain the URL of the destination Vault.
    For example, https://<DestinationVault>.veevavault.com, where <DestinationVault> is the name of the Vault to which you want to transfer the connection.
  • The connection’s Environment Transfer Status field is set to one (1) of the following:
    • blank
    • n/a
    • Transfer Canceled
    • Transferred In

Transfer Connections

Once each connection you want to transfer meets the above prerequisites, navigate to the AS2 Connection record of one (1) of these connections and from the All Actions menu, select Allow Transfer.

If you are transferring more than one (1) connection, Vault confirms if you want to proceed with transferring all the connections that share the same AS2 Transfer Vault Domain. Select one (1) of the following options as required:

  • Cancel: The transfer is canceled. No changes are made to any of the connection records.
  • Confirm: Vault proceeds with transferring the connections, as described below.

Result

Vault sets the AS2 Environment Transfer Status field of each of the connections being transferred to Transferring Out.

Next Steps

To complete the connections transfer, follow the steps described in Transfer Connections into the Destination Vault.

Cancel an AS2 Connection Transfer

To stop a transfer currently in progress on an AS2 Connection in the source Vault, from the connection’s All Actions Menu, select Cancel Transfer.

If there are other connections in the process of being transferred with the same AS2 Transfer Vault Domain, Vault asks if you want to cancel the transfer for all the connections. Select one (1) of the following options as required:

  • Cancel: No changes are made to any of the connection records.
  • Confirm: Vault proceeds with canceling the transfer of the selected AS2 Connections, as described below.

Result

Vault sets the Environment Management Status field of the AS2 Connection and any shared AS2 Connections to Transfer Canceled.

Transfer Connections into the Destination Vault

Once you have transferred connections from the source Vault, complete the following steps to pull the AS2 Connections from the source Vault into the destination Vault:

  1. In the destination Vault, navigate to Admin > Settings > AS2 Connection Settings.
  2. In the Transfer Connections section, enter the URL of the source Vault, excluding the https:// part of the URL.
    For example, <DestinationVault>.veevavault.com.
  3. Select Transfer AS2 Connections.

Result

Vault performs the following actions for each of the transferred connections:

  • Creates an AS2 Connection record in the destination Vault for each AS2 Connection record in the source Vault whose AS2 Transfer Vault Domain field matches the URL of the destination Vault. Vault sets the AS2 Vault Gateway State field of the AS2 Connections records in the destination Vault to Registered.
  • Sets the AS2 Environment Transfer Status field of the transferred AS2 Connections in the source Vault to Transferred Out.
  • Sets the AS2 Environment Transfer Status field of the transferred AS2 Connections in the destination Vault to Transferred In.
  • Sends a notification that the transfer process is completed.
    If one (1) or more AS2 Connection records fail to transfer, Vault also sends a notification email.