AMF (Agile Messaing Framework)
  • Agile Messaging Framework
    • Get Started
      • Install
        • Pre-requisites
        • CockroachDB
        • NATS for Queuing
        • Hashicorp Vault
          • Configure Vault
        • Python 3.9
        • AMF Bundle
        • Installation of AMF
          • Configure and install
          • Post Install Steps
        • IBM SFG Integration
          • Configure and Install
            • Install jars in SFG
            • Add amf.properties
            • Add CRDB pool details
            • Import Sterling Artifacts
          • Post Install Steps
            • Create user with API permissions
            • Changes in BPs
    • Concepts
      • Providers
      • Users
      • Message Type
      • Message Mapping
      • Workflow
      • Communication profiles
        • SFTP Profiles
          • Customer Initiated
          • MFT Initiated
            • MFT Initiated Send
            • MFT Initiated Receive
        • Connect Direct
          • Customer Initiated
          • MFT Initiated
        • SharePoint
          • MFT Initiated
            • MFT Initiated Send
            • MFT Initiated Receive
        • S3
          • MFT Initiated
            • MFT Initiated Send
            • MFT Initiated Receive
        • Azure ADLS
          • MFT Initiated
            • MFT Initiated Send
        • HTTP with Token
          • MFT Initiated
            • MFT Initiated Send
        • UFA
          • Customer Initiated
            • Customer Initiated Send
            • Customer Initiated Receive
      • Communication Rules
        • Immediate
        • Scheduled
    • Management
      • AMF UI Operations
      • AMF Services Operations
    • User Manual
      • Signup and Login
      • Dashboard
      • Track N Trace
        • Message Activity
        • Failed Message Activity
        • Onboarding Activity
        • Session Activity
        • Service Availability
        • Scheduler Activity
        • Delivery Queue
        • Audit Log
      • Onboarding
        • Customers
        • Users
          • Communication Profiles
        • Message Types
        • Message Mapping
        • Workflow
          • Definitions
          • Actions
          • Rules
        • Communication Rules
    • Troubleshooting
    • Tutorials
      • UFA Installations
        • Linux Installation
        • Windows Installation
      • Schedules
        • Run based on timer
        • Run daily
        • Run based on day(s) of the week
        • Run based on day(s) of the month
      • UseCases
        • UC01
        • UC02
        • UC03
        • UC04
        • UC05
        • UC06
        • UC07
        • UC08
        • UC09
        • UC10
        • UC11
        • UC12
        • UC13
        • UC14
        • UC15
        • UC16
        • UC17
        • UC18
        • UC19
        • UC20
        • UC21
        • UC22
        • UC23
        • UC24
        • UC25
        • UC26
Powered by GitBook
On this page
  1. Agile Messaging Framework
  2. Tutorials
  3. UseCases

UC03

PreviousUC02NextUC04

Last updated 3 months ago

CD --> SFG--> AMF --> UFA

Use Case: Partner05 (Sender) send files to AMF (Agile Messaging Framework) via CD protocol, we update the file name format and then deliver those files to Partner06 (Receiver) via AMF.

Sequence Diagram:

Steps:

A. Onboard Partner05 in SFG via AMF and Partner06 in AMF.

B. Onboard Partner05 connect direct node in SFG using AMF (Customer Initiated Communication profiles (Inbound)).

C. Install UFA agent for Partner06.

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 Partner06 Customer Initiated Receive profile.

J. Verify the Message Activity in AMF once Partner05 uploads the file to SFG via CD protocol. If everything was configured correctly, the file will be delivered to Partner06 via UFA protocol.

Process:

A. Onboard Partner05 in SFG via AMF and Partner06 in AMF:

Login to AMF

Go to Onboarding -> Users.

Click on + icon at the top right corner.

Select Customer and give details of Partner05, select User Type, Authentication Type and click next.

  1. User Type: Which Zone does the partner belongs to send or receive files? (DMZ or Trusted.)

  2. 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 Partner06 with AMF as provider.

B. Onboard Partner05 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

  1. Operating System: Operating system of the partner05

  2. SPOE: Option to enable/disable Secure point of entry

  3. Node Name: Node name of Partner05

  4. Host Name/IP: Host/Ip of the Partner05 CD node

  5. Port: Port of the Partner05 CD node

  6. Alternate IPs: we can give here any alternate IPs for this CD node

  7. Secure+: Option to enable/disable secure+ for SSL

  8. Cert File: Public cert of the Partner05 CD node (In txt format with no headers)

  9. Common Name: Common name of the Partner05 CD Cert

  10. TLS Version: TLS version to be used in the communication

  11. 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 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 Partner06 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.

  1. Download Folder: Folder where the files will come from AMF.

  2. Sender: Sender name who is sending files (Partner05 in this case)

  3. Receiver: Receiver name to whom we are delivering files via AMF (Partner06 in this case).

  4. Message Type: Message type we used in this case (GENERIC)

  5. Polling Interval: The polling interval between the sync i.e., UFA agent and the server.

  6. Run Script After Download: Script name with path if we want to run any scripts after the file was downloaded.

  7. Chunk Size: Size of the files that will be transferred in bits when there is a large file transfer

  8. PGP Decrypt: Option to decrypt the downloaded file.

  9. Cleanup on delivery: Option to clean the files from filesystem after successful delivery

  10. Clean Large Files: Option to clean only large file that meets the threshold given (Sample shown below)

  11. Validate MD5 Check Sum: Option to validate the MD5 Checksum on uploaded files.

J. Verify the Message activity in AMF once Partner05 uploads the files to the upload folder. If everything was configured correctly, the file will be delivered to 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