You can configure an exchange profile to receive files that are sent from a trading partner with SFTP. Use Exchange Profiles to create and configure a new secure inbound one-way push exchange pattern.
About this task
When you are creating an exchange profile, you can still navigate to other pages or tabs of the user interface if required. Any information that is entered in the exchange profile configuration is automatically saved and can be completed and deployed later. A progress bar on the Exchange
Profiles collection page indicates the percentage of completion of the
exchange profile. A percentage of 20 is allocated to each of the following sections of the exchange profile:
- Exchange Identification
- Participating Organizations
- Trigger
- Action
- Deploy Exchange Profile
When all components are configured, the progress bar displays 100%, indicating that the exchange profile configuration is complete and the exchange profile is deployed.
Procedure
To create an SFTP inbound one-way push exchange profile:
- Log in to B2B Advanced Communications as a user with the permissions to configure an SFTP exchange profile.
- Click .
- On the Exchange Profiles page, click .
-
On the New Exchange Profile page, specify values for the applicable fields as follows and click Save:
- Profile name
Enter a unique name for the new SFTP exchange profile.
- Exchange pattern
Select Inbound One-Way/Push message exchange pattern.
-
Click Edit corresponding to the Basic Properties section, specify values for the following fields, and click Save:
- Name
The unique name of the exchange profile that you entered in the Profile name field on the New Exchange Profile window is populated here.
- Description
Optional: Enter a description for the exchange profile.
-
Click Participating Organizations to specify the participating organizations:
- Owner Organization
Click Select to select the owner organization. You can filter owning organizations by name or select an existing Organization from the menu. Click New Organization to define a new owner organization. In an inbound one-way push exchange profile, the owner organization is the receiver in the exchange.
- Owner Organization Role
The owner organization role is selected by default and is dependent upon the type of exchange pattern. The role cannot be customized. In an inbound one-way push exchange profile, the owner organization is always a receiver role.
- Receiver ID
Click New to enter a unique receiver ID. The receiver ID is the unique business identifier that is used to identify the owner organization. The receiver ID can be mutually agreed on by both parties or can be assigned by an international code designator, such as a DUNS ID.
- Trading Partner Organization
Click Select to select the trading partner organization. You can filter trading partner organizations by name or select an existing Organization from the menu. Click New Organization to define a new trading partner organization. In an inbound one-way push exchange profile, the trading partner organization is the sender in the exchange.
- Trading Partner Organization Role
The trading partner organization role is selected by default and is dependent upon the type of exchange pattern. The role cannot be customized. In an inbound one-way push exchange profile, the trading partner organization is always a sender role.
- Sender ID
Click New to enter a unique sender ID. The sender ID is the unique business identifier that is used to identify the trading partner. The sender ID can be mutually agreed on by both parties or can be assigned by an international code designator, such as a DUNS ID.
-
Specify Click Trigger: Receive files from Trading Partners to specify the Connection Settings for the exchange:
- Select Receiver
Click Select to select the SFTP receiver that is to be used in the exchange. An SFTP receiver is required for an SFTP inbound one-way push exchange. You can filter applicable existing Receivers by name or select an existing Receiver from the menu. Click New Receiver to create a new SFTP receiver.
- Path
Select a path to a directory in the file system to receive the transferred files. You can select
commonly used paths in other exchanges that are associated with the receiver you selected for the
exchange. You can also specify a new path with Specify Path.
- Configure security
Click Configure to configure security settings for the exchange profile:
- Basic user authentication
-
SFTP user credentials require authentication.
Click Select to select the user credentials for authentication. You can filter applicable user credentials by name or select an existing user from the menu. Click Add Credential to add credentials for a new user.
- Associated Keys
-
Click Associate New Key to add a new public key. You
might want to associate a public key with your user credentials to enable public-key cryptography to
further secure communications. If the server associated with the receiver selected for the exchange
profile requires at least SSH key authentication, you must select a public key to associate with
your user credentials.
Click Select to select an OpenSSH formatted public
key to associate with your user credentials. You can filter applicable public keys by name or select
an existing public key from the menu. Click Add Public Key to upload a new
public key.
- Override Data Threshold
Optional: Select Override Data Threshold to change the value of the data
threshold.
If the data in a document exceeds the size that is defined in the threshold, the data continues through the exchange out-of-line. In place of the data, a reference to where the data is persisted to the storage component, a storage blob ID, is included in the document instead. Overriding the data threshold can help increase performance with certain data set sizes and system configurations.
If you selected Override Data Threshold, you must enter a value for Data Threshold. The default value for Data Threshold is 4096 bytes. If the size of the data is less than 4096 bytes, the data is written inline. If the size of the data is greater than 4096 bytes, the data continues through the exchange out-of-line.
-
Click Action: Deliver Message Data to specify the Action Settings for the exchange:
Important:
If you specified an SFTP server that uses a Sterling File Gateway virtual file system in the
Trigger: Receive Data from Trading Partners section, the Action: Deliver Message Data section will
indicate Deliver to Sterling File Gateway and the section is marked as
completed (no configuration required).
- Action Type
-
Click Change to select the file destination. An action type is not
required for an SFTP inbound one-way push exchange. If No Action (destination) is
selected, the transaction is completed when the file reaches the file system. The file remains on
the file system until it is moved to a destination with a process external to B2B Advanced Communications. You can also select another
action type to complete the transaction at another destination. You can filter applicable existing
action types by name or select an existing action type from the menu.
You can also select a Sterling File Gateway trigger as the file destination, which
allows you to integrate directly with existing File Gateway processes. SFTP inbound push exchange
profiles that have a Sterling File Gateway-based trigger do not require a user-configured action to
push a file that is received from SFTP to a File Gateway Mailbox.
-
Click Deploy Exchange Profile section to complete and deploy your exchange profile configuration. Click Deploy to deploy or enable the exchange profile.
Tip: If the exchange profile configuration is incomplete, a list of incomplete or unconfigured items is displayed in the Deploy Exchange Profile section. The Deploy button is enabled only when all the sections of the exchange profile have Complete status.
What to do next
You can manage files that you receive if you use an SFTP client to access files that are stored on the configured SFTP server that is used in the exchange. For more information about managing files that are stored on an SFTP server, see ../com.ibm.help.meg.administering.doc/b2bac_administering_manageSFTPfiles.html.