HarePoint Workflow Manager Extensions for SharePoint on premise

HarePoint Workflow Manager Extensions

for SharePoint on premise

Administrator’s Guide

Product version 1.2

4/4/2023

HarePoint.Com | Table of Contents

( This Page Intentionally Left Blank )

3 
Table of Contents | HarePoint.Com 
 
Table of Contents 
 
Table of Contents .......................................................................................................................................... 3 
I. Introduction ............................................................................................................................................. 13 
Description .............................................................................................................................................. 13 
II. Product Architecture ............................................................................................................................... 13 
How the product works .......................................................................................................................... 13 
III. Installation ............................................................................................................................................. 14 
Prerequisites ........................................................................................................................................... 14 
The distributive package ......................................................................................................................... 14 
Installing solution .................................................................................................................................... 15 
Checking configuration ........................................................................................................................... 18 
Trial mode and licensing ......................................................................................................................... 18 
IV. Update ................................................................................................................................................... 19 
Before updating ...................................................................................................................................... 19 
Getting the distributive package ............................................................................................................. 19 
Updating solution.................................................................................................................................... 20 
V. Uninstallation .......................................................................................................................................... 23 
General uninstall information ................................................................................................................. 23 
Deactivate features ................................................................................................................................. 23 
Remove trust ........................................................................................................................................... 24 
Retract solution ....................................................................................................................................... 25 
Remove IIS site ........................................................................................................................................ 26 
VI. Activating or deactivating custom actions on a site .............................................................................. 27 
General information ............................................................................................................................... 27 
Managing features .................................................................................................................................. 27 
VII. Security console .................................................................................................................................... 28 
General security information .................................................................................................................. 28 
Generating a token ................................................................................................................................. 29 
Using tokens ............................................................................................................................................ 30 
VIII. Licensing .............................................................................................................................................. 31 

HarePoint.Com | Table of Contents 

 
Trial mode ............................................................................................................................................... 31 
Licensing model ...................................................................................................................................... 31 
Entering license keys ............................................................................................................................... 32 
IX. Creating a workflow in SharePoint Designer ......................................................................................... 32 
Connecting SharePoint Designer ............................................................................................................ 32 
Creating a workflow ................................................................................................................................ 33 
X. List of workflow actions .......................................................................................................................... 35 
Active Directory activities ................................................................................................................... 35 
1 Add Member to Active Directory Group ....................................................................................... 35 
2 Change Active Directory Account Settings .................................................................................... 36 
3 Change Active Directory Group Settings ....................................................................................... 37 
4 Create Group in Active Directory .................................................................................................. 37 
5 Create Mail Contact in Active Directory ....................................................................................... 38 
6 Create User in Active Directory ..................................................................................................... 39 
7 Delete Group from Active Directory ............................................................................................. 39 
8 Delete User from Active Directory ................................................................................................ 40 
9 Find User in Active Directory ........................................................................................................ 40 
10 Find User in Active Directory by Query ....................................................................................... 41 
11 Get Active Directory Groups Where User is Member................................................................. 41 
12 Get E-Mails of Active Directory Group Members ....................................................................... 42 
13 Get User's Attribute from Active Directory ................................................................................ 42 
14 Get User's Manager from Active Directory ................................................................................. 43 
15 Get User's Multivalued Attribute from Active Directory ............................................................ 43 
16 Move User into Organizational Unit ........................................................................................... 44 
17 Remove Member from Active Directory Group .......................................................................... 44 
18 Set Active Directory Options ....................................................................................................... 45 
19 Set User's Attribute in Active Directory ...................................................................................... 45 
20 Set User's Multivalued Attribute in Active Directory .................................................................. 46 
21 Set User's Password in Active Directory ..................................................................................... 46 
22 Set User's Photo in Active Directory ........................................................................................... 47 
Administration activities ..................................................................................................................... 47 


Table of Contents | HarePoint.Com 
 
1 Activate Feature by GUID .............................................................................................................. 47 
2 Add User to SharePoint Group ...................................................................................................... 47 
3 Add User to SharePoint Site .......................................................................................................... 48 
4 Alternate CSS and Site Logo .......................................................................................................... 48 
5 Change SharePoint Group Owner ................................................................................................. 48 
6 Change SharePoint Group Settings ............................................................................................... 49 
7 Change SharePoint List Settings .................................................................................................... 50 
8 Create SharePoint Group .............................................................................................................. 51 
9 Create SharePoint Site .................................................................................................................. 51 
10 Create Site Collection .................................................................................................................. 52 
11 Deactivate Feature By GUID ....................................................................................................... 52 
12 Delete SharePoint Group ............................................................................................................ 53 
13 Delete SharePoint Site ................................................................................................................ 53 
14 Delete Site Collection .................................................................................................................. 53 
15 Delete Site Collection from Recycle Bin ...................................................................................... 53 
16 Deploy Theme To Web ................................................................................................................ 54 
17 Get SharePoint User Membership Status ................................................................................... 54 
18 Get Site User MultiValued Property ........................................................................................... 55 
19 Get Site User SingleValue Property ............................................................................................. 55 
20 Inject Custom CSS ....................................................................................................................... 56 
21 Remove CSS and Site Logo .......................................................................................................... 56 
22 Remove Custom Action ............................................................................................................... 56 
23 Remove User from SharePoint Group ........................................................................................ 56 
24 Remove User from SharePoint Site ............................................................................................. 57 
25 Rename Site at Url ...................................................................................................................... 57 
26 Set Master Page .......................................................................................................................... 57 
27 Set SharePoint Admin Center URL .............................................................................................. 58 
28 Set SharePoint Site Navigation Options ...................................................................................... 58 
29 Set Site Theme Based On Name ................................................................................................. 59 
Cloud Print activities ........................................................................................................................... 59 
1 Delete Print Job ............................................................................................................................. 59 

HarePoint.Com | Table of Contents 

 
2 Get Print Job Status ....................................................................................................................... 59 
3 Get Printer Status .......................................................................................................................... 60 
4 Set Printing Options ...................................................................................................................... 60 
5 Submit Print Job ............................................................................................................................ 61 
Conversion activities ........................................................................................................................... 61 
1 Convert Document ........................................................................................................................ 61 
Date/Time activities ............................................................................................................................ 63 
1 Convert Date from Local Time to UTC .......................................................................................... 63 
2 Convert Date from UTC to Local Time .......................................................................................... 63 
3 Convert Date to Text ..................................................................................................................... 64 
4 Evaluate Due Date ......................................................................................................................... 65 
5 Get Date Property ......................................................................................................................... 65 
6 Get Interval Between Dates .......................................................................................................... 66 
7 Get Working Time Between Dates ................................................................................................ 67 
8 Set DateTime Constant ................................................................................................................. 67 
Development activities ....................................................................................................................... 68 
1 Convert JSON to XML .................................................................................................................... 68 
2 Execute PowerShell Script ............................................................................................................. 69 
3 Execute SQL Command ................................................................................................................. 70 
4 Execute SQL Command into List ................................................................................................... 71 
5 Query XML..................................................................................................................................... 72 
6 Transform XML .............................................................................................................................. 74 
7 Update XML................................................................................................................................... 76 
Dictionary activities ............................................................................................................................. 78 
1 Add an Item to a Dictionary .......................................................................................................... 78 
2 Remove Duplicate Values from Dictionary ................................................................................... 79 
3 Remove Item from Dictionary ....................................................................................................... 79 
Document Library activities ................................................................................................................ 80 
1 Check In Item at URL ..................................................................................................................... 80 
2 Check Out Item at URL .................................................................................................................. 80 
3 Copy Document to List Item Attachment ..................................................................................... 80 


Table of Contents | HarePoint.Com 
 
4 Copy Folder Structure ................................................................................................................... 81 
5 Copy or Move Document .............................................................................................................. 81 
6 Copy or Move Folder ..................................................................................................................... 82 
7 Create Document from Text ......................................................................................................... 82 
8 Create Folder in the Document Library at URL ............................................................................. 83 
9 Create Link to a Document ........................................................................................................... 83 
10 Delete Folder in the Document Library at URL ........................................................................... 84 
11 Discard Check Out Item at URL ................................................................................................... 84 
12 Discard Publish Item ................................................................................................................... 84 
13 Get Document Lock Status .......................................................................................................... 84 
14 Get Entry From Folder Property Bag ........................................................................................... 85 
15 Get Text Document Content ....................................................................................................... 85 
16 Publish Item ................................................................................................................................ 85 
17 Rename Document at URL .......................................................................................................... 86 
18 Upload Net File to Document Library at URL .............................................................................. 86 
E-Mail activities ................................................................................................................................... 87 
1 Add Custom Headers to E-mail ..................................................................................................... 87 
2 Get E-mail Property ....................................................................................................................... 87 
3 Receive All E-Mails to List from IMAP Server ................................................................................ 88 
4 Receive All E-mails to List from POP3 Server ................................................................................ 89 
5 Receive E-Mail from IMAP server ................................................................................................. 90 
6 Receive E-Mail from POP3 Server ................................................................................................. 91 
7 Save E-Mail Attachments to List Item ........................................................................................... 93 
8 Send E-Mail with Document as Attachment ................................................................................. 93 
9 Send E-Mail with Http Files Attachments ..................................................................................... 94 
10 Send E-Mail with List Item Attachments ..................................................................................... 94 
11 Send E-Mail with SharePoint Attachments ................................................................................. 95 
12 Send E-Mail with Word Document as a Body ............................................................................. 96 
13 Send E-Mail without Attachments .............................................................................................. 97 
14 Set E-mail Delivery and Processing Options ............................................................................... 98 
15 Set SMTP Server Options ............................................................................................................ 99 

