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

UC02

PreviousUC01NextUC03

Last updated 3 months ago

CD --> SFG --> AMF --> SFG --> SFTP

Use Case: Partner03 (Sender) send files to SFG via CD protocol, we change the file name and deliver those files to the Partner04 (Receiver) using SFTP protocol from SFG via AMF (Agile Messaging Framework).

Sequence Diagram:

Steps:

A. Onboard Partner03 and Partner04 in SFG using AMF.

B. Onboard Partner03 connect direct node 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 Route Action with file name format.

F. Create Delivery Action or use the predefined one (Deliver as is).

G. Create Workflow Definition and add Actions (Created in step F and step G) as step1 and step2.

H. Create Workflow Rule with Sender, Receiver, Message Type and Workflow Definition Name (Created in step H).

I. Create MFT Initiated Send Communication Profile for outbound delivery in Partner04 with SFTP protocol.

J. Create Communication Rule with Sender, Receiver, Message Type and Comm Profile Name.

K. Verify the Message activity in AMF once the Partner03 uploads the file to SFG via CD protocol. If everything was configured correctly, the file will be delivered to Partner04 via SFTP protocol.

Process:

A. Onboard Partner03 and Partner04 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 Partner03, 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 provider's 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 step 2

Verify the Partner details and click Onboard User.

Repeat the above steps for Partner04.

B. Onboard Partner03 connect direct node in SFG using AMF (Customer Initiated communication profile (Inbound)).

Double click on the Partner03

Click on + icon in the top right corner

Give details of the Node and click save

  1. Operating System: Operating system of the Partner03

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

  3. Node Name: Node name of Parnter03

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

  5. Port: Port of the Partner03 CD node

  6. Alternate Ips: we can give there are any alternate IPs for this CD node

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

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

  9. Common Name: Common name of the Partner03 CD certificate

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

  11. Ciphers: Ciphers to be used in the communication.

Once the onboarding was done, we can see the status as completed.

C. Create Message Type or use the existing one in AMF:

Go to Message Type under Onboarding

Click on + icon in the right corner to add a new Message Type

Give a proper name to Message Type and Description and then click save

Note: In this scenario we will use the existing Message Type (GENERIC)

D. 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 Partner03 will send and click save.

E. Create Route Action with adding file name format.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Name, select Route as Action Type, and in the file name format give the required file name format using tokens

F. 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)

H. Create Workflow Definition and add Actions (Created in step F and 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 step1 and click save.

Select the action that we created in step G step 2 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 Send Communication Profile for outbound delivery in Partner04 with SFTP protocol.

Double click on Partner04 in Onboarding-> users

Click on + icon at the top right

Select MFT initiated Send and give the details (SFTP Protocol)

  1. Remote Host: Remote Host/IP of the Partner04 SFTP server

  2. Remote Port: Port of the Partner04 SFTP server

  3. Remote User ID: Remote User ID of Partner04 in the SFTP server

  4. Auth Type: Auth type supported by Remote SFTP server (password or key)

  5. Use Source File Name: Option to use source filename

  6. Remote File Name: Remote file name if you disabled the Use Source File Name in the 3-v

  7. Remote Path: Path for the file to be placed

  8. Use Temp File Name in Copy: Option to use temp file name in copy

  9. Remote KHK (Known Host Key): Known host key of Remote SFTP server

  10. Send Email Notifications: Option to send email notifications for successful delivery

  11. Receiver’s Mail Ids: Recipients mail addresses if we enable Send Email Notifications.

  12. 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 Partner03 uploads the file to SFG via CD protocol and if everything was configured correctly, the file will be Delivered to Partner04 via SFTP 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 details for the file Delivered to the Partner04