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

UC08

PreviousUC07NextUC09

Last updated 3 months ago

SFTP --> SFG --> AMF --> UFA

Use Case: Partner15 (Sender) send files to SFG via SFTP protocol, We Zip and Deliver those files to the Partner16 (Receiver) via UFA protocol using AMF (Agile Messaging Framework).

Sequence Diagram:

Steps:

A. Onboard Partner15 in SFG using AMF and Partner16 in AMF.

B. Onboard Partner15 SFTP Customer Initiated Communication Profiles (Inbound).

C. Create Message Types or use the existing one in AMF.

D. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.

E. Install UFA agent (Partner16)

F. Onboard Partner16 Customer Initiated Download Profile.

G. Create Zip Action as Action type.

H. Create Deliver Action or Use the predefined one (Deliver As is).

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

J. Create Workflow Rule with Sender, Receiver, MessageType and Workflow Definition Name (Created in step I).

K. Verify the Message Activity in AMF once the Partner15 uploads the file to SFG via SFTP protocol. If everything was configured correctly, the file will be delivered to Partner16 via UFA protocol.

Process:

A. Onboard Partner15 in SFG using AMF and Partner16 in AMF:

Login to AMF

Go to Onboarding -> Users

Click on + icon at the top right corner

Select Customer and give details of partner15, select UserType, AuthenticationType and click next.

  1. UserType: Which Zone does the partner belong 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 same steps for Partner16. Using AMF Provider for UFA user.

B. Onboard Partner15 SFTP Customer Initiated Communication profiles (Inbound).

Double click on Partner15

Click on + icon at the top right corner

Select the protocol as SFTP Inbound and click save.

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

C. Create MessageTypes or use the existing one in AMF:

Go to MessageTypes under Onboarding

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

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

E. Install UFA agent (Partner16).

Please refer the UFA installation document for this step

F. Onboard Partner16 Customer Initiated Download profile:

Double click on Partner16

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 (Partner15 in this case)

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

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

  5. Polling Interval: The polling interval between the sync between UFA agent and 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.

G. Create ZIP Action as Action type

Go to Actions under Onboarding-> Workflow

Click on + icon to create new action

Give Action Name, select ZIP as Action type.

H. Create Deliver 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)

I. Create Workflow Definition and add Actions (Created in step G and step H) as step1

and step2

Go to Definitions under onboarding-> Workflow

Click on + icon at the top right corner.

Give Workflow Name, Description and clicks save.

Double click on the Workflow Definition Name.

Click on the + icon at the top right corner.

Select the zip action that we created in step G as step1 and click save.

Select the Deliver As Is that we created in step H as step2 and click save.

J. Create Workflow Rule with Sender, Receiver, MessageType and Workflow Definition Name (Created in step I).

Go to Rules under Onboarding -> Workflow

Click on + icon at the top right

Give Sender, Receiver, MessageType and Workflow (Created in step I) and click on save

K. Verify the Message activity in AMF once Partner15 uploaded the files to SFG via SFTP protocol. If everything is configured correctly, the file will be delivered to Partner16 via UFA protocol.

Go to Message activity under Track N Trace

Here we can see the file delivered to the Partner16