HarePoint.Com | Table of Contents 

 
Exchange activities .......................................................................................................................... 100 
1 Cancel Exchange Calendar Item ................................................................................................ 100 
2 Create Exchange Calendar Item ................................................................................................ 101 
3 Delete Exchange Calendar Item ................................................................................................ 101 
4 Update Exchange Calendar Item ............................................................................................... 102 
5 Update Exchange Calendar Item Advanced Properties ............................................................ 102 
6 Update Exchange Calendar Item Attendees ............................................................................. 103 
Images activities .............................................................................................................................. 104 
1 Convert Image ........................................................................................................................... 104 
2 Flip Image .................................................................................................................................. 104 
3 Get EXIF Property from Image .................................................................................................. 105 
4 Get Image Size ........................................................................................................................... 106 
5 Get Image Type ......................................................................................................................... 106 
6 Get XMP Property ..................................................................................................................... 109 
7 Resize Image ............................................................................................................................. 109 
8 Rotate Image ............................................................................................................................. 110 
9 Set EXIF Property on Image ....................................................................................................... 111 
10 Set Image Transparent Color .................................................................................................. 111 
11 Set XMP Property .................................................................................................................... 112 
Lists activities .................................................................................................................................. 112 
1 Add Content Type to List ........................................................................................................... 112 
2 Add Existing Column to Content Type ...................................................................................... 112 
3 Approve Item at URL ................................................................................................................. 113 
4 Copy List Item at URL ................................................................................................................ 113 
5 Copy List Item Attachments to Document Library .................................................................... 113 
6 Copy List Item Attachments to List Item ................................................................................... 114 
7 Create Content Type ................................................................................................................. 114 
8 Create List ................................................................................................................................. 115 
9 Create List Item at URL.............................................................................................................. 115 
10 Create Site Column ................................................................................................................. 116 
11 Delete Entire SharePoint List at Url ........................................................................................ 117 


Table of Contents | HarePoint.Com 
 
12 Delete Item at URL .................................................................................................................. 117 
13 Find List Item by CAML ............................................................................................................ 117 
14 Get Field Value at URL ............................................................................................................ 118 
15 Get List Item Attachments ...................................................................................................... 118 
16 Get List Item URL ..................................................................................................................... 118 
17 Get List URL ............................................................................................................................. 119 
18 Loop Through and Update List Items ...................................................................................... 120 
19 Move List Item to Subfolder ................................................................................................... 122 
20 Reject Item at URL................................................................................................................... 122 
21 Remove All Attachments......................................................................................................... 122 
22 Remove Content Type from List ............................................................................................. 123 
23 Set Content Type Document Template ................................................................................... 123 
24 Set Default Content Type on List ............................................................................................ 123 
25 Update List Item at URL .......................................................................................................... 124 
Network activities ........................................................................................................................... 125 
1 Create Directory on FTP Server ................................................................................................. 125 
2 Delete Directory from FTP Server ............................................................................................. 125 
3 Delete File from FTP Server ...................................................................................................... 126 
4 Download Document from FTP Server ..................................................................................... 126 
5 Download Documents from FTP Folder .................................................................................... 127 
6 Fetch RSS Feed to Html ............................................................................................................. 127 
7 Fetch RSS Item .......................................................................................................................... 128 
8 Send HTTP GET Request ............................................................................................................ 128 
9 Send HTTP OAuth Request ........................................................................................................ 129 
10 Send HTTP POST Request ........................................................................................................ 131 
11 Send XMPP Instant Message ................................................................................................... 132 
12 Set FTP Server Options ............................................................................................................ 132 
13 Set OAuth Authentication ....................................................................................................... 133 
14 Shorten Url .............................................................................................................................. 134 
15 Upload Document to FTP Server ............................................................................................. 134 
16 Upload Documents to FTP Folder ........................................................................................... 135 

HarePoint.Com | Table of Contents 

 
17 Upload List Item Attachments to FTP Server .......................................................................... 135 
Office activities ................................................................................................................................ 136 
1 Accept Revision Changes in Word Document ........................................................................... 136 
2 Add Digital Signature ................................................................................................................ 136 
3 Add New Row into Word Document ........................................................................................ 137 
4 Add Watermark to Word Document ........................................................................................ 137 
5 Find Text in Word Document .................................................................................................... 138 
6 Get Excel Cell Value ................................................................................................................... 138 
7 Get Office Document Property ................................................................................................. 138 
8 Get Word Document Page Count ............................................................................................. 139 
9 Read Word Document .............................................................................................................. 140 
10 Read Word Document To Text ................................................................................................ 140 
11 Replace External Hyperlink in Word Document ..................................................................... 140 
12 Replace Text in Word Document ............................................................................................ 141 
13 Set Excel Cell Value ................................................................................................................. 142 
14 Set Office Document Property ................................................................................................ 142 
15 Update Multiple Fields in Word Document ............................................................................ 143 
16 Update Picture in Word Document ........................................................................................ 144 
17 Update Word Document ......................................................................................................... 145 
Pdf activities .................................................................................................................................... 147 
1 Add Image Watermark to PDF .................................................................................................. 147 
2 Add PDF Letterhead .................................................................................................................. 148 
3 Add Text Watermark to PDF ..................................................................................................... 148 
4 Merge PDF Documents ............................................................................................................. 149 
5 Sign PDF Document ................................................................................................................... 149 
6 Split PDF Documents ................................................................................................................. 150 
Permissions activities ...................................................................................................................... 151 
1 Change Permissions Inheritance at URL ................................................................................... 151 
2 Delete All Permissions at URL ................................................................................................... 151 
3 Delete All User Permissions at URL ........................................................................................... 152 
4 Delete Permissions at Url .......................................................................................................... 152 


Table of Contents | HarePoint.Com 
 
5 Grant Permissions at Url ........................................................................................................... 152 
Social activities ................................................................................................................................ 153 
1 Create Group in Yammer .......................................................................................................... 153 
2 Create MailChimp Campaign .................................................................................................... 153 
3 Create User in Yammer ............................................................................................................. 154 
4 Delete MailChimp Campaign .................................................................................................... 155 
5 Delete User from Yammer ........................................................................................................ 155 
6 Follow user/site/tag/document in SharePoint ......................................................................... 155 
7 Get User's Property from Yammer............................................................................................ 156 
8 Invite User to Yammer .............................................................................................................. 156 
9 Publish Message to Social Media via dlvr.it .............................................................................. 156 
10 Publish Message to Yammer ................................................................................................... 157 
11 Replicate MailChimp Campaign .............................................................................................. 157 
12 Schedule MailChimp Campaign .............................................................................................. 158 
13 Send MailChimp Campaign ..................................................................................................... 159 
14 Send Twitter Message ............................................................................................................. 159 
15 Set User's Property in Yammer ............................................................................................... 161 
16 Stop following user/site/tag/document in SharePoint ........................................................... 161 
17 Subscribe to MailChimp List .................................................................................................... 162 
18 Unsubscribe from MailChimp List ........................................................................................... 162 
19 Update Group in Yammer ....................................................................................................... 163 
Strings activities .............................................................................................................................. 163 
1 Capture All Occurrences of Text ............................................................................................... 163 
2 Capture Text with Regular Expression ...................................................................................... 164 
3 Convert Base64 to Text ............................................................................................................. 165 
4 Convert HTML To Text .............................................................................................................. 166 
5 Convert Number To Text ........................................................................................................... 166 
6 Convert Text Case ..................................................................................................................... 167 
7 Convert Text to Base64 ............................................................................................................. 167 
8 Decode Web Text ...................................................................................................................... 168 
9 Encode Web Text ...................................................................................................................... 169 

