Workflow Studio 2.0 Installation Overview

Installation Overview

The Workflow Studio 2.0 installation process is a three step process that involves pre-requisite checks, installation, and then configuration.

Pre-Requisites

There are two utilities that make up the pre-requisite check process:

1. Setup.exe – This utility is designed to be the first application launched during installation and is a native C++ application that should run on any system. The purpose of this utility is solely to check whether .NET Framework 3.5 is installed and install it if it is not already installed. If it is already installed then it just launches SetupWFS.exe.
2. SetupWFS.exe – This utility provides the remainder of the pre-requisite checks. It is built as a WPF application using .NET 3.5 (thus the need for the previous step.) The pre-requisite checks are as follows:
   • Windows Version – The supported OS versions are Windows XP, Vista, Server 2003 R2, and Server 2008 on both 32 and 64 --bit platforms. The pre-requisite check will validate that the machine is one of these and that the latest service pack is installed. We cannot redistribute these files, but in the Components directory of the ISO image there is a SP sub-directory. In there you will find links to the latest full downloads of the service packs, and if you download them into this folder then the setup utility will automatically install them instead of prompting you to download them.
   • .NET Framework – .NET Framework 3.5 SP1 is required. Given that we check for .NET 3.5 in the initial setup.exe utility, this is only likely to highlight that SP1 is not installed. The redistributable files to install the .NET framework are included in the Components\NET folder of the CD image.
   • PowerShell – Windows PowerShell 1.0 is required. If PowerShell 2.0 is detected a warning will be displayed that only PowerShell 1.0 is officially supported. Windows PowerShell 1.0 is not redistributable, but you can download the installer and copy it into the Components\PowerShell folder to have the setup utility offer to install instead of prompting to download.
   • Authorization Manager – Microsoft's Authorization Manager is required for the role-based security in Workflow Studio. Authorization Manager is available through either the "Administration Tools Pack" or the "Remote Server Administration Tools". The utility will detect if this component is installed and direct you to the correct download location based on your OS platform. These are also not redistributable, but you will find download links and file names in the Components\AdminTools folder.
   • SQL Server – SQL Server 2005 is required. This utility will check if a version of SQL Server 2005 is installed locally and display a warning if not. The utility will provide a link to install SQL Server Express for convenience, but this warning can be ignored if a remote SQL Server will be used. The SQL Server check is not required for a runtime install. The redistributable files for SQL Express are in the Components\SQL folder of the CD image.
   • Workflow Components – You must uninstall any previous version of Workflow Studio before installing 2.0. This utility will provide a link to automatically uninstall a previous version if detected. Uninstalling Workflow Studio does not delete any workflows stored in the SQL Server database or workflow history (which is stored in XML files in the ALLUSERS profile.) For the activity library installer, the 2.0 version of Workflow Studio is required to be installed before the activity library can be installed.
   • Group Policy Management Console – This check is only performed for the activity library installer. The Group Policy activity library requires the GPMC to be installed to run any workflow that contains a Group Policy activity in it. You can build workflows in the Workflow Designer without this component installed, but will not be able to run them.

The SetupWFS.exe utility also provides an install button to launch the appropriate installer. The utility will check the local machine and automatically launch either the 32-bit or 64-bit installer.

Installation

There are 6 installers that make up Workflow Studio:

• WFStudio.msi – Full installer for 32-bit platforms
• WFStudio_x64.msi – Full installer for 64-bit platforms
• WFSRuntime.msi – Runtime-only installer for 32-bit platforms
• WFSRuntime_x64.msi – Runtime-only installer for 64-bit platforms
• WFStudioActivities.msi – Activity library installer for 32-bit platforms
• WFStudioActivities_x64.msi – Activity library installer for 64-bit platforms

Configuration

After the full or runtime installer completes, the configuration utility is automatically launched in wizard mode to provide the opportunity to configure Workflow Studio. The configuration utility is also added to the start menu in for ongoing maintenance. The configuration steps are:

• Workflow Database – The utility will automate the creation of a database on a SQL Server. The scripts that are run are located in the "%ProgramFiles%\Citrix\Workflow Studio\SQLSetup" folder, so you can manually create the database if necessary. More details on running the scripts can be found here: http://community.citrix.com/display/wf/Customizing+Your+Workflow+Studio+Database
  The configuration utility also adds the current user as an administrator. This function can be automated from PowerShell:

  Add-PSSnapIn Citrix.WorkflowStudio.DataStore
  Add-StoreRoleAssignment -Role Admin -Account "Domain\User"
  

  Note: The Workflow Database section is not displayed for a runtime only installation.

• TCP port sharing – The Windows service Net.Tcp Port Sharing is typically disabled by default and we need it to be enabled for Workflow Studio. We set the service to automatic at startup and start it in the configuration utility. This can be automated from PowerShell:

  Start-Service NetTcpPortSharing
  Set-Service NetTcpPortSharing -StartupType Automatic
  

• Workflow Runtimes – The configuration utility provides and interface to add/remove one or more workflow runtimes for executing jobs. This can be automated from PowerShell:

  Add-PSSnapIn Citrix.WorkflowStudio.Core 
  Get-Credential | New-WorkflowRuntime 
  

• Security - The configuration utility will create either an XML or AD role store, add the current user to an admin role, and configure the security service (if using AD). This can be automated from PowerShell:

  Add-PSSnapIn Citrix.WorkflowStudio.AzMan
  Add-AzmanRoleAssignment -ConnectionString "msxml:\\C:\Documents and Settings\All Users\Application Data\Citrix\Workflow Studio\AzmanRoleStore.xml" -Role "Perform all job and security operations" -Account "Domain\User"
  
  If using AD:
  Add-PSSnapIn Citrix.WorkflowStudio.AzMan
  New-ADRoleStore
  New-ADRoleService
  

• Firewall - The configuration utility checks if the Windows Firewall is enabled and provides an option to configure an exception for TCP port 8010 for communication with remote runtimes. This can be automated from a command line:

  netsh firewall set portopening protocol=TCP port=8010 name="Citrix Workflow Studio Runtime" mode=enable
  

The configuration utility is launched as WFSConfig.exe. This application accepts the following parameters:

• DisplayType – if passed a value of wizard then the utility will run as a wizard stepping the user through each of the
• DisplayMode – Specifies whether to configure a full install or a runtime only install

Example:

WFSConfig.exe /displaytype:wizard /displaymode:full
WFSConfig.exe /displaytype:wizard /displaymode:runtime
WFSConfig.exe /displaymode:full
WFSConfig.exe /displaymode:runtime

Unattended Installation

Performing an unattended installation of Workflow Studio requires ensuring that the target machine meets the pre-requisites, running the installer, and then performing the configuration steps. Workflow Studio installers are MSI-based and as a result you can use the standard MSI options for an unattended installation.

Full installation

For the full installation you will be running either WFStudio.msi or WFStudio_x64.msi. The full installation requires a valid Citrix license and the license information can passed in through the following parameters:

• • LIC_PRODUCT_TYPE – Specify the type of license you want to validate. Valid values are: "Hyper-V", "XenApp", "XenDesktop", "XenServer", and "NetScaler".
  • LIC_NAME – Specify the server name or host name used to connect to the license server or device.
  • LIC_PORT – For XenApp, XenDesktop, or Hyper-V license types specify the port number for the license server. The default value of "27000" will be used if not provided. For XenServer and NetScaler license types this value is ignored.
  • LIC_USERNAME – For XenServer or NetScaler license types specify the user name used to connect to the device.
  • LIC_PASSWORD – For XenServer or NetScaler license types specify the password used to connect to the device.

If the license check does not succeed then installation will not be completed.

Examples:

msiexec /i WFStudio.msi /passive LIC_PRODUCT_TYPE=XenApp LIC_NAME=localhost LIC_PORT=27000
msiexec /i WFStudio.msi /passive LIC_PRODUCT_TYPE=XenServer LIC_NAME=http://192.168.2.1 LIC_USERNAME=root LIC_PASSWORD=password

Runtime only installation

A runtime installation does not require a license check, so there are no additional parameters necessary. You cannot install a runtime on a machine with the full install already installed.

Example:

msiexec /i WFSRuntime.msi /passive

Activity library installation

Example:

msiexec /i WFStudioActivities.msi /passive

When run in unattended mode, the installer will not automatically launch the configuration utility, so you will need to ensure that the configuration steps are completed manually, or they can be automated as mentioned in the configuration section.