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

UC24

PreviousUC23NextUC25

Last updated 3 months ago

S3 --> SFG --> AMF -->SFG --> SFTP

Use Case: We run Schedule to get file from Partner47 (Sender) folder to SFG via S3 Protocol we use Actions EOL Conversion, Gzip and Deliver those files to the Partner48 (Receiver) using SFTP Protocol from SFG via AMF.

Sequence Diagram:

Steps:

A. Onboard Partner47 and Partner48 in SFG using AMF.

B. Onboard Partner47 S3Profile 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 EOL Conversion Action as Action type.

G. Create Gzip 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 F, step G and step H) as step1, step2 and step3.

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

K. Onboard Partner48 SFTP Profile in SFG Using AMF (MFT Initiated Communication Profile (outbound)).

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

M. Verify the Message Activity in AMF once the Partner47 uploads the file to SFG via S3. If everything was configured correctly, the file will be delivered to Partner48 via SFTP protocol using AMF.

Process:

A. Onboard Partner47 and Partner48 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 Partner47 select User Type and 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 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 the step -2.

Verify the Partner details and click Onboard User.

Repeat the above steps for Partner48.

B. Onboard Partner47 S3Profile in SFG using AMF(MFT Initiated Communication Profile (Inbound)).

Double click on the Partner47.

Click on + icon in the top right corner

Select the protocol as S3, operation as download, give the remaining 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 Username: Proxy username (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 and Select Delivery Type as Schedule.

Go to Rules under onboarding-> Communication

Click on + icon at top right corner.

Select Delivery Type as Scheduled Sender, Receiver, Message Type Comm. Profile Name and click on save

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

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 Partner47 will send and clicks save.

F. Create EOL Conversion Action as Action Type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Action Name, Action Type EOL Conversion and click save.

G. Create Gzip Action as Action Type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action.

Give Action Name, Action Type GZip and click save.

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.

Create Deliver Action as Action Type and click save

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

Go to Definitions under on boarding->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 EOL Conversion Action that we created in step F as step1.

Select the Gzip Action that we created in step G as step2.

Select the Deliver Action or use the predefined one (Deliver As is) in step H as step3.

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

Go to Rules under Onboarding -> Workflow

Click on + icon at the top right

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

K. Onboard Partner48 SFTP profile in SFG Using (MFT Initiated Communication Profile (outbound)).

Double click on the Partner48 in Onboarding-> Users

Click on + icon in the top right corner

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

Give the details and clicks save:

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

  2. Remote Port: Port of the Partner48 SFTP server

  3. Remote User ID: Remote User ID of user in the Partner48 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 step 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 of Remote SFTP server

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

  11. Receivers 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 was cleaned, we cannot redeliver the file again).

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

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

M. Verify the Message Activity in AMF once the Partner47 uploads the file to SFG

ViaS3. If everything was configured correctly, the file will be delivered to Partner48 via SFTP Protocol using AMF.

Go to Message activity under Track N Trace

Here we can see the file Delivered to the Partner48.

Graphical user interface, application Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, text, application Description automatically generated
Graphical user interface, text, application, chat or text message Description automatically generated
Graphical user interface, application, table Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, table Description automatically generated
Graphical user interface, application, Teams Description automatically generated
Graphical user interface, table Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, application, table Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, application Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
A screenshot of a computer Description automatically generated
Graphical user interface, application, Teams Description automatically generated
Graphical user interface, application Description automatically generated
Graphical user interface, application Description automatically generated