9.3

Edit

BI Windows Server installation

important

Run the installation of the WorkFusion Analytics Server as Windows Administrator.

Prerequisites

  • Ports are open as listed in Application ports.
  • Installation packages are uploaded to the server(s) and unzipped.
  • WorkFusionAnalyticsInstaller.zip contains two folders: WorkfusionAnalyticsServer and WorkfusionAnalyticsDesktop.
  • License keys for WorkFusion Analytics Server and Desktop (optional) are provided by the WorkFusion team.

Predefined common variables:

  • WorkFusion group: wfuser by default
  • WorkFusion user: wfuser by default
  • WorkFusion Home Directory: WorkfusionAnalyticsServer,D:\\WorkFusionServerWorkfusionAnalyticsDesktop, D:\\WorkFusionDesktop
  • WorkFusion Installer Directory: D:\\WorkfusionAnalyticsServer by default
  • DNS of the Application Server (APP), for instance, the app.example.com
  • Filebeat installation directory: C:\\filebeat by default
  • Analytics server hostname, for instance, bi.example.com
  • APM server hostname, for instance, apm.example.com
  • Port of APM Logstash service: 4567 by default

WorkFusion Analytics Server installation

The installation process can take about 20-25 minutes.

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

Launch the installation batch file (install_server.bat) with the following parameters representing the installation directory and APP host name:

install_server.bat <INSTALL_DIR> <APP_HOSTNAME>

Example:

install_server.bat D:\WorkFusionServer app.exapmle.com

Open Manager Product Keys and enter the license key:

Start → All Programs → Manage Product Keys

For more details about the activation, refer to WorkFusion Analytics license.

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

important

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

WorkFusion Analytics Desktop installation

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

Launch the installation batch file (install_desktop.bat) with the following parameter representing the installation directory:

install_desktop.bat <INSTALL_DIR>

Example:

install_desktop.bat D:\WorkFusionDesktop

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

For more details about the activation, refer to WorkFusion Analytics license.

WorkFusion Analytics Filebeat installation

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

For log gathering, launch the 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

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

Start the Filebeat service:

sc start filebeat

Configure SSL WorkFusion Analytics Server

note

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

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

Add to the <INSTALL_DIR>\\WorkFusion Analytics Server\\conf\\tabsvc.yml Tableau config on the BI Server.

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

Example:

Restart the WorkFusion Analytics Server:

Deploy Workbooks to WorkFusion Analytics Server

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

Mind the prerequisites:

  • Pre-installed Microsoft Server 2008 R2 or newer WorkFusion Analytics Server.
  • 10.5.2 OEM or newer Workbook packages uploaded to the server(s) and unzipped.
  • WorkFusionAnalitycsWorkbooks.zip contains foldersdeploy_scriptsdashboardswf_automation.

Workbook deployment

Log in to the BI server where the WorkFusion Analytics Server is installed and follow the steps below:

Create folders for installation files

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

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

Pre-installation directories after unpacking ZIP:

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

Run installation

Open the Command Prompt and run the command:

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

Created files and directories after running 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 is created in c:\tdeploy_home\install\ named as install_YYYY-MMDD-HHMI.log.

Create folders for new site

cd c:\tdeploy_home\deploy
create_sitefolder.cmd site_name

In the command above, 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 are created on the WorkFusion Analytics Server.

To create more than one site, specify several parameters for the create_sitefolder.cmd command.

This command create configuration files (copied from deploy\\config\\config.\_sample\_.cmd and config.\_sample_WFA\_.cmd) and a few 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: 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

Prepare configuration files

note

You can download the configuration files from the APP server. For details, refer to Preparation of RPA and BI configurations.

Edit the configuration files manually.

In c:\\tdeploy_home\\deploy\\config\\, specify 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

{{x}}—Ansible variable defined earlier

Values for AutoML
config.site_name_WFA.cmd

{{x}}—Ansible variable defined earlier

 Description
DATABASE_SERVER_NAME

DB_HOSTNAME

{{db_hostname}}

DB_HOSTNAME

{{db_hostname}}

 DNS name of the database server
DATABASE_NAME_MYSQL

wfdb

{{workfusion_db_name}}

 Not specified Data source database name
DATABASE_PORT_MYSQL

