9.2

Edit

BI Windows Server installation

Run installation of WorkFusion Analytics Server as Windows Administrator

Prerequisites

  • Ports are open.

  • Installation packages are uploaded to the server(s) and unzipped.

  • WorkFusionAnalyticsInstaller.zip contains 2 folders (WorkfusionAnalyticsServer and WorkfusionAnalyticsDesktop)

  • License keys for WorkFusion Analytics Server and Desktop (optional) provided by Workfusion Team.

  • Workfusion Analytics Server 2021.x require Windows Server 2016 and later

  • Predefined common variables:

    • WF_GROUP: WorkFusion group. Default is wfuser
    • WF_USER: WorkFusion user. Default is wfuser
    • INSTALL_DIR: WorkFusion Home Directory. Defaults are
      • WorkFusion Analytics Server: D:/WorkFusionServer
      • WorkFusion Analytics Desktop: D:/WorkFusionDesktop
      • <PACKAGE_DIR>: WorkFusion Installer Directory. Default is D:/WorkfusionAnalyticsServer
      • APP_HOSTNAME: DNS of Application server (APP), for example, app.example.com
      • Filebeat service:
        • FILEBEAT_DIR: Filebeat installation directory. Default is C:\filebeat
        • BI_HOSTNAME: Analytics server hostname, for example, bi.example.com
        • APM_HOSTNAME: APM server hostname, for example, apm.example.com
        • PORT: port of APM Logstash service. Default port is 4567

WorkFusion Analytics Server installation

Installation process can take about 20-25 minutes.

  1. Start the Command Prompt (cmd) and go to the WorkfusionAnalyticsServer folder in the unpacked installation package.

  2. 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 app.exapmle.com

    If you are installing WorkfusionAnalyticsServer 2021.x, specify the licence key as a third parameter. Otherwise Trial version will be activated.

    install_server.bat <INSTALL_DIR> <APP_HOSTNAME> <SERVER_LICENCE_KEY>

    Example

    install_server.bat D:\WorkFusionServer app.exapmle.com 1111-2222-3333-4444-5555

    If you've already specified licence key, you can skip the next step

  3. 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.

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

    important

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

WorkFusion Analytics Desktop installation

  1. Start the Command Prompt (cmd) and go to the WorkfusionAnalyticsDesktop folder in the unpacked installation package

  2. 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

  3. Start WorkFusion Analytics Desktop using the Desktop shortcut and enter license key.

    For more details about Activation refer to WorkFusion Analytics license.

WorkFusion Analytics Filebeat installation

  1. Start the Command Prompt (cmd) and go to the Filebeat folder in the unpacked installation package.

  2. For log gathering launch installation file (install_filebeat.bat) with the following parameters (use <INSTALL_DIR> for WorkfusionAnalyticsServer):

    install_filebeat.bat <FILEBEAT_DIR> <INSTALL_DIR> <BI_HOSTNAME> <APM_HOSTNAME>:<PORT>

    Example

    install_filebeat.bat D:\filebeat D:\WorkFusionServer bi.exapmle.com apm.exapmle.com:4567

  3. Copy the root certificate CA.crt file which was generated during the preparation steps to BI server into <FILEBEAT_DIR> and update <FILEBEAT_DIR>/filebit.yml config file with a path to the certificate:

  4. Start the Filebeat service:

    sc start filebeat

Configure SSL WorkFusion Analytics Server

SSL configuration is mandatory in case the whole environment is configured with secure connection.

  1. Import BI certificate and a key generated during the preparation steps and place it to <INSTALL_DIR>.

  2. 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:

    For the WorkfusionAnalyticsServer 2021.x installation, configure SSL with the following commands:

    Configure SSL

    tsm security external-ssl enable --cert-file "<path to the certificate>" --key-file "<path to the key>"

    Example

    tsm security external-ssl enable --cert-file "C:\ssl\bi.crt" --key-file "C:\ssl\bi.key"

  3. Restart WorkFusion Analytics Server.

    For the WorkfusionAnalyticsServer 2021.x installation, apply the changes by running the following commands:

    tsm pending-changes apply --ignore-prompt  --request-timeout 1800

Deploying Workbooks to WorkFusion Analytics Server

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

Pre-installed Software:

  • Microsoft Server 2008 R2 or newer
  • WorkFusion Analytics Server 10.5.2 OEM or newer