HarePoint.Com | Table of Contents 

 
10 Evaluate Mathematical Expression ......................................................................................... 170 
11 Extract Substring ..................................................................................................................... 171 
12 Get Random Number .............................................................................................................. 171 
13 Get Random String .................................................................................................................. 172 
14 Get String Length .................................................................................................................... 172 
15 Join Text .................................................................................................................................. 172 
16 Log to History List (HarePoint) ................................................................................................ 173 
17 Replace Text with Regular Expression .................................................................................... 173 
18 Set Regular Expression Options .............................................................................................. 174 
19 Split Text.................................................................................................................................. 175 
20 Trim Text ................................................................................................................................. 175 
Taxonomy activities ........................................................................................................................ 176 
1 Add Language To Term Store .................................................................................................... 176 
2 Create Taxonomy Group ........................................................................................................... 176 
3 Create Taxonomy Term ............................................................................................................. 177 
4 Create Taxonomy Term Set ....................................................................................................... 177 
5 Delete Taxonomy Group ........................................................................................................... 178 
6 Delete Taxonomy Term ............................................................................................................. 178 
7 Delete Taxonomy Term Set ....................................................................................................... 178 
8 Update Taxonomy Group .......................................................................................................... 179 
9 Update Taxonomy Term ........................................................................................................... 179 
10 Update Taxonomy Term Set ................................................................................................... 180 
Workflow activities ......................................................................................................................... 180 
1 Get Workflow Status ................................................................................................................. 180 
2 Set Authentication .................................................................................................................... 181 
3 Start Workflow .......................................................................................................................... 182 
4 Terminate Workflow ................................................................................................................. 183 
Appendix A. Technical support ................................................................................................................. 184 
 
   

I. Introduction | HarePoint.Com

I. Introduction

Description

HarePoint Workflow Manager Extensions for SharePoint on premise is a software product that vastly

expands the capabilities of SharePoint Designer to create the “2013 workflow platform” type workflows

for SharePoint and in the most of cases allows avoiding custom development and coding to achieve

almost any scenario.

The product offers a wide range of ready-to-use workflow actions with a fundamentally new

functionality to workflows, such as: managing document libraries and lists, reading and writing

Microsoft Office documents, document conversion to PDF and other formats, image conversion,

processing and resizing, SharePoint administration, executing SQL commands, operating through

networking protocols, such as HTTP, SMTP, POP3, FTP, RSS, XMPP and Twitter, improved activities for

sending and receiving e-mails, finally a large set of actions that facilitate work with dictionaries, strings

and regular expressions, date and time.

The product is fully supported by all Microsoft workflow development tools and there is no need to

adapt the existing workflows, or migrate them to a new development environment.

The key features of HarePoint Workflow Extensions are:

✓ easy, quick and trouble-free deployment and update

✓ complete integration with SharePoint Designer which is a freeware and widely used tool, thus

minimum training costs

✓ over 240 custom actions in addition to the built-in actions in SharePoint Designer

✓ full support in SharePoint Designer

✓ the custom actions are also supported by HarePoint Workflow Designer

II. Product Architecture

How the product works

The “2013 workflow platform” type workflows run on a separate engine, which is called Workflow

Manager. Since this engine is technically no longer a part of SharePoint (unlike the “2010 workflow

platform”), it provides a set of advantages, such as improved performance, reliability, scalability, and

control of the workflows.

HarePoint Workflow Manager Extensions product installs the following set of components:

• SharePoint application that contains workflow actions definitions used by SharePoint Designer

or HarePoint Workflow Designer

• IIS site that hosts the engine for HarePoint Workflow Manager Extensions

• Small SQL database to keep the workflow data and cache

HarePoint.Com | III. Installation

• Certificates used to establish Trust relationship to exchange data securely between Workflow

Manager and HarePoint Workflow Manager Extensions engines

User creates a workflow using SharePoint Designer or HarePoint Workflow Designer, where the

additional actions from HarePoint Workflow Manager Extensions are available in 19 new categories.

When a workflow is executed by a Workflow Manager engine, once it reaches the custom action from

HarePoint, the data are sent to the HarePoint workflow engine, then a response with the action results

is returned to the Workflow Manager and the workflow continues.

The process of exchanging data with the HarePoint workflow engine is completely seamless and remains

unnoticed for SharePoint users and administrators, thus retaining the experience of working with native

SharePoint workflows.

III. Installation

Prerequisites

Note: You need to have a farm administrator permissions on your SharePoint farm to install the

product.

• Windows Server 2008 or newer

• SharePoint 2013/2016/2019/SE

• IIS 7.5 or newer

• .NET Framework 4.6.1 and above is required

• Web Deploy 3.6 and above is required

• The 64-bit edition of SQL Server 2008 R2 or newer

The distributive package

The latest version of the product can be downloaded using the following direct link:

https://www.harepoint.com/DownloadProducts/HarePointWorkflowExtensions2016.zip

Unpack the zip file to a new folder on the server where the installation will be initiated.

The distributive package contains:

• Resources folder – contains all the necessary resource files for the deployment. Specifically, this

is a default location for certificate files (.cer and .pfx) that will be created upon installation, and

may later be used for installing product updates.

• Install.ps1 – the main PowerShell script file used to conduct the installation or update

procedures.

III. Installation | HarePoint.Com

• Install.txt – the file with the most detailed and up-to-date instructions on how to use the

current version of the Install.ps1 script. Please read carefully before proceeding with the

installation or update!

• Install.Parameters.config – the configuration file that is created automatically when the

Install.ps1 script is running. It stores the parameters used previously to run installation or

update again with the same parameters.

• Install.log – the log file that will be created automatically when the Install.ps1 script is running.

This is the full log of the installation process, with all the parameters used and all the script

outputs. This file can be used for further technical reference.

• ReadMe.txt - the file containing the version number of the given release.

Installing solution

The product is installed using the fully automated PowerShell script.

Open the PowerShell Console and navigate to the folder where you have unzipped the distributive

package (see previous paragraph).

Run the installation script using the following command:

\.Install.ps1

Note: The script saves parameters from the previous run, so if you have already executed the script

earlier, it will first prompt if the same parameters should be used, or if you would like to specify

all the parameters from scratch:

Enter “n” to start from scratch (or “y” to proceed with the indicated settings).

Choose the installation mode:

HarePoint.Com | III. Installation

1. Full – in this mode, all the components will be installed, including both the IIS site hosting the

HarePoint workflow engine and the SharePoint app with action definitions and management

pages will be deployed (effectively, it combines the modes 2 and 3 below).

2. Workflow actions IIS web site – in this mode, only the IIS site hosting the HarePoint workflow

engine will be installed

3. SharePoint package with action definitions and management pages - in this mode, only the

SharePoint WSP package will be deployed

Depending on your deployment scenario and farm topology, you may be installing these components

either to a single server (mode 1, the simplest case), or to different servers (modes 2 and 3).

In this example we will proceed with the default Full mode – enter “1”:

The script prompts for the path where the certificate file (.pfx) is located.

Since this is a new install, the file does not yet exist, so simply click enter.

Provide the password for the newly created certificate:

The new certificate file (.pfx) will be created.

Note: be sure to remember the certificate password – it may be needed afterwards during the product

update or reinstall.

At the next step, specify the name for the IIS site that will host the HarePoint workflow engine or keep it

default Hwe2013:

The next step is to create or connect to a SQL database that will be used to store the workflow statuses

and cache. Specify the SQL server name, including the instance name, if necessary:

Then specify the SQL database name, or keep it default Hwe2013StateStorage:

III. Installation | HarePoint.Com

After successful connection to the database, the script will proceed to deploying the IIS site.

Specify the port number to configure the site binding, or keep it default 8187:

The installation process will continue; this may take some time.

The script will be updating you about the status:

The final step is to validate the installation and activate the product.

Enter the SharePoint site URL where the custom workflow actions from HarePoint Workflow Manager

Extensions will be used:

Note: if you need to have the custom actions from HarePoint Workflow Manager Extensions available

on other SharePoint sites as well, please follow the instructions of the VI. Activating or

deactivating custom actions on a site chapter, after completing the installation.

HarePoint.Com | III. Installation

The product installation is now complete.

You can close the PowerShell console window.

The installation process log has been saved to Install.log file in the same folder where the script is

located. Keep this file for further technical reference.

Checking configuration

After the installation, check the URL of the HarePoint Workflow Manager Extensions IIS site in the

product settings.

Open Central Administration – HarePoint Workflow Extensions 2013/2016:

The URL and port number need to correspond to the settings of the HWE2013 (default name) site in IIS

Manager, site bindings:

Trial mode and licensing

If the product is installed for the first time on this farm, the 30-days trial mode will be activated.

For details on licensing and instructions to enter the license keys, refer to the VIII. Licensing section.

IV. Update | HarePoint.Com

IV. Update

Before updating

We constantly work on HarePoint Workflow Manager Extensions, introducing new workflow actions,

and extending the capabilities of the existing ones.

We recommend having an up-to-date version of HarePoint Workflow Manager Extensions installed.

Current version

