Last updated
Last updated
Share point --> SFG --> AMF -->UFA
Use Case: We run Schedule to get files from PartnerA (Sender) folder to SFG via Share point protocol, We Unzip the file, Route with file name and Deliver those files to the PartnerB (Receiver) via HTTP (UFA) protocol using AMF.
Sequence Diagram:
Steps:
A. Onboard PartnerA in SFG and PartnerB using AMF.
B. Create PartnerA Share Point Receive 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. Install UFA agent (PartnerB)
G. Create PartnerB UFA Customer Initiated Download Profile.
H. Create Unzip Action as Action type.
I. Create Route Action with adding file name format.
J. Create Deliver Action or use the predefined one (Deliver As is)
K. Create Workflow Definition and add Actions (Created in step H, step I, step J) as step1, step2 and step3 respectively.
L. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step K).
M. Verify the Message Activity in AMF once the PartnerA uploads the file to SFG via Share Point Protocol. If everything was configured correctly, the file will be delivered to PartnerB via HTTP (UFA) Protocol using AMF.
Process:
A. Onboard PartnerA in SFG and PartnerB using 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 = Partner37
PartnerB = Partner38
Select Customer and give details of Partner37 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 providers 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 Partner38. Use AMF Provider for UFA User.
B. Create PartnerA Share point protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).
Double click on the Partner37
Click on + icon in the top right corner
Give details of the Share point MFT Initiated Download profile details and click save.
OAuth URL: URL to get the OAuth token
Grant Type: Grant type to get token
ClientID: Client ID of the user
ClientSecret: Secret of the user
ApplicationID: Application of the user share point where we get files
Resource ID: Resource ID of user share point
Share point Domain: SharePoint Domain of user
Site Name: Site name of the share point user
Sub Folder: Sub folder if any to get files
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 UserName: Proxy user name (If proxy was enabled)
Proxy Password: Proxy password (If proxy was enabled)
Regex: Regular expression to filter the files.
FilePattern: File pattern to filter the files
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 at top right corner
Select Delivery Type as Scheduled, Sender, Receiver, Message Type, Comm. Profile Name and click on save
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 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 Partner37 will send and clicks save.
F. Install UFA Agent (Partner B)
Please refer the UFA installation document for this step
G. Create Partner B UFA Profile in AMF (Customer Initiated Download Profile)
Double click on the Partner38
Click on + icon in the top right corner
Give the UFA details and clicks save.
Download Folder: Folder where the files will come from AMF.
Sender: Sender name who is sending files (Partner37 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner38 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 in file system 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.
H. Create Unzip Action as Action Type.
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Action Name, Action Type Unzip and clicks save.
I. Create Route Action with adding file name format
Go to Actions under Onboarding->Workflow
Click on + icon to create new action
Give Action Name, Action Type Route with adding file name format and clicks save.
J. 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 clicks save.
K. Create Workflow Definition and add Actions (Created in step H, step I, and step J) as step1, step2 and step3.
Go to Definitions under On boarding->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 Unzip Action that we created in step H as step1 and click save.
Select the Route Action with adding file name format that we created in step I as step2 and click save.
Select the Deliver Action that we created in step J as step3 and click save.
L. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step K).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, Message Type and Workflow (Created in step K) and click on save.
M. Verify the Message Activity in AMF once the Partner37(PartnerA) uploads the file to SFG via SharePoint Protocol. If everything was configured correctly, the file will be delivered to Partner 38(PartnerB) via S3 Protocol using AMF.
Go to Message Activity under Track N Trace
Here we can see the details for the file Delivered to the Partner38(PartnerB)
