DSA AD Installation Checklist

From DataSelf Knowledge Base
Jump to navigation Jump to search

For more information on DSA AD see DSA_Automatic_Distribution

CHECKLIST for New Installations of DSA AD

Software Requirements

For a complete list of requirments and instructions on how to verify them see DSA AD Software Requirements.

Software Requirements Summary
  • Recommended: PDF reader

Hardware Requirements

See DataSelf Web Server / Tableau Server Requirements.

  • If the server is running on a virtual machine (VM) use Microsoft Task Manager to see how many logical or virtual processors and RAM is available to the VM.

Security & Network Requirements

  • Ability to connect to a SMTP server to send email
  • Ability to connect to DataSelf Analytics Web Server

For more information see Security & Connection Information Required below.


Information Required

The installer will need the following information in order to install and test the DSA AD module.

Contacts

  1. Contact information for server's IT manager.
    • A re-boot may be required.
  2. Contact information for person who can provide the information listed here should the installer encounter a problem.
  3. Contact information for person or person(s) to receive project status reports.

Security & Connection Information Required

  1. Remote connection to computer server hosting DSA.
  2. Windows User that will run DSA AD on the server hosting DSA/Tableau. (Running DSA AD means DSA AD is running reports and distributing the output)
  3. The Windows user will need to:
    1. Have full access to files in the folder containing DSA AD (especially the Settings sub-folder).
    2. Be able to run programs from .bat files.
    3. Be able to run SQL Server Management Studio in order to create and maintain scheduled jobs with SQL Server Agent.
    4. Be able to run SQL Server Agent jobs on demand for testing.
  4. Logon to DataSelf Analytics Web Server (DSA Web Server)
    1. URL ("domain name") to DSA Web Server
    2. User Name - User with ability to create and modify views
    3. Password
  5. Email Server - (See Recommended Email Server below)
    1. URL to SMTP server. e.g. "Smtp.gmail.com"
    2. SMTP server's Port number.
    3. User name & Password.
    4. Server uses SSL - Yes or No.
    5. "From" email address - When in production the "from" email address that appears on all emails sent.
  6. Status Report Recipient's Email Address.
  7. Name of view on DSA Web Server to use for testing.
    • If one is not provided the installer will create a view for testing.
    • Desired characteristics: Simple, runs quickly, and can be modified.
  8. Name of view on DSA Web Server to use for customer sign off.
    • This view will be modified.
    • Desired characteristics: A view that you want to put into production soon.


Addition Information on Installation

Installation Drives and Folders

The root or home folder for the DSA AD system will be installed inside the DataSelf folder on the your computer server. The new folder will be a sibling folder of DataSelf ETL. For example C:\ ... \DataSelf\DSA AD\


Security Configuration

Who Requires Access

  • The person installing the software
  • The people testing AD
  • The user owing the SQL Server Agent

Security Requirements to Run and Maintain DSA AD

See also

DSA AD is normally installed on the same computer server which hosts DSA / Tableau Web Server. (Other configurations may be possible but they have not been tested.)

In order to a) configure DSA AD 2) and to configure it to run automatically on a schedule requires a certain type of access to the server hosting DSA / Tableau. There are several ways that this security can be configured. A important element of installation planning is a plan between the client, the client's IT department or persons responsible for computer security and operations, and DataSelf.

Plan A

Client configuring and maintaining DSA AD has login access to the server hosting DataSelf and DSA/Tableau. (Use Control Panel > System and Security > System to find the computer name of the server.) This option often requires a RDC (Remote Desktop Connection) or equivalent access to the server and a login user name and password.

The Windows user will need to:

  • Have full access to files in the folder containing DSA AD.
  • Ability to run SQL Server Management Studio in order to create and maintain scheduled jobs with SQL Server Agent.
  • The scheduled SQL Server Agent Jobs must be able to execute the .bat files which execute DSA AD.
  • Be able to run SQL Server Agent jobs on demand for testing.

Plan B

Get login access to the server hosting DataSelf and DSA/Tableau. (Use Control Panel > System and Security > System to find the computer name of the server.)

This option requires a RDC (Remote Desktop Connection) or equivalent access to the server and a login user name and password.

The Windows user will need to:

  • Have full remote access (read "shared" / "network access) to files in the folder containing DSA AD on the server hosting DSA AD.
  • Be able to remotely run SQL Server Management Studio in order to create and maintain scheduled jobs with SQL Server Agent.
  • The scheduled SQL Server Agent Jobs must be able to execute the .bat files which execute DSA AD.
  • Be able to run SQL Server Agent jobs on demand for testing.


Plan C

Similar to Plan B above except that Windows Task Scheduler is used in place of SQL Server Agent.

URL to DSA (Tableau) Web Server

The Windows User specified above, connected to DSA Web Server using the

  • URL from the URL column
  • The Username and Password to the DataSelf Analytics Web Server (recorded on the Static Parameter File)

must be able to do everything that DSA AD is expected to do plus be able to copy and/or create new workbooks and views.

Functionally the Windows and DSA Web Server user must be able to:

  • See existing views.
  • Copy existing view to make new ones.
  • Run views so that they report data from all relevant data sources.
  • The Test scripts in the SetupTests folder validate most of the security credentials described in this section.


DataSelf Analytics Web Server Security

  • A Tableau Server user with:
    • Read access to the data sources that are to be reported on
    • Write access to the views.
  • If row-level security is used for any data source the user must have read access to all rows.

Windows Security

Write Permission to Folder Specified in Output-Path Column

All users involved in testing and refreshing AD must have write permission to the folders named in the Output-Path column. Be sure to include write access to folders in mapped drives, if any.

Set Powershell Execution Policy

Powershell will not run unsigned Powershell scripts without the proper execution policy. With the default execution policy unsigned scripts will fail. The solution is to a) change the Powershell excecution policy or Unblock Powershell script files.

Unblocking Powershell Script Files

To unblock all the script files in the PowerShell_Scripts folder enter the following command into a Powershell command window:

unblock-file -path "C:\Program Files\DataSelf\DSA_AD\PowerShell_Scripts\*"


Changing Powershell Execution Policy

How to Change Powershell's execution policy

  • The least restrictive policy is ByPass.




Pre-Installation Tests in SetupTests Folder

Test scripts in this folder include:

  • Test of parameters used to call Tableau's tabcmd.exe API.
  • Test of SMTP / email parameters

Recommended Email Server

For preliminary testing the installer may use a gmail server but DSA AD designers recommend that email be handled by the client's own email server. Using the client's email server gives the client access to and an audit trail of the emails sent by DSA AD. The audit trail includes a copy of the each email sent and email delivery status (via "unable to deliver email" messages).