BI Server installation

important

Run installation of WorkFusion Analytics Server as Windows Administrator.

Pre-installation requirements

Port configuration

Configure open ports on BI Server:

App	Port
WorkFusion Analytics Server (installation with SSL)	443
WorkFusion Analytics Server (installation without SSL)	8080

WorkFusion Analytics Server must have access to DB Server (DB_HOSTNAME) for the following applications:

App	Default port
MySQL database	3306
PostgreSQL database (for Control Tower and WorkSpace)	5432

Installation Package Download

Download the installation package (link is provided by the WorkFusion team): WorkFusionAnalyticsInstaller.zip** containing two folders: WorkfusionAnalyticsServer and WorkfusionAnalyticsDesktop.

License Keys

Get License keys for WorkFusion Analytics Server and Desktop from WorkFusion Team.

WorkFusion Analytics Server installation

The installation process can take about 15-20 minutes.

Download WorkFusionAnalitycsInstaller.zip (URL will be provided by the WorkFusion team) and unpack the archive.
Start the Command Prompt (cmd) and go to the WorkfusionAnalyticsServer folder in the unpacked installation package from the previous step.
Launch the installation Batch file (install_server.bat) with the following parameters: installation directory and APP host name:
```
install_server.bat ${INSTALL_DIR} ${APP_HOSTNAME}
```
Example
```
install_server.bat D:\WorkFusionServer wf.exapmle.com
```
Open Manager Product Keys and enter the license key: Start > All Programs > Manage Product Keys.

For more details about Activation refer to WorkFusion Analytics License.

Open http://localhost in the browser on BI Server. Create a server administrator account.

Attention

Do not use %, &, ^ or = characters and other special symbols in the password.

WorkFusion Analytics Desktop installation

Download WorkFusionAnalitycsInstaller.zip (URL will be provided by WorkFusion team) and unpack the archive.
Start the Command Prompt (cmd) and go to the WorkfusionAnalyticsDesktop folder in the unpacked installation package from the previous step.
Launch the installation Batch file install_desktop.bat with the installation directory parameter:
```
install_desktop.bat ${INSTALL_DIR}
```
Example
```
install_desktop.bat D:\WorkFusionDesktop
```
Start WorkFusion Analytics Desktop using the Desktop shortcut and enter your license key.

For more details about Activation refer to WorkFusion Analytics License.

Configure SSL WorkFusion Analytics Server

important

The present step is optional.

Add to Tableau config INSTALL_DIR_WorkFusion Analytics Server/conf/tabsvc.yml on BI Server:

ssl.enabled: true
ssl.cert.file: < path to the certificate>
ssl.key.file: < path to the key>

Example:

Restart WorkFusion Analytics Server.

Deploy Workbooks to WorkFusion Analytics Server

This section describes deployment of Tableau workbooks to Tableau 10 Server OEM (WorkFusion Analytics Machine).

Pre-deployment requirements

Pre-installed Software:

Microsoft Server 2008 R2 or newer
WorkFusion Analytics Server 10.1 OEM or newer

Workbook deployment

Pre-publishing preparations are as follows:

Get installation packages from WorkFusion team: deploy_scripts.zip, dashboards.zip, wf_automation.zip.
Log in to the BI server using RDP where WorkFusion Analytics Server has been installed and follow the next steps.

Create folders for installation files

Create a folder: C:\tdeploy_home\install.
Download the installation package deploy_scripts.zip (provided by the WorkFusion team) and unpack into C:\tdeploy_home\install.

Pre-installation directories after unpacking zip files

c:\tdeploy_home
    \install    (file: install.cmd)
        \lib    (installation file pack)

Run installation

Open the Command Prompt and run the command:

Run install.cmd

c:
cd \tdeploy_home\install
install.cmd c:\tdeploy_home

Created files and directories after install.cmd

c:\tdeploy_home
    \deploy        (files: create_sitefolder.cmd, publish.cmd, manage_server.cmd)
        \config    (files: config._sample_.cmd, config._sample_WFA_.cmd, deploy_config.cmd, import_users.csv)
        \lib       (files: deploy_workbook.cmd, get_datetime.vbs, get_logfile.cmd, log_echo.cmd, replace_str.vbs)
        \to_deploy (empty)
        \deployed  (empty)
        \log       (empty)

The installation log file will be created in c:\tdeploy_home\install\ named as install_YYYY-MMDD-HHMI.log

Create folders for new site

c:
cd \tdeploy_home\deploy
create_sitefolder.cmd site_name

