UC22 | AMF (Agile Messaing Framework)

Last updated 11 months ago

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

Use Case: We run Schedule to get file from PartnerA (Sender) folder to SFG via S3 Protocol, we Unzip the file and Deliver those files to the PartnerB (Receiver) using CD Protocol via AMF.

Sequence Diagram:

Steps:

A. Onboard PartnerA and PartnerB in SFG using AMF.

B. Onboard PartnerA S3 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. Onboard PartnerB Connect Direct Node in SFG using AMF (Customer Initiated Communication Profile (Inbound)).

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

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

G. Create GUNZIP Action as Action Type.

H. Create EOL Conversion Action as Action Type.

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

J. Create Workflow Definitions and add Actions (Created in step G and step H and 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. Onboard PartnerB Connect Direct Node Profile in SFG using AMF (MFT Initiated Communication Profile (Outbound))

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

N. Verify the Message Activity in AMF once the PartnerA uploads the file to SFG via S3 protocol. If everything was configured correctly, the file will be delivered to PartnerB via CD protocol.

Process:

A. Onboard PartnerA and PartnerB in SFG using AMF:

Go to Onboarding -> Users

Click on + icon at the top right corner

Note: For convenience we will use the below users instead of PartnerA and PartnerB

PartnerA = Partner43

PartnerB = Partner44

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

User Type: Which Zone does the partner belong to send or receive files? (DMZ or Trusted)
Authentication Type: Where we store the partner credentials? (LDAP or local (SFG/AMF) or Both)

Select the provider the Partner belong to and click next

AMF: AMF provider is used to onboard Partners which use UFA
IBM: This will come from the providers config. We can choose several types based on the provider's config.
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 to Onboard Partner44.

B. Onboard PartnerA S3 receive profile in SFG using AMF (MFT Initiated Communication Profile (Inbound)).

Double click on the Partner43

Click on + icon in the top right corner

Give details of the S3 MFT Initiated download Profile details and click save

Give details and click save

S3 bucket: S3 Bucket name
S3 Region: Region where S3 belongs
S3 Access Key ID: Access key ID of the S3 bucket
S3 Secret Key: Secret key of S3 bucket
Message to Process: Option to process the original or current message
Proxy Required: Option to open connections via proxy server
Proxy URL: Proxy server URL (If proxy was enabled)
Proxy User Name: Proxy user name (If proxy was enabled)
Proxy Password: Proxy password (If proxy was enabled)
Download Path: Path to get files
File Pattern: Pattern to filter the files
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. Select Delivery Type as Schedule.

Go to Comm Rules under Onboarding

Click on + icon in the top right corner

Select Delivery Type as Schedule

D. Onboard PartnerB connect direct node in SFG using AMF (Customer Initiated Communication Profile (Inbound)).

Double click on the Partner44

Click on + icon in the top right corner

Operating System: Operating system of the Partner44
SPOE: Option to enable/disable secure point of entry
Node Name: Node name of Partner44CD Node
Host Name/IP: Host/IP of the Partner44CD Node
Port: Port of the Partner44CD Node
Alternate IPs: we can give there is any alternate IPs for this CD node
Secure+: Option to enable/disable Secure+ for SSL (If secure+ was enabled)
Cert File: Public cert of the Partner44 CD Node (in txt format with no Partner44 headers)
Common Name: Common Name of the CD (If secure+ was enabled)
TLS Version: TLS version to be used in the Communication
Ciphers: Ciphers to be used in the Communication (If secure+ was enabled)

E. Create Message Types 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 Types (GENERIC)

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

H. Create Gunzip Action or use the predefined one(Gunzip)

Go to Actions under Onboarding->Workflow

Click on + icon to create new action

Give Action Name, Action Type Guzip and save

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

Go to Actions under Onboarding->Workflow

Click on + icon to create New Action

Give Action Name, Action Type Deliver and save

J. Create Workflow Definition and add Actions (Created in step F and step G) as step1 and step2.

Go to Definitions under Onboarding->Workflow

Click on + icon at the top right corner

Give Workflow Name, Description 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 on save

L. Onboard PartnerB Connect Direct Node Profile in SFG using AMF (MFT Initiated Communication Profile (Outbound))

Double click on the Partner44

Click on + icon in the top right corner

Give details of the Node and click save

Give the details and clicks save

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)
Submitter User ID: Option to pass submitter user ID
Remote User ID: Remote User ID in the user node
Use Source File Name: Option to use source filename.
Remote File Name: Remote file name if you disabled the Use Source File Name in the 3-iv.
Remote Path: Path for the file to be placed.
Disposition: Dropdown to select disposition of the file
Binary mode: Option to enable or disable binary mode for file transfer
Copy Statement Sys opts: Option to execute copy step Sys opts. If we enable that we need to give the Sys opts to run
Run Task: Option to execute run task Sys opts. If we enable that we need to give the Sys opts to run
Run Job: Option to execute run job Sys opts. If we enable that we need to give the Sys opts to run
Send Email Notifications: Option to send email notifications for successful delivery
Receivers Mail Ids: Recipients mail addresses if we enable Send Email Notifications.
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)

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

M. 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 save

N. Verify the Message Activity in AMF once the Partner43(PartnerA) uploads the file to SFG via S3 Protocol. If everything was configured correctly, the file will be delivered to Partner44 (PartnerB)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 the Partner44(PartnerB)