You can review the currently installed version in Central Administration – HarePoint Workflow

Extensions 2013/2016:

Requirements

You need to have a farm administrator permissions on your SharePoint farm to update the product.

Getting the distributive package

The latest version of the product can be downloaded using the following direct link:

https://www.harepoint.com/DownloadProducts/HarePointWorkflowExtensions2016.zip

Unpack the zip file to a new folder on the server where the installation will be initiated.

The distributive package contains:

• Resources folder – contains all the necessary resource files for the deployment.

Note: this is a default location for certificate files (.cer and .pfx) that are created upon

installation, so it is convenient to copy them from the previously used distributive package to

the new one before starting an update.

• Install.ps1 – the main PowerShell script file used to conduct the installation or update

procedures.

• Install.txt – the file with the most detailed and up-to-date instructions on how to use the

current version of the Install.ps1 script. Please read carefully before proceeding with the

HarePoint.Com | IV. Update

installation or update!

• Install.Parameters.config – the configuration file that is created automatically when the

Install.ps1 script is running. It stores the parameters used previously to run installation or

update again with the same parameters.

Note: It may be convenient to copy this file from the previously used distributive package to

the new one before starting an update, to use the same parameters

• Install.log – the log file that is created automatically when the Install.ps1 script is running. This is

the full log of the update process, with all the parameters used and all the script outputs. This

file can be used for further technical reference.

• ReadMe.txt - the file containing the version number of the given release.

Updating solution

The product is updated using the fully automated PowerShell script.

Open the PowerShell Console and navigate to the folder where you have unzipped the distributive

package (see previous paragraph).

Run the installation script using the following command:

\.Install.ps1

Note: The script saves parameters from the previous run in Install.Parameters.config file, so if you have

already executed the script earlier, it will first prompt if the same parameters should be used, or if

you would like to specify all the parameters from scratch:

Enter “n” to start from scratch (or “y” to proceed with the indicated parameters).

Choose the update mode:

IV. Update | HarePoint.Com

1. Full – in this mode, all the components will be update, including both the IIS site hosting the

HarePoint workflow engine and the SharePoint app with action definitions and management

pages will be deployed (effectively, it combines the modes 2 and 3 below).

2. Workflow actions IIS web site – in this mode, only the IIS site hosting the HarePoint workflow

engine will be updated

3. SharePoint package with action definitions and management pages - in this mode, only the

SharePoint WSP package will be updated

Depending on your deployment scenario and farm topology, these components can be deployed either

to a single server (mode 1, the simplest case), or to different servers (modes 2 and 3). The update would

need to be installed accordingly.

There can be recommendations from HarePoint Technical Support if it’s sufficient to update just one of

the components in this release, so you could be running the partial update (mode 2 or mode 3) rather

than the full update (mode 1).

In this example we will proceed with the default Full mode – enter “1”:

The script prompts for the path where the certificate file (.pfx) is located.

If you have copied the .pfx file from the previous distributive package, then you can specify the path to

it. Alternatively, if you don’t have it, simply continue and the new .pfx file will be created.

Provide the password for the certificate:

Note: be sure to remember the certificate password – it may be needed afterwards during the product

update or reinstall.

At the next step, specify the name for the IIS site that hosts the HarePoint workflow engine or use the

default name Hwe2013:

The next step is to connect to a SQL database that stores the workflow statuses and cache.

Specify the SQL server name, including the instance name, if necessary:

HarePoint.Com | IV. Update

Then specify the SQL database name, or use the default name Hwe2013StateStorage:

After successful connection to the database, the script will proceed to redeploying the IIS site.

Specify the port number to configure the site binding, or use the default port 8187:

The installation process will continue; this may take some time.

The script will be updating you about the status:

The final step is to validate the installation and activate the product.

Enter the SharePoint site URL where the custom workflow actions from HarePoint Workflow Manager

V. Uninstallation | HarePoint.Com

Extensions are used:

The installer will then display a warning that you are about to recycle the “HarePoint Workflow

Extensions 2013 Actions” site level feature – confirm this with entering “y”. Recycling is needed to apply

changes.

Note: if you’re using workflows with HarePoint Workflow Manager Extensions actions on other sites, be

sure to recycle the site feature manually on those sites to apply changes. For more details, refer to

Managing features chapter.

The product update is now complete.

You can close the PowerShell console window. The update process log has been saved to Install.log file

in the same folder where the script is located.

V. Uninstallation

General uninstall information

Uninstalling HarePoint Workflow Extensions will not remove or affect any of the existing workflows in

any way.

The workflows containing HarePoint actions will not be functional after the uninstallation.

If you reinstall HarePoint Workflow Manager Extensions afterwards, the functionality of the workflows

containing HarePoint actions will be restored, without the need to republish the workflows.

To uninstall HarePoint Workflow Manager Extensions completely, follow the steps, as described in the

following paragraphs.

Deactivate features

The availability of custom actions from HarePoint Workflow Manager Extensions is managed individually

per each site by the site feature:

• HarePoint Workflow Extensions 2013 Actions

HarePoint.Com | V. Uninstallation

This feature needs to be deactivated on each site where it was activated.

Open the SharePoint site, navigate to Site Settings:

Click Manage site features under Site Actions:

Scroll down to find the HarePoint Workflow Extensions 2013 Actions feature:

Deactivate this feature.

Remove trust

Navigate to Central Administration – Security – General Security – Manage trust:

V. Uninstallation | HarePoint.Com

Click on HarePoint Workflow Extensions 2013 STS cert, then click Delete button on a ribbon:

Alternatively, you can use the following PowerShell command:

Remove-SPTrustedRootAuthority -Identity "HarePoint Workflow Extensions 2013

STS cert"

Retract solution

Navigate to Central Administration – System settings – Farm Management – Manage farm solutions:

HarePoint.Com | V. Uninstallation

Click on hwe2013.wsp.

In the Solution Properties, click Retract solution:

After the solution is retracted, you can click Remove solution.

Alternatively, you can use the two PowerShell commands:

Uninstall-SPsolution -identity “hwe2013.wsp”

Remove-SPsolution -identity “hwe2013.wsp”

Remove IIS site

Open IIS Manager, expand Sites.

Locate the HWE2013 site, right-click it and select Remove:

VI. Activating or deactivating custom actions on a site | HarePoint.Com

Note: “HWE2013” is a default name of the site; a different site name could have been assigned while

installing the product. For more details on the installation process, refer to Install.log file from the

distributive package that was used for installation.

The product is now completely removed from your SharePoint farm.

VI. Activating or deactivating custom actions on a site

General information

The availability of custom actions from HarePoint Workflow Manager Extensions is managed individually

per each site by the site feature:

• HarePoint Workflow Extensions 2013 Actions

This feature is automatically activated on the site that was specified during the last step of installation

process.

However, if you need to have HarePoint Workflow Manager Extensions actions available on other sites

as well, the site feature there needs to be activated manually, see next section.

Managing features

Follows these steps to make HarePoint Workflow Manager Extensions actions available on a specific

site:

HarePoint.Com | VII. Security console

Open the SharePoint site, navigate to Site Settings:

Click Manage site features under Site Actions:

Scroll down to find the HarePoint Workflow Extensions 2013 Actions feature:

Activate the HarePoint Workflow Extensions 2013 Actions feature.

Restart SharePoint Designer if necessary. The custom actions from HarePoint Workflow Manager

Extensions will now become available for workflows on this site.

If you need to disable the custom actions on this site, deactivate the HarePoint Workflow Extensions

2013 Actions feature:

VII. Security console

General security information

With HarePoint Workflow Manager Extensions actions it is possible to interact with various services that

require authentication (SharePoint sites, FTP, SQL, PowerShell, SMTP, and so on).

For improved security, HarePoint Workflow Manager Extensions do not allow transferring credentials in

clear text; the main approach is based on using tokens.

VII. Security console | HarePoint.Com

Tokens (to access a service) can be generated on the Security console, and then used in Set

Authentication action in a workflow to pass it to the corresponding workflow action, as described

below.

Generating a token

Open the SharePoint site, navigate to Site Settings:

Under Site Administration, click HarePoint Workflow Extensions Security Settings:

The Security console page will open:

In this Security console, you can generate the following tokens:

HarePoint.Com | VII. Security console

• SharePoint – to access the current SharePoint site:

• Login&Password – to access any service using login and password (including SharePoint sites

too):

• PrintNode – to interact with Google Could Print service:

Using tokens

To deliver the tokens obtained on the Security console to the workflow actions using them, a special

workflow action is used – Set Authentication (located under Workflows category):

VIII. Licensing | HarePoint.Com

This action should be placed above all other actions requesting authentication.

In the action, select the service to authenticate to, and then paste the token to the first parameter of

the action:

Note: to simplify access to the current SharePoint site to interact with its lists and libraries, HarePoint

