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

UC21

PreviousUC20NextUC22

Last updated 3 months ago

S3-->SFG-->AMF -->UFA

Use Case: We run Schedule to get files from Partner41 (Sender) folder to SFG via S3 protocol, we GunZip the file and deliver those files to Partner42 (Receiver) using UFA (HTTP) via AMF (Agile Messaging Framework).

Sequence Diagram:

Steps:

A. Onboard Partner41 in SFG using AMF and Partner42 in AMF.

B. Onboard Partner41 S3 Profile in SFG using AMF(MFT Initiated Communication Profile (Inbound).

C. Create Communication Rule with Sender, Receiver, Message Type and Comm. Profile Name. Select Delivery Type as Schedule.

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 Gunzip Action or use the predefined one (Gunzip)

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. Onboard Partner42 UFA Profile in AMF (Customer Initiated Communication Profile (Inbound).

K. Verify the Message Activity in AMF once the Partner41 (S3) Schedule ran, check if we received files from Partner41 in AMF, they got processed and Delivered to Partner42 via UFA (HTTP)Protocol.

Process:

A. Onboard Partner41 in SFG using AMF and Partner42 in AMF:

Login to AMF

Go to Onboarding -> Users

Click on + icon at the top right corner

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

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

  2. Authentication Type: Where 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 the step 2.

Verify the Partner details and click Onboard User.

Repeat the above steps for Partner42. Use AMF Provider for UFA User.

Note: Install UFA agent for Partner42

Please refer the UFA installation document for this step

B. Onboard Partner41 S3 Protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).

Double click on the Partner41

Click on + icon in the top right corner

Give details of the S3 MFT Initiated Download Profile details and click save

Give details and click save

  1. S3 bucket: S3 Bucket name

  2. S3 Region: Region where S3 belongs

  3. S3 Access Key ID: Access key ID of the S3 bucket

  4. S3 Secret Key: Secret key of S3 bucket

  5. Message to Process: Option to process the original or current message

  6. Proxy Required: Option to open connections via proxy server

  7. Proxy URL: Proxy server URL (If proxy was enabled)

  8. Proxy User Name: Proxy user name (If proxy was enabled)

  9. Proxy Password: Proxy password (If proxy was enabled)

  10. Download Path: Path to get files

  11. File Pattern: Pattern to filter the files

  12. Options: Options to perform after file get

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

C. Create Communication Rule with Sender, Receiver, Message Type and Comm. Profile Name. Select Delivery Type as Schedule.

Go to Rules under onboarding-> Communication

Click on + icon in the top right corner

Select Delivered Type Scheduled, Schedule Name, Sender, Receiver, Message Type, Comm. Profile Name and click on save.

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 Partner41 will send and Clicks save.

F. Create Gunzip Action or use the predefined one(Gunzip)

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Action Name, Action Type Gunzip and save

G. Create Deliver Action or use the predefined one (Deliver As Is)

Go to Actions under Onboarding->Workflow

Click on + icon to create New Action

Give Action Name, Action Type Deliver and save

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 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 corner.

Give Sender, Receiver, Message Type and Workflow (Created in step H) and click on save

J. Onboard Partner42 UFA Profile in AMF (Customer Initiated Communication Profile (Inbound)).

Double click on the Partner42

Click on + icon in the top right corner

Give details of the UFA Profile and click save

Give details and click save

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

  2. Sender: Sender name who is sending files

  3. Receiver: Receiver name to whom we are delivering files via AMF

  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 file in file system after successful delivery

  10. Clean Large Files: Option to clean only large file that meets the threshold given

Once the onboarding was done, we can see the status

K. Verify the Message Activity in AMF once the Partner41 Schedule ran, check if we received files from Partner41 in AMF, they got processed and Delivered to Partner42 via UFA (HTTP)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 Partner42