Last updated
Last updated
Use Case: PartnerA (Sender) send files to AMF and delivers those files to PartnerB MQ (Receiver) via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard Partner A and Partner B in AMF.
B. Install UFA Agent Partner A
C. Create Message Type or use the existing one in AMF.
D. Onboard Partner A Customer Initiated Upload profile.
E. Create Deliver MQ Action as Action Type
F. Create Workflow Definition and add Actions (Created in step E) as step1.
G. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step F).
H. Verify the Message Activity in AMF once Partner A uploads the file to SFG via UFA protocol. If everything was configured correctly, the file will be delivered to MQ via AMF.
Process:
A. Onboard Partner A and Partner B 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 Partner A and Partner B
Partner A = Partner19
Partner B = Partner20
Select Customer and give details of Partner A, 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 belong 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 Partner B (Partner20). Using AMF for UFA User
B. Install UFA agent Partner A.
Please refer the UFA installation document for this step
C. 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)
D. Onboard Partner A(Partner19) Customer Initiated Upload Profile:
Double click on Partner19
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 (Partner19 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner20 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 step7.
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 MD5 Checksum on uploaded files.
E. Create Deliver MQ Action as an Action Type
Go to Actions under Onboarding-> Workflow
Click on + icon to create new action
Give Name, Select Deliver MQ as Action type
F. Create Workflow Definition and add Actions (Created in step E) as step1.
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 E as step1 and click Save
G. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition name (Created in step F).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, Message Type and Workflow (Created in step F) and click on Save
H. Verify the Message activity in AMF once Partner A uploaded the files to his upload folder. If everything was configured correctly, the file will be delivered to MQ via AMF
Go to Message Activity under Track N Trace
To see more details double click on the record.
Here we can see the details of the file delivered to MQ (Partner20).
