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

UC19

PreviousUC18NextUC20

Last updated 3 months ago

Share point --> SFG --> AMF -->UFA

Use Case: We run Schedule to get files from Partner37 (Sender) folder to SFG via Share point protocol, We Unzip the file, Route with file name and Deliver those files to the Partner38 (Receiver) via HTTP (UFA) protocol using AMF.

Sequence Diagram:

Steps:

A. Onboard Partner37 in SFG and Partner38 using AMF.

B. Create Partner37 Share Point Receive 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. Install UFA agent (Partner38)

G. Create Partner38 UFA Customer Initiated Download Profile.

H. Create Unzip Action as Action type.

I. Create Route Action with adding file name format.

J. Create Deliver Action or use the predefined one (Deliver As is)

K. Create Workflow Definition and add Actions (Created in step H, step I, step J) as step1, step2 and step3 respectively.

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

M. Verify the Message Activity in AMF once the Partner37 uploads the file to SFG via Share Point Protocol. If everything was configured correctly, the file will be delivered to Partner38 via HTTP (UFA) Protocol using AMF.

Process:

A. Onboard Partner37 in SFG and Partner38 using AMF:

Login to AMF

Go to Onboarding -> Users

Click on + icon at the top right corner

Select Customer and give details of Partner37 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 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 Partner38. Use AMF Provider for UFA User.

B. Create Partner37 Share point protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).

Double click on the Partner37

Click on + icon in the top right corner

Give details of the Share point MFT Initiated Download profile details and click save.

  1. OAuth URL: URL to get the OAuth token

  2. Grant Type: Grant type to get token

  3. ClientID: Client ID of the user

  4. ClientSecret: Secret of the user

  5. ApplicationID: Application of the user share point where we get files

  6. Resource ID: Resource ID of user share point

  7. Share point Domain: SharePoint Domain of user

  8. Site Name: Site name of the share point user

  9. Sub Folder: Sub folder if any to get files

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

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

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

  13. Proxy UserName: Proxy user name (If proxy was enabled)

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

  15. Regex: Regular expression to filter the files.

  16. FilePattern: File pattern to filter the files

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

F. Install UFA Agent (Partner38)

Please refer the UFA installation document for this step

G. Create Partner38 UFA Profile in AMF (Customer Initiated Download Profile)

Double click on the Partner38

Click on + icon in the top right corner

Give the UFA details and clicks save.

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

  2. Sender: Sender name who is sending files (Partner37 in this case)

  3. Receiver: Receiver name to whom we are delivering files via AMF (Partner38 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 in file system 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.

H. Create Unzip Action as Action Type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Action Name, Action Type Unzip and clicks save.

I. Create Route Action with adding file name format

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Action Name, Action Type Route with adding file name format and clicks save.

J. 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 clicks save.

K. Create Workflow Definition and add Actions (Created in step H, step I, and step J) 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 Unzip Action that we created in step H as step1 and click save.

Select the Route Action with adding file name format that we created in step I as step2 and click save.

Select the Deliver Action that we created in step J as step3 and click save.

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

Go to Rules under Onboarding -> Workflow

Click on + icon at the top right

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

M. Verify the Message Activity in AMF once the Partner37 uploads the file to SFG via SharePoint Protocol. If everything was configured correctly, the file will be delivered to Partner 38 via S3 Protocol using AMF.

Go to Message Activity under Track N Trace

Here we can see the details for the file Delivered to the Partner38

Graphical user interface, application Description automatically generated