BI Server installation · WorkFusion Documentation

note

Run the installation of WorkFusion Analytics Server as Windows Administrator.

Pre-installation requirements

Configure open ports

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 installation package

The link is provided by WorkFusion team: WorkFusionAnalyticsInstaller.zip containing two folders (WorkfusionAnalyticsServer and WorkfusionAnalyticsDesktop).

License keys

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

WorkFusion Analytics Server installation

The installation process can take about 15-20 minutes.

Download WorkFusionAnalitycsInstaller.zip (the URL will be provided by the WorkFusion team) and unpack the archive.
Start the Command Prompt (do not use PowerShell) 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.

caution

Do not use %, &, ^, or = characters and other special symbols in the password ($ symbol is allowed).

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 following parameter: installation directory:
```
install_desktop.bat ${INSTALL_DIR}
```
Example
```
install_desktop.bat D:\WorkFusionDesktop
```
Start WorkFusion Analytics Desktop using the Desktop shortcut and enter a license key.

For more details about activation, refer to WorkFusion Analytics License.

Configure SSL WorkFusion Analytics Server

note

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

The 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.5.2 OEM or newer

Pre-publishing preparations:

Get the WorkFusionAnalitycsWorkbooks.zip installation package from the WorkFusion team. It will contain the following folders: deploy_scripts, dashboards, wf_automation.
Log in to the BI server using RDP where WorkFusion Analytics Server has been installed and follow the next steps:
1. Create a folder: C:\tdeploy_home\install.
2. Copy files from the deploy_scripts folder to C:\tdeploy_home\install.

Pre-installation directories after unpacking a zip file:

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

Run installation

Open the Command Prompt and run the install.cmd command:

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, deploy_datasource.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 a 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).

To create more than one site folder need to specify several parameters for the create_sitefolder.cmd command.

The 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                (dashboards for deploying)
                 \automation          (WF-Automation dashboards)
                 \dashboard           (generic dashboard)
                 \datasource          (data sources for generic dashboard)
        \deployed
            \site_name                (already deployed dashboards: are being moved from \to_deploy\site_name during deploy process)
                 \automation
                 \dashboard
                 \datasource

Final directory structure:

c:\tdeploy_home
    \install
        \lib
    \deploy        
        \config    
        \lib       
        \to_deploy 
            \site_name
                 \automation
                 \dashboard
                 \datasource
        \deployed
            \site_name
                 \automation
                 \dashboard
                 \datasource
        \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 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_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

Specific parameter for config.site_name.cmd:

REM MySQL options
SET DATABASE_NAME_MYSQL=dbname
SET DATABASE_PORT_MYSQL=0000
SET DATABASE_USERNAME_MYSQL=dbuser
SET DATABASE_PASSWORD_MYSQL=dbpass
REM Timezone correction parameter in hours (0 for UTC)
SET TIMEZONE_SHIFT=0

Specific parameter for config.site_name_WFA.cmd:

SET SERVICE_WFBI_NAME=swfbiurl.com

Config parameter	Values for Control Tower config.site_name.cmd	Values for AutoML config.site_name_WFA.cmd	Description
`DATABASE_SERVER_NAME`	`DB_HOSTNAME`	`DB_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`	Use "{{ workfusion_db_user }}" Ansible variable defined earlier	not specified	workfusion_db_user from secrets.yml
`DATABASE_PASSWORD_MYSQL`	Please use "{{ workfusion_db_pass }}" Ansible variable defined earlier	not specified	workfusion_db_pass from secrets.yml
`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`	Please use "{{ workfusion_datastore_user }}" Ansible variable defined earlier	Please use "{{ wfbi_db_user }}" Ansible variable defined earlier	Variables from secrets.yml
`DATABASE_PASSWORD_PGSQL`	Please use "{{ workfusion_datastore_pass }}" Ansible variable defined earlier	Please use "{{ wfbi_db_pass }}" Ansible variable defined earlier	Variables from secrets.yml
`TABLEAU_SERVER_URL`			URL of the Tableau Server
`TABLEAU_SERVER_BIN`			Full path to the \`bin` directory of Tableau Server
`TABLEAU_SITE`	`site_name`	`site_name`	part of the `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 `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
`SERVICE_WFBI_NAME`	not specified		Service WFBI name if service-wfbi is hosted at `https://wfapp.company.com/service-wfbi` the value will be `wfapp.company.com`
`TIMEZONE_SHIFT`		not specified	default value: 0 - for UTC time zone. 'Plus' symbol (+) for time zones should not be mentioned (only number).

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

