Last updated
Last updated
Use Case: PartnerA (Sender) send files to AMF (Agile Messaging Framework), we update the file name and then deliver those files to the PartnerB (Receiver) via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard PartnerA and PartnerB in AMF.
B. Install UFA agents in both sides (PartnerA and PartnerB).
C. Create Message Types or use the existing one in AMF.
D. Onboard PartnerA customer Initiated Upload profile.
E. Onboard PartnerB customer Initiated Download profile.
F. Create Route Action with adding file name format.
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 the PartnerA uploads the file to SFG via UFA protocol. If everything was configured correctly, the file will be delivered to PartnerB via UFA protocol.
Process:
A. Onboard PartnerA 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 = Partner17
PartnerB = Partner18
Select Customer and give details of PartnerA(Partner17), 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’s 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.
OpenLdap: 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 (Partner18)
B. Install UFA agents in both sides (Partner17 and Partner18).
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 Types
Note: In this scenario we will use the existing message type (GENERIC)
D. Onboard PartnerA(Partner17) customer Initiated Upload profile:
Double click on Partner17
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 (Partner17 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner18 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 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.
E. Onboard PartnerB(Partner18) Customer Initiated Download Profile:
Double click on Partner18
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 (Partner17 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner18 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.
Clean up 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.
F. 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 name (${fname}_${datetime})
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 step F, step1 and click save.
Select the Action that we created in step G, 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.
Give Sender, Receiver, Message Type and Workflow (Created in step H) and click on save.
J. Verify the Message activity in AMF once PartnerA(Partner17) uploads the files to the upload folder. If everything was configured correctly, the file will be delivered to PartnerB(Partner18).
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 Partner18
