Last updated
Last updated
CD --> SFG --> AMF --> SFG --> SFTP
Use Case: PartnerA (Sender) send files to SFG via CD protocol, we change the file name and deliver those files to the PartnerB (Receiver) using SFTP protocol from SFG via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard PartnerA and PartnerB in SFG using AMF.
B. Onboard PartnerA connect direct node in SFG using AMF (CD Customer Initiated Communication Profile (Inbound)).
C. Create Message Type or use the existing one in AMF.
D. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.
E. Create Route Action with file name format.
F. Create Delivery Action or use the predefined one (Deliver as is).
G. Create Workflow Definition and add Actions (Created in step F and step G) as step1 and step2.
H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step H).
I. Create MFT Initiated Send Communication Profile for outbound delivery in PartnerB with SFTP protocol.
J. Create Communication Rule with Sender, Receiver, Message Type and Comm Profile Name.
K. Verify the Message activity in AMF once the PartnerA uploads the file to SFG via CD protocol. 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 Onboarding -> Users.
Click on + icon at the top right corner
Note: For convenience we will use the below users instead of partnerA and partnerB
partnerA = Partner03
partnerB = Partner04
Select Customer and give details of Partner03, 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 step 2
Verify the Partner details and click Onboard User.
Repeat the above steps for Partner04.
B. Onboard PartnerA(Partner03) connect direct node in SFG using AMF (Customer Initiated communication profile (Inbound)).
Double click on the Partner03
Click on + icon in the top right corner
Give details of the Node and click save
Operating System: Operating system of the Partner03
SPOE: Option to enable/disable Secure point of entry
Node Name: Node name of Parnter03
Host Name/IP: Host/Ip of the Partner03 CD node
Port: Port of the Partner03 CD node
Alternate Ips: we can give there are any alternate IPs for this CD node
Secure+: Option to enable/disable secure+ for SSL
Cert File: Public cert of the Partner03 CD node (In txt format with no headers)
Common Name: Common name of the Partner03 CD certificate
TLS Version: TLS version to be used in the communication
Ciphers: Ciphers to be used in the communication.
Once the onboarding was done, we can see the status as completed.
C. Create Message Type or use the existing one in AMF:
Go to Message Type under Onboarding
Click on + icon in the right corner to add a new Message Type
Give a proper name to Message Type and Description and then click save
Note: In this scenario we will use the existing Message Type (GENERIC)
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 Partner03 will send and click save.
E. Create Route Action with adding file name format.
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Name, select Route as Action Type, and in the file name format give the required file name format using tokens
F. Create Delivery Action or use the predefined one (Deliver as is):
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Note: In this scenario we will use the existing Action (Deliver as is)
H. Create Workflow Definition and add Actions (Created in step F and step G) as step1 and step2.
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 F step1 and click save.
Select the action that we created in step G step 2 and click save.
I. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step H).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, Message Type and Workflow (Created in step H) and click on save
J. Create MFT Initiated Send Communication Profile for outbound delivery in PartnerB(Partner04) with SFTP protocol.
Double click on Partner04 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 the Partner04 SFTP server
Remote Port: Port of the Partner04 SFTP server
Remote User ID: Remote User ID of Partner04 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 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: Recipients 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)
K. 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.
L. Verify the Message activity in AMF, once partnerA(Partner03) uploads the file to SFG via CD protocol and if everything was configured correctly, the file will be Delivered to partnerB(Partner04) 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 the Partner04