Last updated
Last updated
Use Case: PartnerA (Sender) send files to SFG via SFTP protocol, We Zip and Deliver those files to the PartnerB (Receiver) via UFA protocol using AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard PartnerA in SFG using AMF and PartnerB in AMF.
B. Onboard PartnerA SFTP Customer Initiated Communication Profiles (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. Install UFA agent (PartnerB)
F. Onboard PartnerB Customer Initiated Download Profile.
G. Create Zip Action as Action type.
H. Create Deliver Action or Use the predefined one (Deliver As is).
I. Create Workflow Definition and add Actions (Created in step G and step H) as step1 and step2.
J. Create Workflow Rule with Sender, Receiver, MessageType and Workflow Definition Name (Created in step I).
K. Verify the Message Activity in AMF once the PartnerA uploads the file to SFG via SFTP protocol. If everything was configured correctly, the file will be delivered to PartnerB via UFA protocol.
Process:
A. Onboard PartnerA in SFG using AMF and PartnerB in 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 = Partner15
PartnerB = Partner16
Select Customer and give details of partnerA, select UserType, AuthenticationType and click next.
UserType: Which Zone does the partner belong 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 same steps for partnerB (Partner16). Using AMF Provider for UFA user.
B. Onboard PartnerA SFTP Customer Initiated Communication profiles (Inbound).
Double click on Partner15
Click on + icon at the top right corner
Select the protocol as SFTP Inbound and click save.
Once the on boarding was done, we can see the status as completed.
C. Create MessageTypes or use the existing one in AMF:
Go to MessageTypes under Onboarding
Click on + icon in the right corner to add a new Message Types
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 Partner15 will send and click save.
E. Install UFA agent (Partner B).
Please refer the UFA installation document for this step
F. Onboard PartnerB Customer Initiated Download profile:
Double click on Partner16
Click on + icon at the top right corner
Select the protocol as UFA, Operation as download, give the remaining details and click save.
Download Folder: Folder where the files will come from AMF.
Sender: Sender name who is sending files (Partner15 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner16 in this case).
Message Type: Message type we used in this case (GENERIC)
Polling Interval: The polling interval between the sync between UFA agent and server.
Run Script After Download: Script name with path if we want to run any scripts after the file was downloaded.
Chunk Size: Size of the files that will be transferred in bits when there is a large file transfer
PGP Decrypt: Option to decrypt the downloaded file.
Cleanup on delivery: Option to clean the files from filesystem after successful delivery
Clean Large Files: Option to clean only large file that meets the threshold given (Sample shown below).
Validate MD5 Check Sum: Option to validate the MD5 Checksum on uploaded files.
G. Create ZIP Action as Action type
Go to Actions under Onboarding-> Workflow
Click on + icon to create new action
Give Action Name, select ZIP as Action type.
H. Create Deliver 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)
I. Create Workflow Definition and add Actions (Created in step G and step H) as step1
and step2
Go to Definitions under onboarding-> Workflow
Click on + icon at the top right corner.
Give Workflow Name, Description and clicks save.
Double click on the Workflow Definition Name.
Click on the + icon at the top right corner.
Select the zip action that we created in step G as step1 and click save.
Select the Deliver As Is that we created in step H as step2 and click save.
J. Create Workflow Rule with Sender, Receiver, MessageType and Workflow Definition Name (Created in step I).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, MessageType and Workflow (Created in step I) and click on save
K. Verify the Message activity in AMF once Partner A (Partner15) uploaded the files to SFG via SFTP protocol. If everything is configured correctly, the file will be delivered to Partner B (Partner16) via UFA protocol.
Go to Message activity under Track N Trace
Here we can see the file delivered to the Partner16