Workbooks packages are uploaded to the server(s) and unzipped. WorkFusionAnalitycsWorkbooks.zip contains the following folders:

  • deploy_scripts
  • dashboards
  • wf_automation

Workbook deployment

Log in to the BI server where WorkFusion Analytics Server is installed and perform the following steps.

Create folders for installation files

  1. Create a folder c:\tdeploy_home\install.

  2. Copy files from deploy_scripts folder to c:\tdeploy_home\install.

    Pre-installation directories after unpacking a zip archive are as follows:

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

  3. To install, open the Command Prompt and run the command:

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

Created files and directories after install.cmd are as follows:

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 is created in c:\tdeploy_home\install\ named as install_YYYY-MMDD-HHMI.log.

To create folders for a new site, do as follows:

cd c:\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 create_sitefolder.cmd command.

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 are as follows:

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

The final directory structure is as follows:

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

Configuration files preparation

You can download configuration files from APP server. Find the detailed information at Preparation of RPA and BI configurations.

To edit the configuration files manually, in c:/tdeploy_home/deploy/config, specify the appropriate values in config.site_name.cmd and config.site_name_WFA.cmd.

Common config parameters are as follows:

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 parameters for config.site_name.cmd are as follows:

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

A specific parameter for config.site_name_WFA.cmd is as follows:

SET SERVICE_WFBI_NAME=swfbiurl.com
Config parameterValues for Control Tower
config.site_name.cmd

{{ x }} - Ansible variable defined earlier		Values for AutoML
config.site_name_WFA.cmd

{{ x }} - Ansible variable defined earlier		Description
DATABASE_SERVER_NAMEDB_HOSTNAME

{{ db_hostname }}		DB_HOSTNAME

{{ db_hostname }}		DNS name of the database server
DATABASE_NAME_MYSQLwfdb

{{ workfusion_db_name }}		not specifieddata source's database name
DATABASE_PORT_MYSQL3306

{{ mysql_port }}		not specifieddefault values:
3306 for MySQL
DATABASE_USERNAME_MYSQL{{ wfdb_read_user }}not specifiedwfdb_read_user from secrets.yml
DATABASE_PASSWORD_MYSQL{{ wfdb_read_pass }}not specifiedwfdb_read_pass from secrets.yml
DATABASE_NAME_PGSQLwf_datastore

{{ workfusion_datastore_name }}		wfml_automation

part of {{ wf_tableau_db_url }}		data source's database name
DATABASE_PORT_PGSQL5432

{{ postgresql_port }}		5432

{{ postgresql_port }}		default values:
5432 for PostgreSQL
DATABASE_USERNAME_PGSQL{{ workfusion_analytics_user }}{{ wfbi_db_user }}Variables from secrets.yml
DATABASE_PASSWORD_PGSQL{{ workfusion_analytics_pass }}{{ wfbi_db_pass }}Variables from secrets.yml
TABLEAU_SERVER_URLURL of the Tableau Server
TABLEAU_SERVER_BINFull path to the \bin directory of Tableau Server
TABLEAU_SITEsite_namesite_name
part of the APP_HOSTNAME

if APP is hosted at https://wfapp.company.com/ the value will be wfapp
TABLEAU_PROJECTsite_nameWF-Automationshould be equal to TABLEAU_SITE value in case of dashboards, not automation
TABLEAU_USERNAMETableau Server user name with "Server Administrator" rights
TABLEAU_PASSWORD"Server Administrator" user's password
SERVICE_WFBI_NAMEnot specifiedpart of {{ wfbi_access_url }}
Service WFBI name

if service-wfbi is hosted at https://wfapp.company.com/service-wfbi the value will be wfapp.company.com
TIMEZONE_SHIFTnot specifieddefault value:
0 - for UTC time zone.

'Plus' symbol (+) for time zones should not be mentioned (only number).

Update credentials

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

A new user is created on WorkFusion Analytics Server and should be used for Control Tower and Analytics integration. It is added with the Interactor role.

Replace the existing values with already configured credentials. Name and Password should be equal to the {{wf_tableau_dashboard_username}} and {{wf_tableau_dashboard_password}} properties generated during preparation steps in the secrets.yml file.

import_users.csv

tableau_user,tableau_pass,,,,,email@example.com

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 new user

Run the following command in the Command Prompt:

cd c:\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 is added to a newly created site.

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

Workbook publishing