where site_name is a part of the APP instance host. For example, if APP is hosted at https://wfapp.company.com/ the command parameter is wfapp (a site and a project with the same name will be created on WorkFusion Analytics Server).

This command creates the new configuration files (copied from deploy\config\config._sample_.cmd and config._sample_WFA_.cmd) and a few new folders.

New files and directories after create_sitefloder.cmd

c:\tdeploy_home
    \deploy
        \config
            config.site_name.cmd      (settings for the site "site_name")
            config.site_name_WFA.cmd  (settings for WF-Automation)
        \to_deploy
            \site_name                (widgets for deploying)
                 \automation          (WF-Automation widgets)
                 \dashboard           (generic widgets)
        \deployed
            \site_name                (already deployed widgets: are being moved from \to_deploy\site_name during deploy process)
                 \automation
                 \dashboard

Final directory structure

c:\tdeploy_home
    \install
        \lib
    \deploy        
        \config    
        \lib       
        \to_deploy 
            \site_name
                 \automation
                 \dashboard
        \deployed
            \site_name
                 \automation
                 \dashboard
        \log

Edit configuration files

In c:\tdeploy_home\deploy\config\ specify the appropriate values in config.site_name.cmd and config.site_name_WFA.cmd.

Common config parameters

REM DB options
SET DATABASE_SERVER_NAME=servername  (DB_HOSTNAME)
REM MySQL options
SET DATABASE_NAME_MYSQL=dbname
SET DATABASE_PORT_MYSQL=0000
SET DATABASE_USERNAME_MYSQL=dbuser
SET DATABASE_PASSWORD_MYSQL=dbpass
REM PostgreSQL options
SET DATABASE_NAME_PGSQL=dbname
SET DATABASE_PORT_PGSQL=0000
SET DATABASE_USERNAME_PGSQL=dbuser
SET DATABASE_PASSWORD_PGSQL=dbpass
REM WorkFusion Analytics (Tableau) Server options
SET TABLEAU_VERSION=10
SET TABLEAU_SERVER_URL="https://tableau.com"
SET TABLEAU_SERVER_BIN="C:\Program Files\Tableau\Tableau Server\<version>\bin"
SET TABLEAU_SITE=usersite     (site_name)
SET TABLEAU_PROJECT=usersite  (for config.site_name_WFA.cmd predefined value is 'WF-Automation')
SET TABLEAU_USERNAME=tabuser  (user role must be Server Administrator)
SET TABLEAU_PASSWORD=tabpass

A specific parameter for config.site_name.cmd:

REM CT options
SET WF_INSTANCE_NAME=instanceurl.com    (APP_HOSTNAME)
REM Examples of IS_WF_PRIOR_82: t - if instance version < 8.2, f - if instance version >= 8.2
SET IS_WF_PRIOR_82=f

A specific parameter for config.site_name_WFA.cmd:

SET SERVICE_WFBI_NAME=swfbiurl.com

Config parameter	Generic values for config.site_name.cmd	Values for config.site_name_WFA.cmd	Description
`DATABASE_SERVER_NAME`	`DB_HOSTNAME`	`ML_HOSTNAME`	DNS name of the database server
`DATABASE_NAME_MYSQL`	`wfdb`	Not specified	Data source's database name
`DATABASE_PORT_MYSQL`	`3306`	Not specified	Default values: `3306` for MySQL
`DATABASE_USERNAME_MYSQL`		Not specified	Username to connect to database (for MySQL use user with read-only rights)
`DATABASE_PASSWORD_MYSQL`		Not specified	User's password
`DATABASE_NAME_PGSQL`	`wf_datastore`	`wfml_automation`	Data source's database name
`DATABASE_PORT_PGSQL`	`5432`	`5432`	Default values: `5432` for PostgreSQL
`DATABASE_USERNAME_PGSQL`			Username to connect to database
`DATABASE_PASSWORD_PGSQL`			User's password
`TABLEAU_SERVER_URL`			URL of the Tableau Server
`TABLEAU_VERSION`			9 - Tableau Server v.9, 10 - if Tableau Server v.10
`TABLEAU_SERVER_BIN`			Full path to the `\bin` directory of Tableau Server
`TABLEAU_SITE`	`site_name`	`site_name`	Part of `APP_HOSTNAME`. If APP is hosted at https://wfapp.company.com/, the value will be wfapp.
`TABLEAU_PROJECT`	`site_name`	WF-Automation	Should be equal to the `TABLEAU_SITE` value in case of dashboards, not automation
`TABLEAU_USERNAME`			Tableau Server user name with Server Administrator rights
`TABLEAU_PASSWORD`			Server Administrator user's password
`WF_INSTANCE_NAME`		Not specified	APP_HOSTNAME
`IS_WF_PRIOR_82`	`f`	Not specified	`t` if instance version < 8.2, `f` if instance version >= 8.2
`SERVICE_WFBI_NAME`		Not specified	Service WFBI name

