Workflow Steps Reference

This topic provides details on vCommander's built-in workflow steps. Administrators can always access built-in steps in any vCommander installation.

vCommander also supports plug-in workflow steps that you may download and install as required. Plug-in steps are not covered here. For details on plug-in steps, see the readme files included with the plug-in step JAR files added to your system at <vCommander_install_directory>\tomcat\wfplugins\. See Using Plug-In Workflow Steps.

In this topic:

Overview

The steps that can be added to a workflow depend on the type of workflow. For example, in the Approval Workflow, Completion Workflow and Command Workflow wizards, the executable steps, or actions, that can be added a workflow depend on:

  • the type of workflow (for example, whether it's a workflow for a virtual service versus a VM, or a workflow for a new request versus a change request)
  • the managed system type (for example, SCVMM or AWS)

Adding actions to a workflow is optional. For some scenarios it may make sense to create a workflow without actions. For example:

  • You can set up an approval and pre-provisioning workflow whose only purpose is to deploy VMs and virtual services automatically.
  • You can set up a completion workflow that overrides a default completion workflow. For example, let's say you have set up a default VM completion workflow to run every time a new VM is provisioned, but you don't want that workflow to run on one or more specific VMs. In this case, you can configure a VM completion workflow that contains no steps — its only purpose is to override the default VM completion workflow.

Built-in vCommander workflow steps

Workflow steps that send an email

In any workflow step that sends an email, in the Address List field, enter the email account(s) to which you want any emails sent in the order you want them sent (multiple email accounts must be separated by a semi-colon). These email addresses don't have to be associated with vCommander or Service Portal accounts. They can include group accounts.

When vCommander sends an email to a group of people requesting approval for a service request, all people in that group receive the email. As soon as one person has clicked Approve on the approval landing page, other people who have received the same email are no longer able to approve the request. If multiple levels of approval are configured (meaning that multiple Send Approval Email steps were added to the approval workflow), vCommander then sends the email to the next person or group in the approver list. If the request is rejected, no other emails are sent.

If a vCommander user has Administrator access rights on the relevant managed system and their email address matches the email address in the approval workflow, the user can also view a list of service requests awaiting their approval and approve requests right in the vCommander console.

If a Service Portal user has the required permissions and their email address matches the email address in the approval workflow, the user can also view a list of service requests awaiting their approval and approve requests right in the Service Portal. The required permissions are Approve Requests, Request New Service, and Request Service Change. If the requester is a member of an organization, the approver must be a member of the same organization and must also have the Show All Organization Services permission.

Using variables to populate email addresses

Using variables to populate email addresses allows you to configure dynamic recipient lists. For example, to send the email to the primary contacts of the organization, enter the following variable in the Address List field:

#{request.requester.organization.email}

You can pass other variables into the email address field, email subject and email body.

Formatting in the email body

The <a> tag is automatically added to links in emails (only the http protocol is supported). For example, if the value of a custom attribute is a link, the value will be formatted as a link in the email.

If you don't use HTML markup in the email body, the body is assumed to be plain text; <br> and <p> tags are automatically added for new lines.

If you add HTML markup to the email body, however, no additional tags are added.