Last updated
Last updated
Use Case: Partner A (Sender) send files to SFG via SFTP protocol, we Zip and deliver those files to Partner B (Receiver) using SFTP protocol from SFG via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard Partner A and Partner B in SFG using AMF.
B. Onboard Partner A SFTP profile in SFG using AMF (Customer Initiated Communication Profile (Inbound)).
C. Create Message Types or use the existing one in AMF.
D. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.
E. Create a Zip Action as Action Type.
F. Create Delivery Action or use the predefined one (Deliver as is).
G. Create Workflow Definition and add Actions (Created in step E and step F) as step1.and step2.
H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow definition name (Created in step G).
I. Onboard Partner B SFTP profile in SFG Using (MFT Initiated Communication profile) (outbound)).
J. Create Communication Rule with Sender, Receiver, Message Type and Comm. profile Name.
K. Verify the Message Activity in AMF once Partner A uploads the file to SFG via SFTP protocol, if everything was configured correctly, the file will be delivered to Partner B via SFTP protocol.
Process:
A. Onboard Partner A and Partner B in SFG via AMF:
Login to AMF
Go to Onboarding -> Users
Click on + icon at the top right corner.
Note: For convenience we will use the below users instead of Partner A and Partner B
Partner A = Partner09
Partner B = Partner10
Select Customer and give details of Partner09, select User Type, Authentication Type and click next.
User Type: Which Zone does the Partner belongs to send or receive files? (DMZ or Trusted)
Authentication Type: Where do we store the Partner credentials? (LDAP or local (SFG/AMF) or Both)
Select the provider the Partner belongs to and click next
AMF: AMF provider is used to onboard Partners which use UFA
IBM: This will come from the provider's config. We can choose several types based on the provider's config.
Open LDAP: We need to select this if we selected the Authentication Type as LDAP in step2
Verify the Partner details and click Onboard User.
B. Onboard Partner A(Partner09) SFTP profile in SFG using AMF (Customer Initiated Communication profile (Inbound)).
Double click on the Partner 09
Click on + icon in the top right corner.
Give details of the Profile and click save.
Once the onboarding is done, we can see the status as completed.
C. Create Message Types or Use the existing one in AMF:
Go to Message Types under Onboarding
Click on + icon in the right corner to add a new Message Type
In this scenario we will use the Message Type SFTP_UC05_SFTP and click Save.
D. Create Message Mapping with Sender, Receiver and Message Type with a file pattern
Go to Message Mapping under Onboarding
Click on +icon at the top right corner
Select Sender, Receiver and Message Type give pattern of the files that Partner09 will send and click save.
E. Create a Zip Action as Action Type.
Go to Actions under Onboarding->Workflow.
Click on + icon to create new action.
Create a Zip Action as Action Type and click save
F . Create Delivery Action Deliver as is
Go to Actions under Onboarding->Workflow
Click on + icon to create new action.
Create a Deliver As is Action as Action Type.
G. Create Workflow Definition and add Actions (Created in step E and step F).
Go to Definitions under Onboarding->Workflow.
Click on + icon at the top right corner.
Give Workflow Name, Description and click save.
Double click on the Workflow Definition Name
Click on the + icon at the top right corner.
Select the action that we created in Step E as step1 and click save.
Select the action that we created in Step F as step2 and click save.
H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step G).
Go to Rules under Onboarding -> Workflow.
Click on + icon at the top right
Give Sender, Receiver, Message Type and Workflow (Created in step G) and click on save.
I. Onboard Partner B(Partner10) SFTP profile in SFG Using (MFT Initiated Communication Profile (outbound)).
Double click on Partner10 in Onboarding-> users
Click on + icon at the top right.
Select MFT initiated Send and give the details (SFTP Protocol)
Remote Host: Remote Host/IP of Partner10 SFTP server
Remote Port: Port of Partner10 SFTP server
Remote User ID: Remote User ID of Partner10 SFTP server
Auth Type: Auth type supported by Remote SFTP server (password or key)
Use Source File Name: Option to use source filename.
Remote File Name: Remote file name if you disabled the Use Source File Name in step 3-v
Remote Path: Path for the file to be placed.
Use Temp File Name in Copy: Option to use temp file name in copy.
Remote KHK (Known Host Key): Known host key of Remote SFTP server.
Send Email Notifications: Option to send email notifications for successful delivery.
Receiver’s Mail Ids: Recipient’s mail addresses if we enable Send Email Notifications.
Clean up on delivery: Option to clean the file in file system after the file was delivered (Once the file is cleaned, we cannot redeliver the file again).
J. Create Communication Rule with Sender, Receiver, Message Type and Comm Profile Name
Go to rules under onboarding->Communication.
Click on + icon at top right corner
Select Sender, Receiver ,Message Type and Comm Profile name and click on save.
K. Verify the Message activity in AMF once Partner A(Partner09) uploads the file to SFG via SFTP protocol and if everything was configured correctly, the file will be delivered to Partner B(Partner10) via SFTP protocol.
Go to Message activity under Track N Trace
To see more details of the delivery double. click on the record.
Here we can see the details for the file delivered to Partner10.