Workflow Manager Extensions implement a special mechanism called Autologon. With the help of this

mechanism, in most cases using the Set Authentication action + token for the current SharePoint site is

not needed in a workflow.

However, it may still be required in some cases, so if the workflow fails and history log indicates

“Authentication is required”, simply generate a token and add the Set Authentication action to the

workflow.

VIII. Licensing

Trial mode

If the product is installed for the first time on this farm, the 30-days trial mode will be activated.

The trial mode is fully functional, and HarePoint Workflow Manager Extensions actions can be used

without any limitations.

Licensing model

The product is licensed based on the number of Web Front-End* servers in your farm. Each server

requires a separate license key that needs to be entered on a licensing page.

*The server is identified as Web Front-End server if it has “SharePoint Foundation Web Application” service running (Central

Administration – Manage servers in this farm). In some cases, this service may be running also on Application servers – please

contact HarePoint Support for further guidance.

The number of workflows using HarePoint Workflow Manager Extensions is not limited.

HarePoint.Com | IX. Creating a workflow in SharePoint Designer

Entering license keys

The licensing page for HarePoint Workflow Manager Extensions is located in Central Administration

under HarePoint Software Management:

Click the HarePoint Workflow Extensions 2013/2016 link:

Note the number of servers detected, each requiring a separate license key (see previous paragraph for

more details).

Enter the corresponding number of license keys, delimited by a semicolon (;) then click Save.

Note: if there are less license keys entered than number of servers detected, the product will switch

either to trial mode or to trial mode expired. With the trial mode expired, the product is not functional.

For any questions regarding the licensing or entering license keys, please contact HarePoint Technical

Support.

IX. Creating a workflow in SharePoint Designer

Connecting SharePoint Designer

As soon as the product in installed, you can start creating workflows that will use HarePoint Workflow

Manager Extensions actions.

This can be done using the standard tool – SharePoint Designer, or a freeware graphical designer from

HarePoint – HarePoint Workflow Designer.

Launch SharePoint Designer and click Open Site:

IX. Creating a workflow in SharePoint Designer | HarePoint.Com

Enter the URL of the SharePoint site.

Click on Workflows in the Navigation pane:

Your existing workflows (if any) will be displayed in the right pane:

Creating a workflow

Decide what workflow type you need, and click the respective button on the ribbon:

HarePoint.Com | IX. Creating a workflow in SharePoint Designer

For List workflow, point to a list or document library this workflow should refer to.

Enter the name for the new workflow. Make sure the Platform Type is set to SharePoint 2013

Workflow:

New workflow will be created and opened for editing.

Go to Actions drop-down and click on All actions to show all available workflow categories. You will see

19 categories from HarePoint Workflow Extensions:

X. List of workflow actions | HarePoint.Com

Refer to the detailed description of each workflow action and all its parameters in the next chapter List

of workflow actions.

X. List of workflow actions

1. Active Directory activities

1.1 Add Member to Active Directory Group

This workflow action is used to add one or several users or groups to specified Active Directory security

or distribution group.

Mail contacts also can be added.

Note: In order to specify AD credentials, add the Set Authentication activity to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Add current user to members of specified group in Active Directory.

HarePoint.Com | X. List of workflow actions

Parameters:

current user - Logon name of the user or group: DOMAIN\user or user@domain.com. Leave the field

empty to add the current user.

To add multple users, provide their logon names semicolon-delimited:

mapilab\test1;mapilab\test2;mapilab\test3

To add mail contacts, provide the e-mail address of a contact.

specified - Logon name of the group: DOMAIN\group or group@domain.com.

1.2 Change Active Directory Account Settings

This workflow action is used to enable or disable a user account or to change its settings.

See Also: Create User in Active Directory

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Change logon name account settings: enable, change password at next logon: keep existing, password

never expires: keep existing, account expires: keep existing

Parameters:

logon name - Logon name of the user: DOMAIN\user or [email protected]m.

enable/disable - Enable or disable user account.

change password - User must change password at next logon: yes/no or keep existing settings

password never expires - Password never expires: yes/no or keep existing settings.

account expires: yes - Select if the account expires: yes/no or keep existing settings.If Yes is selected,

please specify the expiry date in the next parameter.

on this date - specify the expiry date of the account, if this account expires (previous parameter set to

Yes).

X. List of workflow actions | HarePoint.Com

1.3 Change Active Directory Group Settings

This workflow action is used to change the Active Directory group settings.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Change specified group settings, group type: keep existing, description: keep existing, email: keep

existing

Parameters:

specified group - specify an AD group name that needs to be changed.

group type: keep existing - (optional) if a group type needs to be changed, select the new group type

from a drop-down list.

The available options are:

• unversal security group

• global security group

• domain local security group

• universal distribution group

• global distribution group

• domain local distribution group

description: keep existing - (optional) if a group description needs to be changed, specify the new group

description.

email: keep existing - (optional) if a group email address needs to be changed, specify the new group

email address.

1.4 Create Group in Active Directory

This workflow action will create a new group in the specified Active Directory container.

HarePoint.Com | X. List of workflow actions

See also: "Find Group in Active Directory" action can be used prior to this action to check if the AD group

already exists.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Create new group in this container with specified group name.

Parameters:

this - Distinguished name of the Active Directory container: OU=Test,DC=domain,DC=com. Use Active

Directory Explorer to get correct path: http://technet.microsoft.com/en-us/sysinternals/bb963907

specified - Logon name of the group: DOMAIN\group or group@domain.com.

1.5 Create Mail Contact in Active Directory

This workflow action creates a new mail contact in Active Directorywith specified parameters.

Create new contact in this container with specified name, this display name, this alias, this external e-

mail, mail enable: yes.

Parameters:

this container - Specify the distinguished name or canonical name of the container where the contact

will be created.

with specified name - Specify the name for the contact object in AD

this display name - Specify the name that will be displayed to the user.

this alias - (for mail-enabled contacts only) The internal e-mail address of the contact.

this external e-mail - External e-mail address (outside of organization).

mail enable: yes - Enable (or disable) receiving e-mails to this contact via Microsoft Outlook and

Microsoft Exchange.

X. List of workflow actions | HarePoint.Com

1.6 Create User in Active Directory

This workflow action creates a new user account in a specified Active Directory container. The newly

created account will be enabled; you can disable the account and change its settings with Change Active

Directory Account Settings action.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Create new user in this container with specified logon name, this first name, this last name, this

password. Optional: use this as user principal name.

Parameters:

this container - Distinguished name of the Active Directory container, like OU=Test,DC=domain,DC=com.

specified - User's logon name. Domain name in the user's logon name is ignored (correct syntax is

DOMAIN\username or username@domain).

Important note: Logon name is technically limited to 20 characters. If you need to have a longer name,

specify here only the first 20 characters of user logon name (or just any random characters) and use the

optional parameter "user principal name" to specify a longer name, see below.

this first name - User's first name.

this last name - User's last name.

this password - User's password. Password may be blank. Use Change Active Directory Account Settings

to ask the user to change the password at first logon.

use this as user principal name - (optional) Specify user principal name that can be used instead of user

logon name.

Note: user principal name is technically limited to 64 characters.

1.7 Delete Group from Active Directory

This workflow action will delete a specified security or distribution group from Active Directory.

Note: In order to specify AD credentials, add the Set Authentication activity to the workflow step first.

Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in the

case of an impersonation step.

HarePoint.Com | X. List of workflow actions

Delete group with this group name from Active Directory.

Parameters:

this - Logon name of the group: DOMAIN\group or gr[email protected]om.

1.8 Delete User from Active Directory

This workflow action will delete a specified user from Active Directory.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Delete user with this logon name from Active Directory.

Parameters:

this - Logon name of the user: DOMAIN\user or user@domain.com.

1.9 Find User in Active Directory

This workflow action is used to find a SharePoint user in Active Directory and store the user's logon

name in the output variable. The action returns an empty string if the user is not found in Active

Directory.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Find current user in Active Directory and store logon name in Variable: variable.

Parameters:

current user - Name of SharePoint user.

Variable: variable - Output string variable with a logon name like DOMAIN\username. Or empty string if

user is not found in Active Directory.

X. List of workflow actions | HarePoint.Com

1.10 Find User in Active Directory by Query

This workflow action is used to find a user or group in Active Directory by a specified query. You can use

two type of queries.

First is simple query - the format in the style of ab INI file:

<AD_attribute_name1>=<value1>

<AD_attribute_name2>=<value2>

For example:

displayName=John Smith

Second, is LDAP format. For example:

(&(objectCategory=user)(objectClass=user)(displayName=John Smith)(department=Marketing))

Find user in Active Directory by simple query using this query and store logon name in Variable: variable.

Parameters:

simple query - One of the following query types:

• simple query (for .INI-style query)

• LDAP filter (for LDAP query)

this query - String with the query.