In c:\tdeploy_home\deploy\config\ specify the appropriate values in import_users.csv.

Replace the existing value with credentials of a new user. This new user will be a user for Tableau configuration on the instance (the .properties file).

import_users.csv

NewUserName,NewUserPassword

caution

Do not use %, &, ^ or = characters and other special symbols in the password.

Create WorkFusion Analytics site, project and new user

Run the following command in the Command Prompt:

Run manage_server.cmd

c:
cd \tdeploy_home\deploy
manage_server.cmd site_name

A site and a project are created on WorkFusion Analytics Server as site_name and WF-Automation respectively. A new user from the file will be added with the Site Administrator role.

Workbook publishing

Prepare new Workbook files

Download the Workbook packages (provided by WorkFusion team).

Unpack dashboards.zip to:

\tdeploy_home\deploy\to_deploy\site_name\dashboard

and wf_automation.zip to:

\tdeploy_home\deploy\to_deploy\site_name\automation

to create the following file structure:

Initial generic file list

c:\tdeploy_home\deploy\to_deploy
    \site_name
      \automation
            WF-Automation.twbx
            WF-Automation-r_embeded.twbx
            WF-Automation-j_embeded.twbx
            GoldExtractedDashboard.twbx
      \dashboard
            Average_Time_Spent_source.twbx
            Average_Time_Spent_dashboard.twbx
            Bot_Performance_source.twbx
            Bot_Performance_dashboard.twbx
            Business_Process_Performance_source.twbx
            Business_Process_Performance_dashboard.twbx
            Cognitive_Automation_chart.twbx
            Cognitive_Automation_source.twbx
            Cognitive_Automation_dashboard.twbx
            Manual_Tasks_Volume_and_Average_source.twbx
            Manual_Tasks_Volume_and_Average_dashboard.twbx
            Task_Level_Performance_source.twbx
            Task_Level_Performance_dashboard.twbx
            Worker_Feedback_source.twbx
            Worker_Feedback_dashboard.twbx
            Worker_Performance_source.twbx
            Worker_Performance_dashboard.twbx

Publish new files

Run publish.cmd to consequently publish (add or replace) each file on WorkFusion Analytics Server.

c:
cd \tdeploy_home\deploy
publish.cmd site_name

The command also moves the published file to

\deploy\deployed\site_name\dashboard

and

\deploy\deployed\site_name\automation

respectively.

The log file will be created in \deploy\log.

As a result the new (updated) workbooks should appear at WorkFusion Dashboard or the Automation tab:

Do not use TWB or TWBX files located in the deploy/to_deploy or deploy/deployed directories repeatedly. Reload them from the delivery package each time.

Specify Schedule to refresh extracts

A Schedule should be configured by an administrator.

There are several pre-configered Schedules on the Server and new Schedules could be added too.

Create Schedule

Go to the Schedules page and click New schedule.

Configure Schedule

Enter a name and choose appropriate values.

Assign Schedule to Workbook

Go back to Content > Workbooks, click ... to expand the options of the required Workbook, then click Refresh Extracts....
Choose Schedule a Refresh, select the required refresh time and click Schedule Refreshes.

A Schedule has been created for the selected workbook.

Repeat the steps 1-3 for each Generic and WF-Automation workbook on the site.

Enable WorkFusion Analytics Dashboard in Control Tower

The following actions should be performed to enable BI Analytics Server in the WorkFusion platform:

Install WorkFusion Analytics server as described in WorkFusion Analytics Server Installation.
Deploy workbooks to WorkFusion Analytics server as described in Deploying Workbooks to WorkFusion Analytics Server.

Enable WorkFusion Analytics server in the WorkFusion platform:

Connect to APP server via SSH.
Edit properties in the properties file (workfusion.properties) under the following path <INSTALL_DIR>/tomcat/conf/workfusion.properties. For Ansible installation, check <INSTALL_DIR>/workfusion/conf/workfusion.properties.

<!-- Set the following variables in True value -->
tableau.dashboard.enabled=true
tableau.automation.enabled=true
 
