Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions addons/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ <h1 class="text--white">ZAP Marketplace</h1>
<a class="no-border" title="Repository" href="https://github.com/zaproxy/zap-extensions/" target="_blank" rel="noopener noreferrer"><img alt="Repository" src="/img/addons/source.png" /></a>


<a class="no-border" title="Download" href="https://github.com/zaproxy/zap-extensions/releases/download/automation-v0.50.0/automation-beta-0.50.0.zap" target="_blank" rel="noopener noreferrer"><img alt="Download" src="/img/addons/download.png" /></a>
<a class="no-border" title="Download" href="https://github.com/zaproxy/zap-extensions/releases/download/automation-v0.51.0/automation-beta-0.51.0.zap" target="_blank" rel="noopener noreferrer"><img alt="Download" src="/img/addons/download.png" /></a>



Expand All @@ -535,7 +535,7 @@ <h1 class="text--white">ZAP Marketplace</h1>
automation
</td>
<td align="center">
0.50.0
0.51.0
</td>
<td >
beta
Expand All @@ -544,7 +544,7 @@ <h1 class="text--white">ZAP Marketplace</h1>
ZAP Dev Team
</td>
<td align="center">
2025-06-20
2025-07-17
</td>
</tr>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1883,7 +1883,10 @@ <h1 id="automation-framework---environment">Automation Framework - Environment</
exclude: # List of tech to exclude, as per https://www.zaproxy.org/techtags/ (just use last names)
include: # List of tech to include, should only be used when targeting specific techs, the exclude takes precedence when configuring the context.
structure:
structuralParameters: # List of names of structural parameters.
structuralParameters: # List of names of structural parameters
dataDrivenNodes: # List of data driven nodes
- name: # String, name of the data driven node
regex: # String, regex of the data driven node, must contain 2 or 3 regex groups
users: # List of one or more users available to use for authentication
- name: # String, the name to be used by the jobs
credentials: # List of user credentials - may include any required for scripts
Expand Down
5 changes: 5 additions & 0 deletions docs/desktop/addons/automation-framework/gui/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1859,6 +1859,11 @@ <h2 id="automation-tab">Automation Tab <a class="header-link" href="#automation-
<h3 id="plan-sub-tab">Plan sub-tab <a class="header-link" href="#plan-sub-tab"><svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z" fill="currentColor"/></svg></a></h3>
<p>A graphical representation of the plan which also shows the state of the plan when it is run.<br>
You can edit any of the elements of the plan by double clicking on them.</p>
<p>You can also change the following general job options via the plan table:</p>
<ul>
<li>Enabled - only jobs that are enabled will run.</li>
<li>Always Run - enabled jobs with this option will run even if the plan exits early.</li>
</ul>

<h3 id="output-sub-tab">Output sub-tab <a class="header-link" href="#output-sub-tab"><svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z" fill="currentColor"/></svg></a></h3>
<p>Any output generated when you load or run the plan.</p>
Expand Down
8 changes: 7 additions & 1 deletion docs/desktop/addons/automation-framework/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1892,7 +1892,6 @@ <h2 id="file-paths">File Paths <a class="header-link" href="#file-paths"><svg cl
<p>All file and directory paths can either be absolute or relative to the directory containing the plan. Relative paths are recommended for portability.</p>

<h2 id="jobs">Jobs <a class="header-link" href="#jobs"><svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z" fill="currentColor"/></svg></a></h2>
<p>The jobs can be enabled/disabled through the GUI and the automation plan, with the <code>enabled</code> flag. Jobs are enabled by default.</p>
<p>The following automation jobs are supported by this add-on:</p>
<ul>
<li><a href="/docs/desktop/addons/automation-framework/job-ascanconfig/">activeScan-config</a> - configures the active scanner</li>
Expand All @@ -1904,6 +1903,13 @@ <h2 id="jobs">Jobs <a class="header-link" href="#jobs"><svg class="fill-current
<li><a href="/docs/desktop/addons/automation-framework/job-exitstatus/">exitStatus</a> - sets ZAP&rsquo;s exit code based on scan results</li>
</ul>

<h3 id="gen-options">General Job Options <a class="header-link" href="#gen-options"><svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z" fill="currentColor"/></svg></a></h3>
<p>The following options can be applied to all jobs, via the automation plan or the <a href="/docs/desktop/addons/automation-framework/gui/">GUI</a>:</p>
<ul>
<li><code>enabled</code> - only jobs that are enabled will run.</li>
<li><code>alwaysRun</code> - enabled jobs with this option will run even if the plan exits early.</li>
</ul>

<h3 id="importance-of-job-order">Importance of Job Order <a class="header-link" href="#importance-of-job-order"><svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z" fill="currentColor"/></svg></a></h3>
<p>The order of jobs is relevant and important. For example:</p>
<ul>
Expand Down
Loading