Topics Map > Tableau
UW-Madison Enterprise Tableau Development and Publication Process
Developers seeking approval for their institutional data product must meet the standards outlined in this document. These guidelines apply whether the report is published on our hosted servers or on public platforms.
Table of Contents
Expand each panel by clicking the plus sign.
Roles
Data, Academic Planning and Institutional Research (DAPIR)
For the purposes of authorizing workbooks, enforcing standards, and maintaining organization of the server, the Data, Academic Planning and Institutional Research (DAPIR) will review and approve all Tableau workbooks for the enterprise. DAPIR also serves as the first point of contact for troubleshooting Tableau Server issues and for interacting with UW System Administration on Tableau Server.
Data Stewards
Under UW-Madison’s Institutional Data Policy, Institutional Data Stewards authorize access to institutional data and have broad responsibility and authority with respect to maintaining a quality institutional data environment. Data Stewards review enterprise Tableau workbooks and determine the appropriate access group or audience for each workbook prior to publication.
DAPIR does not proactively reach out to Data Stewards to complete their reviews. If you notice a workbook has not been reviewed in a timely manner (typically a week or more), then you should reach out to the stewards yourself. You can find the stewards still in review on the specification's Data Cookbook page.
Authorized Developers and Publishers
Authorized Developer: Someone who develops Tableau workbooks for publication on UW-Madison’s Tableau server and Tableau Public.
Authorized Publisher: Someone who can publish to the production folder on the server.
To request an Authorized Developer/Publisher role, fill out the following form: Tableau Developer/Publisher Request
In the form, the requester agrees to comply with the standards and guidelines. Please review them before submitting a request. Once your request is approved, someone from DAPIR will contact you to schedule an onboarding session.
After onboarding, Authorized Developers/Publishers will be given access to:
- The development area (Staging and Templates projects) of the server
- The production project (for authorized publishers)
- Data Cookbook groups
- Tableau Dev Community Microsoft Team
- Tableau Dev Community email group
Getting Started With Tableau
Purchase a license
Information on how to request a quote through AE Business Solutions: Tableau Purchasing and Support Handling
Download Tableau
Download the version matching our server’s version. You can find this information at DAPIR's Tableau Page
The download links can be found on Tableau’s website: https://www.tableau.com/support/releases
Add UW color palettes
Replace the existing preference.tps file (usually, it is inside the “C:\Users\<your_user>\Documents\My Tableau Repository” folder) with the following preferences.tps file: https://uwmadison.box.com/s/xchlzpgklxo3br8izduikqgy3qskbk1.
Developing, Modifying, and Publishing a Tableau Workbook
For a detailed step-by-step guide on how to create a Tableau workbook, see Workbook Development - Step by Step.
-
An Authorized Developer must develop a workbook following the Tableau Visualization Standards section of this document.
-
Once an Authorized Developer has created a workbook, they should publish the workbook in the Staging project of the Tableau server and provide access to any staff that will be testing and/or approving the workbook before publication.
-
When the Tableau workbook is tested and ready for publication, follow instructions in the Cookbook Manual for Tableau Developers of this document to enter and submit publication information and start a review process.
-
After approval, finalize publishing the workbook to the UW Madison Institutional Data project and cleanup anything left over in Staging.
Standards & Policies
This section lists the standards and guidelines for publishing a Tableau workbook.
Developers must comply with all applicable internal and external policies, regulations and guidelines.
UW-Madison’s data policies
The Institutional Data Policy can be found here: UW-523
Data Classification policy: UW-504
Other policies, regulations and guidelines
This includes section 508, FERPA, HIPAA and any other applicable internal and external policies, regulations and guidelines.
UW Madison digital accessibility guidelines and best practices.
Organizations must comply with accessibility standards. Learn more about Section 508 here: https://www.section508.gov/manage/laws-and-policies
When creating visualizations, follow accessibility guidelines, considering color-blind users and black-and-white printing. Refer to the Tableau Visualization Style Guide in this document for details.
For accessibility tips, see this KB: Accessibility tips and tricks for Tableau visualizations.
Read more about accessibility in visualizations at UW-Madison here: Accessible data visualizations
For questions, contact the office of accessibility.
Tableau Visualization Style Guide
Before submitting a data visualization to Data Governance for review and publication, ensure it meets the standards outlined in this document. These standards promote consistency in look, usability, and functionality across the UW-Madison Tableau Enterprise and UW-Madison Tableau Public servers.
Deviations from these standards may be permitted. To request a variance, provide a justification in the publication request. Data Governance will review and grant variances as needed.
Overview
-
Use the UW color palettes.
-
Follow the Tableau Visualization Style Guide in this document.
-
Our Templates already incorporated the style guide as well as best practices. Here is a KB on how to use the templates: Tableau Template Quick Start
General Rules
- Ensure views include necessary context, titles, captions, units, and commentary to help the audience understand the data and visuals.
- Views should be user-friendly, intuitive, consistent, and visually appealing.
- Multi-dashboard workbooks must have a navigation page with a summary and table of contents linking to relevant dashboards. The home page can be omitted if there are two dashboards or fewer, or if the visualization is embedded in a web page with a summary and table of contents.
- Publish workbooks with the "Show sheets as tabbed" option enabled.
- Include a link to a Tableau user guide that covers the basics of using a Tableau visualization from the "?" icon.
- Dashboards must identify the owner office and provide contact information in the footer.
- Extract only necessary data and use query-level aggregations if possible.
- Use personal accounts for embedded credentials, not service accounts.
- Start with one of our Templates. Here is a KB on how to use the templates: Tableau Template Quick Start
Accessibility
- All images and icons must include alternative text.
- Maintain a contrast ratio of at least 3:1 between adjacent colors, regardless of the color palette used.
- Related guidelines: https://www.w3.org/TR/WCAG21/#non-text-contrast
- If the contrast ratio rule cannot be met, use borders to separate adjacent components. (KB on how to add borders).
- Use the UW color palette.
- Color should not be the only means of conveying meaning; use shapes or other methods of differentiation.
- Ensure tooltips provide information accessible through other means.
- Summary data should be available for download to rovide alternative access to necessary data.
Layout
-
Differentiate sheets on the same dashboard by using borders, shading, or spacing.
-
Ensure all dashboards fit within a width of 1200px and height of 2500px. Smaller dimensions must maintain proportionality of all elements.
Fonts
Comply with what is in the Templates (use any of the fonts prefixed with “Tableau” such as Tableau Regular, Tableau Light, etc.). Font size should be appropriate for the text's purpose (e.g., titles vs. body text) and must be readable.
Titles
When appropriate, titles should be dynamic to represent current filter selections.
Home Page Navigation Panel
-
Width can be up to 700px.
-
Use red arrow buttons or text buttons in the container to navigate to the corresponding dashboard.
-
Include Technical Notes and How to Use Tableau on the navigation panel.
Parameters & Filters
The title of filters and parameters should start with an action word (like "Select ...").
Filters and parameters can be placed either on top or on the side and must be grouped based on their cascading effect:
-
Parameters and non-cascading filters:
- Group together.
- Use #b4b4b4 color, second thinnest solid border around the layout container.
- Do not fill the background color.
- Do not select "only relevant values."
-
Cascading filters (chained interactivity):
- Use #b4b4b4 color, second thinnest solid border around the layout container.
- Fill the layout container with 33% #b4b4b4 color.
- Select "only relevant values."
To avoid user confusion, position filters near the visualization they affect, ensuring they do not cover any data part of the graph.
Legends
- If a legend applies to all views, place it in a layout container with filters.
- If a legend applies to one view, place it as close to the view as possible.
Tooltips
Tooltips must use meaningful names (no standard Tableau terms or database field names).
Axis
Axis labels must include units. You may remove axis labels and values only if their absence does not cause confusion.
Information & Help Icons
Information Icon
-
This icon links to the technical notes and underlying data and definitions in the Data Cookbook.
-
The icon’s image can be downloaded here: Information Icon
Help Icon
-
This icon links to a PDF with basic instructions on using either a Tableau data visualization or IDE:
-
The icon’s image can be downloaded here: Help Icon
Footer
Footer must include (left to right):
-
Logo: must have an alternative text and navigates to: https://www.wisc.edu/
-
Footer Text: Follows this wording: “This visualization was created by [Department]. Questions, feedback, or accessibility requests should be directed to [Full Name], [email@wisc.edu].”
-
Data classification icons:
Ensure data classification icons use the correct icon and link to their associated page.
-
-
Internal data
- Internal Data link: https://data.wisc.edu/internal-data/
- Internal Data icon
-
Public data
- Public Data link: https://data.wisc.edu/public-data/
- Public Data icon
-
Restricted data
- Restricted Data link: https://data.wisc.edu/restricted-data/
- Restricted Data icon
-
Sensitive data
- Sensitive Data link: https://data.wisc.edu/sensitive-data/
- Sensitive Data icon
-
Our templates adhere to these guidelines. Additionally, we have created dashboards with notes on format specifics, providing a visual way to understand the style guide:
Workbook Development: Step-By-Step
A step by step guide on how to create a new workbook is here: Creating a new Workbook - Step by Step
Documentation Guidelines
Developers must maintain clear and up-to-date documentation.
Required components of documentation
Make sure the following required components are documented. They all have a corresponding field in the Data Cookbook. An overview of these fields are presented in the Data Cookbook section of this document:
Description
Explains what is in the reporting object. For example, "a summary of all budgets and year-to-date totals by department with grand totals provided at the school level."
Definitions
These include any term in the workbook that requires further explanation. These terms must be consistent across the organization. In the Data Cookbook, they are added under the “Definitions” tab.
Purpose
The specification's purpose is a description of why the reporting object is needed.
This might describe a business process that requires a specific report, a regulatory or other mandated requirement, or a specific user need that it fulfills.
Sources
Any data sources behind the workbook need to be listed. Also, the views if applicable. This information is gathered through the following fields in the Data Cookbook: “Data Systems” and “Other data sources”.
Owners
The owner is an optional attribute that may be used to identify a person or office users should go to if they have questions about the report’s contents. Either they created the report themselves or they have requested the report to be created on their behalf.
Security
The permission groups and roles for the report. The corresponding fields in Data Cookbook are:
- Access restrictions: Indicates any access restrictions for the specification and the required permission group(s) in Tableau.
- Request URL: The URL or email address to request access to the specification.
- Classification: Describes the overall data risk for the specification. More information is available here: https://data.wisc.edu/data-governance/data-classification/
Details of existing groups and roles can be found in the Tableau Permission Groups and Roles section of this document.
Refresh schedule
Specify the frequency and timing of data updates. Examples include:
- Data will not be updated.
- Data is extracted on the tenth day of classes for each term and typically updated in November for the fall term and March for the spring term.
- Data is refreshed nightly for the current term but is frozen for completed terms.
- Data is updated annually as the report is revised.
Data classification
The presentation of data is classified under one of UW-Madison’s four risked-based data categories: Data Classification
The related policy and detail explanation of each classification can be found in the Data Classification policy: UW-504
The proper classification must be added to the Data Cookbook as well as the Workbook itself. The Data Cookbook specification template has a field for Classification. Refer to the Tableau Visualization Style Guide in this document to see how to meet this requirement in the workbook.
Data Cookbook
Documentation is maintained in the Data Cookbook. This tool allows us to track and save the governance process as well as necessary information. Every workbook must have a specification in Cookbook before it is published
Creating a new specification:
From the top menu bar, hover over "Specifications" and select "Create a Specification" from the drop-down menu. Fill out the form, ensuring all information from the Required Components of Documentation section is included. (A screenshot in the Index section at the end of this document details each field.)
When creating the specification, add related definitions to the "Definitions" tab. If a definition doesn't exist, create a new one.
Updating existing specifications:
- Open the specification and click "Request a change" below the title.
- Make necessary changes using the "Edit" button under the "Overview" tab.
- Add or remove definitions as needed under the "Definitions" tab.
- Include a comment explaining the modification and link to the workbook in Staging.
- Start the review process by sending it to Data Governance using the "Send to Data Governance" button at the top right.
Creating a Definition
Before creating a new definition, check if one already exists using this glossary tool https://search.data.wisc.edu/glossary.
The minimum information needed includes:
- Name: Choose a proper name for the definition.
- Functional Definition: Provide a descriptive definition of the term.
- Functional Area: Specify the domain.
The specification review process is independent of definitions. An unapproved definition does not delay the specification's review and publication.
Here is a KB on Creating a New Definition in Data Cookbook.
Review Process
Submit your data product for review by the data steward to receive classification and adhere to access restrictions.
We use Data Cookbook for governance. Each Tableau report requires a specification. Refer to the Cookbook Manual for Developer section for details. The table below outlines the specification review process:
Step |
Owner |
Tasks* |
Enter Detailed Comment |
---|---|---|---|
1. In Development |
Developer |
Create/modify specification for a new/updated report to be published.
|
Indicate if publication or modification request. If modification request, explain changes made. Explain any deviations from standards and permissions. Add a link to the Staging version of the workbook. |
2. Data Governance Approval |
DAPIR |
Review report against report standards Review selected access group and selected functional area(s) |
Explain any changes made to functional area or access restriction If sending back to Developer, explain changes needed |
3. Data Steward Approval |
Data Stewards |
Review the report and Cookbook specification details to determine data and definitions accuracy, access restriction and data classification. |
Explain any changes made to functional area or access restriction If sending back to Developer or DAPIR, explain changes needed |
4. Data Governance Final QA |
DAPIR |
Double checks that all changes have been incorporated in the report and Cookbook specification |
Document any changes made
|
5. Requestor Approval |
Developer |
Publishes the report Activates Specification in Cookbook Check links in RADAR the next day |
At this stage, the Developer cannot make changes but can still post a comment after Activating. |
* You will only get an email notification when the specification is assigned to you. ** At any stage in Cookbook, the assigned party may send the specification back to a previous step for corrections. Everyone can add a comment at any stage. |
Review Exceptions:
Data Steward review is no longer required for minor workbook revisions that do not alter data definition, collection, or presentation.
Examples of minor revisions include:
- Updating a workbook's data source to include a new year of data
- Transferring workbook ownership to another developer
- Making minor visual changes for accessibility
- Performing copy edits
For such changes, add Minor Revision at the beginning of your change comment. DAPIR will approve the specification without Data Steward involvement, but the developer must still activate the specification. If DAPIR determines that a Data Steward review is needed, they will note this and proceed with the standard review process.
Tableau Permission Groups and Roles
There are different Tableau groups that can be added to a workbook based on data restriction groups approved by Stewards in Cookbook for that workbook.
The following Table displays the currently existing permission groups. These groups are automatically generated and updated nightly based on their related manifest groups.
Data Restriction |
Group Name in Tableau server |
---|---|
Publicly Available |
Edit the permissions for All Users |
All Employees |
VIZ-Groups-BI UW Madison Employees |
Specific Audience |
Contact DAPIR to add the manifest group |
Employee Record Data - Internal |
UW HR INTERNAL |
Employee Record Data - Sensitive |
UW HR SENSITIVE |
Student Record Data - Internal |
UW STUDENT INTERNAL |
Student Record Data - Sensitive |
UW STUDENT RESTRICTED |
Employee Record Data - Internal & Student Record Data - Sensitive |
UW HR INTERNAL AND UW STUDENT RESTRICTED INNER JOIN |
*More will be created as needed |
TBD |
NOTE:
If during publication to production, “VIZ-Groups-BI UW Madison Employees” was automatically added, remove it (unless that is the access group that ADAWG approved for your workbook).
Other Developer Responsibilities
Quality Control and Data Management:
- Respond promptly to quality control feedback.
- Collaborate with experts to prevent data presentation faults.
- Explain any mismatches with reviewed and published reports.
Avoid Data Duplication:
- Review published products and recommend enhancements for new needs.
- Use RADAR to find existing reports.
- Use the searchable database of definitions: Glossary
Communicate Institutional Data Product Life Cycle:
- Include creation date, review cycle, and conditions for destruction.
- Document data refresh frequency.
- For temporary workbooks, notify DAPIR for removal. Do not remove the report yourself. DAPIR will archive and delete the workbook.
Testing Tableau Upgrades:
- UW Systems and AE Business Solutions upgrade biannually.
- Developers must test their workbooks on the development server after the upgrade is communicated.
- Refer to the KB on testing process: Tableau Server Test Procedure
- If testing is successful, production will be upgraded. Watch for related communications from DAPIR.