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

UC12

PreviousUC11NextUC13

Last updated 3 months ago

UFA --> AMF --> SFG --> MFG

Use Case: Partner23 (Sender) sends files to AMF via HTTP (UFA) protocol, We Unzip, Route, do EOL and Mailbox those files to Partner24 (Receiver) via AMF.

Sequence Diagram:

Steps:

A. Onboard Partner23 in AMF and Partner24 in SFG using AMF.

B. Install UFA agent (Partner23).

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

D. Create Partner23 Customer Initiated Upload profile.

E. Create Unzip as Action type.

F. Create Route with adding file name format.

G. Create EOL Conversion as Action type.

H. Create Mailbox Action as Action type.

I. Create Workflow definition and add Actions (Created in step e, step f, step g, step h) as step1 step2, step3 and step4.

J. Create Workflow Rule with Sender, Receiver, Message Type and Workflow definition name (Created in step i).

K. Verify the Message activity in AMF once Partner23 uploads the file to SFG via UFA protocol. If everything is configured correctly, the file will be Mail boxed to Partner24 via HTTP protocol (MFG).

Process:

A. Onboard Partner23 in AMF and Partner24 in SFG using AMF:

Login to AMF

Go to Onboarding -> Users

Click on + icon at the top right corner

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

  1. UserType: 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: The details 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 4-ii.

Verify the Partner details and click Onboard User.

Repeat the same steps for Partner24. Using AMF provider for UFA User

B. Install UFA agent Partner23.

  1. Please refer the UFA installation document for this step

C. Create Message Type 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)

D. Create Partner23 Customer Initiated Upload profile:

Double click on Partner23

Click on + icon at the top right corner

Select the protocol as UFA, operation as Upload, give the remaining details and click save

  1. Upload Folder: Folder where the files will be placed to deliver to AMF.

  2. File Pattern: File pattern to filter the files.

  3. Sender: Sender name who is sending files (Partner23 in this case)

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

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

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

  7. Archive Flag: Option to enable or disable the archives.

  8. Archive Folder: Folder to archive the files if we enabled step vii

  9. Run Script Before Upload: Script name with path if we want to run any scripts before the file is uploaded.

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

  11. Pgp Encrypt: Option to encrypt the uploaded file.

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

E. Create Unzip as Action type

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give name and create Unzip Action as Action type as clicks save.

F. Create Route with adding file name format

  1. Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give name and create Route Action with adding file name format and clicks save.

G. Create EOL Conversion as Action type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give name and create EOL Conversion, select message type and click save.

H. Create Mailbox Action as Action type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give name and Mailbox as action type and clicks save.

  1. Mailbox Path: Path of the receiver (Partner24) mailbox.

  2. Extraction Count: Option to add extraction for sent file (default value is 1).

I. Create Workflow definition and add Actions (Created in step e, step f, step g and step h) as step1, step2, step3 and step4.

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 e, step f, step g, step h as step1, step2, step3 and step4 and click save

Select the Unzip action created in step e as step1 and click save.

Select the Route action created in step f as step2 and click save.

Select the Route action created in step g as step3 and click save.

Select the Mailbox action created in step h as step4 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, Workflow (Created in step i) and click on save

K. Verify the Message activity in AMF once the Partner23 uploaded the files to his upload folder. If everything is configured correctly, the file will be Mail boxed to Partner24 via HTTP protocol (MFG).

Go to Message activity under Track N Trace

Here we can see the details for the file Mailboxed to the Partner24.