Subscribe to Advanced Routing application

To use Advanced Routing features, you must subscribe a user account or account template to an Advanced Routing application.

Prerequisites

  • Create an Advanced Routing application. For instructions on creating an Advanced Routing application, see Create Advanced Routing application.
  • Create at least one transfer site for the selected user account. For instructions on creating a transfer site, see Transfer sites.
  • Assign at least one route to the selected user account. For instructions on assigning a Route Template Package, see Assign Route Package Template.

Workflow

  1. Select a user account
  2. Configure general settings
  3. Configure post transmission actions
  4. Complete the subscription

Select a user account

  1. Select Accounts > User Accounts. The User Accounts page is displayed.
  2. Click on the name of the account that you want to subscribe to the Advanced Routing application.
  3. The User Account Settings page is displayed with details for the selected account.
  4. Click the Subscriptions tab for the selected account.
  5. Click Subscribe.
  6. The settings page for the subscription is displayed.

Configure general settings

In the General Settings pane:

  1. In the Subscription Folder field, type the full subscription folder path under the user's home folder. The subscription folder name can contain up to 254 characters.
  2. Note You cannot use the following characters in the subscription folder name: * < > ? " \ | :
  3. Select the Encrypt mode. Selecting the Encrypt mode allows you to configure repository encryption for accounts at the per-subscription level. For additional information, refer to Repository encryption certificate.
  4. Select Default to inherit the encryption mode for the subscription folder from the account or the global settings.
  5. Select Enable to encrypt all files uploaded to the subscription folder.
  6. Select Disable to upload unencrypted files to the subscription folder.
  7. Note Files that are transferred via Advanced Routing or Standard Routing will be encrypted or not based on the target subscription folder repository encryption setting.
  8. For additional subscription folder repository encryption information, refer to Configure general settings.
  9. In the Flow Settings pane, select the Existing flow attributes.
  10. If Preserve is selected, the attributes defined in the Flow Attributes pane will be applied only to newly received files which do not have associated flow attributes.
  11. If Overwrite is selected, the attributes defined in the Flow Attributes pane will overwrite any existing attributes for incoming files (for example, files published to this folder from another subscription folder).
  12. When Append is selected, only the attributes which are not defined for incoming files will be applied. Existing attributes will be preserved.
  13. In the Flow/Subscription Attributes pane:
    1. To add a flow or a subscription attribute, click Add Attribute. For additional information, refer to Flow and subscription attributes.
    2. Add Attribute allows you to add custom properties as Key=Value pairs. Flow attributes can be used for expression evaluation in Advanced Routing only when the application operates with files. Subscription attributes are bound to the subscription, therefore, they can be used for expression evaluation in all Advanced Routing fields.
    3. NoteSubscription attributes can be accessed using the following expression: ${subscription.attributes['ATTRIBUTE_NAME'].
      Flow attributes can be accessed using the following expression: ${flow.attributes[‘userVars.ATTRIBUTE_NAME’]}.
    4. Some examples of attributes are:
      AttributeValue
      userVars.1internalEmail@axway.com
      userVars.2ReportsMonitor
      To access attributes, see the following examples:${account.attributes['userVars.1']}${account.attributes['userVars.2']} For example, the account.attributes is the selector for attributes of the account used to execute the current route - it must be written exactly as shown.The userVars. prefix must be prepended to the attribute name .All this should be written as an EL expression: ${...}
    5. Click the Save () icon.

Configure post transmission actions

Configuring the post transformation actions is divided into selecting the post transformation actions, the post client download actions, and the post routing settings.

Select the post transformation actions

In the For Files Received from this Account or its Partners pane:

  1. To set a schedule for automatic retrieval of files from a remote server, select the Automatically Retrieve Files From check box and then select the transfer site from the drop-down list. If you select a PeSIT transfer site, you can select a Transfer Profile from the list or leave the field empty to use the default PeSIT transfer profile. For more information, see Transfer sites.
  2. The Schedule pane and the Retrieve Files Now button are displayed.
  3. If subscription retrieves files from a Folder Monitor transfer site, to configure a scheduled Folder Monitor operation, you must select Set explicit FolderMonitor Schedule.
  4. Click Configure in the Schedule pane to set up a future one time event or a recurring schedule.
  5. The Configure Schedule dialog box is displayed.
  6. In the Configure Schedule dialog box, specify the desired conditions for the scheduled server‑initiated file retrieval.
  7. To schedule an immediate recurrent task, select Schedule events on a recurring basis and then select Start now in the Length of Recurrence pane. The task will begin on the next minute.
  8. Note If the schedule is set on a recurring basis, the Recurrence options dynamically change with respect to the recurrence condition: Hourly, Daily, Weekly, Monthly, or Yearly.

    If the server goes down and restarts, the scheduler will not execute any scheduled tasks missed during the server down time.

    If you configure a schedule and save it after the scheduled start time, the task will not be executed. You must save your configured schedule before the scheduled start time.
  9. (Optional) Enter the Maximum number of parallel transfers. If you enter a value greater than zero, SecureTransport executes only the specified number of transfers in parallel. If the value is null or zero, the maximum number of parallel transfers is limited by system capacity.
  10. The maximum number of parallel transfers limit is applied cluster wide. The limit for files transferred from the client will not be exceeded. Due to limitations in Standard Cluster communication mode, the parallel pulls limit can be exceeded when there are several connections. If you want to force the limit, then the force.standart.cluster.sit.pulls.sync=true system property should be added to the start_tm_console. Adding the property to the start_tm_console has a performance penalty due to increased cluster communication.
    Note that the force.standard.cluster.sit.transfers.sync value overrides the value of the force.standart.cluster.sit.pulls.sync property, used in previous SecureTransport versions for the same purposes.
  11. (Optional) Click the Retrieve Files Now button to immediately trigger a one time file pull.
  12. Note When the one-time pull event is triggered, the admin daemon will try to connect to the Transaction Manager until the maximum number of retry attempts is reached as specified by the Streaming.Event.maxRetries server configuration parameter. The period between each retry is specified by the Streaming.Event.idleTimeout server configuration parameter. When the maximum number of retries is reached, the execution process finishes. For more information on server configuration parameters, refer to View and change server configuration parameters.
  13. In the Post Transmission Settings pane, select the Route. The selected route will be executed on files uploaded to the subscription folder.
  14. In the On Success pane, to execute the selected route when the server does not return any, select the Execute route when the remote server returns no files check box. The selected route will be executed when directory listing is successful but there are no files matching the download pattern.
  15. To trigger processing of files based on a specific condition, select the Trigger processing of files based on condition check box.
  16. When unchecked, each file received in the subscription folder is submitted for processing.
  17. When checked, processing of the files in the subscription folder will be triggered upon a specific condition.
  18. Enter the trigger condition in the Trigger condition field.
  19. Example:
  20. To trigger file processing when the file the extension trigger arrives:
  21. ${stenv['target'].matches('.*.trigger')?1:0}
  22. Select the files to submit for processing.
  23. If All files in the subscription folder (default) is selected, all files in the subscription folder are processed except for the trigger file.
  24. If Files read from trigger file content is selected, data file names will be read from trigger file content. Each file name should be on new line. The whitespace characters before and after the file names are discarded. Also lines containing only whitespace characters are not considered as files.
  25. Trigger file format:
  26. file1.txt
  27. file2.txt
  28. file3.png
  29. If Files matching specific filename pattern is selected, the files matching the defined filename pattern will be processed.
  30. The expression language can be used to specify the filename pattern.
  31. Examples:
  32. All text files - with .txt extension:
  33. *.txt
  34. All files that have names same as the trigger file name without extension.
  35. ${basename(stenv['target'])}.*
  36. In the On Temporary Failure pane, select the option for temporary failed transfers. The temporarily failed transfers will be retried. The temporary failure option is not applicable for Client Initiated Transfers.
  37. Note The following actions are applied to files that did not properly arrive in the designated folder.
  38. If No Action is selected, no actions take place on the temporarily failing files.
  39. If Route is selected, the selected route will be triggered. By default, the route will be triggered without the temporarily failing files. Select Submit the transferred file(s) to the route for processing to perform transformations on the temporarily failing files inside the selected route.
  40. If Delete is selected, the temporarily failing files are deleted.
  41. If Move/Rename File To is selected, you are required to specify a directory in the location where you are transferring the temporarily failing files to and to provide an expression to rename the files.
  42. In the On Failure pane, select the permanent failure option.
  43. Note The following actions are applied to files that did not properly arrive in the designated folder.
  44. If No Action is selected, no actions take place on the failed files.
  45. If Route is selected, the selected route will be triggered. By default, the route will be triggered without the failed files. Select Submit the transferred file(s) to the route for processing to perform transformations on the failed files inside the selected route.
  46. If Delete is selected, the failed files are deleted.
  47. If Move/Rename File To is selected, you are required to specify a directory in the location where you are transferring the failed files to and to provide an expression to rename the files.

Select the post client download actions

In the Post Client Download Actions pane:

Note Post Client Download Actions will be applied to each file downloaded from the subscription folder.
  1. In the On Success pane, select the action to take place for each successful client download.
  2. If No Action is selected, no actions take place on the downloaded files.
  3. If Route is selected, the selected route will be triggered. By default, the route will be triggered without the files that are being downloaded. Select Submit the transferred file(s) to the route for processing to perform transformations on the files that are being downloaded inside the selected route.
  4. If Delete is selected, after a file is successfully downloaded by the client, it is deleted from the Advanced Routing subscription folder.
  5. In the On Failure pane, select the action to take place for each failed client download.
  6. If No Action is selected, no actions take place on the files that failed downloading.
  7. If Route is selected, the selected route will be triggered. By default, the route will be triggered without the files that are being downloaded. Select Submit the transferred file(s) to the route for processing to perform transformations on the files that are being downloaded inside the selected route.
  8. If Delete is selected, after a file download by the client fails, the file is deleted from the Advanced Routing subscription folder.

Select the post routing actions

In the Post Routing Settings pane:

Note The Post Routing Settings actions are applied to files that have triggered a route package.
  1. In the On Success pane, select the action to take place for each file that successfully triggered a route.
  2. If No Action is selected, no actions take place on the files that successfully triggered a route.
  3. If Delete is selected, the files that successfully triggered a route are deleted.
  4. If Move/Rename File Tois selected, you are required specify a directory in the location where you are transferring the files to that successfully triggered a route and to provide an expression rename the files.
  5. In the On Failure pane, select the action to take place for each file that failed to trigger a route.
  6. If No Action is selected, no actions take place on the files that failed to trigger a route.
  7. If Delete is selected, the files that failed to trigger a route are deleted.
  8. If Move/Rename File Tois selected, you are required specify a directory in the location where you are transferring the files to that failed to trigger a route and to provide an expression rename the files.

Complete the subscription

To complete the Advanced Routing subscription, click Add.

Related topics:

Related Links