Last updated
Last updated
Use Case: Partner A (Sender) send files to SFG via SFTP protocol, we deliver those files to Partner B (Receiver) using CD protocol from SFG via AMF (Agile Messaging Framework).
Sequence Diagram:
Steps:
A. Onboard Partner A and Partner B in SFG using AMF.
B. Onboard Partner A SFTP profile in SFG using AMF (Customer Initiated Communication Profiles (Inbound)).
C. Onboard Partner B connect direct node in SFG using AMF (Customer Initiated Communication Profiles (Inbound)).
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 EOL Conversion 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. Create MFT Initiated CD profile for outbound delivery in Partner B.
K. Create Communication Rule with Sender, Receiver, Message Type and Comm profile Name.
L. Verify the Message Activity in AMF once Partner A uploads the file to SFG via SFTP protocol. If everything was configured correctly, the file will be delivered to Partner B via CD protocol.
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 Partner A and Partner B
Partner A = Partner11
Partner B = Partner12
Select Customer and give details of Partner11, 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 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 the step 2.
Verify the Partner details and click Onboard User.
B. Onboard Partner11 SFTP in SFG using AMF (Customer Initiated Communication Profiles (Inbound)).
Double click on the Partner11
Click on + icon in the top right corner
Give details of the SFTP Inbound and click save
Once the Onboarding was done, we can see the status as completed.
C. Onboard PartnerB CD profile in SFG using AMF (Customer Initiated Communication Profiles (Inbound) and MFT Initiated Communication Profiles (Outbound)).
Double click on the Partner12
Click on + icon in the top right corner
Give details of the CD Profile and click save
Operating System: Operating system of the Partner12
SPOE: Option to enable/disable Secure point of entry
Node Name: Node name of Partner12 CDNode
Host Name/IP: Host/IP of the Partner12 CDNode
Port: Port of the Partner12 CDNode
Alternate IPs: we can give there are any alternate IPs for this CD node
Secure+: Option to enable/disable secure+ for SSL
Cert File: Public cert of the Partner12 CDNode (In txt format with no headers)
Common Name: Common name of the CD_PARTNER12
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.
D. 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 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 Partner11 will send and click save.
F.. Create EOL Conversion Action with adding file name format.
Go to Actions under Onboarding-> Workflow
Click on + icon at the top right corner
Give Name, select EOL Conversion as Action Type, and in the file name format give the required name (NewFileName.txt)
G. Create Delivery Action or use the predefined one (Deliver as is):
Go to Actions under Onboarding-> Workflow
Click on + icon at the top right corner
Note: In this scenario we will use the existing Action (Deliver as is)
H. Create Workflow Definition and add Actions (Created in step Fand 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 as step1 and click save.
Select the 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. Create MFT Initiated CD profile for outbound delivery in PartnerB.
click on + icon at top right corner.
1. SPOE: Option to know if user will use SPOE or not (If SPOE was not used then we need to give Remote user ID and Remote Password)
2. Submitter User ID: Option to pass submitter user ID
3. Remote User ID: Remote User ID in the user node
4. Use Source File Name: Option to use source filename.
5. Remote File Name: Remote file name if you disabled the Use Source File Name in the 3-iv.
6. Remote Path: Path for the file to be placed.
7. Disposition: dropdown to select disposition of the file
8. Binary mode: Option to enable or disable binary mode for file transfer.
9. Copy Statement Sys opts: Option to execute copy step Sys opts. If we enable that we need to give the Sys opts to run
10. Run Task: Option to execute run task Sys opts. If we enable that we need to give the Sys opts to run
11. Run Job: Option to execute run job Sys opts. If we enable that we need to give the Sys opts to run
12. Send Email Notifications: Option to send email notifications for successful.
13. Receivers Mail Ids: Recipients mail addresses if we enable Send Email Notifications
14. 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)
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 PartnerA uploads the file to SFG via SFTP protocol. 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 the Partner12
