Skip to main content
This operation creates a template Trading Partner Config Plan file from B2B Trading Partners on the current OIC Target. The plan can be applied during Trading Partner import / partial deploy (after the Trading Partner is imported). Its purpose is to allow environment-specific properties to be replaced for Trading Partner transports, outbound Host identifiers, and inbound/outbound agreement settings prior to deployment. This prevents manual updates of those settings between deployments to different environments.
Either FDOIC_CLOUD_ACCOUNT_CODE target property value or FDOIC_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exist, the plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for OIC.

Target Properties

Property Name

Property Code

Required

Description

OIC Account

FDOIC_CLOUD_ACCOUNT_CODE

No

The OIC account with all the required properties like Base URI, Username and Password for connecting to an OIC Instance

Inputs

Input Name

Input Code

Required

Description

OIC Account

FDOIC_INP_CLOUD_ACCOUNT_CODE

No

The OIC account with all the required properties like Base URI, Username and Password for connecting to an OIC Instance. Typically, this will not be used because the value will come from the property FDOIC_CLOUD_ACCOUNT_CODE instead.

Trading Partner List

FDOIC_INP_B2B_TRADING_PARTNER_LIST

No

CSV list of Trading Partner ids to include. Leave blank to include all non-project Trading Partners (and, depending on Project List, project Trading Partners as described below). Use PROJECTID:TRADINGPARTNERID for a project Trading Partner.

Project List

FDOIC_INP_B2B_PROJECT_LIST

No

CSV list of project ids whose Trading Partners should be included. Leave blank to include Trading Partners from all projects when that path is used.

OIC Trading Partner Config Plan File

FDOIC_INP_B2B_TP_CONFIG_PLAN

No

Optional input to specify a different Config Plan file name. If not specified, it defaults to TradingPartnerConfigPlan.properties. An absolute path can be specified. Otherwise, the location is relative to the temp directory (create / utility) or resolved from artifacts on deploy, then copied to temp for property replacement.

If neither the Trading Partner List nor the Project List is given, Config Plan entries for all non-project Trading Partners and Trading Partners in all projects are created.
If either is given, Config Plan entries for those listed are created.
If both are given, Config Plan entries for the listed of both lists are created (listed Trading Partners plus all Trading Partners in the listed projects).

Artifacts

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

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

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

  • This plan is separate from the Trading Partner Identifier Plan (TradingPartnerIdentifiersPlan.properties), which covers partner identifiers and control numbers.
  • Only fields that should change per environment should remain in the file. Delete lines you do not want to update.
  • Transport Host identifiers (AS2 / AS4 / RosettaNet) and outbound agreement Hosts use UI format Type | Value (example: AS2 Identifier | FLEXAGONOIC_AS2). The Type and Value must exist on the target Host Profile at apply time.
  • Config Plan apply runs after Trading Partner import. Transport updates that change a REST Send URI require the transport integrations to allow that update in OIC (integrations must not remain activated in a state that blocks URI update). Prefer a full undeploy/import/apply/deploy path.
  • Hand-edited keys outside the generate allow-list for that transport/agreement type are ignored. Allowed plan keys that are missing on the OIC object cause apply to fail with a clear error.

Sample Properties

Empty Properties

Only identifier and control number entries that need to be overridden should be included in the Trading Partner Identifier Plan file. If a line is present with no value (as shown above), the corresponding Trading Partner identifier or control number setting will be updated to an empty value.