Last updated
Last updated
Use Case: PartnerA (Sender) send files to SFG via CD protocol, we deliver those files to PartnerB (Receiver) using CD protocol from SFG via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard PartnerA and PartnerB in SFG using AMF.
B. Onboard PartnerA and PartnerB connect direct nodes in SFG using AMF (CD Customer Initiated communication profile (Inbound)).
C. Create Message Type or use the existing one in AMF.
D. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.
E. Create Delivery Action or use the predefined one (Deliver as is).
F. Create Workflow Definition and add Action (Created in step E) as step1.
G. Create Workflow Rule with Sender, Receiver, MessageType and Workflow definition name (Created in step F).
H. Create MFT Initiated CD Communication Profile for outbound delivery.
I. Create Communication Rules with Sender, Receiver, MessageType and Comm profile Name.
J. Verify the Message Activity in AMF once the partnerA uploads the file to SFG via CD protocol. If everything was configured correctly, the file will be delivered to partnerB via CD protocol.
Process:
A. Onboard partnerA and partnerB in SFG via AMF:
Login to AMF
Go to Onboarding -> Users
Click on + icon at the top right corner
Select Customer and give details of partnerA, select UserType, AuthenticationType and click next.
UserType: Which Zone does the partner belongs to send or receive files? (DMZ or trusted)
AuthenticationType: Where do 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.
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 above steps to onboard PartnerB.
Note: For convenience we will use the below users instead of PartnerA and PartnerB
PartnerA = Partner01
PartnerB = Partner02
B. Onboard PartnerA and PartnerB connect direct nodes in SFG using AMF (Customer Initiated communication profile (Inbound)).
Double click on the Partner01
Click on + icon in the top right corner.
Give details of the Node and click save.
Operating System: Operating system of the partner01
SPOE: Option to enable/disable Secure point of entry
Node Name: Node name of Parnter01
Host Name/IP: Host/Ip of the Partner01 CD node
Port: Port of the Partner01 CD node
Alternate Ips: we can give there are any alternate IPs for this CD node
Secure+: Option to enable/disable secure+ for SSL
CertFile: Public cert of the Partner01 CD node (In txt format with no headers)
Common Name: Common name of the Partner01 CD certificate.
TLS Version: TLS version to be used in the communication
Ciphers: Ciphers to be used in the communication
Once the onboarding was done, we can see the status as completed.
Repeat the above steps to onboard CD protocol for Partner02
C. Create MessageType or use the existing one in AMF:
Go to MessageTypes under Onboarding
Click on + icon in the right corner to add a new Message Type
Give the Message Type name and description and click on save
Note: In this scenario we will use the existing Message Type (GENERIC)
D. Create Message Mapping with Sender, Receiver and MessageType with a file pattern:
Go to Message Mapping under Onboarding
Click on +icon at the top right corner
Select Sender, Receiver, MessageType give pattern of the files that Partner01 will send and click save.
E. 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)
F. Create Workflow Definition and add Action (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 step 1 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, MessageType and Workflow (Created in step F) and click on save.
H. Create MFT Initiated Communication Profile for outbound delivery:
Double click on Partner02 in Onboarding-> users
Click on + icon at the top right
Select MFT initiated and give the details
SPOE: Option to know if Partner02 will use SPOE or not (If SPOE was not used then we need to give Remote user ID and Remote Password)
Submitter User ID: Option to pass submitter user ID.
Remote User ID: Remote User ID in the Partner02 node
Use Source File Name: Option to use source filename.
Remote File Name: Remote file name if you disabled the Use Source File Name in the 3-iv.
Remote Path: Path for the file to be placed.
Disposition: dropdown to select disposition of the file
Binary mode: Option to enable or disable binary mode for file transfer.
Copy Statement Sys opts: Option to execute copy step Sys opts. If we enable that we need to give the Sys opts to run
Run Task: Option to execute run task Sys opts. If we enable that we need to give the Sys opts to run
Run Job: Option to execute run job Sys opts. If we enable that we need to give the Sys opts to run
Send Email Notifications: Option to send email notifications for successful delivery.
Receivers Mail Ids: Recipients mail addresses if we enable Send Email Notifications.
Clean-up 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)
I. 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.
J. Verify the Message Activity in AMF, once PartnerA uploads the file to SFG via CD protocol and if everything was configured correctly, the file will be delivered to PartnerB via CD 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 Process Name, Process Number, Message ID, DDSN etc. for the file delivered to Partner02.