Last updated
Last updated
Use Case: We run Schedule to get files from PartnerA (Sender) folder to SFG via Azure Blob protocol, We GunZip and Deliver those files to the PartnerB (Receiver) via HTTP Protocol (UFA) using AMF. AMF will get files from PartnerA.
Sequence Diagram:
Steps:
A. Onboard Partner A in SFG Partner B in AMF.
B. Install UFA agent (Partner B).
C. Onboard Partner A MFT Initiated Receive profile.
D. Create Message Type or use the existing one in AMF.
E. Create Comm Rule with Sender, Receiver, Message Type and Comm Profile Name select Delivery Type as Schedule.
F. Onboard Partner B Customer Initiated Receive profile.
G. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.
H. Create Gun Zip as Action Type.
I. Create Delivery Action and in the file name format give the required name (with file format no extension).
J. Create Workflow Definition and add Actions (Created in step H and step I) as step1 and step2.
K. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step J).
L. Verify the Message Activity in AMF once the Partner A (Azure Blob) Schedule ran, Check if we received files from Partner A in AMF, they got processed and delivered to Partner B via HTTP (UFA)Protocol.
Process:
A. Onboard Partner A in SFG Partner B in using AMF.
Login to AMF
Go to Onboarding
Click on + icon at the top right corner
Note: For convenience we will use the below users instead of PartnerA and PartnerB
Partner A = Partner29
Partner B = Partner30
Select Customer and give details of Partner A, select User Type, and 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.
Select IBM Provider for Partner A which use Azure Blob protocol.(Partner29).
Select AMF Provider for Partner B which uses UFA protocol (Partner30).
Verify the Partner details and click Onboard User.
B. Install UFA agent (PartnerB).
Please refer the UFA installation document for this step.
C. Onboard PartnerA MFT Initiated Receive profile.
Double click on Partner29
Click on + icon at the top right corner
Select the protocol as Azure Blob, MFT Initiated download, give the remaining details and click save.
Give details and click save:
Access Token Url: Using the Url property of the client object.
SAS Token Url: URL to get the SAS token.
Download Url: A hyperlink that points to a location within the Internet where the user can download a file.
File Pattern: Pattern to filter the files.
Archive Path: The given archive file should be one of .zip, .tar, .tar. gz, .tgz and .jar. To list the archive files that have been added, use LIST ARCHIVE.
Error Path: Error where users are putting in the wrong path or name on the command line.
File Format: The extension is separated by a period from the name and contains three or four letters that identify the format.
Token Details: A token is an object that represents something else, such as another object.
Container: A container organizes a set of blobs, similar to a directory in a file system
Download Folder: Folder to download files.
Proxy Required: Option to open connections via proxy server.
Proxy URL: Proxy server URL (If proxy was enabled)
Proxy Username: Proxy username (If proxy was enabled)
Proxy Password: Proxy password (If proxy was enabled)
D. 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)
E. Create Comm Rule with Sender, Receiver, Message Type and Comm Profile Name, Select delivery type as Schedule.
Go to Rules under Onboarding->Communications
Click on + icon at the top right corner.
Select the Deliver Type as Scheduled and Select Sender, Receiver, Message Type, Comm profile name and click on save.
F. Onboard PartnerB Customer Initiated Receive profile.
Double click on Partner30.
Click on + icon at right corner.
Select the protocol as UFA, Customer Initiated Download, give the remaining Details 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 (Partner29 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner30 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 Task 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 upon Delivery: Option to clean the files from file system after successful deliver.
Clean Large Files: Option to clean only large file that meets the threshold given.
Validate MD5 Check Sum: Option to validate the MD5 Checksum on uploaded files.
Once the onboarding was done, we can see the status as completed.
G. 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 Partner29 will send and click on save
H. Create Gun Zip as Action Type.
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Name, select Gun Zip as Action Type.
I. Create Delivery Action and in the file name format give the required Name (With file format no extension).
Go to Actions under Onboarding->Workflow
Click on + icon to create new Action
Give Name, select Deliver as Action Type and in the file name format give the required name (with file format no extension).
J. Create Workflow Definition and add Actions (Created in step H and step I) as step 1 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 H as step1 and click save.
Select the action that we created in step I as step2 and click save
K. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step J).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right corner
Give Sender, Receiver, Message Type and Workflow (Created in step J) and click on
Save
L. Verify the Message Activity in AMF once the Partner A (Partner29) Schedule ran, check if we received files from Partner A in AMF, they got processed and delivered to Partner B (Partner30) via UFA 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 Partner30