Table of Contents

Workflows

A workflow is a list of steps that SharpDay Deploy runs in order. Most workflows set up a PC. For example, they wipe the disk, install Windows and its drivers, then join the PC to a domain.

The PE client runs most of these steps on the PC. The PE client is the program that runs on the PC after it starts Windows PE from the network. The server runs some steps itself, such as sending an email.

You make and look after workflows on Automations > Automations. To set up your first PC from start to end, see Quick start: set up one PC.

Note

To make, change, run or delete a workflow, your account needs change access to Automations. Anyone who can sign in can open and export workflows. See Users and roles.

The workflow list

Each workflow in the list shows:

  • its name, and Enabled or Disabled. Only a workflow that is turned on can start by itself.
  • its tags and its description.
  • how many nodes it has. The Console calls each box in a workflow a node. Most nodes are steps.
  • how long ago it was last changed.

The line under the list says how many workflows are showing, and how many are turned on and off.

To find a workflow:

  • Type part of its name or description in Search workflows.
  • Select a tag above the list to show only the workflows with that tag. Select All to show every workflow again.
  • Use the list at the top right to sort the workflows. You can sort by when they were last changed, by name, by node count, or with the turned on workflows first.

To open a workflow in the editor, double-click it.

The workflow menu

Each workflow has a gear button on its right, called More options. Select it to see these choices:

Choice What it does
Open Opens the workflow in the editor.
Run Now Starts the workflow on the server straight away. No PC takes part, so use this for a workflow made of Server steps.
Duplicate Makes a copy with the same steps. The copy has "(Copy)" after its name. It is turned on or off, the same as the workflow it came from.
Export Saves the workflow as a .json file. You can keep it as a backup, or import it on another server.
Disable Automation or Enable Automation Turns the workflow off or on.
Delete Deletes the workflow from the server. This cannot be undone.
Tip

Export a workflow before you make big changes to it. If you do not like the changes, import the file to get the old version back as a new workflow.

New workflow

New workflow opens a window with templates to start from:

Template What it makes
Blank workflow Just a Start and an End step. It opens in the editor so you can build it yourself.
Wipe, install and join the domain Wipes the disk, installs Windows and its drivers, sets up networking from Known Clients, then joins the PC to an Active Directory domain.
Wipe, install and hand over to Autopilot Wipes the disk, installs Windows and its drivers, then restarts into the Windows setup screens. Windows Autopilot then joins the PC to Entra ID and Intune. The Autopilot settings you pick decide if it is an Entra join or a hybrid join.

In the 2 templates that wipe and install, the PC restarts at the end. If a step fails, a Send Email step sends an email with the subject "Deployment failed", and the workflow ends as failed.

To make a workflow:

  1. Select New workflow.
  2. Select a template, then select Next. You can also double-click the template.
  3. On the Name page, fill in the boxes in the table below.
  4. For a template, the next pages each ask about 1 step. Answer the questions, then select Next. On some pages you can untick a box, such as Join the domain, to leave that step out.
  5. Check the Review page, then select Make workflow. For Blank workflow, Make workflow is on the Name page.
Box on the Name page What to put
Name The name people see in the list and at the PC. You can change it later.
Description A note on what the workflow is for.
Tags Words to sort and filter workflows by, with commas between them. For example, Workstation, Domain.
Enable Workflow Leave this ticked to turn the workflow on when it is made.
Open it in the editor after it's made Leave this ticked to open the new workflow in the editor straight away.

To go back to the list of templates, select Choose another template.

The template questions

A template does not bring any images, accounts or mailboxes with it. Steps that pick one start empty, so you pick them from this server's own lists.

Page What it asks
Disk The disk number (0 is the first fixed disk), if the disk is wiped first, and the partition table (GPT or MBR). Also make a recovery partition takes 1 GB off the end of the Windows partition for a hidden recovery partition. The page lists the partitions the template makes.
Windows image The WIM image to install, its image index, and the drive letter Windows goes on, for example C:. See WIM images.
Drivers If drivers are found from the PC's model, or if every PC gets the same driver pack. See Drivers.
Networking If the PC uses the address on its Known Clients record, DHCP, or an address you type in. A PC with no record uses DHCP.
Domain The domain name, the account to join with, the OU (organisational unit) to put the PC in, and if a computer with the same name in Active Directory is replaced. PCs with a Known Clients record use the domain and OU on their record, unless you tick the boxes to always use the ones you type here.
Autopilot The Autopilot settings to use. You make these on Automations > Autopilot.
Finish What the PC does when the workflow ends: Reboot, Shutdown or Nothing.
Email The email sent when a step fails: the address it is sent from, who it goes to, the subject and the message.

Only the pages for the steps in your template show. Networking and Domain are in the domain template, and Autopilot is in the Autopilot template.

Some steps may still need changes in the editor afterwards, to suit your network.

Import a workflow

