Last updated
Last updated
Use Case: PartnerA (Sender) sends files to SFG via HTTP protocol (MFG) we do EOL conversion and deliver those files to the PartnerB (Receiver) via SFTP protocol from SFG using AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard PartnerA and PartnerB in SFG using AMF.
B. Create Message Type or use the existing one in AMF:
C. Create Message mapping with Sender, Receiver and Message Type with a file pattern.
D. Create EOL Conversion Action as Action type.
E. Create Deliver Action or use the predefined one (Deliver as is).
F. Create Workflow definition and add Actions (Created in step d and step e) as step1 and step2.
G. Create Workflow rule with Sender, Receiver, Message Type and Workflow definition name (Created in step f).
H. Onboard PartnerB SFTP profile in SFG using AMF (MFT Initiated communication profiles (outbound)).
I. Create communication rule with Sender, Receiver, Message Type and Comm profile Name.
J. Verify the Message activity in AMF once the PartnerA uploads the file to SFG via HTTP protocol (MFG). If everything was configured correctly, the file will be delivered to Partner B via SFTP protocol.
Process:
A. Onboard PartnerA and PartnerB in SFG via AMF:
Login to AMF
Go to On boarding -> Users
Click on + icon at the top right corner
Note: For convenience we will use the below users instead of PartnerA and PartnerB
PartnerA = Partner27
PartnerB = Partner28
Select Customer and give details of Partner27, select User Type, Authentication Type and click next.
User Type: Which Zone does the Partner belong to send or receive files? (DMZ or Trusted)
Authentication Type: Where 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.
OpenLdap: We need to select this if we selected the Authentication Type as LDAP in the step 4-ii.
Verify the Partner details and click Onboard User.
Repeat the same steps for PartnerB (Partner28).
B. Create Message Type or use the existing one in AMF:
Go to Message Types under On boarding
Click on + icon in the right corner to add a new message type
Note: In this scenario we will use the existing message type (GENERIC)
C. Create Message mapping with Sender, Receiver and Message Type with a file pattern:
Go to Message mapping under On boarding
Click on +icon at the top right corner
Select Sender, Receiver, and Message Type, give pattern of the files that Partner27 will send and clicks save.
D. Create EOL Conversion Action as Action type.
Go to Actions under On boarding-> Workflow
Click on + icon to create new action
Give Name, select EOL conversion as action type and clicks save.
E. Create Deliver as Action type or use the predefined one (Deliver as is)
Go to Actions under On boarding-> Workflow
Click on + icon to create new action
Give Name and select Deliver as action type and clicks save.
F. Create Workflow definition and add Actions (Created in step d and step e) as step1 and step2.
Go to Definitions under On boarding->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 EOL conversion action that we created in step g as step1 and click save.
Select the Deliver action that we created in step h as step2 and click save.
G. Create Workflow rule with Sender, Receiver, Message Type and Workflow definition Name (Created in step g).
Go to Rules under On boarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, Message Type, Workflow (Created in step h) and click on save
H. Onboard Partner28 SFTP in SFG using AMF (MFT Initiated communication profiles (outbound)).
Double click on the Partner28
Click on + icon in the top right corner
Give details of the SFTP outbound and click save
Remote Host: Remote Host/IP of the user SFTP server
Remote Port: Port of the user SFTP server
Remote User ID: Remote User ID of user in the 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 the step5
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: Recipients mail addresses if we enable Send Email Notifications.
Clean up on delivery: Option to clean the file system after the file was delivered (Once the file is cleaned, we cannot redeliver the file again)
I. 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, Comm profile name and click on save
J. Verify the Message activity in AMF once the PartnerA uploads the file to SFG via HTTP protocol (MFG). If everything was configured correctly, the file will be delivered to PartnerB via SFTP protocol.
Go to Message activity under Track N Trace
Here we can see the details for the file Delivered to the Partner28