DSA Server - Filter Views using URL Parameters

From DataSelf Knowledge Base
Jump to navigation Jump to search

http://kb.tableausoftware.com/articles/knowledgebase/view-filters-url Includes information on formatting date parameters

URL Syntax in DSA Server

To create a filtering URL, you append a query string to the base URL. A query string in this case starts with a question mark (?). Within the query string, parameters (filters) are separated by ampersands (&), and multiple values per parameter are separated by commas.

http://servername/views/workbook/sheet?param1=value1,value2&param2=value

Characters that are Not Allowed in the Filter Name or Filter Value

Certain character cannot be used 'as in' in the URLs but their encoded values can. Characters that we know must be encoded include:

  • spaces
  • Apostrophe -- apostrophe's are sometimes used in names.

Most letters and common symbols are allowed in URLs.

The characters ";", "/", "?", ":", "@", "=" and "&" are reserved for special purposes in a URL. If they are found in a filter value they may need to be replaced with their encoded value. See Table of Characters and their URL Encodings

Encoding Spaces

Spaces must be converted to %20.


Unsafe characters that should be encoded

Characters can be unsafe for a number of reasons.

  • The space character is unsafe because significant spaces may disappear and insignificant spaces may be introduced when URLs are transcribed or typeset or subjected to the treatment of word-processing programs.
  • The characters "<" and ">" are unsafe because they are used as the delimiters around URLs in free text.
  • the quote mark (""") is used to delimit URLs in some systems.
  • The character "#" is unsafe and should always be encoded because it is used in World Wide Web and in other systems to delimit a URL from a fragment/anchor identifier that might follow it.
  • The character "%" is unsafe because it is used for encodings of other characters.
  • Other characters are unsafe because gateways and other transport agents are known to sometimes modify such characters. These characters are "{", "}", "|", "\", "^", "~", "[", "]", and "`".

Unsafe characters should be encoded within a URL.


For more see: Table of URL Encodings

URL Specifications

Examples

Salesperson Name

http://xxx-app1:8000/views/SlspnYTDEmailReport/YTDbySalesperson?Salesperson%20Name=John%20Wood