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

UC23

PreviousUC22NextUC24

Last updated 3 months ago

Share point --> SFG --> AMF -->CD

Use Case: We run Schedule to get files from Partner45 (Sender) folder to SFG via Share point Protocol, we use Actions EOL Conversion, Zip and Deliver those files to the Partner46 (Receiver) via CD Protocol using AMF.

Sequence Diagram:

Steps:

A. Onboard Partner45 and Partner46 in SFG using AMF.

B. Create Partner45 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 Partner46 Connect Direct Node in SFG using AMF (Customer Initiated Communication Profile (Inbound)).

E. Create Message Types or use the existing one in AMF.

F. Create Message Mapping with Sender, Receiver and Message Type with a file pattern.

G. Create EOL Conversion Action as Action Type.

H. Create Zip as Action Type.

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

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

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

L. Create MFT Initiated profile for outbound delivery in Partner46 with CD Protocol.

M. Create Communication Rule with Sender, Receiver, Message Type and Comm profile Name.

N. Verify the Message Activity in AMF once the Partner45 uploads the file to SFG via Share Point Protocol. If everything was configured correctly, the file will be delivered to Partner46 via CD Protocol using AMF.

Process:

A. Onboard Partner45 in SFG and Partner46 using AMF:

Login to AMF

Go to Onboarding -> Users

Click on + icon at the top right corner

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

C. Create Partne45 Share Point Protocol in SFG using AMF (MFT Initiated Communication Profile (Inbound)).

Double click on the Partner45

Click on + icon in the top right corner

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

  1. OAuth URL: URL to get the OAuth token

  2. Grant Type: Grant type to get token

  3. Client ID: Client ID of the user

  4. Client Secret: Secret of the user

  5. Application ID: 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 User Name: 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. File Pattern: File pattern to filter the files

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

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

E. Create Partner46 Connect Direct Node in SFG using AMF (Customer Initiated Communication Profile (Inbound)).

Double click on the Partner46

Click on + icon in the top right corner

Give details of the CD Customer Initiated Profile and click save

  1. Operating System: Operating system of the Partner46

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

  3. Node Name: Node name of Partner46CDNode

  4. Host Name/IP: Host/IP of the Partner46CDNode

  5. Port: Port of the Partner46CDNode

  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. Cert File: Public cert of the Partner46CDNode (In txt format with no headers)

  9. Common Name: Common name of the CD_PARTNER46

  10. TLS Version: TLS version to be used in the Communication

  11. Ciphers: Ciphers to be used in the Communication

Once the on boarding was done, we can see the status as completed.

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

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

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

I. Create Zip Action as Action Type.

Go to Actions under Onboarding->Workflow

Click on + icon to create new Action

Give Action Name, Action Type ZIP 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 G, step H and step I) as step1, step2 and step3.

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 EOL Conversion Action that we created in step G as step1 and click save.

Select the Zip Action that we created in step H as step2 and click save.

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

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

Go to Rules under Onboarding -> Workflow

Click on + icon at the top right

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

L. Create MFT Initiated Profile (Outbound) Delivery in Partner46 with CD Protocol.

Double click on the Partner46

Click on + icon in the top right corner

  1. SPOE: Option to know if user 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 user 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)

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

Go to Rules under on boarding -> Communication

Click on + icon at top right corner

Select Sender, Receiver, Message Type and Comm. Profile Name and click save.

N. Verify the Message Activity in AMF once the Partner45 uploads the file to SFG via Share Point Protocol. If everything was configured correctly, the file will be delivered to Partner 46 via S3 Protocol using AMF.

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 the Partner46.

Graphical user interface, table Description automatically generated
A screenshot of a computer Description automatically generated with medium confidence
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
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
Graphical user interface, text, application 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