Last updated
Last updated
Use Case: Partner A (Sender) sends files to AMF we encrypt the file and then deliver those files to Partner B (Receiver) using SFTP protocol from SFG via AMF. (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard Partner A in AMF and Partner B in SFG via AMF.
B. Install UFA agent (PartnerA).
C. Create Message Type or use the existing one in AMF.
D. Onboard PartnerA Customer Initiated Upload profile.
E. Onboard Partner B SFTP MFT Initiated Send profile.
F. Create Open PGP Encrypt as Action Type.
G. Create Delivery Action or use the predefined one (Deliver as is).
H. Create Workflow definition and add Actions (Created in step f and step g) as step1 and step2.
I. Create Workflow rule with Sender, Receiver, Message Type and Workflow definition name (Created in step h).
J. Verify the Message activity in AMF once Partner A uploads the file to AMF via UFA. If everything is configured correctly, the file will be delivered to Partner B via SFTP protocol.
Process:
A. Onboard Partner A in AMF 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 = Partner21
Partner B = Partner22
Select Customer and give details of PartnerA(Partner21), 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 4-ii.
Select AMF Provider for Partner A (Partner21) which uses UFA protocol.
Select IBM Provider for Partner B (Partner22) which uses SFTP protocol.
Verify the Partner details and click Onboard User.
B. Install UFA agent (PartnerA).
Please refer to the UFA installation document for this step.
C. Create Message Type 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
Note: In this scenario we will use the existing message type (GENERIC)
D. Onboard PartnerA(Partner21) Customer Initiated Upload profile.
Double click on Partner21
Click on + icon at the top right corner
Select the protocol as UFA, operation as Upload, give the remaining details
and click save.
Upload Folder: Folder where the files will be placed to deliver to AMF.
File Pattern: File pattern to filter the files.
Sender: Sender name who is sending files (Partner21 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner22 in this case).
Message Type: Message type we used in this case (GENERIC)
Polling Interval: The polling interval between the sync i.e., UFA agent and the server.
Archive Flag: Option to enable or disable the archives.
Archive Folder: Folder to archive the files if we enabled step vii
Run Script Before Upload: Script name with path if we want to run any scripts before the file upload.
Chunk Size: Size of the files that will be transferred in bits when there is a large file transfer
Pgp Encrypt: Option to encrypt the uploaded file.
Validate MD5 Check Sum: Option to validate the MD5 Checksum on uploaded files.
Once the onboarding is done, we can see the status as completed.
E. Onboard Partner B(Partner22) SFTP MFT Initiated Send profile.
Double click on Partner22.
Click on + icon at the top right corner.
Select MFT initiated upload profile and give the remaining details
(SFTP Protocol) and click save.
Remote Host: Remote Host/IP of Partner22 SFTP server
Remote Port: Port of Partner22 SFTP server
Remote User ID: Remote User ID in Partner22 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
Receivers 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 is delivered (Once the file was cleaned, we cannot redeliver the file again).
F. Create Open Pgp Encrypt as Action Type
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Name, select Open PGP Encrypt as action type and Select Public Key
and click save.
G. 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 steps f and g as steps 1 &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, Workflow (Created in step h) and
click on save
J. Verify the Message activity in AMF once Partner21 uploads file to
AMF via UFA. If everything is configured correctly, the file will be
delivered to Partner22 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 Partner22.
