10.0

Edit

Install BI Windows Server

Prerequisites

  • Application Ports are open.

  • Installation packages are uploaded to one or several servers and unarchived. WorkFusionAnalyticsInstaller.zip contains the following directories with installers:

    • WorkfusionAnalyticsServer
    • WorkfusionAnalyticsDesktop

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

  • The predefined common variables are the following:

    • <bi_user>. A user with Administrator rights under which installation is performed.
    • INSTALL_DIR. WorkFusion home directory C:\workfusion.
    • Defaults directories are the following:
      • WorkfusionAnalyticsServer – INSTALL_DIR\WorkFusionAnalyticsServer
      • WorkfusionAnalyticsDesktop – INSTALL_DIR\WorkFusionDesktop
    • PACKAGE_DIR. WorkFusion Installer Directory. Default is INSTALL_DIR\WorkfusionAnalyticsServer.
    • <app-hostname>**. DNS of Application server (APP), for example, app.example.com.

  • <filebeat-dir> - FileBeat installation directory. Default is C:\workfusion\filebeat.

    • <bi-hostname> - Analytics server hostname, for example, bi.example.com.
    • <int-hostname> - Integration server hostname, for example,int.example.com.
    • <port> - port of INT Logstash service. Default port is 4567.

Install WorkFusion Analytics Server

Always run installation of WorkFusion Analytics Server as a Windows Administrator user. The Installation process takes about 20-25 minutes.

Before the installation, the Analytics databases must be migrated. To migrate the databases, on the INT server, run:

./install.sh migrate bi

The databases can also be migrated after the installation. In this case, run the earlier command and restart the Analytics server to apply the changes.

To install the Analytics Server:

  1. On your prepared server, start the Command Prompt (not PowerShell) and, in the unpacked installation package, go to the WorkfusionAnalyticsServer directory.

  2. Set the following environment variables:

    SET lic_key=trial
SET bi_user=ec2-user
SET bi_pass=1q2w3e!
SET TABLEAU_USER=tableau_user
SET TABLEAU_PASS=tab1q2w!

    Here,

    • bi\_user is a user with Administrator rights under which installation is performed.
    • bi\_pass is a password of a win\_user.
    • TABLEAU\_USER is a tableau\_dashboard\_user of Workfsion Analitycs Server.
    • TABLEAU\_PASS is a tableau_dashboard_pass of a TABLEAU_USER. Note that special symbols are not allowed in the password.

  3. Copy the bi.crt and bi.key certificate files to the INSTALL_DIR directory.

    Note: SSL configuration is mandatory starting from Intelligent Automation Cloud version 10.0.

  4. Run the installation Batch file install_server.bat with the specified installation directory and APP host name.

    install_server.bat *`INSTALL_DIR`* <APP_HOSTNAME>

    Example:

    install_server.bat C:\workfusion\WorkFusionServer app.exapmle.com

  5. Log in to the server and activate it with the license key. Optional.

    tsm login -u <bi_user>

tsm licenses activate -k <product key>

    By default, the install_server.bat script activates the trial Tableau license for two weeks. Thus the step is optional.

  6. On the BI server, in a browser, open https://localhost.

    Create Tableau acc

Install WorkFusion Analytics Desktop

To install the Analytics Desktop:

  1. On your server, start the Command Prompt (not PowerShell) and go to the WorkfusionAnalyticsDesktop directory in the unpacked installation package.

  2. Run the installation Batch file install_desktop.bat with the specified installation directory:

    install_desktop.bat INSTALL_DIR

# Example: install_desktop.bat C:\workfusion\WorkFusionDesktop

  3. Click the WorkFusion Analytics Desktop shortcut to start the application, and then enter the license key.

    Enter key

    For more information on Activation options, see Manage the WorkFusion Analytics license.

Install WorkFusion Analytics Filebeat

To install Filebeat:

  1. Start the Command Prompt (not PowerShell) and go to the Filebeat directory in the unpacked installation package.

  2. To enable log gathering, run the installation file install_filebeat.bat with the specified parameters. Specify INSTALL_DIR as a directory on WorkfusionAnalyticsServer.

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

# Example: install_filebeat.bat C:\workfusion\filebeat C:\workfusion\WorkFusionServer bi.example.com int.example.com:4567

  3. Copy the root certificate ca.crt file, which has been generated earlier, to the BI server's directory <filebeat-dir>, and in the <filebeat-dir>/filebeat.yml config file, add the path to the certificate.
    Filebeat

  4. Start the Filebeat service:

    sc start filebeat

Install WorkFusion Analytics Metricbeat