<!-- Set the value of the APP server tail -->
tableau.server.instance.tail=.example.com
 
<!-- Set Tableau server version -->
tableau.version=9

Property name	Example value	Description	Required for
`tableau.dashboard.enabled`	`true`	WorkFusion Analytics Dashboard and report charts initialization: `true` - Tableau widgets will be displayed on Dashboard page; `false` - Java widgets will be displayed on Dashboard page.	WorkFusion Analytics Dashboard
`tableau.automation.enabled`	`true`	`true` - Tableau automation charts will be displayed on the Automation tab; `false` - Java automation charts will be displayed on the Automation tab.	WorkFusion Analytics charts
`tableau.server.instance.tail`	If APP server DNS = `wfapp.subdomain.example.com` then `.subdomain.example.com`	Server domain name for APP Server	Automation/ML
`tableau.version`	`9`	WorkFusion Analytics Servers version. For all WorkFusion Analytics Servers 9 or higher the value should be `9`.	WorkFusion Analytics UI

Create the secure properties file (Vault) and migrate. For more details regarding secure properties, refer to Manage Security Properties topic.

<!-- Set DNS name of BI server -->
tableau.dashboard.host=https://bi.example.com
tableau.automation.host=https://bi.example.com
  
<!-- Set login and password for connection to BI server -->
tableau.dashboard.username=tableau_user
tableau.dashboard.password=tableau_pass
tableau.automation.username=tableau_user
tableau.automation.password=tableau_pass
 
<!-- Set site and workbooks name for Automation -->
tableau.automation.site=wfapp
tableau.automation.workbook=WF-Automation-r
tableau.new.automation.workbook=WF-Automation-j

Property name	Example value	Description	Required for
`tableau.dashboard.host`	`https://bi.example.com`	WorkFusion Analytics Server website URL for Dashboard	WorkFusion Analytics Dashboard
`tableau.automation.host`	`https://bi.example.com`	WorkFusion Analytics Server website URL	WorkFusion Analytics UI
`tableau.dashboard.username`	`tableau_user`	WorkFusion Analytics Server website username for Dashboard	WorkFusion Analytics Dashboard
`tableau.dashboard.password`	`tableau_pass`	WorkFusion Analytics Server website password for Dashboard	WorkFusion Analytics Dashboard
`tableau.automation.username`	`tableau_user`	WorkFusion Analytics Server website username for WF-Automation	WorkFusion Analytics UI
`tableau.automation.password`	`tableau_pass`	WorkFusion Analytics Server website password for WF-Automation	WorkFusion Analytics UI
`tableau.automation.site`	If APP server DNS=`wfapp.example.com` then `wfapp`	WorkFusion Analytics Server site name	WorkFusion Analytics Dashboard
`tableau.automation.workbook`	`WF-Automation-r`	WorkFusion Analytics workbook for automation data (should always contain the value from example)	WorkFusion Analytics Dashboard
`tableau.new.automation.workbook`	`WF-Automation-j`	Additional WorkFusion Analytics workbook for automation data (should always contain the value from example)	WorkFusion Analytics Dashboard

Restart Tomcat.

<INSTALL_DIR>/apps/webapps/tomcat.init restart

Wait for about one minute and check, that there are no errors in the Control Tower application logs.

Check results

Open the following URL https://<hostname>/ in a browser to go to the APP instance. The following menu appears:
Go to the Dashboard section in the main menu to see widgets. Verify that WorkFusion Analytics Dashboard displays BI widgets:
Go to Manual Tasks - View All Manual Tasks and click the Automation available label to see the Automation report.

caution

Do not use %, &, ^ or = characters and other special symbols in the password.

WorkFusion Documentation

8.5

Preinstall steps

Installation steps

Post-installation steps

Appendix

Single sign-on

WorkFusion Analytics license

Platform Monitor overview

Platform Monitor configuration

Platform Monitor for RPA

important

Pre-installation requirements

WorkFusion Analytics Server installation

Attention

WorkFusion Analytics Desktop installation

Configure SSL WorkFusion Analytics Server

important

Deploy Workbooks to WorkFusion Analytics Server

Pre-deployment requirements

Workbook deployment

Create folders for installation files

Run installation

Create folders for new site

Edit configuration files

caution

Create WorkFusion Analytics site, project and new user

Workbook publishing

Prepare new Workbook files

Publish new files

Specify Schedule to refresh extracts

Create Schedule

Configure Schedule

Assign Schedule to Workbook

Enable WorkFusion Analytics Dashboard in Control Tower

Check results

caution