Configuring the DSA Report and Distribution Commands
The commands are stored in a table format.
DSA Cloud AD the report and distribution commands table is stored on a SQL Server table on DataSelf's cloud server.
DSA AD running 'on-prem' (on a client's server) the the report and distribution commands table is stored in a .csv file. DSA AD & DSA Cloud AD Diagrams Diagrams
DSA Cloud AD (scheduler not shown)
DSA Cloud AD. The Commands Database in the upper right is stored in a SQL Server database. The job scheduler, the final element in the automation, is not shown.
DSA AD on on-premises installations (Scheduler not shown)
DSA AD. Versions of DSA AD that run 'on-prem' (on your companies server) stores the Commands Table in a .csv file. The job scheduler, the final element in the automation, is not shown.
DSA AD & DSA Cloud AD in a broader context.
Outline of whats in a DSA AD Commands Table
The commands table contains:
the names of DSA views (reports, dashboards) on the DataSelf Analytics (Tableau) Web Server
output file names
output / export format options
email subject line text, etc.
Columns in the Report Commands table ID
Any name or id value you make up. The ID is helpful for tracking/tracing each row of commands in
log files. URL
A segment of the URL that opens a worksheet in workbook in DataSelf Analytics/Tableau Web Server.
To obtain this string of text:
Use the DSA/Tableau Web Server to navigate to the workbook or view (tab) you want to distribute.
Copy the URL from the web browser's URL window
Delete everything in the URL text string except the part after
"/view/" and before question mark ("
Copy the remaining text to the URL column.
When the URL shown in the web browser is one of:
the text for the URL column should be:
404 Not Found", "Failed to create a VizQl session" error messages - see
See also the "fullpdf" option in the
Dashboards call other worksheets. A URL to a worksheet (tab) that is configured as a dashboard will run all the worksheets specified in the dashboard.
The filter parameters (or
) portion of the URL that is passed to DataSelf Analytics Web Server. query string
When output is a dashboard the filters will apply to all filters on the views included in the dashboard.
When output is of all views in a workbook the filters will apply to all views. (see the
fullpdf option of the
Tableau documentation refers to string in the URL-Filters column as the "
query string". Example of a filter parameter in URL-Filters: (all these elements are covered in the examples below):
?AcctManagerID=AA,BB&Salesperson Name=John Smith&:refresh=yes
Example 1: Filter for
AcctManagerID identified by code "BB".
For Testing: The complete URL copied to the browser mig
ht be Testing: Copy the part before the "?" to the After URL column, copy the question mark and the query string after it to the URL-Filters column. Example 2: Older versions of DSA AD - Spaces in Field Names or Values
%20 in place of spaces is allowed but not
required in DSA Cloud AD.
Example 3: More than One Field Name (USE OF THE & CONNECTOR)
Combine filter parameter segments with "
The URL-Filter for Salesperson John Smith in Region 20 :
Example 4: More than One Value for Filter
Separate multiple values for a filter with a comma.
URL-Filter for Regions 20 and 22:
URL-Filter for Salespersons John Smith and James Wesson:
%20 in the example above is an example of URL Encoding . This encoding is required if you test the filters on your web browser. In the URL-Filter column the more common encodings are supplied by AD. Example 5: Force a Fresh Data Query with ":refresh=yes"
Add the parameter
?:refresh=yes to the end of the end of the
URL_Filter to force a fresh data query instead of pulling the results from the cache. Example: Refresh=yes option added after the filter part:
See Example 5 above. We recommend including the
:refresh=yes option on the first row of every batch.
Tableau is supposed to see when the extract file has been updated. However, in the past the automatic refreshing of the internal cache from the latest extract file has not worked properly. This is the workaround.
For more information see: , URL Encoding DSA Server - Filter Views using URL Parameters Recipient-Email-Address
A email address or list of addresses (optional).
The email address in the list will be send a email with the contents as specified in the current row. Address List - more than one address
Separate addresses with semi-colons.
Optional and informational only. Can be any name you specify. Usually the name of the email recipient.
Window's file system
path to the file specified in the column. Output-File-Name Output-File-Name
Name of a file to save the .png, .pdf or .csv file to. Default is blank or NONE.
If delivered by email then this will also be the name of the report file attached to the email.
We recommend using file names that do not contain spaces or special characters.
File names containing spaces may have to be delimited by quotes.
such as / \ ? % * ; : “ < > . cannot contain special characters
For file names with non-ASCII characters see
Non-ASCII characters and PDF exports Output-Format
Required. Must be either
This value may need to match the .png or .pdf extension, if any, ending of the
. URL column
png to output a view or a dashboard in a workbook.
outputs all views in a workbook to a pdf file, one view per page in the .pdf file.
Click here to expand section on CSV output Subject-Line
Text that will appear in the subject line of the email. Optional.
Ignored if Recipient-Email-Address is blank or "NONE". Body-Line
Text that will appear in the
body of the email. Optional. Process
Set to "
Yes" to process this row.
The software recognizes two codes - "
NO" and "
Any value other than "NO" or "TEST" is ignored and the line is processed normally.
When Process = NO this line is skipped.When Process = TEST no email is sent but the log file will display the email settings that would have been used.
Optional PDF format options for
pagelayout, pagesize, width and
--pagelayout portrait --width 800
Sets the page orientation (landscape or portrait) of the exported PDF.If not specified, its Tableau Desktop setting will be used.
Sets the page size of the exported PDF as:
unspecified, letter, legal, note folio, tabloid, ledger, statement, executive, a3, a4, a5, b4, b5,
Default is letter.unspecified asks the software to dynamically adjust the size to fit the report.
Example: Landscape mode, adjust page size to fit the data.
--pagelayout landscape --pagesize unspecified
Use of --pagesize unspecified
may cause problems with the PDF output and how the PDF file is read by Abobe's PDF Reader.
Sets the width in pixels.Default is 600 pixels (px). ?
Sets the height in pixels. Default is 800 pixels.