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

UC01

PreviousUseCasesNextUC02

Last updated 3 months ago

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

Use Case: Partner01 (Sender) send files to SFG via CD protocol, we deliver those files to Partner02 (Receiver) using CD protocol from SFG via AMF (Agile Messaging Framework).

Sequence Diagram:

Steps:

A. Onboard Partner01 and Partner02 in SFG using AMF.

B. Onboard Partner01 and Partner02 connect direct nodes 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 Delivery Action or use the predefined one (Deliver as is).

F. Create Workflow Definition and add Action (Created in step E) as step1.

G. Create Workflow Rule with Sender, Receiver, MessageType and Workflow definition name (Created in step F).

H. Create MFT Initiated CD Communication Profile for outbound delivery.

I. Create Communication Rules with Sender, Receiver, MessageType and Comm profile Name.

J. Verify the Message Activity in AMF once the Partner01 uploads the file to SFG via CD protocol. If everything was configured correctly, the file will be delivered to Partner02 via CD protocol.

Process:

A. Onboard Partner01 and Partner02 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 Partner01, select UserType, AuthenticationType and click next.

  1. UserType: Which Zone does the partner belongs to send or receive files? (DMZ or trusted)

  2. AuthenticationType: 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. OpenLdap: 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 to onboard Partner02.

B. Onboard Partner01 and Partner02 connect direct nodes in SFG using AMF (Customer Initiated communication profile (Inbound)).

Double click on the Partner01

Click on + icon in the top right corner.

Give details of the Node and click save.

  1. Operating System: Operating system of the partner01

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

  3. Node Name: Node name of Parnter01

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

  5. Port: Port of the Partner01 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. CertFile: Public cert of the Partner01 CD node (In txt format with no headers)

  9. Common Name: Common name of the Partner01 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.

Repeat the above steps to onboard CD protocol for Partner02

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

Go to MessageTypes under Onboarding

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

Give the Message Type name and description and click on save

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

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

Go to Message Mapping under Onboarding

Click on +icon at the top right corner

Select Sender, Receiver, MessageType give pattern of the files that Partner01 will send and click save.

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

F. Create Workflow Definition and add Action (Created in step E) as step1.

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 as step 1 and click save.

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

Go to Rules under Onboarding -> Workflow.

Click on + icon at the top right.

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

H. Create MFT Initiated Communication Profile for outbound delivery:

Double click on Partner02 in Onboarding-> users

Click on + icon at the top right

Select MFT initiated and give the details

  1. SPOE: Option to know if Partner02 will use SPOE or not (If SPOE was not used then we need to give Remote user ID and Remote Password)

  2. Submitter User ID: Option to pass submitter user ID.

  3. Remote User ID: Remote User ID in the Partner02 node

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

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

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

  7. Disposition: dropdown to select disposition of the file

  8. Binary mode: Option to enable or disable binary mode for file transfer.

  9. Copy Statement Sys opts: Option to execute copy step Sys opts. If we enable that we need to give the Sys opts to run

  10. Run Task: Option to execute run task Sys opts. If we enable that we need to give the Sys opts to run

  11. Run Job: Option to execute run job Sys opts. If we enable that we need to give the Sys opts to run

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

  13. Receivers Mail Ids: Recipients mail addresses if we enable Send Email Notifications.

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

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

J. Verify the Message Activity in AMF, once Partner01 uploads the file to SFG via CD protocol and if everything was configured correctly, the file will be delivered to Partner02 via CD 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 Process Name, Process Number, Message ID, DDSN etc. for the file delivered to Partner02.