3306

{{mysql_port}}

 Not specified Default values:
3306 for MySQL
DATABASE_USERNAME_MYSQL {{wfdb_read_user}} Not specified wfdb_read_user from secrets.yml
DATABASE_PASSWORD_MYSQL {{wfdb_read_pass}} Not specified wfdb_read_pass from secrets.yml
DATABASE_NAME_PGSQL

wf_datastore

{{workfusion_datastore_name}}

wfml_automation

Part of {{wf_tableau_db_url}}

 Data source database name
DATABASE_PORT_PGSQL

5432

{{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_URL URL of the Tableau Server
TABLEAU_SERVER_BIN Full path to the \bin directory of the Tableau Server
TABLEAU_SITE site_name site_name

Part of the APP_HOSTNAME

If APP is hosted at https://wfapp.company.com/ the value is wfapp.
TABLEAU_PROJECT site_name WF-Automation Should be identical to the TABLEAU_SITE value in case of dashboards, not automation.
TABLEAU_USERNAME Tableau Server user name with the Server Administrator rights
TABLEAU_PASSWORD Server Administrator user password
SERVICE_WFBI_NAME Not specified Part of {{wfbi_access_url}}

Service WFBI name

If service-wfbi is hosted at https://wfapp.company.com/service-wfbi, the value is fapp.company.com.
TIMEZONE_SHIFT
Not specified

Default value:
0 for the UTC time zone.

For time zomes, do not use the plus symbol (+), only numbers.

Update user credentials

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

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

Replace the existing values with already configured credentials. Th name and password should be identical 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
note

Do not use %, &, ^, or = 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 following command in the Command Prompt:

cd c:\tdeploy_home\deploy 
manage_server.cmd site_name

A site and a project are created on the WorkFusion Analytics Server as site_name and WF-Automation respectively. A new user is added to the created site.

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

Publish Workbook

Prepare new workbook files as described below:

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

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

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

  3. Copy the files from wf_automation:

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

    The datasource folder remains for backward compatibility.

Then, run publish.cmd to consequently publish (add or replace) each file on the WorkFusion Analytics Server.

cd c:\tdeploy_home\deploy
publish.cmd site_name

To publish workbooks on more than one site on the WorkFusion Analytics Server, specify several parameters for the 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

A log file is created in \deploy\log.

As a result, the new (updated) workbooks should appear on the WorkFusion's Analytics or Automation tabs.

note

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.

Refresh extracts schedule configuration

A schedule should be configured by an administrator.

For that, log into WorkFusion Analytics Server. There are several pre-configered schedules on the server, and a new schedule for correct data refreshing should be added, too.

Create schedule

Go to the Schedules page and click New schedule:

Configure schedule

Enter a name and choose appropriate values. The minimal frequency is 15 minutes.

Choose the Serial execution type for correct data refresh.

Assign schedule to workbook

  1. Go back to Content → Workbooks, click ... to expand the options of the required Workbook, then click Refresh Extracts.... The 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 Workbook refresh order

To prevent data gaps, change the ETL workbook priority.

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

  2. Set Priority to 10 and click Change Priority.

The ETL workbook will be refreshed first.

Enable WorkFusion Analytics dashboard in Control Tower

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

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

  2. Deploy Workbooks to the WorkFusion Analytics Server as described in Deploy Workbooks to WorkFusion Analytics Server.

  3. Enable the WorkFusion Analytics Server in the WorkFusion platform:

    1. Check and configure the vault secure properties file on the DB server (should be configured before installation). For details about secure properties, refer to How to View Secrets article.

      <!-- 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 the 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 the dashboard (was used in import_users.csv). WorkFusion Analytics dashboard
      tableau.dashboard.password

      tableau_pass

      		 WorkFusion Analytics Server website password for the dashboard (was used in import_users.csv). WorkFusion Analytics dashboard
      tableau.automation.username

      tableau_user

      		 WorkFusion 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.password

      tableau_pass

      		 WorkFusion 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

    2. Restart the WorkFusion service on the APP server:

      sudo su - wfuser; wfmanager restart workfusion

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

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

Check results

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

Go to Analytics section in the main menu to see the dashboard. Overview is the 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.

← PreviousNext →