Sterling File Gateway Tutorial

To learn how Sterling File Gateway works from end to end, perform the following procedure using sample files that you create to use with the tutorial.

Only the high-level tasks are listed here. For specific instructions for each step, see the topics in the appropriate persona library. Use the following log on information for users that are automatically installed with Sterling File Gateway:
Role User ID Password
System Administrator fg_sysadmin password
Integration Architect fg_architect password
Route Provisioner fg_provisioner password
Operator fg_operator password
  1. Log in to Sterling File Gateway as fg_sysadmin.
  2. Configure an FTP Server adapter.
    See Prepare Communication Adapters.
  3. Log out.
  4. Log in as fg_architect.
  5. From the main menu, select Participants > Communities to create a community with the following values:
    Field Value
    Community Name FirstComm
    Partner Initiates Protocol Connection X
    Partner Listens for Protocol Connections X
    FTP or FTPS X
    Should Receive Notification Yes
    See Create a Community.
  6. Select Participants > Groups to create a group named Group1.
    See Create a Group.
  7. Log out of Sterling File Gateway.
  8. Log in as fg_provisioner.
  9. Create two partners with the following values:
    Field Value For First Partner Value For Second Partner
    Community FirstComm FirstComm
    Partner Name Partner1 Partner2
    Phone 333 444
    Email y@x.com x@y.com
    User Name partner1 partner2
    Password password password
    Given Name partner partner
    Surname 1 2
    Partner Role Is a consumer of data
    • Initiates a connection
    		Is a producer of data
    Use SSH No No
    PGP Settings
    • No
    • No
    • No
    • No
    See Create a Partner.
  10. Associate the partners with Group1. Select Participants > Groups > Add Partner. Select the partners and the group, and click Execute.
    See Add Partners to Groups.
  11. Log out.
  12. Log in as fg_architect.
  13. Select Routes > Templates > Create to create a routing channel template with the following values:
    Field Value
    Template Name FirstStatic
    In the Type tab  
    Type Static
    In the Special Characters tab  
    Special Characters None
    In the Groups tab  
    Producer Group Group1
    Consumer Group Group1
    In the Provisioning Facts tab  
    Fact Name myUserId
    Display Label User ID
    Description The user ID to send it to
    In the Producer tab  
    Producer Mailbox Path  
    Producer File Structure Click Add
    Producer File Type Text
    File name pattern as regular expression .+
    File name pattern group fact names, comma delimited (leave blank)
    In the Consumer tab  
    Delivery Channel Description Click Add
    Pattern for Consumer Mailbox Path  
    If checked, mailboxes matching this pattern may be created on demand Check the box
    Consumer File Structures Click Add
    Consumer File Type Text
    Consumer file name format  
    See Create a Routing Channel Template.
  14. Log out.
  15. Log in as fg_provisioner.
  16. Create a routing channel with the following values:
    Field Value
    Routing Channel Template FirstStatic
    Producer Partner2
    Consumer Partner1
    User ID User1
    See Create a Routing Channel.
  17. Log out.
  18. Log in to myFileGateway as Partner2.
  19. Upload a file to the / mailbox.
    See Send a File from myFileGateway.
  20. Log out.
  21. Log in to Sterling File Gateway as fg_operator.
  22. Search for the file you uploaded.
    See Search for a File.
  23. Click on the arrived file and observe the details about the events, the routing channel, and the routing channel template.
  24. Log out.
  25. Log in to myFileGateway as Partner1.
  26. Download a file.
    See Retrieve a File from myFileGateway.
  27. Log out.
  28. Log in to Sterling File Gateway as fg_operator.
  29. Search for the file you downloaded.
  30. Click on the arrived file and observe the details about the events, the routing channel, and the routing channel template.
  31. Replay the route.
    See Replay From the Beginning of a Transfer.