Prepare new Workbook files

  1. Download the Workbook packages (provided by WorkFusion team).

  2. Copy files from the dashboards/workbook folder to:

    c:\tdeploy_home\deploy\to_deploy\site_name\dashboard

  3. Copy files from wf_automation to:

    c:\tdeploy_home\deploy\to_deploy\site_name\automation

The datasource folder remains for the backward compatibility.

Publish new files

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

cd c:\tdeploy_home\deploy
publish.cmd site_name

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

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

c:\deploy\deployed\site_name\dashboard
c:\deploy\deployed\site_name\automation

The log file is created in /deploy/log.

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

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.

Schedule configuration

A Schedule should be configured by an Administrator.

Log in to the WorkFusion Analytics Server.

There are several pre-configered Schedules on the Server and new Schedule for correct data refresh should be added too.

Creating schedule

Go to the Schedules page and click New schedule.

WorkfusionAnalyticsServer 2021.x:

Configure schedule

Enter a name and choose appropriate values.

Minimal frequency is 15 minutes.

Remember to select the Serial execution type for correct data refresh.

WorkfusionAnalyticsServer 2021.x:

Assign schedule to workbook

WorkfusionAnalyticsServer 2020.x:

  1. Go back to Content → Workbooks, click '...' to expand the options of the required Workbook, then click Refresh Extracts.... Schedule should be assigned to "AA_ETL_process" and "Analytics_WB" workbooks.

  2. Choose Schedule a Refresh, select the required refresh time and click Schedule Refreshes.

WorkfusionAnalyticsServer 2021.x:

  1. Go to Explore → <Site name>, click '...' to expand the options of the required Workbook, then click Refresh Extracts.... Schedule should be assigned to "AA_ETL_process" and "Analytics_WB" workbooks.

  2. Choose Schedule a Refresh, select the required refresh time and click Schedule Refreshes.

A schedule is created for the selected workbook.

Define Workbooks refresh order

Priority for ETL workbook should be changed to prevent data gap.

WorkfusionAnalyticsServer 2020.x:

  1. Go to Tasks → Extract Refreshes, click '...' on "AA_ETL_process" workbook to expand the options, then click Change Priority....

  2. Set Priority to 10 and click Change Priority.

WorkfusionAnalyticsServer 2021.x:

  1. Go to Schedules → <Created schedule>, click '...' on "AA_ETL_process" workbook to expand the options, then click Change Priority....

  2. Set Priority to 10 and click Change Priority.

ETL workbook is refreshed first.

Enable WorkFusion Analytics dashboard in Control Tower

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

  1. Install WorkFusion Analytics server as described in WorkFusion Analytics Server installation.

  2. Deploy Workbooks to WorkFusion Analytics server as described in Workbook deployment.

  3. Enable WorkFusion Analytics server in WorkFusion platform:

    1. Check and configure the secure properties file (Vault) on DB server (should be already configured before installation). Refer to View Secrets article to view secure properties.
        <!-- 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 nameExample valueDescriptionRequired for
    tableau.dashboard.hosthttps://bi.example.comWorkFusion Analytics Server website url for DashboardWorkFusion Analytics Dashboard
    tableau.automation.hosthttps://bi.example.comWorkFusion Analytics Server website urlWorkFusion Analytics UI
    tableau.dashboard.usernametableau_userWorkFusion Analytics Server website username for Dashboard (was used in import_users.csv)WorkFusion Analytics Dashboard
    tableau.dashboard.passwordtableau_passWorkFusion Analytics Server website password for Dashboard (was used in import_users.csv)WorkFusion Analytics Dashboard
    tableau.automation.usernametableau_userWorkFusion Analytics Server website username for WF-Automation. Automation is published on the same server so the same credentials as for tableau.dashboard should be used.WorkFusion Analytics UI
    tableau.automation.passwordtableau_passWorkFusion Analytics Server website password for WF-Automation. Automation is published on the same server so the same credentials as for tableau.dashboard should be used.WorkFusion Analytics UI
    1. Restart Workfusion service on APP server
        sudo su - wfuser; wfmanager restart workfusion
    1. Wait for about 1 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

Check results

  1. Open the following URL https://<hostname>/ in a browser to go to the APP server. The following menu appears:

  2. Go to Analytics section in the main menu to see dashboard. Overview is a default tab.

  3. Verify that WorkFusion Analytics displays dashboard:

  4. Go to Manual Tasks - View All and click the Cognitive Bot Ready label to see the Automation.

← PreviousNext →