Variable: variable - Output string variable with a logon name like DOMAIN\username. Empty string if

user is not found in Active Directory.

1.11 Get Active Directory Groups Where User is Member

This workflow action will return the list of groups where specified user is a member.

Note: In order to specify AD credentials, add the Set Authentication activity to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Get list of the Active Directory groups where user current user is member. Store list of these groups in

Variable: GroupsDictionary, success of the searching in Variable: UserFound.

Parameters:

HarePoint.Com | X. List of workflow actions

current user - The name of Active Directory user for reading names of his groups (like

DOMAIN\Account). Leave the field empty to use current user.

Variable: GroupsArray - Output dicionary variable with the list of groups.

Variable: UserFound - Output boolean variable, true indicates that user was found in Active Directory.

1.12 Get E-Mails of Active Directory Group Members

This workflow action returns the email addresses of an Active Directory group's members to a dictionary

variable.

Note: In order to specify AD credentials, add the Set Authentication activity to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Get user e-mails from specified group. Expand nested groups: No. Store result in Variable: EmailsArray.

Parameters:

specified group - Name of the group from which we want to read member e-mails (like:

DOMAIN\group).

expand nested groups - Include or not members of nested groups.

Variable: EmailsArray - Output array variable with the list of the e-mails of Active Directory group

members.

1.13 Get User's Attribute from Active Directory

This workflow action will return the value of a user's specified Active Directory user attribute.

Note: In order to specify AD credentials, add the Set Authentication activity to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

See Also: Get User's Multivalued Attribute from Active Directory.

Note: to get attribute of any other AD object, refer to "Get Object’s Attribute from Active Directory"

action.

Get this attribute of current user from Active Directory. Store attribute value in Variable: variable1,

success of searching in Variable: variable2

X. List of workflow actions | HarePoint.Com

Parameters:

this attribute - Name of the attribute.

current user - Name of the user from which we want to read the attribute value (like DOMAIN\Account).

Leave the field empty to use the current user.

Variable: variable1 - Output variable for the obtained attribute value.

Variable: variable2 - Output boolean variable, true indicates that the user (not the attribute!) was found

in Active Directory.

1.14 Get User's Manager from Active Directory

This workflow action is used to get a manager's display name for a specified Active Directory user or a

group.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Get manager of current user from Active Directory. Store manager's display name in Variable: variable1,

success of the searching in Variable: variable2.

Parameters:

current user - The name of Active Directory user or a group whose manager's name is to be obtained

(like DOMAIN\Account). Leave the field empty to use current user.

Variable: variable1 - Output variable for the obtained manager display name.

Variable: variable2 - Output boolean variable, true indicates that the user or group (not the manager)

was found in Active Directory.

1.15 Get User's Multivalued Attribute from Active Directory

This workflow action is used to get a multi-valued attribute of a specified Active Directory user.

Note: This action returns a dictionary variable.

See Also: Get User's Attribute from Active Directory.

HarePoint.Com | X. List of workflow actions

Get multi-valued attribute this attribute of current user from Active Directory. Store attribute value

in Variable: ArrayVariable, success of the searching in Variable: variable.

Parameters:

this attribute - Name of attribute.

current user - User logon name (like DOMAIN\Account) or current user by default.

Variable: ArrayVariable - Output dictionary variable with attribute values.

Variable: variable - Output boolean variable, true indicates that user was found in Active Directory.

1.16 Move User into Organizational Unit

This workflow action is used to move a specified AD user into a specified AD organizational unit or

container.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

Move Active Directory user with this logon name into specified organizational unit.

Parameters:

with this logon name - Logon name of the Active Directory user (e.g. DOMAIN\username).

specified - Distinguished name or canonical name of the Organizational Unit or Active Directory

container (e.g. OU=Test,DC=company,DC=local or company.local/Users).

1.17 Remove Member from Active Directory Group

This workflow action will remove a user or group from an Active Directory security or distribution group.

Mail contacts can also be removed.

Deleting multiple users is supported.

Note: In order to specify AD credentials, add the Set Active Directory Authentication (impersonate)

activity to the same workflow step first. Otherwise, AD will be accessed as the user who started the

workflow or as the workflow author in the case of an impersonation step.

X. List of workflow actions | HarePoint.Com

Remove current user from members of specified group in Active Directory.

Parameters:

current user - Logon name of the user or group: DOMAIN\user or user@domain.com. Leave the field

empty to use the current user.

To delete multiple users, specify them delimiting by a semicolon (;).

Example: DOMAIN\user1; DOMAIN\user2; DOMAIN\user3

specified - Logon name of the group: DOMAIN\group or group@domain.com.

To remove a mail contact, specify its e-mail address.

Examples:

Remove COMPANY\jsmith from finance@company.com group in Active Directory

1.18 Set Active Directory Options

This workflow action is used to specify where the users should be searched in.

Set Active Directory Options: Search in the current forest with specified DNS name .

Parameters:

current forest - Specify the search scope to find the necessary user. Possible values:

• current

• current and trusted

• custom - in this case, additionally specify the forest DNS name

with specified DNS name - specify the DNS name of the AD forest.

1.19 Set User's Attribute in Active Directory

This workflow action is used to set an Active Directory attribute of a specified user.

Note: In order to specify AD credentials, add the Set Authentication action to the same workflow step

first. Otherwise, AD will be accessed as the user who started the workflow or as the workflow author in

the case of an impersonation step.

HarePoint.Com | X. List of workflow actions

See Also: Set User's Multivalued Attribute in Active Directory.

Set this attribute of current user in Active Directory to this value.

Parameters:

this attribute - specify the name of AD attribute to be set.

current user - specify the user whose attribute will be changed

this value - specify the new value the AD attribute.

1.20 Set User's Multivalued Attribute in Active Directory

This workflow action is used to set a multi-valued Active Directory attribute for a specified user.

Note: This action uses a dictionary variable.

Tip: This action can be used to set AD attribute to empty (null). To do this, create an empty dictionay,

then set the AD attribute to this array.

See Also: Set User's Attribute in Active Directory.

Set multi-valued attribute this attribute of current user in Active Directory to this value.

Parameters:

this attribute - Name of attribute.

current user - User logon name (like DOMAIN\Account) or current user by default.

this value - Dictionary variable with values.

1.21 Set User's Password in Active Directory

This workflow action is used to set the password for a specified Active Directory user.

Set logon name account password in Active Directory to this password.

Parameters:

logon name - Logon name of the user: DOMAIN\user or user@domain.com.

this password - String with new password.

X. List of workflow actions | HarePoint.Com

1.22 Set User's Photo in Active Directory

This workflow action is used to set or remove a photo in the Active Directory user's profile

('thumbnailPicture' attribute).

JPG image format is required.

Note: The size of the photo is limited to 100KB.

Set current user's photo in Active Directory to photo at this url.

Parameters:

current user - specify the user whose photo will be changed

photo at this url - specify the URL of the photo (stored in SharePoint document library) that will be

uploaded to the user's AD profile

2. Administration activities

2.1 Activate Feature by GUID

This workflow action is used to activate a site or site collection feature by its GUID (forcibly, if

necessary).

Activate feature with this GUID for the Site at this URL . Force: Yes.

Parameters:

this GUID - the GUID of the feature to be activated.

Site - select whether the feature belongs to a Site or Site Collection.

this URL - the site or site collection URL.

Yes - select if the feature should be installed in Force mode. (Yes/No)

2.2 Add User to SharePoint Group

This action adds one or more users to one or more SharePoint groups.

Add specified users to specified group at this site.

HarePoint.Com | X. List of workflow actions

Parameters:

specified users - One or more logon names of users separated by semicolon.

specified group - Group name, as displayed under People and Groups \ All Groups.

This parameter also accepts arrays of groups. In this case, user(s) will be added to all groups from the

array.

this - Full URL of a site.

2.3 Add User to SharePoint Site

This workflow action is used to add local or Active Directory users to a SharePoint site.

Add specified users to this site

Parameters:

specified users - One or more logon user names separated by semicolons (;). For example,

DOMAIN\account or MACHINE\account.

this site - Full URL of the site.

2.4 Alternate CSS and Site Logo

This workflow action is used to set alternative CSS and logo to a site.

Set alternate CSS and site logo to this site. CSS file this, logo file this.

Parameters:

this site - site URL

CSS file this - specify the CSS file to be applied

logo file this - specify the logo file to be applied

2.5 Change SharePoint Group Owner

This workflow action is used to change the owner of a SharePoint group.

X. List of workflow actions | HarePoint.Com

Change specified group owner at current site url to current user account

Parameters:

specified group - specify the SharePoint group name

current site url - (optional) specify the address of the site where the group should be searched at.

By default, the current site is used.

current user - (optional) specify the name of the account or the group that should be set as the group

owner.

By default, current user will be set as the group owner.