To install Metricbeat:

  1. Start the Command Prompt (not PowerShell) and go to the metricbeat directory in the unpacked installation package.

  2. To enable metrics gathering, run the installation file install_metricbeat.bat with the specified parameters. Specify INSTALL_DIR as a directory on WorkfusionAnalyticsServer.

    install_metricbeat.bat <METRICBEAT_DIR> INSTALL_DIR <BI_HOSTNAME> <INT_HOSTNAME>:<PORT>

# Example: install_metricbeat.bat C:\workfusion\metricbeat C:\workfusion\WorkFusionServer bi.example.com INT.example.com:4569

  3. Copy the root certificate ca.crt file, which was generated earlier, to BI server's directory <metricbeat-dir>and in the <metricbeat-dir>/metricbeat.yml config file, add the path to the certificate:

    Metricbeat

  4. Start the etricbeat service:

    sc start metricbeat

Deploy workbooks to WorkFusion Analytics Server

This section describes deployment of Tableau workbooks to Tableau 2018.3 Server OEM on WorkFusion Analytics Server.

The following workbooks must be uploaded to WorkFusion Analytics Server:

  • Overview_WB
  • Capacity_WB
  • AutoML_WB
  • RPA_WB
  • Process_WB
  • Speed_WB
  • Manual_WB
  • AA_ETL_Scheduler

Prerequisites

Pre-installed software:

  • Microsoft Server 2008 R2 or newer
  • WorkFusion Analytics Server 2018.3.2 or newer

Note that installation package contains 2018.3.9 version of WorkFusion Analytics Server.

Workbooks packages are uploaded to the servers and unarchived. The WorkFusionAnalitycsWorkbooks.zip archive contains the following directories:

  • deploy_scripts
  • dashboards

Deploy workbooks

To deploy workbooks, log in to the BI server with the installed WorkFusion Analytics Server and perform the following steps:

  1. Create the c:\workfusion\tdeploy_home\install directory and copy files from the deploy_scripts directory to it.

    Pre-installation directories after unpacking .zip

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

  2. Open the Command Prompt (not PowerShell), and run the following installation command:

    cd c:\workfusion\tdeploy_home\install

install.cmd c:\workfusion\tdeploy_home

    Created files and directories after install.cmd

    c:\workfusion\tdeploy_home
    \deploy        (files: create_sitefolder.cmd, publish.cmd, manage_server.cmd)
        \config    (files: config._sample_.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 in the install_YYYY-MMDD-HHMI.log format is created in c:\workfusion\tdeploy_home\install\.

  3. Create directories for a New website:

    cd c:\workfusion\tdeploy_home\deploy

create_sitefolder.cmd site_name

    Here, 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 website and a project with the same name will be created on the WorkFusion Analytics Server.

    To create several site folders, specify parameters for the create_sitefolder.cmd command. The command creates the new configuration file and new directories. The configuration file is copied from deploy\config\config._sample_.cmd.

    New files and directories after create_sitefloder.cmd

    c:\workfusion\tdeploy_home
    \deploy
        \config
            config.site_name.cmd      (settings for the site "site_name")
        \to_deploy
            \site_name                (dashboards for deploying)
                 \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)
                 \dashboard
                 \datasource

    Final directory structure

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

  4. Prepare configuration files.

    You can download the configuration files from the APP Server. For more information, see Prepare RPA, OCRWIN and BI configurations.

    If needed, change the files manually.

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

    Common config parameters

    REM MSSQL DB options
