Scripted installation
The installation of the pre-requisite software and Blue Prism software can be scripted. These instructions illustrate how a single device can be scripted to be configured with:
- SQL Server
- Blue Prism application server connected to the SQL Server
- Blue Prism interactive client connected to the application server
The examples provided within this section are for illustrative purposes only and should be tested prior to being used in a production environment.
Information on the scripting capabilities can be found in the In-Product help (automate.exe /help), and by using the automatec /? Switch.
To install SQL Server from the command line, see this Microsoft article.
Production environments should be configured to connect to SQL Server using Windows Authentication where possible.
Core application
To install Blue Prism use the command:
msiexec /i "BluePrism6.8_x64.msi" /QB- ALLUSERS=1
This command performs a full install of Blue Prism including all optional components, such as the Chrome browser extension.
Custom install options
To install Blue Prism without the optional components, use the ADDLOCAL parameter with the BluePrism and BPServer components:
msiexec /i BluePrism6.8_x64 ADDLOCAL=BluePrism,BPServer /qn
The BluePrism and BPServer components must both be specified to install or upgrade Blue Prism using the ADDLOCAL parameters. They cannot be used in isolation.
The ADDLOCAL parameter can also be used to install the following optional components:
Component |
Description |
---|---|
OutlookAutomation |
Installs the Microsoft Outlook Interop DLL required on all devices on which the Blue Prism MS Outlook Email VBO will be executed. |
GoogleSheets |
Installs the DLLs required on all devices on which the Google Sheets VBO will be executed. |
ChromePlugin |
Installs the Blue Prism Chrome browser extension required on devices that will use this mechanism to automate Chrome. |
FirefoxPlugin |
Installs the Blue Prism Firefox browser extension required on devices that will use this mechanism to automate Firefox. |
To install Blue Prism with the Chrome and Firefox browser extensions, use the command:
msiexec /i BluePrism6.8_x64 ADDLOCAL=BluePrism,BPServer,ChromePlugin,FirefoxPlugin /qn
To install Blue Prism and the Microsoft Outlook Interop DLL:
msiexec /i BluePrism6.8_x64 ADDLOCAL=BluePrism,BPServer,OutlookAutomation /qn
To install Blue Prism with Google sheets:
msiexec /i BluePrism6.8_x64 ADDLOCAL=BluePrism,BPServer,GoogleSheets /qn
Configure the database connection
Once Blue Prism is installed, the Blue Prism database connection can be configured.
For SQL native authentication mode, use:
Automate.exe /dbconname "Friendly name" /setdbname "DB Name" /setdbserver "DB Server" /setdbusername "DB User" /setdbpassword "********"
For SQL windows authentication mode use:
Automate.exe /dbconname "Friendly name" /setdbname "DB Name" /setdbserver "DB Server"
Create a Blue Prism database
Once a database connection has been defined a Blue Prism database can then be created. The parameters that must be used will depend on whether Blue Prism Native, or Single Sign-on will be used to secure access to Blue Prism.
Configuring a database for an environment to be secured using Blue Prism Native Authentication
Database secured using SQL Authentication
AutomateC.exe /createdb "*******"
Database secured using Windows Authentication
AutomateC.exe /createdb ""
Configuring a database for an environment to be secured using Single Sign-on for Blue Prism
Database secured using SQL Authentication
AutomateC.exe /createdb "*******" /setaddomain "Domain Name" /setadadmingroup "Group Name"
Database secured using Windows Authentication
AutomateC.exe /createdb "" /setaddomain "Domain Name" /setadadmingroup "Group Name"
The current user must belong to the AD Group specified as the /setadmingroup.
The configuration of additional Blue Prism security roles including associating with Active Directory Security Groups must be completed via the User Interface.
Register the License
The license can be added to the deployment by specifying the path of the license file in the command below:
AutomateC.exe /license "Path of License File"
Create the server service profile
Create a server service that uses the created connection. An encryption scheme named Default Encryption Scheme will be created by default.
AutomateC.exe /serverconfig "Profile Name" "Connection Name" "Port"
AutomateC.exe /serverconfig "Default" "Default Connection" "8199"
Do not use this method to create a server for an existing environment as the encryption scheme must match existing schemes.
Configure a connection to the application server
Configure the devices to connect to the environment via the Blue Prism Server.
Automate.exe /dbconname "Friendly name" /setbpserver "Server Name" "Port"
Import processes
If there are business objects or processes to be imported the XML files can be imported individually using the command(s):
AutomateC.exe /import "C:\My Process.xml" /user admin admin
AutomateC.exe /import "C:\My Object.xml" /user admin admin
The user credentials supplied here (username "admin" and password "admin") are the sample options for native authentication; these have not yet been changed but will be changed later. Where Active Directory authentication is being used, the option "/user admin admin" should be replaced with "/sso"; this assumes that the Active Directory groups have already been configured.
Publishing processes
Any processes which need to be published can be published as follows:
AutomateC.exe /publish "My Process" /user admin admin
Publishing a process makes it available to be run or scheduled.
Scripting references
The following table provides references to further information on the command line examples printed above.
Topic |
Help Reference |
Download Location |
---|---|---|
Msiexec |
http://technet.microsoft.com/en-us/library/cc759262%28WS.10%29.aspx |
N/A |
Blue Prism |
AutomateC.exe /help or Contact your Account Manager or the Technical Support Team |
N/A |
For scenarios where it is necessary for database creation or update operations to occur manually, the SQL scripts for the operation can be generated.
- Create Script – AutomateC.exe can be used to generate a script and save it on a local device which, when run against a blank database, generates the Blue Prism schema and carries out essential configuration.
- Automatec.exe /getdbscript > "c:\temp\CreateScript.sql"
- Upgrade Script – AutomateC.exe can be used to generate a script and save it on a local device which, when run against an existing Blue Prism database, updates the schema and configuration to be appropriate for the version of Blue Prism.
- Automatec.exe /getdbscript /fromrev 10 > "c:\temp\UpgradeScript.sql"
Setup the Windows services
For each server configuration (excluding Default which is configured automatically), a windows service can be created using SC.exe. This is the service control program typically distributed within resource kits by Microsoft.
sc create {SERVICENAME} binPath= "[Blue Prism Install Location]\BPServerService.exe {CONFIGURATIONNAME}"
Please note that in the below examples that there is a space between binPath= and the opening quote, and also that the configuration name is within the same quotes as the location as the BPServerService.
sc create "Blue Prism Dev Server" binPath= "C:\Program Files\Blue Prism Limited\Blue Prism Automate\BPServerService.exe Development"
sc create "Blue Prism Test Server" binPath= "C:\Program Files\Blue Prism Limited\Blue Prism Automate\BPServerService.exe Test"
Where the server configuration name contains spaces, it is necessary to use a backspace as an escape character. The example below shows the setup where the server configuration name is “Development Environment”
sc create "Blue Prism Dev Server" binPath= "\"C:\Program Files\Blue Prism Limited\Blue Prism Automate\BPServerService.exe\" \"Development Environment\""
Configuring the Access Control List (ACL) for non-administrators
When the Blue Prism Server service is configured to use a WCF connection mode, if the Service logon account is not a local administrator, it will be necessary to grant the logon account user permissions to start the listener using the defined settings.
The command to setup the ACL will differ based on the WCF connection mode and the binding configured on the associated server profile settings.
netsh http add urlacl url=[http | https]://[Server Binding]/bpserver user=[Service User]
The following should be considered when constructing the command:
- When using a WCF mode that uses message encryption select http.
- When using a WCF mode that uses transport encryption select https.
- When a binding is specified this must be explicitly stated in the command
- When not using a binding, a strong wildcard should be used in the binding
WCF mode using message encryption with no server binding specified on the server profile
netsh http add urlacl url=http://+:8199/bpserver user=Domain\UserName
WCF mode using message encryption with a server binding specified on the server profile
netsh http add urlacl url=http://bpserver001.mydomain:8199/bpserver user=Domain\UserName
WCF mode using transport encryption with no server binding specified on the server profile
netsh http add urlacl url=https://+:8199/bpserver user=Domain\UserName
WCF mode using transport encryption with a server binding specified on the server profile
netsh http add urlacl url=https://bpserver001.mydomain:8199/bpserver user=Domain\UserName
Associating a Certificate with the network interface
When the Blue Prism Server service is configured to use a WCF connection mode that requires a deployed certificate, these steps provide the commands to associate a locally deployed certificate with the listening IP address and port.
The certificate must be deployed for the computer account. Likewise ensure that the issuing certificate authority is trusted by this device and that the certificate, and its issuing authority, are trusted by all client devices.
netsh http add sslcert ipport=[IP Address:Port] certhash=[Thumbprint] appid={00112233-4455-6677-8899-AABBCCDDEEFF}
For example:
netsh http add sslcert ipport=10.0.2.15:8199 certhash=bac31cc4094793d275167cf02b31bbac2718f3c7 appid={00112233-4455-6677-8899-AABBCCDDEEFF}