Replace the existing value with credentials of a new user and an e-mail address. A user will be created on WorkFusion Analytics Server. This new user will be a user for Tableau configuration on the instance (the .properties file). E-mail is needed for Alerts mechanism availability.

import_users.csv:
```
NewUserName,NewUserPassword,,,,,email@example.com
```

caution

Do not use %, &, ^, or = characters and other special symbols in the password (the $ symbol is allowed).

Do not add or delete any commas in import_users.csv.

Create WorkFusion Analytics Site, project and user

Run the manage_server.cmd command in the Command Prompt:

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 Interactor role. It should be used during the Enable WorkFusion Analytics Dashboard in Control Tower section implementation.

To create more than one site on WorkFusion Analytics Server, specify several parameters for the manage_server.cmd command.

Workbook publishing

Prepare new workbook files

Download the Workbook packages provided by the WorkFusion team.

Copy files from the dashboards/workbook folder to:

\tdeploy_home\deploy\to_deploy\site_name\dashboard

From dashboards/datasource to:

\tdeploy_home\deploy\to_deploy\site_name\datasource

and from wf_automation to:

\tdeploy_home\deploy\to_deploy\site_name\automation

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

To publish workbooks on more than one site on WorkFusion Analytics Server, specify several parameters for the publish.cmd command.

The command also moves the published file to the following folders respectively:

\deploy\deployed\site_name\datasource
\deploy\deployed\site_name\dashboard
\deploy\deployed\site_name\automation

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

As a result the new (updated) workbooks should appear at WorkFusion Analytics or on the Automation tab.

caution

Do not use TWB and 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.

To create a schedule, go to the Schedules page and click New schedule.

To configure a schedule, enter a name and choose appropriate values.

To assign a schedule to a Workbook, do as follows:

Go back to Content > Workbooks, click ... to expand the options of the required Workbook, then click Refresh Extracts.... The schedule should be assigned to the WF-Automation workbook.
Choose Schedule a Refresh, select the required refresh time, and click Schedule Refreshes.

A schedule is created for the selected workbook.

To assign a schedule to a Data Source, do as follows:

Go back to Content > Data Sources, select all items manually, or use the Select All menu.
Click Actions > Refresh Extracts....
Choose Schedule a Refresh, select the required refresh time, and click Schedule Refreshes.

A schedule has been created for the selected data sources.

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 WorkFusion platform:

Connect to APP server via SSH.
Check and configure the secure properties file (Vault) on DB server. 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

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 (from import_users.csv)	WorkFusion Analytics Dashboard
`tableau.dashboard.password`	`tableau_pass`	WorkFusion Analytics Server website password for Dashboard (from import_users.csv)	WorkFusion Analytics Dashboard
`tableau.automation.username`	`tableau_user`	WorkFusion Analytics Server website username for WF-Automation (from import_users.csv)	WorkFusion Analytics UI
`tableau.automation.password`	`tableau_pass`	WorkFusion Analytics Server website password for WF-Automation (from import_users.csv)	WorkFusion Analytics UI

Restart Tomcat.

sudo su - wfuser; wfmanager restart workfusion

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

sudo su - wfuser; tailf -n 50 /opt/workfusion/supervisord/log/workfusion.out.log

note

Perform an additional configuration step for installation with SSL according to the Add third-party service certificates to Truststore.

Check results

Open the following URL https://<hostname>/ in a browser to go to the APP instance. The following menu appears:
Go to Analytics in the main menu to see a dashboard. Overview is a default tab.
Verify that WorkFusion Analytics displays the dashboard:
Go to Manual Tasks > View All and click the Cognitive Bot Ready label to see the Automation report.