Partner Channel Templates

A PartnerChannelTemplate defines reusable Partner Channel configuration that can be applied to Partners.

Route path patterns can be fixed paths shared by all assigned Partners, or include {{partner_name}} to expand to a single folder name. Slashes in Partner names become pipes (|). Leading and trailing whitespace, percent signs, and null bytes are percent-encoded. Names consisting of . or .. become %2E or %2E%2E. For example, a Partner named "Acme " uses the folder "Acme%20", while "Acme%20" uses "Acme%2520". These percent sequences are literal folder-name characters, not URL encoding to decode. The expanded route must point to an existing folder in the same Workspace.

Resource Schema

Required

Property	Description
name String	The name of the Partner Channel Template.
path String	Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

Optional

Property	Description
workspace_id Int64	ID of the Workspace associated with this Partner Channel Template.
direction String	Channel directions. `two_way` enables both directions, `to_partner` enables outgoing downloads, and `from_partner` enables incoming uploads. Possible values: `two_way`, `to_partner`, `from_partner`
use_channel_root Bool	Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
to_partner_folder_name String	Optional Channel-level to-Partner folder name override.
from_partner_folder_name String	Optional Channel-level from-Partner folder name override.
from_partner_route_path_pattern String	Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_route_path_pattern String	Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
to_partner_managed_folder_paths List	Managed folder paths inside the to-Partner folder.
from_partner_managed_folder_paths List	Managed folder paths inside the from-Partner folder.

Read Only

Property	Description
id Int64	The unique ID of the Partner Channel Template.
effective_to_partner_folder_name String	Resolved to-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.
effective_from_partner_folder_name String	Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

Example Resource

resource "files_partner_channel_template" "example_partner_channel_template" {
  direction                         = "two_way"
  use_channel_root                  = false
  from_partner_folder_name          = "incoming"
  from_partner_managed_folder_paths = ["claims/received"]
  from_partner_route_path_pattern   = "processing/{{partner_name}}/from-partner"
  to_partner_folder_name            = "outgoing"
  to_partner_managed_folder_paths   = ["reports/monthly"]
  to_partner_route_path_pattern     = "delivery/{{partner_name}}/to-partner"
  name                              = "Claims Template"
  path                              = "claims/medical"
  workspace_id                      = 0
}

Resource Import

This Resource supports importing using the following syntax:

Example Import Command

# Partner Channel Templates can be imported by specifying the id.
terraform import files_partner_channel_template.example_partner_channel_template 1

Data Source Schema

Required

Property	Description
id Int64	The unique ID of the Partner Channel Template.

Read Only

Property	Description
workspace_id Int64	ID of the Workspace associated with this Partner Channel Template.
direction String	Channel directions. `two_way` enables both directions, `to_partner` enables outgoing downloads, and `from_partner` enables incoming uploads. Possible values: `two_way`, `to_partner`, `from_partner`
use_channel_root Bool	Use the Channel folder directly for a one-way exchange. Defaults to false. Cannot be changed after creation. Folder name overrides must be blank when enabled, and the Template must remain one-way.
name String	The name of the Partner Channel Template.
path String	Channel path relative to the Partner root folder. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
to_partner_folder_name String	Optional Channel-level to-Partner folder name override.
from_partner_folder_name String	Optional Channel-level from-Partner folder name override.
from_partner_route_path_pattern String	Optional route path pattern for files uploaded by the Partner. Supports {{partner_name}}.
to_partner_route_path_pattern String	Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
to_partner_managed_folder_paths List	Managed folder paths inside the to-Partner folder.
from_partner_managed_folder_paths List	Managed folder paths inside the from-Partner folder.
effective_to_partner_folder_name String	Resolved to-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.
effective_from_partner_folder_name String	Resolved from-Partner subfolder name. Null when the direction is disabled or uses the Channel folder directly.

Example Data Source

data "files_partner_channel_template" "example_partner_channel_template" {
  id = 1
}