Last updated
Last updated
Use Case: PartnerA (Sender) send files to AMF (Agile Messaging Framework) via CD protocol, we update the file name format and then deliver those files to Partner B (Receiver) via AMF.
Sequence Diagram:
Steps:
A. Onboard Partner A in SFG via AMF and Partner B in AMF.
B. Onboard PartnerA connect direct node in SFG using AMF (Customer Initiated Communication profiles (Inbound)).
C. Install UFA agent for Partner B.
D. Create Message Type or use the existing one in AMF.
E. Create Message Mapping with Sender, Receiver, Message Type and File Name Pattern.
F. Create Deliver Action by adding file name format.
G. Create Workflow Definition and add Actions (Created in step F) as step1.
H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step G).
I. Onboard Partner B Customer Initiated Receive profile.
J. Verify the Message Activity in AMF once Partner A uploads the file to SFG via CD protocol. If everything was configured correctly, the file will be delivered to Partner B via UFA protocol.
Process:
A. Onboard Partner A in SFG via AMF and Partner B in 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 = Partner05
Partner B = Partner06
Select Customer and give details of Partner A, select User Type, Authentication Type and click next.
User Type: Which Zone does the partner belongs 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.
1. AMF: AMF provider is used to onboard Partners which use UFA.
2. IBM: This will come from the providers config. We can choose several types based on the provider’s config.
3. Open LDAP: We need to select this if we selected the Authentication Type as LDAP in step2 .
Verify the Partner details and click Onboard User.
Repeat the same steps for Partner B (Partner06) with AMF as provider.
B. Onboard Partner A connect direct node in SFG using AMF (Customer Initiated Communication profiles (Inbound)).
Double click on Partner05
Click on + icon at the top right corner
Select the protocol CD, give the remaining details and click save
Operating System: Operating system of the partner05
SPOE: Option to enable/disable Secure point of entry
Node Name: Node name of Partner05
Host Name/IP: Host/Ip of the Partner05 CD node
Port: Port of the Partner05 CD node
Alternate IPs: we can give here any alternate IPs for this CD node
Secure+: Option to enable/disable secure+ for SSL
Cert File: Public cert of the Partner05 CD node (In txt format with no headers)
Common Name: Common name of the Partner05 CD Cert
TLS Version: TLS version to be used in the communication
Ciphers: Ciphers to be used in the communication
Once the onboarding is done, we can see the status as completed.
C. Install UFA agent for Partner B(Partner06).
Please refer the UFA installation document for this step
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 (CD_UC03_UFA)
E. Create Message Mapping with Sender, Receiver and Message Type with a file pattern:
Go to Message Mapping under Onboarding
Click on + icon in the right corner to add a new Message Mapping.
Select Sender, Receiver and Message Type give pattern of the files that Partner05 will send and click save.
F. Create Deliver Action by adding file name format:
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 (${datetime}).
G. Create Workflow Definition and add Actions (Created in step F) 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 F) as step1 and click save.
H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step G).
Go to Rules under Onboarding -> Workflow
Click on + icon at the top right
Give Sender, Receiver, Message Type and Workflow (Created in step G) and click on save
I. Onboard Partner B Customer Initiated Receive profile:
Double click on Partner06
Note: In this case we are using Partner06 as alternate user of NSFGR03V UFA agent. So we onboard this profile in that user.
Click on + icon at the top right corner
Select the protocol as UFA, Operation as download, give the remaining details and click save.
Download Folder: Folder where the files will come from AMF.
Sender: Sender name who is sending files (Partner05 in this case)
Receiver: Receiver name to whom we are delivering files via AMF (Partner06 in this case).
Message Type: Message type we used in this case (GENERIC)
Polling Interval: The polling interval between the sync i.e., UFA agent and the 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 from filesystem 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.
J. Verify the Message activity in AMF once Partner A(Partner05) uploads the files to the upload folder. If everything was configured correctly, the file will be delivered to Partner B(Partner06).
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 Partner06
