KBA-01778: How to Create a New ATC Workflow Script

Question:

I’ve been reading through ATC Scripts and Automatic Workflow and also the Index of ATC Commands and I believe I can solve an issue we are having by using workflow. How do I go about adding a new ATC script to do what I want?

Answer:

  1. Open the Workflow Scripts tool on the System Admin Dashboard then click the icon to add a new row.
  2. Enter a unique name in the Workflow Script Name field. We recommend you do not include spaces in the name. It is helpful to make the name indicate Doc type or trigger, for example: OnDFRSaveAttachTemplate, OnSubmittalDocSaved, or Project_Startup_Checklist.
  3. (optional) Write a note indicating the purpose of this workflow script or any other useful information about the script.
  4. Click the checkmark to accept the row.
  5. Save your changes. Continue with the steps below.

  1. Find the script name row then click the workflow icon to open the text editor.
  2. Type your workflow script. See the Index of ATC commands for more information.
  3. Save the script. The text editor will close.
  4. Save your changes.
  5. If you want to trigger this workflow script from a document action, see How to associate an event with a workflow script  If you are going to call this  workflow scripts from another script (through the ATC: CALL command), your script does not need to be associated with any event.

Pro Tip

Even if you plan to CALL your workflow script from a button or a route, associate your script with appropriate document types and a trigger of zero.  This allows the use of the Doc Type filter!


KBA-01778; Last updated: October 27, 2020 at 16:48 pm