Last updated
Last updated
Use Case: We run Schedule to get files from PartnerA (Sender) folder to SFG via Share Point Protocol, we Unzip the file and Deliver those files to the PartnerB (Receiver) using S3 protocol via AMF.
Sequence Diagram:
Steps:
A. Onboard Partner A and Partner B in SFG using AMF.
B. Onboard Partner A 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. Create Unzip Action as Action Type.
G. Create Deliver 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 Partner B S3 Profile in AMF (MFT Initiated Communication Profile (Outbound)).
K. Create Communication Rule with Sender, Receiver, Message Type and Comm Profile Name.
L. Verify the Message Activity in AMF once the Partner A uploads the file to SFG via Share point protocol. If everything was configured correctly, the file will be delivered to Partner B via S3 protocol using AMF.
Process:
A. Onboard Partner A and Partner B in SFG via 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 = Partner35
PartnerB = Partner36
Select Customer and give details of Partner35, 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 Partner36.
B. Onboard Partner A Share Point Protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).
Double click on the Partner35
Click on + icon in the top right corner
Give details of the Share point MFT Download Profile details and click save.
Give details and click save
OAuth URL: URL to get the OAuth token
Grant Type: Grant type to get token
Client ID: Client ID of the user
Client Secret: Secret of the user
Application ID: 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 User Name: Proxy user name (If proxy was enabled)
Proxy Password: Proxy password (If proxy was enabled)
Regex: Regular expression to filter the files.
File Pattern: File pattern to filter the files
Once the on boarding 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 and 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 Partner35 will send and clicks save.
F. 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.
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 clicks save
H. Create Workflow Definition and add Actions (Created in step F and step G) as step1 and step2.
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 F as step1 and click save.
Select the Deliver 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
Give Sender, Receiver, Message Type and Workflow (Created in step H) and click on save.
J. Onboard PartnerB S3 Profile in AMF (Customer Initiated Communication Profile (Outbound)).
Double click on the Partner36
Click on + icon in the top right corner
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)
Upload Path: Path to upload files
Cleanup on Delivery: Option to clean the file in file system after the file was delivered (Once the file is cleaned, we cannot redeliver the file again)
K. Create Communication Rule with Sender, Receiver, Message Type and Comm Profile Name.
Go to Rules under onboarding->Communication
Click on + icon at top right corner
Select Sender, Receiver, Message Type and Comm. Profile name and click on save.
L. Verify the Message Activity in AMF once the Partner35(PartnerA) uploads the file to SFG via Share point Protocol. If everything was configured correctly, the file will be delivered to Partner36(PartnerB) via S3 Protocol using AMF.
Go to Message Activity under Track N Trace
Here we can see the file Delivered to the Partner36(PartnerB)
