> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# b2bImportAgreement

> Import an Agreement into the B2B repository along with all of its dependencies such as Listening Channel and documents. B2bImportAgreement accepts a f

Import an Agreement into the B2B repository along with all of its dependencies such as Listening Channel and documents. `B2bImportAgreement` accepts a [config file](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-b2b-plugin-guide/appendix-b2b/configuration-file-setup.md) for property replacement.

# Target Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>B2B Server Host</td><td>`FDB2B_SERVER_HOST`</td><td>Yes</td><td>Host Name for the B2B Server. Under the default SOA installation, it will share the same host as the managed SOA servers.</td></tr><tr><td>B2B Server Port</td><td>`FDB2B_SERVER_PORT`</td><td>Yes</td><td>Port for the B2B Server</td></tr><tr><td>Oracle SOA Home</td><td>`FD_ORACLE_SOA_HOME`</td><td>Yes</td><td>Oracle SOA Home indicates where SOA Suite is installed.</td></tr></tbody></table>

# Project Properties

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Display Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>B2B Agreement</td><td>`FDB2B_AGRMT_NAME`</td><td>Yes</td><td>The name of the Agreement to be imported to the B2B Repository.</td></tr></tbody></table>

# Inputs

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Input Name**</th><th>**Input Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Config File</td><td>`FDB2B_INP_CONFIG_FILE`</td><td>No</td><td>Config file to be used to replace environment specific properties.</td></tr><tr><td>Activate Agreement</td><td>`FDB2B_INP_ACTIVATE_AGRMT`</td><td>No</td><td>Boolean to indicate whether or not to activate the Agreement on deployment.</td></tr><tr><td>Overwrite Data</td><td>`FDB2B_INP_OVERWRITE_DATA`</td><td>No</td><td>Boolean to indicate whether or not to overwrite any conflicting data on deploy.</td></tr><tr><td>B2B User</td><td>`FDB2B_B2B_USER`</td><td>No</td><td>User that performs the given operation</td></tr></tbody></table>

# Artifacts

This operation consumes the Agreement zip produced in the export step as well as any [config file](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-b2b-plugin-guide/appendix-b2b/configuration-file-setup.md) to be used for property replacement. This is not exposed to workflow developer.  

# Endpoint Selection

This operation will select all available endpoints associated to the Target.

# Endpoint Execution

This operation will execute on any endpoint from the endpoint selection.

# Special Considerations

This operation uses a [config file](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-b2b-plugin-guide/appendix-b2b/configuration-file-setup.md) located in the artifacts repository to perform property replacement. Leaving the input `FDB2B_INP_CONFIG_FILE` blank will bypass any property replacement and deploy the Agreement as it was upon export.