{"id":5601,"date":"2023-11-30T08:00:51","date_gmt":"2023-11-30T08:00:51","guid":{"rendered":"https:\/\/www.process.st\/help\/docs\/naming-workflow-runs\/"},"modified":"2026-07-08T07:20:37","modified_gmt":"2026-07-08T07:20:37","slug":"naming-workflow-runs","status":"publish","type":"ht_kb","link":"https:\/\/www.process.st\/help\/docs\/naming-workflow-runs\/","title":{"rendered":"Naming Workflow Runs"},"content":{"rendered":"<p>Establishing a clear naming convention for your workflow runs helps you keep processes organized, simplifies report generation, and makes it easier for your team to locate past runs.<\/p>\n<p>Each workflow run has a unique name distinct from its parent workflow, allowing you to track instances effectively.<\/p>\n<p>A workflow run&#8217;s name will be different from the name of its parent workflow and will typically be unique each time that workflow is run.<\/p>\n<p><em><strong>Users: All&nbsp;<a href=\"https:\/\/www.process.st\/help\/docs\/user-permissions\/\">users<\/a> can change the name of a workflow run when active, unless the workflow\u2019s \u201cPrevent edits when using default naming\u201d setting is enabled. To run workflows, you must be an Administrator or a <a href=\"https:\/\/www.process.st\/help\/docs\/what-is-a-full-member\/\">Builder<\/a> with &#8220;edit&#8221;, &#8220;view all&#8221; or &#8220;run&#8221; permissions.&nbsp;<\/strong><\/em><\/p>\n<h2>Decide on a naming convention<\/h2>\n<h3>Plan ahead<\/h3>\n<p>Before running workflows, agree on a naming convention with your team. A consistent approach makes it easier to search for and reference past runs.<\/p>\n<p>You can name your workflow runs in a manner that will help you easily find them again, such as in these examples:<\/p>\n<ul>\n<li>Employee Onboarding: Employee Name + Job Title<\/li>\n<li>Client Setup: Client Name + Company Name<\/li>\n<li>Ticket Processing: Ticket Number<\/li>\n<li>Website Update: Company Name<\/li>\n<li>Payment Processing: Invoice Number<\/li>\n<\/ul>\n<h2>Naming new workflow runs<\/h2>\n<h3>Setting default run names<\/h3>\n<p>The most effective way to name your workflow runs is to set default run names while editing your workflow. This means, whenever you run a workflow, the run name could be a predefined value that doesn&#8217;t need to be manually updated.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17077\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-default-run.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<p>To set this up, edit your workflow then click the <strong>Edit button<\/strong> next to your <strong>Workflow Name. <\/strong>Here, you can enter some static text as the default run name, choose from the list of variables, or create a combination of both.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17075\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-default.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<p>You can also add <a href=\"https:\/\/www.process.st\/help\/docs\/getting-started-adding-form-fields\/\">form field<\/a> variables in your workflow run names. The form field value will reflect in your run name as soon as you populate the form field and click outside it.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17074\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-variable.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<p>If you have a&nbsp;<a href=\"https:\/\/www.process.st\/help\/docs\/data-sets\/\">Data Set<\/a> connected to your workflow, you can also use the Data Set values as variables to name your workflow automatically.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-14696\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/data-set-named-workflow-run.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<p>To set this up, first, <a href=\"https:\/\/www.process.st\/help\/docs\/data-sets\/#connecting-a-saved-view-to-a-workflow\">connect a Data Set to a dropdown field<\/a> in your workflow. Next, click the <strong>Settings cog<\/strong> and go to your <strong>Workflow Run name<\/strong>. Here, click on the <strong>magic wand<\/strong> to expand the list of variables and look for that <strong>Data Set&#8217;s variables<\/strong>. Select the desired variable that should name your workflow and <strong>Save<\/strong>.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17088\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-data-set-variables.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<h3>Lock the default run name<\/h3>\n<p>After entering a default run name, a <strong>Prevent edits when using default naming<\/strong> toggle appears in the workflow settings modal. Turn this on to make the run name read-only whenever a run uses the auto-generated default name.<\/p>\n<p>When this setting is enabled:<\/p>\n<ul>\n<li>Runs that use the default name display a read-only run name \u2014 no one can edit it.<\/li>\n<li>Runs where the name was changed manually or set via an integration remain editable as usual.<\/li>\n<\/ul>\n<p>This is useful when you need consistent, tamper-proof naming \u2014 for example, compliance workflows where each run must follow the exact naming pattern defined by the workflow owner.<\/p>\n<h3>Setting run names manually<\/h3>\n<p>If you have not set a default run name for your workflows, you have to manually name each workflow when you <a href=\"https:\/\/www.process.st\/help\/docs\/running-checklists\/\">run them<\/a>.<\/p>\n<p>Click the &#8220;<strong>+New<\/strong>&#8221; button in the top right corner of your screen. Then click <strong>&#8220;Run a Workflow&#8221;<\/strong> and search for a workflow to run.<\/p>\n<p>By default, the name will be set to the workflow name plus the time the workflow run was created, for example, <strong>&#8220;Create an Invoice 11:46PM workflow run&#8221;<\/strong>.&nbsp;Delete this and&nbsp;give your workflow run a different name, as shown below.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17078\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-run.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<h3>Setting run names via the scheduling tool<\/h3>\n<p>You can also set workflow run names in advance when you <a href=\"https:\/\/www.process.st\/help\/docs\/scheduled-checklists\/\">schedule your workflows to run<\/a>.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17087\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-scheduler.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<h3>Setting run names via integrations and automations<\/h3>\n<p>Naming a workflow run via <a href=\"https:\/\/www.process.st\/help\/kb\/integrations\/\">integration<\/a> or <a href=\"https:\/\/www.process.st\/help\/docs\/automations\/\">automation<\/a> is another common way to set names when your workflow runs.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-10389\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/PS-run-name-ex2.png\" alt=\"\" width=\"100%\" \/><\/p>\n<h2>Change the name of an active workflow run<\/h2>\n<blockquote><p><strong>Note:<\/strong> If the workflow has <strong>Prevent edits when using default naming<\/strong> turned on and the run uses the default name, the run name is read-only and can\u2019t be changed.<\/p><\/blockquote>\n<h3>Change the run name manually<\/h3>\n<p>From your <a href=\"https:\/\/www.process.st\/help\/docs\/reports\/\">Reports<\/a> area, click a workflow run&#8217;s name to open it, and then click on its current name to start editing and change it, as shown below:<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-17079\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/run-name-active-run.gif\" alt=\"\" width=\"100%\" \/><\/p>\n<p>Once you have edited the name, you will see a flash notification at the top of your screen &#8220;<strong>Workflow run name updated<\/strong>&#8221; which tells you that your changes have been saved.<\/p>\n<h3>Change the run name via integration or automation<\/h3>\n<p>If you&#8217;re using an integration tool like <a href=\"https:\/\/zapier.com\/\">Zapier<\/a> you can update the name of a workflow run automatically when using the step to &#8220;Update a workflow run&#8221;.<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-11188\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/Naming-via-Zapier.png\" alt=\"\" width=\"100%\" \/><\/p>\n<p><em><strong>Note:<\/strong> Your workflow run name&#8217;s character count limit is 1,024 characters, irrespective of how you update it. <\/em><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Establishing a clear naming convention for your workflow runs helps you keep processes organized, simplifies report generation, and makes it easier for your team to locate past runs. Each workflow run has a unique name distinct from its parent workflow, allowing you to track instances effectively. A workflow run&#8217;s name will be different from the [&hellip;]<\/p>\n","protected":false},"author":3,"template":"","meta":{"_acf_changed":false,"available_plan":"All plans","available_product":"Workflows","footnotes":""},"ht_kb_category":[168],"ht_kb_tag":[169,170,171],"class_list":["post-5601","ht_kb","type-ht_kb","status-publish","hentry","ht_kb_category-run-workflows","ht_kb_tag-naming","ht_kb_tag-running","ht_kb_tag-updating"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5601","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb"}],"about":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":8,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5601\/revisions"}],"predecessor-version":[{"id":10096,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5601\/revisions\/10096"}],"wp:attachment":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/media?parent=5601"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_category?post=5601"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_tag?post=5601"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}