ATC: ROUTE routelist; option

This command alters the route of the current document.

  • routelist is required. It specifies the routing to be applied to the document. The routelist can contain any of the following, but at least one element is required and multiple elements must be separated by commas.
    • * is optional, but recommended. If used, it must begin the route list. This option preserves the existing routing on the document (which may have come from the template document); in other words it appends the route. Not including the * will cause existing routes to be replaced and all previous route events, including audit trail of who-got-what-when to be discarded.
    • AUTO is optional. This option selects the Predefined Route that best matches based upon standard routing rules.
    • routename is optional. This option specifies a route name. Multiple route names can be separated by commas.
    • ; (semicolon) is required to end the route list.
  • option is optional. You can use these options together.
    • AUTOACCEPTED specifies that the routee at Seq 1 should be recorded as having accepted his/her route so the document is sent on to Seq. 2 immediately.
    • AUTOSAVE causes the current document to be saved with its new route.  Typically the document is saved after the workflow script finishes.
    • FROM from option makes the target document be “from” a specified person by replacing Seq. 1 in the Route Detail. The from option can be any of the following:
      • FIRST makes Seq. 2 of the resolved route replace Seq. 1 (removing the default creator).
        Note: because FIRST replaces Seq. 1 with Seq. 2 (moving Seq. 2 up), Seq. 2 is the route that is AUTOACCEPTED if that option is also specified. If you do not wish the route to move up, use FROM 2 instead.
      • FINAL sets Seq. 1 to match the last routee in the resolved route.
      • n sets Seq. 1 to match the first routee in the resolved route at the specified sequence.
      • USER sets Seq. 1 to match the current user

Example

ATC: SET STATUS = BB
ATC: ROUTE *, AUTO; AUTOSAVE

The above example means “set the document status to BB (Bid Back) then select a predefined route based upon the status being Bid Back and save the current document with this route.”  Because the * option is included, the previous route on the document is preserved.

ATC: ROUTE AUTO; AUTOSAVE

You probably forgot the asterisk (*); see the first example!  The above example means “select a predefined route based upon standard routing rules and save the current document with this route.”  Because the * option is not included, the previous  route on the document (if any) is not preserved.  Using this form of the command in a route-triggered workflow can cause an “Invalid use of SaveDocRouteData” message to appear.

ATC: ROUTE *, InvScan; AUTOACCEPTED

The above example means “keep the current routing on the document, append the predefined route called InvScan, then accept the route and send the document on to the routee in Seq. 2.”

ATC: ROUTE *, AUTO; FROM 15 AUTOACCEPTED

The above example means “select a route based upon standard routing rules, make Seq. 1 equal to the first routee in Seq. 15, then accept the route for Seq. 1 and send the document on to the routee in Seq. 2”


Last updated: May 14, 2019 at 21:52 pm ;