Advanced Routing

This section provides the Advanced Routing concepts and procedures for creating delegated administrators, applications, and route package templates for Advanced Routing. The creation of Advanced Routes is also described in this topic. It also provides details of subscribing user accounts to Advanced Routing applications and assigning route package templates to user accounts.

In addition to configuration descriptions, basic and advanced use cases are provided. Transformation and route step examples are included in the use case.

Advanced Routing best practices and troubleshooting suggestions are also provided.

Advanced Routing overview

The main function of the Advanced Routing feature is to act as an intelligent routing and allow SecureTransport administrators to flexibly provision data flows and to create diverse patterns for data movement between different participants, partner systems, and applications. The Advanced Routing feature for SecureTransport includes PGP Encryption and Decryption, Compress and Decompress, Line Ending, External Script, Encoding Conversion, Characters Replace, Line Padding, Line Folding, Line Truncating, and Rename transformation mechanisms. It also includes Publish To Account and Send To Partner routing mechanisms

Advanced Routing functional overview

Advanced Routing provides advanced transformation and routing capabilities for SecureTransport Server. On a high level, when specific conditions are met, particular steps are performed. Conditions and steps are wrapped in routes as part of a Route Package Template or Route Package.

Advanced Routing has the following main features:

  • Conditioning
    • Transformation and route execution is based on file path/name patterns or other environment variables
  • Transformations
    • PGP Encryption, PGP Decryption, Compress, Decompress, Line Ending, External Script, Encoding Conversion, Characters Replace, Line Padding, Line Truncating, Line Folding, and Rename transformations
    • Multiple transformation execution (for example, Decompress > PGP Decryption > Compress)
    • Renaming
  • Routings
    • File routing to transfer sites, accounts (including virtual and LDAP ones), and file system through Publish To Account and Send To Partner
    • Renaming and deleting
    • Overwrite upload folder - optional setting for the new upload folder name which overwrites the one configured in Transfer site settings
  • Tracking and notifications
    • File Tracking integration
    • Sentinel integration
    • Email notifications on routing and transformation successes, failures, and triggering
  • Extensive Expression Language support
  • Post routing, post transformation, and post processing actions 
  • Ability to specify and overwrite transformation and routing steps on an account basis
  • Distributed execution of the routes in a Standard Cluster or Enterprise Cluster

Advanced Routing process overview

The Advanced Routing feature is to be able to define the conditions which will trigger transformation and routing processing or both over a file or files. Those conditions or steps are stored in a Route Package or Route Package Template. In order to reuse an already defined step or steps the administrator can define them in a Route Package Template. While a step or steps which are specific for the particular user can be defined in a Route Package.

Each Route Package Template or Route Package can contain multiple routes and each route can contain multiple steps. There are two types of steps - transformation and routing. Transformation steps are used to transform the file, while routing steps are used to move the transformed file out of the temporary folder.

Advanced Routing is a standard SecureTransport application. In order to use this application the administrator must subscribe either an account or account template to it.

Advanced Routing processing can be triggered by the following events:

  • Successful client upload
  • Failed client upload
  • Successful client download
  • Failed client download
  • Successful server pull
  • Temporarily failure of a server pull
  • Failed server pull - Also applies to failed wildcard and individual file pulls

Advanced Routing process overview

If Submit the transferred file(s) to the route for processing is selected, the files that are processed and routed by Advanced Routing use a sandbox folder. Once a file is uploaded in a Advanced Routing subscription folder, a chain of routes is built and the execution of the first route in the chain starts by creating a temporary sandbox folder and copying the original file (from the subscription folder) in it. Then the steps defined for this route are executed in the predefined order. When the last step is executed (either successfully or not), the sandbox folder is deleted. The whole process from creating the sandbox folder is repeated for all other routes in the chain. If Submit the transferred file(s) to the route for processing is not selected, the route triggers without creating a sandbox folder.

From execution point of view there is no difference whether a route is defined in a Route Package Template as inherited routes or in a Route Package as specific routes. Routes defined in Route Package Templates are executed prior to the routes defined in the Route Package.

A route might be defined with:

  • Several transformation and routing steps - When the route executed the file is transformed and then sent to the list of destinations.
  • No routing steps - Only transformations are applied and the file is not sent to any destination. However, this means the transformed file is not available since it's not published or sent to a destination. For transformed files to be available, you need to have at least one routing step in each route.
  • No transformations - When the route is executed the file is directly sent to the list of destinations.

Each Route Package Template, Route Package, or Route can contain configuration information for e-mail notification on failure, success, and triggering. When e-mail notifications on route triggering are enabled, SecureTransport will first send the e-mail notification as configured in the Route Package, then the e-mail notification as configured in the Route Package Template, and then the e-mail notification as configured in the Route.

Proceed with route execution on step failure is selectable in each step configuration. If the route execution is successful and e-mail notification on route success is enabled, SecureTransport will send this e-mail notification first as configured in the Route, then the notification as configured in the Route Package Template, and then the notification as configured in the Route Package.

The following topics describe the Advanced Routing feature and provide how-to instructions for configuring and troubleshooting the Advanced Routing feature:

Related Links