You can import a workflow file from this server or another one. The file can be one made with Export, or a file that holds only a workflow's steps.

  1. Select Import workflow.
  2. Pick the .json file.
  3. If any step picks something from the server, the Console checks it against this server's lists. This includes WIM images, driver packs, accounts, SDDN servers, mailboxes, other workflows, unattend files and Autopilot settings.
  4. If the server has everything the file picks, the workflow is imported straight away. If not, the import window opens, so you can choose what to use instead.

The import window has these pages:

  • Overview lists each step that picks something this server does not have.
  • Then there is 1 page for each of those steps. The box at the top says what is missing. Pick what this server should use instead. Or tick Leave this step as it is to keep what the file has, and change it in the editor later.
  • Review lists what will change. Tick Open it in the editor once it's imported to open the workflow straight away.

Select Import on the Review page to finish. To skip the questions and import the file just as it is, select Import as it is.

After an import:

  • The workflow is always added as a new workflow. It never replaces one you already have.
  • If the name is already in use, a number is added to it, for example Office laptops (2).
  • A message at the bottom of the page says how it went. It warns you if the file has no Start step, or if a step still picks something this server does not have. Fix these in the editor before the workflow runs.
Note

If the server does not send one of its lists in time, the steps that use that list are not checked. The message at the end of the import says which lists were not checked.

How a PC gets a workflow

Every workflow begins with a Start step. Its Trigger condition decides what starts the workflow. Only workflows that are turned on start this way.

Trigger condition When the workflow starts
PE Deployment When someone picks it at a PC.
Manually When you select Run Now, or when a Run Workflow step in another workflow runs it.
On Server Start When the SharpDay Deploy server starts and has a working licence.
Linux Install Ends When a Linux network install on a PC finishes, fails or runs out of time.

When a PC starts the PE client, the PE client shows Select Deployment. It lists every workflow that is turned on and has the PE Deployment trigger. Pick a workflow to start it. If no workflow fits, the PE client says that no deployment workflows are available on the server.

To watch a deployment while it runs, go to Clients.

Change what a workflow does on some PCs

Reroute rules do not choose the workflow. They change what a workflow does on the PCs that match a rule. You make them on the Reroute page:

  • A rule with the Source set to Workflow step can change a setting on a step with Change a workflow step property. It can also swap the image an Apply OS Image step installs with Redirect to OS image.
  • A rule with the Source set to PE Client connect can change the name offered to the PC. With Deny the request, it stops the PC from deploying.

The workflow editor

To open the editor, double-click a workflow, or select Open on its menu.

The editor has 3 parts:

  • Toolbox on the left holds the steps you can add. Drag a step onto the canvas to add it. To find a step, type in Search nodes....
  • The canvas in the middle shows the steps and the lines between them. Drag a line from a step's output to the next step's input to set the order.
  • Properties on the right shows the settings for the step or line you select.

Select the gear button next to the workflow's name to open Workflow settings. Here you can change the name, description and tags, and turn the workflow on or off.

The toolbox

The toolbox puts the steps into groups. Each group starts closed. Select a group to open it.

Group Steps that
Flow Control start and end the workflow, branch, wait, restart the PC, or run another workflow.
Disk Operations format the disk and set up its partitions.
Execution run PowerShell or CMD commands, move or delete files, edit the registry, and add, change or delete local users.
Diagnostics write to the log, pause the deployment, or send an email.
OSInstallation install Windows, choose the unattend file, add drivers, set up networking, join a domain, or move the computer to another OU.
Extras change the firewall and Windows Update, repair DNS, run a Deployment Node script, clean up, or read the PC's hardware again.
Parallel run branches at the same time, then wait for them all.
Cloud hand the PC over to Windows Autopilot.

Runs on

The Runs on switch at the top of the toolbox has 2 choices:

  • PE Client: the steps you add run on the PC.
  • Server: the steps you add run on the SharpDay Deploy server.

The toolbox only shows the steps that can run where the switch points. One workflow can have both kinds. For example, the templates run their steps on the PC, but send the failure email from the server.

These steps only show when the switch is on Server:

  • Run Workflow
  • Pause Running the Deployment
  • Send Email
  • Choose Unattend File
  • Move OU
  • Run SDDN Command. See Deployment Node.

Some steps show for both, such as Run Powershell, Run CMD and Log Message. All other steps run only on the PC.

Save your changes

Select Save, or press Ctrl+S. The bar at the top shows when you last saved, for example "Last saved: 5 minutes ago".

If a step is set to run somewhere it cannot, the editor does not save. It tells you which step to fix.

Important

Back does not save your changes. Select Save before you leave the editor.

Other tabs on this page

  • SDDN Servers: the Deployment Nodes that a Run SDDN Command step can call. See Deployment Node.
  • Credentials: saved user names and passwords that steps use to sign in, such as the account a Join Domain step joins with.
  • Email: the addresses the server sends email from, for Send Email steps and alerts.
  • Autopilot: the settings a Hand over to Autopilot step uses. Make them here, or import a file exported from Intune.
  • Alerts: emails the server sends when something happens to a PC, such as a deployment failing. An alert covers every workflow.