2.6 Change SharePoint Group Settings

This workflow action is used to change the settings of a SharePoint group.

Change specified group settings at current site url, about me: keep existing, view membership: keep

existing, edit membership: keep existing, allow membership requests: keep existing, auto-accept

requests: keep existing.

Parameters:

specified group - type in the name of SharePoint group to change.

current site url - keep it default to point to a current site, or specify the URL of a different site where the

SharePoint group belongs to.

about me: keep existing - (optional) specify the new text for group description.

view membership: keep existing - (optional) specify who can view members of this group:

• keep existing

• group members

• everyone

edit membership: keep existing - (optional) specify who can edit group membership:

• keep existing

• group owner

HarePoint.Com | X. List of workflow actions

• group members

allow membership requests: keep existing - (optional) specify if membership requests are allowed:

• keep existing

• yes - in this case additional parameter to this email appears

• no

to this e-mail - (only if previous parameter is set to yes) specify e-mail address for membership requests

auto-accept requests: keep existing - (optional) specify if membership requests should be automatically

accepted:

• keep existing

• yes

• no

2.7 Change SharePoint List Settings

This workflow action is used to change the settings of SharePoint list.

Change list settings at this list url , require approval: keep existing , require checkout: keep existing ,

create versions: keep existing , enable content types: keep existing , experience: keep existing

Parameters:

this list url - Specify the full path to the list or document library, which settings need to be changed.

require approval - Specify whether new items or changes to existing items should remain in a draft state

until they have been approved.

Keep existing, yes, no

require checkout - Specify whether users must check out documents before making changes in this

document library.

Keep existing, yes, no

create versions - Specify whether a version is created each time you edit a file in this document library.

Keep existing, major, major and minor

X. List of workflow actions | HarePoint.Com

enable content types - Specify whether to allow the management of content types on this document

library.

Keep existing, yes, no

experience - specify which user experience shoud be used for this list or library.

Keep existing, auto, new experience, classic experience

2.8 Create SharePoint Group

This workflow action creates a SharePoint group with specified parameters.

Create specified group with this description at site url and make current user the owner, can view:

Group Members , can edit: Group Owner .

Parameters:

specified group - enter the group name.

this description - the description for this group.

site url - the full site URL where the group should be created.

current user - (optional) specify the name of account or a group that will be set as this group owner.

By default, the current user will be set as the owner.

can view: Group Members - specify an account or group which can view the members of this group.

can edit: Group Owner - specify an account or a group which can edit group membership.

2.9 Create SharePoint Site

This action allows you to create a new site anywhere within the SharePoint environment.

Create new site with specified title at this URL, using this template and this description, use unique

permissions No.

Parameters:

specified - Title of the new site.

this url - Full URL for the new site.

HarePoint.Com | X. List of workflow actions

this template - Template for the new site. It might be the name of a site template, e.g. Team Site, Blank

Site, Blog and etc., or it might be the ID of a site template, e.g. STS#0, STS#1 and so on.

this description - New site description.

No - By default, the new site inherits permissions from its parent Site or the Site Collection. Unique

permissions can be created. If you select No, a single set of user permissions will be shared by both sites,

and user permissions on the new site will be editable only by an administrator of the parent site.

2.10 Create Site Collection

This action workflow action creates a new site collection.

Create new site collection with specified title at this url , using this template and this owner. Site

collection storage quota 1000 and resource quota 1000 .

Parameters:

specified title - Title of new site collection.

this url - URL of new site collection.

this template - Template for the new site. It might be name of site template, e.g. Team Site, Blank Site,

Blog and etc., or it might be the ID of a site template, e.g. STS#0, STS#1, and so on.

this owner - specify the account to be owner of this site collection.

storage quota 1000 - (in Megabytes) specify the storage quota for the new site collection.

resource quota 1000 - (in Megabytes) specify the resource quota for the new site collection.

2.11 Deactivate Feature By GUID

This workflow action is used to deactivate Site or Site Collection features based on their GUID.

Deactivation can be forced, if necessary.

Deactivate feature with this GUID for the Site at this URL . Force: Yes .

Parameters:

this GUID - specify the GUID of the feature to be deactivated.

Site - select the scope of the feature: Site or Site Collection.

X. List of workflow actions | HarePoint.Com

this URL - specify the URL of the Site or Site Collection where a feature needs to be deactivated.

Yes - choose whether deactivation should be forced: Yes, No.

2.12 Delete SharePoint Group

This workflow action is used to delete a SharePoint group from a specified site.

Delete specified group from this site url.

Parameters:

specified - Name of group.

site url - Full URL of a site.

2.13 Delete SharePoint Site

This action deletes a site anywhere within the SharePoint environment.

Delete site at this url.

Parameters:

this url - Full URL of site to delete.

2.14 Delete Site Collection

This workflow action deletes a site collection.

Delete site collection at this url.

Parameters:

this url - Full URL to site collection.

2.15 Delete Site Collection from Recycle Bin

This workflow action deletes a Site Collection permanently by removing it from the Recycle Bin.

Delete site collection at this url.

HarePoint.Com | X. List of workflow actions

Parameters:

this url - Full URL of the site collection.

2.16 Deploy Theme To Web

This workflow action is used to deploy a custom theme to a SharePoint Site.

Deploy theme with this name to this site. Theme file path , font file path , image file path , master page

name .

Parameters:

this name - enter the name of the theme.

this site - specify the URL of the site where the theme will be deployed.

theme file path - specify the path of the theme file.

font file path - specify the path of the font file.

image file path - specify the path of the image file.

master page name - specify the name of the master page.

2.17 Get SharePoint User Membership Status

This workflow action is used to check if a specified user is a member of a SharePoint group.

If this user is member of this SharePoint group, set Variable: isMember to yes

Parameters:

this user - specify the user name as DOMAIN\username

this SharePoint group - specify the name of SharePoint group

Variable: isMember - specify the output variable

X. List of workflow actions | HarePoint.Com

2.18 Get Site User MultiValued Property

This workflow action is used to get a specified multi-value property from a user's profile on the given

site. This action returns an empty string if the property is not found.

A list of all available properties is located in Central Administration \ Manage User Profile Properties.

Get (Custom) specified property for this user and store result in Variable: userProperty

Parameters:

(Custom) - Select the property from the drop-down list, or select Custom and specify it in the next

parameter

specified - Property name (not the display name of the property!).

this user - User whose property should be received.

Variable: userProperty - Output string variable.

2.19 Get Site User SingleValue Property

This workflow action is used to get a specified single-value property from a user's profile on the site. This

action returns an empty string if the property is not found.

You can get the list of all available properties in Central Administration \ Manage User Profile Properties.

Get (Custom) specified property for this user and store result in Variable: userProperty

Parameters:

(Custom) - Select the property from the drop-down list, or select Custom and specify it in the next

parameter

specified - Property name (not the display name of the property!).

this user - User whose property should be received.

Variable: userProperty - Output string variable.

HarePoint.Com | X. List of workflow actions

2.20 Inject Custom CSS

This workflow action is used to inject custom CSS in a site.

Inject custom CSS to this site. CSS file this and this action name.

Parameters:

this site - specify the URL of the site where CSS needs to be injected.

CSS file this - specify the URL of the CSS file.

this action name - specify the action name.

2.21 Remove CSS and Site Logo

This workflow action is used to remove CSS and the logo from the specific site.

Remove CSS and site logo from this site.

Parameters:

this site - specify the URL of the site.

2.22 Remove Custom Action

This workflow action is used to remove a custom action from the Site Actions menu on a specified site.

Remove custom action with this name at this site.

Parameters:

this name - specify the name of the custom action.

this site - specify the URL of the site.

2.23 Remove User from SharePoint Group

This workflow action is used to remove a user from a SharePoint group.

Remove specified user from specified group at this site.

Parameters:

X. List of workflow actions | HarePoint.Com

specified user - The login name of the user to be removed.

specified group - Group name, as it displayed in People and Groups \ All Groups.

this - Full URL of site.

2.24 Remove User from SharePoint Site

This workflow action is used to remove user from SharePoint site and from all site groups.

Remove specified user from this site.

Parameters:

specified - the login name of the user.

this - Full URL of a site.

2.25 Rename Site at Url

This workflow action is used to set a new title for a site specified by URL anywhere within the SharePoint

environment.

Rename site at this url to this title.

Parameters:

this url - Full URL of site.

this title - New title.

2.26 Set Master Page

This workflow action sets the master page for the current or any other site.

Set this master page as default for the current site.

Parameters:

this masterpage - specify the name of the masterpage or its URL relative to the server.

Examples:

HarePoint.Com | X. List of workflow actions

• v4.master

• default.master

• /_catalogs/masterpage/v4.master

the current site - (Optional) specify the absolute URL of the site to set where the masterpage is being