SET DATABASE_SERVER_NAME=servername     (MSSQL_HOSTNAME)
SET DATABASE_NAME=workfusion
SET DATABASE_PORT=1433
SET DATABASE_USERNAME=dbuser
SET DATABASE_PASSWORD=dbpass
REM WorkFusion Analytics Dashboard option
SET REQUIRE_SSL=1
REM WorkFusion Analytics (Tableau) Server options
SET TABLEAU_SERVER_URL="https://tableau.com"
SET TABLEAU_SITE=usersite               (site_name)
SET TABLEAU_USERNAME=tabuser            (user role must be Server Administrator)
SET TABLEAU_PASSWORD=tabpass

    Config parameter

    Values for Control Tower
    config.site_name.cmd

    {{ x }} - Ansible variable defined earlier

    		 Description 
    DATABASE_SERVER_NAME

    MSSQL_HOSTNAME

    {{ mssql_hostname }}

    		 A DNS name of the MS SQL database server 
    DATABASE_NAME

    workfusion

    		 An MS SQL database name 
    DATABASE_PORT

    1433

    {{ mssql_port }}

    		 The default value is 1433 for MS SQL 
    DATABASE_USERNAME
    		 
    {{ mssql_dm_user }}
    		 mssql_dm_user from secrets.yml 
    DATABASE_PASSWORD
    		 {{ mssql_dm_pass }} mssql_dm_pass from secrets.yml 
    REQUIRE_SSL
    		 1 The option for dashboard connection to require SSL.
    Possible values are 0 or 1. Default value is 1    		 
    TABLEAU_SERVER_URL
    		 
    "https://{{ bi_hostname }}"
    		 The URL of the Tableau Server 
    TABLEAU_SITE

    site_name

    {{ wf_tableau_site }}

    A part of the APP_HOSTNAME

    if APP is hosted at https://wfapp.company.com/ the value will be wfapp 
    TABLEAU_USERNAME
    		 
    {{ bi_user }}
    		 A Tableau Server user name with "Server Administrator" rights 
    TABLEAU_PASSWORD
    		 
    {{ bi_pass }}
    		 The "Server Administrator" user's password

  5. In c:\workfusion\tdeploy_home\deploy\config\, open import_users.csv, and specify the appropriate values. A new user is created on WorkFusion Analytics Server and must be used for Control Tower – Analytics integration. The new user is added with the 'Viewer' role.

    Also, replace the existing values with already configured credentials. Name and Password must be equal to {{wf\_tableau\_dashboard\_username}} and {{wf\_tableau\_dashboard\_password}} properties generated in config.yml file during preparation.

    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.

  6. Create a WorkFusion Analytics website, a project and a new user by running the following command in the command-line tool:

    cd c:\workfusion\tdeploy_home\deploy

manage_server.cmd site_name

    A website and a project are created on WorkFusion Analytics Server as site_name and WF-Automation respectively. The new user is added to a newly created website. To create several websites on the Server, specify the required parameters for the manage_server.cmd command.

Publish workbooks

To publish workbooks:

  1. Download the Workbook packages, which are provided by the WorkFusion team, and copy files from folder dashboards/workbook to the c:\workfusion\tdeploy_home\deploy\to_deploy\site_name\dashboard directory. The datasource directory must remain unchanged for backward compatibility.

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

    cd c:\workfusion\tdeploy_home\deploy
publish.cmd site_name

    To publish workbooks on several websites on WorkFusion Analytics Server, specify the corresponding parameters for publish.cmd command. This command also moves the published file to the c:\workfusion\deploy\deployed\site_name\dashboard directory. As a result, the updated workbooks appear at WorkFusion Analytics page.The log file is created in \deploy\log.

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

Schedule Configuration

A user with the administrator privileges configures a Schedule on WorkFusion Analytics Server. The new Schedule must be added to the Server along with other already existing pre-configured Schedules.

To create a schedule:

  1. In Tableau, in the main menu, click Schedules, and then click New Schedule.

    Schedules

  2. Specify the following options:

    • Name.
    • Execution: serial. Select this option for correct data update.
    • Frequency: minimum 15 minutes.

    New schedule

  3. Assign a Schedule to a Workbook:

    1. Go to Content → Workbooks, select a required Workbook, click More (...) to expand the options, and then click Refresh Extracts. The Schedule must be assigned to the AA_ETL_Scheduler and all *_WB Workbooks.

      Refresh

    2. Go to the Schedule a Refresh tab, select the required refresh time and click Schedule Refreshes.

      Schedule

      A Schedule is now created for the selected Workbook.

  4. Specify the Workbooks refresh order. The priority for ETL workbook mustbe changed to prevent data gap. For that:

    1. Go to Tasks → Extract Refreshes, select the AA_ETL_Scheduler workbook, and then click More (...) → Change Priority.

      Change priority

    2. Set priority to 10 and click Change Priority.

      Priority

      The ETL workbook will be refreshed first.

Enable WorkFusion Analytics Dashboard in Control Tower

To enable BI Analytics Server on WorkFusion platform:

  1. Install WorkFusion Analytics server as described in WorkFusion Analytics Server Installation.
  2. Deploy workbooks to WorkFusion Analytics server as described in Deploying Workbooks to WorkFusion Analytics Server.
  3. Enable WorkFusion Analytics server on WorkFusion platform:

    1. On the INT Server, check and configure the Vault secure properties file. The file must already be configured before the installation.

      <!-- 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

    2. On the APP Server, restart the Workfusion service:

      sudo su - bi_user; wfmanager restart workfusion

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

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

Check the installation

To check the installation:

  1. In a browser, open URL https://<hostname>/> to go to the APP instance. The following menu appears:

    ct-menu

  2. In the main menu, go to the Analytics group to check that the the dashboard is displayed.

    check-dashboard

← PreviousNext →