UC21
Last updated
Last updated
S3-->SFG-->AMF -->UFA
Use Case: We run Schedule to get files from Partner41 (Sender) folder to SFG via S3 protocol, we GunZip the file and deliver those files to Partner42 (Receiver) using UFA (HTTP) via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard Partner41 in SFG using AMF and Partner42 in AMF.
B. Onboard Partner41 S3 Profile in SFG using AMF(MFT Initiated Communication Profile (Inbound).
C. Create Communication Rule with Sender, Receiver, Message Type and Comm. Profile Name. Select Delivery Type as Schedule.
D. Create Message Types or use the existing one in AMF.
E. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.
F. Create Gunzip Action or use the predefined one (Gunzip)
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. Onboard Partner42 UFA Profile in AMF (Customer Initiated Communication Profile (Inbound).
K. Verify the Message Activity in AMF once the Partner41 (S3) Schedule ran, check if we received files from Partner41 in AMF, they got processed and Delivered to Partner42 via UFA (HTTP)Protocol.
Process:
A. Onboard Partner41 in SFG using AMF and Partner42 in AMF:
Login to AMF
Go to Onboarding -> Users
Click on + icon at the top right corner
Select Customer and give details of Partner41, 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.
Open Ldap: We need to select this if we selected the Authentication Type as LDAP in the step 2.
Verify the Partner details and click Onboard User.
Repeat the above steps for Partner42. Use AMF Provider for UFA User.
Note: Install UFA agent for Partner42
Please refer the UFA installation document for this step
B. Onboard Partner41 S3 Protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).
Double click on the Partner41
Click on + icon in the top right corner
Give details of the S3 MFT Initiated Download Profile details and click save
Give details and click save
S3 bucket: S3 Bucket name
S3 Region: Region where S3 belongs
S3 Access Key ID: Access key ID of the S3 bucket
S3 Secret Key: Secret key of S3 bucket
Message to Process: Option to process the original or current message
Proxy Required: Option to open connections via proxy server
Proxy URL: Proxy server URL (If proxy was enabled)
Proxy User Name: Proxy user name (If proxy was enabled)
Proxy Password: Proxy password (If proxy was enabled)
Download Path: Path to get files
File Pattern: Pattern to filter the files
Options: Options to perform after file get
Once the onboarding was done, we can see the status.
C. Create Communication Rule with Sender, Receiver, Message Type and Comm. Profile Name. Select Delivery Type as Schedule.
Go to Rules under onboarding-> Communication
Click on + icon in the top right corner
Select Delivered Type Scheduled, Schedule Name, Sender, Receiver, Message Type, Comm. Profile Name and click on save.
D. 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
Note: In this scenario we will use the existing Message Type (GENERIC)
E. 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 Partner41 will send and Clicks save.
F. Create Gunzip Action or use the predefined one(Gunzip)
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Action Name, Action Type Gunzip and save
G. Create Deliver Action or use the predefined one (Deliver As Is)
Go to Actions under Onboarding->Workflow
Click on + icon to create New Action
Give Action Name, Action Type Deliver and save
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 as step1 and click save.
Select the Action that we created in step G as step2 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 corner.
Give Sender, Receiver, Message Type and Workflow (Created in step H) and click on save
J. Onboard Partner42 UFA Profile in AMF (Customer Initiated Communication Profile (Inbound)).
Double click on the Partner42
Click on + icon in the top right corner
Give details of the UFA Profile and click save
Give details and click save
Download Folder: Folder where the files will come from AMF.
Sender: Sender name who is sending files
Receiver: Receiver name to whom we are delivering files via AMF
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 file in file system after successful delivery
Clean Large Files: Option to clean only large file that meets the threshold given
Once the onboarding was done, we can see the status
K. Verify the Message Activity in AMF once the Partner41 Schedule ran, check if we received files from Partner41 in AMF, they got processed and Delivered to Partner42 via UFA (HTTP)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 Partner42