set. Use current site to set the masterpage for the current site.

2.27 Set SharePoint Admin Center URL

This workflow action is used to specify the URL of SharePoint Admin Center, to be referred to by the

next actions in the workflow.

Use this url as SharePoint admin center url

Parameters:

this url - specify the full URL of the SharePoint Admin Center

2.28 Set SharePoint Site Navigation Options

This workflow action sets the navigation options for a SharePoint site (such as Quick Launch, Top Link

Bar).

Set options for site at this url, show on parent's Quick Launch: don't change , show on parent's top link

bar: don't change , inherit parent's top link bar: don't change

Parameters:

site at this url - specify the URL of the site.

show on parent's Quick Launch: don't change- specify whether you need to display or hide this site

from the Quick Launch of the parent site.

Available values: yes, no, don't change (keep current setting)

show on parent's top link bar: don't change - specify whether you need to display or hide this site from

the Top Link Bar of the parent site.

Available values: yes, no, don't change (keep current setting)

X. List of workflow actions | HarePoint.Com

inherit parent's top link bar: don't change - choose to display the Top Link Bar from the parent site or

display a Top Link Bar for this particular site.

Available values: yes, no, don't change (keep current setting)

2.29 Set Site Theme Based On Name

This workflow action allows you to set the site theme based on a theme name.

Set this site theme based on this name.

Parameters:

this site - specify the URL of the site.

this name - specify the name of the theme to be set.

3. Cloud Print activities

3.1 Delete Print Job

This workflow action deletes a print job with a specified ID.

Delete print job with this id.

Parameters:

this id - specify the ID of the print job that needs to be deleted.

3.2 Get Print Job Status

This workflow action is used to get the status of a specified print job.

Get status of print job with this id and store status in jobStatus .

Parameters:

this id - specify the ID of the print job to get its status.

The print job ID can be obtained from the Submit Job action.

jobStatus - specify the variable to store the print job status.

HarePoint.Com | X. List of workflow actions

3.3 Get Printer Status

This workflow action is used to get the status of a cloud printer by its name or ID.

Get status of printer name or id of printer and store status in printerStatus .

Parameters:

printer name or id of printer - specify either the cloud printer name or cloud printer ID to get its status.

printerStatus - specify the variable to store the cloud printer status.

3.4 Set Printing Options

This workflow action is used to set printing options for a cloud print job.

Set number of copies: 1 , page range: all , Portrait orientation, Do not fit to page , 2-sided printing: No

and print in Color .

Parameters:

number of copies: 1 - specify the number of document copies to be printed.

page range: all - specify the page range to be printed. By default, all pages will be printed.

Portrait orientation - specify the orientation of the document:

• Portrait

• Landscape

Do not fit to page - specify the document scaling:

• Do not fit to page

• Fit to page

• Grow to page

• Shrink to page

• Fill page

X. List of workflow actions | HarePoint.Com

2-sided printing: No - specify whether the document needs should be printed on both sides of the

paper:

• No

• Long edge

• Short edge

print in Color - select the color mode for printing:

• Color

• Monochrome

• Auto

3.5 Submit Print Job

This workflow action submits a cloud print job.

Print document from this URL with default content type on the specified printer . Store job's id to jobId .

Parameters:

this URL - specify the URL of the document to be printed.

default content type - (optional) specify the content type of the document to be printed.

specified printer - specify the printer name or printer ID.

jobId - specify the variable to store the print job ID.

This Job ID is used to get the status of this print job - see also Get Job Status action.

4. Conversion activities

4.1 Convert Document

This workflow action converts the specified document to a different format and stores the output file in

a document library.

This action processes files only of supported formats; files of other formats will be skipped. The list of

supported input formats:

HarePoint.Com | X. List of workflow actions

• Open XML Document (.docx, .docm, .dotx, .dotm)

• Word 97-2003 Document (.doc, .dot)

• Rich Text Format (.rtf)

• Web Page (.htm, .html, .mht, .mhtml)

• Word 2003 XML Document (.xml)

The list of supported output formats:

• Word Document (docx)

• Word 97-2003 Document (doc)

• PDF

• PDF/A

• RTF

• XPS

Note: This action requires "Word Automation Services" running on the server. To check this service,

open Central Administration, go to System Settings and open the "Manage services on server" page.

Unfortunately, this service is not available on SharePoint Foundation.

Convert document at this URL to PDF format and save to the folder at specified URL and with the same

name. Overwrite existing document

Parameters:

this URL - specify the full URL of the input document

PDF - specify the output format:

• Word Document (docx)

• Word 97-2003 Document (doc)

• PDF

• PDF/A

• RTF

• XPS

X. List of workflow actions | HarePoint.Com

folder at specified URL - specify the URL of a document library, or a folder within a document library to

store the output file.

the same name - choose if the output file should have the same name as the original file, or specify a

name directly.

Overwrite - choose if a document should be overwritten, if a file with such name already exists in the

target folder.

5. Date/Time activities

5.1 Convert Date from Local Time to UTC

This workflow action converts a local date/time variable to a Coordinated Universal Time (UTC)

date/time. The UTC is equal to the local time minus the UTC offset taken from the site's Regional

Settings. The conversion also takes into account the daylight-saving time rule.

Convert specified date from Local Time to UTC and store result in Variable: convertedToUTCDate

Parameters:

specified date - Input date or Date/Time variable.

Variable: convertedToUTCDate - Output Date/Time variable.

5.2 Convert Date from UTC to Local Time

This workflow action is used to convert Coordinated Universal Time (UTC) to local time. The local time is

equal to the UTC time plus the UTC offset taken from the site's Regional Settings. The conversion also

takes into account the daylight-saving time rule.

Convert specified date from UTC to Local Time and store result in Variable: convertedToLocalTimeDate

Parameters:

specified date - Input UTC date or date/time variable

Variable: convertedToLocalTimeDate - Output local time/date variable

HarePoint.Com | X. List of workflow actions

5.3 Convert Date to Text

This workflow action converts a date/time variable to a string using a specified format.

A detailed description of format string syntax for each type is contained in following articles:

• Standard DateTime Format Strings - http://msdn.microsoft.com/en-

us/library/aa720651(v=VS.71).aspx

• Custom DateTime Format Strings - http://msdn.microsoft.com/en-

us/library/aa719856(v=VS.71).aspx

• DateTime Formatting Sample - http://msdn.microsoft.com/en-

us/library/aa326720(v=VS.71).aspx

In the case of a wrongly formatted string, the date will be converted with the default format and a

warning message will be logged in the workflow history log.

Convert specified date to text with specified format and store result in Variable: textDate

Parameters:

specified date - Input date/time variable.

specified format - Format string.

Variable: textDate - Output string variable.

Examples:

Set DateTime constant Now and store result in Variable: d

then Convert Variable: d to text with MMMM dd yyyy HH:mm:ss.fffffff and store result in Variable:

strDate

then Get Variable: d day property and store result in Variable: day

then Get Variable: d day of week property and store result in Variable: dow

then Get Variable: d day of year property and store result in Variable: doy

then Get Variable: d hour property and store result in Variable: h

then Get Variable: d millisecond property and store result in Variable: ms

then Get Variable: d minute property and store result in Variable: min

then Get Variable: d month property and store result in Variable: m

X. List of workflow actions | HarePoint.Com

then Get Variable: d second property and store result in Variable: sec

then Get Variable: d year property and store result in Variable: y

then Log [%Variable: strDate%] : [%Variable: day%], [%Variable: dow%], [%Variable: doy%], [%Variable:

h%], [%Variable: ms%], [%Variable: min%], [%Variable: m%], [%Variable: sec%], [%Variable: y%] to the

workflow history list

Result in workflow history file:

April 25 2011 14:16:26.1626432 : 25, 2, 115, 14, 162, 16, 4, 26, 2011

5.4 Evaluate Due Date

This workflow action calculates a due date by adding a specified amount of time to a starting date while

excluding non-working hours according to the site's Regional Settings.

Evaluate due date from this time for this many hours, 5 minutes and store result in Variable: dueDate

Parameters:

this time - Starting date/time.

this many hours - Duration in hours.

5 minutes - Duration in minutes.

Variable: dueDate - Output date/time variable.

5.5 Get Date Property

This workflow action is used to get one of the numeric values (like year, or day of the week) of a

date/time variable.

See examples section for details.

Get this date day property and store result in Variable: dateProperty.

Parameters:

this date - Input date/time variable.

day - What property of the date to store, available values are: day, day of week, day of year, hour,

millisecond, minute, month, second, and year.

HarePoint.Com | X. List of workflow actions

See examples section for details.

Variable: dateProperty - Output integer variable.

Examples:

Set DateTime constant Now and store result in Variable: d

then Convert Variable: d to text with MMMM dd yyyy HH:MM:ss.fffffff and store result in Variable: