From 9b974e1065435fa33f9d79b108284a7878db7baa Mon Sep 17 00:00:00 2001 From: Russell Hay Date: Wed, 17 Jan 2018 15:51:14 -0800 Subject: [PATCH 001/158] Moving docs out of the docs directory --- .gitignore | 149 ++ Gemfile | 3 + _config.yml | 17 + _includes/analytics.html | 7 + _includes/docs_menu.html | 73 + _includes/footer.html | 8 + _includes/head.html | 18 + _includes/header.html | 29 + _includes/icon-github.svg | 1 + _includes/search_form.html | 7 + _layouts/default.html | 34 + _layouts/docs.html | 31 + _layouts/home.html | 19 + _layouts/search.html | 43 + assets/logo.png | Bin 0 -> 2800 bytes css/api_ref.css | 709 +++++++ css/extra.css | 14 + css/github-highlight.css | 224 ++ css/main.css | 276 +++ docs/api-ref.md | 3070 ++++++++++++++++++++++++++++ docs/dev-guide.md | 96 + docs/filter-sort.md | 90 + docs/index.md | 76 + docs/page-through-results.md | 69 + docs/populate-connections-views.md | 45 + docs/samples.md | 55 + docs/search.md | 5 + docs/sign-in-out.md | 39 + docs/versions.md | 55 + index.md | 13 + js/lunr.min.js | 6 + js/redirect-to-search.js | 13 + js/search.js | 71 + 33 files changed, 5365 insertions(+) create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 _config.yml create mode 100644 _includes/analytics.html create mode 100644 _includes/docs_menu.html create mode 100644 _includes/footer.html create mode 100644 _includes/head.html create mode 100644 _includes/header.html create mode 100644 _includes/icon-github.svg create mode 100644 _includes/search_form.html create mode 100644 _layouts/default.html create mode 100644 _layouts/docs.html create mode 100644 _layouts/home.html create mode 100644 _layouts/search.html create mode 100644 assets/logo.png create mode 100644 css/api_ref.css create mode 100644 css/extra.css create mode 100644 css/github-highlight.css create mode 100644 css/main.css create mode 100644 docs/api-ref.md create mode 100644 docs/dev-guide.md create mode 100644 docs/filter-sort.md create mode 100644 docs/index.md create mode 100644 docs/page-through-results.md create mode 100644 docs/populate-connections-views.md create mode 100644 docs/samples.md create mode 100644 docs/search.md create mode 100644 docs/sign-in-out.md create mode 100644 docs/versions.md create mode 100644 index.md create mode 100644 js/lunr.min.js create mode 100644 js/redirect-to-search.js create mode 100644 js/search.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..d7496406b --- /dev/null +++ b/.gitignore @@ -0,0 +1,149 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# PyCharm stuff +.idea/ + +# IPython Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# dotenv +.env + +# virtualenv +venv/ +ENV/ + +# Spyder project settings +.spyderproject + +# Rope project settings +.ropeproject + + + +# macOS.gitignore from https://github.com/github/gitignore +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + + + +# Windows.gitignore from https://github.com/github/gitignore +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Documentation +docs/_site/ +docs/.jekyll-metadata +docs/Gemfile.lock diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..775d954bf --- /dev/null +++ b/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins + diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..5ea15f228 --- /dev/null +++ b/_config.yml @@ -0,0 +1,17 @@ +# Site settings +title: Tableau Server Client Library (Python) +email: github@tableau.com +description: Simplify interactions with the Tableau Server REST API. +baseurl: "/server-client-python" +permalinks: pretty +defaults: + - + scope: + path: "" # Apply to all files + values: + layout: "default" + +# Build settings +markdown: kramdown +highlighter: rouge + diff --git a/_includes/analytics.html b/_includes/analytics.html new file mode 100644 index 000000000..0cdbad25d --- /dev/null +++ b/_includes/analytics.html @@ -0,0 +1,7 @@ + + + diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html new file mode 100644 index 000000000..104a1f5b3 --- /dev/null +++ b/_includes/docs_menu.html @@ -0,0 +1,73 @@ +
+ {% include search_form.html %} + +
diff --git a/_includes/footer.html b/_includes/footer.html new file mode 100644 index 000000000..486c81d22 --- /dev/null +++ b/_includes/footer.html @@ -0,0 +1,8 @@ + + diff --git a/_includes/head.html b/_includes/head.html new file mode 100644 index 000000000..083e3f268 --- /dev/null +++ b/_includes/head.html @@ -0,0 +1,18 @@ + + + + + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} + + + + + + + + + + + + +{% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %} diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 000000000..106578dfc --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,29 @@ +
+
+ +
+
diff --git a/_includes/icon-github.svg b/_includes/icon-github.svg new file mode 100644 index 000000000..4422c4f5d --- /dev/null +++ b/_includes/icon-github.svg @@ -0,0 +1 @@ + diff --git a/_includes/search_form.html b/_includes/search_form.html new file mode 100644 index 000000000..41bb34259 --- /dev/null +++ b/_includes/search_form.html @@ -0,0 +1,7 @@ +
+ +
+ diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 000000000..38ee020bb --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,34 @@ + + + + + {% include head.html %} + + + +
+ {% include header.html %} + + {% include footer.html %} +
+ + + diff --git a/_layouts/docs.html b/_layouts/docs.html new file mode 100644 index 000000000..5355f63df --- /dev/null +++ b/_layouts/docs.html @@ -0,0 +1,31 @@ +--- +layout: docs +--- + + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

{{ page.title }}

+
+ Edit this page +   + Submit an issue +
+
+ {{ content }} + {% include footer.html %} +
+
+ + + diff --git a/_layouts/home.html b/_layouts/home.html new file mode 100644 index 000000000..c2cf32fcb --- /dev/null +++ b/_layouts/home.html @@ -0,0 +1,19 @@ +--- +layout: home +--- + + + + + {% include head.html %} + + + +
+ {% include header.html %} + {{ content }} + {% include footer.html %} +
+ + + diff --git a/_layouts/search.html b/_layouts/search.html new file mode 100644 index 000000000..96dbd94a1 --- /dev/null +++ b/_layouts/search.html @@ -0,0 +1,43 @@ +--- +layout: search +--- + + + + + + {% include head.html %} + + + + + + + +
+ {% include header.html %} + {% include docs_menu.html %} + +
+

+
+
+

Loading search results...

+
+ + {% include footer.html %} +
+
+ + diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..60761152152291896e7b27f94d981fc82e71a2dd GIT binary patch literal 2800 zcmb7GdpuNWA3rk7jj(zc zA_9#@6Cwf+j{N!tppenAD|!*Tt? zar#(2+n89aH%lSV-lRb3+Ff~Q<4W3MbT z@VqTFFgsTxdBECEUTw_=QFxAOl%7~&W%r{p6`lSZYEWfw_N(j+_voCtm@(sQg^ZaR zsIPw<-y$EgstQv?0+7GAo#~0Ybf<5&_#AxMFXwb?)9ujtx3<&f(hsV490=3nB^pAJ zMTU9sKs7)h8oMvf0Qh2Q4X6li#W2BNGXt$=HfdHSpi}0iurAQrwHK3}3Gfe>Z7BX< zq3$f|V$_05hx;%OITN-*535$zVg^snD5$=sNBEW(^)1Yyj%k;vy{wVRpW9#M8}ico z`xoM42SX)!goCAfAkAyd301SblpHR7C55iE*E9iL;}XNM-OoAN8fZ={l9N%*^3B|5 z+V!G$`?J+2lS2Zi$d%7H)4u(#VPVgB&d*}qPUgG#ThLM3Ie<@F!WLyAXzZ~#FYjD+ zIcvcy&*fuR^=SCM2%}Q-v zc6@V!Cjpy)p^eN{4k)7%h1+@LE#?q-XV*rWJ!rK@qaIQK(v4YOFAB7x9QfDe6NM9T z-$s!EQY1{y|L>u^zOJag>xEZBY%Z{hcR3Wh0HoqajIrx=-0Sw7LfNocy;ckD zlN=YnmJy+F`L(I;)F4-+U7OKAJsbV3r2%VZ}eDU0r44YGzvYI}6J8SJ|guC1AP%`f-qACE3fV`|%cn zrm1{UtI64mKbG$DOOHzKkquq?rE8foh%;9Zm5nB+dL)iK+JaZ!U~6g!!hIxBnI&b# z$l_tno&l91PI7OBh3n}-#xAoh>oCc6XWvxt`wJTuf^d(s<}9GdK6Q<@;aQV|ORNy{ zSCSp6KuQ-%D(pXbx-1S)|y2kxwzf%4+Yp1u28EW3orO>jQfZQH*0SGO#V6wj~LH z<)E0yt_=N*&R#lMQ)g8PJQE`8ISv+%*X0_3T9W3rIcWicZqKG%Yk(AR--d?gIh72) z2r+UimAg<>@mA|l^qZc=n4@o@>6*ej!eE54DU+`cUpewrq~Ax-pgA#OG0qwL6UKbl z=eL@fTZ+?e-#8TA!rJd7GLVpNwr!iz;6k09xMrmF4 zt`Smbk^5c}plr=9^O)~g_!J7(`n47)Ylp(22O5Cjh!n;$4dB}~!?dtq_0Gs8N3eQ1 zP17Ubq4G{@a|0!xqt}$?3}}UEp`@G7$sOPMYInvg^IFEIqhj{zM)b;clX8_^($FpV zt<%~0;HRkUMv~TXfd4S@#1#${xvfNjuoX5p@EfZjDDz}~u|v7Nrpl4=zes(cc3LCn9^5yHcG4y0kRne# ztY1!+o3y&qA zttx95Z>yADY4Q91Ulv7;c6mO(mRHs9)^Np*XLpaxze8FIHcYEz0#evG5M-$;1_?3( za|j;>1-mGX;#mPCHLIkrNa>*{o6z_CiqqjK0lkSx&FzkS7Yk+B-62H&(gnE395AbQp4>LZYT`AK6 z;mN3uerOU4Zk;)^D5Po7bTw{9&P-|lK+$M(zbm&!Xc)N6RXFL6Tkw02sw!d+QCar@ z5bLMn&_+=8JJX;%;!;wr(0~AiZc26oNF#=17!(BX|MH;|H80s{HcH;Y$85@-7/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* 2 */ +/* ========================================================================== Tables ========================================================================== */ +/** Remove most spacing between table cells. */ +table { border-collapse: collapse; border-spacing: 0; } + +/* Visual Studio-like style based on original C# coloring by Jason Diamond */ +.hljs { display: inline-block; padding: 0.5em; background: white; color: black; } + +.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { color: #008000; } + +.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { color: #00f; } + +.xml .hljs-tag { color: #00f; } +.xml .hljs-tag .hljs-value { color: #00f; } + +.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { color: #a31515; } + +.ruby .hljs-symbol { color: #a31515; } +.ruby .hljs-symbol .hljs-string { color: #a31515; } + +.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { color: #a31515; } + +.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { color: #2b91af; } + +.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { color: #808080; } + +.vhdl .hljs-typename { font-weight: bold; } +.vhdl .hljs-string { color: #666666; } +.vhdl .hljs-literal { color: #a31515; } +.vhdl .hljs-attribute { color: #00b0e8; } + +.xml .hljs-attribute { color: #f00; } + +.col > :first-child, .col-1 > :first-child, .col-2 > :first-child, .col-3 > :first-child, .col-4 > :first-child, .col-5 > :first-child, .col-6 > :first-child, .col-7 > :first-child, .col-8 > :first-child, .col-9 > :first-child, .col-10 > :first-child, .col-11 > :first-child, .tsd-panel > :first-child, ul.tsd-descriptions > li > :first-child, .col > :first-child > :first-child, .col-1 > :first-child > :first-child, .col-2 > :first-child > :first-child, .col-3 > :first-child > :first-child, .col-4 > :first-child > :first-child, .col-5 > :first-child > :first-child, .col-6 > :first-child > :first-child, .col-7 > :first-child > :first-child, .col-8 > :first-child > :first-child, .col-9 > :first-child > :first-child, .col-10 > :first-child > :first-child, .col-11 > :first-child > :first-child, .tsd-panel > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child, .col > :first-child > :first-child > :first-child, .col-1 > :first-child > :first-child > :first-child, .col-2 > :first-child > :first-child > :first-child, .col-3 > :first-child > :first-child > :first-child, .col-4 > :first-child > :first-child > :first-child, .col-5 > :first-child > :first-child > :first-child, .col-6 > :first-child > :first-child > :first-child, .col-7 > :first-child > :first-child > :first-child, .col-8 > :first-child > :first-child > :first-child, .col-9 > :first-child > :first-child > :first-child, .col-10 > :first-child > :first-child > :first-child, .col-11 > :first-child > :first-child > :first-child, .tsd-panel > :first-child > :first-child > :first-child, ul.tsd-descriptions > li > :first-child > :first-child > :first-child { margin-top: 0; } +.col > :last-child, .col-1 > :last-child, .col-2 > :last-child, .col-3 > :last-child, .col-4 > :last-child, .col-5 > :last-child, .col-6 > :last-child, .col-7 > :last-child, .col-8 > :last-child, .col-9 > :last-child, .col-10 > :last-child, .col-11 > :last-child, .tsd-panel > :last-child, ul.tsd-descriptions > li > :last-child, .col > :last-child > :last-child, .col-1 > :last-child > :last-child, .col-2 > :last-child > :last-child, .col-3 > :last-child > :last-child, .col-4 > :last-child > :last-child, .col-5 > :last-child > :last-child, .col-6 > :last-child > :last-child, .col-7 > :last-child > :last-child, .col-8 > :last-child > :last-child, .col-9 > :last-child > :last-child, .col-10 > :last-child > :last-child, .col-11 > :last-child > :last-child, .tsd-panel > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child, .col > :last-child > :last-child > :last-child, .col-1 > :last-child > :last-child > :last-child, .col-2 > :last-child > :last-child > :last-child, .col-3 > :last-child > :last-child > :last-child, .col-4 > :last-child > :last-child > :last-child, .col-5 > :last-child > :last-child > :last-child, .col-6 > :last-child > :last-child > :last-child, .col-7 > :last-child > :last-child > :last-child, .col-8 > :last-child > :last-child > :last-child, .col-9 > :last-child > :last-child > :last-child, .col-10 > :last-child > :last-child > :last-child, .col-11 > :last-child > :last-child > :last-child, .tsd-panel > :last-child > :last-child > :last-child, ul.tsd-descriptions > li > :last-child > :last-child > :last-child { margin-bottom: 0; } + +@media (max-width: 640px) { .container { padding: 0 20px; } } + +.container-main { padding-bottom: 200px; } + +.row { position: relative; margin: 0 -10px; } +.row:after { visibility: hidden; display: block; content: ""; clear: both; height: 0; } + +.col, .col-1, .col-2, .col-3, .col-4, .col-5, .col-6, .col-7, .col-8, .col-9, .col-10, .col-11 { box-sizing: border-box; float: left; padding: 0 10px; } + +.col-1 { width: 8.33333%; } + +.offset-1 { margin-left: 8.33333%; } + +.col-2 { width: 16.66667%; } + +.offset-2 { margin-left: 16.66667%; } + +.col-3 { width: 25%; } + +.offset-3 { margin-left: 25%; } + +.col-4 { width: 33.33333%; } + +.offset-4 { margin-left: 33.33333%; } + +.col-5 { width: 41.66667%; } + +.offset-5 { margin-left: 41.66667%; } + +.col-6 { width: 50%; } + +.offset-6 { margin-left: 50%; } + +.col-7 { width: 58.33333%; } + +.offset-7 { margin-left: 58.33333%; } + +.col-8 { width: 66.66667%; } + +.offset-8 { margin-left: 66.66667%; } + +.col-9 { width: 75%; } + +.offset-9 { margin-left: 75%; } + +.col-10 { width: 83.33333%; } + +.offset-10 { margin-left: 83.33333%; } + +.col-11 { width: 91.66667%; } + +.offset-11 { margin-left: 91.66667%; } + +.tsd-kind-icon { display: block; position: relative; padding-left: 20px; text-indent: -20px; } +.tsd-kind-icon:before { content: ''; display: inline-block; vertical-align: middle; width: 17px; height: 17px; margin: 0 3px 2px 0; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAO4AAADMCAYAAAB0ip8fAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAJLFJREFUeNrsnQ+sXUWdx+e9PnFbumFDrCmpqRZhdV3EurI1mrLPAI1t7ILIGkFX2y6EBqKugejq6mLLwkpgTTASTAnYV0iKWdQGgqEraZdnX2RF2C2srBKJha4NzbYQSUrZ16S+nd+7M+/OmTt/fr+Zufecd+7vl0xv773nft7vzDnfM3PmnO+ZsZmZGcHRiYvvz2c8dEV78uDojRt2vK0ReYzBP98ZSfvxNYbmSzB27NiRxNiwYUP2Tl96R29KHiXqtCn7x1N3pUHed/VMUUYTYpSPoRwc2fFuWR6Q5beyzKjXB9TnsVgqy2Iqwyfc5bLcKcuLCgKv29Tn2GgD45OyXCDLCs6DGY44RZavyvJDWfbK8kFZRtTro+pz+H6B57efUP//WyrDJdw1sjwLvRQjeXi9Wn2+BrFC850BlfSgLKer/z8z5Hkwwx3flGVclvfC2YAsB9Xn8HqX+hy+v93x21tleV6JkswYdRx9HlBNtysWq++XR45g853xZSWWhzgPZni+Xw1DGbJ8XJZjnmWOqe8vVsubv10iy8JUhi3cL8pyWuQoc5pazhfznbEMBg/V0Y/zYIaPAa30bbK8GmG8qpa7xvrtzhyGLdxLkecFlyZ+Nx8Ya9T5xyTnwYzActB93YVk7FLLm799IodhC3cJErIk8bv5wFiqXo9wHswILLdEbRtM2NtwifFZEmPM8eUyJCT0HZphXt9bNJHGqFyrPGVD7roctip3oPVhXP/NykNzLhMF6lRsaMT+sWpbffupvv57CYwWvvGtppAOIcV/xCHCZIbd4j6EVP9Did8J1fV7vyxvqZnhWw6G4E+obkmd9UHJo+l12sY8JtWAESYuVsubv12Vw7CFe1tgdMsc5bot8H2McbkaTfuZ6Fw3+5nV/x8Uw7cucPS72Rg4qKs+KHk0vU7bmIceNFwcyWOxWu471m8/kcOwhXtAlo+J8ND0x9RyvogxoAv4PXXEG1Gv36uBEVqXm9VI3pqa6wObx3yo07blMSW6N0iELin9UC03Zf32mCpJDNcNGLDAuaJz8fewsRJ3qc8fRTTrIYYeeLnNOPItrYERWpeTsqyX5XVV3ltTfWDzmA912sY8Pic6o8P/KTo3bSw1fne1+vwJtZwdX5BlpSw3pjBGwB1Uw03krju2RxZN7Mhm/KA7OEUKuLm/pCuHyHKuC/FPOxmXnciv0+MbNzRi/1i1beAmA2ceanDKDBAg3AG1WgnusGodoce0P/I3lqle1VkUxsggbX3GxtN/FFqTh3Uu1yBSMUY7nQzT1UKNQdvpjL/nXJdE4VYYmHz6WaeD3j9KhCFuZx4O4Q48xmr6u7tlWWtUxu6aGMmiG0R9YPIxxN/IOq1x/+hbHjdueCEJVtLLO5baTXZ1hwixrkDu60pvpRoN7OsK5NPIOm1jHk0w02NaXOiDH8r5I/LgsEwK/FBOV0d255bJLtuhWLetDUb6kgcQNtKXNdI35QkYISM9nCQ/JjqG3sdE1d2AFexqWWYZ8ArvEwS7WpZZBrzCe8HB0axohJFeC3af6F5wHlfvUQI2BNvDwArYEGwPgyhgNtKXy4MZ1ajPSP/OjVLuy72CtaMi4FfmPL9BwToZPgF7BOtkIARsG6UPinwDO5bRpjyY4Q6XkV5zcoz0UcboH8ou+5/8jRBSwPukgMcxhygp2PF/FxP7HhffrXyewrA/P+uss/adeuqpKMbLL788PjU1tS9wJLWN0ueL7hMGUg3sWEab8mCGu2fqMsHvM36TaqSPMua6yoaAdQvsEpuQYhMg2JfFCz3fl2AsXrxYnH322SBgIQXsE6yQghX79u0TR48e9W0Yl1H6oLVxUgzsGEab8mCGZ9xMuE3wyy3hpRjpo4xRjPhiYusHwyVgpGB1aAP0iFFcGwdjYKcy2pQHM/yna9oEP2MUl/AwRnoSYywmvn/b9XPx+NM/ShpqK8HQAn7sscdmBUuIJUaFYJYzR/kgjmQw2pQHM/yfHzHEHwqMkZ7EiF7H/f0bprPHykMM8/pe6DrvyZMnQyPQxlhdj+kbXv9RFlcTvVPgjPRUhl3haEbESI/OI2CkRzEiRvqB1UfESD+wPCJGejgfvlCWRQ7G/QJnpCcx6ngg+qxB+SNiywiUHMZHP/rRESieZR4ydnw4V3yTsTF0MZfT4TKwUxmUPDYLvJGeyiiRR4k6bWMepgle2/OOG0LTRQickZ7EqEO4l0vBxozSUYYULMVs/SZr4wijsrBGegqDkgfVSE9hlMijRJ22MQ/bBH/cEp4wRqexRno0wxTuh0TV7BuKKbW8HVGGFG3MoBxlSNGmmK31xjE3LNVIT2Fg80gx0lMYJfIoUadty8NlpNfCMwVHNdKjGKNW831+RDhasOdbTf9snPd1MSnL+QjxeQ3K73nPeyZlyWJY3U3TKP0mkW+kxzKweYTWBZtHifrod522MQ+Xkf64yDfSRxljnr77+apbcJPoXPQFAX3NJVZXgICB8eRWJ0NHcNQLBAyMp59+OplhHFk3q0KN+4z/pzKweUwXyGO6z3mUqNM25XFC7Y/fF507oLaKqgkebpzYH/jthBogu4XKGIsMAIGAV0S6HFEB73lYrHh4ZssBh0PENCgHBbxnz54Vu3btOuBwu1QYTZkXluilRdcHIioMjAk+VqclDOwYRmz/KDHVJYbhcBDFtst+JbCUOJTCGEMekbLi736+2maQjdLXXXddNqOE2PoUbKSfR3k0wkh/4x/HFLNanggXd9KxkR6xLmykb2YeQ2OklzvgMrlDs5EemQcb6d0MNtJ3o69GerkDrpZllgGv8D5BsGyk52h6tMNIbwi2h4EVMBvpG5kHM6pRn5H+wjOFWLLIK1g7KgJ+/ehBjGCdDJ+A+2ykPyryDexYRpvyYIY7XEb6RSLfSB9ljL75VCEuersQUsD7pIBRtx5KwY7/z08m9h2crBrpUxj253020t8oujeTpxrYsYw25cEMd8/UZYJfI7pGgVQjfZQx11U2BKxbYJfYhBSbAMEeP/JCz/clGH020h+1Nk6KgR3DaFMezPCMmwm3CX6RJbwUI32UMeYT3/++Jvtlh4U4crwjtqP/vdcpNFeUYGgBHzt2TLz00kvitddemxXsL3/5S4yJHuJS4/zQtXH0TeWw3Oeso502sN+ayGhTHsxwM6BX+CX1/ys8wtOGgV2q92T+9gvqXDqJMRYT3yOTPxfPTaaZ4EswChjpdyKXM0f5II5kMNqUBzP8n2t/bOwCHsZIT2JEr+OOnsw30ocY5jXL0LXUDCM93HH1ISGsR1J2YkbgjPRUhl3haEbESI/OI2CkRzEiRvqB1UfESD+wPCJG+hVqwNZ1PjwicEZ6EqM2I/07LtsyAiWHgTTSrxDVZ/fYz/bBGOmpDEoesLGwRnoqo0QeJeq0jXmYJngQv/mcKvs5VhgjPYlRi5FeCnbQRnr7wVvCGLHDGukpDEoeVCM9hVEijxJ12sY8bBO8/ZA5YYxOY430aMbAjfRStHUZ6fXGMTcs1UhPYWDzSDHSUxgl8ihRp23Lw2Wk18IzBUc10qMYRY30V5wjJmVpspF+ucg30mMZ2DxC64LNo0R99LtO25iHy0h/UOQb6aOMvhjpQcDAuP8XbKQn5MFG+vmXRzuN9FrA/7pXrHju+1sOpBjH2UhPDjbSB4KN9ISY+Dwb6SPBRvp5lEcjjPT3/1dkiSWrxTsuYyN9n8XPRvp5lMfQGelzWjQ20qetDxvp2UjPRnoODnewkd4hWDbSs5G+qQw20kcE62TwjPQ8m7wY1hnph8xIzzPSM6MUoxkz0g+JkZ5npGdGKUazZqR3iS8mtn4weEZ6npG+4YxmzkjfIiM9z0iflwcz/J83d0Z6NtKzkZ6N9GykF4KN9Gykb0ce9Rrp4ZZHddvjmfIVFjrTc/Txtpi6IBlOI/1lJ3boo/yZ+/fvjzLYSM9G+przaIaRXgpuXL1e4PmxGU4jPYYRM9JL0Y6rVy+DjfRspBdspJ+N7bJcqQZENkrhbfWIJmSkxzL0wIvLoFxhSPGmMOzuJhvp8/MoUadtzKNWIz0I5a9kgTPuV9T594tSeFNXvHu2H64NvSEjPYWhYxrDkOKdWrlyJZbhO7Kykb5MHiXqtE151Gqkv0d07sh4UC30gIJMSOGdPL1zrhnz5EYZCCO9lyHFCy3PmWykRwUb6QPRNiP9JtXiHVZHgQnVTRMCb6T3MghGei+DjfRR8bORfkB5NMJIb7Wa5mvnjP20vxbL/zJ0qNkiYgxHVAzKMKKcyygRbKRnIz0mj0YY6VeeiCYRNNJjdlS5osvkUSpgpEd159hIn7A+bKQfXiP9iyLRSC9XcrUsswx4hfdUhmHze5GN9BwNjUYZ6e9V55iL1Ou9WAEbgu1hYAVsCLaHwUZ6NsE3hFGbkX7MEuxNKmG4tnSfMUA1od5/WgkJrjPBMPiULVibIbvIcwz5/RxD/n+WIb+fsgVrM2S3bY4hv59jyP/PMuT3vgenrxHVi9t6Q12txPAx4b7et0B0L3rD/aHPJDDalAcz3AFG+neIzvV100+rTfA7FR9aVfta7q1KU19NYZgtLtw1AtdLb7ZEq+Ok+vxmtZzLqlNhGKIVajSOzDBEq8+9MAy9AUyjNFyne934PsXATmG0KQ9muHumtgkeWuqFxjIpRnoUw+4qX6uOAPDYjo1G87xAvX9WfX9toELmGLJV3SjLAtUaL4D3VIZsVTfKskC1xgvgPZJhG6Xh6GXfhUU1sGMZbcqDGZ5xM9Frgr9a9N7zTDXSoxi2cKFLfLbo3MlxgxKI+XqL+n7CVxuyVe1hSMH2MNRyvhHNHoYUbA9DLecLlwH6KdUl2R1YzmVgpzLalAcz3GGa4CsD0KJzm+Ja4zOMkZ7EcPlxT1rntHD/8CZP99kn3pPWOe0cw+4+B8R70jqnnWPY3WdP+AzQcDvlOlUxKwXOwE5ltCkPZvh/7/P7wunNI+ogsF/gjPQkRshIrwW8PdTCIgW8HVpYuAZmXwcz37vuSDEEvB1aWLguaV+bjBjpXRVyr9ooQuCM9FSGGSRGxEiPziNgpEcxIkb6gdVHxEg/sDwiRnqX+D8juvcYY4z0JEYdRnozRvrIcJmoYWM8KctHAsu5DOxUBiWP2YcCCJyRnsookUeJOm1jHqYJ3gwQ2nmymM9qwhjpSQxbuOaAlC/0QJUzzAGpQMDO6DVKmwNSqQxRNUpDwD3QPxWda6HmiB3WSE9hUPKgGukpjBJ5lKjTNuZhm+Ah4DZduP56wBqdxhrp0Qx7RvorHSPKwjGyfKXwz0h/pT2ibDEgYjPSX2mPKBMZQvQape92DLNTjfQUBjaPFCM9hVEijxJ12rY8XEb6q0TvJSWqkR7FcM1Iv9kSsLAEu1l4ZqSX56iTslQY6hKQMC4F6YEXp0FZnsdOylJhqEtAwrgUFGRY3U3TKK03SI6RHsvA5hFaF2weJeqj33XaxjxcRnr9uxwjfZQx8g8Tbw11RaMz0ocsTlKsPobLFDniYkmxkhg/OGWDSInSN/cTWTMFzv+dDMt5lcQ4vjGtTjNMBs48Vm0buMnAmYcanLLPjb+q9lHTBH+z8BvpdSxTvaqzKIyQcHUEZ6THeBOlgFfI5Q4YI8i6QkyD8kiIJQW8QrbEppHeycAYx30xaFuf8fec65Io3AoDk08/65QShrideZQw9GPCELczD4dwBx4DmZEeRGt9RDZKg2hzGSVFVzjYSD+P8miakX6QwTPSI9aFjfTNzGNoZqTXRvrUI5XqzrGRPmF92EjPRno20nNwuION9A7BspGejfRNZbCR3hSsYCN90/JghjvYSO9jsJGejfQNZbCRPsRgIz0b6RvKYCO9Y0Szh8FG+tryYIY72EjvES8b6ZuRBzP8v2cjvVo+JGA20hPyYCN92TzYSF8NNtL7DdsPCzbSNzmPWo30psnAZyaYscSxwOi62qLxMmRrOmK0ruNqOHyV6ut/6e1i62SMIVvcEaMl6GHAilnuIFi5n6gTffA5ftsxYge2rgPWHUtwXe1fZHmJwgjsJCHGGepyQM+6EPJwMi47sWMyN4/jGzdQGJX6gLuePHdMkfNYtW0kOQ+468lzxxQ5D9na6jz+QJb/U43f79Vn4On9nGN0+hnVek4Zo8rQGfpKKmPUOmGGAA/sqSLNSI9hQIQMyiUYG9XrRaqSDgqa2fpbsnw4k4HNI2TYxuZxuEB9HO5znbYtj8vV6yajAaMY6W/KYThnpJflDlneLLrzdZqC9RnpgwykkT7IQBrpbcaN6gT/KWODxMzWg2SUWJemMJpSH4PO47tKYEuM38WM9P+cw/DOSK/U/bDR+m0WxBnpPQwd06UZspscYpyHPGeuizHdIoYY0jx2q1PL2Iz02Qx9jgtHkLNEdyb451WTfVJEjPTWkczLiBnp5TnuSIyBMdJL8XoZMQeQcY4bygMb0TwQRnpKHj0MeY4bZGgHUKhO5TlukBEztxvnuFFGyEgvz3GDecRmmjfOcaOMkJFenuOO9Hv/wPx4IDPSE4z0XgbBSB9aF5G7LgTxU/Igr4tD/CXqo5Y6bVMekUc5peYhfC2uN87Y+ELw+5cm3hb9I3plfF5G2dpGGY7WwRmhZ04RRNfXSHwuFSkwz5qK1SnmWVOEFjfK8C2LedYUocWNMnzLNuGRNXPCvVNEH+QTNNJjngMkN8gyuVyWGV8b6WPLNcXAzkZ6NtL3M/pqpJcba7Usswx4hfcJgmUjPUfTo1FG+j2ic3/yIvW6BytgQ7A9DKyADcH2MNhIzyb4hjAaZ6S/Qy34RdVVhh0HriXBRWivkV4JEsWQy84yZFcoZKQPMthIzyZ4wUb6ioEdBANzmCxRK7FEvb9D4E3wdTL0BjCN0nA3yvtF966UFAM7hdGmPJjh7pnaJng915C+AyvFSI9i+Iz0v1NHE/jBW9TrN9XnWBP8HEO2qtkM2apSGbZRekq11mbrTDWwYxltyoMZnnEz0WuCX60aE1OkVCM9iuEz0i9UC9+pdp471fuFImKklyLtYchucQ9DLecb0exhKCN9hYE00sMR9CnVLRHq9SnjyIoxsFMZbcqDGe4wTfCwP4L5/dPq/afVe91qYoz0JIYt3O1G10A/gWKr6D75QncxtgcGplAMtZxvYArFUMv5Qt/zCSf551kb5jz1ubmcOconRNW4TGW0KQ9m+H+v/bEwPeeTluieVJ/b29D8bTLDNar8K0OgE0ZLvNz6PhRzDN2yqtceBlzf08XH0C2reu1haHO9dc2SUiFmHE7cML4gMQJGelIewLGuB5MYhes0meHZPwaeB1z/hXLJ9Isi8YAaMtKTGbZw4Tascw1hbDdaYi2Uc9Vyvq5yhaFbVvX6K9X1O01UrUx2V7nC0C2rekUxRNcoHeuCYIz0VAYljycEfkZ6KqNEHiXqtI15mCb4WHcbY6QnMVwz0j9vCNQM/f55EZiRXgo0xrhcVUhwRvpchuidcXy12iDmST91Rnosg5JHyoz0WEaJPErUaRvzcM0mP6XEZg5wUWekRzF8M9JrgW4yWmItJNSM9JqhWmDdEj8v4gblHoZqgXVLjGFA2DOOL1RdIHOYnTojPYWBzSNlRnoKo0QeJeq0bXm4ZqR/XXVvzUtK1BnpUQzfjPRTwj0j/ZQIzEgvxTkpS4WhWmDdElNnpJ9l8Iz0PCN9Q/Oob0b6gMkANSN9yGQgxUqaTd7F4hnp8xg8I31LZ6RHuIOCRnqkO2iFXO5AzozjPCM9eifjGekzg2ek74qbZ6QPB89IP4/yaMSM9NijmDwKLZNdjixPrezqLHti8ywjZ8Zx7Q/mGekRjBJ51BA8I31uiysFq906q+X/Z88xpYCniF2POYYUbxLDcA3Nneu6XEE8I311fdhIP2RGehCbLI+J6sTSs35Y9TlKsLkMzwTXc75cwcFRf9RvpHeI7WwlFPAnflF1U8eJgiUzHIIlM1Swkb5cHsyoRm1GeleLa/phwXoEt4DZ02zGoimMNeo31xgbQhuln1XfuwIq6UHR8cLC/59JYLQpD2a445uq8YDr63BXk55bV5vg36u+v93xWzDSP69ESWb4usqmH3ZOKLKfP0E4mvWNYZkNQkdS0yhtR4qBncJoUx7M6A2Xkd6OFCM9ijHqORHXXdOFpthk99c0G8RO5rMZli93TrCG2SAU2ih9oei9JjqiPsca2KmMNuXBDM+4meia4PeI3ps1ZtTnWCM9iTHqOUc1/bC22M5FDkxlMyxfri3YGEMboPd6KmSvtZzZfbIN7FRGm/JghjtME/wFHvFfoP6PMdKTGKHHs/7Kej1Xtpqm2QATfWEYZoNQLEHyU2aCp/yt+Z4HM/yfH0EyUmakDzJ8XWXTDzsnNtlqbhTdm/xjXeUoQ5uTdXF0lSsMLVjTbGAavj2mb0yFmHE4ccOkfNezXMRIj84jYKRHMQrXaTIjYqQfWB4RIz1G/DEjPYnh6ypvNFo0U2x6gAjTVfYxPqxOsqNXwi1frilYDEMbpdd6uiBrreV0uAzsVAYlDxg5xxrpqYwSeZSo0zbmYZrgd3u62/pWTYyRnsTwdZVvMFrWZx2jwpjwMeCenj8VYaN0CYY2Sj/iqZBHBN5IT2VQ8jgo8EZ6KqNEHiXqtI15mCb4dR7xrxN4Iz2J4RPu2UbLeotjVPhVhHB7GKL7DKuYUboEwzZKu4bZqUZ6CgObR4qRnsIokUeJOm1bHi4jvR0pRnoUwyfc5bpltQT7pGoJML6mHoboPsMKY5SeZTgeFEdhsJG+TB4l6rSNedRnpJ+ZmbHPTW9S3TM4wmxULdzFqpm+TYow2tpGGF8THoOyeTO4PJ9NYrCRvspgI31LjfS2cNXKwYXn65Rg7sMKNsYwuthOg7I9x6kUL5nBRno20ufGvDXSK5F+XZXUo1wPw6gQlFFa7jA9DGMnYyO9YCN9HXk0wkhfU4X03fRNaT1NgZT28yJ5fTfSI32565AtIqmbnMBYh2wRSd3kBMa6UkIEsWvBpwrYPGAMVLi+SqREwW7bUmNAghLmhfBUhjMP4gHEmUdGr2GOkVHHResjo2tcNI+M/bZv+9ioGM64W3TuA6YGDEJ8NpPRpjyYUdO2HUbhgkka7lo5SPwdPIkALtZPZTDalAczaty2mGdOnaaOAHBNCa5v3ZE4wpzFUCPMFYYavKLEner330qo0B+LzrW3SxMZbcqDGTVv29Azp06TBa4r/UZ0rjFdpV5/Iz+/ASvYXAYIVhYnQ82ZS6lQ7Wd8lPC7dxkVOp7IaFMezGjAth1FiO2DlhUPbsHaShQsmeEQ7ActO1+UYcS3jcqAO5D2EioUjMzXi86F8RRGm/JgRkO2ravFBd8SPDLlU0psJxJM8EUZSrAniEZ6HbcbJ/sQC9X5w1LkUfB6da6RwmhTHsxo0LZ1CRfOJb8vy4NSbHtEmgm+KEMKtsJAGukhPiA6M//ZAQ+e+7X63hffEJ3pDn+bwWhTHsxo0Lb13Tm1SQruFiWWd8r3z8n3C5Sn9sui6nQQqQz7Irh9vQwEKkU7x5Dvn5PvFyhf7izDvrHAugb5OPxOdJ6o90krxXvU9764RP0G7tr6vCwXJTBIeXiu3ZLysBnWdV1UHn2sUxLDvlnDuq47sDwi+2kt+xjVSA9Hhc0y8fMRA1M+Bkwe/OeiM1VnbGCqwjCM9GiG6LiZrhLd+UZn9wk1EBCLnarStmQw2pQHMxqybV3C/ZCoTixdEawsk4hkvAzRsSf9mYgb6UswdFwguhMWQ2VcS9gowJ3MZMTyGEesSyyP8QL1MT6gOuU8MvexUUcXd1K1qCCQ+4iCDTJE99EbUSO9NcH1LEO9RzOsioG4i1ihp6vzi90ZDEwesXXB5FGiPgZRp5xHgX1sLCQ+4ZjImhIBhm1QvsnHAAHnMkTH4XGPOghQj8Svqkr9ciIDk0dsXTB5lKiPQdQp51FgH6vLHQQxPSDGcjVyd1UCH+4bhQdjL85gYPOYLpDHdJ/zKFGnnEeBfazue5XXD4ABz/XZlMi+Q3SePpDDoOSxvkAe6/uYR4k65TwK7GN1CVcbo3NN3xjGKxl5Hi7AwOQRW5fDBRhiQIxB1Eeb8kjax0YmJiay1hqu8WEnTz5nemPw+1+8cSJ7K+T4df/in57K/vs/+fv3oZeNeW5/dyCezx+tCP894qNritcpJWIm+xoeXeMbu0lml3gKBhjqB3qO6xMmRfyxnStVfBTB9fMgAHlQfusTt14fnpG+7Iz0OeJLfeQNpaucM8N20xgcHK0LW7g5M2w3jWFePPcV10V1uAAOTo/FGYw25cGMBm5bW7g5M2w3jQEXy1dFDlyrRO9FdbixG1waxzIYbcqDGWHGV1Sj4itfQWxbMsMUrmuG7W2iewuWEP4ZtpvGgMDasuzlTi/AaFMezAh/F/Pd7kVsWzLDFK45O7YOeHzGPtGdXFoI9wzbTWNwcAzNOa45O3ZlQE105i9Za3y2S/hvhG8Cg4NjaIQbmkAZmnZ4+txK9d43IW9TGBwcrQ7zOq4WwSHHcnBXx2dEd/Ihn7iSGI5ZzzMY58zrDVLiJhCTc+WytN9Xt8mG2urDvP67alt926Vy/bcBcweZLa45O7YZIJLzZPmR8Zk9w3YKA4T5lj4x5lPA+sLM5yMtYDSlPtqUR1S45uzYOsBiBNdOzQmCXTNsUxkhg3IJxnyKy0V8Bvb5wmhKfbQpj6hwXTNs24/S8M2wTWFAUGf6pjKEp6vtikOO7n4ug5KHb+bzIwUYYsCMftZHU/NYG+GsRexjZIZ9A0bODNtYhv5/zkzfGMZVIj7h0mHR63/cqcqyDAY1D9e6UPMoUR/9qtM257FdhO962o7Yx8gM22RwQnRme4fHosIthVtFdXbsj4v4DNsxxl1quek+M8CCdUZCLwRa9k8ZR8MURkoe0wXymO5DHiXqlPMovI/53EH7lUhzAsMwZ/ouwijt8kkNTB6OEeRYfWCiwsBY8hwOogqjhJ0Ow3A4iCp5lJimFcNwOIgqeZR0+aTGWAmvJZYRm02euJMVn7W8RtE714Uofp6Rfh7kUUr0rZ2RPiUGbaSPrQsxn0bWKedRjXlppB9E6z5sRvrY+rCRvp1G+rGcirXPW0owUna0QT1ahYOjKdHmGenZSF8mD2Y0cNu6hDuDKLFoAoON9GXyYEaYUbuRvtIdV91o/TzZ9er9jZQufc0M+2I5PB3+dcRypxdgtCkPZoQZpgnefuCDEHQjPYrhEi7c4ADT/p20Pj+pPp9CiKYpDDPgpg2Ye+hgRvebGcwIheuBD31huIQbm7oSM7VlUxh2wHAtPK8q53ocM5gRCtcDH4oz2jw45Qvw9ML1uf3MYEafGPYDH4ozxupWkXkJKfXWuuolpHMwFXJvgUrtC4N4DdebB8FI72QQjfR9qw+ikb4veYyMniL+4+43dpd4wxkY8X+mwAHEyxi2Fhc2xpOyfKRBjFTDdhMZTamPYnlI0VLzcD3wQZRm1CXcEiZ4KgNms/+pLCsy8u4HI8Ww3VRGU+qjSB5StNQ8XA98oAaKERPuAus1JVwMykzfqQzbvHy36B1mdy13pACDkkeKkR7LEANm9LM+BpqHFG2Kkd71wAeqkR7FCAn3TtGdgft29Z4aPkbMoFyCwUb6MnmUqNM259EII70Z1xboEocY031msJG+TB4l6nRe5QGDUU3fx+oeVS5uHGcjPRvpQ4FhVEaQHXk0wkg/yI1jbBivQTm2o7GR3it+NtLPgzzYSB9hUK6HmgIp7edF8vpupEfaJdcRW0TyQRzJCOZB8dT6WtgQw+gqB/Og+HJNwZbw8w5UuCVa9YLe26WIwQlXmLM4pDKceRAPIM48MnoNc4yMOi5aHxn7S1YeM78/UWFkdNH7to8N4y2PEDD0f0rC7+AC/WczGW3Kgxk1bdthFC7cOAc+S6oL5N2ic+/oVAajTXkwo8ZtO2zChWvAYJvam1ChP5blC7JcmshoUx7MqHnbjg6ZaPUk2I8Sfvcuo0LHExltyoMZDdi2wyLcbxuV8TrhaAgVukeW62VZnchoUx7MaMi2HQbh3m6c7EMsVOcPS5FHwevVuUYKo015MKNB27btwv2A6Lg+7ICHdf1afe+Lb4jOExF+m8FoUx7MaNC2HWu5cB+X5Z2y3CrLJ63v7lHf++IS9Rt4vtXnZbkogUHKw3PtlpSHzbCu66LysG/WsK7r5tQpiWHfrGFd1x1YHvbNGtZ13Vr2sWHoKsNN3LZV6jtqICAWO1WlbclgtCkPZjRk2w7L4NQFouu1hMqgOJ9glG8ykxHLA/NQgFgelAcL9JMxqPpoUx7kfWxYhKsr/C5ihZ6uzi92ZzAwecQM25g8KA8n6CdjEPXRpjyS9rFhEe5ada6wOeFI/KroukRSGJg8YoZtTB6UhxP0kzGI+mhTHkn72NgQiHa5Grm7KuG3cN/ohaIzx0sqA5vHdIE8pvucR4k65TwK7GPD0OLC/CybEn97h+g8cS+HQcljfYE81vcxjxJ1ynkU2MeGQbivZPz2cAEGJg9t0PYZtg8XYIgBMQZRH23KI2kf+38BBgBl/ARfytYPuAAAAABJRU5ErkJggg==); } +@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-kind-icon:before { background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAdwAAAGYCAYAAADoalOPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAa/5JREFUeNrsvQ+MFce9JlozRpNlzdOs0HKFNRb+E/y4zxvb5GFhxYIdhJcIiwgShysc7suOvbEcEdmyZYsIL/OYgMyCgoyMsIKCzI3nWtcx73ltwYvFKF4j5jKyn5Hnhdj3Ostby39mGXm02OjOXjvszgt7Xv3oXzM1Pf2nqruqq8453yeVzpk+3VXffF3dX1d1Vf06Go2GAAAAAIBWw47BG4PhsqvvE9GJUwIAAAAA7jEHEgB5WP9rf2Uf/wH0CF0PAAi1pUktytCAFi4AAAAA+GjhHupwX+gWjdfGofAYHBx0zqOvry+IllUztaCgR5j1FPePmRg97J7IsocbTcNDAzfJtEmmNTJ1y7SUt5+VaVKmN2Q6KtPHjv8dJzzQpQwAAAD4xgqZnpapN8vP+XO1THtkGpGpX6ZhC+VeluntOniU6VKeTw93Mh2T6V2Z/sTpXd62hfdxDfDwz4Oe/B7gp0HoAT3AAzxM0SXTQZlOs8ldpA4KmTbIdCc3Cufw9w3820U2xlN8bFeFcnvYbGvhYWK4c2XaJtNHMv1CpvXs9tdwWsbbfsH7bONjbAM8/POg45+Q6XfcpfIx9IAe4AEeJUz+tzI9ItMlmfbKdLNMP5HpuEyj3Pq8zN+P8283876X+NjfGj4MxOVOiKhbuDYeuoa7kF18Dz/F6zzp7+FjFlqsHODhn0dcJnW73M9dKdADeoAHeJga/QluTZLxrZLpKRG9Hy3CJO+7io/t5bzmGpRLrdPddfPQMVxqcr8j0/ISoi7nY3ssVA7w8M9jgVLm4zKdgR7QAzzAowSe5XzGZbqLrx1TnOFjxzmvZzXLpQFQj/rgUWS41Cf9qkyLKgi7iPPoqpAHePjnQfsd4+OoW+Uw9IAe4AEeJY6lbuqHZZqS6T6ZxirwGOM8pjjPZRrlHmBzrJ1HkeE+UfIJKO2J6IkKx4OHfx70juJb/P2n0AN6gAd4lOTxc/7cX7JFmdbC3J/IO6tceg+7zxePPMOl/vqtwh62Cr33BOARHg/6fTt/p3loJ6EH9AAP8CjBg7pzaUrNpGJ8NrCP81wtpufMppU7JNMFXzzyDHedsDsMnPLaXOI48PDPY6NS5ivQA3qAB3iU5LGRP18X0cAlW6C8XkqUkVbukE8eeYa7SdjH2hLHgId/Hurvb0MP6AEe4FGSR/wa5qgDHkOJMtLKHfXJI89wlzggsqzEMeDhn8dtyvdz0AN6gAd4lOSxJHHd2MRozv8Yb/vQJ488w13ogMiCEseAh38eapkXoAf0AA/wKMkj3nfCAY8LOXzibZM+edQdLWhKhAHwAA/wAA/waC0eXaHzyDNcF84/XuIY8PDPY6KmJ1TogXoKHq3Nw2WPUE+ijLRyu33yyDNcF33b52o6Bjzs5vm+8n0J9IAe4AEeJfN0OeYh71qMty32ySMvPB9Nd1hvmchQiWNs8KAnsCdFFErp6tNYVszMjDiXznhkxTLNiD/q47zQ7/EQdxp5d7Id6kdOzF1XeqTyyOKTEa+3netpq98/gtYjK+ZuIk4ujepfzdfPcct6rFXKSCIudyl/98Ijr4VLJCYtkqC8XipxXFUe9JRxu4iGf49XyKdVeJQ5L3SRxnPVNqJ+ONED9RT3j3bQI563TqbfbVEPymtzooy0ctf55NFZcEL3WiSyt+SJrsqjX7k5Ut/6yzKdl6nB6Txv62kTHmXOC/2+m7/TE2Jvm9cPF3qgnuL+0Q560Mpsw2xM2yzqsY3zHOYysspdI6JxF154FI1SpnUhRy2QoDwOVDi+Co83+JP61d8T0cRvtTL08Db67dY24FH2vDwnptcbfQb1w7oeqKe4f7SLHk/yJ63DvMyCHpTHY4m8s8rtEtPrP9fOo8hwabj3hopdKeOcx6UKeVThET8FUrzS+ZwXPaVdz6mft83nfVqdR9nzEpc5JmZG2WjX+mFbD9RT3D/aRQ81utYxUS3MXw/nMZfzHC14UDnMBtvjg0en5gm+W5SPE3h3xQpmg4fgrgTCAHcHjnPazdvUfVqdR9nzQlMK4piRahzJdq0ftvVAPcX9o130UONHvyXKx+V9i/M4w3kWgfahrt6DPnjoLnxBT/Gr+OlF573BJO+7SlSLMWiDR4z4xfiRlP3ibfPagEfV8zLBx+8S0bua3javH7b0QD3F/aOd9KAW+r0ietdJsXVPcYtYZwBTN+97io8d5rx0Wv1xudQC3143D5OVpi7x08vNMj0qoigL6kvhs7ztUd5nd8VuD1s8krigua1Vedg4L3Q8Dby4U0Tz2ha1ef2woQfqKe4f7aYHDb76Nhv0XDbAj7j1SaOJ1fB2S3nbQd5nOx9zhPMwifgTl3uTiN4318ZjTokTRBk+x8knyvJogIfVMo+gfjjRA/UU94920IPe9z4k04sy7RHRvPZHOOWB5rg+xa3KKuX2chqug8csw93SEEHAFo+syem6yJjUb4ysRQN0kbHIQdvClh45i1s0FUKpp7h/zERi0QdvsMUja3ELCyDDonfKNPqZ5rbT+99upXVJLW3q0qZR0jS/9ZzFcmvjMUe0L+7hzzfBA0D9QD2FHkHoQQa2W0zPc/cFJzza2XC7wAMt6zLnxYUmOS1t1FPcP5pej119n0ChNjNcGrKuzrM6kbFPu/AAUD9QT6EH9IDhOgG9EP+VyA7HNMH7tAsPAPUD9RR6tLQeobWs28lwKbLGdeABoH6gnkKP9tBjx+CNwXAh8+9oNBqoOgAAAEDLITTDbfoWbtVh+1WnD1SdRmFrOocr+Jw2E+KALegBAM1hfCEO1OqsmoE0vBWUAvhfVnACDwAAACA4lG7hssnSOpK9/DdNGO6XLcYRDwZ3lYeIJi7T2qAtxaOOllUztaCgx0xU7WnRgU5vzKEO9/+rTq9UKDwcLhRxFTqLWoTCQwPxcot5C04cleljx/+OEx7GLVxu0Z6SX08r5iL4+2n6rY4WbxEPES0oXUdLcwWX5ZsHAABAsyK+j9L6xLS04moRhb28htMy3raH90neb6uU+626eGgbbo7BJeHUeE15uDI82aJYIZN3Hgoo+sUWEcVkfFemP3F6l7dt4X1sgp78HuCnQZ88oEeYeoAHeBSBFsw4qNxHaU3nQyKK10vBQOZwupO3HeJ9YmM8KMotQhKXS3OJ366LR6HhGhicU+OtysOW4RkYbV3GS5EqtvHT1i9kWp/yRLaef/uI951roUwK4vw77lL52BMP6BGmHuABHrom/1sRBQiII25RRKKfyHRcREHcL3Ma5W0/4X328jGPcB7zS5RLc4WP1smj04HBWTVe2zzKGl4Fo3VpvAs5nz1CP37jHj5mYcUy6X31/SJ6V+2DB/QIUw/wAA9doz/B98M4pjRF3dGNy/sUHzPBeZzQfBCIy6XW6e66eXQ6NLhKxuuah67hWTTaVB6UN5VR4njqCnlHpuUZv+/KOXY5H9tjWOYCpczHZTrjiQf0CFMP8AAPXTzL+dDyj3fxtZOGHTl5nOFjxzmvZzXLpQFQj/rgMctw//wBcXreIqvGMgMXxVjv/y1eOF20Xyg8Fi9efPraa691xuOLL77oHRkZOW14GL0reFVEgc6zMFBw0SziPLoMyjzGx1G3ymFPPKBHmHqAB3jogrqpHxZRTNr7ZBrL2XdngdmNcR5TnOcyjXIPsDnWzmOW4f5PNwrxv/ybK4Yn5i2yanBCGpx4W/yV+EJ8Urh/KDzmzZsnbrnlFjJeIY3XptEKabTi9OnT4vPPPzc9/ImcJ1OTi2Y556UDekcRj+b7qUce0CNMPcADPHTxc/7cn9OiNDG7M5yXmndWufQedp8vHp2uDc/U4ELlYct4Kxotgd6jbDXYv+ii2SqK39/Q79v5O81DO+mJB/QIUw/wAA9dUHcuTauZVIxPB0Vmt4/zXC2m58ymlUtrQF/wxaNwlHJZw6tqcKHyKGu8Fow2xjphPjw/76KhvDYXHL9RKfMVjzygR5h6gAd46GIjf74uooFLJsgzO8rrpUQZaeUO+eShPQ9X1/BsG1yoPHSN16LRxtiU+LsjI5lcNGsLylR/f9sjD+gRph7gAR66iF/DHE1sb2QkE7MbSpSRVu6oTx7GSzvGhveP0sPOnxTiy7Fpg/t/xUkn5hYyj9h4v/zyS/HZZ5+Jr7766qrR/uEPf7BlsiqWVDh2gD+TFWVZwXG3Kd/PeeQBPcLUAzzAw7T8cxV47OTP5APAaM7/GG/70CeP0mspq4b3wgsv1GZwofJQjZd4ODDaGAtTnsiqYoFBmRc88oAeYeoBHuBhuu9ESku7Ki7k8Im3TfrkUTlaEBmeL5MLkQcZr0OzdYUp8AAP8ACPJufRFTqPpo+H24agJ7LkqEAauPOqYT4vKd/HDcpcwPv74AE9wtQDPMDDpPXXwy3t5GpO9KrmG4Y81LhhPYkWZlq53fzdC4/KLVygdqS9c6DRcPdZzlPF+8r3JR55QI8w9QAP8DDdd0nGdfV3FXjkXYvxtsU+ebRLC5eewJ6UaWSd+NmMp7G0uJlbGu55fPe7353BIy2eaUb8UXoaXZ9x0YiUJ9WXNHgNafwe508j70564uFKDzoXtA7yiPq0nhNz15UeqTyy+GTE63XGIyvmbkD1tFY9smLuZtw/Wl6PrJi7iTi5NKp/NZd3POdh9hs5LcgsrFXKSCIudyl/98KjHVq49JRxuzTao0mz9cFDGu3RpNka4rjIXli7zJPqpMbFTRfpxcSF6YOHCz2unBcRTQ8YN7hp2dajDI9Q9AilnkKP8PWI562T6Xfn9CCZtjApr82JMtLKXeeTRzsYbr802vjmSH3rL8t0XkzPrzrP23pc85BGa4MHXSx7c343vXj3iuLIGPT7bv5OT4i9nni40KNfMU/d8+JCjzI8QtEjlHoKPcLXg1ZmG2Zj2pZTjqnZbeM8h7mMrHLXiGjchRce7WC4b/An9au/J6KJ32pl6OFt9NutTcKD1usctXDxUh4HNPk/J6bXG33GIw/bepQ9L7b1CKV+NHs9hR7h6/Ekf9I6zMssmB3l8Vgi76xyu8T0+s+180gz3FUi6pt3hREuowhWeMjWbfwUSPFKaRmyKX5Ku55TP2+bz/s44SFbt1V5qKD9NhR06RRdvOOcxyXNfyEuc0zMjLJRNw/bepQ9L7b1CKV+NHs9hR7h66FG1zpW0DtQZHY9nMdcznO04EHlMBtsjw8eswz3zgExLNNKB8Z7xWh/0/jZSpmGi3Z2wGMNfw5wd+A4p91iegWVNcmD7rjjjmGZvPPIuPDuFvlRLjZmbD/Dx5q+g6EpBXHMSDWOZN08bOtR9rzY1iOU+tHs9RR6hK+HGj/6LZEfvej9jO3L+dgezutxjf+b9qGu3oM+eHTWYHhGRuuQR/xi/EjKb/G2eVkHWzTeSjwSGGM+/ULvfc4k77tK5Md+LDJdOp6WM6N3Nb2eeNjSo+p5saVHKPWjVeop9AhbD2qh3yuid520Kv4pbhHrRB7q5n1P8bHDnJdOqz8ul1rg2+vmUfgOt4LhVTJah8Z7QXOba+OtxCNRgeip8maZHhVR9Av1Zf1Z3vYo77O7YndUXCYNvLhTRPPaFnniYUMPG+fFhh6h1I9WqqfQI2w9aPDVt9mg57IBfsStTxpNrIa3W8rbDvI+2/mYI5yHScSfuNybRPS+uTYe2vNwyfDkx8p3d155gidXX5FjtP02TNYGj5TtVmbZkvESj9///vdeeSQq0XOc6sLFlCdcHzxs6tEIRI9GC+gRSj2FHuHqQe97H5LpRZn2iGhe+yOc8kBzXJ/iVmWVcns5DdfBw3jhixzDc2q0pjwqnAhTXOHBJ80Zj4xFDtoWtvRY/+vW0CNj8QljZC1uoQuHi8Z44XGo4lL2iUUfvMEWj6zFLSzdR+mdMo1+pnfH9P63W2ldUkuburRplDTNbz1nsdzaeJReaSpheKIuoy0wPGFgcPfw55stxgOwg1DOC3igfrSTHmRgu8X0PHdfcMKj8tKOZLy/GfhZCCfc1PC7WpxHUC3JJkRXnZrktLSDj4CC+gEU6bGr7xMoJFpgLeU7B6a/pxm/0iVEQ9bVeVYnUrIzHm5/xx13zNr22muvzdqmdNU54QFURijnBTxQP6AHDLfpQS/EfyVmB2COMcH7tAsPAPUD9RR6tLQeobWs28lwKbLGdeABoH6gnkKP9tBjx+CNwXAh8+9oNBqoOgAAAEDLITTDbfoWbtVpHVUHwFSdRmFrOkeo+vo8N9ADANrX+EIcqFU5WpC8Aa2gFMD/skII8AAAAADCROkWLpssLfTQy3/TdJh++RQ+UvP/MIOHiKbl0IITLcWjjpZVM7WgoMdMVO1p0YFOb8yhDvf/q86iFqHwcLhQxFXoLGoRCg8NxMst5i04cVSmjx3/O054GBtu0mgV0N+n6zLeIh41Gm8oPAAAAJoVWffRq37On6tFtPSirZX8qNzLIlqi0TkPbcPNMThRp/Ga8nBleLJFEQQPBfP5iWytiObHqU9kNB9uiJ/ILlosk578vsf/28ceeUCPMPUAD/AoAi2Y8YyYXrP4IpczxOXGgRSWMq+1zJPuv6dEtPYzBXufKlnuCJdXC49CwzUwOKfGW5WHLcMzMNq6jJciVTwm0zaRHlJqGaf1/ERGUW0OiGqRR6jMLVw5H2Rz8cEDeoSpB3iAh67Jv8r3xkucL+WfFipwlNNxEQUL2Ma86Zq7Tab7DB4G4nLjbuHaeMxxYHBWjdc2j7KGV8FoXRovTTo/JvKDJidbYHu4FbZBRJPTy5ZJlWuViAIu++ABPcLUAzzAQ9foT3DZE5zfGc1jJ9nsXmP+vZzXKo0HgbhcarXurptHZ5rByXSKTaFX2ENsvKd0RjW75sHdAIU8yGhlcsaD8mYzNwV1a7yTc7G8mnPscj62x7DMBUqZj3PF9MEDeoSpB3iAhy6e5XzI+O7KMblv5ORxho8d57ye1SyXuoUf9cFjluHec7M4veCfWjWWGbj0+Vjvf/7bF04X7RcKj8WLF5++9tprnfH44osvekdGRk4bHtbFF8SinH1eKbhoFvHvXQZlHuPjqEvlsCce0CNMPcADPHRBXdQPi+h9J3XBjuXse1uB2Y1xHlOc5zKNcg+wOdbOY5bh/tm1Qvyrr18xPCENz6bBCWlwYmz4r8QfL3xSuH8oPObNmyduueUWMl4hjdem0QpptOL06dPi888/Nz38Cc1uoKKLZjnnpQN6R/Et/v5TjzygR5h6gAd46OLn/Llf6HXfFpndGc5LzTurXBqRvM8Xj07XhmdqcKHysGW8FY2WQO9RthrsX3TRbBXpgyWSZW7n7zRa76QnHtAjTD3AAzx0Qd25NKVmUjE+HRSZ3T7Oc7WYHmGdVi6NOr7gi0fhSlNlDa+qwYXKo6zxWjDaGOtENKpOWLpoKK/NBcdvVMp8xSMP6BGmHuABHrrYyJ+vC/MpRnlmR3m9lCgjrdwhnzy05+HGhvdfvhLivQn5iPDHbIP7/IOTVswtZB6x8X755Zfis88+E1999VWm0f7hD3+oarIqNiX+3mxw0RDuS/mN5pQdyjl2rfL9bY88oEeYeoAHeOjyiF/DHE1s113X7Tb+/LuU38hMtyhlpJU76pOH8UpTWYbn2uBC5ZFlvA6MNsaSCsdmXTTLNCsX4ZxHHtAjTD3AAzxMyz9XgUeW2Y3m/I/xtg998ii9lrJqeC+88EJtBhcqD9V4iYcDo42RDPj8koU8FxiUecEjD+gRph7gAR6m+ybn8NpYHf1CDp9426RPHpWjBZHh+TK5EHmQ8To0W1eYAg/wAA/waHIeXaHz6BRAsyFtdZcBmToMk4pxgzIXeOQBPcLUAzzAw7T1tzDlt50yNQyTip5EGWnldvvkAcNtPpzLqCA7LOep4n3l+xKPPKBHmHqAB3iY7rskw/h3VeCRdy3G2xb75DFHtAfoCYwiOYws+f7PZjyNpcVVdRgH9SqP7373uzN4pMUzzYg/SgMX1mdcNCKlougEqRzS+D0e4k4j70564uFKDzoX94toXevxvLrhWI9UHll8MuqpMx5ZMXcDqqe16pEVczcjTm7L65EVczcRJ5dG9a/m6+d4htmJlAcAnYC+a5UykojLXcrfvfBohxYuPWXcLo32aNJsffCQRns0abaGoMoxmfFbmSdVyusljYs0nqu20SMPF3pcOS8imh4wbnDTsq1HGR6h6BFKPYUe4esRj3Qm089aMKNMC5Py2pwoI63cdT55tIPh9kujjW+O1Lf+skznxXTf+3ne1uOahzRaGzzoYtmb87vpxbs35wJUy9zN3+kJsdcTDxd69CvmqXteXOhRhkcoeoRST6FH+HrQymzDbEzbcsoxNbs4vOCwmI5dm1buGhGNu/DCox0M9w3+pH7190Q08VutDD28jX67tUl40HqdoxYuXsrjgCZ/CrAcrzf6jEcetvUoe15s6xFK/Wj2ego9wtfjSf6kdZiXWTA7yuOxRN5Z5XaJ6fWfa+eRZrirhL3g6GkY4TKKYIWHbN3GT4EUy5aWIZvip7TrOfXztvm8jxMesnVblYcK2m9DQZdO0cU7znnoBpKOyxwTM6Ns1M3Dth5lz4ttPUKpH81eT6FH+Hqo0bWOFfQOFJldD+cxl/McLXhQOcwG2+ODxyzD/cE3xLBMKx0Y7xWjPffKz1bKNFy0swMeaxThdnNli4MQDyT2uYo77rhjWCbvPDIuvLtFfpSLnRnbz/Cxpu9gaEpBHDNSjSNZNw/bepQ9L7b1CKV+NHs9hR7h66HGj35L5EcvGsjYvpyP7eG8Htf4v2kf6uo96INHZw2GZ2S0DnnEL8aPpPwWb5uXdbBF463EI4Ex5tMv9N7nTPK+q0R+7Mci013FT3v0rqbXEw9belQ9L7b0CKV+tEo9hR5h60Et9HtF9K6TYuue4haxTuShbt73FB87zHnptPrjcqkFvr1uHoXvcCsYXiWjdWi8FzS3uTbeSjwSFYieKm+W6VERRb9QX9af5W2P8j67K3ZHxWXSwIs7RTSvbZEnHjb0sHFebOgRSv1opXoKPcLWgwZffZsNei4b4Efc+qTRxGp4u6W87SDvs52POcJ5mET8icu9SUTvm2vjoT0PlwxPfqz89d9deYInV1+RY7T9NkzWBo+U7Q0bPMh4icfvf/97rzwSleg5TnXhYsoTrg8eNvVoBKJHowX0CKWeQo9w9aD3vQ/J9KJMe0Q0r/0RTnmgOa5PcauySrm9nIbr4GG88EWO4Tk1WlMeFU6EKa7w4JPmjIfDxTiaErb0WP/r1tAjY/EJY2QtbqGLLY0w9LDF41BHteMTiz54gy0eWYtbWLqP0jtlGv1Mc9vp/W+30rqkljZ1adMoaZrfes5iubXxKL3SVMLwRF1GW2B4wsDg7uHPN1uMB2AHoZwX8ED9aCc9yMB2i+l57r7ghEflpR2vvFt95WchnHBTw+9qcR5BtSSbEF11apLT0g4+AgrqB1Ckx66+T6CQaIG1lKXhT39PMX7lRkZD1tV5VidSsjMebn/HHXfM2vbaa6/N2qZ01TnhAVRGKOcFPFA/oAcMt+lBL8R/JdLDMREmeJ924QGgfqCeQo+W1iO0lnU7GS5F1rgOPADUD9RT6NEeeuwYvDEYLmT+HY1GA1UHAAAAaDmEZrhN38KtOq2j6gCYqtMobE3nCFVfn+cGegBA+xpfiAO1KkcLkjegFZQC+F9WCAEeAAAAQJgo3cJlk6WFHnr5b5oO0y+fwkdq/h9m8BDRtBxacKKleNTRsmqmFhT0mImqPS060OmNOdTh/n/VWdQiFB4OF4q4Cp1FLULhoYF4ucW8BSeOyvSx43/HCQ9jw00arQL6+3RdxlvEo0bjDYUHAABAsyLrPnrVz/lztYiWXrS1kh+Ve1lESzQ656FtuDkGJ+o0XlMergxPtiiC4KFgPj+RrRXR/Dj1iYzmww3xE9lFi2XSk9/3+H/72CMP6BGmHuABHkWgBTOeEdNrFl/kcoa43DiQwlLmtZZ50v33lIjWfqZg71Mlyx3h8mrhUWi4Bgbn1Hir8rBleAZGW5fxUqSKx2TaJtJDSi3jtJ6fyCiqzQFRLfIIlbmFK+eDbC4+eECPMPUAD/DQNflX+d54ifOl/NNCBY5yOi6iYAHbmDddc7fJdJ/Bw0BcbtwtXBuPOQ4Mzqrx2uZR1vAqGK1L46VJ58dEftDkZAtsD7fCNohocnrZMqlyrRJRwGUfPKBHmHqAB3joGv0JLnuC8zujeewkm91rzL+X81ql8SAQl0ut1t118+hMMziZTrEp9Ap7iI33lM6oZtc8uBugkAcZrUzOeFDebOamoG6Nd3Iull05xy7nY3sMy1yglPk4V0wfPKBHmHqAB3jo4lnOh4zvrhyT25GTxxk+dpzzelazXOoWftQHj1mGe8/N4vSCf2rVWGbg0udjvf/5b184XbRfKDwWL158+tprr3XG44svvugdGRk5bXhYF3eBLMrZZ6DgolnEeXQZlHmMj6MulcOeeECPMPUAD/DQBXVRPyyi953UBTuWs+/OArMb4zymOM9lGuUeYHOsnccsw/2za4X4V1+/YnhCGp5NgxPS4MTY8F+JP174pHD/UHjMmzdP3HLLLWS8QhqvTaMV0mjF6dOnxeeff256+BOa3UBFF81yzksH9I7iW/z9px55QI8w9QAP8NDFz/lzv9Drvi0yuzOcl5p3Vrk0InmfLx6drg3P1OBC5WHLeCsaLYHeo2w12L/ootkq0gdLJMvczt9ptN5JTzygR5h6gAd46IK6c2lKzaRifDooMrt9nOdqMT3COq1cGnV8wRePwpWmyhpeVYMLlUdZ47VgtDHWiWhUnbB00VBemwuO36iU+YpHHtAjTD3AAzx0sZE/XxfmU4zyzI7yeilRRlq5Qz55aC/tqGt4tg0uVB66xmvRaGNsSvzdkZFMLpq1BWWqv7/tkQf0CFMP8AAPXcSvYY4mtjcykonZDSXKSCt31CcP45WmYsP7L18J8d6EbJv/cdrgPv/gpBNzC5lHbLxffvml+Oyzz8RXX3111Wj/8Ic/2DJZFUsqHDvAn8mKsqzguNuU7+c88oAeYeoBHuBhWv65Cjx28mfyAWA053+Mt33ok0fptZRVw3vhhRdqM7hQeajGSzwcGG2MhSlPZFWxwKDMCx55QI8w9QAP8DDddyKlpV0VF3L4xNsmffKoHC2IDM+XyYXIg4zXodm6whR4gAd4gEeT8+gKnUenAJoNaau7DIjsdzE672jGDcpc4JEH9AhTD/AAD9PW38KU33aK7HeoOu9WexJlpJXb7ZMHDLf5cC6jguywnKeK95XvSzzygB5h6gEe4GG675IM499VgUfetRhvW+yTxxzRHqAnMIrkMLLk+z+b8TSWFlfVYRzUqzy++93vzuCRFs80I/4oTUNZn3HRiJSKovOOZkjj93iIO428O+mJhys96FzcL6J1rcfz6oZjPVJ5ZPHJqKfOeGTF3A2ontaqR1bM3Yw4uS2vR1bM3UScXBrVv5qvn+MZZidSHgB03q2uVcpIIi53KX/3wqMdWrj0lHG7NNqjSbP1wUMa7dGk2RqCKsdkxm9lnlQpr5c0LtJ4rtpGjzxc6HHlvIhoesC4wU3Lth5leISiRyj1FHqEr0c8b51MP2vBjDItTMprc6KMtHLX+eSRZri7xOz++irN67KwxaNfGm18c6S+9ZdlOi+m+97P87Ye1zyk0VbhoV5oe3N+N7149+ZcgGqZu/k7PSH2euLhQo9+xTx1z4sLPcrwCEWPUOop9AhfD1qZbZiNaVtOOaZmF4cXHBbTsWvTyl0jonEXXnjMSek2G0gr9Ae3pTavrSCj684Wjzf4k/rV3xKzV1mhirGJT8TK708NfpDoOUvlsXTpUqc8ZPogJ6/93LJalnPRCI2KQvPFDmjyf4750fqpFKj5Tk88bOtR9rzY1iOU+tHs9RR6hK8HvVZ7V0TrML8ipuetZnlA0X2W/o/HlLyzoJb7lA8eaS3cLjFzWPOVv3/9fuUXyTGo33+Vxn5WeMjWbfwU+DRXjil+SrueUz9vm8/7aPE4e/asEQ/Zuq3KQwXtt6GgS6foSXWc89ANJB2XOSZmRtmom4dtPcqeF9t6hFI/mr2eQo/w9VCjax0r6B0ous/2cB5zOc/RggeVw2ywPT54dKaYyzHlwLnK31VN94rRnnvlZytlGtYwW9s81ijC7ebKFgchHkjso8XD1HQr8Mi68O4W+VEudmZsP8PHmr6DoSkFccxINY5k3Txs61H2vNjWI5T60ez1FHqEr4caP/otkR+9aCBj+3I+tofzelzj/36cu3oP+uDRmWIuNMKK+ksXcgZLeVtZszMxWpc84hfjR1J+i7fNM+VRwnRNeeRhjHsL+oXe+5xJ3neVyI/9WGS6q/h/pnc1vZ542NKj6nmxpUco9aNV6in0CFsPaqHfK6J3nRRb9xS3iHUiD3Xzvqf42GHOS6fVH5dLLfDtdfPoTDEXmqx7j0wfi2jdyXt4W2wyczXNztRoXfFI4oLGNiMeJVu6FzS36VQgeqq8WaZHRRT9Qn1Zf5a3Pcr77K7YHRWXSQMv6L3lYq5sPnjY0MPGebGhRyj1o5XqKfQIWw8afPVtNui5bIAfcetznZgZ3m4pbzvI+2znY45wHiYRf+JybxLR++baeMzJMBf1RfcHvO1N3udVme4js8sYwERG229gsnkmV5lHSjkNFzzIdDMGUpXlYQo60c9xqgsXU55wffCwqUcjED0aLaBHKPUUeoSrB73vfUimF2XaI6J57Y9wygPNcX2KW5VVyu3lNFwHDzLcaxLbLqfsdznj+AHFYMoabQyrPCqciFB4zIDDxTiaErb0yFncoqmQsfiEMbIWt9DFlkYYetjicajiUvaJRR+8wRaPrMUtLIDuk/ROmUY/0whqev/brbQuqaVNXdo0SppGFJ+zWG5tPOZwl8J93FKjFtspEfXrx626W3kbzV0a4n2vdG384BtC/PrvohHHFYxW7dooxYOxKkPALNzDn28GygPwi1DOC3igfrSTHmRgu8X0PHdfcMJjTobJvMkufw1/zzIXMt3hH7zyM1t8SvMo0ZLsagIeLdOSbEJ01alJTks7+AgoqB9AkR67+j6BQmLmWsqqyRAmlCa0yDAXFzDmQS3tK58pxq/cyGjIujrP6kRK2eNVeNxxxx1XPl977bVZGStddaY8gHoQynkBD9QP6NEGhquajFDMJPl3HXDBg16I/0qkh2OKDfWhQHkA7hHKeQEP1A/oYQmhtaznZJhd3t91mq5NHtQFfF3eDt+fGgyCB+AFoZwX8ED9gB6WsGPwxmC4kPl3NBoNVB0AAACg5RCa4c5pd0GrdjlUnUZhazqHK/icNhPigC3oAQDNYXwhDtTqtCDkCkoB/C8rOIEHAAAAEBxKt3DZZGkdyV7+m6bD9MunihEPBneVh4im5dCCEy3Fo46WVTO1oKDHTFTtadGBTm/MoQ73/6vOohah8HC4UMRV6CxqEQoPDcTLLeYtOHFUREvtuoQTHsaGmzRaMb2gNf19ui7jLeJRo/GGwgMAAKBZkbyPzvJz/lwtoqUXba3kR+XSyoFv18FDu0uZu45PsYn0srHQKhw3cNrN22LjPeWiq9mUh4hWhbLOQ7YoVsjknYcCin6xRUTrQFNQ5T9xepe3bRGzg0VXBT35PcBPgz55QI8w9QAP8CgCLZhxULmP0prOh0QUr/dObhTO4e8b+LeLfC89xcd2VSi3h822Fh6FLdyMliQtcL1PtmLVcE39ct998nOriBZ8ttrizeMhZoaN6udtM3jYammS0YbAQwFFqnhMpm0iPaTUMk7r+YmMotocENWmN83lC5D+rwe5W8UHD+gRph7gAR66Jv8q3xsvcb57RXqowFFOx0UULGAb86ZrjsLX3Cf0IwbF5cbdwrXx6CzTkpTm2Z8w2yugbfQbt/B22WjxFvHIECWOHzmLR9mWZkGLtjYeCSzkfPYI/fiNe/iYhRXLpIeO+/kBwgcP6BGmHuABHrpGf4Lvh3FM6aeEflzep/iYCc7jBOepW+5Fvn/XyqPThtFmGO9AFeO1wYOPGahieHlG29fXZxK4OZUH5c2tZlNQV8g7Mi0vcexyPrbH8LgFSpmPy3TGEw/oEaYe4AEeuniW86HlH+/ia8cUZ/jYcc7rWc1yaQDUoz54pLVwTyvdpdQ1druBwWUZ7+0iCt4uFMMrgjUeiuFZ4UFGK1PdPFR0cRfIopTffqzZ3bOI8+gyKPMYH0ddKoc98YAeYeoBHuChC+qiflhEMWmpC3YsZZ9farZYxziPKc5zmUa5B9gca+dRNGiKBn+8J1ua22XqNlWVjqFjKQ+ZFleoIJV4cFeINR6yRbpdJp88nsh5MqUb/8qMypP2pPqEZpn0juJb/P2nHnlAjzD1AA/w0MXP+XN/TovyYW6ILNJsYe5P5J1VLo1I3ueLR57hxqNsySTo/dSnuoanGO2nfGy3mO6KNUVpHorBOeFBxiv0333Y4kHHbi3Yh1pc3xTReqdF2KrxP8T8CTQP7aQnHtAjTD3AAzx0Qd25q/n+t0+jJfw7EYVILUI8aHW1mJ4zm1Yu/U8XfPHINFxl8FOa4e1IM7wCo40HORmhiEfGyc4zuHiQkxH4fW0qD/rX6+IhsU7oDc+nQQH3iuidcR4or80F+2xUynzFIw/oEaYe4AEeutjIn68LvVHFlP8JvscW8X0pUUZauUM+eXQWmF3aqGMyjZ2q8eoYbcl3r1o8FMPTMbjSPOi9rWK8vnhsMtyf3hl/p6BSFT25qb+/7ZEH9AhTD/AAD13Er2GOGvKge+xvCh4WhhJlpJU76pOH1sIXGaOOVaNxYrS2eFQ12gzj9cVjSYlj6CmOJmyfzekyycNtyvdzHnlAjzD1AA/wMC3/XMnWOS3EsTTj99Gc/zHe9qFPHkbBC3IMz6nRluVh22jTjFfMnu7jmkfZ+W80wvpumY6k/LbAoMwLHnlAjzD1AA/w0EW870RJHjRw9S2ZfpTy24UcPvG2SZ88SgUvYDMd2DF4I43I+gfefINLk83iITmQ4c3g4dJkMxAbr28eOricsm0KPMADPMCjiXhck7KtK3QelcLzqQZbt9mmGF7a91bkUfaJjIa10/D2h1N+Gzcoc4FHHtAjTD3AAzx0UbVHiKYr0bSlwym/9STKSCu32yePyvFwgdpR5p0DhZiiYe3LSub5vvJ9iUce0CNMPcADPEzLL/MumdY+pulKoxm/512L8bbFPnmUjofbArgSIHLH4I1pLffaeaTFM82IP0rTUNYb5E8jp3cW7DOk8Xs8xJ1G3p30xMOVHvSE/qSIAkpcfVrPibnrSo9UHll8MuL1OuORFXM3oHpaqx5ZMXcz4uS2vB5ZMXcTcXJpVP9qvn6OG/CgMTIDBfusVcpIIi53KX/3wgMt3OYDVQ6d7moatv4bjYuW8npJ4yKNpwVs9MjDhR70FEpLbR4V+l1jLvQowyMUPUKpp9AjfD3ieetk+joLZtB19h0Nk6O8NifKSCt3nU8eedGCuoVllF0e0iIF6lt/WabzMjU4nedtuQtxl1zK0ToPvlj2FuxDT3HvKpUrD3s1LkB1VSzKu9cTDxd69CvmqXteXOhRhkcoeoRST6FH+HrQ1KJhNqZtBTxoX5qO9LrG/xWHFxwW6dOX4nKpe3yBLx55LdxPK6xdPMs0lYUxTGGLB/Wr0xrGmxKVoYe30W+35vGosIayTR4EGg2d9f6AhqnTcPWbNLhQHgc0eVPM33i90Wc88rCtxxslz4ttPd4IpH680eT1FHqEr8eT/EnrMGe9F6bpRzQN6WON/4fyeCyRd1a5XWJ6/efaeaQZ7ioR9c2XWbs4z2jjhSBGuIwiWOPBeJq7Sab4Ke16Tv28bT7vU8ijovGW5aGC9tuQ0aXzvNCLbjHOeegGko7LHBMzo2zUzcO2HpMlz4ttPSYDqR+TTV5PoUf4eqjRtY5ltIYf0vwfeziPuZznaMGDymE22B4fPGYZ7q6+T4ZlWplheDsqBC+4YrSUN5VRlIcNHmJm3/wa/hzg7sBxTrvFdL/8mmQGfX19wzKtzDDerDWUrfPIuPDuFuXjN94tzN/B0JSCOGakGkeybh629Sh7XmzrEUr9aPZ6Cj3C10ONH/2WKB+X9y3O4wznWYTHuav3oA8enYaGt1OYBy8wMlpTHqI4aEDS9I5kdBsQ5mXxyDDe5BrKznkkMMZ8dFeymuR9Vwm98FtZpkvH02g9elfT64mHLT2qnhdbeoRSP1qlnkKPsPWgViMFRyBPoDm+pxTP0GnAPM3HLOI87tVsicblzud7c608OhqNhm73cC9nvkIRf7+YHsVGJ00N1USm1F/GZC3ziMeqNxJ/J3H1d51pQbJ165yHOt0iZ4pKjDhqx1p+0orX+TzLT540hYBGNWYuQp42zaSgXCrzeyJ6rzNmi0ceH4d6aJ8Xx3po81D1yZqyU4ceaj091OG+nm7RuGU54KGth8ova6qMTT0S027S+1Lt89DWg/ilTb9kUHfuL8T0EolxtJ0hLjceeLSUea1lnvMVc/+JSFntiu7jGuXStXrUJQ+Vj7bh5hheEk6MtiwPfupQK0AROkzm4aYYrzUehoZbGSUMt3Y+DnlpnxfH/7Y2D0PDdcbD0HArw5LhOtPD0HArw5LhOtOjwHBj0H10j0iP9JMGmuP6lHJfFYaGq5YrlHys81D5GC98wUa6MsXwajFaXR46AljCFR58opzxyDOfdoQtPXw+UNhExuITxqhq3FsaYehhi0dV49Yxwzpgi4fDBwi6T9I7ZRr9THPb6f1vd6KlPcktUprfes5iubXxKL3SVMLwRF1GW2B4wsDg7uHPN1uMB2AHoZwX8ED9aCc9yMB2i+l57r7ghEflpR09Gm3Rk0oRulqcR1AtySZEV52a5LS0u0LXA/UDKNKj5uVyg0XTr6VcdCKVPnx68a3OszqRsrvxcHvdrjylq84JD6AyQjkv4IH6AT1guE0PmsD8K5EdjmmC92kXHgDqB+op9GhpPUJrWbeT4dLw7uvAA0D9QD2FHu2hh8Yo5VrN33haEAAAAAA0A0Iz3DntLmjVLoeq0yhsTedwhVDn4UIPAIDxuby3u0CnBSFXUArgf1khshefaEceAAAAQEAo3cJlk6WFHnr5b5oOQwtfjHgwuKs8RDQthxacaCkevlaaaueWdzPp4WClqVnQ6Y1p4ZWmSvFo4ZWmSvHQAIUFpPB+eQtO0FKMHzv+d5zwMDbcpNGK6QWt6e/TdRlvEY8ajTcUHgAAAM2K5H10lp/z52oRLb1oayU/KveyiJZodM5Du0uZu45PsYn0srHQKhw3cNrN22LjPeWiq9mUh4giOVjnIVsUK2TyzkMBLaK9RUQxGd+V6U+c3uVtW8T0Qtu2QE9+D4iZwap98IAeYeoBHuBRBFow46ByH6WgAYdEFK/3Tm4UzuHvG/i3i3wvPcXHdlUot4fNthYehS3cjJbkczLtk61YNVxTv9x3n4gi5Dxiu8Wbx0PMDBvVz9tm8LDV0iSjDYGHAgp4/JhM20R6SKllnNbzE9lemQ6IagGs5/IFSP/Xg9yt4oMH9AhTD/AAD12Tf5XvjZc4370iPVTgKKfjIgoWsI150zV3m0z3CY0IZIly427h2nh0lmlJSvPsT5jtFdA2+o1beLtstHiLeGSIEsePnMWjbEuzoEVbG48EFnI+e4R+/MY9fMzCimXSQ8f9/ADhgwf0CFMP8AAPXaM/wffDOKb0U0I/Lu9TfMwE53GC89Qt9yLfv2vl0WnDaDOMd6CK8drgwccMVDG8PKPt6+szCdycyoPy5lazKagr5B2Zlpc4djkf22N43AKlzMdlOuOJB/QIUw/wAA9dPMv50PKPd/G1Y4ozfOw45/WsZrk0AOpRHzzSWrinle5S6hq73cDgsoz3dpk+5M2x4RXBGg/F8KzwIKOVqW4eKrq4C2RRym8/1uzuWcR5dBmUeYyPoy6Vw554QI8w9QAP8NAFdVE/LKJg7dQFO5ayzy81W6xjnMcU57lMo9wDbI618ygaNEWDP96TLc3tMnWbqkrH0LGUh0yLK1SQSjy4K8QaD9ki3S6TTx5P5DyZ0o1/ZUblSXtSfUKzTHpHEQdl/qlHHtAjTD3AAzx08XP+3J/TonyYGyKLNFuY+xN5Z5VLI5L3+eKRZ7jxKFsyCXo/9amu4SlG+ykf2y2mu2JNUZqHYnBOeJDxCv13H7Z40LFbC/ahFtc3RbTeaRG2avwPMX8CzUM76YkH9AhTD/AAD11Qd+5qvv/t02gJ/06mtRr5xoNWV4vpObNp5dL/dMEXj0zDVQY/pRnejjTDKzDaeJCTEYp4ZJzsPIOLBzkZgd/XpvKgf70uHhLrhN7wfBoUcK+I3hnngfLaXLDPRqXMVzzygB5h6gEe4KGLjfz5utAbVUz5n+B7bBHflxJlpJU75JNHZ4HZpY06JtPYqRqvjtGWfPeqxUMxPB2DK82D3tsqxuuLxybD/emd8XcKKlXRk5v6+9seeUCPMPUAD/DQRfwa5qghD7rH/qbgYWEoUUZauaM+eWgtfJEx6lg1GidGa4tHVaPNMF5fPJaUOIae4mjC9tmcLpM83KZ8P+eRB/QIUw/wAA/T8s+VbJ3TQhxLM34fzfkf420f+uRhFLwgx/CcGm1ZHraNNs14xezpPq55lJ3/RiOs75bpSMpvCwzKvOCRB/QIUw/wAA9dxPtOlORBA1ffkulHKb9dyOETb5v0yaNU8AI204EdgzfSiKx/4M03uDTZLB6SAxneDB4uTTYDsfH65qGDyynbpsADPMADPJqIxzUp27pC51EpPJ9qsHWbbYrhpX1vRR5ln8hoWDsNb3845bdxgzIXeOQBPcLUAzzAQxdVe4RouhJNWzqc8ltPooy0crt98qgcDxeoHWXeOVCIKRrWvqxknu8r35d45AE9wtQDPMDDtPwy75Jp7WOarjSa8XvetRhvW+yTR+l4uC2AKwEidwzemNZyr51HWjzTjPijNA1lvUH+NHJ6Z8E+Qxq/x0PcaeTdSU88XOlBT+hPiiigxNWn9ZyYu670SOWRxScjXq8zHlkxdwOqp7XqkRVzNyNObsvrkRVzNxEnl0b1r+br57gBDxojM1Cwz1qljCTicpfydy880MJtPlDl0OmupmHrv9G4aCmvlzQu0nhawEaPPFzoQU+htNTmUaHfNfZ/ONCjDI9Q9AilnkKP8PWI562T6essmEHX2Xc0TI7y2pwoI63cdT55dGY4eEday68qDJdldMGD+tZflum8TA1O53lbTx6PrKf7GnmoF9o/45Zx1qR0eop7V6lcedircQGqq2Id98jDhR79innqnpd/dKBHGR6h6BFKPYUe4etxlsv+Zxr8aV+ajvS6xv8VhxccFunTl87yb9Q9vsAXj47//YUbSrsGdb1KQ2zw944Co6W1Z68uA6bub8lU436LLB7Ur/6WyJ6wTJVo5dfFzg9C4CHTB/++q0+nvJ1i5uonD4koGLLOgtujXNaVxcqTXZSJLkwaefeASB8kYJXH1UfxH6TysK1HfMFpnxdHehjx+P7U4Ach6PHHB/pc8cisH8ku20Md4dSP5b/sqF2PRJdtZteuDz2Ofe2GsvfT50UU0UcnkAK9Wz7NnO9kfWJ/Su73Lpvuf6iLh+qXaS3cLjFzWHPyb6MWbcoKVNTvv0rjcGs8GE9z5Zjip7TrOfXztvm8T7PxGEg8qT6vedFSd9AGoR9IekpMR8TxycO2HpMlz4ttPSYDqR+TTV5PoUdz6pHEQ5r/I7WkjzHnwyJ7IFP8oLKezdYLjzkpYhzj7/fx56v8uYGF/Ccy/TeNruMZLVo2WloQY1izclTmIaYXoBD8VCO4gu1V9qGuQZpbtkfZp9l4xO8VdmhefBTV4i+E+TuYVuURynkBD9SPdtbDdD4vRSv6P9nsSJvHNY75v3zy6EwRg0ZYUR/+Qs5gKW87xvv8N26h6gYvuNKilUa70tBsS/MQM9cyVrcR0lZKibfNa2IeySfVrKfTfuY7VvKibTUeoZwX8ED9gB56iAPHnBLR/GDylXs1W6JeeXSmkKDJuveIaCmvD/n7BYXMXC7gJxytJzbbqkZbmkfiySzJI4kLGtualQddNP+bmPmynr6/zu8hbuYn0EsVLtpW4xHKeQEP1A/oMd2d/T+LmWsV03caxEXvlz/i++tcNvdvC72IP9550KCpNBLvJ/ajxdrfFNHoriFuhtPJ35nSDWHSdRybdZYYlXnwUwehocPl62Ln10Lg8e+7+qrwKIWMQVNddfNI8qmJR0Nzv6+FwOP7U4NB8PjjA/XX04xBU0HUj+W/7Khdj4xBU0HocexrN9i+n8agOa5PKffVWUgMmuryxUPlQ+9wk2tBpq2VeTkjjwGFiLHRJmCVh44ArcojY0EE4UGPIHjk6WE4Arol9MhYqOIKSkx/K81jSyMMPfJ4GI6ArsQjaZy+9MjjYTgC2ub99Cx3adMqTzS/9Vwz8uhkB7+PHX0Bd4/equxzK2+b9RTEKzKtKtF1nIbSPBirOK3UNLl7OAXJQ7ZgqvKwhXbl4ap+gAfqB/TQ59HB6Zt8X90tyi1PGQSPOQkyr3KTm5rVd/NTQW6XQ0WTzRLFmEeJlmRXi/MQvs+L5ZZ23Xp01alHTku7q1X1CKWeQo8w9XCwxK738zIngwxhQmlCixoqR2keeSdG6cOnofTq6icnUnYfr8JDs6vOOY9QzkuT8QjlvIAH6gf0aNH72JwMMkIpNPm3qFEUmzxoAvOvRHY4pgnep114hHJeUD/AA/UDejjRI2W1KWMeNlvaczJOTt7fdVYSmzyoq+C6vB2+nr5eeO08atIjlPPSNPUjFB7fnxoMgscfH+hD/VCw/Jcd0EPBsa/d4F2PnGWDtXnYWs+fjLuj0WgIAAAAAGg1uAjCU8Vwmz4ebolh+zNQdWpC1ShCee99Q0CJaTPW4GDQFfQAgDYxvprjmmuhcjxcaXgrKAXwv6zgBB4AAABAcCjdwmWTpWULe/lvmg7TL1uMIx4M7ioPEU3LoQUnWopHHS2rZmpBQY+ZsByvORU6vTFVe5x0oNMrFQqPEgtFGENnwYxQeGjgJpk2iSjwAS2JGy+rqC44cVRESzK6hBMexoabNFoxvaA1/X26LuMt4lGj8YbCAwAAoFmRvI/O8nP+XC2iSERVV/JTy6UVpt6ug4d2lzJ3HZ9iE+llY6HVNm7gtJu3xcZ7ykVXsykPEa0eYp2HbFGskMk7DwUUf3KLiNYLpSDLf+L0Lm/bIrKDRZcFPfk9wE+DPnlAjzD1AA/wKAItmHFQuY/S4v+HRBQm705uFM7h7xv4t4t8Lz3Fx3ZVKLeHzbYWHoUt3JSWpOBm9CrZilVDRfXLfSnwLq3Ysdh2izePh5gZsoqeNmbxsNXSJKMNgYcCilTxmEzbRHpUomWc1vMTGcWuPCCqDcefyxcgxTx+kP9/HzygR5h6gAd46Jr8q3xvvMT57hUzwwDGGOV0XETBArYxb7rmKOjAfUIvYpBabtwtXBuPTsOW5Bn+mZ7g35O/75CpmxOFKXqPzUXwvpVbvDo8RLSwdLeYjj+byaNsSzOjRVs7jwQWcj57Mi6WtBbYHj5mYcUy6aHjfn6A8MEDeoSpB3iAh67Rn+D74QQ3WJ7KMLkkJnnfVXxsL+c116Dci9wLWSuPTpMuW9lKvYszH2HxaaWIT0VKHFzet3RXsy0eMt1VpYs3r+u4r6+vMg/Km1vNpqCukHdkWl7i2OV8bI/hcQuUMh/nhwgfPKBHmHqAB3jo4lnOZ5zvjWdK5HGGjx3nvJ7VLJcGQD3qg0daC/e00l1KXWO3S4OjLuErji8/6Qn+OyJaaUQoLTrB277D+9C+k3Qs5SGiIL9CMbwiVOYhpl9kT3I3rhUe0mj7ZYqfgOrioaKLu0AW5ezzl5yysIjz6DIo8xgfR10qhz3xgB5h6gEe4KEL6qJ+WKYp7oIdy9n3bzhlYYzzmOI8l2mUe4DNsXYeRYOmsrqOqQW3lvcZEdPvI2nbpwVdzWVQiofI7+ItzUO2SHfI1E2J862bxxMFT6Zk5i9x+rDgSfUJzTLpHcW3+PtPPfKAHmHqAR7goYuf8+f+ghYl3SM3c1pc0MLcn8g7q1wakbzPF488w427Pou6jldSEsVdq3FXrCm0eIgo/mw78KBjtxbsczzjexq2iuL3N/GDAoHmoZ30xAN6hKkHeICHLqg7dzXf//YV7Ls+43sa9nGeq8X0nNm0cqnX8YIvHpmGy13B9M5xl2I0qV3HvH9W16r67rXftHbo8BAz50AV8hDCnAd1I4fAQ2KdKB6eP6p8P1uw73x+csvDRqXMVzzygB5h6gEe4KGLjfz5uigeVbwsYZh5uMgtcrWMtHKHfPLoLDA7egc7wOagIqvrWO1ajXGD+u61DIp4iNldtqk82OBK86D3tjL55rFJY59zyvcPNPZfa/D72x55QI8w9QAP8NBF/BrmqMa+S5Tvt2rsP5QoI63cUZ88tFaaIsNTlkqj1tkjYrqr9AmlBSfYSJ6Lu9yqGK1NHlWMNs14laX06uaxJGXbh9z1c5YvEPUieV9Ek7Vv5acz6hJZnPMEl4bbUi5GHzygR5h6gAd4mJZ/LuW3xZz/Ui7v1sQ19y5zO8t8P8xomS/JKfdDnzzy5uFup5Zriullda3mdh0rrWAjVOEh0rts1fdv2pAGu50HSSVRKw8xe/4bLbRwi0xPyvQin2x1UvoUb3uR97mFj1GxwKDMCx55QI8w9QAP8NBFvO9EYjsFs/9PMj0j0w/ZxNX5rF287Ye8z3/iY0TKtbggp9xJnzzyWrg0uGerNDsadXUg2dKUHwP82z/EXaVprVk2S2oBln3Jn8tDbqcu3hk8MlqRVnhI053Fg8uri0cScy0cMwUe4AEe4OGRxyULx3SFziPPcCdTuklFiuGpJpyGTxPdq6YmU8gjYWytzmMiccwvmM9r3MVxjrs7Likn/zbu3qAuku+ldAmNG5S5gPf3wQN6hKkHeICHLqj118MtbfUe+RNusHyPy1nCXblzFVN/n/mdZb7JrtyeRAszrdxu/u6FR57h3sCtsEfUE8Tdws9lGazSolVbdPF7zH1KC1AXuTxyjK0WHkLUzuOcmP1uYLGYOdT/TjH9HiF+51CUZx7eV8pcwheYDx7QI0w9wAM8TMrvYQ7J4z4UM6foULnLlGvuzoK8897LxuUuZiP0wiPTcNlQKSDBPn4C2sE/pXbx5nQd03vMfbFBm8apLOLBTyMHUgxO5UE3xHtl+nuZ/gdv68jikxbnkleW6h8cHHTCIy2eaUb8UZqGsl7jhOcNIEhiSOP3eIg7jbw76YmHKz3ovND7qRH1aT0n5q4rPVJ5ZPHJiNfrjEdWzN2A6mmtemTdyzLi5La8HlkxdxNxcmlU/2q+form+J5TjE7H1NcqZSQRl7uUv3vhURieT5mSk9a1+mmiq1Rd1CE+vt/GSOUKPEig2/nJ5H9U5aFMDfLF47goHum8LON7GiivlzQu0niu2kaPPFzoEZ+XowZdYy70KMMjFD1CqafQI3w94nnr60Xx67TRjO9ZPYmbE2WklbvOJ4+8UcpZJNQF+LtTukrjkbkmeQqHPPqVmyN1Ibws03mZGpzO87bchbgzRijXzoPz3Fuwj8nKKHs1LkB1VSx6Quz1xMOFHmXOiws9QqkfzVxPoUf4etB7z2G+P27TeDhI+56GOLzgsEhfrCMud42Ixl144ZHXwv00bUqOEpAgngoT4+qUoGSLNrEwhilK8RDTi0u8oXSN0BrGmxKVoYe30W95k5o/zZgaFAckqIsHYX/Bk1a89ucWkb/2J+VxQPM80DvneL3RZzzysK1H2fNiW49Q6kez11PoEb4eT/LnEwUt+XhN50Mif01nyuOxRN5Z5XaJ6UGvtfNIM9xVYnoN4KfZ8HYUdfFmdR0rRptcc7gIWjzE9JQc9QksbbQw5UHLkE3xPtdz6udt83mfQh4UvMADDxW034aCLh2KbPGLnN/HOQ/dYfBxmWNiZpSNunnY1qPsebGtRyj1o9nrKfQIXw81utaxgt4Bilj0k5zfeziPuZznaMGDymE22B4fPDpTjHQ4IxiBdrdwYp+0YAfDRXnY4JHo4l3DnwPc+hzntFsxyjXJDPr6+oZlyuQhRD08Mi68u0X5+I13C/N3MDSlII4ZqcaRrJuHbT3KnhfbeoRSP5q9nkKP8PVQ40e/JcrH5X2L8zjDeRbhce7qPeiDR6eB4eV28eZ0HRsZrSmPDMNT1zJOmt6RlP3jbfOyeKQY71UeXFYtPBIYYz66azPH3d+rRH7sxyLTpeOp+5ze1fR64mFLj6rnxZYeodSPVqmn0CNsPaiFTjM2yBMotu4ppXGm04B5mo9ZxHncq9nqj8udz/fmWnnojFJOa2nO6uLN6joua7QmPISY0dWc5JHEBc1tusbrhUeiAtFT5c0yPSqi6Bfqy/qzvO1R3md3xe6ouEwaeEHz0RZzZfPBw4YeNs6LDT1CqR+tVE+hR9h60OCrb7NBz+V75kfc+qTRxGpknqW87SDvs52POcJ5XDT4n+NyKb75pjp5dDQaDaOzI421l01kRcYuZEL9NkzWBg8xHTJP9x/t2GIgyeDgoDMe6vzGnDmh1pA2r7OOck34OOSlfV4c/9vaPFR9subI1sFDraeHOtzXC53r0wGPUvePrLmpNpGY55oKBzy09SB+OwZvLNqP7qN7RHqknzTQHNenhMj2mV19n+iWK5R8rPNQ+cwpUdkp45UphleL0ery0BHAEq7w4BPljEee+bQjbOnh84HCJjIWnzBGVePe0ghDD1s8qhq3jhnWAVs8HD5A0H2S3inT6Gea207vf7uV1iW1tOPZHjS/9ZzFcmvjMadChVYNT9RltAWGJwwM7h7+fLPFeAB2EMp5AQ/Uj3bSgwxst5ie5+4LTnjMqZqBR6MtelIpQleL8wiqJdmE6KpTk5yWdlfoeqB+AEV6UHcqYMFwfaOo60jpEqIh6+o8qxMpuxsPt9ftylO66pzwACojlPMCHqgf0AOG2/R4SESBghdm/D7B+7QLDwD1A/UUerS0HqG1rNvJcCmyxnW2My0xyMQJDyDM+gEeqB/Qwx80RinXav7G04KKMHq448oo3WUPN0Z8/nN18dAwXHXU8izYGl0KAAAAhG241lq4bHA0LaaX/6bBQ/11G28oPNhor/IQ0WCq/izjDRWhzsOFHgAA4ysyuNDQWTUDMjiZTsmvp8V0mLJJ/n6afotbm66NNgQebLSZPPi3FbgEAQAA2gulW7jJliSbCoUs28d/b5XpEcXwnLQ0Q+GR0qLN5WHa4vW10lQ7t7ybSQ8HK03Ngs7rjxZeaaoUjxZeaaoUDw3Eyy3mLThxVKaPHf87TngYG26ewUnB1cWt++W+FKaIJkIvVozGypkPhUeB0c7gIaKwTa54AAAANCuS99FZfs6fq0W09KKtlfyo3MsiWqLROQ9twzUwONq3m1tzW4Ve1AXRbDxki0LXaAWX7YSHgvn8RLZWRPPj1Ccymg83xE9kFy2WSf/L97iyfeyRB/QIUw/wAI8i0IIZz/D9UXD+R7m8cTEdSGEp81rLPONXd3TPpWDvUyXLHeHyauFRaLgWDC7ef7tno7XCw4LRWuGhgCJVPCbTtgwzX8ZpPT+RUVSbA6Ja5BEqcwv/bw+yufjgAT3C1AM8wEPX5F/le+klznevSA8VOMrpuIiCBWxj3nTN3SbTfQYPA3G5cbdwbTx0Wrinle90I1klDW7MwOCuGKLcp6rBBMtDzI5RmcuDv9swXJp0fkzoB03u5ouGWmEbRDQ5vWyZt/H/fsYTD+gRph7gAR66Rn+Cy57g/M5oHjvJZvca8+/lvFZpPAjE5VKrdXfdPEzf4dKL5Pekae3npwBRZHCOuj+C4iGTFg+hF+RZF9St8ZaIYq+agirXOyKKimGy/NoCPo7K/DFXTB88oEeYeoAHeOjiWc5nnPMZK5EHXW938f+xnPP8sUa5S7klWjsPk2lBu9kwyEh2iii4uhpgfZL3uUEaXL9Dk2s6HiJ6qW6TRxd3gSyqkMcizqPLoMxjfBx1qRz2xAN6hKkHeICHLqiL+mERve+8r6TJxRjjPKY4z2Ua5R5gg62dh7bhknmxeexSjKbQ4Kib10I3bnA8+vr6CnlkGC3tU5XHEwbdQEVPqk9o7kst9zgo80898oAeYeoBHuChi5/z536h331b1MLcn8g7q1wakbzPFw+jhS/IxGQaYDOJUWRwcavPGkLhIU2XyprFo8Boq/KgfLYqfw9zd0aHyJ9iFP9+l5g5hF1n5LT6kECj9U564gE9wtQDPMBDF9Sdu5rvj/uU7fT+k7qpG5yyEP/+jpg5dSd+ZbdaTI+wTiuXRh1f8MWj1EpTqqlpGFy3sNudGhyPRL5FRluVxzoRjaqLcb/h09kZPiYG5bW54JiNSpmveOQBPcLUAzzAQxcb+fN1MXM078uGre7lfEwMyuulRBlp5Q755KFtuGRePAo46/csg9udaAFWQig8BgcHt8vUrdEKss1jU+LvicQTV9ETmXpMjLUFZaq/v+2RB/QIUw/wAA9dxK9hjia2L0y0pIta2uoxImGm38opd9QnD5NRymQaWxMjg7Wm4vB+trwuKB5i5gjl2GhdjlRe4qKzoOD325Tv5zzygB5h6gEe4GFa/jkHPEZz/sd424c+eZgYrjoiV31R/qmodypOU/IQ9rqzFzr4XxYYlHnBIw/oEaYe4AEepvtOOOBxIYfPAuWe7I2HieHeIKYX4O9OtOhyDS6vC7gEmopHhtG6Wt6xLKbAAzzAAzyanEdX6DxMpgVNJqbkxNCZivOptb6LQHjQCOXE1KAZPETxSOWycPFENm5Q5gKPPKBHmHqAB3iYtv5ctLR7EmWkldvtk4fxKGVlSk78d7/mCGGrCIUHm+qA8rfOlKAqPFy8cyjK833l+xKPPKBHmHqAB3iY7uviXXLetRhvW+yTh0m0oO6i96EugwZU5EFPYP9Gpv8g03/lffLMvJAHjVDmebh5KOSRF8c0I/4oTUNZn3iaonzjfyiLfEfKE1iMoYL/g36Ph7jTyLuTnni40oOecmmqw4j6tJ4Tc9eVHqk8svhkxOt1xiOrrgZUT2vVIyvmbkac3JbXI+uemrif0qj+1Xz9HE+0knuU8rNu0I2clvVapYwk4nKX8ncvPExauJ9mTckpmorDXcC2YMrjXZluEdEyZP/VJg+aGpTRWk1r0dricTzRgn7esFtkIR+jttBf0rhI47lqGz3ycKHHP5fpKxFNDxg3uGnZ1qMMj1D0CKWeQo/w9Yjnra9P3DsfEmbd3RN8jHrP3ZwoI63cdT55mBhuN5sHGd4OxeRyjdbBKGFTHrQg9SXlaY4mKZ8X0/PKzvO2nrI8ZNqhbHfNg/Lbm3ia+kzoz6P7TMycN5cVhipZ5m7+Tk+IvZ54uNBjlUz/aHheXOhRhkcoeoRST6FH+HrQymzDfG/clmitXyf0579el2jhx+EFh8V07Nq0cteIaNyFFx5VghfE8B00IJeH/Pz/+HfqV6fIPpsSlaGHt9Fvt7rgIaL3ujZ50NzfUQtaUh4HNPel1wLxijTPeORhW483Sp4X23q8EUj9eKPJ6yn0CF+PJ/mTplMus6AH5fFYIu+scrvE9DTO2nlUCV6QfNr3FbxAiwcbIS1DNsUGeD2nft42XxiscZwSvGAWD5E+gMoGD9pvQ8UurnHOQzeQdFzmmJgZZaNuHrb1mCx5XmzrMRlI/Zhs8noKPcLXQ42udaxE76JIGDzlMZfzHC14UDnMBtvjg0fdwQtGLJmuNg8Fa/hzgA1xXEwHIR5I7KNruibBC2zziOM3lolycUaUi2VJ7yvu4uOTcSTr5GFbj7LnxbYeodSPZq+n0CN8PR4XM+NHl4letJyP7eG8Htc4hvahrt6DPnjUFbyAjHaV3HelsAhNHjHiF+NHUrKKt80rSUUneIELHtS6WiX04+1O8r6rRPnYjxN8PLXs6V1NrycetvSoel5s6RFK/WiVego9wtaDWuj3iuhdJ8XWPSX0p0zG42dO8bHDnJdOqz8udz7fl2vl4Tp4wVWjlWnYRg0pwSOJC5rbclEieIETHnxy6anyZpkeFVH0C/Vl/Vne9ijvs7tid1RcJg28uFNE89oWeeJhQw8b58WGHqHUj1aqp9AjbD1opP+32aDn8v3yI2590mhiNbzdUt52kPfZzscc4TwuGvzPcbk3ieh9c208dObhkmmuEGZBA+iYflsmW5FHEg2bPIRe8AIXPNIq0XOc6sLFlCdcHzxs6tEIRI9GC+gRSj2FHuHqQe97aVrNizLtEdG89kc45YHmuD4lZsbmLVNuL6fhOnh0NBrFekkz62WDWaF0LXSnfHdhtJV4KJOxdStGR9HCF7Jla8QjcTK0eWQsKFArchZ/cI6MhR1c/X/a58UxJW0eLvRRFrdoqnrqCsriFtp6bGm0rByi7P10x+CNukXQ6Gea276G76NLlZY23VtplDTNby1c3WpX3ycm5TrjofLRWmmKDXRliuHFLTqnRuuIxz38+aYpD3mDucIjxXhn8NB86inNA3CKUM4LeKB+tJMeZGC7xfQ8d19wwsMkWlCa4Yk6jNYRj8qRJch4pemu5C6JqzwMuzm6Qr6K6mhlBoquOjXJ6UkIPgIK6gdQpAe17gBDw00anm/yhjziNTJjnMjYpwxC4QGURyjnBTxQP6AHDLfpQS/EfyWy1w1Nromp28rV2k95N+aEBxBm/QAP1A/o4Q+htazbyXDjNTLBA0D9QD2FHtCjdmiNUgYAAAAAAC3ctoPtqTo6g4DqmB5UdjAS9JiJvBjLZVB22s8hyxOoyk63CYVHXgzuMtCJ2x0yjwpTdlKh031su0xTHp0CaCfQSMKNAZTpgwf0CFMP8ACPtrluYbjtZbYvi3qnM6SV6YMH9AhTD/AAj7a6bmG47YFrZPobmb4nLEVsKlmmDx7QI0w9wAM82u66xTvciqj6vqyGZfGu4Scx6vp4X9iNNmJSpg8e0CNMPcADPNryukULtz1atvF7hqGay6Q1Rx/yxAN6hKkHeIBH2163Vlu4o4c74ig6BFpq0Uv3Qyg8xHRUoSs8au6OiSvHJmXbcI1lUiWlcFWjHnhAjzD1AA/waOvr1orhKgbXq2w+LbcP12l4ofBQjHYGDz5BdRgvVZi/TlQOint5sqYyvxRRIOZRDzygR5h6gAd4tP11W8lwUwyOngbieIqP8HbnhhcKjxSjTeXh2HipwtCSa5sT24eFmwDWyTK/5CfCMx54QI8w9QAP8MB1K0q+wyWDk+kUm0cvGwuFMbpBmhkZGpnJDTLt4t9iwztl22hD4MFGm8qDjTWVBx/josL8MOW3YceV9IdcAe9VKmmdPKBHmHqAB3jgui3Tws1pSe6T5jaZcshU4u9exy3aWnkMDg5m8uDvtfBQ8HxG5SC87qiiPq9U0m9zq/1XHnhAjzD1AA/wwHVrYrgmBif3pQDs1H26VUTB2OP9u+s0Wpc8DI3WGY8EqHI8kPEbRe5430EljcuMnwhHPPGAHmHqAR7ggetWQWGXckGX7aRqcDJtl18/ZTPqFjO7VquabRA8pNmm8hBRt/Fkwmid8Uh5Onsg5/eFvM9CB2VSJf0Od7H44AE9wtQDPMAD162p4YrZ3Z6Xki3JPINLGmIFNAUPDaPtF+ndzVUqzI809qN9/qNMT4jqy6LFZdL/vkFEo/V88IAeYeoBHuCB67ak4caIu0HJRD6V5rajJoNrCh4y7ajZaAm/1Kwc6sPAMzL9vUzrKpYZV9I3PPGAHmHqAR7ggevWguHewOYRG81OXYPj96m20FQ8MozWFo/XZPqwxHGLZVpfscy5IpqXttATD+gRph7gAR64bqsaLplXYppNjFyDU1qfVhAKj76+vkmZMnnkGK1NHrS02L+Q6UnD1vMRmX5socyN3K1yq0zfrJkH9AhTD/AAD1y3Flq4quENKH8XGVzc6qORX6ssG693HnxiBpS/i4zWNg+aarRfpj/nE1+EF0S0LqitMl/hbpXfyXSuZh7QI0w9wAM8cN2mQHseLplX0bvQjKk4ZCxkhlYmLJfkMS7T95nLf+d98sy8kMfg4GA3tXILdivkkRdtyDCS0ASf+HUie/QcVY4HLV4kapnUrULLn/2ZBx5W9Vj/6/yMj/+gHj0q8LCqR1FErCaop1Z5HOrIz3hLQ7SVHnn3Ut37abvcx0wWvqABSjTP9DnNOa9WjbYCj5foniDTn2zzkDeiKzyE3txbVzxU3FZQOR5yXCZ101z2xAN6hKkHeIAHrluGTpfyKjbPGSODFZNL7SqVZrjSstmW4iHTXyom1yOiWIbnZWpwOs/besryENEI5Rh18UhD1ki5F7lyXHZQUdUyhz3ysKGHjfNiQ49Q6kcr1VPoAT2838cKDZdMk8wzYTQ7lV1cG60tHktkek9EI9J6EpVmE/92axGPvr6+YZm0eci0Usxcd9MKjwz0ZlSOBx1etGqZQx55VNXD1nmpqkco9aPV6in0gB7e72Mmo5SThhfDqdFa5EFGOF9EL8ppYNP1nPp523wxHbu2ECnGO4NHitE64aFgbkoFOeq4kqpl0lJnY5542NDDxnmxoUco9aOV6in0gB5B3MeMw/Oxma0cPdzRq/xdO0rwWMOfNKJ4r7J9Nwu4R9nHBMNsrr2J7oi6eazmSqJWjr90fNGqZY545GFDDxvnxYYeodSPVqqn0AN6BHEf6yx7ILc0vZhtSR7x4KW0od7xtnkVqAwLvZBNrnisUL6/UtNFq5b5ukceNvSwcV5s6BFK/Wilego9oEcQ97E5ov1wQXObFnSnRKRMrbDKQ0y/4KfKcX9NF61a5pBHHjb1qHJebOoRSv1ohXoKPaBHEPexdjTcRgvyWCSiIeyv1fiEnFamDx629WgEokejyfUIpZ5CD+gRzH2sUwCtgBVcOehJbMpjmT54QI8w9QAP8MB1C8O9ins4tQKPyx4ulrQyLwdw0driYXpeXOkRSv1o1noKPaBHMPexduxSjtHVQjyOeuB9NBAervToCkSPribVQ6B+QA/cx2aio9EI5ZWmGyjrfNIKKEWrn9Bax9cbrv2pBWXQlDYPwzVqgRJQ1ivWPi+Gaxg3FQ/U05lQ1k3W1mNLC99SQ7mfNivaqUuZluKayPk9XsC6XXgAqB+op9ADetSIdupSpuHe14EHgPqBego9oIcPtHyXMgAAAAAE1cItinnpAmnvfsAjHPzLfzfqtfy//bfLoEfAegBAM2DH4I1ey9/V98nV75iHCwAAAAB1tnANcJOIwi/RwtS0nuZS3n5WRIHY3xDRsOqPHXNvKx51tK6aqQUFPWaijh4ZnR4YZVSvM+iMAg6FhzKq1xl0RgGHwqOO1qbaomxmw6XVNyjcUm+W3vxJURYoUgRFXaBQTbYDHIAHAAAA0HTQ6VKmCc0HZTrN5nKRHiBl2iDTnWzac/j7Bv7tIhvSKT7WxqRo8JgGzX97WURz4Rol03nOo8ewzG955gE9wtQDPMAD120BjyLDpSDCv5XpEZkuiSju4c0y/USm49RTIaJlsC7z9+P828287yU+9recV1mAxzSWyPSeiLqxq1b2TZzXrQZlfuCRB/QIUw/wAA9ctxo88gyXgu+e4FYcTWJeJdNTInovWYRJ3ncVH9vLec0t8Y+Ax0w8XfGhIe0h4mmDMic98oAeYeoBHuBRlge9YrtLpo6S6S7Oo+p1WwuPPMN9VqblIlqeizI7U0LUM3zsOOf1bIk8wGMm1gj7WFPidx88oEeYeoAHeJQ95v6S91L1nnq/heu2Fh5ZhksDfh4WUbSE+2QaS9nnl5ottDHOY4rzNBn6CR6z0e3ggplXokwfPKBHmHqAB3iU5TFhofwJC9dtLTyyDPfn/Lk/x/XJLGjg0CJN99+fyFsH4AEAAAC0BNIMl+aR0lQW6uPep9Hy+51MazXK2sd5rhbTc1XzAB4AAABASxvuRv58XUTTWYpAL4lpANCOgv0or5cSZeQBPAAAAICWNtx4fpJpEN6dMv1G5I+AG0qUkQfwAAAAAFracJfw57kS+a2T6V2R3UU6migjD+ABAAAAtLThLuDPsqO2aG3ht2T6UcpvFxJl5AE8AAAAgJY2XFu4JmVbl4f/ETwAAACAIA03bnUtLJknzTNdKdPhlN96EmXkATwAAACAljbc+F1lmfeKFIrum2L63WQSJu9DwQMAAABoGaSF53tbRHNDaarKcYO8dsk0ULDPWqWMIrjkQfldDRCZjCWaiPsZCg/AHWipzSdFFEJxPN5YR8xdHR5ZfBzG603lkRVztw3qaaoeWTF3deLktqIeWTF3deLktrPhviLTdpnWi2jZq6LF+Wk+6b8W0TzVPFBem5UyiuCKhylC4QG4AfUu3C305liDB+oH9IAepZHWpXxWRFEPyFy2FRxP+96paS7bOM9hPk5o5G2bR1rcw6I4hqHwANygX7l5+Dwv4IH6AT3a0HAFdxcQnhDZi+sf4SedjzXKoTweS+StA5s8suIe6sQxDIUHYB9vBHJewAP1A3q0qeHSyyIaVUvTVo5lPK08JKKA6kXo4Tzmcp4mL8Zs8ojjHk7xU9r1nPp5W14cw1B4ECYd1IMvC36fDISHCz0mS5yXyUB4iBbm0cz1A3ro62GjJdxj4T5WC4+8ebiPiyiqDWVCCzcsL0FgOR/bw3k9XiIPGzwIcYxCGsi0W0Qv+8f5+0Bin5B5nHT41GpSpg8eLvUwOS8nA+Eh2oBHM9YP6KGvx/Oi/JRLwcc+b+E+VguPPMOl1tq9Inp/SSHnTvETi048xW7e9xQfO8x5XSrxj1Tlkfx+JGW/eNu8JuChvkOxgYucp9Ass9sjD5d6mJwXl3qEUj+asZ5Cj+bTg2aufCam3wGbps84j6r3sVp4dGqc1G+zgNQlTKN1P5LpoIjWCVbXCF7K2w7yPtv5mCOcx8WKlassjyQuaG4LlccHMt0uotHTVYImT3Aet3OeumXe6pGHSz1MzotLPUKpH81YT6EH9Aj6PjZHIyPqj6f3ky/KtEdEkW0e4ZQHmr/6FLcIbaAsjyQaLcCDum7+QtSLtDJ98HCtRyMQPRpNpkco9RR6QI9g72NzDPYl46RRuDQ6jRaBWMPN8rhVR1Ni6AX0G+z0rlZPMuUhWoGHw0UOmhK29PCwuIUT2Fp8ImtxC12EsuiDLR5Zi1voIpRFH2zxyFrcQhe7+j5p6/vWnBLHkJHu5uQTVXncw59vtggPwC5COS/ggfoBPVrNcENZns02j5wn9q5m4NEKrcgmRVeduuS0tLtC1wP1AwhZj5Ba1XPaqEJQP7061+pExj7twgNA/UA9hR7Qo0Z0ttH/SgOd8kahTfA+7cIDQP1APYUe0AMtXCcYkuk68ABQP1BPoQf08IGORgOhkwAAAAAALVzAG3xPmQlt0Bb0AIDmw47BG72Wrw7a6sTpAAAAAAC0cIEaW1fN1IKCHjNRdcEKHehMlau6UIQOdBa1CIVH1YUidKCzqEUoPOpobYa8uAZauAAAAADgs4Xr6gnRdMm1UHi4akGUXGCD5r89I9MKUT6OI82RG5HpSaE3Xy4u84CI1sn2xQN6hKkHeIAHrtsCHmjhNh9o7eb3ZNokqgVN7uE8KK9bDcr8wCMP6BGmHuABHrhuNXjoGG7DUqoK8IhAMXjnWzTw+ZynbpmTHnlAjzD1AA/wKMuDgsDcJVNHyXQX51H1uq2FBwZNNR/WeMhzTSA8oEeYeoAHeJQ95n5RLQ7tGc7js4rXbS08TLuUd8l0g+Lqe5XfDinb/5z3vezIdNqZR3fB7z+W6ZJhnvNKlOmDB/QIUw/wAI+yPLJM7pcyzdXMa8LCdVsLDxPDpWDyAzKNaex7jvd93IHJgUc+Dsu0UpMXeIAHeIBHiDwelum0TItaiYeu4Y4kWm+6eI6PtQXw0ANNUv2miNY79QnwAA/wAI+yoInwv5Npbavw0DXcpyqU8VPLrUrw0MNFme4VUVe2T4AHeIAHeJQFDUKi0H87WoGHjuF2VGyVvc15VAV4lAN1ZX+HLyCfAA/wAA/wKIudMv1G2B1hXTsPzMNtD7wu050ynQUP8AAP8GhSHutkelempc3KA4bbPvhYprtlOgIe4AEe4NGkPG6S6S2ZftSMPGC47YfL4AEe4AEeTc7jmmbkgYUv2gc0rP1VEY24Aw/wAA/waEYeNF3pPhGNpG46Hmjhtgdo5ZPfBXCxgAd4gAd4lMUbIpquNNqsPNq2hZsXhWhLoz4eeVGISkYSSoKGse8MQPKQeVB0D4ryMSKUSB+OY+5q88jiYylerzaPrLraBvU0VY+se4il+0dT6NHR2XVVj//n+a+lZvC/PvTfbfCg6UkDAehRiQe6lFsXNGz9r0U0og48snnQKmA0GOQieATFA/UjYD2k0dalB5Xzr0U0UtonrPBoty5lCqH0skznxXTUnvO8raeFeNBw9XcDuGibgUe/cjP1eV7AA/WjKfRQzNa1HjQN6c4AzNYaj3Yy3Ky4h1XjOobGg4ap03D1mzzr3Sw83gjkvIAH6gf0mMYR7ln42LMeVnm0k+HGcQ+n+Kn1ek79vK1sXMe6eUwW5P+80I9uEePLgt8nA+HhQo/JEudlMhAeooV5NHP9aFk9ZOvWth5ZLeGHhH7Uoh4L97FaeFQ1XDUM0VzhDzo84hiF9MJ7t4he/I/z94HEPiHzOOlAvzcKfj8ZCA+Xepicl5OB8BBtwKMZ6wf00NeDDH5hBR4LOY+q97FaeJQ1XJqTtVmmHyrb6O/tMi2v0XxNeHQrXQRp3QZJwwyVh/pOyQYucp5Cs8xujzxc6mFyXlzqEUr9aMZ6Cj2aTw+KwENB2xsl02ecR9X7WC08yhguZf6pTH8jZgb07eIuhHdk+mMNZluWxwXNbaHy+ECm22V6RWQHTdbBBOdxO+epW+atHnm41MPkvLjUI5T60Yz1FHpAj6DvY2WmBdUZ6cYFj0YL8KCum7+oWe+0Mn3wcK1HIxA9Gk2mRyj1FHpAj2DvY5iH2ySwtMgB9EjA8eIWtcHS4hO5C7HooM5FY+rgcahi82LZw2EIYotH1uIWutjV90lb37fmtPqFk3PB3MOfb9ZxQ8u5kRnxAGpDKOcFPFA/oEerG24boAs80Kouc15c6JLT0kY9xf0DerRIq7qdDJf66dW5Vicy9mkXHgDqB+op9IAeNaKdFr6gCcx5o9AmeJ924QGgfqCeQg/ogRauEwzJdB14AKgfqKfQA3r4QEej0YAKAAAAAIAWLpCE7aksOoOA6pg+U3YwEvSYiapTe5IoO0L/kOUZ+2VnLITCY/SwXSJlp/qEwmPH4I1WeegMjrJdpimPdgvP1+6gkYQbAyjTBw/oEaYe4AEebXPdwnDby2xfFvUO308r0wcP6BGmHuABHm113cJw2wPXiGit5+/JNOKxTB88oEeYeoAHeLTddQvDbQ+zfZm7Pt6XacxTmT54QI8w9QAP8GjL6xaG2x4t2/g9w1DNZVJw54c88YAeYeoBHuDRttctDLf1zXaTsm24xjKpkn5bplEPPKBHmHqAB3i09XULw21ds/3rROW4JNPJmsr8UqZ7uZLWzQN6hKkHeIBH21+3MNzWNNtfybQ5sX2YK4nrMr/kJ8IzHnhAjzD1AA/wwHULw21Zs/1hym/DNZR5iZ8Iz3jgAT3C1AM8wAPXLQMrTbUWns+oHITXHZd5iZ8IR3IqqUse0CNMPcADPHDdooXbcqDK8UDGbxS5432HZcZPhCOeeECPMPUAD/DAdQvDbcmW7QM5vy/kfRY6KJMq6XdE1MXigwf0CFMP8AAPXLcw3JY02x9p7Ef7/EeZnhDVl0WLy6RKukFEo/V88IAeYeoBHuCB6xaG23L4pWbliNEt0zMy/b1M6yqWGVfSNzzxgB5h6gEe4IHrFobbknhNpg9LHLdYpvUVy5wronlpCz3xgB5h6gEe4IHrFobbkqClxf6FTE+KaEUUXRyR6ccWytzI3Sq3yvTNmnlAjzD1AA/wwHULw21ZTMm0X6Y/5xNfhBdEtC6orTJf4W6V38l0rmYe0CNMPcADPHDdpqCj0WjAspoM//Lfjeb9/JnIHj1HlePB5Ma//bfLbJV5UaY/k+myKx516FEE4lmHHjo80jA4OFirHn19fanbD3UIqzy2lLxV2eZRhCyeo4c7rPJY9nA5QWzzKEIWzx2DN1rlsavvk0IummVWum7zeKCF21q4raByPOS4zCGupD54QI8w9QAP8MB1C8NtSWSNlHuRK8dlx2UOe+RhQ48eEcW6PC9Tg9N53tZTox42eISiRyj1FHpAD+/3MRhua6E3o3I86PCiVcsc8sijqh5LZHpPRCMWexI3lU3826016GGLRyh6hFJPoQf08H4fg+G2DuamVJCjjiupWiYtdTbmiYcNPZ6Wab6IBlL0y3Q9p37eNp/3ca2HDR6h6BFKPYUe0COI+xiCF7QOVnMlUSvHXzq+aNUyRzzysKHHGv4ckGmvsn03H7NH2celHjZ4hKJHKPUUekCPIO5jaOG2DlYo31+p6aJVy3zdIw8benTzZ9pUgHjbvBr0sMEjFD1CqafQA3oEcR+D4bYO1imV4/6aLlq1zCGPPGzqcUFzm2s9qvAIRY9Q6in0gB5B3MfQpdwaWCSiIeyv1fiEnFamDx629WgEokejyfUIpZ5CD+gRzH0MLdzWwAquHPQkNuWxTB88oEeYeoAHeOC6heG2JC57uFjSyrwcwEVri8c9nHzrYcojFD1CqafQA3oEcx9Dl3Jr4GggZR5tIT26AtGjq0n1EKgf0AP3sZnAWspAW0NZE5lWyClaHWdcpuvLrvncDDyUdZi1eWStpdwKUNZh1tZjSwvfUpV1mLX1KLvmcysCXcoAEIGWapvI+X1C1LOWLHigfkCPFsX/L8AA4ouZqwDTQvQAAAAASUVORK5CYII=); background-size: 238px 204px; } } + +.tsd-signature.tsd-kind-icon:before { background-position: 0 -153px; } + +.tsd-kind-object-literal > .tsd-kind-icon:before { background-position: 0px -17px; } +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -17px; } +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -17px; } + +.tsd-kind-class > .tsd-kind-icon:before { background-position: 0px -34px; } +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -34px; } +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -34px; } + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -51px; } +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -51px; } +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -51px; } + +.tsd-kind-interface > .tsd-kind-icon:before { background-position: 0px -68px; } +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -68px; } +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -68px; } + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: 0px -85px; } +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -85px; } +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -85px; } + +.tsd-kind-module > .tsd-kind-icon:before { background-position: 0px -102px; } +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; } +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; } + +.tsd-kind-external-module > .tsd-kind-icon:before { background-position: 0px -102px; } +.tsd-kind-external-module.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -102px; } +.tsd-kind-external-module.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -102px; } + +.tsd-kind-enum > .tsd-kind-icon:before { background-position: 0px -119px; } +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -119px; } +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -119px; } + +.tsd-kind-enum-member > .tsd-kind-icon:before { background-position: 0px -136px; } +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -136px; } +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -136px; } + +.tsd-kind-signature > .tsd-kind-icon:before { background-position: 0px -153px; } +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -153px; } +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -153px; } + +.tsd-kind-type-alias > .tsd-kind-icon:before { background-position: 0px -170px; } +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { background-position: -17px -170px; } +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { background-position: -34px -170px; } + +.tsd-kind-variable > .tsd-kind-icon:before { background-position: -136px -0px; } +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; } +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; } +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; } +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; } +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; } + +.tsd-kind-property > .tsd-kind-icon:before { background-position: -136px -0px; } +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -0px; } +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -0px; } +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -0px; } +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -0px; } +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -0px; } +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -0px; } +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -0px; } + +.tsd-kind-get-signature > .tsd-kind-icon:before { background-position: -136px -17px; } +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -17px; } +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -17px; } +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -17px; } + +.tsd-kind-set-signature > .tsd-kind-icon:before { background-position: -136px -34px; } +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -34px; } +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -34px; } +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -34px; } + +.tsd-kind-accessor > .tsd-kind-icon:before { background-position: -136px -51px; } +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -51px; } +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -51px; } +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -51px; } +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -51px; } +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -51px; } +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -51px; } + +.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -68px; } +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -68px; } +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -68px; } +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -68px; } + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; } +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; } + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { background-position: -136px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -85px; } +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -85px; } + +.tsd-kind-constructor > .tsd-kind-icon:before { background-position: -136px -102px; } +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; } +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; } +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; } +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; } +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; } + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { background-position: -136px -102px; } +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -102px; } +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -102px; } +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -102px; } + +.tsd-kind-index-signature > .tsd-kind-icon:before { background-position: -136px -119px; } +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -119px; } +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -119px; } +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -119px; } + +.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -136px; } +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -136px; } +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -136px; } +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -136px; } +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -136px; } +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -136px; } +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -136px; } +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -136px; } + +.tsd-is-static > .tsd-kind-icon:before { background-position: -136px -153px; } +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -153px; } +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -153px; } +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -153px; } +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -153px; } +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -153px; } +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -153px; } +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -153px; } + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { background-position: -136px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -170px; } +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -170px; } + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { background-position: -136px -187px; } +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { background-position: -153px -187px; } +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { background-position: -51px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { background-position: -68px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { background-position: -85px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { background-position: -102px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { background-position: -170px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { background-position: -187px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { background-position: -119px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { background-position: -204px -187px; } +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { background-position: -221px -187px; } + +.no-transition { -webkit-transition: none !important; transition: none !important; } + +@-webkit-keyframes fade-in { + from { opacity: 0; } + to { opacity: 1; } } + +@keyframes fade-in { from { opacity: 0; } + to { opacity: 1; } } +@-webkit-keyframes fade-out { + from { opacity: 1; visibility: visible; } + to { opacity: 0; } } +@keyframes fade-out { from { opacity: 1; visibility: visible; } + to { opacity: 0; } } +@-webkit-keyframes fade-in-delayed { + 0% { opacity: 0; } + 33% { opacity: 0; } + 100% { opacity: 1; } } +@keyframes fade-in-delayed { 0% { opacity: 0; } + 33% { opacity: 0; } + 100% { opacity: 1; } } +@-webkit-keyframes fade-out-delayed { + 0% { opacity: 1; visibility: visible; } + 66% { opacity: 0; } + 100% { opacity: 0; } } +@keyframes fade-out-delayed { 0% { opacity: 1; visibility: visible; } + 66% { opacity: 0; } + 100% { opacity: 0; } } +@-webkit-keyframes shift-to-left { + from { -webkit-transform: translate(0, 0); transform: translate(0, 0); } + to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } } +@keyframes shift-to-left { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); } + to { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } } +@-webkit-keyframes unshift-to-left { + from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@keyframes unshift-to-left { from { -webkit-transform: translate(-25%, 0); transform: translate(-25%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@-webkit-keyframes pop-in-from-right { + from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@keyframes pop-in-from-right { from { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } + to { -webkit-transform: translate(0, 0); transform: translate(0, 0); } } +@-webkit-keyframes pop-out-to-right { + from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; } + to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } } +@keyframes pop-out-to-right { from { -webkit-transform: translate(0, 0); transform: translate(0, 0); visibility: visible; } + to { -webkit-transform: translate(100%, 0); transform: translate(100%, 0); } } + +.tsd-typography { line-height: 1.333em; } +.tsd-typography ul { list-style: square; padding: 0 0 0 20px; margin: 0; } +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; margin: 0; } +.tsd-typography h5, .tsd-typography h6 { font-weight: normal; } +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { margin: 1em 0; } + +@media (min-width: 901px) and (max-width: 1024px) { html.default .col-content { width: 72%; } + html.default .col-menu { width: 28%; } + html.default .tsd-navigation { padding-left: 10px; } } +@media (max-width: 900px) { html.default .col-content { float: none; width: 100%; } + html.default .col-menu { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; z-index: 1024; top: 0 !important; bottom: 0 !important; left: auto !important; right: 0 !important; width: 100%; padding: 20px 20px 0 0; max-width: 450px; visibility: hidden; background-color: #fff; -webkit-transform: translate(100%, 0); -ms-transform: translate(100%, 0); transform: translate(100%, 0); } + html.default .col-menu > *:last-child { padding-bottom: 20px; } + html.default .overlay { content: ""; display: block; position: fixed; z-index: 1023; top: 0; left: 0; right: 0; bottom: 0; background-color: rgba(0, 0, 0, 0.75); visibility: hidden; } + html.default.to-has-menu .overlay { -webkit-animation: fade-in 0.4s; animation: fade-in 0.4s; } + html.default.to-has-menu header, html.default.to-has-menu footer, html.default.to-has-menu .col-content { -webkit-animation: shift-to-left 0.4s; animation: shift-to-left 0.4s; } + html.default.to-has-menu .col-menu { -webkit-animation: pop-in-from-right 0.4s; animation: pop-in-from-right 0.4s; } + html.default.from-has-menu .overlay { -webkit-animation: fade-out 0.4s; animation: fade-out 0.4s; } + html.default.from-has-menu header, html.default.from-has-menu footer, html.default.from-has-menu .col-content { -webkit-animation: unshift-to-left 0.4s; animation: unshift-to-left 0.4s; } + html.default.from-has-menu .col-menu { -webkit-animation: pop-out-to-right 0.4s; animation: pop-out-to-right 0.4s; } + html.default.has-menu body { overflow: hidden; } + html.default.has-menu .overlay { visibility: visible; } + html.default.has-menu header, html.default.has-menu footer, html.default.has-menu .col-content { -webkit-transform: translate(-25%, 0); -ms-transform: translate(-25%, 0); transform: translate(-25%, 0); } + html.default.has-menu .col-menu { visibility: visible; -webkit-transform: translate(0, 0); -ms-transform: translate(0, 0); transform: translate(0, 0); } } + +.tsd-page-title { padding: 70px 0 20px 0; margin: 0 0 40px 0; background: #fff; box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); } +.tsd-page-title h1 { margin: 0; } + +.tsd-breadcrumb { margin: 0; padding: 0; color: #808080; } +.tsd-breadcrumb a { color: #808080; text-decoration: none; } +.tsd-breadcrumb a:hover { text-decoration: underline; } +.tsd-breadcrumb li { display: inline; } +.tsd-breadcrumb li:after { content: " / "; } + +html.minimal .container-main { padding-bottom: 0; } +html.minimal .content-wrap { padding-left: 340px; } +html.minimal .tsd-navigation { position: fixed !important; float: left; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; box-sizing: border-box; z-index: 1; top: 60px; bottom: 0; width: 300px; padding: 20px; margin: 0; } +html.minimal .tsd-member .tsd-member { margin-left: 0; } +html.minimal .tsd-page-toolbar { position: fixed; z-index: 2; } +html.minimal #tsd-filter .tsd-filter-group { right: 0; -webkit-transform: none; -ms-transform: none; transform: none; } +html.minimal footer { background-color: transparent; } +html.minimal footer .container { padding: 0; } +html.minimal .tsd-generator { padding: 0; } +@media (max-width: 900px) { html.minimal .tsd-navigation { display: none; } + html.minimal .content-wrap { padding-left: 0; } } + +dl.tsd-comment-tags { overflow: hidden; } +dl.tsd-comment-tags dt { clear: both; float: left; padding: 1px 5px; margin: 0 10px 0 0; border-radius: 4px; border: 1px solid #808080; color: #808080; font-size: 0.8em; font-weight: normal; } +dl.tsd-comment-tags dd { margin: 0 0 10px 0; } +dl.tsd-comment-tags p { margin: 0; } + +.tsd-panel.tsd-comment .lead { font-size: 1.1em; line-height: 1.333em; margin-bottom: 2em; } +.tsd-panel.tsd-comment .lead:last-child { margin-bottom: 0; } + +.toggle-protected .tsd-is-private { display: none; } + +.toggle-public .tsd-is-private, .toggle-public .tsd-is-protected, .toggle-public .tsd-is-private-protected { display: none; } + +.toggle-inherited .tsd-is-inherited { display: none; } + +.toggle-only-exported .tsd-is-not-exported { display: none; } + +.toggle-externals .tsd-is-external { display: none; } + +#tsd-filter { position: relative; display: inline-block; height: 40px; vertical-align: bottom; } +.no-filter #tsd-filter { display: none; } +#tsd-filter .tsd-filter-group { display: inline-block; height: 40px; vertical-align: bottom; white-space: nowrap; } +#tsd-filter input { display: none; } +@media (max-width: 900px) { #tsd-filter .tsd-filter-group { display: block; position: absolute; top: 40px; right: 20px; height: auto; background-color: #fff; visibility: hidden; -webkit-transform: translate(50%, 0); -ms-transform: translate(50%, 0); transform: translate(50%, 0); box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } + .has-options #tsd-filter .tsd-filter-group { visibility: visible; } + .to-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-in 0.2s; animation: fade-in 0.2s; } + .from-has-options #tsd-filter .tsd-filter-group { -webkit-animation: fade-out 0.2s; animation: fade-out 0.2s; } + #tsd-filter label, #tsd-filter .tsd-select { display: block; padding-right: 20px; } } + +footer { background-color: #fff; } +footer.with-border-bottom { border-bottom: 1px solid #eee; margin-left: 20px } +footer .tsd-legend-group { font-size: 0; } +footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 16px; list-style: none; line-height: 1.333em; vertical-align: top; } +@media (max-width: 900px) { footer .tsd-legend { width: 50%; } } + +.tsd-hierarchy { list-style: square; padding: 0 0 0 20px; margin: 0; } +.tsd-hierarchy .target { font-weight: bold; } + +.tsd-index-panel .tsd-index-content { margin-bottom: -30px !important; } +.tsd-index-panel .tsd-index-section { margin-bottom: 30px !important; } +.tsd-index-panel h3 { margin: 0 -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; } +.tsd-index-panel ul.tsd-index-list { -webkit-column-count: 3; -moz-column-count: 3; -ms-column-count: 3; column-count: 3; -webkit-column-gap: 20px; -moz-column-gap: 20px; -ms-column-gap: 20px; column-gap: 20px; padding: 0; list-style: none; line-height: 1.333em; } +@media (max-width: 900px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 1; -moz-column-count: 1; -ms-column-count: 1; column-count: 1; } } +@media (min-width: 901px) and (max-width: 1024px) { .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 2; -moz-column-count: 2; -ms-column-count: 2; column-count: 2; } } +.tsd-index-panel ul.tsd-index-list li { -webkit-column-break-inside: avoid; -moz-column-break-inside: avoid; -ms-column-break-inside: avoid; -o-column-break-inside: avoid; column-break-inside: avoid; -webkit-page-break-inside: avoid; -moz-page-break-inside: avoid; -ms-page-break-inside: avoid; -o-page-break-inside: avoid; page-break-inside: avoid; } +.tsd-index-panel a, .tsd-index-panel .tsd-parent-kind-module a { color: #9600ff; } +.tsd-index-panel .tsd-parent-kind-interface a { color: #7da01f; } +.tsd-index-panel .tsd-parent-kind-enum a { color: #cc9900; } +.tsd-index-panel .tsd-parent-kind-class a { color: #4da6ff; } +.tsd-index-panel .tsd-kind-module a { color: #9600ff; } +.tsd-index-panel .tsd-kind-interface a { color: #7da01f; } +.tsd-index-panel .tsd-kind-enum a { color: #cc9900; } +.tsd-index-panel .tsd-kind-class a { color: #4da6ff; } +.tsd-index-panel .tsd-is-private a { color: #808080; } + +.tsd-flag { display: inline-block; padding: 1px 5px; border-radius: 4px; color: #fff; background-color: #808080; text-indent: 0; font-size: 14px; font-weight: normal; } + +.tsd-anchor { position: absolute; top: -100px; } + +.tsd-member { position: relative; } +.tsd-member .tsd-anchor + h3 { margin-top: 0; margin-bottom: 0; border-bottom: none; } + +.tsd-navigation { padding: 0 0 0 40px; } +.tsd-navigation a { display: block; padding-top: 2px; padding-bottom: 2px; border-left: 2px solid transparent; color: #222; text-decoration: none; -webkit-transition: border-left-color 0.1s; transition: border-left-color 0.1s; } +.tsd-navigation a:hover { text-decoration: underline; } +.tsd-navigation ul { margin: 0; padding: 0; list-style: none; } +.tsd-navigation li { padding: 0; } + +.tsd-navigation.primary { padding-bottom: 40px; } +.tsd-navigation.primary a { display: block; padding-top: 6px; padding-bottom: 6px; } +.tsd-navigation.primary ul li a { padding-left: 5px; } +.tsd-navigation.primary ul li li a { padding-left: 25px; } +.tsd-navigation.primary ul li li li a { padding-left: 45px; } +.tsd-navigation.primary ul li li li li a { padding-left: 65px; } +.tsd-navigation.primary ul li li li li li a { padding-left: 85px; } +.tsd-navigation.primary ul li li li li li li a { padding-left: 105px; } +.tsd-navigation.primary > ul { border-bottom: 1px solid #eee; } +.tsd-navigation.primary li { border-top: 1px solid #eee; } +.tsd-navigation.primary li.current > a { font-weight: bold; } +.tsd-navigation.primary li.label span { display: block; padding: 20px 0 6px 5px; color: #808080; } +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { padding-top: 20px; } + +.tsd-navigation.secondary ul { -webkit-transition: opacity 0.2s; transition: opacity 0.2s; } +.tsd-navigation.secondary ul li a { padding-left: 25px; } +.tsd-navigation.secondary ul li li a { padding-left: 45px; } +.tsd-navigation.secondary ul li li li a { padding-left: 65px; } +.tsd-navigation.secondary ul li li li li a { padding-left: 85px; } +.tsd-navigation.secondary ul li li li li li a { padding-left: 105px; } +.tsd-navigation.secondary ul li li li li li li a { padding-left: 125px; } +.tsd-navigation.secondary ul.current a { border-left-color: #eee; } +.tsd-navigation.secondary li.focus > a, .tsd-navigation.secondary ul.current li.focus > a { border-left-color: #000; } +.tsd-navigation.secondary li.current { margin-top: 20px; margin-bottom: 20px; border-left-color: #eee; } +.tsd-navigation.secondary li.current > a { font-weight: bold; } + +@media (min-width: 901px) { .menu-sticky-wrap { position: static; } + .no-csspositionsticky .menu-sticky-wrap.sticky { position: fixed; } + .no-csspositionsticky .menu-sticky-wrap.sticky-current { position: fixed; } + .no-csspositionsticky .menu-sticky-wrap.sticky-current ul.before-current, .no-csspositionsticky .menu-sticky-wrap.sticky-current ul.after-current { opacity: 0; } + .no-csspositionsticky .menu-sticky-wrap.sticky-bottom { position: absolute; top: auto !important; left: auto !important; bottom: 0; right: 0; } + .csspositionsticky .menu-sticky-wrap.sticky { position: -webkit-sticky; position: sticky; } + .csspositionsticky .menu-sticky-wrap.sticky-current { position: -webkit-sticky; position: sticky; } } + +.tsd-panel { margin: 20px 0; padding: 20px; background-color: #fff; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } +.tsd-panel:empty { display: none; } +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { margin: 1.5em -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eee; } +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { margin-bottom: 0; border-bottom: 0; } +.tsd-panel table { display: block; width: 100%; overflow: auto; margin-top: 10px; word-break: normal; word-break: keep-all; } +.tsd-panel table th { font-weight: bold; } +.tsd-panel table th, .tsd-panel table td { padding: 6px 13px; border: 1px solid #ddd; } +.tsd-panel table tr { background-color: #fff; border-top: 1px solid #ccc; } +.tsd-panel table tr:nth-child(2n) { background-color: #f8f8f8; } + +.tsd-panel-group { margin: 30px 0; } +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { padding-left: 20px; padding-right: 20px; } + +#tsd-search { -webkit-transition: background-color 0.2s; transition: background-color 0.2s; } +#tsd-search .title { position: relative; z-index: 2; } +#tsd-search .field { position: absolute; left: 0; top: 0; right: 40px; height: 40px; } +#tsd-search .field input { box-sizing: border-box; position: relative; top: -50px; z-index: 1; width: 100%; padding: 0 10px; opacity: 0; outline: 0; border: 0; background: transparent; color: #222; } +#tsd-search .field label { position: absolute; overflow: hidden; right: -40px; } +#tsd-search .field input, #tsd-search .title { -webkit-transition: opacity 0.2s; transition: opacity 0.2s; } +#tsd-search .results { position: absolute; visibility: hidden; top: 40px; width: 100%; margin: 0; padding: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } +#tsd-search .results li { padding: 0 10px; background-color: #fdfdfd; } +#tsd-search .results li:nth-child(even) { background-color: #fff; } +#tsd-search .results li.state { display: none; } +#tsd-search .results li.current, #tsd-search .results li:hover { background-color: #eee; } +#tsd-search .results a { display: block; } +#tsd-search .results a:before { top: 10px; } +#tsd-search .results span.parent { color: #808080; font-weight: normal; } +#tsd-search.has-focus { background-color: #eee; } +#tsd-search.has-focus .field input { top: 0; opacity: 1; } +#tsd-search.has-focus .title { z-index: 0; opacity: 0; } +#tsd-search.has-focus .results { visibility: visible; } +#tsd-search.loading .results li.state.loading { display: block; } +#tsd-search.failure .results li.state.failure { display: block; } + +.tsd-signature { margin: 0 0 1em 0; padding: 10px; border: 1px solid #eee; font-family: Menlo, Monaco, Consolas, "Courier New", monospace; font-size: 14px; } +.tsd-signature.tsd-kind-icon { padding-left: 30px; } +.tsd-signature.tsd-kind-icon:before { top: 10px; left: 10px; } +.tsd-panel > .tsd-signature { margin-left: -20px; margin-right: -20px; border-width: 1px 0; } +.tsd-panel > .tsd-signature.tsd-kind-icon { padding-left: 40px; } +.tsd-panel > .tsd-signature.tsd-kind-icon:before { left: 20px; } + +.tsd-signature-symbol { color: #808080; font-weight: normal; } + +.tsd-signature-type { font-style: italic; font-weight: normal; } + +.tsd-signatures { padding: 0; margin: 0 0 1em 0; border: 1px solid #eee; } +.tsd-signatures .tsd-signature { margin: 0; border-width: 1px 0 0 0; -webkit-transition: background-color 0.1s; transition: background-color 0.1s; } +.tsd-signatures .tsd-signature:first-child { border-top-width: 0; } +.tsd-signatures .tsd-signature.current { background-color: #eee; } +.tsd-signatures.active > .tsd-signature { cursor: pointer; } +.tsd-panel > .tsd-signatures { margin-left: -20px; margin-right: -20px; border-width: 1px 0; } +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { padding-left: 40px; } +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { left: 20px; } +.tsd-panel > a.anchor + .tsd-signatures { border-top-width: 0; margin-top: -20px; } + +ul.tsd-descriptions { position: relative; overflow: hidden; -webkit-transition: height 0.3s; transition: height 0.3s; padding: 0; list-style: none; } +ul.tsd-descriptions.active > .tsd-description { display: none; } +ul.tsd-descriptions.active > .tsd-description.current { display: block; } +ul.tsd-descriptions.active > .tsd-description.fade-in { -webkit-animation: fade-in-delayed 0.3s; animation: fade-in-delayed 0.3s; } +ul.tsd-descriptions.active > .tsd-description.fade-out { -webkit-animation: fade-out-delayed 0.3s; animation: fade-out-delayed 0.3s; position: absolute; display: block; top: 0; left: 0; right: 0; opacity: 0; visibility: hidden; } +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { font-size: 16px; margin: 1em 0 0.5em 0; } + +ul.tsd-parameters, ul.tsd-type-parameters { list-style: square; margin: 0; padding-left: 20px; } +ul.tsd-parameters > li.tsd-parameter-siganture, ul.tsd-type-parameters > li.tsd-parameter-siganture { list-style: none; margin-left: -20px; } +ul.tsd-parameters h5, ul.tsd-type-parameters h5 { font-size: 16px; margin: 1em 0 0.5em 0; } +ul.tsd-parameters .tsd-comment, ul.tsd-type-parameters .tsd-comment { margin-top: -0.5em; } + +.tsd-sources { font-size: 14px; color: #808080; margin: 0 0 1em 0; } +.tsd-sources a { color: #808080; text-decoration: underline; } +.tsd-sources ul, .tsd-sources p { margin: 0 !important; } +.tsd-sources ul { list-style: none; padding: 0; } + +.tsd-page-toolbar { position: absolute; z-index: 1; top: 0; left: 0; width: 100%; height: 40px; color: #333; background: #fff; border-bottom: 1px solid #eee; } +.tsd-page-toolbar a { color: #333; text-decoration: none; } +.tsd-page-toolbar a.title { font-weight: bold; } +.tsd-page-toolbar a.title:hover { text-decoration: underline; } +.tsd-page-toolbar .table-wrap { display: table; width: 100%; height: 40px; } +.tsd-page-toolbar .table-cell { display: table-cell; position: relative; white-space: nowrap; line-height: 40px; } +.tsd-page-toolbar .table-cell:first-child { width: 100%; } + +.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { content: ""; display: inline-block; width: 40px; height: 40px; margin: 0 -8px 0 0; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAAoCAQAAAAlSeuiAAABp0lEQVR4Ae3aUa3jQAyF4QNhIBTCQiiEQlgIhRAGhTAQBkIgBEIgDITZZGXNjZTePiSWYqn/54dGfbAq+SiTutWXAgAAAAAAAAAAAAA8NCz1UFSD2lKDS5d3NVzZj/BVNasaLoRZRUmj2lLrVVHWMUntQ13Wj/i1pWa9lprX6xMRnH4dx6Rjsn26+v+12ms+EcB37P0r+qH+DNQGXgMFcHzbregQ78B8eQCTJk0e979ZW7PdA2O49ceDsYexKgUNoI3EKYDWL3D8miaPh/uXtl6BHqEHFQvgXau/FsCiIWAAbST2fpQRT0sl70j3z5ZiBdD7CG5WZX8kxwmgjbiP5GQA9/3O2XaxnnHi53AEE0AbRh+JQwC3/fzC4hcb6xPvS4i3QaMdwX+0utsRPEY6gm2wNhKHAG77eUi7SIcK4G4NY4GMIan2u2Cxqzncl5DUn7Q8ArjvZ8JFOsl/Ed0jyBom+BomQKSto+9PcblHMM4iuu4X0QQw5hrGQY/gUxFkjZuf4m4alXVU+1De/VhEn5CvDSB/RsBzqWgAAAAAAAAAAAAAAACAfyyYJ5nhVuwIAAAAAElFTkSuQmCC); background-repeat: no-repeat; text-indent: -1024px; vertical-align: bottom; } +@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before { background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAoAAAABQCAMAAAC+sjQXAAAAM1BMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACjBUbJAAAAEXRSTlMA3/+/UCBw7xCPYIBAMM+vn1qYQ7QAAALCSURBVHgB7MGBAAAAAICg/akXqQIAAAAAAAAAAAAAAAAAAJids9mdE4bhoDNZCITP93/aSmhV/9uwPWyi8jtkblws2IxsYpz9LwSAaJW8AreE16PxOsMYE6Q4DiYKF7X+8ZHXc/E608xv5snEyIuZrVwMZjbnujR6T3gsXmcLOIRNzD+Ig2UuVtt2+NbAiX/wVLzOlviD9L2BOfGBlL/3D1I+uDjGBJArBPxU3x+K15kCQFo2s21JAOHrKpz4SPrWv4IKA+uFaR6vMwMcb+emA2DWEfDglrkLqEBOKVslA8Dx14oPMiV4CtywWxdQgAwkq2QE0uTXUwJGk2G9s3mTFNBzAkC7HKPsX72AEVjMnAWIpsPCRRjXdQxcjCYpoOcEgHY5Rtk/slWSgM3M2aSeeVgjAOeVpKcdgGMdNAXMuIAqOcZzqF8L+WcAsi8wkTeheCWMegL6mgCorHHyEJ5TVfxrLWDrTUjZdhnhjYqAnlN8TaoELOLVC0gucmoz/3RKcPs2jAs4+J5ET8AEZF+TSgGLeC1V8YuGQQU2IV1Asq9JCwE9XitZVPxr34bpJRj8PqsFLOK108W9aVrWZRrR7Sm2HL4JCToCujHZ6gUs4jUz0P1TEvD+U5wMa363YeziBODIq1YbJrsv9QKW8Ry1nNp+GAHvuingRTfmYcjBf0QpAS37bdUL6PFKtHJq63EsZ5cxcKMkDVIClu1dAK1PcJ5TFQ0M9wZKDCPs3BD7MIJGTs3WfiTfDVQYx5q5ZekCauTU3P5Q0ukGCgh49oFURdobWBY9N/CxEuwGjpGLuPhTdwH1x7HqDDxNgRP2zQ8lraFyF/yJ9vH6QGqtgSbBOU8/j2VORz+Wqfle2d5Ae4R+ML0z7Y+W4P7XHN3AU+tzyK/24EAGAAAAYJC/9T2+CgAAAAAAAAAAAAAAAAAAAADgJpfzHyIKFFBKAAAAAElFTkSuQmCC); background-size: 320px 40px; } } + +.tsd-widget { display: inline-block; overflow: hidden; opacity: 0.6; height: 40px; -webkit-transition: opacity 0.1s, background-color 0.2s; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; } +.tsd-widget:hover { opacity: 0.8; } +.tsd-widget.active { opacity: 1; background-color: #eee; } +.tsd-widget.no-caption { width: 40px; } +.tsd-widget.no-caption:before { margin: 0; } +.tsd-widget.search:before { background-position: 0 0; } +.tsd-widget.menu:before { background-position: -40px 0; } +.tsd-widget.options:before { background-position: -80px 0; } +.tsd-widget.options, .tsd-widget.menu { display: none; } +@media (max-width: 900px) { .tsd-widget.options, .tsd-widget.menu { display: inline-block; } } +input[type=checkbox] + .tsd-widget:before { background-position: -120px 0; } +input[type=checkbox]:checked + .tsd-widget:before { background-position: -160px 0; } + +.tsd-select { position: relative; display: inline-block; height: 40px; -webkit-transition: opacity 0.1s, background-color 0.2s; transition: opacity 0.1s, background-color 0.2s; vertical-align: bottom; cursor: pointer; } +.tsd-select .tsd-select-label { opacity: 0.6; -webkit-transition: opacity 0.2s; transition: opacity 0.2s; } +.tsd-select .tsd-select-label:before { background-position: -240px 0; } +.tsd-select.active .tsd-select-label { opacity: 0.8; } +.tsd-select.active .tsd-select-list { visibility: visible; opacity: 1; -webkit-transition-delay: 0s; transition-delay: 0s; } +.tsd-select .tsd-select-list { position: absolute; visibility: hidden; top: 40px; left: 0; margin: 0; padding: 0; opacity: 0; list-style: none; box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -webkit-transition: visibility 0s 0.2s, opacity 0.2s; transition: visibility 0s 0.2s, opacity 0.2s; } +.tsd-select .tsd-select-list li { padding: 0 20px 0 0; background-color: #fdfdfd; } +.tsd-select .tsd-select-list li:before { background-position: 40px 0; } +.tsd-select .tsd-select-list li:nth-child(even) { background-color: #fff; } +.tsd-select .tsd-select-list li:hover { background-color: #eee; } +.tsd-select .tsd-select-list li.selected:before { background-position: -200px 0; } +@media (max-width: 900px) { .tsd-select .tsd-select-list { top: 0; left: auto; right: 100%; margin-right: -5px; } + .tsd-select .tsd-select-label:before { background-position: -280px 0; } } diff --git a/css/extra.css b/css/extra.css new file mode 100644 index 000000000..804bb597f --- /dev/null +++ b/css/extra.css @@ -0,0 +1,14 @@ +pre code { + white-space: pre; + word-wrap: normal; + display: block; + padding: 12px; + font-size: 14px; +} + +code { + white-space: pre-wrap; + word-wrap: break-word; + padding: 2px 5px; + font-size: 16px; +} diff --git a/css/github-highlight.css b/css/github-highlight.css new file mode 100644 index 000000000..52b18879c --- /dev/null +++ b/css/github-highlight.css @@ -0,0 +1,224 @@ +pre { + border: none !important; + background-color: #fff !important; +} +code { + color: inherit !important; + background-color: #fff; +} +pre, code { + white-space: pre !important; +} +.highlight table pre { margin: 0; } +.highlight .cm { + color: #999988; + font-style: italic; +} +.highlight .cp { + color: #999999; + font-weight: bold; +} +.highlight .c1 { + color: #999988; + font-style: italic; +} +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; +} +.highlight .c, .highlight .cd { + color: #999988; + font-style: italic; +} +.highlight .err { + color: #a61717; + background-color: #e3d2d2; +} +.highlight .gd { + color: #000000; + background-color: #ffdddd; +} +.highlight .ge { + color: #000000; + font-style: italic; +} +.highlight .gr { + color: #aa0000; +} +.highlight .gh { + color: #999999; +} +.highlight .gi { + color: #000000; + background-color: #ddffdd; +} +.highlight .go { + color: #888888; +} +.highlight .gp { + color: #555555; +} +.highlight .gs { + font-weight: bold; +} +.highlight .gu { + color: #aaaaaa; +} +.highlight .gt { + color: #aa0000; +} +.highlight .kc { + color: #000000; + font-weight: bold; +} +.highlight .kd { + color: #000000; + font-weight: bold; +} +.highlight .kn { + color: #000000; + font-weight: bold; +} +.highlight .kp { + color: #000000; + font-weight: bold; +} +.highlight .kr { + color: #000000; + font-weight: bold; +} +.highlight .kt { + color: #445588; + font-weight: bold; +} +.highlight .k, .highlight .kv { + color: #000000; + font-weight: bold; +} +.highlight .mf { + color: #009999; +} +.highlight .mh { + color: #009999; +} +.highlight .il { + color: #009999; +} +.highlight .mi { + color: #009999; +} +.highlight .mo { + color: #009999; +} +.highlight .m, .highlight .mb, .highlight .mx { + color: #009999; +} +.highlight .sb { + color: #d14; +} +.highlight .sc { + color: #d14; +} +.highlight .sd { + color: #d14; +} +.highlight .s2 { + color: #d14; +} +.highlight .se { + color: #d14; +} +.highlight .sh { + color: #d14; +} +.highlight .si { + color: #d14; +} +.highlight .sx { + color: #d14; +} +.highlight .sr { + color: #009926; +} +.highlight .s1 { + color: #d14; +} +.highlight .ss { + color: #990073; +} +.highlight .s { + color: #d14; +} +.highlight .na { + color: #008080; +} +.highlight .bp { + color: #999999; +} +.highlight .nb { + color: #0086B3; +} +.highlight .nc { + color: #445588; + font-weight: bold; +} +.highlight .no { + color: #008080; +} +.highlight .nd { + color: #3c5d5d; + font-weight: bold; +} +.highlight .ni { + color: #800080; +} +.highlight .ne { + color: #990000; + font-weight: bold; +} +.highlight .nf { + color: #990000; + font-weight: bold; +} +.highlight .nl { + color: #990000; + font-weight: bold; +} +.highlight .nn { + color: #555555; +} +.highlight .nt { + color: #000080; +} +.highlight .vc { + color: #008080; +} +.highlight .vg { + color: #008080; +} +.highlight .vi { + color: #008080; +} +.highlight .nv { + color: #008080; +} +.highlight .ow { + color: #000000; + font-weight: bold; +} +.highlight .o { + color: #000000; + font-weight: bold; +} +.highlight .w { + color: #bbbbbb; +} +.highlight { + background-color: #fff; + padding-bottom: 0px; +} +.highlighter-rouge { + border: 1px solid #ccc; + margin-bottom: 1em; +} diff --git a/css/main.css b/css/main.css new file mode 100644 index 000000000..05fd446ec --- /dev/null +++ b/css/main.css @@ -0,0 +1,276 @@ +/* General CSS */ +@import url(https://fonts.googleapis.com/css?family=Open+Sans); + +body { + font-family: "Open Sans", Helvetica, Arial, sans-serif; +} + +img { + max-width: 90%; +} + +/* Custom CSS for home page */ +.hero-spacer { + margin-top: 50px; +} + +.hero-feature { + margin-bottom: 30px; +} + +.blog-content-wrap { + margin-top: 20px; + padding-top: 40px; +} + +/* Custom CSS for the docs */ + +.edit-links { + color: #cccccc; +} + +/* Prevent in-page links from scrolling under top nav */ +h2::before, h3::before { + display: block; + content: " "; + margin-top: -80px; + height: 80px; + visibility: hidden; +} + +/* Custom CSS for header and footer */ +.site-header +{ + width: 100%; + padding: 24px 0px; +} + +img.logo +{ + height: 28px; + margin-left: -18px; +} + +.icon > svg +{ + display: inline-block; + width: 28px; + height: 28px; +} + +.icon > svg path +{ + fill: #333333; +} + + +.thumb-home { + height: 340px; +} + +.img-home { + height: 150px !important; + margin: 10px; +} + +.tableauIcon { + margin-left: 18px; +} + +.jumbotron { + background-color: #fafafa; + border: 1px solid #e8e8e8; +} + +#community-jumbo { + background-color: #F0F8FF; +} + +footer { + margin: 30px 0; + text-align: center; +} + +.footer-hr { + width: 100%; + position: relative; +} + +table { + border: 1px solid #c2c2c2; + border-collapse: collapse; + margin: 1em 0px; +} + +th +{ + font-weight: bold; + border: 1px solid #c2c2c2; + text-align: left; + padding: .3em; + vertical-align: top; + background-color: #fafafa; +} + +td +{ + border: 1px solid #c2c2c2; + text-align: left; + padding: .3em; + vertical-align: top; +} + +/* So the scroll bar width doesn't cause the page to jump */ +html { + overflow-y: scroll; +} + +.label { + margin-right: 3px; +} + +/* to get right navbar icons to respect collapse */ +@media (max-width: 992px) { + .navbar-header { + float: none; + } + .navbar-left,.navbar-right { + float: none !important; + } + .navbar-toggle { + display: block; + } + .navbar-collapse { + border-top: 1px solid transparent; + box-shadow: inset 0 1px 0 rgba(255,255,255,0.1); + } + .navbar-fixed-top { + top: 0; + border-width: 0 0 1px; + } + .navbar-collapse.collapse { + display: none!important; + } + .navbar-nav { + float: none!important; + margin-top: 7.5px; + } + .navbar-nav>li { + float: none; + } + .navbar-nav>li>a { + padding-top: 10px; + padding-bottom: 10px; + } + .collapse.in{ + display:block !important; + } +} + + +/* Custom css for news section */ +.blog-content { + margin-bottom: 70px; +} + +.blogul { + padding: 0px; +} + +.blogul h1 { + margin-top: 40px; +} + +.blog-content > h4 { + margin-top: 20px; +} + +.blog-content > ol { + margin-bottom: 20px; +} + + +/* Community connectors */ +.thumbnail { + background-color: #fff; + border: 1px solid #ccc; + margin: 12px; +} + +.thumbnail h2 { + border-left: 2px solid #337ab7; + text-decoration: none; + font-size: 20px; + padding: 6px; + margin-left: 10px; +} + +.thumbnail h2 a { + text-decoration: none; + color: #333333; +} + +.well { + background-color: #ffffff; + margin-bottom: 40px; +} + +.tsd-navigation { + padding: 10px !important; +} + +/* Media queries for responsive design */ +#grid[data-columns]::before { + content: '3 .column.size-1of3'; +} + +.column { float: left; } +.size-1of3 { width: 33.333%; } + + +@media screen and (max-width: 767px) { + #grid[data-columns]::before { + content: '1 .column.size-1of1'; + } + + /* Docs Menu*/ + .docs-menu, .tsd-navigation { + top: 20px; + position: relative; + } + +} +@media screen and (min-width: 769px) { + #grid[data-columns]::before { + content: '3 .column.size-1of3'; + } + + /* Docs Menu*/ + .docs-menu, .tsd-navigation { + position: fixed; + overflow: auto; + top: 90px; + max-height: 90%; + max-width: 250px; + } + + .content { + position: relative; + margin: 40px 0px 0px 275px; + max-width: 1000px; + } + + /* API Reference */ + + .ref-content { + margin: 40px 0px 0px 275px; + max-width: 1000px; + } +} + +.column { float: left; } +.size-1of1 { width: 100%; } +.size-1of2 { width: 50%; } +.size-1of3 { width: 33.333%; } + + diff --git a/docs/api-ref.md b/docs/api-ref.md new file mode 100644 index 000000000..d0ac648d1 --- /dev/null +++ b/docs/api-ref.md @@ -0,0 +1,3070 @@ +--- +title: API reference +layout: docs +--- + +
+ Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. + +
+ + + +The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. + +The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + +|:--- | +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#API_Reference%3FTocPath%3DAPI%2520Reference%7C_____0){:target="_blank"}.| + + + +* TOC +{:toc } + +
+
+ + +## Authentication + +You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. + +
+
+ +### TableauAuth class + +```py +TableauAuth(username, password, site_id='', user_id_to_impersonate=None) +``` +The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. + + + **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). + +**Attributes** + +Name | Description +:--- | :--- +`username` | The name of the user whose credentials will be used to sign in. +`password` | The password of the user. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. + +Source file: models/tableau_auth.py + +**Example** + +```py +import tableauserverclient as TSC +# create a new instance of a TableauAuth object for authentication + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') + +# create a server instance +# pass the "tableau_auth" object to the server.auth.sign_in() method +``` + +
+
+ +### Auth methods +The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. + + +Source file: server/endpoint/auth_endpoint.py + +
+
+ +#### auth.sign in + +```py +auth.sign_in(auth_req) +``` + +Signs you in to Tableau Server. + + +The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign In](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Sign_In%3FTocPath%3DAPI%2520Reference%7C_____77){:target="_blank"} + +**Parameters** + +`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an auth object +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') + +# create an instance for your server +server = TSC.Server('http://SERVER_URL') + +# call the sign-in method with the auth object +server.auth.sign_in(tableau_auth) + +``` + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
+
+ + +#### auth.sign out + +```py +auth.sign_out() +``` +Signs you out of the current session. + +The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign Out](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Sign_Out%3FTocPath%3DAPI%2520Reference%7C_____78){:target="_blank"} + +**Example** + +```py + +server.auth.sign_out() + + +``` + + + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
+
+ + + + +## Connections + +The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. + +### ConnectionItem class + +```py +ConnectionItem() +``` + +The `ConnectionItem` class corresponds to workbook and data source connections. + +In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. + +**Attributes** + +Name | Description + :--- | : --- +`datasource_id` | The identifier of the data source. +`datasource_name` | The name of the data source. +`id` | The identifier of the connection. +`connection_type` | The type of connection. +`username` | The username for the connection. +`password` | The password used for the connection. +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`server_address` | The server address for the connection. +`server_port` | The port used for the connection. + +Source file: models/connection_item.py + +
+
+ + + +### ConnectionCredentials class + +```py +ConnectionCredentials(name, password, embed=True, oauth=False) +``` + + +The `ConnectionCredentials` class is used for workbook and data source publish requests. + + + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The username for the connection. +`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). +`password` | The password used for the connection. +`server_address` | The server address for the connection. +`server_port` | The port used by the server. +`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. + + +Source file: models/connection_credentials.py + +
+
+ +## Data sources + +Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. +The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. + +
+ +### DatasourceItem class + +```py +DatasourceItem(project_id, name=None) +``` + +The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. +`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. +`name` | The name of the data source. If not specified, the name of the published data source file is used. +`project_id` | The identifier of the project associated with the data source. When you must provide this identifier when create an instance of a `DatasourceItem` +`project_name` | The name of the project associated with the data source. +`tags` | The tags that have been added to the data source. +`updated_at` | The date and time when the data source was last updated. + + +**Example** + +```py + import tableauserverclient as TSC + + # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39') +``` + + +Source file: models/datasource_item.py + +
+
+ +### Datasources methods + +The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/datasources_endpoint.py + +
+
+ +#### datasources.delete + +```py +datasources.delete(datasource_id) +``` + +Removes the specified data source from Tableau Server. + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Datasource%3FTocPath%3DAPI%2520Reference%7C_____19){:target="_blank"} + +
+
+ + +#### datasources.download + +```py +datasources.download(datasource_id, filepath=None, no_extract=False) + +``` +Downloads the specified data source in `.tdsx` format. + +REST API: [Download Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Download_Datasource%3FTocPath%3DAPI%2520Reference%7C_____34){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. +`no_extract` | (Optional) Specifies whether to download the file without the extract. When the data source has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded data source. The data source is downloaded in `.tdsx` format. + +**Example** + +```py + + file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + print("\nDownloaded the file to {0}.".format(file_path)) + +```` + + +
+
+ +#### datasources.get + +```py +datasources.get(req_options=None) +``` + +Returns all the data sources for the site. + +To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) + +REST API: [Query Datasources](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasources%3FTocPath%3DAPI%2520Reference%7C_____49){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. + + +**Returns** + +Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('http://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_datasources, pagination_item = server.datasources.get() + print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) + print([datasource.name for datasource in all_datasources]) +```` + + + +
+
+ + +#### datasources.get_by_id + +```py +datasources.get_by_id(datasource_id) +``` + +Returns the specified data source item. + +REST API: [Query Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource%3FTocPath%3DAPI%2520Reference%7C_____46){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The `datasource_id` specifies the data source to query. + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The `DatasourceItem`. See [DatasourceItem class](#datasourceitem-class) + + +**Example** + +```py + +datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e') +print(datasource.name) + +``` + + +
+
+ + + +#### datasources.populate_connections + +```py +datasources.populate_connections(datasource_item) +``` + +Populates the connections for the specified data source. + +This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. + +REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource_Connections%3FTocPath%3DAPI%2520Reference%7C_____47){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the data source to populate with connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('http://SERVERURL') +# + ... + +# get the data source + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + + +# get the connection information + server.datasources.populate_connections(datasource) + +# print the information about the first connection item + print(datasource.connections[0].connection_type) + print(datasource.connections[0].id) + print(datasource.connections[0].server_address) + + ... + +``` + +
+
+ +#### datasources.publish + +```py +datasources.publish(datasource_item, file_path, mode, connection_credentials=None) +``` + +Publishes a data source to a server, or appends data to an existing data source. + +This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. + +REST API: [Publish Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Datasource%3FTocPath%3DAPI%2520Reference%7C_____44){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). +`file_path` | The path and name of the data source to publish. +`mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Only .tds, tdsx, or .tde files can be published as datasources.` | Raises an error if the type of file specified is not supported. + + +**Returns** + +The `DatasourceItem` for the data source that was added or appended to. + + +**Example** + +```py + + import tableauserverclient as TSC + server = TSC.Server('http://SERVERURL') + + ... + + project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' + file_path = r'C:\temp\WorldIndicators.tde' + + + # Use the project id to create new datsource_item + new_datasource = TSC.DatasourceItem(project_id) + + # publish data source (specified in file_path) + new_datasource = server.datasources.publish( + new_datasource, file_path, 'CreateNew') + + ... +``` + +
+
+ +#### datasources.update + +```py +datasource.update(datasource_item) +``` + +Updates the owner, or project of the specified data source. + +REST API: [Update Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Datasource%3FTocPath%3DAPI%2520Reference%7C_____79){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +An updated `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# do some updating + datasource.name = 'New Name' + +# call the update method with the data source item + updated_datasource = server.datasources.update(datasource) + + + +``` + + + +
+
+ +## Filters + +The TSC library provides a `Filter` class that you can use to filter results returned from the server. + +You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +For more information, see [Filter and Sort](filter-sort). + + +### Filter class + +```py +Filter(field, operator, value) +``` + +The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. + + + +**Attributes** + +Name | Description +:--- | :--- +`Field` | Defined in the `RequestOptions.Field` class. +`Operator` | Defined in the `RequestOptions.Operator` class +`Value` | The value to compare with the specified field and operator. + + + + + +
+
+ + +## Groups + +Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group. + +The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. + +
+
+ +### GroupItem class + +```py +GroupItem(name) +``` + +The `GroupItem` class contains the attributes for the group resources on Tableau Server. The `GroupItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/group_item.py + +**Attributes** + +Name | Description +:--- | :--- +`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). +`id` | The id of the group. +`users` | The list of users (`UserItem`). +`name` | The name of the group. The `name` is required when you create an instance of a group. + + + +**Example** + +```py + newgroup = TSC.GroupItem('My Group') + + # call groups.create() with new group +``` + + + + +
+
+ +### Groups methods + +The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source file: server/endpoint/groups_endpoint.py + +
+
+ +#### groups.add_user + +```py +groups.add_user(group_item, user_id): +``` + +Adds a user to the specified group. + + +REST API [Add User to Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Add_User_to_Group%3FTocPath%3DAPI%2520Reference%7C_____8){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`user_id` | The id of the user. + + + + +**Returns** + +None. + + +**Example** + +```py +# Adding a user to a group +# +# get the group item + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba' + +# add Ian to the group + server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba') + + + +``` + +
+
+ +#### groups.create + +```py +create(group_item) +``` + +Creates a new group in Tableau Server. + + +REST API: [Create Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Group%3FTocPath%3DAPI%2520Reference%7C_____14){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. + + + + +**Returns** +Adds new `GroupItem`. + + +**Example** + +```py + +# Create a new group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + +# create a new instance with the group name + newgroup = TSC.GroupItem('My Group') + +# call the create method + newgroup = server.groups.create(newgroup) + +# print the names of the groups on the server + all_groups, pagination_item = server.groups.get() + for group in all_groups : + print(group.name, group.id) +``` + +
+
+ +#### groups.delete + +```py +groups.delete(group_id) +``` + +Deletes the group on the site. + +REST API: [Delete Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Site%3FTocPath%3DAPI%2520Reference%7C_____74){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_id` | The identifier (`id`) for the group that you want to remove from the server. + + +**Exceptions** + +Error | Description +:--- | :--- +`Group ID undefined` | Raises an exception if a valid `group_id` is not provided. + + +**Example** + +```py +# Delete a group from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + +``` +
+
+ +#### groups.get + +```py +groups.get(req_options=None) +``` + +Returns information about the groups on the site. + + +To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulateusers) method. + + +REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_on_Site%3FTocPath%3DAPI%2520Reference%7C_____41){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. + + +**Returns** + +Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the groups on the server + all_groups, pagination_item = server.groups.get() + + # print the names of the first 100 groups + for group in all_groups : + print(group.name, group.id) +```` + + +
+
+ +#### groups.populate_users + +```py +groups.populate_users(group_item, req_options=None) +``` + +Populates the `group_item` with the list of users. + + +REST API: [Get Users in Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_in_Group){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to populate with user information. +`req_options` | (Optional) Additional request options to send to the endpoint. + + + +**Exceptions** + +`Group item missing ID. Group must be retrieved from server first.` : Raises an error if the `group_item` is unspecified. + + +**Returns** + +None. A list of `UserItem` objects are added to the group (`group_item.users`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('http://SERVERURL') +# + ... + +# get the group + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# get the user information + pagination_item = server.groups.populate_users(mygroup) + + +# print the names of the users + for user in mygroup.users : + print(user.name) + + + + +``` + +
+
+ +#### groups.remove_user + +```py +groups.remove_user(group_item, user_id) +``` + +Removes a user from a group. + + + + +REST API: [Remove User from Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Group%3FTocPath%3DAPI%2520Reference%7C_____73){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to remove the user from. +`user_id` | The id for the user. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. + + +**Returns** + +None. The user is removed from the group. + + +**Example** + +```py +# Remove a user from the group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the group + mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + + # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' + server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` + +
+
+ + + +## Projects + +Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. + +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + + + + +
+ +### ProjectItem class + +```py + +ProjectItem(name, description=None, content_permissions=None) + +``` +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. + +**Attributes** + +Name | Description +:--- | :--- +`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. +`name` | Name of the project. +`description` | The description of the project. +`id` | The project id. + + + +Source file: models/project_item.py + + +#### ProjectItem.ContentPermissions + +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"} + +Name | Description +:--- | :--- +`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. +`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc + + +locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject +print(locked_true) +# prints 'LockedToProject' + +by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner +print(by_owner) +# prints 'ManagedByOwner' + + +# pass the content_permissions to new instance of the project item. +new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') + +``` + +
+
+ +### Project methods + +The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + +Source files: server/endpoint/projects_endpoint.py + +
+
+ + +#### projects.create + +```py +projects.create(project_item) +``` + + +Creates a project on the specified site. + +To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Create Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. + + +**Returns** +Returns the new project item. + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('http://SERVER') + +with server.auth.sign_in(tableau_auth): + # create project item + new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') + # create the project + new_project = server.projects.create(new_project) + +``` + +
+
+ + +#### projects.get + +```py +projects.get() + +``` + +Return a list of project items for a site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Query Projects](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Projects%3FTocPath%3DAPI%2520Reference%7C_____55){:target="_blank"} + + +**Parameters** + +None. + +**Returns** + +Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + + + **Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('http://SERVER') + +with server.auth.sign_in(tableau_auth): + # get all projects on site + all_project_items, pagination_item = server.projects.get() + print([proj.name for proj in all_project_items]) + +``` + +
+
+ + +#### projects.update + +```py +projects.update(project_item) +``` + +Modify the project settings. + +You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Update Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Project%3FTocPath%3DAPI%2520Reference%7C_____82){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. + + +**Exceptions** + +Error | Description + :--- | : --- +`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Returns** + +Returns the updated project information. + +See [ProjectItem class](#projectitem-class) + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc + + ... + # get list of projects + all_project_items, pagination_item = server.projects.get() + + + # update project item #7 with new name, etc. + my_project = all_projects[7] + my_project.name ='New name' + my_project.description = 'New description' + + # call method to update project + updated_project = server.projects.update(my_project) + + + + +``` +
+
+ + +#### projects.delete + +```py +projects.delete(project_id) +``` + +Deletes a project by ID. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Project%3FTocPath%3DAPI%2520Reference%7C_____24){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`project_id` | The ID of the project to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc. + + server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + +``` + + +
+
+ + +## Requests + +The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. + +You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Groups +- Workbooks +- Views + +For more information, see [Filter and Sort](filter-sort). + +
+ + +### RequestOptions class + +```py +RequestOptions(pagenumber=1, pagesize=100) + +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`pagenumber` | The page number of the returned results. The defauilt value is 1. +`pagesize` | The number of items to return with each page (the default value is 100). +`sort()` | Returns a iterable set of `Sort` objects. +`filter()` | Returns an iterable set of `Filter` objects. + +
+
+ + + +#### RequestOptions.Field class + +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_filtering_and_sorting.htm%3FTocPath%3DConcepts%7C_____7){:target="_blank"} in the Tableau REST API. + +**Attributes** + +**Attributes** + +Field | Description +:--- | :--- +`CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` +`LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` +`Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` +`OwnerName` | Same as 'ownerName' in the REST API. `RequestOptions.Field.OwnerName` +`SiteRole` | Same as 'siteRole' in the REST API. `RequestOptions.Field.SiteRole` +`Tags` | Same as 'tags' in the REST API. `RequestOptions.Field.Tags` +`UpdatedAt` | Same as 'updatedAt' in the REST API. `RequestOptions.Field.UpdatedAt` + + +
+
+ + + +#### RequestOptions.Operator class + +Specifies the operators you can use to filter requests. + + +**Attributes** + +Operator | Description +:--- | :--- +`Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` +`GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` +`GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` +`LessThan` | Sets the operator to less than (same as `lt` in the REST API). `TSC.RequestOptions.Operator.LessThan` +`LessThanOrEqual` | Sets the operator to less than or equal (same as `lte` in the REST API). `TSC.RequestOptions.Operator.LessThanOrEqual` +`In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In` + +
+
+ + + +#### RequestOptions.Direction class + +Specifies the direction to sort the returned fields. + + +**Attributes** + +Name | Description +:--- | :--- +`Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) +`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). + + +
+
+ + + +## Server + +In the Tableau REST API, the server (`http://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) +The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. + + +
+
+ + +### Server class + +```py +Server(server_address) +``` +The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. + +**Attributes** + +Attribute | Description +:--- | :--- +`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `http://MY-SERVER/`). +`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_versions.htm){:target="_blank"} + + + +**Example** + +```py +import tableauserverclient as TSC + +# create a instance of server +server = TSC.Server('http://MY-SERVER') + + +# change the REST API version to 2.5 +server.version = '2.5' + + +``` + +#### Server.*Resources* + +When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` + + + +Resource | Description + :--- | : --- +*server*.auth | Sets authentication for sign in and sign out. See [Auth](#auththentication) | +*server*.views | Access the server views and methods. See [Views](#views) +*server*.users | Access the user resources and methods. See [Users](#users) +*server*.sites | Access the sites. See [Sites](#sites) +*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) +*server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) +*server*.projects | Access the resources and methods for projects. See [Projects](#projets) +*server*.schedules | Access the resources and methods for schedules. See [Schedules](#Schedules) +*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfo-class) + +
+
+ +#### Server.PublishMode + +The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. + + +**Properties** + +Resource | Description + :--- | : --- +`PublishMode.Overwrite` | Overwrites the workbook or data source. +`PublishMode.Append` | Appends to the workbook or data source. +`PublishMode.CreateNew` | Creates a new workbook or data source. + + +**Example** + +```py + + print(TSC.Server.PublishMode.Overwrite) + # prints 'Overwrite' + + overwrite_true = TSC.Server.PublishMode.Overwrite + + ... + + # pass the PublishMode to the publish workbooks method + new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true) + + +``` + + +
+
+ + +### ServerInfoItem class + +```py +ServerInfoItem(product_version, build_number, rest_api_version) +``` +The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. + +**Attributes** + +Name | Description +:--- | :--- +`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). +`build_number` | Shows the specific build number (for example, 10200.17.0329.1446). +`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. + + +
+
+ + +### ServerInfo methods + +The TSC library provides a method to access the build and version information from Tableau Server. + +
+ +#### server_info.get + +```py +server_info.get() + +``` +Retrieve the build and version information for the server. + +This method makes an unauthenticated call, so no sign in or authentication token is required. + +REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Server_Info%3FTocPath%3DAPI%2520Reference%7C_____76){:target="_blank"} + +**Parameters** + None + +**Exceptions** + +Error | Description +:--- | :--- +`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. + +**Example** + +```py +import tableauserverclient as TSC + +# create a instance of server +server = TSC.Server('http://MY-SERVER') + +# set the version number > 2.3 +# the server_info.get() method works in 2.4 and later +server.version = '2.5' + +s_info = server.server_info.get() +print("\nServer info:") +print("\tProduct version: {0}".format(s_info.product_version)) +print("\tREST API version: {0}".format(s_info.rest_api_version)) +print("\tBuild number: {0}".format(s_info.build_number)) + +``` + + +
+
+ + +## Sites + +Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. + +The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. + +
+
+ +### SiteItem class + +```py +SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None, + disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) +``` + +The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The name of the site. The name of the default site is "". +`content_url` | The path to the site. +`admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) +`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. +`storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. +`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. +`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. +`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. +`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. +`state` | Shows the current state of the site (`Active` or `Suspended`). + + +**Example** + +```py + +# create a new instance of a SiteItem + +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True) + +``` + +Source file: models/site_item.py + +
+
+ + +### Site methods + +The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. + + +Source file: server/endpoint/sites_endpoint.py + +
+
+ +#### sites.create + +```py +sites.create(site_item) +``` + +Creates a new site on the server for the specified site item object. + +Tableau Server only. + + +REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Site%3FTocPath%3DAPI%2520Reference%7C_____17){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass the `create` method. + + +**Returns** + +Returns a new instance of `SiteItem`. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an instance of server +server = TSC.Server('http://MY-SERVER') + +# create shortcut for admin mode +content_users=TSC.SiteItem.AdminMode.ContentAndUsers + +# create a new SiteItem +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True) + +# call the sites create method with the SiteItem +new_site = server.sites.create(new_site) +``` +
+
+ +#### sites.get + +```py +sites.get() +``` + +Queries all the sites on the server. + + +REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Sites%3FTocPath%3DAPI%2520Reference%7C_____58){:target="_blank"} + + +**Parameters** + + None. + +**Returns** + +Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc. + + # query the sites + all_sites, pagination_item = server.sites.get() + + # print all the site names and ids + for site in TSC.Pager(server.sites): + print(site.id, site.name, site.content_url, site.state) + + +``` + +
+
+ + + +#### sites.get_by_id + +```py +sites.get_by_id(site_id) +``` + +Queries the site with the given ID. + + +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Site){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`site_id` | The id for the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site ID undefined.` | Raises an error if an id is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) + +``` + +
+
+ +#### sites.get_by_name + +```py +sites.get_by_name(site_name) +``` + +Queries the site with the specified name. + + +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Site){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`site_name` | The name of the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site Name undefined.` | Raises an error if an name is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_name('MY_SITE') + + +``` + +
+
+ + + +#### sites.update + +```py +sites.update(site_item) +``` + +Modifies the settings for site. + + +The site item object must include the site ID and overrides all other settings. + + +REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Site%3FTocPath%3DAPI%2520Reference%7C_____84){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. + + +**Exceptions** + +Error | Description +:--- | :--- +`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. +`You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` + + +**Returns** + +Returns the updated `site_item`. + + +**Example** + +```py +... + +# make some updates to an existing site_item +site_item.name ="New name" + +# call update +site_item = server.sites.update(site_item) + +... +``` + +
+
+ + + + +#### sites.delete + + +```py +Sites.delete(site_id) +``` + +Deletes the specified site. + + +REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Site%3FTocPath%3DAPI%2520Reference%7C_____27){:target="_name"} + + +**Parameters** + +Name | Description + :--- | : --- +`site_id` | The id of the site that you want to delete. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. + + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, etc. + +server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + +``` + +
+
+ + + + +## Sort + +The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. + +You can use the sort and request options to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +### Sort class + +```py +sort(field, direction) +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. +`direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. + +**Example** + +```py + +# create a new instance of a request option object +req_option = TSC.RequestOptions() + +# add the sort expression, sorting by name and direction +req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, + TSC.RequestOptions.Direction.Asc)) +matching_workbooks, pagination_item = server.workbooks.get(req_option) + +for wb in matching_workbooks: + print(wb.name) +``` + +For information about using the `Sort` class, see [Filter and Sort](filter-sort). + +
+
+ + + +## Users + +Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. + +The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. + + +### UserItem class + +```py +UserItem(name, site_role, auth_setting=None) +``` + +The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Name | Description +:--- | :--- +`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for tis attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`domain_name` | The name of the site. +`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. +`id` | The id of the user on the site. +`last_login` | The date and time the user last logged in. +`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. +`email` | The email address of the user. +`fullname` | The full name of the user. +`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest` + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') + +# create a new UserItem object. + newU = TSC.UserItem('Monty', 'Publisher') + + print(newU.name, newU.site_role) + +``` + +Source file: models/user_item.py + +
+
+ + +### Users methods + +The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/users_endpoint.py +
+
+ +#### users.add + +```py +users.add(user_item) +``` + +Adds the user to the site. + +To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. + +REST API: [Add User to Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Add_User_to_Site%3FTocPath%3DAPI%2520Reference%7C_____9){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns the new `UserItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# login, etc. + +# create a new UserItem object. + newU = TSC.UserItem('Heather', 'Publisher') + +# add the new user to the site + newU = server.users.add(newU) + print(newU.name, newU.site_role) + +``` + +#### users.get + +```py +users.get(req_options=None) +``` + +Returns information about the users on the specified site. + +To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. + + +REST API: [Get Users on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_on_Site%3FTocPath%3DAPI%2520Reference%7C_____41){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('http://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_users, pagination_item = server.users.get() + print("\nThere are {} user on site: ".format(pagination_item.total_available)) + print([user.name for user in all_users]) +```` + +
+
+ +#### users.get_by_id + +```py +users.get_by_id(user_id) +``` + +Returns information about the specified user. + +REST API: [Query User On Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_User_On_Site%3FTocPath%3DAPI%2520Reference%7C_____61){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The `user_id` specifies the user to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined.` | Raises an exception if a valid `user_id` is not provided. + + +**Returns** + +The `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + user1 = server.users.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(user1.name) + +``` + +
+
+ + +#### users.populate_favorites + +```py +users.populate_favorites(user_item) +``` + +Returns the list of favorites (views, workbooks, and data sources) for a user. + +*Not currently implemented* + +
+
+ + +#### users.populate_workbooks + +```py +users.populate_workbooks(user_item, req_options=None): +``` + +Returns information about the workbooks that the specified user owns and has Read (view) permissions for. + + +This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). + +REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource_Connections%3FTocPath%3DAPI%2520Reference%7C_____47){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to populate with workbook information. + + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +A list of `WorkbookItem` + +A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) + + +**Example** + +```py +# first get all users, call server.users.get() +# get workbooks for user[0] + ... + + page_n = server.users.populate_workbooks(all_users[0]) + print("\nUser {0} owns or has READ permissions for {1} workbooks".format(all_users[0].name, page_n.total_available)) + print("\nThe workbooks are:") + for workbook in all_users[0].workbooks : + print(workbook.name) + + ... +``` + + + + +
+
+ +#### users.remove + +```py +users.remove(user_id) +``` + + + +Removes the specified user from the site. + +REST API: [Remove User from Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Site%3FTocPath%3DAPI%2520Reference%7C_____74){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The identifier (`id`) for the user that you want to remove from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined` | Raises an exception if a valid `user_id` is not provided. + + +**Example** + +```py +# Remove a user from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
+
+ + + + +#### users.update + +```py +users.update(user_item, password=None) +``` + +Updates information about the specified user. + +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_User%3FTocPath%3DAPI%2520Reference%7C_____86){:target="_blank"}. + + + +REST API: [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_User%3FTocPath%3DAPI%2520Reference%7C_____86){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to update. +`password` | (Optional) The new password for the user. + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +An updated `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # create a new user_item + user1 = TSC.UserItem('temp', 'Viewer') + + # add new user + user1 = server.users.add(user1) + print(user1.name, user1.site_role, user1.id) + + # modify user info + user1.name = 'Laura' + user1.fullname = 'Laura Rodriguez' + user1.email = 'laura@example.com' + + # update user + user1 = server.users.update(user1) + print("\Updated user info:") + print(user1.name, user1.fullname, user1.email, user1.id) + + +``` + + + +
+
+ + + + +## Views + +Using the TSC library, you can get all the views on a site, or get the views for a workbook, or populate a view with preview images. +The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API, for example, you can find the name of the view, its id, and the id of the workbook it is associated with. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. + + +
+ +### ViewItem class + +``` +class ViewItem(object) + +``` + +The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/view_item.py + +**Attributes** + +Name | Description +:--- | :--- +`id` | The identifier of the view item. +`name` | The name of the view. +`owner_id` | The id for the owner of the view. +`preview_image` | The thumbnail image for the view. +`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. +`workbook_id` | The id of the workbook associated with the view. + + +
+
+ + +### Views methods + +The Tableau Server Client provides two methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. + +Source file: server/endpoint/views_endpoint.py + +
+
+ +#### views.get +``` +views.get(req_option=None) +``` + +Returns the list of views items for a site. + + +REST API: [Query Views for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Views_for_Site%3FTocPath%3DAPI%2520Reference%7C_____64){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its id. + + + +**Returns** + +Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password') +server = TSC.Server('http://servername') + +with server.auth.sign_in(tableau_auth): + all_views, pagination_item = server.views.get() + print([view.name for view in all_views]) + +```` + +See [ViewItem class](#viewitem-class) + + +
+
+ +#### views.populate_preview_image + +```py + views.populate_preview_image(view_item) + +``` + +Populates a preview image for the specified view. + +This method gets the preview image (thumbnail) for the specified view item. The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `view.preview_image` for the view. + +REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Preview_Image%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. + + + +**Returns** + +None. The preview image is added to the view. + +See [ViewItem class](#viewitem-class) + +
+
+ + + + + +## Workbooks + +Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. + +The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. + + + + + +
+
+ +### WorkbookItem class + +```py + + WorkbookItem(project_id, name=None, show_tabs=False) + +``` +The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project + + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. +`name` | The name of the workbook. +`owner_id` | The ID of the owner. +`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. +`project_id` | The project id. +`project_name` | The name of the project. +`size` | The size of the workbook (in megabytes). +`show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. +`tags` | The tags that have been added to the workbook. +`updated_at` | The date and time when the workbook was last updated. +`views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). + + + + + +**Example** + +```py +# creating a new instance of a WorkbookItem +# +import tableauserverclient as TSC + +# Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') + + +```` + +Source file: models/workbook_item.py + +
+
+ +### Workbook methods + +The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. +The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. + + + +Source files: server/endpoint/workbooks_endpoint.py + +
+
+ +#### workbooks.get + +```py +workbooks.get(req_options=None) +``` + +Queries the server and returns information about the workbooks the site. + + + + + +REST API: [Query Workbooks for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbooks_for_Site%3FTocPath%3DAPI%2520Reference%7C_____70){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) + + +**Returns** + +Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('http://servername') + +with server.auth.sign_in(tableau_auth): + all_workbooks, pagination_item = server.workbooks.get() + # print names of first 100 workbooks + print([workbook.name for workbook in all_workbooks]) + + + +``` + +
+
+ + + +#### workbooks.get_by_id + +```py +workbooks.get_by_id(workbook_id) +``` + +Returns information about the specified workbook on the site. + +REST API: [Query Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook%3FTocPath%3DAPI%2520Reference%7C_____66){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). + + +**Exceptions** + +Error | Description + :--- | : --- +`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. + + +**Returns** + +The `WorkbookItem`. See [WorkbookItem class](#workbookitem-class) + + +**Example** + +```py + +workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') +print(workbook.name) + +``` + + +
+
+ + +#### workbooks.publish + +```py +workbooks.publish(workbook_item, file_path, publish_mode) +``` + +Publish a workbook to the specified site. + +**Note:** The REST API cannot automatically include +extracts or other resources that the workbook uses. Therefore, + a .twb file that uses data from an Excel or csv file on a local computer cannot be published, +unless you package the data and workbook in a .twbx file, or publish the data source separately. + +For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. + +REST API: [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Workbook%3FTocPath%3DAPI%2520Reference%7C_____45){:target="_blank"}, [Initiate File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Initiate_File_Upload%3FTocPath%3DAPI%2520Reference%7C_____43){:target="_blank"}, [Append to File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Append_to_File_Upload%3FTocPath%3DAPI%2520Reference%7C_____13){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). +`file_path` | The path and name of the workbook to publish. +`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. +`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. + +See the REST API [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Workbook%3FTocPath%3DAPI%2520Reference%7C_____45){:target="_blank"} for additional error codes. + +**Returns** + +The `WorkbookItem` for the workbook that was published. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('http://servername') + +with server.auth.sign_in(tableau_auth): + # create a workbook item + wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + # call the publish method with the workbook item + wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') +``` + +
+
+ + +#### workbooks.update + +```py +workbooks.update(workbook_item) +``` + + +Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. + +REST API: [Update Workbooks](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Workbook%3FTocPath%3DAPI%2520Reference%7C_____87){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('http://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nUpdate {0} workbook. Project was {1}".format(workbook.name, workbook.project_name)) + + + # make an change, for example a new project ID + workbook.project_id = '1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e' + + # call the update method + workbook = server.workbooks.update(workbook) + print("\nUpdated {0} workbook. Project is now {1}".format(workbook.name, workbook.project_name)) + + +``` + + +
+
+ + + +#### workbooks.delete + +```py +workbooks.delete(workbook_id) +``` + +Deletes a workbook with the specified ID. + + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Workbook%3FTocPath%3DAPI%2520Reference%7C_____31){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID of the workbook to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# tableau_auth sign in, etc. + + server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + +``` + + +
+
+ + +#### workbooks.download + +```py +workbooks.download(workbook_id, filepath=None, no_extract=False) +``` + +Downloads a workbook to the specified directory (optional). + + +REST API: [Download Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Download_Workbook%3FTocPath%3DAPI%2520Reference%7C_____36){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. +`no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded workbook. + + +**Example** + +```py + + file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nDownloaded the file to {0}.".format(file_path)) + +```` + + +
+
+ + +#### workbooks.populate_views + +```py +workbooks.populate_views(workbook_item) +``` + +Populates (or gets) a list of views for a workbook. + +You must first call this method to populate views before you can iterate through the views. + +This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. + +REST API: [Query Views for Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Views_for_Workbook%3FTocPath%3DAPI%2520Reference%7C_____65){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. + + +**Returns** + +None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('http://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the view information + server.workbooks.populate_views(workbook) + +# print information about the views for the work item + print("\nThe views for {0}: ".format(workbook.name)) + print([view.name for view in workbook.views]) + + ... + +``` + +
+
+ +#### workbooks.populate_connections + +```py +workbooks.populate_connections(workbook_item) +``` + +Populates a list of data source connections for the specified workbook. + +You must populate connections before you can iterate through the +connections. + +This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. + +REST API: [Query Workbook Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Connections%3FTocPath%3DAPI%2520Reference%7C_____67){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('http://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the connection information + server.workbooks.populate_connections(workbook) + +# print information about the data connections for the workbook item + print("\nThe connections for {0}: ".format(workbook.name)) + print([connection.id for connection in workbook.connections]) + + + ... + +``` + +
+
+ + +#### workbooks.populate_preview_image + +```py +workbooks.populate_preview_image(workbook_item) +``` + +This method gets the preview image (thumbnail) for the specified workbook item. + +The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. + +REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Preview_Image%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. + + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. + + + +**Returns** + +None. The preview image is added to the view. + + + +**Example** + +```py + +# import tableauserverclient as TSC + +# server = TSC.Server('http://SERVERURL') + + ... + + # get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # add the png thumbnail to the workbook item + server.workbooks.populate_preview_image(workbook) + + +``` + +#### workbooks.update_connection + +```py +workbooks.update_conn(workbook_item, connection_item) +``` + +Updates a workbook connection information (server address, server port, user name, and password). + +The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) + +REST API: [Update Workbook Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Workbook_Connection%3FTocPath%3DAPI%2520Reference%7C_____88){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. +`connection_item` | The `connection_item` that has the information you want to update. + + + +**Returns** + +None. The connection information is updated with the information in the `ConnectionItem`. + + + + +**Example** + +```py + +# update connection item user name and password +workbook.connections[0].username = 'USERNAME' +workbook.connections[0].password = 'PASSWORD' + +# call the update method +server.workbooks.update_conn(workbook, workbook.connections[0]) +``` + +
+
+ + diff --git a/docs/dev-guide.md b/docs/dev-guide.md new file mode 100644 index 000000000..8b47609ce --- /dev/null +++ b/docs/dev-guide.md @@ -0,0 +1,96 @@ +--- +title: Developer Guide +layout: docs +--- + +This topic describes how to contribute to the Tableau Server Client (Python) project. + +* TOC +{:toc} + +## Submit your first patch + +1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla) + +1. Fork the repository. + + We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/). + +1. Clone your fork: + + ```shell + git clone git@github.com:/server-client-python.git + ``` + +1. Run the tests to make sure everything is peachy: + + ```shell + python setup.py test + ``` + +1. Set up the feature, fix, or documentation branch. + + It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so: + + ```shell + git checkout -b 13-feature-new-stuff + ``` + +1. Code and commit! + + Here's a quick checklist for ensuring a good pull request: + + - Only touch the minimal amount of files possible while still accomplishing the goal. + - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. + - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle .` + - Keep commit messages clean and descriptive. + If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message. + +1. Add tests. + + All of our tests live under the `test/` folder in the repository. + We use `unittest` and the built-in test runner `python setup.py test`. + If a test needs a static file, like a twb/twbx, it should live under `test/assets/` + +1. Update the documentation. + + Our documentation is written in markdown and built with Jekyll on Github Pages. All of the documentation source files can be found in `docs/docs`. + + When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code. + + If you are just making a PR for documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built in `Edit this file` in the Github UI + +1. Submit to your fork. + +1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch. + +1. Wait for a review and address any feedback. + While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging + the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able. + +1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR + + +## Add new features + +1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually + has `get`, `post`, `update`, and `delete` operations that require making the url, creating the XML request if necesssary, + sending the request, and creating the target item object based on the server response. + +1. Create an item class for the new feature, following the structure of the other item classes. Each item has properties + that correspond to what attributes are sent to/received from the server (refer to docs and Postman for attributes). + Some items also require constants for user input that are limited to specific strings. After making all the + properties, make the parsing method that takes the server response and creates an instances of the target item. If + the corresponding endpoint class has an update function, then parsing is broken into multiple parts (refer to another + item like workbook or datasource for example). + +1. Add testing by getting real xml responses from the server, and asserting that all properties are parsed and set + correctly. + +1. Add a sample to show users how to use the new feature. + + diff --git a/docs/filter-sort.md b/docs/filter-sort.md new file mode 100644 index 000000000..f63e32f19 --- /dev/null +++ b/docs/filter-sort.md @@ -0,0 +1,90 @@ +--- +title: Filter and Sort +layout: docs +--- +Use the `RequestOptions` object to define filtering and sorting criteria for an endpoint, +then pass the object to your endpoint as a parameter. + +* TOC +{:toc} + + +## Available endpoints and fields + +You can use the TSC library to filter and sort the following endpoints: + +* Users +* Datasources +* Workbooks +* Views + +For the above endpoints, you can filter or sort on the following +fields: + +* CreatedAt +* LastLogin +* Name +* OwnerName +* SiteRole +* Tags +* UpdatedAt + +**Important**: Not all of the fields are available for all endpoints. For more information, see the [REST +API help](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_filtering_and_sorting.htm). + +## Filtering + +To filter on a field, you need to specify the following criteria: + +### Operator criteria + +The operator that you want to use for that field. For example, you can use the Equals operator to get everything from the endpoint that matches exactly. + +The operator can be any of the following: + +* Equals +* GreaterThan +* GreaterThanOrEqual +* LessThan +* In + +### Value criteria + +The value that you want to filter on. This can be any valid string. + +### Filtering example + +The following code displays only the workbooks where the name equals Superstore: + +```py +req_option = TSC.RequestOptions() +req_option.filter.add(TSC.Filter(TSC.RequestOptions.Field.Name, + TSC.RequestOptions.Operator.Equals, + 'Superstore')) +matching_workbooks, pagination_item = server.workbooks.get(req_option) + +print(matching_workbooks[0].owner_id) +``` + +## Sorting + +To sort on a field, you need to specify the direction in which you want to sort. + +### Direction criteria + +This can be either `Asc` for ascending or `Desc` for descending. + +### Sorting example + +The following code sorts the workbooks in ascending order: + +```py +req_option = TSC.RequestOptions() +req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, + TSC.RequestOptions.Direction.Asc)) +matching_workbooks, pagination_item = server.workbooks.get(req_option) + +for wb in matching_workbooks: + print(wb.name) +``` + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..9fd8b699e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,76 @@ +--- +title: Get Started +layout: docs +--- + +Use the Tableau Server Client (TSC) library to increase your productivity as you interact with the Tableau Server REST API. With +the TSC library you can do almost everything that you can do with the REST API, including: + +* Publish workbooks and data sources. +* Create users and groups. +* Query projects, sites, and more. + +This section describes how to: + +* TOC +{:toc} + +## Confirm prerequisites + +Before you install TSC, confirm that you have the following dependencies installed: + +* Python. You can use TSC with Python 2.7.9 or later and with Python 3.3 or later. These versions include pip, which is + the recommended means of installing TSC. +* Git. Optional, but recommended to download the samples or install from the source code. + + +## Install TSC + +You can install TSC with pip or from the source code. + +### Install with pip (recommended) + +Run the following command to install the latest stable version of TSC: + +``` +pip install tableauserverclient +``` + +### Install from the development branch + +You can install from the development branch for a preview of upcoming features. Run the following command +to install from the development branch: + +``` +pip install git+https://github.com/tableau/server-client-python.git@development +``` + +Note that the version from the development branch should not be used for production code. The methods and endpoints in the +development version are subject to change at any time before the next stable release. + +## Get the samples + +The TSC samples are included in the `samples` directory of the TSC repository on Github. You can run the following command to clone the +repository: + +``` +git clone git@github.com:tableau/server-client-python.git +``` + +For more information on the samples and how to run the samples, see [Samples]({{ site.baseurl }}/docs/samples). + +## Write your first program + +Run the following code to get a list of all the data sources on your installation of Tableau Server: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('http://SERVER_URL') + +with server.auth.sign_in(tableau_auth): + all_datasources, pagination_item = server.datasources.get() + print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) + print([datasource.name for datasource in all_datasources]) +``` diff --git a/docs/page-through-results.md b/docs/page-through-results.md new file mode 100644 index 000000000..b01a1455b --- /dev/null +++ b/docs/page-through-results.md @@ -0,0 +1,69 @@ +--- +title: Page through Results +layout: docs +--- + +Many of the calls that you make with the TSC library query for resources (like workbooks or data sources) on Tableau +Server. Because the number of resources on Tableau Server can be very large, Tableau Server only returns the first 100 +resources by default. To get all of the resources on Tableau Server, you need to page through the results. + +* TOC +{:toc} + +## The Pager generator + +The simplest way to page through results is to use the `Pager` generator on any endpoint with a `get` function. + +For example, to get all of the workbooks on Tableau Server, run the following code: + +```py +for wb in TSC.Pager(server.workbooks): + print(wb.name) +``` + +The `Pager` generator function returns one resource for each time that it is called. To get all the resources on the +server, you can make multiple calls to the `Pager` function. For example, you can use a `for ... in` loop to call the +`Pager` function until there are no resources remaining. Note that the `Pager` generator only makes calls to the Tableau +Server REST API when it runs out of resources--it does not make a call for each resource. + +**Tip**: For more information on generators, see the [Python wiki](https://wiki.python.org/moin/Generators). + +### Set pagination options + +You can set pagination options in the request options and then pass the request options to the `Pager` function as a +second optional parameter. + +For example, to set the page size to 1000 use the following code: + +```py +request_options = TSC.RequestOptions(pagesize=1000) +all_workbooks = list(TSC.Pager(server.workbooks, request_options)) +``` + +You can also set the page number where you want to start like so: + +```py +request_options = TSC.RequestOptions(pagenumber=5) +all_workbooks = list(TSC.Pager(server.workbooks, request_options)) +``` + +### Use list comprehensions and generator expressions + +The `Pager` generator can also be used in list comprehensions or generator expressions for compactness and easy +filtering. Generator expressions will use less memory than list comprehensions. The following example shows how to use +the `Pager` generator with list comprehensions and generator expressions: + +```py +# List comprehension +[wb for wb in TSC.Pager(server.workbooks) if wb.name.startswith('a')] + +# Generator expression +(wb for wb in TSC.Pager(server.workbooks) if wb.name.startswith('a')) +``` + +If you want to load all the resources returned by the `Pager` generator in memory (rather than one at a time), then you +can insert the elements into a list: + +```py +all_workbooks = list(TSC.Pager(server.workbooks)) +``` diff --git a/docs/populate-connections-views.md b/docs/populate-connections-views.md new file mode 100644 index 000000000..63e3fe8f4 --- /dev/null +++ b/docs/populate-connections-views.md @@ -0,0 +1,45 @@ +--- +title: Populate Connections and Views +layout: docs +--- + +When you get a workbook with the TSC library, the response from Tableau Server does not include information about the +views or connections that make up the workbook. Similarly, when you get a data source, the response does not include +information about the connections that make up the data source. This is a result of the design of the Tableau Server +REST API, which optimizes the size of responses by only returning what you ask for explicitly. + +As a result, if you want to get views and connections, you need to run the `populate_views` and `populate_connections` +functions. + +* TOC +{:toc} + +## Populate views for workbooks + +```py +workbook = server.workbooks.get_by_id('a1b2c3d4') +print(workbook.id) + +server.workbooks.populate_views(workbook) +print([view.name for view in workbook.views]) +``` + +## Populate connections for workbooks + +```py +workbook = server.workbooks.get_by_id('a1b2c3d4') +print(workbook.id) + +server.workbooks.populate_connections(workbook) +print([connection.datasource_name for connection in workbook.connections]) +``` + +## Populate connections for data sources + +```py +datasource = server.datasources.get_by_id('a1b2c3d4') +print(datasource.name) + +server.datasources.populate_connections(datasource) +print([connection.datasource_name for connection in datasource.connections]) +``` diff --git a/docs/samples.md b/docs/samples.md new file mode 100644 index 000000000..3ea908dd6 --- /dev/null +++ b/docs/samples.md @@ -0,0 +1,55 @@ +--- +title: Samples +layout: docs +--- + +The TSC samples are included in the `samples` directory of the TSC repository [on Github](https://github.com/tableau/server-client-python). + +* TOC +{:toc} + +## Run the samples + +Each of the samples requires the following arguments: + +* `--server`. The URL for the Tableau Server that you want to connect to. +* `--username`. The user name of the Tableau Server account that you want to use. When you run the samples, you are + prompted for a password for the user account that you enter. + +Additionally, some of the samples require that you enter other arguments when you run them. For more information about +the arguments required by a particular sample, run the sample with the `-h` flag to see the help output. + +For example, if you run the following command: + +``` +python samples/publish_workbook.py -h +``` + +You might see that you need to enter a server address, a user name, and a file path for the workbook that you want to +publish. + +## Samples list + +The following list describes the samples available in the repository: + +* `create_group.py`. Create a user group. + +* `create_schedules.py`. Create schedules for extract refreshes and subscriptions. + +* `explore_datasource.py`. Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. + +* `explore_workbook.py`. Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. + +* `move_workbook_projects.py`. Updates the properties of a workbook to move the workbook from one project to another. + +* `move_workbook_sites.py`. Downloads a workbook, stores it in-memory, and uploads it to another site. + +* `pagination_sample.py`. Use the Pager generator to iterate over all the items on the server. + +* `publish_workbook.py`. Publishes a Tableau workbook. + +* `set_http_options.py`. Sets HTTP options for the server and specifically for downloading workbooks. + +**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources +requested by the samples. + diff --git a/docs/search.md b/docs/search.md new file mode 100644 index 000000000..c35daec37 --- /dev/null +++ b/docs/search.md @@ -0,0 +1,5 @@ +--- +title: Search +layout: search +--- + diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md new file mode 100644 index 000000000..f619aaeab --- /dev/null +++ b/docs/sign-in-out.md @@ -0,0 +1,39 @@ +--- +title: Sign In and Out +layout: docs +--- + +To sign in and out of Tableau Server, call the `Auth.sign_in` and `Auth.sign_out` functions like so: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('http://SERVER_URL') + +server.auth.sign_in(tableau_auth) + +# Do awesome things here! + +server.auth.sign_out() +``` + +
+ Note: When you sign in, the TSC library manages the authenticated session for you, however it is still + limited by the maximum session length (of four hours) on Tableau Server. +
+ + +Alternatively, for short programs, consider using a `with` block: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('http://SERVER_URL') + +with server.auth.sign_in(tableau_auth): + # Do awesome things here! +``` + +The TSC library signs you out of Tableau Server when you exit out of the `with` block. diff --git a/docs/versions.md b/docs/versions.md new file mode 100644 index 000000000..aae5c3bf8 --- /dev/null +++ b/docs/versions.md @@ -0,0 +1,55 @@ +--- +title: Versions +layout: docs +--- + +Because the TSC library is a client for the Tableau Server REST API, you need to confirm that the version of the TSC +library that you use is compatible with the version of the REST API used by your installation of Tableau Server. + +* TOC +{:toc} + +## Display the REST API version + +To display the default version of the REST API used by TSC, run the following code: + +```py +import tableauserverclient as TSC + +server = TSC.Server('http://SERVER_URL') + +print(server.version) +``` + +For example, the code might display version `2.3`. + +## Use another version of the REST API + +To use another version of the REST API, set the version like so: + +```py +import tableauserverclient as TSC + +server = TSC.Server('http://SERVER_URL') + +<<<<<<< HEAD +server.version = 2.4 +======= + +server.version = '2.6' + + + +>>>>>>> 87acd20... Update versions.md (#195) +``` + +## Supported versions + +The current version of TSC only supports the following REST API and Tableau Server versions: + +|REST API version|Tableau Server version| +|---|---| +|2.3|10.0| +|2.4|10.1| +|2.5|10.2| +|2.6|10.3| diff --git a/index.md b/index.md new file mode 100644 index 000000000..c0f9a4431 --- /dev/null +++ b/index.md @@ -0,0 +1,13 @@ +--- +layout: home +indexed_by_search: false +--- + +
+

Tableau Server Client (Python)

+

The Tableau Server Client is a Python library for the Tableau Server REST API.

+
+ Get Started   + Download +
+ diff --git a/js/lunr.min.js b/js/lunr.min.js new file mode 100644 index 000000000..22776bb85 --- /dev/null +++ b/js/lunr.min.js @@ -0,0 +1,6 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 0.7.2 + * Copyright (C) 2016 Oliver Nightingale + * @license MIT + */ +!function(){var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.7.2",t.utils={},t.utils.warn=function(t){return function(e){t.console&&console.warn&&console.warn(e)}}(this),t.utils.asString=function(t){return void 0===t||null===t?"":t.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var t=Array.prototype.slice.call(arguments),e=t.pop(),n=t;if("function"!=typeof e)throw new TypeError("last argument must be a function");n.forEach(function(t){this.hasHandler(t)||(this.events[t]=[]),this.events[t].push(e)},this)},t.EventEmitter.prototype.removeListener=function(t,e){if(this.hasHandler(t)){var n=this.events[t].indexOf(e);this.events[t].splice(n,1),this.events[t].length||delete this.events[t]}},t.EventEmitter.prototype.emit=function(t){if(this.hasHandler(t)){var e=Array.prototype.slice.call(arguments,1);this.events[t].forEach(function(t){t.apply(void 0,e)})}},t.EventEmitter.prototype.hasHandler=function(t){return t in this.events},t.tokenizer=function(e){if(!arguments.length||null==e||void 0==e)return[];if(Array.isArray(e))return e.map(function(e){return t.utils.asString(e).toLowerCase()});var n=t.tokenizer.seperator||t.tokenizer.separator;return e.toString().trim().toLowerCase().split(n)},t.tokenizer.seperator=!1,t.tokenizer.separator=/[\s\-]+/,t.tokenizer.load=function(t){var e=this.registeredFunctions[t];if(!e)throw new Error("Cannot load un-registered function: "+t);return e},t.tokenizer.label="default",t.tokenizer.registeredFunctions={"default":t.tokenizer},t.tokenizer.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing tokenizer: "+n),e.label=n,this.registeredFunctions[n]=e},t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.registeredFunctions[e];if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");this._stack.splice(i,0,n)},t.Pipeline.prototype.remove=function(t){var e=this._stack.indexOf(t);-1!=e&&this._stack.splice(e,1)},t.Pipeline.prototype.run=function(t){for(var e=[],n=t.length,i=this._stack.length,r=0;n>r;r++){for(var o=t[r],s=0;i>s&&(o=this._stack[s](o,r,t),void 0!==o&&""!==o);s++);void 0!==o&&""!==o&&e.push(o)}return e},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},t.Vector.Node=function(t,e,n){this.idx=t,this.val=e,this.next=n},t.Vector.prototype.insert=function(e,n){this._magnitude=void 0;var i=this.list;if(!i)return this.list=new t.Vector.Node(e,n,i),this.length++;if(en.idx?n=n.next:(i+=e.val*n.val,e=e.next,n=n.next);return i},t.Vector.prototype.similarity=function(t){return this.dot(t)/(this.magnitude()*t.magnitude())},t.SortedSet=function(){this.length=0,this.elements=[]},t.SortedSet.load=function(t){var e=new this;return e.elements=t,e.length=t.length,e},t.SortedSet.prototype.add=function(){var t,e;for(t=0;t1;){if(o===t)return r;t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r]}return o===t?r:-1},t.SortedSet.prototype.locationFor=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;)t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r];return o>t?r:t>o?r+1:void 0},t.SortedSet.prototype.intersect=function(e){for(var n=new t.SortedSet,i=0,r=0,o=this.length,s=e.length,a=this.elements,h=e.elements;;){if(i>o-1||r>s-1)break;a[i]!==h[r]?a[i]h[r]&&r++:(n.add(a[i]),i++,r++)}return n},t.SortedSet.prototype.clone=function(){var e=new t.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},t.SortedSet.prototype.union=function(t){var e,n,i;this.length>=t.length?(e=this,n=t):(e=t,n=this),i=e.clone();for(var r=0,o=n.toArray();rp;p++)c[p]===a&&d++;h+=d/f*l.boost}}this.tokenStore.add(a,{ref:o,tf:h})}n&&this.eventEmitter.emit("add",e,this)},t.Index.prototype.remove=function(t,e){var n=t[this._ref],e=void 0===e?!0:e;if(this.documentStore.has(n)){var i=this.documentStore.get(n);this.documentStore.remove(n),i.forEach(function(t){this.tokenStore.remove(t,n)},this),e&&this.eventEmitter.emit("remove",t,this)}},t.Index.prototype.update=function(t,e){var e=void 0===e?!0:e;this.remove(t,!1),this.add(t,!1),e&&this.eventEmitter.emit("update",t,this)},t.Index.prototype.idf=function(t){var e="@"+t;if(Object.prototype.hasOwnProperty.call(this._idfCache,e))return this._idfCache[e];var n=this.tokenStore.count(t),i=1;return n>0&&(i=1+Math.log(this.documentStore.length/n)),this._idfCache[e]=i},t.Index.prototype.search=function(e){var n=this.pipeline.run(this.tokenizerFn(e)),i=new t.Vector,r=[],o=this._fields.reduce(function(t,e){return t+e.boost},0),s=n.some(function(t){return this.tokenStore.has(t)},this);if(!s)return[];n.forEach(function(e,n,s){var a=1/s.length*this._fields.length*o,h=this,u=this.tokenStore.expand(e).reduce(function(n,r){var o=h.corpusTokens.indexOf(r),s=h.idf(r),u=1,l=new t.SortedSet;if(r!==e){var c=Math.max(3,r.length-e.length);u=1/Math.log(c)}o>-1&&i.insert(o,a*s*u);for(var f=h.tokenStore.get(r),d=Object.keys(f),p=d.length,v=0;p>v;v++)l.add(f[d[v]].ref);return n.union(l)},new t.SortedSet);r.push(u)},this);var a=r.reduce(function(t,e){return t.intersect(e)});return a.map(function(t){return{ref:t,score:i.similarity(this.documentVector(t))}},this).sort(function(t,e){return e.score-t.score})},t.Index.prototype.documentVector=function(e){for(var n=this.documentStore.get(e),i=n.length,r=new t.Vector,o=0;i>o;o++){var s=n.elements[o],a=this.tokenStore.get(s)[e].tf,h=this.idf(s);r.insert(this.corpusTokens.indexOf(s),a*h)}return r},t.Index.prototype.toJSON=function(){return{version:t.version,fields:this._fields,ref:this._ref,tokenizer:this.tokenizerFn.label,documentStore:this.documentStore.toJSON(),tokenStore:this.tokenStore.toJSON(),corpusTokens:this.corpusTokens.toJSON(),pipeline:this.pipeline.toJSON()}},t.Index.prototype.use=function(t){var e=Array.prototype.slice.call(arguments,1);e.unshift(this),t.apply(this,e)},t.Store=function(){this.store={},this.length=0},t.Store.load=function(e){var n=new this;return n.length=e.length,n.store=Object.keys(e.store).reduce(function(n,i){return n[i]=t.SortedSet.load(e.store[i]),n},{}),n},t.Store.prototype.set=function(t,e){this.has(t)||this.length++,this.store[t]=e},t.Store.prototype.get=function(t){return this.store[t]},t.Store.prototype.has=function(t){return t in this.store},t.Store.prototype.remove=function(t){this.has(t)&&(delete this.store[t],this.length--)},t.Store.prototype.toJSON=function(){return{store:this.store,length:this.length}},t.stemmer=function(){var t={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},e={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[^aeiou]",i="[aeiouy]",r=n+"[^aeiouy]*",o=i+"[aeiou]*",s="^("+r+")?"+o+r,a="^("+r+")?"+o+r+"("+o+")?$",h="^("+r+")?"+o+r+o+r,u="^("+r+")?"+i,l=new RegExp(s),c=new RegExp(h),f=new RegExp(a),d=new RegExp(u),p=/^(.+?)(ss|i)es$/,v=/^(.+?)([^s])s$/,g=/^(.+?)eed$/,m=/^(.+?)(ed|ing)$/,y=/.$/,S=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\1$"),k=new RegExp("^"+r+i+"[^aeiouwxy]$"),x=/^(.+?[^aeiou])y$/,b=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,F=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,_=/^(.+?)(s|t)(ion)$/,z=/^(.+?)e$/,O=/ll$/,P=new RegExp("^"+r+i+"[^aeiouwxy]$"),T=function(n){var i,r,o,s,a,h,u;if(n.length<3)return n;if(o=n.substr(0,1),"y"==o&&(n=o.toUpperCase()+n.substr(1)),s=p,a=v,s.test(n)?n=n.replace(s,"$1$2"):a.test(n)&&(n=n.replace(a,"$1$2")),s=g,a=m,s.test(n)){var T=s.exec(n);s=l,s.test(T[1])&&(s=y,n=n.replace(s,""))}else if(a.test(n)){var T=a.exec(n);i=T[1],a=d,a.test(i)&&(n=i,a=S,h=w,u=k,a.test(n)?n+="e":h.test(n)?(s=y,n=n.replace(s,"")):u.test(n)&&(n+="e"))}if(s=x,s.test(n)){var T=s.exec(n);i=T[1],n=i+"i"}if(s=b,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+t[r])}if(s=E,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+e[r])}if(s=F,a=_,s.test(n)){var T=s.exec(n);i=T[1],s=c,s.test(i)&&(n=i)}else if(a.test(n)){var T=a.exec(n);i=T[1]+T[2],a=c,a.test(i)&&(n=i)}if(s=z,s.test(n)){var T=s.exec(n);i=T[1],s=c,a=f,h=P,(s.test(i)||a.test(i)&&!h.test(i))&&(n=i)}return s=O,a=c,s.test(n)&&a.test(n)&&(s=y,n=n.replace(s,"")),"y"==o&&(n=o.toLowerCase()+n.substr(1)),n};return T}(),t.Pipeline.registerFunction(t.stemmer,"stemmer"),t.generateStopWordFilter=function(t){var e=t.reduce(function(t,e){return t[e]=e,t},{});return function(t){return t&&e[t]!==t?t:void 0}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter"),t.trimmer=function(t){return t.replace(/^\W+/,"").replace(/\W+$/,"")},t.Pipeline.registerFunction(t.trimmer,"trimmer"),t.TokenStore=function(){this.root={docs:{}},this.length=0},t.TokenStore.load=function(t){var e=new this;return e.root=t.root,e.length=t.length,e},t.TokenStore.prototype.add=function(t,e,n){var n=n||this.root,i=t.charAt(0),r=t.slice(1);return i in n||(n[i]={docs:{}}),0===r.length?(n[i].docs[e.ref]=e,void(this.length+=1)):this.add(r,e,n[i])},t.TokenStore.prototype.has=function(t){if(!t)return!1;for(var e=this.root,n=0;n" + title + ""; + container.innerHTML += "

" + getResultBlurb(search_blob[ref].content) + "...


"; + } + } + } else { + container.innerHTML += "
No results found.
"; + } + } + + addContentToIndex(); + window.addEventListener("load", function () { + displaySearchHeading(searchQuery); + displaySearchResults(getRawSearchResults(searchQuery)); + }); + +})(); From 45c63ebfb8952584ee9dc83b72de6f67730eb3b9 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Tue, 10 Apr 2018 10:48:50 -0700 Subject: [PATCH 002/158] removing merge text Merge comments were added when content was updated on master. --- docs/versions.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/versions.md b/docs/versions.md index aae5c3bf8..a4eff325d 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -32,15 +32,9 @@ import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL') -<<<<<<< HEAD -server.version = 2.4 -======= server.version = '2.6' - - ->>>>>>> 87acd20... Update versions.md (#195) ``` ## Supported versions From c8e05d55d35057b3606841aee656c37988a06073 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Wed, 25 Apr 2018 17:06:09 -0700 Subject: [PATCH 003/158] D45 docs v06.1 (partial update) (#290) * Updating dev guide with gh-pages info for docs * Moving the Dev Guide up in the TOC pane * Update dev-guide.md Added Tyler's correction for pycodestyle. --- _includes/docs_menu.html | 15 ++++++++++++--- _layouts/docs.html | 2 +- docs/dev-guide.md | 39 ++++++++++++++++++++++++--------------- 3 files changed, 37 insertions(+), 19 deletions(-) diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index 104a1f5b3..2f5ab1b04 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -22,6 +22,9 @@
  • Samples
    • +
  • + Developer Guide +
  • API Reference
    • -
  • - Developer Guide -
    • diff --git a/_layouts/docs.html b/_layouts/docs.html index 5355f63df..d40bafbdf 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -17,7 +17,7 @@

    {{ page.title }}

    - Edit this page + Edit this page   Submit an issue
    diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 8b47609ce..3a51e86c6 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -8,8 +8,15 @@ This topic describes how to contribute to the Tableau Server Client (Python) pro * TOC {:toc} +--- + ## Submit your first patch + +This section will get you started with the basic workflow, describing how to create your own fork of the repository and how to open a pull request (PR) to add your contributions to the **development** branch. + +### Get the source code and set up your branch + 1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla) 1. Fork the repository. @@ -36,45 +43,47 @@ This topic describes how to contribute to the Tableau Server Client (Python) pro git checkout -b 13-feature-new-stuff ``` -1. Code and commit! +### Code and commit - Here's a quick checklist for ensuring a good pull request: + Here's a quick checklist to follow when coding to ensure a good pull request (PR): - - Only touch the minimal amount of files possible while still accomplishing the goal. + - Only touch the fewest number of files possible while still accomplishing the goal. - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. - - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle .` + - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle server-client-python test samples` - Keep commit messages clean and descriptive. If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message. -1. Add tests. +### Add tests All of our tests live under the `test/` folder in the repository. - We use `unittest` and the built-in test runner `python setup.py test`. - If a test needs a static file, like a twb/twbx, it should live under `test/assets/` + We use `pytest` and the built-in test runner `python setup.py test`. + If a test needs a static file, like a .twb/.twbx, it should live under `test/assets/` -1. Update the documentation. - - Our documentation is written in markdown and built with Jekyll on Github Pages. All of the documentation source files can be found in `docs/docs`. +### Update the documentation When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code. - If you are just making a PR for documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built in `Edit this file` in the Github UI + Our documentation is written in markdown and built with Jekyll on GitHub Pages. All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python) + + If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place. -1. Submit to your fork. +### Commit changes to your fork and open a PR -1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the 'development' branch. +1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the **development** branch for code changes, or against **gh-pages** for documentation updates. 1. Wait for a review and address any feedback. While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able. -1. That's it! When the PR has received :rocket:'s from members of the core team they will merge the PR +1. That's it! When the PR has received ![](https://assets-cdn.github.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR + +--- ## Add new features 1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually - has `get`, `post`, `update`, and `delete` operations that require making the url, creating the XML request if necesssary, + has `get`, `post`, `update`, and `delete` operations that require making the url, creating the XML request if necessary, sending the request, and creating the target item object based on the server response. 1. Create an item class for the new feature, following the structure of the other item classes. Each item has properties From d09420ea1a8f326edf7b721953ba5b2949c2197c Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Mon, 4 Jun 2018 17:47:17 -0700 Subject: [PATCH 004/158] D45 docs v06.1 (#300) * Updating dev guide with gh-pages info for docs * Moving the Dev Guide up in the TOC pane * Update dev-guide.md Added Tyler's correction for pycodestyle. * Updating ref pages from v4.1 to v6.1 * Update dev-guide.md Updated command to: pycodestyle tableauserverclient test samples * Update versions.md updated example to use the more compact and elegant: `use_server_version=True` --- docs/api-ref.md | 747 +++++++++++++++++++++++++++++++++++++++++++--- docs/dev-guide.md | 2 +- docs/versions.md | 20 +- 3 files changed, 730 insertions(+), 39 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index d0ac648d1..9cb3daa06 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -25,6 +25,7 @@ The TSC API reference is organized by resource. The TSC library is modeled after

    +--- ## Authentication @@ -151,7 +152,7 @@ server.auth.sign_out()

    - +--- ## Connections @@ -217,6 +218,8 @@ Source file: models/connection_credentials.py

    +--- + ## Data sources Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. @@ -238,7 +241,9 @@ Name | Description :--- | :--- `connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). `content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. +`created_at` | The date and time when the data source was created. +`certified` | A Boolean value that indicates whether the data source is certified. +`certification_note` | The optional note that describes the certified data source. `datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. `id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. `name` | The name of the data source. If not specified, the name of the published data source file is used. @@ -305,10 +310,10 @@ REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en #### datasources.download ```py -datasources.download(datasource_id, filepath=None, no_extract=False) +datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None) ``` -Downloads the specified data source in `.tdsx` format. +Downloads the specified data source in `.tdsx` or `.hyper` format. REST API: [Download Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Download_Datasource%3FTocPath%3DAPI%2520Reference%7C_____34){:target="_blank"} @@ -318,7 +323,8 @@ Name | Description :--- | :--- `datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. `filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. -`no_extract` | (Optional) Specifies whether to download the file without the extract. When the data source has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. +`include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. +`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. **Exceptions** @@ -329,7 +335,7 @@ Error | Description **Returns** -The file path to the downloaded data source. The data source is downloaded in `.tdsx` format. +The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. **Example** @@ -338,10 +344,10 @@ The file path to the downloaded data source. The data source is downloaded in `. file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') print("\nDownloaded the file to {0}.".format(file_path)) -```` +``` -
    +

    #### datasources.get @@ -365,7 +371,7 @@ Name | Description **Returns** -Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. +Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. @@ -381,12 +387,12 @@ with server.auth.sign_in(tableau_auth): all_datasources, pagination_item = server.datasources.get() print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) print([datasource.name for datasource in all_datasources]) -```` +``` -
    -
    +
    +
    #### datasources.get_by_id @@ -514,7 +520,7 @@ Name | Description `datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). `file_path` | The path and name of the data source to publish. `mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). +`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). @@ -524,7 +530,7 @@ Error | Description :--- | :--- `File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. `Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Only .tds, tdsx, or .tde files can be published as datasources.` | Raises an error if the type of file specified is not supported. +`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. **Returns** @@ -607,8 +613,36 @@ An updated `DatasourceItem`. ``` +
    +
    + +#### datasource.update_connection + +```py +datasource.update_connection(datasource_item, connection_item) +``` + +Updates the server address, port, username, or password for the specified data source connection. + +REST API: [Update Datasource Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Datasource_Connection){:target="_blank"} +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. +`connection_item` | The `connection_item` that has the information you want to update. + + +**Returns** + +An updated `ConnectionItem` for the data source. + +**Example** + +See the `update_connection.py` sample in the Samples directory. +

    @@ -622,7 +656,7 @@ You can use the `Filter` and `RequestOptions` classes to filter and sort the fol - Users - Datasources - Workbooks -- Views +- Views For more information, see [Filter and Sort](filter-sort). @@ -652,6 +686,7 @@ Name | Description

    +--- ## Groups @@ -738,7 +773,7 @@ None. ```py # Adding a user to a group -# +# # get the group item all_groups, pagination_item = server.groups.get() mygroup = all_groups[1] @@ -856,7 +891,7 @@ groups.get(req_options=None) Returns information about the groups on the site. -To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulateusers) method. +To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_on_Site%3FTocPath%3DAPI%2520Reference%7C_____41){:target="_blank"} @@ -889,7 +924,7 @@ Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these # print the names of the first 100 groups for group in all_groups : print(group.name, group.id) -```` +```
    @@ -1011,8 +1046,120 @@ None. The user is removed from the group.

    +--- + +## Jobs + +Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### JobItem class + +```py +JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0) + +``` + +The `JobItem` class contains information about the specified job running on Tableau Server. The `JobItem` class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload. + +Source file: models/job_item.py + +**Attributes** + +Name | Description +:--- | :--- +`id` | The `id` of the job. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Job){:target="_blank"} REST API. +`created_at` | The time the job was created. +`started_at` | The time the job started. +`completed_at` | The time the job finished. +`finish_code` | The return code from job. + + +### Jobs methods +The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +Source files: server/endpoint/jobs_endpoint.py + +
    +
    + + +#### jobs.get + + +```py +jobs.get(job_id) + +``` + +Gets information about the specified job. + +REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Job){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory + + + + +**Exceptions** + +Error | Description +:--- | :--- +`404018 Resource Not Found` | Raises an error if the `job_id` is not found. + + +**Returns** + +Returns the `JobItem` requested. + + +**Example** + +```py +# Query a Job + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('http://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the id of the job from response to extract refresh task, + # or another asynchronous REST API call. + # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" + + + myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' + jobinfo = server.jobs.get(myJobID) + + print(jobinfo) + + # + + + + +``` + + +
    +
    + +--- + ## Projects Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. @@ -1029,7 +1176,7 @@ The project resources for Tableau are defined in the `ProjectItem` class. The cl ```py -ProjectItem(name, description=None, content_permissions=None) +ProjectItem(name, description=None, content_permissions=None, parent_id=None) ``` The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. @@ -1042,6 +1189,7 @@ Name | Description `name` | Name of the project. `description` | The description of the project. `id` | The project id. +`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](http://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. @@ -1050,7 +1198,7 @@ Source file: models/project_item.py #### ProjectItem.ContentPermissions -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"} +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"}. Name | Description :--- | :--- @@ -1091,7 +1239,7 @@ The project methods are based upon the endpoints for projects in the REST API an Source files: server/endpoint/projects_endpoint.py
    -
    +
    #### projects.create @@ -1288,6 +1436,7 @@ Error | Description

    +--- ## Requests @@ -1301,11 +1450,16 @@ You can use the `Sort` and `RequestOptions` classes to filter and sort the follo - Workbooks - Views -For more information, see [Filter and Sort](filter-sort). + +You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. + +For more information about filtering and sorting, see [Filter and Sort](filter-sort). +
    + ### RequestOptions class ```py @@ -1319,7 +1473,7 @@ RequestOptions(pagenumber=1, pagesize=100) Name | Description :--- | :--- -`pagenumber` | The page number of the returned results. The defauilt value is 1. +`pagenumber` | The page number of the returned results. The default value is 1. `pagesize` | The number of items to return with each page (the default value is 100). `sort()` | Returns a iterable set of `Sort` objects. `filter()` | Returns an iterable set of `Filter` objects. @@ -1387,10 +1541,299 @@ Name | Description `Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). + +### ImageRequestOptions class + +```py +ImageRequestOptions(imageresolution=None) + +``` +Use this class to specify the resolution of the view returned as an image. See `views.populate_view`. + +**Attributes** + +Name | Description +:--- | :--- +`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_view` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, get a specific view, etc. + +# set the image request option +image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High) + +# retrieve the image for the view +server.views.populate_image(view_item, image_req_option) + +``` + +### PDFRequestOptions class + +```py +PDFRequestOptions(page_type=None, orientation=None) + +``` +Use this class to specify the format of the PDF that is returned for the view. See `views.populate_pdf`. + +**Attributes** + +Name | Description +:--- | :--- +`page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
    `PageType.A3`
    `PageType.A4`
    `PageType.A5`
    `PageType.B5`
    `PageType.Executive`
    `PageType.Folio`
    `PageType.Ledger`
    `PageType.Legal`
    `PageType.Letter`
    `PageType.Note`
    `PageType.Quarto`
    `PageType.Tabloid` +`orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
    `Orientation.Portrait`
    `Orientation.Landscape` + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, get a specific view, etc. + +# set the PDF request options +pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, orientation=TSC.PDFRequestOptions.Orientation.Landscape) + +# retrieve the PDF for a view +server.views.populate_pdf(view_item, pdf_req_option) + +``` + + +
    +
    + +--- + +## Schedules + +Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### ScheduleItem class + +```py +ScheduleItem(name, priority, schedule_type, execution_order, interval_item) + +``` + +The `ScheduleItem` class contains information about the specified schedule running on Tableau Server. The `ScheduleItem` class defines the information you can query and set. The class members correspond to the attributes of a server response payload. + +Source file: models/schedule_item.py + +**Attributes** + +Name | Description +:--- | :--- +`name` | The `name` of the schedule. +`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. +`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. +`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. +`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. + + +#### IntervalItem class +This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. + +**Attributes** + +Name | Description +:--- | :--- +`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. +`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. +`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. +`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The + + + + +### Schedule methods + +The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. + + +Source files: server/endpoint/schedules_endpoint.py + +#### schedule.create + +```py +schedule.create(schedule_item) +``` +Creates a new schedule for an extract refresh or a subscription. + + +REST API: [Create Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Schedule%3FTocPath%3DAPI%2520Reference%7C_____21){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. + + +**Returns** + +Returns a new instance of `schedule_item`. + +**Exceptions** + +Error | Description +:--- | :--- +`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. + + +**Example** + +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +```

    +#### schedule.delete + +```py +schedule.delete(schedule_id) +``` + +Deletes an existing schedule for an extract refresh or a subscription. + + +REST API: [Delete Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Schedule%3FTocPath%3DAPI%2520Reference%7C_____31){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. + + +**Returns** + +None. + +**Exceptions** + +Error | Description +:--- | :--- +`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. + + +#### schedule.get + +```py +schedule.get([req_options=None]) +``` + +Returns all schedule items from the server. + + +REST API: [Query Schedules](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Schedules%3FTocPath%3DAPI%2520Reference%7C_____65){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . + +#### schedule.update + +
    +
    + + +**Hourly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +``` + +**Daily schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a daily interval to run every day at 12:30AM + Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) + # Create schedule item using daily interval + daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) + # Create daily schedule + daily_schedule = server.schedules.create(daily_schedule) + +``` + +**Weekly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM + weekly_interval = TSC.WeeklyInterval(time(19, 15), + TSC.IntervalItem.Day.Monday, + TSC.IntervalItem.Day.Wednesday, + TSC.IntervalItem.Day.Friday) + # Create schedule item using weekly interval + weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) + # Create weekly schedule + weekly_schedule = server.schedules.create(weekly_schedule) + +``` + +**Monthly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a monthly interval to run on the 15th of every month at 11:30PM + monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), + interval_value=15) + # Create schedule item using monthly interval + monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, + TSC.ScheduleItem.Type.Subscription + TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) + # Create monthly schedule + monthly_schedule = server.schedules.create(monthly_schedule) +``` + + + +
    +
    + +--- + ## Server @@ -1423,13 +1866,18 @@ Attribute | Description ```py import tableauserverclient as TSC + # create a instance of server server = TSC.Server('http://MY-SERVER') +# sign in, etc. -# change the REST API version to 2.5 -server.version = '2.5' +# change the REST API version to match the server +server.use_server_version() +# or change the REST API version to match a specific version +# for example, 2.8 +# server.version = '2.8' ``` @@ -1445,11 +1893,13 @@ Resource | Description *server*.views | Access the server views and methods. See [Views](#views) *server*.users | Access the user resources and methods. See [Users](#users) *server*.sites | Access the sites. See [Sites](#sites) -*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) *server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) *server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) *server*.projects | Access the resources and methods for projects. See [Projects](#projets) *server*.schedules | Access the resources and methods for schedules. See [Schedules](#Schedules) +*server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) *server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfo-class)
    @@ -1472,7 +1922,9 @@ Resource | Description **Example** ```py - + import tableauserverclient as TSC + # login, etc. + print(TSC.Server.PublishMode.Overwrite) # prints 'Overwrite' @@ -1562,6 +2014,7 @@ print("\tBuild number: {0}".format(s_info.build_number))

    +--- ## Sites @@ -1642,7 +2095,7 @@ REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-u Name | Description :--- | :--- -`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass the `create` method. +`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. **Returns** @@ -1702,7 +2155,7 @@ Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these value all_sites, pagination_item = server.sites.get() # print all the site names and ids - for site in TSC.Pager(server.sites): + for site in all_sites): print(site.id, site.name, site.content_url, site.state) @@ -1906,7 +2359,7 @@ server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')

    - +--- ## Sort @@ -1956,8 +2409,228 @@ For information about using the `Sort` class, see [Filter and Sort](filter-sort)

    +--- + +## Subscriptions + +Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions. + +### SubscriptionItem class + +The subscription resources for Tableau Server are defined in the `SubscriptionItem` class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the `SubscriptionItem` class. + +```py +SubscriptionItem(subject, schedule_id, user_id, target) + +``` + +**Attributes** + +Name | Description +:--- | :--- +`id` | The id of the subscription on the site. +`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. +`schedule_id` | The identifier associated with the specific subscription. +`user_id` | The identifier of the user (person) who receives the subscription. +`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. + + + + +Source files: server/endpoints/subscription_item.py + + +### Subscription methods + +The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source files: server/endpoints/subscriptions_endpoint.py + +
    +
    + +#### subscription.create + +```py +subscription.create(subscription_item) +``` +Creates a subscription to a view or workbook for a specific user. +When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. + +To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). + + +REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Subscription%3FTocPath%3DAPI%2520Reference%7C_____23){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. + + +**Returns** + +Returns the new `SubscriptionItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# create auth, specify site +# login, etc. + + +# create the target (content) of the subscription +# in this case, id of the workbook add the target type "workbook" + + target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') + +# the ids for the schedule and user + schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') + user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' + +# create a new SubscriptionItem object. + newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) + +# create the new subscription to the site + newSub = server.subscriptions.create(newSub) + print(newUSub.subject) + +``` + + +
    +
    + + + +#### subscriptions.delete + +```py +subscriptions.delete(subscription_id) +``` + + + +Deletes the specified subscription from the site. + +REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Subscription%3FTocPath%3DAPI%2520Reference%7C_____33){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. + + +**Exceptions** + +Error | Description + :--- | : --- +`Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. + + +**Example** + +```py +# Remove a subscription from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') +# server = TSC.Server('http://SERVERURL') + + + with server.auth.sign_in(tableau_auth): + server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
    +
    + +
    +
    + +#### subscription.get + +```py +subscription.get(req_options=None) +``` +Returns information about the subscriptions on the specified site. + + +REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Subscriptions%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. + + +**Returns** +Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +
    +
    + +#### subscription.get_by_id + + +```py +subscription.get_by_id(subscription_id) +``` + +Returns information about the specified subscription. + +REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Subscription%3FTocPath%3DAPI%2520Reference%7C_____68){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The `subscription_id` specifies the subscription to query. + + + +**Exceptions** + +Error | Description + :--- | : --- +`No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. + + +**Returns** + +The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) + + +**Example** + +```py + sub1 = server.subscription.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(sub1.subject) + +``` + + + +
    +
    + +--- + ## Users Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. @@ -1977,7 +2650,7 @@ The `UserItem` class contains the members or attributes for the view resources o Name | Description :--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for tis attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. `domain_name` | The name of the site. `external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. `id` | The id of the user on the site. @@ -1986,7 +2659,7 @@ Name | Description `email` | The email address of the user. `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest` +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. **Example** @@ -2095,13 +2768,14 @@ with server.auth.sign_in(tableau_auth): all_users, pagination_item = server.users.get() print("\nThere are {} user on site: ".format(pagination_item.total_available)) print([user.name for user in all_users]) -```` +```

    #### users.get_by_id + ```py users.get_by_id(user_id) ``` @@ -2331,7 +3005,7 @@ An updated `UserItem`. See [UserItem class](#useritem-class)
    - +--- ## Views @@ -2379,7 +3053,7 @@ Source file: server/endpoint/views_endpoint.py #### views.get ``` -views.get(req_option=None) +views.get(req_option=None, usage=False) ``` Returns the list of views items for a site. @@ -2392,6 +3066,7 @@ REST API: [Query Views for Site](http://onlinehelp.tableau.com/current/api/rest_ Name | Description :--- | :--- `req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its id. +`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. @@ -2456,7 +3131,7 @@ See [ViewItem class](#viewitem-class)
    - +--- ## Workbooks diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 3a51e86c6..385222054 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -49,7 +49,7 @@ This section will get you started with the basic workflow, describing how to cre - Only touch the fewest number of files possible while still accomplishing the goal. - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. - - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle server-client-python test samples` + - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle tableauserverclient test samples` - Keep commit messages clean and descriptive. If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message. diff --git a/docs/versions.md b/docs/versions.md index a4eff325d..9fd8aae87 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -21,9 +21,21 @@ server = TSC.Server('http://SERVER_URL') print(server.version) ``` -For example, the code might display version `2.3`. +For example, the code might display version `2.3`. -## Use another version of the REST API +## Use the REST API version supported by the server + +To always use the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to, set the version using the `use_server_version()` method. You can do this when you create the server instance by specifying `use_server_version=True` as one of the arguments. + +```py +import tableauserverclient as TSC + +server = TSC.Server('http://SERVER_URL', use_server_version=True) + + +``` + +## Use a specific version of the REST API To use another version of the REST API, set the version like so: @@ -47,3 +59,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |2.4|10.1| |2.5|10.2| |2.6|10.3| +|2.7|10.4| +|2.8|10.5| +|3.0|2018.1| + From aa150644f7f6d1e57bf6281621dd101eb62055de Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Tue, 2 Oct 2018 15:10:18 -0700 Subject: [PATCH 005/158] Update footer.html --- _includes/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/footer.html b/_includes/footer.html index 486c81d22..ee1481e55 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -3,6 +3,6 @@

    This site is open source. Suggestions and pull requests are welcome on our GitHub page.

    -

    © 2016 Tableau.

    +

    © 2018 Tableau.

    From 071efc71dd0a8b14fa0a90cb7cc9e64282bae894 Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Tue, 2 Oct 2018 16:04:23 -0700 Subject: [PATCH 006/158] update link to latest release download zip file The download button on the page was linked to the oldest version, v0.1. Updated link to point to the latest version, v0.7. --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index c0f9a4431..eeceabaf4 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,6 @@ indexed_by_search: false

    The Tableau Server Client is a Python library for the Tableau Server REST API.


    Get Started   - Download + Download From 0ae5477661a11b19aa637a3755ef4402c2cfa0eb Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Wed, 23 Jan 2019 14:26:43 -0800 Subject: [PATCH 007/158] Update api-ref.md (#386) fixed typo in link from *server*.auth to Authentication. --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 9cb3daa06..8cfe1b61e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1889,7 +1889,7 @@ When you create an instance of the `Server` class, you have access to the resour Resource | Description :--- | : --- -*server*.auth | Sets authentication for sign in and sign out. See [Auth](#auththentication) | +*server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | *server*.views | Access the server views and methods. See [Views](#views) *server*.users | Access the user resources and methods. See [Users](#users) *server*.sites | Access the sites. See [Sites](#sites) From 51883e9f5f61a3991c2692d217c35990d4599dee Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 25 Jan 2019 11:04:17 -0800 Subject: [PATCH 008/158] updating docs for view --- docs/api-ref.md | 208 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 177 insertions(+), 31 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 8cfe1b61e..f661768b0 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3009,20 +3009,19 @@ An updated `UserItem`. See [UserItem class](#useritem-class) ## Views -Using the TSC library, you can get all the views on a site, or get the views for a workbook, or populate a view with preview images. -The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API, for example, you can find the name of the view, its id, and the id of the workbook it is associated with. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. +Using the TSC library, you can get information about views in a site or a workbook. +The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class.
    ### ViewItem class ``` -class ViewItem(object) - +ViewItem() ``` -The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. +The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. Source file: models/view_item.py @@ -3030,12 +3029,17 @@ Source file: models/view_item.py Name | Description :--- | :--- +`content_url` | The name of the view as it would appear in a URL. +`csv` | The CSV data of the view. You must first call the [views.populate_csv](#views.populate_csv) method to access the CSV data. `id` | The identifier of the view item. -`name` | The name of the view. -`owner_id` | The id for the owner of the view. -`preview_image` | The thumbnail image for the view. -`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. -`workbook_id` | The id of the workbook associated with the view. +`image` | The image of the view. You must first call the [views.populate_image](#views.populate_image) method to access the image. +`name` | The name of the view. +`owner_id` | The ID for the owner of the view. +`pdf` | The PDF of the view. You must first call the [views.populate_pdf](#views.populate_pdf) method to access the PDF content. +`preview_image` | The thumbnail image for the view. You must first call the [views.populate_preview_image](#views.populate_preview_image) method to access the preview image. +`project_id` | The ID of the project that contains the view. +`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. +`workbook_id` | The ID of the workbook associated with the view.
    @@ -3044,7 +3048,7 @@ Name | Description ### Views methods -The Tableau Server Client provides two methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. +The Tableau Server Client provides methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. Source file: server/endpoint/views_endpoint.py @@ -3053,26 +3057,30 @@ Source file: server/endpoint/views_endpoint.py #### views.get ``` -views.get(req_option=None, usage=False) +views.get(req_options=None, usage=False) ``` -Returns the list of views items for a site. +Returns the list of views items for a site. -REST API: [Query Views for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Views_for_Site%3FTocPath%3DAPI%2520Reference%7C_____64){:target="_blank"} +REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} -**Parameters** +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** Name | Description :--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its id. +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. `usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. **Returns** -Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. +Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. **Example** @@ -3082,10 +3090,17 @@ tableau_auth = TSC.TableauAuth('username', 'password') server = TSC.Server('http://servername') with server.auth.sign_in(tableau_auth): - all_views, pagination_item = server.views.get() - print([view.name for view in all_views]) + all_views, pagination_item = server.views.get() + print([view.name for view in all_views]) +``` -```` +**Example using Pager** + +You can also use the provided Pager generator to get all views on site, without having to page through the results. +```py +for view in TSC.Pager(server.views): + print(view.name) +``` See [ViewItem class](#viewitem-class) @@ -3097,39 +3112,170 @@ See [ViewItem class](#viewitem-class) ```py views.populate_preview_image(view_item) - ``` -Populates a preview image for the specified view. +Populates a preview image for the specified view. -This method gets the preview image (thumbnail) for the specified view item. The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `view.preview_image` for the view. +This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. -REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Preview_Image%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} +REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} -**Parameters** +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** Name | Description :--- | :--- -`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. - +`view_item` | Specified the view to populate. -**Exceptions** + +**Exceptions** Error | Description :--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. +`View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. + - **Returns** -None. The preview image is added to the view. +None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. See [ViewItem class](#viewitem-class)

    +#### views.populate_image + +```py +views.populate_image(view_item, req_options=None) +``` + +Populates the image of the specified view. + +This method uses the `id` field to query the image, and populates the image content as the `image` field. + +REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.5 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The image is added to the `view_item` and can be accessed by its `image` field. + +**Example** + +Creating a request option for high resolution image: +```py +req_options = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High) +server.views.populate_image(view_item, req_options=req_options) +``` + +See [ViewItem class](#viewitem-class) + +
    +
    + +#### views.populate_csv +``` +views.populate_csv(view_item) +``` + +Populates the CSV data of the specified view. + +This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. + +REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. + +See [ViewItem class](#viewitem-class) + +
    +
    + +#### views.populate_pdf +``` +views.populate_pdf(view_item, req_options=None) +``` + +Populates the PDF content of the specified view. + +This method uses the `id` field to query the PDF content, and populates the content as the `pdf` field. + +REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. + +**Example** + +Creating a request option for page type and orientation: +```py +req_options = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A5, + orientation=TSC.PDFRequestOptions.Orientation.Landscape) +server.views.populate_pdf(view_item, req_options=req_options) +``` + +See [ViewItem class](#viewitem-class) + +
    +
    + --- From e1222d14ed208b0f13903237487f90e17149a2fc Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 25 Jan 2019 11:23:13 -0800 Subject: [PATCH 009/158] fixed typos and links --- docs/api-ref.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f661768b0..0c33791f3 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3030,13 +3030,13 @@ Source file: models/view_item.py Name | Description :--- | :--- `content_url` | The name of the view as it would appear in a URL. -`csv` | The CSV data of the view. You must first call the [views.populate_csv](#views.populate_csv) method to access the CSV data. +`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. `id` | The identifier of the view item. -`image` | The image of the view. You must first call the [views.populate_image](#views.populate_image) method to access the image. +`image` | The image of the view. You must first call the `views.populate_image`method to access the image. `name` | The name of the view. `owner_id` | The ID for the owner of the view. -`pdf` | The PDF of the view. You must first call the [views.populate_pdf](#views.populate_pdf) method to access the PDF content. -`preview_image` | The thumbnail image for the view. You must first call the [views.populate_preview_image](#views.populate_preview_image) method to access the preview image. +`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content. +`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image. `project_id` | The ID of the project that contains the view. `total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. `workbook_id` | The ID of the workbook associated with the view. @@ -3128,7 +3128,7 @@ This endpoint is available with REST API version 2.0 and up. Name | Description :--- | :--- -`view_item` | Specified the view to populate. +`view_item` | Specifies the view to populate. **Exceptions** @@ -3169,7 +3169,7 @@ This endpoint is available with REST API version 2.5 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. +`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. See [ImageRequestOptions class](#imagerequestoptions-class) **Exceptions** @@ -3181,14 +3181,6 @@ Error | Description None. The image is added to the `view_item` and can be accessed by its `image` field. -**Example** - -Creating a request option for high resolution image: -```py -req_options = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High) -server.views.populate_image(view_item, req_options=req_options) -``` - See [ViewItem class](#viewitem-class)
    @@ -3250,7 +3242,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. +`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. See [PDFRequestOptions class](#pdfrequestoptions-class) **Exceptions** @@ -3262,15 +3254,6 @@ Error | Description None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. -**Example** - -Creating a request option for page type and orientation: -```py -req_options = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A5, - orientation=TSC.PDFRequestOptions.Orientation.Landscape) -server.views.populate_pdf(view_item, req_options=req_options) -``` - See [ViewItem class](#viewitem-class)
    From 6aec8ba950b7854f70cd2850fb7e8d28683c872a Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 25 Jan 2019 11:27:46 -0800 Subject: [PATCH 010/158] minor fix --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 0c33791f3..3a87733da 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3169,7 +3169,7 @@ This endpoint is available with REST API version 2.5 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. See [ImageRequestOptions class](#imagerequestoptions-class) +`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. **Exceptions** @@ -3242,7 +3242,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. See [PDFRequestOptions class](#pdfrequestoptions-class) +`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. **Exceptions** From 756bef6a7b0c4522b22425d430aa02f02d86bcad Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 25 Jan 2019 14:42:47 -0800 Subject: [PATCH 011/158] added info about view filters --- docs/api-ref.md | 87 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 80 insertions(+), 7 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 3a87733da..21863efd8 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1540,23 +1540,48 @@ Name | Description `Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) `Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). +
    +
    + +### CSVRequestOptions class + +```py +CSVRequestOptions() +``` +Use this class to specify view filters to be applied when the CSV data is generated. See `views.populate_csv`. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('http://MY-SERVER') +# sign in, get a specific view, etc. +# set view filters +csv_req_option = TSC.CSVRequestOptions() +csv_req_option.vf('Region', 'South') +csv_req_option.vf('Category', 'Furniture') + +# retrieve the csv data for the view +server.views.populate_csv(view_item, csv_req_option) +``` ### ImageRequestOptions class ```py ImageRequestOptions(imageresolution=None) - ``` -Use this class to specify the resolution of the view returned as an image. See `views.populate_view`. +Use this class to specify the resolution of the view returned as an image. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. **Attributes** Name | Description :--- | :--- -`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_view` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +**View Filters** +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the image is generated, the specified filters will be applied to the view. **Example** @@ -1568,6 +1593,9 @@ Name | Description # set the image request option image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High) +# (optional) set a view filter +image_req_option.vf('Category', 'Furniture') + # retrieve the image for the view server.views.populate_image(view_item, image_req_option) @@ -1577,7 +1605,6 @@ server.views.populate_image(view_item, image_req_option) ```py PDFRequestOptions(page_type=None, orientation=None) - ``` Use this class to specify the format of the PDF that is returned for the view. See `views.populate_pdf`. @@ -1588,6 +1615,8 @@ Name | Description `page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
    `PageType.A3`
    `PageType.A4`
    `PageType.A5`
    `PageType.B5`
    `PageType.Executive`
    `PageType.Folio`
    `PageType.Ledger`
    `PageType.Legal`
    `PageType.Letter`
    `PageType.Note`
    `PageType.Quarto`
    `PageType.Tabloid` `orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
    `Orientation.Portrait`
    `Orientation.Landscape` +**View Filters** +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. **Example** @@ -1599,6 +1628,9 @@ Name | Description # set the PDF request options pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, orientation=TSC.PDFRequestOptions.Orientation.Landscape) +# (optional) set a view filter +pdf_req_option.vf('Region', 'West') + # retrieve the PDF for a view server.views.populate_pdf(view_item, pdf_req_option) @@ -3138,11 +3170,20 @@ Error | Description `View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. - **Returns** None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the preview image as 'view_preview_image.png' +server.views.populate_preview_image(view_item) +with open('./view_preview_image.png', 'wb') as f: + f.write(view_item.preview_image) +``` + See [ViewItem class](#viewitem-class)
    @@ -3169,7 +3210,7 @@ This endpoint is available with REST API version 2.5 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. +`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. **Exceptions** @@ -3181,6 +3222,16 @@ Error | Description None. The image is added to the `view_item` and can be accessed by its `image` field. +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view image as 'view_image.png' +server.views.populate_image(view_item) +with open('./view_image.png', 'wb') as f: + f.write(view_item.image) +``` + See [ViewItem class](#viewitem-class)
    @@ -3206,6 +3257,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in a request object to specify view filters to be applied when the CSV data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. **Exceptions** @@ -3217,6 +3269,17 @@ Error | Description None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the CSV data as 'view_csv.csv' +server.views.populate_csv(view_item) +with open('./view_csv.csv', 'wb') as f: + # Perform byte join on the CSV data + f.write(b''.join(view_item.csv)) +``` + See [ViewItem class](#viewitem-class)
    @@ -3242,7 +3305,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. **Exceptions** @@ -3254,6 +3317,16 @@ Error | Description None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view pdf as 'view_pdf.pdf' +server.views.populate_pdf(view_item) +with open('./view_pdf.pdf', 'wb') as f: + f.write(view_item.pdf) +``` + See [ViewItem class](#viewitem-class)
    From 85d6cf263319fe001a864fb33a047df46f9c679b Mon Sep 17 00:00:00 2001 From: jsonhuff <47429419+jsonhuff@users.noreply.github.com> Date: Fri, 15 Feb 2019 15:22:59 -0800 Subject: [PATCH 012/158] Updated API versions for Tableau Server (#395) The API versions from 2018.2 and 2018.3 are taken from the REST API XML Schema doc: https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_schema.htm - Version 3.2 (Tableau Server 2018.3): ts-api_3_2.xsd - Version 3.1 (Tableau Server 2018.2): ts-api_3_1.xsd --- docs/versions.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/versions.md b/docs/versions.md index 9fd8aae87..2519b5b80 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -62,4 +62,5 @@ The current version of TSC only supports the following REST API and Tableau Serv |2.7|10.4| |2.8|10.5| |3.0|2018.1| - +|3.1|2018.2| +|3.2|2018.3| From 0d6ffdef23748c910aa93fb4a0f0d714c22e02d9 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Wed, 20 Feb 2019 08:25:49 -0800 Subject: [PATCH 013/158] Adding 2019.1 (v3.3) to docs --- docs/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions.md b/docs/versions.md index 2519b5b80..648945d7a 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -64,3 +64,4 @@ The current version of TSC only supports the following REST API and Tableau Serv |3.0|2018.1| |3.1|2018.2| |3.2|2018.3| +|3.3|2019.1| From e24efdfe332234261c70dddb4e84868a185dfbd7 Mon Sep 17 00:00:00 2001 From: Jared Dominguez Date: Wed, 13 Mar 2019 17:44:42 -0700 Subject: [PATCH 014/158] [Security] Fix DOM XSS vulnerability in search --- js/search.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/js/search.js b/js/search.js index 76b0b6ea0..b73e673de 100644 --- a/js/search.js +++ b/js/search.js @@ -23,7 +23,7 @@ function displaySearchHeading(query) { var heading = document.getElementById("searchHeading"); - heading.innerHTML = "Search results for: " + query; + heading.textContent = "Search results for: " + query; } // Get the raw search results From ad51790d6880c252983e5188bcd8e70e855d3cc1 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Mon, 8 Apr 2019 12:31:39 -0700 Subject: [PATCH 015/158] Fix misspelled anchors under the Server resource page (#410) Addressing PR #410: Fix the projects anchor under the Server resource page. Also fixed schedules and serverinfoitem-class anchors that were misspelled. --- docs/api-ref.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 21863efd8..b218117da 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1929,10 +1929,10 @@ Resource | Description *server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) *server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) *server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) -*server*.projects | Access the resources and methods for projects. See [Projects](#projets) -*server*.schedules | Access the resources and methods for schedules. See [Schedules](#Schedules) +*server*.projects | Access the resources and methods for projects. See [Projects](#projects) +*server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) *server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) -*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfo-class) +*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class)

    From d476a782a3e81993597c5f0d3c78e40f92d1eb9f Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Sat, 11 May 2019 11:44:22 +0900 Subject: [PATCH 016/158] Https link --- _includes/header.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/header.html b/_includes/header.html index 106578dfc..a42240f87 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -19,7 +19,7 @@
    From d7ebbe30a63cc388203ac2ab6c91b0dc876eb2a7 Mon Sep 17 00:00:00 2001 From: Dan Zucker Date: Thu, 13 Jun 2019 18:26:02 -0700 Subject: [PATCH 017/158] Fixing links to REST API reference pages in api-ref.md --- docs/api-ref.md | 116 ++++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index b218117da..ea8e24a89 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. |:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#API_Reference%3FTocPath%3DAPI%2520Reference%7C_____0){:target="_blank"}.| +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| @@ -90,7 +90,7 @@ Signs you in to Tableau Server. The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign In](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Sign_In%3FTocPath%3DAPI%2520Reference%7C_____77){:target="_blank"} +REST API: [Sign In](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} **Parameters** @@ -131,7 +131,7 @@ Signs you out of the current session. The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign Out](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Sign_Out%3FTocPath%3DAPI%2520Reference%7C_____78){:target="_blank"} +REST API: [Sign Out](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} **Example** @@ -301,7 +301,7 @@ Error | Description `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. -REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Datasource%3FTocPath%3DAPI%2520Reference%7C_____19){:target="_blank"} +REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"}

    @@ -315,7 +315,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr ``` Downloads the specified data source in `.tdsx` or `.hyper` format. -REST API: [Download Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Download_Datasource%3FTocPath%3DAPI%2520Reference%7C_____34){:target="_blank"} +REST API: [Download Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} **Parameters** @@ -360,7 +360,7 @@ Returns all the data sources for the site. To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) -REST API: [Query Datasources](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasources%3FTocPath%3DAPI%2520Reference%7C_____49){:target="_blank"} +REST API: [Query Datasources](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} **Parameters** @@ -403,7 +403,7 @@ datasources.get_by_id(datasource_id) Returns the specified data source item. -REST API: [Query Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource%3FTocPath%3DAPI%2520Reference%7C_____46){:target="_blank"} +REST API: [Query Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} **Parameters** @@ -450,7 +450,7 @@ Populates the connections for the specified data source. This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. -REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource_Connections%3FTocPath%3DAPI%2520Reference%7C_____47){:target="_blank"} +REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} **Parameters** @@ -511,7 +511,7 @@ Publishes a data source to a server, or appends data to an existing data source. This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. -REST API: [Publish Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Datasource%3FTocPath%3DAPI%2520Reference%7C_____44){:target="_blank"} +REST API: [Publish Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} **Parameters** @@ -572,7 +572,7 @@ datasource.update(datasource_item) Updates the owner, or project of the specified data source. -REST API: [Update Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Datasource%3FTocPath%3DAPI%2520Reference%7C_____79){:target="_blank"} +REST API: [Update Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} **Parameters** @@ -624,7 +624,7 @@ datasource.update_connection(datasource_item, connection_item) Updates the server address, port, username, or password for the specified data source connection. -REST API: [Update Datasource Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Datasource_Connection){:target="_blank"} +REST API: [Update Datasource Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} **Parameters** @@ -752,7 +752,7 @@ groups.add_user(group_item, user_id): Adds a user to the specified group. -REST API [Add User to Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Add_User_to_Group%3FTocPath%3DAPI%2520Reference%7C_____8){:target="_blank"} +REST API [Add User to Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} **Parameters** @@ -799,7 +799,7 @@ create(group_item) Creates a new group in Tableau Server. -REST API: [Create Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Group%3FTocPath%3DAPI%2520Reference%7C_____14){:target="_blank"} +REST API: [Create Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} **Parameters** @@ -849,7 +849,7 @@ groups.delete(group_id) Deletes the group on the site. -REST API: [Delete Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Site%3FTocPath%3DAPI%2520Reference%7C_____74){:target="_blank"} +REST API: [Delete Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} **Parameters** @@ -894,7 +894,7 @@ Returns information about the groups on the site. To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. -REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_on_Site%3FTocPath%3DAPI%2520Reference%7C_____41){:target="_blank"} +REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} **Parameters** @@ -939,7 +939,7 @@ groups.populate_users(group_item, req_options=None) Populates the `group_item` with the list of users. -REST API: [Get Users in Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_in_Group){:target="_blank"} +REST API: [Get Users in Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} **Parameters** @@ -1000,7 +1000,7 @@ Removes a user from a group. -REST API: [Remove User from Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Group%3FTocPath%3DAPI%2520Reference%7C_____73){:target="_blank"} +REST API: [Remove User from Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} **Parameters** @@ -1073,7 +1073,7 @@ Source file: models/job_item.py Name | Description :--- | :--- `id` | The `id` of the job. -`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Job){:target="_blank"} REST API. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. `created_at` | The time the job was created. `started_at` | The time the job started. `completed_at` | The time the job finished. @@ -1102,7 +1102,7 @@ jobs.get(job_id) Gets information about the specified job. -REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Job){:target="_blank"} +REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} **Parameters** @@ -1198,7 +1198,7 @@ Source file: models/project_item.py #### ProjectItem.ContentPermissions -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"}. +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. Name | Description :--- | :--- @@ -1254,7 +1254,7 @@ Creates a project on the specified site. To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Create Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Project%3FTocPath%3DAPI%2520Reference%7C_____15){:target="_blank"} +REST API: [Create Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} **Parameters** @@ -1299,7 +1299,7 @@ Return a list of project items for a site. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Query Projects](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Projects%3FTocPath%3DAPI%2520Reference%7C_____55){:target="_blank"} +REST API: [Query Projects](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} **Parameters** @@ -1340,7 +1340,7 @@ Modify the project settings. You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Update Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Project%3FTocPath%3DAPI%2520Reference%7C_____82){:target="_blank"} +REST API: [Update Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} **Parameters** @@ -1402,7 +1402,7 @@ Deletes a project by ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Project%3FTocPath%3DAPI%2520Reference%7C_____24){:target="_blank"} +REST API: [Delete Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} **Parameters** @@ -1485,7 +1485,7 @@ Name | Description #### RequestOptions.Field class -The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_filtering_and_sorting.htm%3FTocPath%3DConcepts%7C_____7){:target="_blank"} in the Tableau REST API. +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. **Attributes** @@ -1703,7 +1703,7 @@ schedule.create(schedule_item) Creates a new schedule for an extract refresh or a subscription. -REST API: [Create Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Schedule%3FTocPath%3DAPI%2520Reference%7C_____21){:target="_blank"} +REST API: [Create Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} @@ -1752,7 +1752,7 @@ schedule.delete(schedule_id) Deletes an existing schedule for an extract refresh or a subscription. -REST API: [Delete Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Schedule%3FTocPath%3DAPI%2520Reference%7C_____31){:target="_blank"} +REST API: [Delete Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} @@ -1783,7 +1783,7 @@ schedule.get([req_options=None]) Returns all schedule items from the server. -REST API: [Query Schedules](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Schedules%3FTocPath%3DAPI%2520Reference%7C_____65){:target="_blank"} +REST API: [Query Schedules](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} @@ -1889,7 +1889,7 @@ The `Server` class contains the attributes that represent the server on Tableau Attribute | Description :--- | :--- `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `http://MY-SERVER/`). -`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_versions.htm){:target="_blank"} +`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} @@ -2011,7 +2011,7 @@ Retrieve the build and version information for the server. This method makes an unauthenticated call, so no sign in or authentication token is required. -REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Server_Info%3FTocPath%3DAPI%2520Reference%7C_____76){:target="_blank"} +REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} **Parameters** None @@ -2119,7 +2119,7 @@ Creates a new site on the server for the specified site item object. Tableau Server only. -REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Site%3FTocPath%3DAPI%2520Reference%7C_____17){:target="_blank"} +REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} @@ -2164,7 +2164,7 @@ sites.get() Queries all the sites on the server. -REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Sites%3FTocPath%3DAPI%2520Reference%7C_____58){:target="_blank"} +REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} **Parameters** @@ -2207,7 +2207,7 @@ sites.get_by_id(site_id) Queries the site with the given ID. -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Site){:target="_blank"} +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} **Parameters** @@ -2253,7 +2253,7 @@ sites.get_by_name(site_name) Queries the site with the specified name. -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Site){:target="_blank"} +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} **Parameters** @@ -2304,7 +2304,7 @@ Modifies the settings for site. The site item object must include the site ID and overrides all other settings. -REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Site%3FTocPath%3DAPI%2520Reference%7C_____84){:target="_blank"} +REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} **Parameters** @@ -2357,7 +2357,7 @@ Sites.delete(site_id) Deletes the specified site. -REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Site%3FTocPath%3DAPI%2520Reference%7C_____27){:target="_name"} +REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} **Parameters** @@ -2494,7 +2494,7 @@ When a user is subscribed to the content, Tableau Server sends the content to th To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). -REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Create_Subscription%3FTocPath%3DAPI%2520Reference%7C_____23){:target="_blank"} +REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} **Parameters** @@ -2553,7 +2553,7 @@ subscriptions.delete(subscription_id) Deletes the specified subscription from the site. -REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Subscription%3FTocPath%3DAPI%2520Reference%7C_____33){:target="_blank"} +REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} **Parameters** @@ -2598,7 +2598,7 @@ subscription.get(req_options=None) Returns information about the subscriptions on the specified site. -REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Subscriptions%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} +REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} **Parameters** @@ -2623,7 +2623,7 @@ subscription.get_by_id(subscription_id) Returns information about the specified subscription. -REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Subscription%3FTocPath%3DAPI%2520Reference%7C_____68){:target="_blank"} +REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} **Parameters** @@ -2731,7 +2731,7 @@ Adds the user to the site. To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. -REST API: [Add User to Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Add_User_to_Site%3FTocPath%3DAPI%2520Reference%7C_____9){:target="_blank"} +REST API: [Add User to Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} **Parameters** @@ -2774,7 +2774,7 @@ Returns information about the users on the specified site. To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. -REST API: [Get Users on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Get_Users_on_Site%3FTocPath%3DAPI%2520Reference%7C_____41){:target="_blank"} +REST API: [Get Users on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} **Parameters** @@ -2814,7 +2814,7 @@ users.get_by_id(user_id) Returns information about the specified user. -REST API: [Query User On Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_User_On_Site%3FTocPath%3DAPI%2520Reference%7C_____61){:target="_blank"} +REST API: [Query User On Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} **Parameters** @@ -2873,7 +2873,7 @@ Returns information about the workbooks that the specified user owns and has Rea This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). -REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Datasource_Connections%3FTocPath%3DAPI%2520Reference%7C_____47){:target="_blank"} +REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} **Parameters** @@ -2930,7 +2930,7 @@ users.remove(user_id) Removes the specified user from the site. -REST API: [Remove User from Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Remove_User_from_Site%3FTocPath%3DAPI%2520Reference%7C_____74){:target="_blank"} +REST API: [Remove User from Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} **Parameters** @@ -2974,11 +2974,11 @@ users.update(user_item, password=None) Updates information about the specified user. -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_User%3FTocPath%3DAPI%2520Reference%7C_____86){:target="_blank"}. +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. -REST API: [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_User%3FTocPath%3DAPI%2520Reference%7C_____86){:target="_blank"} +REST API: [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} **Parameters** @@ -3425,7 +3425,7 @@ Queries the server and returns information about the workbooks the site. -REST API: [Query Workbooks for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbooks_for_Site%3FTocPath%3DAPI%2520Reference%7C_____70){:target="_blank"} +REST API: [Query Workbooks for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} **Parameters** @@ -3470,7 +3470,7 @@ workbooks.get_by_id(workbook_id) Returns information about the specified workbook on the site. -REST API: [Query Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook%3FTocPath%3DAPI%2520Reference%7C_____66){:target="_blank"} +REST API: [Query Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} **Parameters** @@ -3521,7 +3521,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. -REST API: [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Workbook%3FTocPath%3DAPI%2520Reference%7C_____45){:target="_blank"}, [Initiate File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Initiate_File_Upload%3FTocPath%3DAPI%2520Reference%7C_____43){:target="_blank"}, [Append to File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Append_to_File_Upload%3FTocPath%3DAPI%2520Reference%7C_____13){:target="_blank"} +REST API: [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} @@ -3545,7 +3545,7 @@ Error | Description `Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. `Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. -See the REST API [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Publish_Workbook%3FTocPath%3DAPI%2520Reference%7C_____45){:target="_blank"} for additional error codes. +See the REST API [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. **Returns** @@ -3580,7 +3580,7 @@ workbooks.update(workbook_item) Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. -REST API: [Update Workbooks](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Workbook%3FTocPath%3DAPI%2520Reference%7C_____87){:target="_blank"} +REST API: [Update Workbooks](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} **Parameters** @@ -3638,7 +3638,7 @@ Deletes a workbook with the specified ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Delete_Workbook%3FTocPath%3DAPI%2520Reference%7C_____31){:target="_blank"} +REST API: [Delete Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} **Parameters** @@ -3682,7 +3682,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False) Downloads a workbook to the specified directory (optional). -REST API: [Download Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Download_Workbook%3FTocPath%3DAPI%2520Reference%7C_____36){:target="_blank"} +REST API: [Download Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} **Parameters** @@ -3733,7 +3733,7 @@ You must first call this method to populate views before you can iterate through This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. -REST API: [Query Views for Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Views_for_Workbook%3FTocPath%3DAPI%2520Reference%7C_____65){:target="_blank"} +REST API: [Query Views for Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} **Parameters** @@ -3796,7 +3796,7 @@ connections. This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. -REST API: [Query Workbook Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Connections%3FTocPath%3DAPI%2520Reference%7C_____67){:target="_blank"} +REST API: [Query Workbook Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} **Parameters** @@ -3858,7 +3858,7 @@ This method gets the preview image (thumbnail) for the specified workbook item. The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. -REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Query_Workbook_Preview_Image%3FTocPath%3DAPI%2520Reference%7C_____69){:target="_blank"} +REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} **Parameters** @@ -3911,7 +3911,7 @@ Updates a workbook connection information (server address, server port, user nam The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) -REST API: [Update Workbook Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_ref.htm#Update_Workbook_Connection%3FTocPath%3DAPI%2520Reference%7C_____88){:target="_blank"} +REST API: [Update Workbook Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} **Parameters** From 73d7755a9debf1e20e3883b7a564b8a04ce10e82 Mon Sep 17 00:00:00 2001 From: Dan Zucker Date: Thu, 13 Jun 2019 18:32:48 -0700 Subject: [PATCH 018/158] convert http: to https globally --- docs/api-ref.md | 170 ++++++++++++++++++++++++------------------------ 1 file changed, 85 insertions(+), 85 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index ea8e24a89..63412f95e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. |:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| @@ -90,7 +90,7 @@ Signs you in to Tableau Server. The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign In](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} +REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} **Parameters** @@ -106,7 +106,7 @@ import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # create an instance for your server -server = TSC.Server('http://SERVER_URL') +server = TSC.Server('https://SERVER_URL') # call the sign-in method with the auth object server.auth.sign_in(tableau_auth) @@ -131,7 +131,7 @@ Signs you out of the current session. The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign Out](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} +REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} **Example** @@ -301,7 +301,7 @@ Error | Description `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. -REST API: [Delete Datasource](http://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} +REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"}

    @@ -315,7 +315,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr ``` Downloads the specified data source in `.tdsx` or `.hyper` format. -REST API: [Download Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} +REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} **Parameters** @@ -360,7 +360,7 @@ Returns all the data sources for the site. To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) -REST API: [Query Datasources](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} +REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} **Parameters** @@ -381,7 +381,7 @@ Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('http://SERVERURL') +server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): all_datasources, pagination_item = server.datasources.get() @@ -403,7 +403,7 @@ datasources.get_by_id(datasource_id) Returns the specified data source item. -REST API: [Query Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} +REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} **Parameters** @@ -450,7 +450,7 @@ Populates the connections for the specified data source. This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. -REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} +REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} **Parameters** @@ -478,7 +478,7 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour ```py # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # ... @@ -511,7 +511,7 @@ Publishes a data source to a server, or appends data to an existing data source. This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. -REST API: [Publish Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} +REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} **Parameters** @@ -543,7 +543,7 @@ The `DatasourceItem` for the data source that was added or appended to. ```py import tableauserverclient as TSC - server = TSC.Server('http://SERVERURL') + server = TSC.Server('https://SERVERURL') ... @@ -572,7 +572,7 @@ datasource.update(datasource_item) Updates the owner, or project of the specified data source. -REST API: [Update Datasource](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} +REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} **Parameters** @@ -598,7 +598,7 @@ An updated `DatasourceItem`. ```py # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # sign in ... # get the data source item to update @@ -624,7 +624,7 @@ datasource.update_connection(datasource_item, connection_item) Updates the server address, port, username, or password for the specified data source connection. -REST API: [Update Datasource Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} +REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} **Parameters** @@ -752,7 +752,7 @@ groups.add_user(group_item, user_id): Adds a user to the specified group. -REST API [Add User to Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} +REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} **Parameters** @@ -799,7 +799,7 @@ create(group_item) Creates a new group in Tableau Server. -REST API: [Create Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} +REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} **Parameters** @@ -823,7 +823,7 @@ Adds new `GroupItem`. # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # create a new instance with the group name @@ -849,7 +849,7 @@ groups.delete(group_id) Deletes the group on the site. -REST API: [Delete Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} +REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} **Parameters** @@ -873,7 +873,7 @@ Error | Description # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') @@ -894,7 +894,7 @@ Returns information about the groups on the site. To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. -REST API: [Get Uers on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} +REST API: [Get Uers on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} **Parameters** @@ -914,7 +914,7 @@ Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these ```py # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): @@ -939,7 +939,7 @@ groups.populate_users(group_item, req_options=None) Populates the `group_item` with the list of users. -REST API: [Get Users in Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} +REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} **Parameters** @@ -965,7 +965,7 @@ None. A list of `UserItem` objects are added to the group (`group_item.users`). ```py # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # ... @@ -1000,7 +1000,7 @@ Removes a user from a group. -REST API: [Remove User from Group](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} +REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} **Parameters** @@ -1031,7 +1031,7 @@ None. The user is removed from the group. # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): @@ -1133,7 +1133,7 @@ Returns the `JobItem` requested. # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): @@ -1189,7 +1189,7 @@ Name | Description `name` | Name of the project. `description` | The description of the project. `id` | The project id. -`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](http://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. +`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. @@ -1198,7 +1198,7 @@ Source file: models/project_item.py #### ProjectItem.ContentPermissions -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. Name | Description :--- | :--- @@ -1210,7 +1210,7 @@ Name | Description ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc @@ -1254,7 +1254,7 @@ Creates a project on the specified site. To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Create Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} +REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} **Parameters** @@ -1273,7 +1273,7 @@ Returns the new project item. ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('http://SERVER') +server = TSC.Server('https://SERVER') with server.auth.sign_in(tableau_auth): # create project item @@ -1299,7 +1299,7 @@ Return a list of project items for a site. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Query Projects](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} +REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} **Parameters** @@ -1317,7 +1317,7 @@ Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these va ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('http://SERVER') +server = TSC.Server('https://SERVER') with server.auth.sign_in(tableau_auth): # get all projects on site @@ -1340,7 +1340,7 @@ Modify the project settings. You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Update Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} +REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} **Parameters** @@ -1366,7 +1366,7 @@ See [ProjectItem class](#projectitem-class) ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc ... @@ -1402,7 +1402,7 @@ Deletes a project by ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Project](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} +REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} **Parameters** @@ -1425,7 +1425,7 @@ Error | Description ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc. server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') @@ -1485,7 +1485,7 @@ Name | Description #### RequestOptions.Field class -The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. **Attributes** @@ -1554,7 +1554,7 @@ Use this class to specify view filters to be applied when the CSV data is genera ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, get a specific view, etc. # set view filters @@ -1587,7 +1587,7 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, get a specific view, etc. # set the image request option @@ -1622,7 +1622,7 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, get a specific view, etc. # set the PDF request options @@ -1703,7 +1703,7 @@ schedule.create(schedule_item) Creates a new schedule for an extract refresh or a subscription. -REST API: [Create Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} +REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} @@ -1752,7 +1752,7 @@ schedule.delete(schedule_id) Deletes an existing schedule for an extract refresh or a subscription. -REST API: [Delete Schedule](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} +REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} @@ -1783,7 +1783,7 @@ schedule.get([req_options=None]) Returns all schedule items from the server. -REST API: [Query Schedules](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} +REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} @@ -1869,7 +1869,7 @@ import tableauserverclient as TSC ## Server -In the Tableau REST API, the server (`http://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) +In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. @@ -1888,7 +1888,7 @@ The `Server` class contains the attributes that represent the server on Tableau Attribute | Description :--- | :--- -`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `http://MY-SERVER/`). +`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} @@ -1900,7 +1900,7 @@ import tableauserverclient as TSC # create a instance of server -server = TSC.Server('http://MY-SERVER') +server = TSC.Server('https://MY-SERVER') # sign in, etc. @@ -2028,7 +2028,7 @@ Error | Description import tableauserverclient as TSC # create a instance of server -server = TSC.Server('http://MY-SERVER') +server = TSC.Server('https://MY-SERVER') # set the version number > 2.3 # the server_info.get() method works in 2.4 and later @@ -2141,7 +2141,7 @@ Returns a new instance of `SiteItem`. import tableauserverclient as TSC # create an instance of server -server = TSC.Server('http://MY-SERVER') +server = TSC.Server('https://MY-SERVER') # create shortcut for admin mode content_users=TSC.SiteItem.AdminMode.ContentAndUsers @@ -2180,7 +2180,7 @@ Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these value ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc. # query the sites @@ -2233,7 +2233,7 @@ Returns the `SiteItem`. ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc. a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') @@ -2279,7 +2279,7 @@ Returns the `SiteItem`. ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc. a_site = server.sites.get_by_name('MY_SITE') @@ -2381,7 +2381,7 @@ Error | Description ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # sign in, etc. server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') @@ -2577,7 +2577,7 @@ Error | Description # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): @@ -2731,7 +2731,7 @@ Adds the user to the site. To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. -REST API: [Add User to Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} +REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} **Parameters** @@ -2774,7 +2774,7 @@ Returns information about the users on the specified site. To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. -REST API: [Get Users on Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} +REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} **Parameters** @@ -2794,7 +2794,7 @@ Returns a list of `UserItem` objects and a `PaginationItem` object. Use these v ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('http://SERVERURL') +server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): all_users, pagination_item = server.users.get() @@ -2814,7 +2814,7 @@ users.get_by_id(user_id) Returns information about the specified user. -REST API: [Query User On Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} +REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} **Parameters** @@ -2873,7 +2873,7 @@ Returns information about the workbooks that the specified user owns and has Rea This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). -REST API: [Query Datasource Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} +REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} **Parameters** @@ -2930,7 +2930,7 @@ users.remove(user_id) Removes the specified user from the site. -REST API: [Remove User from Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} +REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} **Parameters** @@ -2954,7 +2954,7 @@ Error | Description # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') @@ -2974,11 +2974,11 @@ users.update(user_item, password=None) Updates information about the specified user. -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. -REST API: [Update User](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} +REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} **Parameters** @@ -3007,7 +3007,7 @@ An updated `UserItem`. See [UserItem class](#useritem-class) # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): @@ -3119,7 +3119,7 @@ Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these value ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password') -server = TSC.Server('http://servername') +server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): all_views, pagination_item = server.views.get() @@ -3425,7 +3425,7 @@ Queries the server and returns information about the workbooks the site. -REST API: [Query Workbooks for Site](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} +REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} **Parameters** @@ -3446,7 +3446,7 @@ Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these v import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('http://servername') +server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): all_workbooks, pagination_item = server.workbooks.get() @@ -3470,7 +3470,7 @@ workbooks.get_by_id(workbook_id) Returns information about the specified workbook on the site. -REST API: [Query Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} +REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} **Parameters** @@ -3521,7 +3521,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. -REST API: [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} +REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} @@ -3545,7 +3545,7 @@ Error | Description `Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. `Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. -See the REST API [Publish Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. +See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. **Returns** @@ -3558,7 +3558,7 @@ The `WorkbookItem` for the workbook that was published. import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('http://servername') +server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): # create a workbook item @@ -3580,7 +3580,7 @@ workbooks.update(workbook_item) Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. -REST API: [Update Workbooks](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} +REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} **Parameters** @@ -3600,7 +3600,7 @@ Error | Description import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('http://servername') +server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): @@ -3638,7 +3638,7 @@ Deletes a workbook with the specified ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} +REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} **Parameters** @@ -3661,7 +3661,7 @@ Error | Description ```py # import tableauserverclient as TSC -# server = TSC.Server('http://MY-SERVER') +# server = TSC.Server('https://MY-SERVER') # tableau_auth sign in, etc. server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') @@ -3682,7 +3682,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False) Downloads a workbook to the specified directory (optional). -REST API: [Download Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} +REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} **Parameters** @@ -3733,7 +3733,7 @@ You must first call this method to populate views before you can iterate through This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. -REST API: [Query Views for Workbook](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} +REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} **Parameters** @@ -3761,7 +3761,7 @@ None. A list of `ViewItem` objects are added to the workbook (`workbook_item.vie ```py # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # ... @@ -3796,7 +3796,7 @@ connections. This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. -REST API: [Query Workbook Connections](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} +REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} **Parameters** @@ -3824,7 +3824,7 @@ None. A list of `ConnectionItem` objects are added to the data source (`workbook ```py # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') # ... @@ -3858,7 +3858,7 @@ This method gets the preview image (thumbnail) for the specified workbook item. The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. -REST API: [Query View Preview Image](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} +REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} **Parameters** @@ -3888,7 +3888,7 @@ None. The preview image is added to the view. # import tableauserverclient as TSC -# server = TSC.Server('http://SERVERURL') +# server = TSC.Server('https://SERVERURL') ... @@ -3911,7 +3911,7 @@ Updates a workbook connection information (server address, server port, user nam The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) -REST API: [Update Workbook Connection](http://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} +REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} **Parameters** From f4bcafe612d8e779779382966b0f35dbf9d7ef5c Mon Sep 17 00:00:00 2001 From: Irwin Dolobowsky Date: Fri, 2 Aug 2019 18:17:31 +0000 Subject: [PATCH 019/158] Update api-ref.md Updating datasource.update to be an update to ownerID instead of name as data sources can't be renamed. Also added a note that name cannot be changed in teh description. --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 63412f95e..4be763c53 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -570,7 +570,7 @@ The `DatasourceItem` for the data source that was added or appended to. datasource.update(datasource_item) ``` -Updates the owner, or project of the specified data source. +Updates the owner or project of the specified data source. Data source name cannot be updated. REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} @@ -605,7 +605,7 @@ An updated `DatasourceItem`. datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') # do some updating - datasource.name = 'New Name' + datasource.owner_id = 'New Owner ID' # call the update method with the data source item updated_datasource = server.datasources.update(datasource) From 8b6747e37d1347e4acb129501977aaa1ec4a741d Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 5 Aug 2019 10:29:36 -0700 Subject: [PATCH 020/158] Update api-ref.md Fix site.get() code sample - remove extraneous ")" ```for site in all_sites):``` to ```for site in all_sites:``` --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 4be763c53..7915017df 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2187,7 +2187,7 @@ Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these value all_sites, pagination_item = server.sites.get() # print all the site names and ids - for site in all_sites): + for site in all_sites: print(site.id, site.name, site.content_url, site.state) From 9f42a46afd979d9335e92c6e6c8ee9f6576f774f Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Tue, 6 Aug 2019 14:06:13 -0700 Subject: [PATCH 021/158] Update sign-in-out.md Revised page to address Issue #355 (add site specification on sign in) --- docs/sign-in-out.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index f619aaeab..61a7e29ac 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -3,28 +3,32 @@ title: Sign In and Out layout: docs --- -To sign in and out of Tableau Server, call the `Auth.sign_in` and `Auth.sign_out` functions like so: +To sign in and out of Tableau Server, call the server's `.auth.signin` method in a`with` block. ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('http://SERVER_URL') +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', `SITENAME`) +server = TSC.Server('https://SERVER_URL') -server.auth.sign_in(tableau_auth) +with server.auth.sign_in(tableau_auth): + # Do awesome things here! +``` -# Do awesome things here! +The `SERVER_URL` is the URL of the Tableau server without subpaths. For local Tableau servers, in the form of: `https://www.MY_SERVER.com`. For Tableau Online, `https://10ax.online..tableau.com/`. -server.auth.sign_out() -``` +`SITENAME` is same as the `contentURL`, or site subpath, of your full site URL. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. + +Optionally, you can override the Tableau API version by adding `server.version = ''` before the `auth.signin` call. + +The TSC library signs you out of Tableau Server when you exit out of the `with` block.
    - Note: When you sign in, the TSC library manages the authenticated session for you, however it is still - limited by the maximum session length (of four hours) on Tableau Server. + Note: When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying + credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default).
    - -Alternatively, for short programs, consider using a `with` block: +An option to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly. ```py import tableauserverclient as TSC @@ -32,8 +36,9 @@ import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') server = TSC.Server('http://SERVER_URL') -with server.auth.sign_in(tableau_auth): - # Do awesome things here! -``` +server.auth.sign_in(tableau_auth) -The TSC library signs you out of Tableau Server when you exit out of the `with` block. +# Do awesome things here! + +server.auth.sign_out() +``` From fb8adbe83df77e5c2d8f4572f3a234ce6ad0b4e3 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Tue, 6 Aug 2019 17:12:31 -0700 Subject: [PATCH 022/158] Update sign-in-out.md small improvements --- docs/sign-in-out.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 61a7e29ac..0d1304791 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -15,11 +15,11 @@ with server.auth.sign_in(tableau_auth): # Do awesome things here! ``` -The `SERVER_URL` is the URL of the Tableau server without subpaths. For local Tableau servers, in the form of: `https://www.MY_SERVER.com`. For Tableau Online, `https://10ax.online..tableau.com/`. +`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -`SITENAME` is same as the `contentURL`, or site subpath, of your full site URL. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. +`SITENAME` is the subpath of your site of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. -Optionally, you can override the Tableau API version by adding `server.version = ''` before the `auth.signin` call. +Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. The TSC library signs you out of Tableau Server when you exit out of the `with` block. @@ -28,7 +28,7 @@ The TSC library signs you out of Tableau Server when you exit out of the `with` credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default). -An option to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly. +An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly. ```py import tableauserverclient as TSC From 5e1a2a58982563cfdb11cdc26f1ffd779414f341 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Tue, 6 Aug 2019 17:14:43 -0700 Subject: [PATCH 023/158] Update sign-in-out.md typo fix --- docs/sign-in-out.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 0d1304791..61b65961e 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -17,7 +17,7 @@ with server.auth.sign_in(tableau_auth): `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -`SITENAME` is the subpath of your site of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. +`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. From 8c5a159ae22aa9cc470ed8b15ad13facd57b4a35 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Wed, 7 Aug 2019 10:49:59 -0700 Subject: [PATCH 024/158] Update api-ref.md (#479) --- docs/api-ref.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 7915017df..14e48f031 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -249,7 +249,7 @@ Name | Description `name` | The name of the data source. If not specified, the name of the published data source file is used. `project_id` | The identifier of the project associated with the data source. When you must provide this identifier when create an instance of a `DatasourceItem` `project_name` | The name of the project associated with the data source. -`tags` | The tags that have been added to the data source. +`tags` | The tags (list of strings) that have been added to the data source. `updated_at` | The date and time when the data source was last updated. @@ -3449,9 +3449,9 @@ tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): - all_workbooks, pagination_item = server.workbooks.get() + all_workbooks_items, pagination_item = server.workbooks.get() # print names of first 100 workbooks - print([workbook.name for workbook in all_workbooks]) + print([workbook.name for workbook in all_workbooks_items]) From 60f0470c0d16b2e3622facbbbf4d720a07fcffee Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Fri, 9 Aug 2019 13:04:16 -0700 Subject: [PATCH 025/158] Update index.md (#481) * Update index.md Added *Install on an offline machine* in response to #365 Also added `SITENAME` and descriptive text to sign in of get started example per #355 * Update index.md (#482) Removed test dependencies in anticipation of @t8y8 's package with those dependencies unwired. --- docs/index.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 9fd8b699e..45d62e6b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,6 +48,14 @@ pip install git+https://github.com/tableau/server-client-python.git@development Note that the version from the development branch should not be used for production code. The methods and endpoints in the development version are subject to change at any time before the next stable release. +### Install on an offline machine + +To install TSC onto a machine without internet connection, use the following steps: + +1) Download and manually install the **requests** python library (and its dependencies). +2) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}. +3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz` + ## Get the samples The TSC samples are included in the `samples` directory of the TSC repository on Github. You can run the following command to clone the @@ -66,7 +74,7 @@ Run the following code to get a list of all the data sources on your installatio ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME') server = TSC.Server('http://SERVER_URL') with server.auth.sign_in(tableau_auth): @@ -74,3 +82,7 @@ with server.auth.sign_in(tableau_auth): print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) print([datasource.name for datasource in all_datasources]) ``` + +> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. + +>`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. From 14a1937dd5f498e138b6801343374ec49663a19f Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Fri, 9 Aug 2019 13:10:44 -0700 Subject: [PATCH 026/158] Update index.md --- docs/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.md b/docs/index.md index 45d62e6b7..25d16086b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,7 +53,9 @@ development version are subject to change at any time before the next stable rel To install TSC onto a machine without internet connection, use the following steps: 1) Download and manually install the **requests** python library (and its dependencies). + 2) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}. + 3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz` ## Get the samples From c90fb3988d8c16b2c4ee900093a15e166c61160e Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 12 Aug 2019 10:08:26 -0700 Subject: [PATCH 027/158] Update sign-in-out.md (#480) change "locally installed" to "on premise" --- docs/sign-in-out.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 61b65961e..12c19bf4c 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -17,7 +17,7 @@ with server.auth.sign_in(tableau_auth): `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a locally installed Tableau server. +`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. From ede678117156ef284420269ede8a0ed55edbef5e Mon Sep 17 00:00:00 2001 From: Albin Antony Date: Mon, 12 Aug 2019 22:48:21 +0530 Subject: [PATCH 028/158] Documentation: Update Write your first program (#474) * Documentation: Update Write your first program TableauAuth Class requires a third parameter site_id as given in the API reference. If only username and password is given it would lead to a Authentication Error. * Upadted Write your first program Added extra example for Tableau online. * Update index.md * Update in Write Your first program changed SITEID to SITE_NAME and made the explanation more clear. --- docs/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 25d16086b..43c8508b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -84,7 +84,6 @@ with server.auth.sign_in(tableau_auth): print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) print([datasource.name for datasource in all_datasources]) ``` - > `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. >`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. From ab84a68f948dbfd8ae6b1348d91168943e95cc1c Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 12 Aug 2019 10:25:07 -0700 Subject: [PATCH 029/158] Update sign-in-out.md --- docs/sign-in-out.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 12c19bf4c..668325b86 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -15,9 +15,11 @@ with server.auth.sign_in(tableau_auth): # Do awesome things here! ``` -`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. +> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: + `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. +> `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of + `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. From 98b5b9317dafe7e684e18e21e33dfc7b530fb02c Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 12 Aug 2019 10:46:00 -0700 Subject: [PATCH 030/158] Update sign-in-out.md --- docs/sign-in-out.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 668325b86..ce8e7e960 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -15,11 +15,9 @@ with server.auth.sign_in(tableau_auth): # Do awesome things here! ``` -> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: - `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. +`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -> `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of - `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. +`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. From 079bf08b21087319513eeb528c5f2945318712a6 Mon Sep 17 00:00:00 2001 From: prae04 Date: Tue, 27 Aug 2019 12:43:07 -0400 Subject: [PATCH 031/158] Simple typo (#493) --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 14e48f031..d8e3fed81 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -894,7 +894,7 @@ Returns information about the groups on the site. To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. -REST API: [Get Uers on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} +REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} **Parameters** From 308d3323982a646f7e4ab523140376eaa816ae66 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Wed, 28 Aug 2019 16:17:43 -0700 Subject: [PATCH 032/158] Gh pages samples and refresh (#495) * update samples page, add workbook.refresh, adddatasource.refresh * minor fix * fixed @shinchris comments --- docs/api-ref.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/samples.md | 47 ++++++++++++++++++------- 2 files changed, 127 insertions(+), 12 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index d8e3fed81..0bf6fd69b 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -564,6 +564,53 @@ The `DatasourceItem` for the data source that was added or appended to.

    +#### datasources.refresh + +```py +datasource.refresh(datasource_item) +``` + +Refreshes the data of the specified extract. + +REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +A refreshed `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# call the refresh method with the data source item + refreshed_datasource = server.datasources.refresh(datasource) + +``` +
    +
    + #### datasources.update ```py @@ -3570,6 +3617,51 @@ with server.auth.sign_in(tableau_auth):

    +#### workbooks.refresh + +```py +workbooks.refresh(workbook_item) +``` + + +Refreshes the extract of an existing workbook. + +REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # call the update method + workbook = server.workbooks.refresh(workbook) + print("\nThe data of workbook {0} is refreshed.".format(workbook.name)) + + +``` + + +
    +
    #### workbooks.update diff --git a/docs/samples.md b/docs/samples.md index 3ea908dd6..eede1cb04 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -3,7 +3,7 @@ title: Samples layout: docs --- -The TSC samples are included in the `samples` directory of the TSC repository [on Github](https://github.com/tableau/server-client-python). +The TSC samples are included in the `samples` directory of the TSC repository [on Github](https://github.com/tableau/server-client-python/tree/master/samples). * TOC {:toc} @@ -32,24 +32,47 @@ publish. The following list describes the samples available in the repository: -* `create_group.py`. Create a user group. +* `create_group.py` Create a user group. -* `create_schedules.py`. Create schedules for extract refreshes and subscriptions. +* `create_project.py` Creates a project in a site. -* `explore_datasource.py`. Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. +* `create_schedules.py` Create schedules for extract refreshes and subscriptions. -* `explore_workbook.py`. Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. +* `download_view_image.py` Downloads an image of a specified view. -* `move_workbook_projects.py`. Updates the properties of a workbook to move the workbook from one project to another. +* `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. -* `move_workbook_sites.py`. Downloads a workbook, stores it in-memory, and uploads it to another site. +* `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. -* `pagination_sample.py`. Use the Pager generator to iterate over all the items on the server. +* `export.py` Exports a view as an image, pdf, or csv. -* `publish_workbook.py`. Publishes a Tableau workbook. +* `export_wb.py` Exports a pdf containing all views in a workbook. -* `set_http_options.py`. Sets HTTP options for the server and specifically for downloading workbooks. +* `filter_sort_groups.py` Demonstrates selecting user groups as filters. -**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources -requested by the samples. +* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources. + +* `kill_all_jobs.py` Kills all running jobs. + +* `list.py` Lists all datasources or workbooks of a site. + +* `move_workbook_projects.py` Updates the properties of a workbook to move the workbook from one project to another. + +* `move_workbook_sites.py` Downloads a workbook, stores it in-memory, and uploads it to another site. + +* `pagination_sample.py` Use the Pager generator to iterate over all the items on the server. + +* `publish_workbook.py` Publishes a Tableau workbook. + +* `refresh.py` Refreshes a datasource or workbook. + +* `refresh_tasks.py` Lists and runs configured tasks on a server. + +* `set_http_options.py` Sets HTTP options for the server and specifically for downloading workbooks. + +* `set_refresh_schedule.py` Sets the schedule to refresh a datasource or workbook. + +* `update_connection.py` Updates and embeds connection credentials of a datasource. + +**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. From 30c7b1d318ffdad42ba9373ce176c2d48f025e69 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Thu, 29 Aug 2019 09:47:44 -0700 Subject: [PATCH 033/158] Gh pages add owner_id to datasourceItem (#496) * update samples page, add workbook.refresh, adddatasource.refresh * add owner_id to attributes of datasourceItem --- docs/api-ref.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 0bf6fd69b..f0109bdac 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -247,7 +247,8 @@ Name | Description `datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. `id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. `name` | The name of the data source. If not specified, the name of the published data source file is used. -`project_id` | The identifier of the project associated with the data source. When you must provide this identifier when create an instance of a `DatasourceItem` +`owner_id` | The identifier of the owner of the data source. +`project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. `project_name` | The name of the project associated with the data source. `tags` | The tags (list of strings) that have been added to the data source. `updated_at` | The date and time when the data source was last updated. From 1c9e688431bf16a1f19ae274559c5019b1b54bbd Mon Sep 17 00:00:00 2001 From: Jac Date: Tue, 5 Nov 2019 11:00:31 -0800 Subject: [PATCH 034/158] bump bootstrap to 3.4.1 address xss vulnerability in 3.3.6 --- _includes/head.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/head.html b/_includes/head.html index 083e3f268..1321285cf 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -7,12 +7,12 @@ - + - + {% if jekyll.environment == "production" %}{% include analytics.html %}{% endif %} From fed76449f3e59d19cb61113091d58c86d261237f Mon Sep 17 00:00:00 2001 From: Martin Peters Date: Mon, 11 Nov 2019 20:36:34 +0000 Subject: [PATCH 035/158] Added tasks sections to api-ref.md --- docs/api-ref.md | 209 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 209 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index f0109bdac..b4316a122 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2709,6 +2709,215 @@ The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class)

    +--- + +## Tasks + +Using the TSC library, you can get information about all the tasks on a site and you can remove tasks. To create new tasks see [Schedules](#schedules). + +The task resources for Tableau Server are defined in the `TaskItem` class. The class corresponds to the task resources you can access using the Tableau Server REST API. The task methods are based upon the endpoints for tasks in the REST API and operate on the `TaskItem` class. + +### TaskItem class + +```py +TaskItem(id, task_type, priority, consecutive_failed_count=0, schedule_id=None, target=None) +``` + +**Attributes** + +Name | Description +:--- | :--- +`consecutive_failed_count` | The number of failed consecutive executions. +`id` | The id of the task on the site. +`priority` | The priority of the task on the server. +`schedule_id` | The id of the schedule on the site. +`target` | An object, `datasource` or `workbook` which is associated to the task. Source file: models/target.py +`task_type` | Type of extract task - full or incremental refresh. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') + + task = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(task) + +``` + +Source file: models/task_item.py + +
    +
    + + +### Tasks methods + +The Tableau Server Client provides several methods for interacting with task resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/tasks_endpoint.py +
    +
    + +#### tasks.get + +```py +tasks.get(req_options=None) +``` + +Returns information about the tasks on the specified site. + +REST API: [Get Extract Refresh Tasks on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_extract_refresh_tasks){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. + + +**Returns** + +Returns a list of `TaskItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('https://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_tasks, pagination_item = server.tasks.get() + print("\nThere are {} tasks on site: ".format(pagination_item.total_available)) + print([task.id for task in all_tasks]) +``` + +
    +
    + +#### tasks.get_by_id + + +```py +tasks.get_by_id(task_id) +``` + +Returns information about the specified task. + +REST API: [Query Extract Refresh Task On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_extract_refresh_task){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`task_id` | The `task_id` specifies the task to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Task ID undefined.` | Raises an exception if a valid `task_id` is not provided. + + +**Returns** + +The `TaskItem`. See [TaskItem class](#taskitem-class) + + +**Example** + +```py + task1 = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(task1.task_type) + +``` + +
    +
    + +#### tasks.run + + +```py +tasks.run(task_item) +``` + +Runs the specified extract refresh task. + +To run a extract refresh task you need to first lookup the task `task_item` (`TaskItem` class). + +REST API: [Run Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#run_extract_refresh_task){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`task_item` | You can pass the method a task object. + + +**Returns** + +Returns the REST API response. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# login, etc. + + task = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + server.tasks.run(task) + +``` + +
    +
    + +#### tasks.delete + + +```py +tasks.delete(task_id) +``` + +Deletes an extract refresh task. + +REST API: [Run Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobstasksschedules.htm#delete_workbook){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`task_id` | The `task_id` specifies the task to delete. + + +**Exceptions** + +Error | Description + :--- | : --- +`Task ID undefined.` | Raises an exception if a valid `task_id` is not provided. + + +**Example** + +```py + server.tasks.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` + +
    +
    + + --- ## Users From e4eacd3ad9a9355f7d2d9040a8204034d4fa52e7 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 10 Feb 2020 09:43:43 -0800 Subject: [PATCH 036/158] Update api-ref.md Fixed role description for `userItem`. --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f0109bdac..9a51a43a9 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2739,7 +2739,7 @@ Name | Description `email` | The email address of the user. `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `ReadOnly`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. **Example** From 2bf76156a307c5a6d4d8573d7ba6c1f92c86b702 Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Mon, 10 Feb 2020 09:54:00 -0800 Subject: [PATCH 037/158] Update api-ref.md Fix to fix of UserItem role description. --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 9a51a43a9..e7488eb5a 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2739,7 +2739,7 @@ Name | Description `email` | The email address of the user. `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `ReadOnly`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. **Example** From b923ca6ea4df0db62e90b5b203a9e76aaf0f4dea Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Tue, 25 Feb 2020 18:05:04 -0800 Subject: [PATCH 038/158] Update versions.md Adding supported versions --- docs/versions.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/versions.md b/docs/versions.md index 648945d7a..5589985d0 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -65,3 +65,6 @@ The current version of TSC only supports the following REST API and Tableau Serv |3.1|2018.2| |3.2|2018.3| |3.3|2019.1| +|3.4|2019.2| +|3.5|2019.3| +|3.6|2019.4| From 0d0f118218047776e0f569909175aa29ad0e4f6f Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Fri, 28 Feb 2020 13:44:03 -0800 Subject: [PATCH 039/158] Update copyright date with script --- _includes/footer.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_includes/footer.html b/_includes/footer.html index ee1481e55..a3177d7f5 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -3,6 +3,7 @@

    This site is open source. Suggestions and pull requests are welcome on our GitHub page.

    -

    © 2018 Tableau.

    +

    © Copyright Tableau

    + Documentation last generated on: {{ site.time }}>
    From ec06b8035423448650d5612969940f976de54459 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Fri, 28 Feb 2020 13:49:56 -0800 Subject: [PATCH 040/158] Update footer.html --- _includes/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/footer.html b/_includes/footer.html index a3177d7f5..35ea121c7 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -4,6 +4,6 @@

    This site is open source. Suggestions and pull requests are welcome on our GitHub page.

    © Copyright Tableau

    - Documentation last generated on: {{ site.time }}> + Documentation last generated on: {{ site.time }} From f002465525cff47f540fddec63b2c814af1fbd56 Mon Sep 17 00:00:00 2001 From: mbren Date: Fri, 28 Feb 2020 18:32:03 -0500 Subject: [PATCH 041/158] adding doc for the data acceleration sample --- docs/accelerate_workbook_doc.md | 499 ++++++++++++++++++++++++++++++++ 1 file changed, 499 insertions(+) create mode 100644 docs/accelerate_workbook_doc.md diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md new file mode 100644 index 000000000..91a240207 --- /dev/null +++ b/docs/accelerate_workbook_doc.md @@ -0,0 +1,499 @@ +--- +title: Getting Started with Data Acceleration +layout: docs +--- + +* TOC +{:toc} + +## Introduction + +Administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. + +The easiest way to configure data acceleration is to use the `accelerate_workbook.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the Tableau Server REST API. + +Workbooks with published and live data sources (both with embedded credentials), and workbooks with embedded extracts are supported. Workbooks with embedded extracts do not need to be scheduled. Workbooks with published and live data sources need to have a data acceleration task added to a schedule. + +Not supported, are workbooks with encrypted extracts or workbooks that include user-based, now(), today() functions. Federated data sources are not supported. Data Blending is partially supported for acceleration; Data queried against the secondary data sources is not accelerated. + +## Limitations + +* Site and Server Administrator permission are required to control data acceleration. +* Only those workbooks with embedded credentials can be accelerated. +* The pre-computed data is saved into the Tableau Cache.  The cache is subject to the cache size limit and the cache expiration limit. We recommend that you review your configuration and recommend 2GB or larger. +* When you attach an acceleration schedule to a workbook, if that acceleration schedule interval exceeds the Tableau Server cache expiration time, the workbook will not be accelerated during the period between the cache expiration time and the next run of the acceleration schedule.  The workbook will revert to using the databases. By default, the Tableau Server cache expiration time is 12 hours (720 minutes). +* Workbooks using encrypted extracts or that include user-based, now(), today() functions are not supported currently and will not be accelerated. +* Federated Data Source is not supported for acceleration. When there is a workbook containing both federated data sources and other data sources, the data queried against federated data sources will not be accelerated. +* Data Blending is partially supported for acceleration. Data queried against the secondary data sources are not accelerated. +* Data acceleration schedules are not currently supported to be created in the Tableau Server schedules view.  + +## Prerequisites + +When using this feature, it is recommended to increase the size of the Tableau Server external cache to 2 GB or larger. + +View your current Tableau Server external cache size setting: +`tsm configuration get -k redis.max_memory_in_mb` + +Set the Tableau Server external cache size to 2 GB: +`tsm configuration set -k redis.max_memory_in_mb -v 2048` +`tsm pending-changes apply` + +## Quick Start Tutorial + +This tutorial shows you how to enable and schedule workbooks for data acceleration using the `accelerate_workbook.py` command line tool. + +Note: You must be signed in as a server administrator to create schedules or use site-level commands. For other commands, you can use the server administrator role or the site administrator role. + +### Sign Into Tableau Server + +`python accelerate_workbook.py --server --username --password --site ` + +For information about how to identify the site value, see [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out). If you don’t specify a site, you will be signed into the Default site.   + +### Enable Workbooks That Only Use Embedded Extracts + +When data acceleration is enabled, a workbook that only has data sources that are embedded extracts does not require an acceleration schedule. Tableau Server automatically identifies the changes to its content and data whenever the workbook is republished or its extracts are refreshed (manually or on a schedule) and it submits a background task for the data pre-computation.  Thus, this type of workbook can be accelerated by just enabling it with the command: + +`python accelerate_workbook.py --enable "My Project/Embedded Extract Workbook"` + +Note: If a workbook is in a nested project, its path may be like "Project 1/Project 2/Workbook Name". Workbook paths are case sensitive. + +The server will enable the workbook and you will see the following output: + +Workbooks enabled +Project/Workbook +My Project/Embedded Extract Workbook + +After the background task for pre-computation of the workbook's data is completed, subsequent loads of the workbooks will use those pre-computed results. The background task may take a few minutes to finish. + +### Schedule Workbooks With Published or Live Data Sources + +Workbooks with published or live data sources need to be scheduled for acceleration, which keeps their data fresh. + +This command will create an acceleration schedule called "My Schedule" that runs every 4 hours throughout the day. + +`python accelerate_workbook.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` + +Next, we'll associate this acceleration schedule with your workbooks: + +`python accelerate_workbook.py --add-to-schedule "My Schedule" "My Project/My Workbook"` + +You will see the following output: + +Workbooks added to schedule +Project/Workbook | Schedules +My Project/My Workbook | My Schedule + +Users can also attach multiple workbooks to "My Schedule" by using a path list. + +`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list pathfile.txt` + +In the 'pathfile.txt' file, each line defines a workbook path. + +My project/My Workbook +Finance Project/Expenses +Sales Project/Leads Per Region + +Note: If a workbook uses only embedded extracts then an acceleration schedule will not be attached even when the user issues the `--add-to-schedule command`. + +### Monitor Your Accelerated Workbooks + +To see which workbooks have been enabled, use the `--status`, and `--show-schedules` commands. + +Display all the workbooks that are enabled, and which acceleration schedules are associated. +`python accelerate_workbook.py --status` + +Display the accelerated schedules associated with workbooks. +`python accelerate_workbook.py --show-schedules` + +### Load Your Accelerated Workbooks and Check the Performance + +#### Tableau Server Administrator Views + +Tableau Server provides an administrator view to review the load times for workbooks. See [Stats for Load Times](https://help.tableau.com/current/server/en-us/adminview_stats_load_time.htm). + +### Sign Out of Tableau Server + +Log out of Tableau Server and end your session. +`python accelerate_workbook.py --logout` + +## Command Reference + +Note: Optional arguments are indicated with []. + +### Get Help + +Get a list of the available commands. + +`python accelerate_workbook.py --help` + +### Sign Into Tableau Server + +In Tableau Server, creating schedules and site level commands require the user to be signed in with an account with the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is required. + +`python accelerate_workbook.py [--server] [SERVER_URL] [--site] [SITE_NAME] [--username] [Username] [--password] [password]` + +SITE_NAME is the sub-path of your full site URL (also called contentURL in the REST API). Given the site URL 'https://my.tableauserver.com/MYSITE', 'MYSITE' is the site name. See [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out) for identifying the [SITE_NAME]. When `--site` is not specified or is specified with "" the Default site will be used. + +After a successful sign in, a session token file (".token_profile") will be created and saved in the same directory as `accelerate_workbook.py`. The token file will be deleted when you log out. + +Example: Sign into Tableau Server and the Default site + +`python accelerate_workbook.py --server https://server --site "" --username user1 --password password1` + +You can ignore the SSL Certificate by pressing the ENTER key when prompted. + +Example: Sign into Tableau Server with an SSL certificate + +`python accelerate_workbook.py --server https://server --site "" --username user1 --password password1 --ssl-cert-pem cert.pem` + +Example: Switch the site that you are logged into + +`python accelerate_workbook.py --server https://server --username user1 --password password1 --site different_site` + +Example: For some usernames and passwords it may be necessary to use double quotes. + +`python accelerate_workbook.py --server https://server --site "" --username "user space name" --password "password with spaces"` + +Example: Double quotes "" should not be used when prompted for input: + +`python accelerate_workbook.py --server https://server` + +site (hit enter for the Default site): +username: user space name +password: password with spaces +path to ssl certificate (hit enter to ignore): cert.pem + +### Sign Out of Tableau Server + +The session token file (".token_profile") created on login will be deleted when you log out. + +Example: Sign out of Tableau Server + +`python accelerate_workbook.py --logout` + +When successfully signed out of Tableau Server, you will see the following message, "Signed out from current connection to https://server successfully". If you are not connected to an existing server, you will see the following message, "No existing connection to any server." + +### Create Data Acceleration Schedules + +The following command is used to create a data acceleration schedule. + +`python accelerate_workbook.py --create-schedule SCHEDULE_NAME INTERVAL_TYPE [INTERVAL] [START_TIME] [END_TIME]` + +In Tableau Server, creating schedules requires the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is sufficient. + +INTERVAL_TYPE can be one of the four options below: +--hourly-interval with INTERVAL in {0.25,0.5,1,2,4,6,8,12}, the unit is hour. +--daily-interval, INTERVAL is not needed +--weekly-interval with INTERVAL as a non-empty subset of: +{Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday} +--monthly-interval, INTERVAL is the starting day in a month. + +[START_TIME] is optional. If no starting time is specified, the default time 00:00:00 is used. To specify the starting time, --start-hour and --start-minute can be used to specify the time. + +[END_TIME] is optional. If no end time is specified, the end of the day will be used. To specify the ending time, --end-hour and --end-minute can be used to specify the time. END_TIME option is only useful for hourly interval. + +The warning, "Warning: The recurrence interval of the given schedule is larger than Vizql server data refresh interval of 720 minutes." will be displayed if the users try to create a schedule that exceeds the configured VizQL server data refresh interval. By default, this is set to 12 hours (720 minutes). + +Example 1: Create a scheduled pre-computation every 4 hours. + +In this example, a pre-computation background task will be submitted every 4 hours throughout the day. + +`python accelerate_workbook.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` + +After the acceleration schedule is created using the command line client, it can be viewed in the Tableau Server Schedules view. The scheduled task type will not currently be displayed. + +### Associate Workbooks to a Schedule + +You can associate a workbook to single or multiple data acceleration schedules. If your workbook has not been enabled for acceleration, the --add-schedule command will automatically enable the workbook. + +`python accelerate_workbook.py --add-to-schedule [SCHEDULE_NAME] --workbook-path WORKBOOK_PATH` + +`python accelerate_workbook.py --add-to-schedule [SCHEDULE_NAME] --path-list PATH_LIST` + +Example 1: Associate a workbook to a schedule + +`python accelerate_workbook.py --add-to-schedule "My Schedule" --workbook-path project/workbook1` + +```iecst +Workbooks added to schedule +Project/Workbook | Schedules +Default/my workbook1 | My Schedule +``` + +Example 2: Associate an acceleration schedule using a text file with a path list containing one or more workbooks. + +`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list path.txt` + +```iecst +Workbooks added to schedule +Project/Workbook Schedules +Default/my workbook1 My Schedule +Default/my workbook2 My Schedule +``` + +Example 3: Associate acceleration schedules with a workbook that is only extract data source based. + +Any workbook that uses only embedded extracts as its data source does not require an explicit acceleration schedule and thus it will only be enabled for acceleration without using an acceleration schedule. For these workbooks, the Tableau Server will automatically identify changes to the workbook content and data. Whenever the workbook is republished or its extract refreshes (manually or scheduled) a background task is submitted to pre-compute the data. + +In the example below, an attempt was made to add "My Schedule" to a workbook with only embedded extracts. The workbook is enabled for acceleration and it is not added to the "My Schedule" acceleration schedule. + +`python accelerate_workbook.py --add-to-schedule "My schedule" Default/WorkbookwithOnlyExtracts` + +```iecst +Workbooks added to schedule: None +Warning: Unable to add workbook "Default/WorkbookwithOnlyExtracts" to schedule due to Workbook with id 10000 uses only embedded extract(s) and does not need explicit scheduling for acceleration. It was enabled for acceleration but not attached to the given schedule. +``` + +`python accelerate_workbook.py --show-schedule` + +```iecst +Workbooks added to schedule +Project/Workbook Schedules +Default/my workbook1 My Schedule +Default/my workbook2 My Schedule +``` + +For workbooks that are not supported you will see the following warnings: + +Workbooks with encrypted embedded extracts: +`Unable to enable Default/Sales. Workbook 'Sales' is not supported for data acceleration because it only uses encrypted embedded extracts as data sources.` + +Workbooks where credentials are not embedded: +`Unable to enable Default/Finance. Workbook 'Finance' is not supported for data acceleration because it uses data sources without embedding credentials.` + +The following warning will be displayed if the users try to create a schedule that exceeds the configured VizQL server data refresh interval. By default, this is set to 12 hours (720 minutes). +`Warning: The recurrence interval of the given schedule is larger than Vizql server data refresh interval of 720 minutes.` + +### Enable Workbooks + +Enabling a workbook will opt in the workbook for acceleration. data acceleration will monitor the relevant Tableau events that could potentially change the data of the workbooks such as workbook publishing, extract refreshing (if the workbook has any) and web authoring. Pre-computation will be triggered after these events. However, the data source changes which are not managed by Tableau will not be monitored and the acceleration schedule is used for keeping the pre-computed data up to date in those scenarios. + +To enable one workbook: + +`python accelerate_workbook.py --enable [--workbook-path] WORKBOOK_PATH` + +To enable one or more workbooks in batches, you can provide a file specifying a list of workbooks. + +`python accelerate_workbook.py --enable [--path-list] PATH_LIST` + +Example 1: Enable a single workbook + +`python accelerate_workbook.py --enable Default/Workbook1` + +Example 2: Enable multiple workbooks + +Create a path file for example `paths.txt` using the format below project/workbook: +Default/Workbook1 +Default/Workbook2 +The following command will enable the workbooks defined in the paths.txt file. + +`python accelerate_workbook.py --enable --path-list paths.txt` + +```iecst +Workbooks enabled +Project/Workbook +Default/my workbook1 +Default/my workbook2 +``` + +For workbooks that are not currently supported, you will see the following warnings: + +Workbooks with encrypted embedded extracts: +`Unable to enable Default/Sales. Workbook 'Sales' is not supported for data acceleration because it only uses encrypted embedded extracts as data sources.` + +Workbooks where credentials are not embedded: +`Unable to enable Default/Finance. Workbook 'Finance' is not supported for data acceleration because it uses data sources without embedding credentials.` + +### Detach a Workbook from a Schedule + +Use the --remove-from-schedule command to detach a workbook from a schedule. + +`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME [--workbook-path] WORKBOOK_PATH` + +`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME [---path-list] PATH_LIST` + +`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME project/workbook` + +Example 1: Removing multiple workbooks from a schedule using --path-list. +In the example below "workbook1" and "workbook2" was detached from the acceleration schedule "My Schedule". Any workbooks included in the path list are not associated with "My Schedule". + +`python accelerate_workbook.py --remove-from-schedule "My Schedule" --path-list "paths.txt"` + +```iecst +Workbooks removed from schedule +Project/Workbook Schedules +Default/workbook1 My Schedule +Default/workbook2 My Schedule + +Workbooks not on schedule "My Schedule" +Project/Workbook +Default/extractworkbook +``` + +Example 2: Remove a workbook from a schedule + +`python accelerate_workbook.py --remove-from-schedule "My Schedule" Default/workbook1` + +```iecst +Workbooks removed to schedule +Project/Workbook Removed From Schedule +Default/my workbook1 My Schedule +``` + +Example 3: + +`python accelerate_workbook.py --remove-from-schedule "My Schedule" --workbook-path Default/workbook1` + +```iecst +Workbooks removed from schedule +Project/Workbook Schedules +Default/workbook1 My Schedule +``` + +### Accelerate On-Demand + +You can use --enable combined with --acceleration-now to submit a backgrounder pre-computation job on demand. This can be useful to trigger a pre-computation ahead of the next scheduled run. + +`python accelerate_workbook.py --enable --accelerate-now --path-list PATH_LIST` + +`python accelerate_workbook.py --enable WORKBOOK_PATH --accelerate-now` + +Example 1: + +`python accelerate_workbook.py --enable Default/workbook1 --accelerate-now` + +### Disable Workbooks + +Disabling a workbook stops accelerating the workbook. It detaches the workbook from the workbook's associated schedules and cleans up all of the acceleration artifacts related to the workbook. It will not remove entries from the Tableau query cache. + +`python accelerate_workbook.py --disable [--workbook-path] WORKBOOK_PATH` + +`python accelerate_workbook.py --disable --path-list PATH_LIST` + +`python accelerate_workbook.py --disable --workbook-path Default/workbook1` + +```iecst +Workbooks Disabled +Project/Workbook +Default/workbook1 +``` + +### Enable or Disable a Site for Data Acceleration + +The following commands are used to enable or disable a site for acceleration. + +`python accelerate_workbook.py --enable --site SITE_NAME --type site` + +`python accelerate_workbook.py --disable --site SITE_NAME --type site` + +Workbooks can only be enabled for acceleration if their site is enabled. Enabling a site will not enable any workbooks automatically. All sites are enabled for acceleration by default. Enabling a site is only needed when a site is explicitly disabled, or a site is imported from another Tableau Server. + +Disabling a site for acceleration will disable all workbooks that were currently enabled for acceleration. Once a site is disabled, no workbooks can be enabled on this site until this site is enabled again. All workbooks under that site will be disabled and detached from any accelerated schedules they are associated with. + +In Tableau Server, to enable or disable acceleration requires the user to be signed in with an account with the Server Administrator role. + +Example 1: Disable the Default site for acceleration + +`python accelerate_workbook.py --disable --site SITE_NAME --type site` + +Example 2: Enable the Default site for acceleration + +`python accelerate_workbook.py --enable --site SITE_NAME --type site` + +### Display Acceleration Schedules + +The --show-schedules command displays the schedule information for enabled workbooks associated with their accelerated schedules. The schedule information includes the schedule name associated with the workbooks and their next run time. + +`python accelerate_workbook.py --show-schedules` + +`python accelerate_workbook.py --show-schedules SCHEDULE_NAME [--workbook-path] [WORKBOOK_PATH]` + +`python accelerate_workbook.py --show-schedules SCHEDULE_NAME [---path-list] [PATH_LIST]` + +Note: If --workbook-path or –path-list are omitted, the command will show all the enabled workbooks with their schedule information. + +Example 1: When there are no data acceleration schedules associated with enabled workbooks + +`python accelerate_workbook.py --show-schedules` + +Scheduled Tasks for Data Acceleration: None + +Example 2: When there are enabled workbooks with data acceleration schedules + +```iecst +Scheduled Tasks for Data Acceleration + +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 +``` + +### Show Acceleration Status + +The --status command shows the list of workbooks enabled for acceleration and their associated schedules. When a workbook is enabled but not associated with any schedule, an asterisk '*' will be shown in the Schedule column. In that case, the pre-computed data for workbooks will be updated when the workbooks are re-published, or their extracts (if they have any) get refreshed. Workbooks that only contain embedded extracts will not be associated with schedules. + +`python accelerate_workbook.py --status` + +Example 1: Display the status of all enabled and scheduled accelerated workbooks. + +`python accelerate_workbook.py --status` + +```iecst +Data Acceleration is enabled for the following workbooks +Site Project/Workbook +Default Default/extractworkbook +Default Default/liveworkbook +Default Default/liveandextractworkbook + +Scheduled Tasks for Data Acceleration +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 + +*The Data Acceleration views for these workbooks will be updated when they are published, or when their extract is refreshed. +``` + +### Specify workbook paths + +This section describes how to specify the workbook path argument and the path list argument in the commands --add-to-schedule, --enable, --remove-from-schedule. + +--workbook-path +[WORKBOOK_PATH] is the path concatenating the project path and the workbook name by "/" where the project path is the path of the project directly containing the workbook to the root project. The path is in the form of "Project Name/Workbook Name". If a workbook is in a nested project, its path may be like "Project 1/Project 2/Workbook Name". Workbook paths are case sensitive. + +Double quotes are required for specifying the workbook path if it contains whitespace. + +`python accelerate_workbook.py --enable [--workbook-path] PATH_LIST` + +Example 1: Specifying --workbook-path + +`python accelerate_workbook.py --enable --workbook-path "project/workbook with spaces"` + +Example 2: --workbook-path is optional + +`python accelerate_workbook.py --enable project/workbook` + +Example 3: --workbook-path is optional + +`python accelerate_workbook.py --add-to-schedule "My Schedule" project/workbook` + +--path-list +PATH_LIST is a text file where each line is a workbook path. In the PATH_LIST, there is no need to use double quotes for workbook paths that contain whitespace. + +Here is an example paths text file: +projectLevel1/projectLevel2/workbook1 +project1/workbook2 + +Example 1: Enable multiple workbooks + +`python accelerate_workbook.py --enable --path-list paths.txt` + +Example 2: Add multiple workbooks to a schedule. + +`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list paths.txt` + +Example 3: Remove multiple workbooks from a schedule. + +`python accelerate_workbook.py –-remove-from-schedule "My Schedule" --path-list paths.txt` From 61d43e1b45828e8d73c9e7ee2a90c06a2f4f58b3 Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:10:11 -0500 Subject: [PATCH 042/158] Update accelerate_workbook_doc.md remove duplicated information and incorporate feedback. --- docs/accelerate_workbook_doc.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index 91a240207..e9101dc07 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -8,23 +8,21 @@ layout: docs ## Introduction -Administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. +Starting in Tableau Server version 2020.2 and later, administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. -The easiest way to configure data acceleration is to use the `accelerate_workbook.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the Tableau Server REST API. +The easiest way to configure data acceleration is to use the `accelerate_workbook.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the [Tableau Server REST API](https://help.tableau.com/v2020.2/api/rest_api/en-us/REST/rest_api.htm). Workbooks with published and live data sources (both with embedded credentials), and workbooks with embedded extracts are supported. Workbooks with embedded extracts do not need to be scheduled. Workbooks with published and live data sources need to have a data acceleration task added to a schedule. -Not supported, are workbooks with encrypted extracts or workbooks that include user-based, now(), today() functions. Federated data sources are not supported. Data Blending is partially supported for acceleration; Data queried against the secondary data sources is not accelerated. - ## Limitations * Site and Server Administrator permission are required to control data acceleration. * Only those workbooks with embedded credentials can be accelerated. * The pre-computed data is saved into the Tableau Cache.  The cache is subject to the cache size limit and the cache expiration limit. We recommend that you review your configuration and recommend 2GB or larger. * When you attach an acceleration schedule to a workbook, if that acceleration schedule interval exceeds the Tableau Server cache expiration time, the workbook will not be accelerated during the period between the cache expiration time and the next run of the acceleration schedule.  The workbook will revert to using the databases. By default, the Tableau Server cache expiration time is 12 hours (720 minutes). -* Workbooks using encrypted extracts or that include user-based, now(), today() functions are not supported currently and will not be accelerated. -* Federated Data Source is not supported for acceleration. When there is a workbook containing both federated data sources and other data sources, the data queried against federated data sources will not be accelerated. -* Data Blending is partially supported for acceleration. Data queried against the secondary data sources are not accelerated. +* Workbooks using encrypted extracts or that include user-based, now(), today() functions are not supported. +* Federated data sources are not supported. When there is a workbook containing both federated data sources and other data sources, the data queried against federated data sources will not be accelerated. +* Data Blending is partially supported for acceleration. Data queried against the secondary data sources is not accelerated. * Data acceleration schedules are not currently supported to be created in the Tableau Server schedules view.  ## Prerequisites From 172a4808e7ca2ed0e6f343e2e0230842df25c7df Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:19:58 -0500 Subject: [PATCH 043/158] Update accelerate_workbook_doc.md incorporate feedback --- docs/accelerate_workbook_doc.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index e9101dc07..49de9a06b 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -422,10 +422,10 @@ Example 2: When there are enabled workbooks with data acceleration schedules ```iecst Scheduled Tasks for Data Acceleration -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 ``` ### Show Acceleration Status From 2b2164b09ce41c5a96f026502f182a6880bb9324 Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:27:05 -0500 Subject: [PATCH 044/158] Update accelerate_workbook_doc.md incorporated feedback. --- docs/accelerate_workbook_doc.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index 49de9a06b..ac275a187 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -8,7 +8,7 @@ layout: docs ## Introduction -Starting in Tableau Server version 2020.2 and later, administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. +Starting in Tableau Server version 2020.2, administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. The easiest way to configure data acceleration is to use the `accelerate_workbook.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the [Tableau Server REST API](https://help.tableau.com/v2020.2/api/rest_api/en-us/REST/rest_api.htm). @@ -27,7 +27,7 @@ Workbooks with published and live data sources (both with embedded credentials), ## Prerequisites -When using this feature, it is recommended to increase the size of the Tableau Server external cache to 2 GB or larger. +When using this feature, it is recommended to increase the size of the Tableau Server external query cache to 2 GB or larger because it is used to store the results from acceleration. Query results that exceed this limit will not be cached. The result of not having enough storage for query results is that precomputed results are not cached and those queries will be executed as normal against the data source. View your current Tableau Server external cache size setting: `tsm configuration get -k redis.max_memory_in_mb` From be4b93cd254e74255bddd9ab22b49fcd50723a34 Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:30:04 -0500 Subject: [PATCH 045/158] Update accelerate_workbook_doc.md incorporate feedback --- docs/accelerate_workbook_doc.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index ac275a187..21f51a7e0 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -424,7 +424,7 @@ Scheduled Tasks for Data Acceleration Project/Workbook Schedule Next Run Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 ``` @@ -446,10 +446,10 @@ Default Default/liveworkbook Default Default/liveandextractworkbook Scheduled Tasks for Data Acceleration -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 *The Data Acceleration views for these workbooks will be updated when they are published, or when their extract is refreshed. ``` From 6195dc5ee579de58ad74014d3bb2228351c042ef Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:32:13 -0500 Subject: [PATCH 046/158] Update accelerate_workbook_doc.md added feedback --- docs/accelerate_workbook_doc.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index 21f51a7e0..8c3043989 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -422,10 +422,10 @@ Example 2: When there are enabled workbooks with data acceleration schedules ```iecst Scheduled Tasks for Data Acceleration -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 +Project/Workbook | Schedule | Next Run +Default/extractworkbook | * +Default/liveworkbook | My Schedule | 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook | My Schedule | 2020-01-22 16:00:00-08:00 ``` ### Show Acceleration Status @@ -446,10 +446,10 @@ Default Default/liveworkbook Default Default/liveandextractworkbook Scheduled Tasks for Data Acceleration -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 +Project/Workbook | Schedule | Next Run +Default/extractworkbook | * +Default/liveworkbook | My Schedule | 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook | My Schedule | 2020-01-22 16:00:00-08:00 *The Data Acceleration views for these workbooks will be updated when they are published, or when their extract is refreshed. ``` From 90aa35d2786934801224c20f3fe1bc17dc4457da Mon Sep 17 00:00:00 2001 From: Mary Brennan Date: Mon, 2 Mar 2020 15:35:57 -0500 Subject: [PATCH 047/158] Update accelerate_workbook_doc.md fix table formatting --- docs/accelerate_workbook_doc.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index 8c3043989..1a65a20dd 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -422,10 +422,10 @@ Example 2: When there are enabled workbooks with data acceleration schedules ```iecst Scheduled Tasks for Data Acceleration -Project/Workbook | Schedule | Next Run -Default/extractworkbook | * -Default/liveworkbook | My Schedule | 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook | My Schedule | 2020-01-22 16:00:00-08:00 +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 ``` ### Show Acceleration Status @@ -446,10 +446,10 @@ Default Default/liveworkbook Default Default/liveandextractworkbook Scheduled Tasks for Data Acceleration -Project/Workbook | Schedule | Next Run -Default/extractworkbook | * -Default/liveworkbook | My Schedule | 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook | My Schedule | 2020-01-22 16:00:00-08:00 +Project/Workbook Schedule Next Run +Default/extractworkbook * +Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 +Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 *The Data Acceleration views for these workbooks will be updated when they are published, or when their extract is refreshed. ``` From c824c654a9e5dac8ba7ac2bd5081313e85c80a4d Mon Sep 17 00:00:00 2001 From: mbren Date: Fri, 6 Mar 2020 15:51:10 -0500 Subject: [PATCH 048/158] fix script name --- docs/accelerate_workbook_doc.md | 122 ++++++++++++++++---------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md index 91a240207..aac277c4a 100644 --- a/docs/accelerate_workbook_doc.md +++ b/docs/accelerate_workbook_doc.md @@ -8,9 +8,9 @@ layout: docs ## Introduction -Administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. +Tableau Server administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. -The easiest way to configure data acceleration is to use the `accelerate_workbook.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the Tableau Server REST API. +The easiest way to configure data acceleration is to use the `accelerate_workbooks.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the Tableau Server REST API. Workbooks with published and live data sources (both with embedded credentials), and workbooks with embedded extracts are supported. Workbooks with embedded extracts do not need to be scheduled. Workbooks with published and live data sources need to have a data acceleration task added to a schedule. @@ -40,13 +40,13 @@ Set the Tableau Server external cache size to 2 GB: ## Quick Start Tutorial -This tutorial shows you how to enable and schedule workbooks for data acceleration using the `accelerate_workbook.py` command line tool. +This tutorial shows you how to enable and schedule workbooks for data acceleration using the `accelerate_workbooks.py` command line tool. Note: You must be signed in as a server administrator to create schedules or use site-level commands. For other commands, you can use the server administrator role or the site administrator role. ### Sign Into Tableau Server -`python accelerate_workbook.py --server --username --password --site ` +`python accelerate_workbooks.py --server --username --password --site ` For information about how to identify the site value, see [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out). If you don’t specify a site, you will be signed into the Default site.   @@ -54,7 +54,7 @@ For information about how to identify the site value, see [Sign In and Out](ht When data acceleration is enabled, a workbook that only has data sources that are embedded extracts does not require an acceleration schedule. Tableau Server automatically identifies the changes to its content and data whenever the workbook is republished or its extracts are refreshed (manually or on a schedule) and it submits a background task for the data pre-computation.  Thus, this type of workbook can be accelerated by just enabling it with the command: -`python accelerate_workbook.py --enable "My Project/Embedded Extract Workbook"` +`python accelerate_workbooks.py --enable "My Project/Embedded Extract Workbook"` Note: If a workbook is in a nested project, its path may be like "Project 1/Project 2/Workbook Name". Workbook paths are case sensitive. @@ -72,11 +72,11 @@ Workbooks with published or live data sources need to be scheduled for accel This command will create an acceleration schedule called "My Schedule" that runs every 4 hours throughout the day. -`python accelerate_workbook.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` +`python accelerate_workbooks.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` Next, we'll associate this acceleration schedule with your workbooks: -`python accelerate_workbook.py --add-to-schedule "My Schedule" "My Project/My Workbook"` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" "My Project/My Workbook"` You will see the following output: @@ -86,7 +86,7 @@ My Project/My Workbook | My Schedule Users can also attach multiple workbooks to "My Schedule" by using a path list. -`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list pathfile.txt` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list pathfile.txt` In the 'pathfile.txt' file, each line defines a workbook path. @@ -101,10 +101,10 @@ Note: If a workbook uses only embedded extracts then an acceleration To see which workbooks have been enabled, use the `--status`, and `--show-schedules` commands. Display all the workbooks that are enabled, and which acceleration schedules are associated. -`python accelerate_workbook.py --status` +`python accelerate_workbooks.py --status` Display the accelerated schedules associated with workbooks. -`python accelerate_workbook.py --show-schedules` +`python accelerate_workbooks.py --show-schedules` ### Load Your Accelerated Workbooks and Check the Performance @@ -115,7 +115,7 @@ Tableau Server provides an administrator view to review the load times for workb ### Sign Out of Tableau Server Log out of Tableau Server and end your session. -`python accelerate_workbook.py --logout` +`python accelerate_workbooks.py --logout` ## Command Reference @@ -125,39 +125,39 @@ Note: Optional arguments are indicated with []. Get a list of the available commands. -`python accelerate_workbook.py --help` +`python accelerate_workbooks.py --help` ### Sign Into Tableau Server In Tableau Server, creating schedules and site level commands require the user to be signed in with an account with the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is required. -`python accelerate_workbook.py [--server] [SERVER_URL] [--site] [SITE_NAME] [--username] [Username] [--password] [password]` +`python accelerate_workbooks.py [--server] [SERVER_URL] [--site] [SITE_NAME] [--username] [Username] [--password] [password]` SITE_NAME is the sub-path of your full site URL (also called contentURL in the REST API). Given the site URL 'https://my.tableauserver.com/MYSITE', 'MYSITE' is the site name. See [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out) for identifying the [SITE_NAME]. When `--site` is not specified or is specified with "" the Default site will be used. -After a successful sign in, a session token file (".token_profile") will be created and saved in the same directory as `accelerate_workbook.py`. The token file will be deleted when you log out. +After a successful sign in, a session token file (".token_profile") will be created and saved in the same directory as `accelerate_workbooks.py`. The token file will be deleted when you log out. Example: Sign into Tableau Server and the Default site -`python accelerate_workbook.py --server https://server --site "" --username user1 --password password1` +`python accelerate_workbooks.py --server https://server --site "" --username user1 --password password1` You can ignore the SSL Certificate by pressing the ENTER key when prompted. Example: Sign into Tableau Server with an SSL certificate -`python accelerate_workbook.py --server https://server --site "" --username user1 --password password1 --ssl-cert-pem cert.pem` +`python accelerate_workbooks.py --server https://server --site "" --username user1 --password password1 --ssl-cert-pem cert.pem` Example: Switch the site that you are logged into -`python accelerate_workbook.py --server https://server --username user1 --password password1 --site different_site` +`python accelerate_workbooks.py --server https://server --username user1 --password password1 --site different_site` Example: For some usernames and passwords it may be necessary to use double quotes. -`python accelerate_workbook.py --server https://server --site "" --username "user space name" --password "password with spaces"` +`python accelerate_workbooks.py --server https://server --site "" --username "user space name" --password "password with spaces"` Example: Double quotes "" should not be used when prompted for input: -`python accelerate_workbook.py --server https://server` +`python accelerate_workbooks.py --server https://server` site (hit enter for the Default site): username: user space name @@ -170,7 +170,7 @@ The session token file (".token_profile") created on login will be deleted when Example: Sign out of Tableau Server -`python accelerate_workbook.py --logout` +`python accelerate_workbooks.py --logout` When successfully signed out of Tableau Server, you will see the following message, "Signed out from current connection to https://server successfully". If you are not connected to an existing server, you will see the following message, "No existing connection to any server." @@ -178,7 +178,7 @@ When successfully signed out of Tableau Server, you will see the following messa The following command is used to create a data acceleration schedule. -`python accelerate_workbook.py --create-schedule SCHEDULE_NAME INTERVAL_TYPE [INTERVAL] [START_TIME] [END_TIME]` +`python accelerate_workbooks.py --create-schedule SCHEDULE_NAME INTERVAL_TYPE [INTERVAL] [START_TIME] [END_TIME]` In Tableau Server, creating schedules requires the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is sufficient. @@ -199,7 +199,7 @@ Example 1: Create a scheduled pre-computation every 4 hours. In this example, a pre-computation background task will be submitted every 4 hours throughout the day. -`python accelerate_workbook.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` +`python accelerate_workbooks.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` After the acceleration schedule is created using the command line client, it can be viewed in the Tableau Server Schedules view. The scheduled task type will not currently be displayed. @@ -207,13 +207,13 @@ After the acceleration schedule is created using the command line client, it can You can associate a workbook to single or multiple data acceleration schedules. If your workbook has not been enabled for acceleration, the --add-schedule command will automatically enable the workbook. -`python accelerate_workbook.py --add-to-schedule [SCHEDULE_NAME] --workbook-path WORKBOOK_PATH` +`python accelerate_workbooks.py --add-to-schedule [SCHEDULE_NAME] --workbook-path WORKBOOK_PATH` -`python accelerate_workbook.py --add-to-schedule [SCHEDULE_NAME] --path-list PATH_LIST` +`python accelerate_workbooks.py --add-to-schedule [SCHEDULE_NAME] --path-list PATH_LIST` Example 1: Associate a workbook to a schedule -`python accelerate_workbook.py --add-to-schedule "My Schedule" --workbook-path project/workbook1` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" --workbook-path project/workbook1` ```iecst Workbooks added to schedule @@ -223,7 +223,7 @@ Default/my workbook1 | My Schedule Example 2: Associate an acceleration schedule using a text file with a path list containing one or more workbooks. -`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list path.txt` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list path.txt` ```iecst Workbooks added to schedule @@ -238,14 +238,14 @@ Any workbook that uses only embedded extracts as its data source does not requir In the example below, an attempt was made to add "My Schedule" to a workbook with only embedded extracts. The workbook is enabled for acceleration and it is not added to the "My Schedule" acceleration schedule. -`python accelerate_workbook.py --add-to-schedule "My schedule" Default/WorkbookwithOnlyExtracts` +`python accelerate_workbooks.py --add-to-schedule "My schedule" Default/WorkbookwithOnlyExtracts` ```iecst Workbooks added to schedule: None Warning: Unable to add workbook "Default/WorkbookwithOnlyExtracts" to schedule due to Workbook with id 10000 uses only embedded extract(s) and does not need explicit scheduling for acceleration. It was enabled for acceleration but not attached to the given schedule. ``` -`python accelerate_workbook.py --show-schedule` +`python accelerate_workbooks.py --show-schedule` ```iecst Workbooks added to schedule @@ -271,15 +271,15 @@ Enabling a workbook will opt in the workbook for acceleration. data acceleration To enable one workbook: -`python accelerate_workbook.py --enable [--workbook-path] WORKBOOK_PATH` +`python accelerate_workbooks.py --enable [--workbook-path] WORKBOOK_PATH` To enable one or more workbooks in batches, you can provide a file specifying a list of workbooks. -`python accelerate_workbook.py --enable [--path-list] PATH_LIST` +`python accelerate_workbooks.py --enable [--path-list] PATH_LIST` Example 1: Enable a single workbook -`python accelerate_workbook.py --enable Default/Workbook1` +`python accelerate_workbooks.py --enable Default/Workbook1` Example 2: Enable multiple workbooks @@ -288,7 +288,7 @@ Default/Workbook1 Default/Workbook2 The following command will enable the workbooks defined in the paths.txt file. -`python accelerate_workbook.py --enable --path-list paths.txt` +`python accelerate_workbooks.py --enable --path-list paths.txt` ```iecst Workbooks enabled @@ -309,16 +309,16 @@ Workbooks where credentials are not embedded: Use the --remove-from-schedule command to detach a workbook from a schedule. -`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME [--workbook-path] WORKBOOK_PATH` +`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME [--workbook-path] WORKBOOK_PATH` -`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME [---path-list] PATH_LIST` +`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME [---path-list] PATH_LIST` -`python accelerate_workbook.py --remove-from-schedule SCHEDULE_NAME project/workbook` +`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME project/workbook` Example 1: Removing multiple workbooks from a schedule using --path-list. In the example below "workbook1" and "workbook2" was detached from the acceleration schedule "My Schedule". Any workbooks included in the path list are not associated with "My Schedule". -`python accelerate_workbook.py --remove-from-schedule "My Schedule" --path-list "paths.txt"` +`python accelerate_workbooks.py --remove-from-schedule "My Schedule" --path-list "paths.txt"` ```iecst Workbooks removed from schedule @@ -333,7 +333,7 @@ Default/extractworkbook Example 2: Remove a workbook from a schedule -`python accelerate_workbook.py --remove-from-schedule "My Schedule" Default/workbook1` +`python accelerate_workbooks.py --remove-from-schedule "My Schedule" Default/workbook1` ```iecst Workbooks removed to schedule @@ -343,7 +343,7 @@ Default/my workbook1 My Schedule Example 3: -`python accelerate_workbook.py --remove-from-schedule "My Schedule" --workbook-path Default/workbook1` +`python accelerate_workbooks.py --remove-from-schedule "My Schedule" --workbook-path Default/workbook1` ```iecst Workbooks removed from schedule @@ -355,23 +355,23 @@ Default/workbook1 My Schedule You can use --enable combined with --acceleration-now to submit a backgrounder pre-computation job on demand. This can be useful to trigger a pre-computation ahead of the next scheduled run. -`python accelerate_workbook.py --enable --accelerate-now --path-list PATH_LIST` +`python accelerate_workbooks.py --enable --accelerate-now --path-list PATH_LIST` -`python accelerate_workbook.py --enable WORKBOOK_PATH --accelerate-now` +`python accelerate_workbooks.py --enable WORKBOOK_PATH --accelerate-now` Example 1: -`python accelerate_workbook.py --enable Default/workbook1 --accelerate-now` +`python accelerate_workbooks.py --enable Default/workbook1 --accelerate-now` ### Disable Workbooks Disabling a workbook stops accelerating the workbook. It detaches the workbook from the workbook's associated schedules and cleans up all of the acceleration artifacts related to the workbook. It will not remove entries from the Tableau query cache. -`python accelerate_workbook.py --disable [--workbook-path] WORKBOOK_PATH` +`python accelerate_workbooks.py --disable [--workbook-path] WORKBOOK_PATH` -`python accelerate_workbook.py --disable --path-list PATH_LIST` +`python accelerate_workbooks.py --disable --path-list PATH_LIST` -`python accelerate_workbook.py --disable --workbook-path Default/workbook1` +`python accelerate_workbooks.py --disable --workbook-path Default/workbook1` ```iecst Workbooks Disabled @@ -383,9 +383,9 @@ Default/workbook1 The following commands are used to enable or disable a site for acceleration. -`python accelerate_workbook.py --enable --site SITE_NAME --type site` +`python accelerate_workbooks.py --enable --site SITE_NAME --type site` -`python accelerate_workbook.py --disable --site SITE_NAME --type site` +`python accelerate_workbooks.py --disable --site SITE_NAME --type site` Workbooks can only be enabled for acceleration if their site is enabled. Enabling a site will not enable any workbooks automatically. All sites are enabled for acceleration by default. Enabling a site is only needed when a site is explicitly disabled, or a site is imported from another Tableau Server. @@ -395,27 +395,27 @@ In Tableau Server, to enable or disable acceleration requires the user to be sig Example 1: Disable the Default site for acceleration -`python accelerate_workbook.py --disable --site SITE_NAME --type site` +`python accelerate_workbooks.py --disable --site SITE_NAME --type site` Example 2: Enable the Default site for acceleration -`python accelerate_workbook.py --enable --site SITE_NAME --type site` +`python accelerate_workbooks.py --enable --site SITE_NAME --type site` ### Display Acceleration Schedules The --show-schedules command displays the schedule information for enabled workbooks associated with their accelerated schedules. The schedule information includes the schedule name associated with the workbooks and their next run time. -`python accelerate_workbook.py --show-schedules` +`python accelerate_workbooks.py --show-schedules` -`python accelerate_workbook.py --show-schedules SCHEDULE_NAME [--workbook-path] [WORKBOOK_PATH]` +`python accelerate_workbooks.py --show-schedules SCHEDULE_NAME [--workbook-path] [WORKBOOK_PATH]` -`python accelerate_workbook.py --show-schedules SCHEDULE_NAME [---path-list] [PATH_LIST]` +`python accelerate_workbooks.py --show-schedules SCHEDULE_NAME [---path-list] [PATH_LIST]` Note: If --workbook-path or –path-list are omitted, the command will show all the enabled workbooks with their schedule information. Example 1: When there are no data acceleration schedules associated with enabled workbooks -`python accelerate_workbook.py --show-schedules` +`python accelerate_workbooks.py --show-schedules` Scheduled Tasks for Data Acceleration: None @@ -434,11 +434,11 @@ Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 The --status command shows the list of workbooks enabled for acceleration and their associated schedules. When a workbook is enabled but not associated with any schedule, an asterisk '*' will be shown in the Schedule column. In that case, the pre-computed data for workbooks will be updated when the workbooks are re-published, or their extracts (if they have any) get refreshed. Workbooks that only contain embedded extracts will not be associated with schedules. -`python accelerate_workbook.py --status` +`python accelerate_workbooks.py --status` Example 1: Display the status of all enabled and scheduled accelerated workbooks. -`python accelerate_workbook.py --status` +`python accelerate_workbooks.py --status` ```iecst Data Acceleration is enabled for the following workbooks @@ -465,19 +465,19 @@ This section describes how to specify the workbook path argument and the path li Double quotes are required for specifying the workbook path if it contains whitespace. -`python accelerate_workbook.py --enable [--workbook-path] PATH_LIST` +`python accelerate_workbooks.py --enable [--workbook-path] PATH_LIST` Example 1: Specifying --workbook-path -`python accelerate_workbook.py --enable --workbook-path "project/workbook with spaces"` +`python accelerate_workbooks.py --enable --workbook-path "project/workbook with spaces"` Example 2: --workbook-path is optional -`python accelerate_workbook.py --enable project/workbook` +`python accelerate_workbooks.py --enable project/workbook` Example 3: --workbook-path is optional -`python accelerate_workbook.py --add-to-schedule "My Schedule" project/workbook` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" project/workbook` --path-list PATH_LIST is a text file where each line is a workbook path. In the PATH_LIST, there is no need to use double quotes for workbook paths that contain whitespace. @@ -488,12 +488,12 @@ project1/workbook2 Example 1: Enable multiple workbooks -`python accelerate_workbook.py --enable --path-list paths.txt` +`python accelerate_workbooks.py --enable --path-list paths.txt` Example 2: Add multiple workbooks to a schedule. -`python accelerate_workbook.py --add-to-schedule "My Schedule" --path-list paths.txt` +`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list paths.txt` Example 3: Remove multiple workbooks from a schedule. -`python accelerate_workbook.py –-remove-from-schedule "My Schedule" --path-list paths.txt` +`python accelerate_workbooks.py –-remove-from-schedule "My Schedule" --path-list paths.txt` From 530147f578d9a8321b69fb3328cfa064edfa0d9c Mon Sep 17 00:00:00 2001 From: mbren Date: Wed, 11 Mar 2020 15:54:55 -0400 Subject: [PATCH 049/158] remove old documentation --- docs/accelerate_workbook_doc.md | 497 -------------------------------- 1 file changed, 497 deletions(-) delete mode 100644 docs/accelerate_workbook_doc.md diff --git a/docs/accelerate_workbook_doc.md b/docs/accelerate_workbook_doc.md deleted file mode 100644 index 26dc0bda3..000000000 --- a/docs/accelerate_workbook_doc.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -title: Getting Started with Data Acceleration -layout: docs ---- - -* TOC -{:toc} - -## Introduction - -Starting in Tableau Server version 2020.2, administrators can enable data acceleration for specific workbooks. An accelerated workbook loads faster because Tableau Server pre-computes the workbook's data in a background process. - -The easiest way to configure data acceleration is to use the `accelerate_workbooks.py` sample in the Tableau Server Client library. It is also possible to configure data acceleration using the [Tableau Server REST API](https://help.tableau.com/v2020.2/api/rest_api/en-us/REST/rest_api.htm). - -Workbooks with published and live data sources (both with embedded credentials), and workbooks with embedded extracts are supported. Workbooks with embedded extracts do not need to be scheduled. Workbooks with published and live data sources need to have a data acceleration task added to a schedule. - -## Limitations - -* Site and Server Administrator permission are required to control data acceleration. -* Only those workbooks with embedded credentials can be accelerated. -* The pre-computed data is saved into the Tableau Cache.  The cache is subject to the cache size limit and the cache expiration limit. We recommend that you review your configuration and recommend 2GB or larger. -* When you attach an acceleration schedule to a workbook, if that acceleration schedule interval exceeds the Tableau Server cache expiration time, the workbook will not be accelerated during the period between the cache expiration time and the next run of the acceleration schedule.  The workbook will revert to using the databases. By default, the Tableau Server cache expiration time is 12 hours (720 minutes). -* Workbooks using encrypted extracts or that include user-based, now(), today() functions are not supported. -* Federated data sources are not supported. When there is a workbook containing both federated data sources and other data sources, the data queried against federated data sources will not be accelerated. -* Data Blending is partially supported for acceleration. Data queried against the secondary data sources is not accelerated. -* Data acceleration schedules are not currently supported to be created in the Tableau Server schedules view.  - -## Prerequisites - -When using this feature, it is recommended to increase the size of the Tableau Server external query cache to 2 GB or larger because it is used to store the results from acceleration. Query results that exceed this limit will not be cached. The result of not having enough storage for query results is that precomputed results are not cached and those queries will be executed as normal against the data source. - -View your current Tableau Server external cache size setting: -`tsm configuration get -k redis.max_memory_in_mb` - -Set the Tableau Server external cache size to 2 GB: -`tsm configuration set -k redis.max_memory_in_mb -v 2048` -`tsm pending-changes apply` - -## Quick Start Tutorial - -This tutorial shows you how to enable and schedule workbooks for data acceleration using the `accelerate_workbooks.py` command line tool. - -Note: You must be signed in as a server administrator to create schedules or use site-level commands. For other commands, you can use the server administrator role or the site administrator role. - -### Sign Into Tableau Server - -`python accelerate_workbooks.py --server --username --password --site ` - -For information about how to identify the site value, see [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out). If you don't specify a site, you will be signed into the Default site.   - -### Enable Workbooks That Only Use Embedded Extracts - -When data acceleration is enabled, a workbook that only has data sources that are embedded extracts does not require an acceleration schedule. Tableau Server automatically identifies the changes to its content and data whenever the workbook is republished or its extracts are refreshed (manually or on a schedule) and it submits a background task for the data pre-computation.  Thus, this type of workbook can be accelerated by just enabling it with the command: - -`python accelerate_workbooks.py --enable "My Project/Embedded Extract Workbook"` - -Note: If a workbook is in a nested project, its path may be like "Project 1/Project 2/Workbook Name". Workbook paths are case sensitive. - -The server will enable the workbook and you will see the following output: - -Workbooks enabled -Project/Workbook -My Project/Embedded Extract Workbook - -After the background task for pre-computation of the workbook's data is completed, subsequent loads of the workbooks will use those pre-computed results. The background task may take a few minutes to finish. - -### Schedule Workbooks With Published or Live Data Sources - -Workbooks with published or live data sources need to be scheduled for acceleration, which keeps their data fresh. - -This command will create an acceleration schedule called "My Schedule" that runs every 4 hours throughout the day. - -`python accelerate_workbooks.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` - -Next, we'll associate this acceleration schedule with your workbooks: - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" "My Project/My Workbook"` - -You will see the following output: - -Workbooks added to schedule -Project/Workbook | Schedules -My Project/My Workbook | My Schedule - -Users can also attach multiple workbooks to "My Schedule" by using a path list. - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list pathfile.txt` - -In the 'pathfile.txt' file, each line defines a workbook path. - -My project/My Workbook -Finance Project/Expenses -Sales Project/Leads Per Region - -Note: If a workbook uses only embedded extracts then an acceleration schedule will not be attached even when the user issues the `--add-to-schedule command`. - -### Monitor Your Accelerated Workbooks - -To see which workbooks have been enabled, use the `--status`, and `--show-schedules` commands. - -Display all the workbooks that are enabled, and which acceleration schedules are associated. -`python accelerate_workbooks.py --status` - -Display the accelerated schedules associated with workbooks. -`python accelerate_workbooks.py --show-schedules` - -### Load Your Accelerated Workbooks and Check the Performance - -#### Tableau Server Administrator Views - -Tableau Server provides an administrator view to review the load times for workbooks. See [Stats for Load Times](https://help.tableau.com/current/server/en-us/adminview_stats_load_time.htm). - -### Sign Out of Tableau Server - -Log out of Tableau Server and end your session. -`python accelerate_workbooks.py --logout` - -## Command Reference - -Note: Optional arguments are indicated with []. - -### Get Help - -Get a list of the available commands. - -`python accelerate_workbooks.py --help` - -### Sign Into Tableau Server - -In Tableau Server, creating schedules and site level commands require the user to be signed in with an account with the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is required. - -`python accelerate_workbooks.py [--server] [SERVER_URL] [--site] [SITE_NAME] [--username] [Username] [--password] [password]` - -SITE_NAME is the sub-path of your full site URL (also called contentURL in the REST API). Given the site URL 'https://my.tableauserver.com/MYSITE', 'MYSITE' is the site name. See [Sign In and Out](https://tableau.github.io/server-client-python/docs/sign-in-out) for identifying the [SITE_NAME]. When `--site` is not specified or is specified with "" the Default site will be used. - -After a successful sign in, a session token file (".token_profile") will be created and saved in the same directory as `accelerate_workbooks.py`. The token file will be deleted when you log out. - -Example: Sign into Tableau Server and the Default site - -`python accelerate_workbooks.py --server https://server --site "" --username user1 --password password1` - -You can ignore the SSL Certificate by pressing the ENTER key when prompted. - -Example: Sign into Tableau Server with an SSL certificate - -`python accelerate_workbooks.py --server https://server --site "" --username user1 --password password1 --ssl-cert-pem cert.pem` - -Example: Switch the site that you are logged into - -`python accelerate_workbooks.py --server https://server --username user1 --password password1 --site different_site` - -Example: For some usernames and passwords it may be necessary to use double quotes. - -`python accelerate_workbooks.py --server https://server --site "" --username "user space name" --password "password with spaces"` - -Example: Double quotes "" should not be used when prompted for input: - -`python accelerate_workbooks.py --server https://server` - -site (hit enter for the Default site): -username: user space name -password: password with spaces -path to ssl certificate (hit enter to ignore): cert.pem - -### Sign Out of Tableau Server - -The session token file (".token_profile") created on login will be deleted when you log out. - -Example: Sign out of Tableau Server - -`python accelerate_workbooks.py --logout` - -When successfully signed out of Tableau Server, you will see the following message, "Signed out from current connection to https://server successfully". If you are not connected to an existing server, you will see the following message, "No existing connection to any server." - -### Create Data Acceleration Schedules - -The following command is used to create a data acceleration schedule. - -`python accelerate_workbooks.py --create-schedule SCHEDULE_NAME INTERVAL_TYPE [INTERVAL] [START_TIME] [END_TIME]` - -In Tableau Server, creating schedules requires the Server Administrator role. For other commands the Server Administrator role or the Site Administrator role is sufficient. - -INTERVAL_TYPE can be one of the four options below: ---hourly-interval with INTERVAL in {0.25,0.5,1,2,4,6,8,12}, the unit is hour. ---daily-interval, INTERVAL is not needed ---weekly-interval with INTERVAL as a non-empty subset of: -{Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday} ---monthly-interval, INTERVAL is the starting day in a month. - -[START_TIME] is optional. If no starting time is specified, the default time 00:00:00 is used. To specify the starting time, --start-hour and --start-minute can be used to specify the time. - -[END_TIME] is optional. If no end time is specified, the end of the day will be used. To specify the ending time, --end-hour and --end-minute can be used to specify the time. END_TIME option is only useful for hourly interval. - -The warning, "Warning: The recurrence interval of the given schedule is larger than Vizql server data refresh interval of 720 minutes." will be displayed if the users try to create a schedule that exceeds the configured VizQL server data refresh interval. By default, this is set to 12 hours (720 minutes). - -Example 1: Create a scheduled pre-computation every 4 hours. - -In this example, a pre-computation background task will be submitted every 4 hours throughout the day. - -`python accelerate_workbooks.py --create-schedule "My Schedule" --hourly-interval 4 --start-hour 0 --end-hour 23 --end-minute 45` - -After the acceleration schedule is created using the command line client, it can be viewed in the Tableau Server Schedules view. The scheduled task type will not currently be displayed. - -### Associate Workbooks to a Schedule - -You can associate a workbook to single or multiple data acceleration schedules. If your workbook has not been enabled for acceleration, the --add-schedule command will automatically enable the workbook. - -`python accelerate_workbooks.py --add-to-schedule [SCHEDULE_NAME] --workbook-path WORKBOOK_PATH` - -`python accelerate_workbooks.py --add-to-schedule [SCHEDULE_NAME] --path-list PATH_LIST` - -Example 1: Associate a workbook to a schedule - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" --workbook-path project/workbook1` - -```iecst -Workbooks added to schedule -Project/Workbook | Schedules -Default/my workbook1 | My Schedule -``` - -Example 2: Associate an acceleration schedule using a text file with a path list containing one or more workbooks. - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list path.txt` - -```iecst -Workbooks added to schedule -Project/Workbook Schedules -Default/my workbook1 My Schedule -Default/my workbook2 My Schedule -``` - -Example 3: Associate acceleration schedules with a workbook that is only extract data source based. - -Any workbook that uses only embedded extracts as its data source does not require an explicit acceleration schedule and thus it will only be enabled for acceleration without using an acceleration schedule. For these workbooks, the Tableau Server will automatically identify changes to the workbook content and data. Whenever the workbook is republished or its extract refreshes (manually or scheduled) a background task is submitted to pre-compute the data. - -In the example below, an attempt was made to add "My Schedule" to a workbook with only embedded extracts. The workbook is enabled for acceleration and it is not added to the "My Schedule" acceleration schedule. - -`python accelerate_workbooks.py --add-to-schedule "My schedule" Default/WorkbookwithOnlyExtracts` - -```iecst -Workbooks added to schedule: None -Warning: Unable to add workbook "Default/WorkbookwithOnlyExtracts" to schedule due to Workbook with id 10000 uses only embedded extract(s) and does not need explicit scheduling for acceleration. It was enabled for acceleration but not attached to the given schedule. -``` - -`python accelerate_workbooks.py --show-schedule` - -```iecst -Workbooks added to schedule -Project/Workbook Schedules -Default/my workbook1 My Schedule -Default/my workbook2 My Schedule -``` - -For workbooks that are not supported you will see the following warnings: - -Workbooks with encrypted embedded extracts: -`Unable to enable Default/Sales. Workbook 'Sales' is not supported for data acceleration because it only uses encrypted embedded extracts as data sources.` - -Workbooks where credentials are not embedded: -`Unable to enable Default/Finance. Workbook 'Finance' is not supported for data acceleration because it uses data sources without embedding credentials.` - -The following warning will be displayed if the users try to create a schedule that exceeds the configured VizQL server data refresh interval. By default, this is set to 12 hours (720 minutes). -`Warning: The recurrence interval of the given schedule is larger than Vizql server data refresh interval of 720 minutes.` - -### Enable Workbooks - -Enabling a workbook will opt in the workbook for acceleration. data acceleration will monitor the relevant Tableau events that could potentially change the data of the workbooks such as workbook publishing, extract refreshing (if the workbook has any) and web authoring. Pre-computation will be triggered after these events. However, the data source changes which are not managed by Tableau will not be monitored and the acceleration schedule is used for keeping the pre-computed data up to date in those scenarios. - -To enable one workbook: - -`python accelerate_workbooks.py --enable [--workbook-path] WORKBOOK_PATH` - -To enable one or more workbooks in batches, you can provide a file specifying a list of workbooks. - -`python accelerate_workbooks.py --enable [--path-list] PATH_LIST` - -Example 1: Enable a single workbook - -`python accelerate_workbooks.py --enable Default/Workbook1` - -Example 2: Enable multiple workbooks - -Create a path file for example `paths.txt` using the format below project/workbook: -Default/Workbook1 -Default/Workbook2 -The following command will enable the workbooks defined in the paths.txt file. - -`python accelerate_workbooks.py --enable --path-list paths.txt` - -```iecst -Workbooks enabled -Project/Workbook -Default/my workbook1 -Default/my workbook2 -``` - -For workbooks that are not currently supported, you will see the following warnings: - -Workbooks with encrypted embedded extracts: -`Unable to enable Default/Sales. Workbook 'Sales' is not supported for data acceleration because it only uses encrypted embedded extracts as data sources.` - -Workbooks where credentials are not embedded: -`Unable to enable Default/Finance. Workbook 'Finance' is not supported for data acceleration because it uses data sources without embedding credentials.` - -### Detach a Workbook from a Schedule - -Use the --remove-from-schedule command to detach a workbook from a schedule. - -`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME [--workbook-path] WORKBOOK_PATH` - -`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME [---path-list] PATH_LIST` - -`python accelerate_workbooks.py --remove-from-schedule SCHEDULE_NAME project/workbook` - -Example 1: Removing multiple workbooks from a schedule using --path-list. -In the example below "workbook1" and "workbook2" was detached from the acceleration schedule "My Schedule". Any workbooks included in the path list are not associated with "My Schedule". - -`python accelerate_workbooks.py --remove-from-schedule "My Schedule" --path-list "paths.txt"` - -```iecst -Workbooks removed from schedule -Project/Workbook Schedules -Default/workbook1 My Schedule -Default/workbook2 My Schedule - -Workbooks not on schedule "My Schedule" -Project/Workbook -Default/extractworkbook -``` - -Example 2: Remove a workbook from a schedule - -`python accelerate_workbooks.py --remove-from-schedule "My Schedule" Default/workbook1` - -```iecst -Workbooks removed to schedule -Project/Workbook Removed From Schedule -Default/my workbook1 My Schedule -``` - -Example 3: - -`python accelerate_workbooks.py --remove-from-schedule "My Schedule" --workbook-path Default/workbook1` - -```iecst -Workbooks removed from schedule -Project/Workbook Schedules -Default/workbook1 My Schedule -``` - -### Accelerate On-Demand - -You can use --enable combined with --acceleration-now to submit a backgrounder pre-computation job on demand. This can be useful to trigger a pre-computation ahead of the next scheduled run. - -`python accelerate_workbooks.py --enable --accelerate-now --path-list PATH_LIST` - -`python accelerate_workbooks.py --enable WORKBOOK_PATH --accelerate-now` - -Example 1: - -`python accelerate_workbooks.py --enable Default/workbook1 --accelerate-now` - -### Disable Workbooks - -Disabling a workbook stops accelerating the workbook. It detaches the workbook from the workbook's associated schedules and cleans up all of the acceleration artifacts related to the workbook. It will not remove entries from the Tableau query cache. - -`python accelerate_workbooks.py --disable [--workbook-path] WORKBOOK_PATH` - -`python accelerate_workbooks.py --disable --path-list PATH_LIST` - -`python accelerate_workbooks.py --disable --workbook-path Default/workbook1` - -```iecst -Workbooks Disabled -Project/Workbook -Default/workbook1 -``` - -### Enable or Disable a Site for Data Acceleration - -The following commands are used to enable or disable a site for acceleration. - -`python accelerate_workbooks.py --enable --site SITE_NAME --type site` - -`python accelerate_workbooks.py --disable --site SITE_NAME --type site` - -Workbooks can only be enabled for acceleration if their site is enabled. Enabling a site will not enable any workbooks automatically. All sites are enabled for acceleration by default. Enabling a site is only needed when a site is explicitly disabled, or a site is imported from another Tableau Server. - -Disabling a site for acceleration will disable all workbooks that were currently enabled for acceleration. Once a site is disabled, no workbooks can be enabled on this site until this site is enabled again. All workbooks under that site will be disabled and detached from any accelerated schedules they are associated with. - -In Tableau Server, to enable or disable acceleration requires the user to be signed in with an account with the Server Administrator role. - -Example 1: Disable the Default site for acceleration - -`python accelerate_workbooks.py --disable --site SITE_NAME --type site` - -Example 2: Enable the Default site for acceleration - -`python accelerate_workbooks.py --enable --site SITE_NAME --type site` - -### Display Acceleration Schedules - -The --show-schedules command displays the schedule information for enabled workbooks associated with their accelerated schedules. The schedule information includes the schedule name associated with the workbooks and their next run time. - -`python accelerate_workbooks.py --show-schedules` - -`python accelerate_workbooks.py --show-schedules SCHEDULE_NAME [--workbook-path] [WORKBOOK_PATH]` - -`python accelerate_workbooks.py --show-schedules SCHEDULE_NAME [---path-list] [PATH_LIST]` - -Note: If --workbook-path or –path-list are omitted, the command will show all the enabled workbooks with their schedule information. - -Example 1: When there are no data acceleration schedules associated with enabled workbooks - -`python accelerate_workbooks.py --show-schedules` - -Scheduled Tasks for Data Acceleration: None - -Example 2: When there are enabled workbooks with data acceleration schedules - -```iecst -Scheduled Tasks for Data Acceleration - -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 -``` - -### Show Acceleration Status - -The --status command shows the list of workbooks enabled for acceleration and their associated schedules. When a workbook is enabled but not associated with any schedule, an asterisk '*' will be shown in the Schedule column. In that case, the pre-computed data for workbooks will be updated when the workbooks are re-published, or their extracts (if they have any) get refreshed. Workbooks that only contain embedded extracts will not be associated with schedules. - -`python accelerate_workbooks.py --status` - -Example 1: Display the status of all enabled and scheduled accelerated workbooks. - -`python accelerate_workbooks.py --status` - -```iecst -Data Acceleration is enabled for the following workbooks -Site Project/Workbook -Default Default/extractworkbook -Default Default/liveworkbook -Default Default/liveandextractworkbook - -Scheduled Tasks for Data Acceleration -Project/Workbook Schedule Next Run -Default/extractworkbook * -Default/liveworkbook My Schedule 2020-01-22 16:00:00-08:00 -Default/liveandextractworkbook My Schedule 2020-01-22 16:00:00-08:00 - -*The Data Acceleration views for these workbooks will be updated when they are published, or when their extract is refreshed. -``` - -### Specify workbook paths - -This section describes how to specify the workbook path argument and the path list argument in the commands --add-to-schedule, --enable, --remove-from-schedule. - ---workbook-path -[WORKBOOK_PATH] is the path concatenating the project path and the workbook name by "/" where the project path is the path of the project directly containing the workbook to the root project. The path is in the form of "Project Name/Workbook Name". If a workbook is in a nested project, its path may be like "Project 1/Project 2/Workbook Name". Workbook paths are case sensitive. - -Double quotes are required for specifying the workbook path if it contains whitespace. - -`python accelerate_workbooks.py --enable [--workbook-path] PATH_LIST` - -Example 1: Specifying --workbook-path - -`python accelerate_workbooks.py --enable --workbook-path "project/workbook with spaces"` - -Example 2: --workbook-path is optional - -`python accelerate_workbooks.py --enable project/workbook` - -Example 3: --workbook-path is optional - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" project/workbook` - ---path-list -PATH_LIST is a text file where each line is a workbook path. In the PATH_LIST, there is no need to use double quotes for workbook paths that contain whitespace. - -Here is an example paths text file: -projectLevel1/projectLevel2/workbook1 -project1/workbook2 - -Example 1: Enable multiple workbooks - -`python accelerate_workbooks.py --enable --path-list paths.txt` - -Example 2: Add multiple workbooks to a schedule. - -`python accelerate_workbooks.py --add-to-schedule "My Schedule" --path-list paths.txt` - -Example 3: Remove multiple workbooks from a schedule. - -`python accelerate_workbooks.py –-remove-from-schedule "My Schedule" --path-list paths.txt` From 56512127715ba2d6c6cd06427081cc65d456a696 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Mon, 27 Apr 2020 10:26:23 -0700 Subject: [PATCH 050/158] [DOC] Fix connection usage in docs Fixing errors in the sample code for using datasource/workbook connections. The populate_connections method for workbook/datasource is implemented using the fetcher pattern, so it is best practice to save the connection items in a separate variable. --- docs/api-ref.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index e7488eb5a..ebb3d97c5 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -491,9 +491,10 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour server.datasources.populate_connections(datasource) # print the information about the first connection item - print(datasource.connections[0].connection_type) - print(datasource.connections[0].id) - print(datasource.connections[0].server_address) + connection = datasource.connections[0] + print(connection.connection_type) + print(connection.id) + print(connection.server_address) ... @@ -4026,12 +4027,16 @@ None. The connection information is updated with the information in the `Connect ```py +# query for workbook connections +server.workbooks.populate_connections(workbook) + # update connection item user name and password -workbook.connections[0].username = 'USERNAME' -workbook.connections[0].password = 'PASSWORD' +connection = workbook.connections[0] +connection.username = 'USERNAME' +connection.password = 'PASSWORD' # call the update method -server.workbooks.update_conn(workbook, workbook.connections[0]) +server.workbooks.update_conn(workbook, connection) ```
    From 95f0dacf59b5717c8b825a4354f58ff708b81daf Mon Sep 17 00:00:00 2001 From: Jac Date: Tue, 28 Apr 2020 10:34:00 -0700 Subject: [PATCH 051/158] Remove statement that you can use python 2.x (#605) * Remove statement that you can use python 2.x * Update index.md --- docs/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 43c8508b4..aec722ade 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,8 +19,7 @@ This section describes how to: Before you install TSC, confirm that you have the following dependencies installed: -* Python. You can use TSC with Python 2.7.9 or later and with Python 3.3 or later. These versions include pip, which is - the recommended means of installing TSC. +* Python. You can use TSC with Python 3.5 or later. * Git. Optional, but recommended to download the samples or install from the source code. From 9906ba62e2fd5754a393d97add73bb9eaf00972f Mon Sep 17 00:00:00 2001 From: Jac Date: Tue, 28 Apr 2020 10:34:40 -0700 Subject: [PATCH 052/158] Add Personal Access Token to the Auth page (#604) * Add Personal Access Token to the Auth page * fix code! --- docs/sign-in-out.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index ce8e7e960..a664a2cf4 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -9,6 +9,8 @@ To sign in and out of Tableau Server, call the server's `.auth.signin` method in import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', `SITENAME`) +# or for a personal access token +# tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') server = TSC.Server('https://SERVER_URL') with server.auth.sign_in(tableau_auth): @@ -19,6 +21,8 @@ with server.auth.sign_in(tableau_auth): `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. +'TOKEN_NAME' and 'TOKEN_VALUE' are your Personal Access Token values, generated in your Account Settings. + Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. The TSC library signs you out of Tableau Server when you exit out of the `with` block. @@ -33,7 +37,7 @@ An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.s ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will try to log the user into the Default site server = TSC.Server('http://SERVER_URL') server.auth.sign_in(tableau_auth) From 5223ce1c4fee38833d0f376121f3d4dcd526fc1e Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Thu, 30 Apr 2020 15:30:01 -0700 Subject: [PATCH 053/158] Add 2020.1 to API to release version mapping table --- docs/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions.md b/docs/versions.md index 5589985d0..aeab32836 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -68,3 +68,4 @@ The current version of TSC only supports the following REST API and Tableau Serv |3.4|2019.2| |3.5|2019.3| |3.6|2019.4| +|3.7|2020.1| From 3a6272d8808c895c0b3238ab73c928d2cf6ec91e Mon Sep 17 00:00:00 2001 From: mbren Date: Wed, 6 May 2020 15:31:27 -0400 Subject: [PATCH 054/158] add note that hourly interval schedules must start at top of hour --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index ebb3d97c5..b571905fc 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1729,7 +1729,7 @@ This class sets the frequency and start time of the scheduled item. This class c Name | Description :--- | :--- -`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. +`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. `DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. `WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. `MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The From d63d9824da90ddbb48575f95cab097c4ba81e0e1 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Tue, 19 May 2020 10:37:46 -0700 Subject: [PATCH 055/158] Adding legal and privacy links to footer Doc update: - For GDPR compliance, adding links to legal and privacy pages - Updating styles and formatting to match other Tableau assets --- _includes/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/footer.html b/_includes/footer.html index 35ea121c7..b73489dc7 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -3,7 +3,7 @@

    This site is open source. Suggestions and pull requests are welcome on our GitHub page.

    -

    © Copyright Tableau

    +

    LEGAL PRIVACY © 2003– TABLEAU SOFTWARE LLC. ALL RIGHTS RESERVED

    Documentation last generated on: {{ site.time }}
    From 116df2a827824a4180e0a6f066e86ac7b001b29f Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Tue, 19 May 2020 10:39:22 -0700 Subject: [PATCH 056/158] Update main.css --- css/main.css | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/css/main.css b/css/main.css index 05fd446ec..f9a61e939 100644 --- a/css/main.css +++ b/css/main.css @@ -273,4 +273,8 @@ html { .size-1of2 { width: 50%; } .size-1of3 { width: 33.333%; } - +/* Legal and Privacy Links */ +.aLegal { + word-spacing: 8px; + padding-right: 8px; +} From 585a6220768ce133ccc344d252225410af38f5a1 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Mon, 29 Jun 2020 15:38:28 -0700 Subject: [PATCH 057/158] Update docs with maxage info (#640) * Update docs with maxage info Docs for #635 and #639 * Addresses feedback for request options part of docs * Addresses remaining feedback to view and workbook methods --- docs/api-ref.md | 84 +++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 71 insertions(+), 13 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index b571905fc..51e4b4e26 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1595,9 +1595,15 @@ Name | Description ### CSVRequestOptions class ```py -CSVRequestOptions() +CSVRequestOptions(maxage=-1) ``` -Use this class to specify view filters to be applied when the CSV data is generated. See `views.populate_csv`. +Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a `maxage` value. See `views.populate_csv`. + +**Attributes** + +Name | Description +:--- | :--- +`maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. **Example** @@ -1607,7 +1613,7 @@ Use this class to specify view filters to be applied when the CSV data is genera # sign in, get a specific view, etc. # set view filters -csv_req_option = TSC.CSVRequestOptions() +csv_req_option = TSC.CSVRequestOptions(maxage=5) csv_req_option.vf('Region', 'South') csv_req_option.vf('Category', 'Furniture') @@ -1618,15 +1624,16 @@ server.views.populate_csv(view_item, csv_req_option) ### ImageRequestOptions class ```py -ImageRequestOptions(imageresolution=None) +ImageRequestOptions(imageresolution=None, maxage=-1) ``` -Use this class to specify the resolution of the view returned as an image. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. +Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. **Attributes** Name | Description :--- | :--- `imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +`maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. **View Filters** @@ -1640,7 +1647,7 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. # sign in, get a specific view, etc. # set the image request option -image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High) +image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) # (optional) set a view filter image_req_option.vf('Category', 'Furniture') @@ -1653,9 +1660,9 @@ server.views.populate_image(view_item, image_req_option) ### PDFRequestOptions class ```py -PDFRequestOptions(page_type=None, orientation=None) +PDFRequestOptions(page_type=None, orientation=None, maxage=-1) ``` -Use this class to specify the format of the PDF that is returned for the view. See `views.populate_pdf`. +Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. **Attributes** @@ -1663,6 +1670,7 @@ Name | Description :--- | :--- `page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
    `PageType.A3`
    `PageType.A4`
    `PageType.A5`
    `PageType.B5`
    `PageType.Executive`
    `PageType.Folio`
    `PageType.Ledger`
    `PageType.Legal`
    `PageType.Letter`
    `PageType.Note`
    `PageType.Quarto`
    `PageType.Tabloid` `orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
    `Orientation.Portrait`
    `Orientation.Landscape` +`maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. **View Filters** You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. @@ -1675,7 +1683,9 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. # sign in, get a specific view, etc. # set the PDF request options -pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, orientation=TSC.PDFRequestOptions.Orientation.Landscape) +pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, + orientation=TSC.PDFRequestOptions.Orientation.Landscape, + maxage=1) # (optional) set a view filter pdf_req_option.vf('Region', 'West') @@ -3259,7 +3269,7 @@ This endpoint is available with REST API version 2.5 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify a high resolution image. By default, the image will be in low resolution. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. **Exceptions** @@ -3306,7 +3316,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify view filters to be applied when the CSV data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. **Exceptions** @@ -3341,7 +3351,7 @@ views.populate_pdf(view_item, req_options=None) Populates the PDF content of the specified view. -This method uses the `id` field to query the PDF content, and populates the content as the `pdf` field. +This method populates a PDF with image(s) of the view you specify. REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} @@ -3354,7 +3364,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in a request object to specify the page type and orientation of the PDF content. If not specified, PDF content will have default page type and orientation. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. **Exceptions** @@ -3995,6 +4005,9 @@ None. The preview image is added to the view. ``` +
    +
    + #### workbooks.update_connection ```py @@ -4042,4 +4055,49 @@ server.workbooks.update_conn(workbook, connection)

    +#### workbooks.populate_pdf +``` +workbooks.populate_pdf(workbook_item, req_options=None) +``` + +Populates the PDF content of the specified workbook. + +This method populates a PDF with image(s) of the workbook view(s) you specify. + +REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 3.4 and up. + +**Parameters** + +Name | description +:--- | :--- +`workbook_item` | Specifies the workbook to populate. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID` | Raises an error if the ID of the workbook is missing. + +**Returns** + +None. The PDF content is added to the `workbook_item` and can be accessed by its `pdf` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the workbook pdf as 'workbook_pdf.pdf' +server.workbooks.populate_pdf(workbook_item) +with open('./workbook_pdf.pdf', 'wb') as f: + f.write(workbook_item.pdf) +``` + +
    +
    + From c93464893b8ae91b110ad9688869ebcec5767167 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Tue, 21 Jul 2020 10:02:11 -0700 Subject: [PATCH 058/158] Update download file in docs to latest (v0.12) Download link in docs was pointing to v0.7; latest is v0.12 --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index eeceabaf4..9ab8dbb70 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,6 @@ indexed_by_search: false

    The Tableau Server Client is a Python library for the Tableau Server REST API.


    Get Started   - Download + Download From b90818a35251c1148f2ba2c8ee96926baebc081a Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Wed, 22 Jul 2020 15:53:01 -0700 Subject: [PATCH 059/158] Update download link to always point to latest --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 9ab8dbb70..c19b7f087 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,6 @@ indexed_by_search: false

    The Tableau Server Client is a Python library for the Tableau Server REST API.


    Get Started   - Download + Download From b6a454678b00b4c94a8fab87edd7af707e5e6542 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 5 Aug 2020 17:47:54 -0700 Subject: [PATCH 060/158] Doc pages cleanup and minor editing - minor content edits - update Tableau doc links - update dev community forum links - add missing samples to samples.md list --- .gitignore | 6 +- _includes/docs_menu.html | 4 +- _includes/header.html | 2 +- docs/api-ref-x.md | 4103 ++++++++++++++++++++++++++++ docs/api-ref.md | 136 +- docs/api-ref.md.orig | 4103 ++++++++++++++++++++++++++++ docs/api-ref.md.rej | 68 + docs/dev-guide.md | 14 +- docs/filter-sort.md | 8 +- docs/index.md | 3 +- docs/page-through-results.md | 8 +- docs/patch | 612 +++++ docs/populate-connections-views.md | 2 +- docs/samples.md | 59 +- docs/sign-in-out.md | 16 +- docs/versions.md | 31 +- 16 files changed, 9021 insertions(+), 154 deletions(-) create mode 100644 docs/api-ref-x.md create mode 100644 docs/api-ref.md.orig create mode 100644 docs/api-ref.md.rej create mode 100644 docs/patch diff --git a/.gitignore b/.gitignore index d7496406b..e7dc31618 100644 --- a/.gitignore +++ b/.gitignore @@ -144,6 +144,6 @@ $RECYCLE.BIN/ *.lnk # Documentation -docs/_site/ -docs/.jekyll-metadata -docs/Gemfile.lock +_site/ +.jekyll-metadata +Gemfile.lock diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index 2f5ab1b04..5693ee67e 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -11,7 +11,7 @@ Versions
  • - Page through Results + Page Through Results
  • Populate Connections and Views @@ -53,7 +53,7 @@ Requests
  • - Schedules + Schedules
  • Server diff --git a/_includes/header.html b/_includes/header.html index a42240f87..b8ad08f65 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -15,7 +15,7 @@
      diff --git a/docs/api-ref-x.md b/docs/api-ref-x.md new file mode 100644 index 000000000..2cb41e0e5 --- /dev/null +++ b/docs/api-ref-x.md @@ -0,0 +1,4103 @@ +--- +title: API reference +layout: docs +--- + +
      + Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. + +
      + + + +The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. + +The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + +|:--- | +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| + + + +* TOC +{:toc } + +
      +
      + +--- + +## Authentication + +You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. + +
      +
      + +### TableauAuth class + +```py +TableauAuth(username, password, site_id='', user_id_to_impersonate=None) +``` +The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. + + + **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). + +**Attributes** + +Name | Description +:--- | :--- +`username` | The name of the user whose credentials will be used to sign in. +`password` | The password of the user. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. + +Source file: models/tableau_auth.py + +**Example** + +```py +import tableauserverclient as TSC +# create a new instance of a TableauAuth object for authentication + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') + +# create a server instance +# pass the "tableau_auth" object to the server.auth.sign_in() method +``` + +
      +
      + +### Auth methods +The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. + + +Source file: server/endpoint/auth_endpoint.py + +
      +
      + +#### auth.sign in + +```py +auth.sign_in(auth_req) +``` + +Signs you in to Tableau Server. + + +The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) + +**Parameters** + +`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an auth object +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') + +# create an instance for your server +server = TSC.Server('https://SERVER_URL') + +# call the sign-in method with the auth object +server.auth.sign_in(tableau_auth) + +``` + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
      +
      + + +#### auth.sign out + +```py +auth.sign_out() +``` +Signs you out of the current session. + +The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) + +**Example** + +```py + +server.auth.sign_out() + + +``` + + + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
      +
      + +--- + + +## Connections + +The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. + +### ConnectionItem class + +```py +ConnectionItem() +``` + +The `ConnectionItem` class corresponds to workbook and data source connections. + +In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. + +**Attributes** + +Name | Description + :--- | : --- +`datasource_id` | The identifier of the data source. +`datasource_name` | The name of the data source. +`id` | The identifier of the connection. +`connection_type` | The type of connection. +`username` | The username for the connection. +`password` | The password used for the connection. +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`server_address` | The server address for the connection. +`server_port` | The port used for the connection. + +Source file: models/connection_item.py + +
      +
      + + + +### ConnectionCredentials class + +```py +ConnectionCredentials(name, password, embed=True, oauth=False) +``` + + +The `ConnectionCredentials` class is used for workbook and data source publish requests. + + + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The username for the connection. +`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). +`password` | The password used for the connection. +`server_address` | The server address for the connection. +`server_port` | The port used by the server. +`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). + + +Source file: models/connection_credentials.py + +
      +
      + +--- + +## Data sources + +Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. +The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. + +
      + +### DatasourceItem class + +```py +DatasourceItem(project_id, name=None) +``` + +The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`certified` | A Boolean value that indicates whether the data source is certified. +`certification_note` | The optional note that describes the certified data source. +`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. +`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. +`name` | The name of the data source. If not specified, the name of the published data source file is used. +`owner_id` | The identifier of the owner of the data source. +`project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. +`project_name` | The name of the project associated with the data source. +`tags` | The tags (list of strings) that have been added to the data source. +`updated_at` | The date and time when the data source was last updated. + + +**Example** + +```py + import tableauserverclient as TSC + + # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39') +``` + + +Source file: models/datasource_item.py + +
      +
      + +### Datasources methods + +The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/datasources_endpoint.py + +
      +
      + +#### datasources.delete + +```py +datasources.delete(datasource_id) +``` + +Removes the specified data source from Tableau Server. + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source) + +
      +
      + + +#### datasources.download + +```py +datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None) + +``` +Downloads the specified data source in `.tdsx` or `.hyper` format. + +REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source) + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. +`include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. +`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. + +**Example** + +```py + + file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + print("\nDownloaded the file to {0}.".format(file_path)) + +``` + + +
      +
      + +#### datasources.get + +```py +datasources.get(req_options=None) +``` + +Returns all the data sources for the site. + +To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) + +REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources) + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. + + +**Returns** + +Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('https://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_datasources, pagination_item = server.datasources.get() + print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) + print([datasource.name for datasource in all_datasources]) +``` + + + +
      +
      + + +#### datasources.get_by_id + +```py +datasources.get_by_id(datasource_id) +``` + +Returns the specified data source item. + +REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The `datasource_id` specifies the data source to query. + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The `DatasourceItem`. See [DatasourceItem class](#datasourceitem-class) + + +**Example** + +```py + +datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e') +print(datasource.name) + +``` + + +
      +
      + + + +#### datasources.populate_connections + +```py +datasources.populate_connections(datasource_item) +``` + +Populates the connections for the specified data source. + +This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. + +REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the data source to populate with connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the data source + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + + +# get the connection information + server.datasources.populate_connections(datasource) + +# print the information about the first connection item + connection = datasource.connections[0] + print(connection.connection_type) + print(connection.id) + print(connection.server_address) + + ... + +``` + +
      +
      + +#### datasources.publish + +```py +datasources.publish(datasource_item, file_path, mode, connection_credentials=None) +``` + +Publishes a data source to a server, or appends data to an existing data source. + +This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. + +REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). +`file_path` | The path and name of the data source to publish. +`mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. + + +**Returns** + +The `DatasourceItem` for the data source that was added or appended to. + + +**Example** + +```py + + import tableauserverclient as TSC + server = TSC.Server('https://SERVERURL') + + ... + + project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' + file_path = r'C:\temp\WorldIndicators.tde' + + + # Use the project id to create new datsource_item + new_datasource = TSC.DatasourceItem(project_id) + + # publish data source (specified in file_path) + new_datasource = server.datasources.publish( + new_datasource, file_path, 'CreateNew') + + ... +``` + +
      +
      + +#### datasources.refresh + +```py +datasource.refresh(datasource_item) +``` + +Refreshes the data of the specified extract. + +REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +A refreshed `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# call the refresh method with the data source item + refreshed_datasource = server.datasources.refresh(datasource) + +``` +
      +
      + +#### datasources.update + +```py +datasource.update(datasource_item) +``` + +Updates the owner or project of the specified data source. Data source name cannot be updated. + +REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +An updated `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# do some updating + datasource.owner_id = 'New Owner ID' + +# call the update method with the data source item + updated_datasource = server.datasources.update(datasource) + + + +``` +
      +
      + +#### datasource.update_connection + +```py +datasource.update_connection(datasource_item, connection_item) +``` + +Updates the server address, port, username, or password for the specified data source connection. + +REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection) + + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. +`connection_item` | The `connection_item` that has the information you want to update. + + +**Returns** + +An updated `ConnectionItem` for the data source. + +**Example** + +See the `update_connection.py` sample in the Samples directory. + + +
      +
      + +## Filters + +The TSC library provides a `Filter` class that you can use to filter results returned from the server. + +You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +For more information, see [Filter and Sort](filter-sort). + + +### Filter class + +```py +Filter(field, operator, value) +``` + +The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. + + + +**Attributes** + +Name | Description +:--- | :--- +`Field` | Defined in the `RequestOptions.Field` class. +`Operator` | Defined in the `RequestOptions.Operator` class +`Value` | The value to compare with the specified field and operator. + + + + + +
      +
      + +--- + +## Groups + +Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group. + +The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. + +
      +
      + +### GroupItem class + +```py +GroupItem(name) +``` + +The `GroupItem` class contains the attributes for the group resources on Tableau Server. The `GroupItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/group_item.py + +**Attributes** + +Name | Description +:--- | :--- +`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). +`id` | The id of the group. +`users` | The list of users (`UserItem`). +`name` | The name of the group. The `name` is required when you create an instance of a group. + + + +**Example** + +```py + newgroup = TSC.GroupItem('My Group') + + # call groups.create() with new group +``` + + + + +
      +
      + +### Groups methods + +The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source file: server/endpoint/groups_endpoint.py + +
      +
      + +#### groups.add_user + +```py +groups.add_user(group_item, user_id): +``` + +Adds a user to the specified group. + + +REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`user_id` | The id of the user. + + + + +**Returns** + +None. + + +**Example** + +```py +# Adding a user to a group +# +# get the group item + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba' + +# add Ian to the group + server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba') + + + +``` + +
      +
      + +#### groups.create + +```py +create(group_item) +``` + +Creates a new group in Tableau Server. + + +REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. + + + + +**Returns** +Adds new `GroupItem`. + + +**Example** + +```py + +# Create a new group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + +# create a new instance with the group name + newgroup = TSC.GroupItem('My Group') + +# call the create method + newgroup = server.groups.create(newgroup) + +# print the names of the groups on the server + all_groups, pagination_item = server.groups.get() + for group in all_groups : + print(group.name, group.id) +``` + +
      +
      + +#### groups.delete + +```py +groups.delete(group_id) +``` + +Deletes the group on the site. + +REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) + + +**Parameters** + +Name | Description +:--- | :--- +`group_id` | The identifier (`id`) for the group that you want to remove from the server. + + +**Exceptions** + +Error | Description +:--- | :--- +`Group ID undefined` | Raises an exception if a valid `group_id` is not provided. + + +**Example** + +```py +# Delete a group from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + +``` +
      +
      + +#### groups.get + +```py +groups.get(req_options=None) +``` + +Returns information about the groups on the site. + + +To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. + + +REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. + + +**Returns** + +Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the groups on the server + all_groups, pagination_item = server.groups.get() + + # print the names of the first 100 groups + for group in all_groups : + print(group.name, group.id) +``` + + +
      +
      + +#### groups.populate_users + +```py +groups.populate_users(group_item, req_options=None) +``` + +Populates the `group_item` with the list of users. + + +REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to populate with user information. +`req_options` | (Optional) Additional request options to send to the endpoint. + + + +**Exceptions** + +`Group item missing ID. Group must be retrieved from server first.` : Raises an error if the `group_item` is unspecified. + + +**Returns** + +None. A list of `UserItem` objects are added to the group (`group_item.users`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the group + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# get the user information + pagination_item = server.groups.populate_users(mygroup) + + +# print the names of the users + for user in mygroup.users : + print(user.name) + + + + +``` + +
      +
      + +#### groups.remove_user + +```py +groups.remove_user(group_item, user_id) +``` + +Removes a user from a group. + + + + +REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to remove the user from. +`user_id` | The id for the user. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. + + +**Returns** + +None. The user is removed from the group. + + +**Example** + +```py +# Remove a user from the group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the group + mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + + # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' + server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` + +
      +
      + +--- + +## Jobs + +Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### JobItem class + +```py +JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0) + +``` + +The `JobItem` class contains information about the specified job running on Tableau Server. The `JobItem` class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload. + +Source file: models/job_item.py + +**Attributes** + +Name | Description +:--- | :--- +`id` | The `id` of the job. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. +`created_at` | The time the job was created. +`started_at` | The time the job started. +`completed_at` | The time the job finished. +`finish_code` | The return code from job. + + +### Jobs methods + + +The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +Source files: server/endpoint/jobs_endpoint.py + +
      +
      + + +#### jobs.get + + +```py +jobs.get(job_id) + +``` + +Gets information about the specified job. + +REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) + + +**Parameters** + +Name | Description +:--- | :--- +`job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory + + + + +**Exceptions** + +Error | Description +:--- | :--- +`404018 Resource Not Found` | Raises an error if the `job_id` is not found. + + +**Returns** + +Returns the `JobItem` requested. + + +**Example** + +```py +# Query a Job + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the id of the job from response to extract refresh task, + # or another asynchronous REST API call. + # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" + + + myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' + jobinfo = server.jobs.get(myJobID) + + print(jobinfo) + + # + + + + +``` + + +
      +
      + +--- + +## Projects + +Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. + +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + + + + +
      + +### ProjectItem class + +```py + +ProjectItem(name, description=None, content_permissions=None, parent_id=None) + +``` +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. + +**Attributes** + +Name | Description +:--- | :--- +`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. +`name` | Name of the project. +`description` | The description of the project. +`id` | The project id. +`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). + + + +Source file: models/project_item.py + + +#### ProjectItem.ContentPermissions + +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). + +Name | Description +:--- | :--- +`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. +`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + + +locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject +print(locked_true) +# prints 'LockedToProject' + +by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner +print(by_owner) +# prints 'ManagedByOwner' + + +# pass the content_permissions to new instance of the project item. +new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') + +``` + +
      +
      + +### Project methods + +The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + +Source files: server/endpoint/projects_endpoint.py + +
      +
      + + +#### projects.create + +```py +projects.create(project_item) +``` + + +Creates a project on the specified site. + +To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. + + +**Returns** +Returns the new project item. + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') + +with server.auth.sign_in(tableau_auth): + # create project item + new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') + # create the project + new_project = server.projects.create(new_project) + +``` + +
      +
      + + +#### projects.get + +```py +projects.get() + +``` + +Return a list of project items for a site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) + + +**Parameters** + +None. + +**Returns** + +Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + + + **Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') + +with server.auth.sign_in(tableau_auth): + # get all projects on site + all_project_items, pagination_item = server.projects.get() + print([proj.name for proj in all_project_items]) + +``` + +
      +
      + + +#### projects.update + +```py +projects.update(project_item) +``` + +Modify the project settings. + +You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. + + +**Exceptions** + +Error | Description + :--- | : --- +`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Returns** + +Returns the updated project information. + +See [ProjectItem class](#projectitem-class) + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + + ... + # get list of projects + all_project_items, pagination_item = server.projects.get() + + + # update project item #7 with new name, etc. + my_project = all_projects[7] + my_project.name ='New name' + my_project.description = 'New description' + + # call method to update project + updated_project = server.projects.update(my_project) + + + + +``` +
      +
      + + +#### projects.delete + +```py +projects.delete(project_id) +``` + +Deletes a project by ID. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) + + +**Parameters** + +Name | Description +:--- | :--- +`project_id` | The ID of the project to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + +``` + + +
      +
      + +--- + +## Requests + +The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. + +You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Groups +- Workbooks +- Views + + +You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. + +For more information about filtering and sorting, see [Filter and Sort](filter-sort). + + +
      + + + +### RequestOptions class + +```py +RequestOptions(pagenumber=1, pagesize=100) + +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`pagenumber` | The page number of the returned results. The default value is 1. +`pagesize` | The number of items to return with each page (the default value is 100). +`sort()` | Returns a iterable set of `Sort` objects. +`filter()` | Returns an iterable set of `Filter` objects. + +
      +
      + + + +#### RequestOptions.Field class + +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. + +**Attributes** + +**Attributes** + +Field | Description +:--- | :--- +`CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` +`LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` +`Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` +`OwnerName` | Same as 'ownerName' in the REST API. `RequestOptions.Field.OwnerName` +`SiteRole` | Same as 'siteRole' in the REST API. `RequestOptions.Field.SiteRole` +`Tags` | Same as 'tags' in the REST API. `RequestOptions.Field.Tags` +`UpdatedAt` | Same as 'updatedAt' in the REST API. `RequestOptions.Field.UpdatedAt` + + +
      +
      + + + +#### RequestOptions.Operator class + +Specifies the operators you can use to filter requests. + + +**Attributes** + +Operator | Description +:--- | :--- +`Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` +`GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` +`GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` +`LessThan` | Sets the operator to less than (same as `lt` in the REST API). `TSC.RequestOptions.Operator.LessThan` +`LessThanOrEqual` | Sets the operator to less than or equal (same as `lte` in the REST API). `TSC.RequestOptions.Operator.LessThanOrEqual` +`In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In` + +
      +
      + + + +#### RequestOptions.Direction class + +Specifies the direction to sort the returned fields. + + +**Attributes** + +Name | Description +:--- | :--- +`Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) +`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). + +
      +
      + +### CSVRequestOptions class + +```py +CSVRequestOptions(maxage=-1) +``` +Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a `maxage` value. See `views.populate_csv`. + +**Attributes** + +Name | Description +:--- | :--- +`maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +csv_req_option = TSC.CSVRequestOptions(maxage=5) +csv_req_option.vf('Region', 'South') +csv_req_option.vf('Category', 'Furniture') + +# retrieve the csv data for the view +server.views.populate_csv(view_item, csv_req_option) +``` + +### ImageRequestOptions class + +```py +ImageRequestOptions(imageresolution=None, maxage=-1) +``` +Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. + +**Attributes** + +Name | Description +:--- | :--- +`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +`maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**View Filters** + +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the image is generated, the specified filters will be applied to the view. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set the image request option +image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) + +# (optional) set a view filter +image_req_option.vf('Category', 'Furniture') + +# retrieve the image for the view +server.views.populate_image(view_item, image_req_option) + +``` + +### PDFRequestOptions class + +```py +PDFRequestOptions(page_type=None, orientation=None, maxage=-1) +``` +Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. + +**Attributes** + +Name | Description +:--- | :--- +`page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` +`orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` +`maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**View Filters** +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set the PDF request options +pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, + orientation=TSC.PDFRequestOptions.Orientation.Landscape, + maxage=1) + +# (optional) set a view filter +pdf_req_option.vf('Region', 'West') + +# retrieve the PDF for a view +server.views.populate_pdf(view_item, pdf_req_option) + +``` + + +
      +
      + +--- + +## Schedules + +Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### ScheduleItem class + +```py +ScheduleItem(name, priority, schedule_type, execution_order, interval_item) + +``` + +The `ScheduleItem` class contains information about the specified schedule running on Tableau Server. The `ScheduleItem` class defines the information you can query and set. The class members correspond to the attributes of a server response payload. + +Source file: models/schedule_item.py + +**Attributes** + +Name | Description +:--- | :--- +`name` | The `name` of the schedule. +`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. +`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. +`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. +`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. + + +#### IntervalItem class +This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. + +**Attributes** + +Name | Description +:--- | :--- +`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. +`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. +`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. +`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The + + + + +### Schedule methods + +The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. + + +Source files: server/endpoint/schedules_endpoint.py + +#### schedule.create + +```py +schedule.create(schedule_item) +``` +Creates a new schedule for an extract refresh or a subscription. + + +REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. + + +**Returns** + +Returns a new instance of `schedule_item`. + +**Exceptions** + +Error | Description +:--- | :--- +`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. + + +**Example** + +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +``` +
      +
      + + +#### schedule.delete + +```py +schedule.delete(schedule_id) +``` + +Deletes an existing schedule for an extract refresh or a subscription. + + +REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. + + +**Returns** + +None. + +**Exceptions** + +Error | Description +:--- | :--- +`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. + + +#### schedule.get + +```py +schedule.get([req_options=None]) +``` + +Returns all schedule items from the server. + + +REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) + + + +**Parameters** + +Name | Description +:--- | :--- +`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . + +#### schedule.update + +
      +
      + + +**Hourly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +``` + +**Daily schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a daily interval to run every day at 12:30AM + Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) + # Create schedule item using daily interval + daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) + # Create daily schedule + daily_schedule = server.schedules.create(daily_schedule) + +``` + +**Weekly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM + weekly_interval = TSC.WeeklyInterval(time(19, 15), + TSC.IntervalItem.Day.Monday, + TSC.IntervalItem.Day.Wednesday, + TSC.IntervalItem.Day.Friday) + # Create schedule item using weekly interval + weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) + # Create weekly schedule + weekly_schedule = server.schedules.create(weekly_schedule) + +``` + +**Monthly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a monthly interval to run on the 15th of every month at 11:30PM + monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), + interval_value=15) + # Create schedule item using monthly interval + monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, + TSC.ScheduleItem.Type.Subscription + TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) + # Create monthly schedule + monthly_schedule = server.schedules.create(monthly_schedule) +``` + + + +
      +
      + +--- + + +## Server + +In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) +The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. + + +
      +
      + + +### Server class + +```py +Server(server_address) +``` +The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. + +**Attributes** + +Attribute | Description +:--- | :--- +`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) + + + +**Example** + +```py +import tableauserverclient as TSC + + +# create a instance of server +server = TSC.Server('https://MY-SERVER') + +# sign in, etc. + +# change the REST API version to match the server +server.use_server_version() + +# or change the REST API version to match a specific version +# for example, 2.8 +# server.version = '2.8' + +``` + +#### Server.*Resources* + +When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` + + + +Resource | Description + :--- | : --- +*server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | +*server*.views | Access the server views and methods. See [Views](#views) +*server*.users | Access the user resources and methods. See [Users](#users) +*server*.sites | Access the sites. See [Sites](#sites) +*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) +*server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) +*server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) +*server*.projects | Access the resources and methods for projects. See [Projects](#projects) +*server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) +*server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) +*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class) + +
      +
      + +#### Server.PublishMode + +The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. + + +**Properties** + +Resource | Description + :--- | : --- +`PublishMode.Overwrite` | Overwrites the workbook or data source. +`PublishMode.Append` | Appends to the workbook or data source. +`PublishMode.CreateNew` | Creates a new workbook or data source. + + +**Example** + +```py + import tableauserverclient as TSC + # login, etc. + + print(TSC.Server.PublishMode.Overwrite) + # prints 'Overwrite' + + overwrite_true = TSC.Server.PublishMode.Overwrite + + ... + + # pass the PublishMode to the publish workbooks method + new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true) + + +``` + + +
      +
      + + +### ServerInfoItem class + +```py +ServerInfoItem(product_version, build_number, rest_api_version) +``` +The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. + +**Attributes** + +Name | Description +:--- | :--- +`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). +`build_number` | Shows the specific build number (for example, 10200.17.0329.1446). +`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. + + +
      +
      + + +### ServerInfo methods + +The TSC library provides a method to access the build and version information from Tableau Server. + +
      + +#### server_info.get + +```py +server_info.get() + +``` +Retrieve the build and version information for the server. + +This method makes an unauthenticated call, so no sign in or authentication token is required. + +REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) + +**Parameters** + None + +**Exceptions** + +Error | Description +:--- | :--- +`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. + +**Example** + +```py +import tableauserverclient as TSC + +# create a instance of server +server = TSC.Server('https://MY-SERVER') + +# set the version number > 2.3 +# the server_info.get() method works in 2.4 and later +server.version = '2.5' + +s_info = server.server_info.get() +print("\nServer info:") +print("\tProduct version: {0}".format(s_info.product_version)) +print("\tREST API version: {0}".format(s_info.rest_api_version)) +print("\tBuild number: {0}".format(s_info.build_number)) + +``` + + +
      +
      + +--- + +## Sites + +Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. + +The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. + +
      +
      + +### SiteItem class + +```py +SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None, + disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) +``` + +The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The name of the site. The name of the default site is "". +`content_url` | The path to the site. +`admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) +`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. +`storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. +`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. +`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. +`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. +`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. +`state` | Shows the current state of the site (`Active` or `Suspended`). + + +**Example** + +```py + +# create a new instance of a SiteItem + +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True) + +``` + +Source file: models/site_item.py + +
      +
      + + +### Site methods + +The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. + + +Source file: server/endpoint/sites_endpoint.py + +
      +
      + +#### sites.create + +```py +sites.create(site_item) +``` + +Creates a new site on the server for the specified site item object. + +Tableau Server only. + + +REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) + + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. + + +**Returns** + +Returns a new instance of `SiteItem`. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an instance of server +server = TSC.Server('https://MY-SERVER') + +# create shortcut for admin mode +content_users=TSC.SiteItem.AdminMode.ContentAndUsers + +# create a new SiteItem +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True) + +# call the sites create method with the SiteItem +new_site = server.sites.create(new_site) +``` +
      +
      + +#### sites.get + +```py +sites.get() +``` + +Queries all the sites on the server. + + +REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) + + +**Parameters** + + None. + +**Returns** + +Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + # query the sites + all_sites, pagination_item = server.sites.get() + + # print all the site names and ids + for site in all_sites: + print(site.id, site.name, site.content_url, site.state) + + +``` + +
      +
      + + + +#### sites.get_by_id + +```py +sites.get_by_id(site_id) +``` + +Queries the site with the given ID. + + +REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) + +**Parameters** + +Name | Description +:--- | :--- +`site_id` | The id for the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site ID undefined.` | Raises an error if an id is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) + +``` + +
      +
      + +#### sites.get_by_name + +```py +sites.get_by_name(site_name) +``` + +Queries the site with the specified name. + + +REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) + +**Parameters** + +Name | Description +:--- | :--- +`site_name` | The name of the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site Name undefined.` | Raises an error if an name is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_name('MY_SITE') + + +``` + +
      +
      + + + +#### sites.update + +```py +sites.update(site_item) +``` + +Modifies the settings for site. + + +The site item object must include the site ID and overrides all other settings. + + +REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. + + +**Exceptions** + +Error | Description +:--- | :--- +`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. +`You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` + + +**Returns** + +Returns the updated `site_item`. + + +**Example** + +```py +... + +# make some updates to an existing site_item +site_item.name ="New name" + +# call update +site_item = server.sites.update(site_item) + +... +``` + +
      +
      + + + + +#### sites.delete + + +```py +Sites.delete(site_id) +``` + +Deletes the specified site. + + +REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site) + + +**Parameters** + +Name | Description + :--- | : --- +`site_id` | The id of the site that you want to delete. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. + + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + +server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + +``` + +
      +
      + +--- + + +## Sort + +The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. + +You can use the sort and request options to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +### Sort class + +```py +sort(field, direction) +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. +`direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. + +**Example** + +```py + +# create a new instance of a request option object +req_option = TSC.RequestOptions() + +# add the sort expression, sorting by name and direction +req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, + TSC.RequestOptions.Direction.Asc)) +matching_workbooks, pagination_item = server.workbooks.get(req_option) + +for wb in matching_workbooks: + print(wb.name) +``` + +For information about using the `Sort` class, see [Filter and Sort](filter-sort). + +
      +
      + +--- + +## Subscriptions + +Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions. + +### SubscriptionItem class + +The subscription resources for Tableau Server are defined in the `SubscriptionItem` class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the `SubscriptionItem` class. + +```py +SubscriptionItem(subject, schedule_id, user_id, target) + +``` + +**Attributes** + +Name | Description +:--- | :--- +`id` | The id of the subscription on the site. +`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. +`schedule_id` | The identifier associated with the specific subscription. +`user_id` | The identifier of the user (person) who receives the subscription. +`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. + + + + +Source files: server/endpoints/subscription_item.py + + +### Subscription methods + +The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source files: server/endpoints/subscriptions_endpoint.py + +
      +
      + +#### subscription.create + +```py +subscription.create(subscription_item) +``` +Creates a subscription to a view or workbook for a specific user. +When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. + +To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). + + +REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription) + +**Parameters** + +Name | Description + :--- | : --- +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. + + +**Returns** + +Returns the new `SubscriptionItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# create auth, specify site +# login, etc. + + +# create the target (content) of the subscription +# in this case, id of the workbook add the target type "workbook" + + target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') + +# the ids for the schedule and user + schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') + user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' + +# create a new SubscriptionItem object. + newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) + +# create the new subscription to the site + newSub = server.subscriptions.create(newSub) + print(newUSub.subject) + +``` + + +
      +
      + + + +#### subscriptions.delete + +```py +subscriptions.delete(subscription_id) +``` + + + +Deletes the specified subscription from the site. + +REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. + + +**Exceptions** + +Error | Description + :--- | : --- +`Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. + + +**Example** + +```py +# Remove a subscription from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') +# server = TSC.Server('https://SERVERURL') + + + with server.auth.sign_in(tableau_auth): + server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
      +
      + +
      +
      + +#### subscription.get + +```py +subscription.get(req_options=None) +``` +Returns information about the subscriptions on the specified site. + + +REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions) + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. + + +**Returns** +Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +
      +
      + +#### subscription.get_by_id + + +```py +subscription.get_by_id(subscription_id) +``` + +Returns information about the specified subscription. + +REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The `subscription_id` specifies the subscription to query. + + + +**Exceptions** + +Error | Description + :--- | : --- +`No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. + + +**Returns** + +The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) + + +**Example** + +```py + sub1 = server.subscription.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(sub1.subject) + +``` + + + + + +
      +
      + +--- + +## Users + +Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. + +The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. + + +### UserItem class + +```py +UserItem(name, site_role, auth_setting=None) +``` + +The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Name | Description +:--- | :--- +`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`domain_name` | The name of the site. +`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. +`id` | The id of the user on the site. +`last_login` | The date and time the user last logged in. +`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. +`email` | The email address of the user. +`fullname` | The full name of the user. +`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') + +# create a new UserItem object. + newU = TSC.UserItem('Monty', 'Publisher') + + print(newU.name, newU.site_role) + +``` + +Source file: models/user_item.py + +
      +
      + + +### Users methods + +The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/users_endpoint.py +
      +
      + +#### users.add + +```py +users.add(user_item) +``` + +Adds the user to the site. + +To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. + +REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns the new `UserItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# login, etc. + +# create a new UserItem object. + newU = TSC.UserItem('Heather', 'Publisher') + +# add the new user to the site + newU = server.users.add(newU) + print(newU.name, newU.site_role) + +``` + +#### users.get + +```py +users.get(req_options=None) +``` + +Returns information about the users on the specified site. + +To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. + + +REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('https://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_users, pagination_item = server.users.get() + print("\nThere are {} user on site: ".format(pagination_item.total_available)) + print([user.name for user in all_users]) +``` + +
      +
      + +#### users.get_by_id + + +```py +users.get_by_id(user_id) +``` + +Returns information about the specified user. + +REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The `user_id` specifies the user to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined.` | Raises an exception if a valid `user_id` is not provided. + + +**Returns** + +The `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + user1 = server.users.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(user1.name) + +``` + +
      +
      + + +#### users.populate_favorites + +```py +users.populate_favorites(user_item) +``` + +Returns the list of favorites (views, workbooks, and data sources) for a user. + +*Not currently implemented* + +
      +
      + + +#### users.populate_workbooks + +```py +users.populate_workbooks(user_item, req_options=None): +``` + +Returns information about the workbooks that the specified user owns and has Read (view) permissions for. + + +This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). + +REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to populate with workbook information. + + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +A list of `WorkbookItem` + +A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) + + +**Example** + +```py +# first get all users, call server.users.get() +# get workbooks for user[0] + ... + + page_n = server.users.populate_workbooks(all_users[0]) + print("\nUser {0} owns or has READ permissions for {1} workbooks".format(all_users[0].name, page_n.total_available)) + print("\nThe workbooks are:") + for workbook in all_users[0].workbooks : + print(workbook.name) + + ... +``` + + + + +
      +
      + +#### users.remove + +```py +users.remove(user_id) +``` + + + +Removes the specified user from the site. + +REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The identifier (`id`) for the user that you want to remove from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined` | Raises an exception if a valid `user_id` is not provided. + + +**Example** + +```py +# Remove a user from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
      +
      + + + + +#### users.update + +```py +users.update(user_item, password=None) +``` + +Updates information about the specified user. + +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). + + + +REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user) + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to update. +`password` | (Optional) The new password for the user. + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +An updated `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # create a new user_item + user1 = TSC.UserItem('temp', 'Viewer') + + # add new user + user1 = server.users.add(user1) + print(user1.name, user1.site_role, user1.id) + + # modify user info + user1.name = 'Laura' + user1.fullname = 'Laura Rodriguez' + user1.email = 'laura@example.com' + + # update user + user1 = server.users.update(user1) + print("\Updated user info:") + print(user1.name, user1.fullname, user1.email, user1.id) + + +``` + + + +
      +
      + + +--- + +## Views + +Using the TSC library, you can get information about views in a site or a workbook. + +The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. + +
      + +### ViewItem class + +``` +ViewItem() +``` + +The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/view_item.py + +**Attributes** + +Name | Description +:--- | :--- +`content_url` | The name of the view as it would appear in a URL. +`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. +`id` | The identifier of the view item. +`image` | The image of the view. You must first call the `views.populate_image`method to access the image. +`name` | The name of the view. +`owner_id` | The ID for the owner of the view. +`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content. +`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image. +`project_id` | The ID of the project that contains the view. +`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. +`workbook_id` | The ID of the workbook associated with the view. + + +
      +
      + + +### Views methods + +The Tableau Server Client provides methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. + +Source file: server/endpoint/views_endpoint.py + +
      +
      + +#### views.get +``` +views.get(req_options=None, usage=False) +``` + +Returns the list of views items for a site. + + +REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site) + +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. +`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. + + + +**Returns** + +Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + all_views, pagination_item = server.views.get() + print([view.name for view in all_views]) +``` + +**Example using Pager** + +You can also use the provided Pager generator to get all views on site, without having to page through the results. +```py +for view in TSC.Pager(server.views): + print(view.name) +``` + +See [ViewItem class](#viewitem-class) + + +
      +
      + +#### views.populate_preview_image + +```py + views.populate_preview_image(view_item) +``` + +Populates a preview image for the specified view. + +This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. + +REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview) + +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | Specifies the view to populate. + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. + + +**Returns** + +None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the preview image as 'view_preview_image.png' +server.views.populate_preview_image(view_item) +with open('./view_preview_image.png', 'wb') as f: + f.write(view_item.preview_image) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_image + +```py +views.populate_image(view_item, req_options=None) +``` + +Populates the image of the specified view. + +This method uses the `id` field to query the image, and populates the image content as the `image` field. + +REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image) + +**Version** + +This endpoint is available with REST API version 2.5 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The image is added to the `view_item` and can be accessed by its `image` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view image as 'view_image.png' +server.views.populate_image(view_item) +with open('./view_image.png', 'wb') as f: + f.write(view_item.image) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_csv +``` +views.populate_csv(view_item) +``` + +Populates the CSV data of the specified view. + +This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. + +REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data) + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the CSV data as 'view_csv.csv' +server.views.populate_csv(view_item) +with open('./view_csv.csv', 'wb') as f: + # Perform byte join on the CSV data + f.write(b''.join(view_item.csv)) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_pdf +``` +views.populate_pdf(view_item, req_options=None) +``` + +Populates the PDF content of the specified view. + +This method populates a PDF with image(s) of the view you specify. + +REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf) + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view pdf as 'view_pdf.pdf' +server.views.populate_pdf(view_item) +with open('./view_pdf.pdf', 'wb') as f: + f.write(view_item.pdf) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + + +--- + + +## Workbooks + +Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. + +The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. + + + + + +
      +
      + +### WorkbookItem class + +```py + + WorkbookItem(project_id, name=None, show_tabs=False) + +``` +The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project + + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. +`name` | The name of the workbook. +`owner_id` | The ID of the owner. +`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. +`project_id` | The project id. +`project_name` | The name of the project. +`size` | The size of the workbook (in megabytes). +`show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. +`tags` | The tags that have been added to the workbook. +`updated_at` | The date and time when the workbook was last updated. +`views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). + + + + + +**Example** + +```py +# creating a new instance of a WorkbookItem +# +import tableauserverclient as TSC + +# Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') + + +```` + +Source file: models/workbook_item.py + +
      +
      + +### Workbook methods + +The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. +The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. + + + +Source files: server/endpoint/workbooks_endpoint.py + +
      +
      + +#### workbooks.get + +```py +workbooks.get(req_options=None) +``` + +Queries the server and returns information about the workbooks the site. + + + + + +REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site) + + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) + + +**Returns** + +Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + all_workbooks_items, pagination_item = server.workbooks.get() + # print names of first 100 workbooks + print([workbook.name for workbook in all_workbooks_items]) + + + +``` + +
      +
      + + + +#### workbooks.get_by_id + +```py +workbooks.get_by_id(workbook_id) +``` + +Returns information about the specified workbook on the site. + +REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook) + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). + + +**Exceptions** + +Error | Description + :--- | : --- +`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. + + +**Returns** + +The `WorkbookItem`. See [WorkbookItem class](#workbookitem-class) + + +**Example** + +```py + +workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') +print(workbook.name) + +``` + + +
      +
      + + +#### workbooks.publish + +```py +workbooks.publish(workbook_item, file_path, publish_mode) +``` + +Publish a workbook to the specified site. + +**Note:** The REST API cannot automatically include +extracts or other resources that the workbook uses. Therefore, + a .twb file that uses data from an Excel or csv file on a local computer cannot be published, +unless you package the data and workbook in a .twbx file, or publish the data source separately. + +For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. + +REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) + + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). +`file_path` | The path and name of the workbook to publish. +`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. +`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. + +See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. + +**Returns** + +The `WorkbookItem` for the workbook that was published. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + # create a workbook item + wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + # call the publish method with the workbook item + wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') +``` + +
      +
      + +#### workbooks.refresh + +```py +workbooks.refresh(workbook_item) +``` + + +Refreshes the extract of an existing workbook. + +REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # call the update method + workbook = server.workbooks.refresh(workbook) + print("\nThe data of workbook {0} is refreshed.".format(workbook.name)) + + +``` + + +
      +
      + +#### workbooks.update + +```py +workbooks.update(workbook_item) +``` + + +Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. + +REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook) + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nUpdate {0} workbook. Project was {1}".format(workbook.name, workbook.project_name)) + + + # make an change, for example a new project ID + workbook.project_id = '1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e' + + # call the update method + workbook = server.workbooks.update(workbook) + print("\nUpdated {0} workbook. Project is now {1}".format(workbook.name, workbook.project_name)) + + +``` + + +
      +
      + + + +#### workbooks.delete + +```py +workbooks.delete(workbook_id) +``` + +Deletes a workbook with the specified ID. + + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID of the workbook to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# tableau_auth sign in, etc. + + server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + +``` + + +
      +
      + + +#### workbooks.download + +```py +workbooks.download(workbook_id, filepath=None, no_extract=False) +``` + +Downloads a workbook to the specified directory (optional). + + +REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook) + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. +`no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded workbook. + + +**Example** + +```py + + file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nDownloaded the file to {0}.".format(file_path)) + +```` + + +
      +
      + + +#### workbooks.populate_views + +```py +workbooks.populate_views(workbook_item) +``` + +Populates (or gets) a list of views for a workbook. + +You must first call this method to populate views before you can iterate through the views. + +This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. + +REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. + + +**Returns** + +None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the view information + server.workbooks.populate_views(workbook) + +# print information about the views for the work item + print("\nThe views for {0}: ".format(workbook.name)) + print([view.name for view in workbook.views]) + + ... + +``` + +
      +
      + +#### workbooks.populate_connections + +```py +workbooks.populate_connections(workbook_item) +``` + +Populates a list of data source connections for the specified workbook. + +You must populate connections before you can iterate through the +connections. + +This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. + +REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the connection information + server.workbooks.populate_connections(workbook) + +# print information about the data connections for the workbook item + print("\nThe connections for {0}: ".format(workbook.name)) + print([connection.id for connection in workbook.connections]) + + + ... + +``` + +
      +
      + + +#### workbooks.populate_preview_image + +```py +workbooks.populate_preview_image(workbook_item) +``` + +This method gets the preview image (thumbnail) for the specified workbook item. + +The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. + +REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. + + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. + + + +**Returns** + +None. The preview image is added to the view. + + + +**Example** + +```py + +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') + + ... + + # get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # add the png thumbnail to the workbook item + server.workbooks.populate_preview_image(workbook) + + +``` + +
      +
      + +#### workbooks.update_connection + +```py +workbooks.update_conn(workbook_item, connection_item) +``` + +Updates a workbook connection information (server address, server port, user name, and password). + +The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) + +REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection) + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. +`connection_item` | The `connection_item` that has the information you want to update. + + + +**Returns** + +None. The connection information is updated with the information in the `ConnectionItem`. + + + + +**Example** + +```py + +# query for workbook connections +server.workbooks.populate_connections(workbook) + +# update connection item user name and password +connection = workbook.connections[0] +connection.username = 'USERNAME' +connection.password = 'PASSWORD' + +# call the update method +server.workbooks.update_conn(workbook, connection) +``` + +
      +
      + +#### workbooks.populate_pdf +``` +workbooks.populate_pdf(workbook_item, req_options=None) +``` + +Populates the PDF content of the specified workbook. + +This method populates a PDF with image(s) of the workbook view(s) you specify. + +REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) + +**Version** + +This endpoint is available with REST API version 3.4 and up. + +**Parameters** + +Name | description +:--- | :--- +`workbook_item` | Specifies the workbook to populate. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID` | Raises an error if the ID of the workbook is missing. + +**Returns** + +None. The PDF content is added to the `workbook_item` and can be accessed by its `pdf` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the workbook pdf as 'workbook_pdf.pdf' +server.workbooks.populate_pdf(workbook_item) +with open('./workbook_pdf.pdf', 'wb') as f: + f.write(workbook_item.pdf) +``` + +
      +
      + + diff --git a/docs/api-ref.md b/docs/api-ref.md index 51e4b4e26..71e0a3a15 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. |:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| @@ -90,7 +90,7 @@ Signs you in to Tableau Server. The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} +REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) **Parameters** @@ -131,7 +131,7 @@ Signs you out of the current session. The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). -REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} +REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) **Example** @@ -210,7 +210,7 @@ Attribute | Description `password` | The password used for the connection. `server_address` | The server address for the connection. `server_port` | The port used by the server. -`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. +`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). Source file: models/connection_credentials.py @@ -302,7 +302,7 @@ Error | Description `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. -REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} +REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source)

      @@ -316,7 +316,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr ``` Downloads the specified data source in `.tdsx` or `.hyper` format. -REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} +REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source) **Parameters** @@ -361,7 +361,7 @@ Returns all the data sources for the site. To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) -REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} +REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources) **Parameters** @@ -404,7 +404,7 @@ datasources.get_by_id(datasource_id) Returns the specified data source item. -REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} +REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) **Parameters** @@ -451,7 +451,7 @@ Populates the connections for the specified data source. This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. -REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} +REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) **Parameters** @@ -513,7 +513,7 @@ Publishes a data source to a server, or appends data to an existing data source. This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. -REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} +REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) **Parameters** @@ -574,7 +574,7 @@ datasource.refresh(datasource_item) Refreshes the data of the specified extract. -REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} +REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) **Parameters** @@ -621,7 +621,7 @@ datasource.update(datasource_item) Updates the owner or project of the specified data source. Data source name cannot be updated. -REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} +REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) **Parameters** @@ -673,7 +673,7 @@ datasource.update_connection(datasource_item, connection_item) Updates the server address, port, username, or password for the specified data source connection. -REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} +REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection) **Parameters** @@ -801,7 +801,7 @@ groups.add_user(group_item, user_id): Adds a user to the specified group. -REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} +REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) **Parameters** @@ -848,7 +848,7 @@ create(group_item) Creates a new group in Tableau Server. -REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} +REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) **Parameters** @@ -898,7 +898,7 @@ groups.delete(group_id) Deletes the group on the site. -REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} +REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) **Parameters** @@ -943,7 +943,7 @@ Returns information about the groups on the site. To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. -REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} +REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) **Parameters** @@ -988,7 +988,7 @@ groups.populate_users(group_item, req_options=None) Populates the `group_item` with the list of users. -REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} +REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) **Parameters** @@ -1049,7 +1049,7 @@ Removes a user from a group. -REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} +REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) **Parameters** @@ -1122,7 +1122,7 @@ Source file: models/job_item.py Name | Description :--- | :--- `id` | The `id` of the job. -`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. `created_at` | The time the job was created. `started_at` | The time the job started. `completed_at` | The time the job finished. @@ -1151,7 +1151,7 @@ jobs.get(job_id) Gets information about the specified job. -REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} +REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) **Parameters** @@ -1238,7 +1238,7 @@ Name | Description `name` | Name of the project. `description` | The description of the project. `id` | The project id. -`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. +`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). @@ -1247,7 +1247,7 @@ Source file: models/project_item.py #### ProjectItem.ContentPermissions -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). Name | Description :--- | :--- @@ -1303,7 +1303,7 @@ Creates a project on the specified site. To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} +REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) **Parameters** @@ -1348,7 +1348,7 @@ Return a list of project items for a site. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} +REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) **Parameters** @@ -1389,7 +1389,7 @@ Modify the project settings. You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} +REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) **Parameters** @@ -1451,7 +1451,7 @@ Deletes a project by ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} +REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) **Parameters** @@ -1534,7 +1534,7 @@ Name | Description #### RequestOptions.Field class -The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. **Attributes** @@ -1762,7 +1762,7 @@ schedule.create(schedule_item) Creates a new schedule for an extract refresh or a subscription. -REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} +REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) @@ -1811,7 +1811,7 @@ schedule.delete(schedule_id) Deletes an existing schedule for an extract refresh or a subscription. -REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} +REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) @@ -1842,7 +1842,7 @@ schedule.get([req_options=None]) Returns all schedule items from the server. -REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} +REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) @@ -1948,7 +1948,7 @@ The `Server` class contains the attributes that represent the server on Tableau Attribute | Description :--- | :--- `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). -`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} +`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). @@ -2070,7 +2070,7 @@ Retrieve the build and version information for the server. This method makes an unauthenticated call, so no sign in or authentication token is required. -REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} +REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) **Parameters** None @@ -2178,7 +2178,7 @@ Creates a new site on the server for the specified site item object. Tableau Server only. -REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} +REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) @@ -2223,7 +2223,7 @@ sites.get() Queries all the sites on the server. -REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} +REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) **Parameters** @@ -2266,7 +2266,7 @@ sites.get_by_id(site_id) Queries the site with the given ID. -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} +REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) **Parameters** @@ -2312,7 +2312,7 @@ sites.get_by_name(site_name) Queries the site with the specified name. -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} +REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) **Parameters** @@ -2363,7 +2363,7 @@ Modifies the settings for site. The site item object must include the site ID and overrides all other settings. -REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} +REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) **Parameters** @@ -2416,7 +2416,7 @@ Sites.delete(site_id) Deletes the specified site. -REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} +REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site) **Parameters** @@ -2553,7 +2553,7 @@ When a user is subscribed to the content, Tableau Server sends the content to th To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). -REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} +REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription) **Parameters** @@ -2612,7 +2612,7 @@ subscriptions.delete(subscription_id) Deletes the specified subscription from the site. -REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} +REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) **Parameters** @@ -2657,7 +2657,7 @@ subscription.get(req_options=None) Returns information about the subscriptions on the specified site. -REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} +REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions) **Parameters** @@ -2682,7 +2682,7 @@ subscription.get_by_id(subscription_id) Returns information about the specified subscription. -REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} +REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) **Parameters** @@ -2790,7 +2790,7 @@ Adds the user to the site. To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. -REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} +REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) **Parameters** @@ -2833,7 +2833,7 @@ Returns information about the users on the specified site. To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. -REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} +REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) **Parameters** @@ -2873,7 +2873,7 @@ users.get_by_id(user_id) Returns information about the specified user. -REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} +REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) **Parameters** @@ -2932,7 +2932,7 @@ Returns information about the workbooks that the specified user owns and has Rea This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). -REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} +REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) **Parameters** @@ -2989,7 +2989,7 @@ users.remove(user_id) Removes the specified user from the site. -REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} +REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) **Parameters** @@ -3033,11 +3033,11 @@ users.update(user_item, password=None) Updates information about the specified user. -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). -REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} +REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user) **Parameters** @@ -3154,7 +3154,7 @@ views.get(req_options=None, usage=False) Returns the list of views items for a site. -REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} +REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site) **Version** @@ -3209,7 +3209,7 @@ Populates a preview image for the specified view. This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. -REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} +REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview) **Version** @@ -3258,7 +3258,7 @@ Populates the image of the specified view. This method uses the `id` field to query the image, and populates the image content as the `image` field. -REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} +REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image) **Version** @@ -3305,7 +3305,7 @@ Populates the CSV data of the specified view. This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. -REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} +REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data) **Version** @@ -3353,7 +3353,7 @@ Populates the PDF content of the specified view. This method populates a PDF with image(s) of the view you specify. -REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} +REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf) **Version** @@ -3484,7 +3484,7 @@ Queries the server and returns information about the workbooks the site. -REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} +REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site) **Parameters** @@ -3529,7 +3529,7 @@ workbooks.get_by_id(workbook_id) Returns information about the specified workbook on the site. -REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} +REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook) **Parameters** @@ -3580,7 +3580,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. -REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} +REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) @@ -3604,7 +3604,7 @@ Error | Description `Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. `Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. -See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. +See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. **Returns** @@ -3638,7 +3638,7 @@ workbooks.refresh(workbook_item) Refreshes the extract of an existing workbook. -REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} +REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) **Parameters** @@ -3684,7 +3684,7 @@ workbooks.update(workbook_item) Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. -REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} +REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook) **Parameters** @@ -3742,7 +3742,7 @@ Deletes a workbook with the specified ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} +REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) **Parameters** @@ -3786,7 +3786,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False) Downloads a workbook to the specified directory (optional). -REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} +REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook) **Parameters** @@ -3837,7 +3837,7 @@ You must first call this method to populate views before you can iterate through This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. -REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} +REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) **Parameters** @@ -3900,7 +3900,7 @@ connections. This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. -REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} +REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) **Parameters** @@ -3962,7 +3962,7 @@ This method gets the preview image (thumbnail) for the specified workbook item. The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. -REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} +REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) **Parameters** @@ -4018,7 +4018,7 @@ Updates a workbook connection information (server address, server port, user nam The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) -REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} +REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection) **Parameters** @@ -4064,7 +4064,7 @@ Populates the PDF content of the specified workbook. This method populates a PDF with image(s) of the workbook view(s) you specify. -REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} +REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) **Version** diff --git a/docs/api-ref.md.orig b/docs/api-ref.md.orig new file mode 100644 index 000000000..51e4b4e26 --- /dev/null +++ b/docs/api-ref.md.orig @@ -0,0 +1,4103 @@ +--- +title: API reference +layout: docs +--- + +
      + Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. + +
      + + + +The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. + +The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + +|:--- | +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| + + + +* TOC +{:toc } + +
      +
      + +--- + +## Authentication + +You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. + +
      +
      + +### TableauAuth class + +```py +TableauAuth(username, password, site_id='', user_id_to_impersonate=None) +``` +The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. + + + **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). + +**Attributes** + +Name | Description +:--- | :--- +`username` | The name of the user whose credentials will be used to sign in. +`password` | The password of the user. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. + +Source file: models/tableau_auth.py + +**Example** + +```py +import tableauserverclient as TSC +# create a new instance of a TableauAuth object for authentication + +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') + +# create a server instance +# pass the "tableau_auth" object to the server.auth.sign_in() method +``` + +
      +
      + +### Auth methods +The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. + + +Source file: server/endpoint/auth_endpoint.py + +
      +
      + +#### auth.sign in + +```py +auth.sign_in(auth_req) +``` + +Signs you in to Tableau Server. + + +The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} + +**Parameters** + +`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an auth object +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') + +# create an instance for your server +server = TSC.Server('https://SERVER_URL') + +# call the sign-in method with the auth object +server.auth.sign_in(tableau_auth) + +``` + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
      +
      + + +#### auth.sign out + +```py +auth.sign_out() +``` +Signs you out of the current session. + +The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). + +REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} + +**Example** + +```py + +server.auth.sign_out() + + +``` + + + + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
      +
      + +--- + + +## Connections + +The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. + +### ConnectionItem class + +```py +ConnectionItem() +``` + +The `ConnectionItem` class corresponds to workbook and data source connections. + +In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. + +**Attributes** + +Name | Description + :--- | : --- +`datasource_id` | The identifier of the data source. +`datasource_name` | The name of the data source. +`id` | The identifier of the connection. +`connection_type` | The type of connection. +`username` | The username for the connection. +`password` | The password used for the connection. +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`server_address` | The server address for the connection. +`server_port` | The port used for the connection. + +Source file: models/connection_item.py + +
      +
      + + + +### ConnectionCredentials class + +```py +ConnectionCredentials(name, password, embed=True, oauth=False) +``` + + +The `ConnectionCredentials` class is used for workbook and data source publish requests. + + + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The username for the connection. +`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). +`password` | The password used for the connection. +`server_address` | The server address for the connection. +`server_port` | The port used by the server. +`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. + + +Source file: models/connection_credentials.py + +
      +
      + +--- + +## Data sources + +Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. +The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. + +
      + +### DatasourceItem class + +```py +DatasourceItem(project_id, name=None) +``` + +The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`certified` | A Boolean value that indicates whether the data source is certified. +`certification_note` | The optional note that describes the certified data source. +`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. +`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. +`name` | The name of the data source. If not specified, the name of the published data source file is used. +`owner_id` | The identifier of the owner of the data source. +`project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. +`project_name` | The name of the project associated with the data source. +`tags` | The tags (list of strings) that have been added to the data source. +`updated_at` | The date and time when the data source was last updated. + + +**Example** + +```py + import tableauserverclient as TSC + + # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39') +``` + + +Source file: models/datasource_item.py + +
      +
      + +### Datasources methods + +The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/datasources_endpoint.py + +
      +
      + +#### datasources.delete + +```py +datasources.delete(datasource_id) +``` + +Removes the specified data source from Tableau Server. + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} + +
      +
      + + +#### datasources.download + +```py +datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None) + +``` +Downloads the specified data source in `.tdsx` or `.hyper` format. + +REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. +`include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. +`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. + +**Example** + +```py + + file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + print("\nDownloaded the file to {0}.".format(file_path)) + +``` + + +
      +
      + +#### datasources.get + +```py +datasources.get(req_options=None) +``` + +Returns all the data sources for the site. + +To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) + +REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. + + +**Returns** + +Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('https://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_datasources, pagination_item = server.datasources.get() + print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) + print([datasource.name for datasource in all_datasources]) +``` + + + +
      +
      + + +#### datasources.get_by_id + +```py +datasources.get_by_id(datasource_id) +``` + +Returns the specified data source item. + +REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`datasource_id` | The `datasource_id` specifies the data source to query. + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The `DatasourceItem`. See [DatasourceItem class](#datasourceitem-class) + + +**Example** + +```py + +datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e') +print(datasource.name) + +``` + + +
      +
      + + + +#### datasources.populate_connections + +```py +datasources.populate_connections(datasource_item) +``` + +Populates the connections for the specified data source. + +This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. + +REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the data source to populate with connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the data source + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + + +# get the connection information + server.datasources.populate_connections(datasource) + +# print the information about the first connection item + connection = datasource.connections[0] + print(connection.connection_type) + print(connection.id) + print(connection.server_address) + + ... + +``` + +
      +
      + +#### datasources.publish + +```py +datasources.publish(datasource_item, file_path, mode, connection_credentials=None) +``` + +Publishes a data source to a server, or appends data to an existing data source. + +This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. + +REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). +`file_path` | The path and name of the data source to publish. +`mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. + + +**Returns** + +The `DatasourceItem` for the data source that was added or appended to. + + +**Example** + +```py + + import tableauserverclient as TSC + server = TSC.Server('https://SERVERURL') + + ... + + project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' + file_path = r'C:\temp\WorldIndicators.tde' + + + # Use the project id to create new datsource_item + new_datasource = TSC.DatasourceItem(project_id) + + # publish data source (specified in file_path) + new_datasource = server.datasources.publish( + new_datasource, file_path, 'CreateNew') + + ... +``` + +
      +
      + +#### datasources.refresh + +```py +datasource.refresh(datasource_item) +``` + +Refreshes the data of the specified extract. + +REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +A refreshed `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# call the refresh method with the data source item + refreshed_datasource = server.datasources.refresh(datasource) + +``` +
      +
      + +#### datasources.update + +```py +datasource.update(datasource_item) +``` + +Updates the owner or project of the specified data source. Data source name cannot be updated. + +REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. + + + +**Exceptions** + +Error | Description + :--- | : --- +`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. + + +**Returns** + +An updated `DatasourceItem`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVERURL') +# sign in ... + +# get the data source item to update + datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') + +# do some updating + datasource.owner_id = 'New Owner ID' + +# call the update method with the data source item + updated_datasource = server.datasources.update(datasource) + + + +``` +
      +
      + +#### datasource.update_connection + +```py +datasource.update_connection(datasource_item, connection_item) +``` + +Updates the server address, port, username, or password for the specified data source connection. + +REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. +`connection_item` | The `connection_item` that has the information you want to update. + + +**Returns** + +An updated `ConnectionItem` for the data source. + +**Example** + +See the `update_connection.py` sample in the Samples directory. + + +
      +
      + +## Filters + +The TSC library provides a `Filter` class that you can use to filter results returned from the server. + +You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +For more information, see [Filter and Sort](filter-sort). + + +### Filter class + +```py +Filter(field, operator, value) +``` + +The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. + + + +**Attributes** + +Name | Description +:--- | :--- +`Field` | Defined in the `RequestOptions.Field` class. +`Operator` | Defined in the `RequestOptions.Operator` class +`Value` | The value to compare with the specified field and operator. + + + + + +
      +
      + +--- + +## Groups + +Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group. + +The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. + +
      +
      + +### GroupItem class + +```py +GroupItem(name) +``` + +The `GroupItem` class contains the attributes for the group resources on Tableau Server. The `GroupItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/group_item.py + +**Attributes** + +Name | Description +:--- | :--- +`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). +`id` | The id of the group. +`users` | The list of users (`UserItem`). +`name` | The name of the group. The `name` is required when you create an instance of a group. + + + +**Example** + +```py + newgroup = TSC.GroupItem('My Group') + + # call groups.create() with new group +``` + + + + +
      +
      + +### Groups methods + +The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source file: server/endpoint/groups_endpoint.py + +
      +
      + +#### groups.add_user + +```py +groups.add_user(group_item, user_id): +``` + +Adds a user to the specified group. + + +REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`user_id` | The id of the user. + + + + +**Returns** + +None. + + +**Example** + +```py +# Adding a user to a group +# +# get the group item + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba' + +# add Ian to the group + server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba') + + + +``` + +
      +
      + +#### groups.create + +```py +create(group_item) +``` + +Creates a new group in Tableau Server. + + +REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. + + + + +**Returns** +Adds new `GroupItem`. + + +**Example** + +```py + +# Create a new group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + +# create a new instance with the group name + newgroup = TSC.GroupItem('My Group') + +# call the create method + newgroup = server.groups.create(newgroup) + +# print the names of the groups on the server + all_groups, pagination_item = server.groups.get() + for group in all_groups : + print(group.name, group.id) +``` + +
      +
      + +#### groups.delete + +```py +groups.delete(group_id) +``` + +Deletes the group on the site. + +REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_id` | The identifier (`id`) for the group that you want to remove from the server. + + +**Exceptions** + +Error | Description +:--- | :--- +`Group ID undefined` | Raises an exception if a valid `group_id` is not provided. + + +**Example** + +```py +# Delete a group from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + +``` +
      +
      + +#### groups.get + +```py +groups.get(req_options=None) +``` + +Returns information about the groups on the site. + + +To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. + + +REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. + + +**Returns** + +Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the groups on the server + all_groups, pagination_item = server.groups.get() + + # print the names of the first 100 groups + for group in all_groups : + print(group.name, group.id) +``` + + +
      +
      + +#### groups.populate_users + +```py +groups.populate_users(group_item, req_options=None) +``` + +Populates the `group_item` with the list of users. + + +REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to populate with user information. +`req_options` | (Optional) Additional request options to send to the endpoint. + + + +**Exceptions** + +`Group item missing ID. Group must be retrieved from server first.` : Raises an error if the `group_item` is unspecified. + + +**Returns** + +None. A list of `UserItem` objects are added to the group (`group_item.users`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the group + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# get the user information + pagination_item = server.groups.populate_users(mygroup) + + +# print the names of the users + for user in mygroup.users : + print(user.name) + + + + +``` + +
      +
      + +#### groups.remove_user + +```py +groups.remove_user(group_item, user_id) +``` + +Removes a user from a group. + + + + +REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to remove the user from. +`user_id` | The id for the user. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. + + +**Returns** + +None. The user is removed from the group. + + +**Example** + +```py +# Remove a user from the group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the group + mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + + # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' + server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` + +
      +
      + +--- + +## Jobs + +Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### JobItem class + +```py +JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0) + +``` + +The `JobItem` class contains information about the specified job running on Tableau Server. The `JobItem` class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload. + +Source file: models/job_item.py + +**Attributes** + +Name | Description +:--- | :--- +`id` | The `id` of the job. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. +`created_at` | The time the job was created. +`started_at` | The time the job started. +`completed_at` | The time the job finished. +`finish_code` | The return code from job. + + +### Jobs methods + + +The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +Source files: server/endpoint/jobs_endpoint.py + +
      +
      + + +#### jobs.get + + +```py +jobs.get(job_id) + +``` + +Gets information about the specified job. + +REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory + + + + +**Exceptions** + +Error | Description +:--- | :--- +`404018 Resource Not Found` | Raises an error if the `job_id` is not found. + + +**Returns** + +Returns the `JobItem` requested. + + +**Example** + +```py +# Query a Job + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the id of the job from response to extract refresh task, + # or another asynchronous REST API call. + # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" + + + myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' + jobinfo = server.jobs.get(myJobID) + + print(jobinfo) + + # + + + + +``` + + +
      +
      + +--- + +## Projects + +Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. + +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + + + + +
      + +### ProjectItem class + +```py + +ProjectItem(name, description=None, content_permissions=None, parent_id=None) + +``` +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. + +**Attributes** + +Name | Description +:--- | :--- +`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. +`name` | Name of the project. +`description` | The description of the project. +`id` | The project id. +`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. + + + +Source file: models/project_item.py + + +#### ProjectItem.ContentPermissions + +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. + +Name | Description +:--- | :--- +`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. +`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + + +locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject +print(locked_true) +# prints 'LockedToProject' + +by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner +print(by_owner) +# prints 'ManagedByOwner' + + +# pass the content_permissions to new instance of the project item. +new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') + +``` + +
      +
      + +### Project methods + +The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. + + +Source files: server/endpoint/projects_endpoint.py + +
      +
      + + +#### projects.create + +```py +projects.create(project_item) +``` + + +Creates a project on the specified site. + +To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. + + +**Returns** +Returns the new project item. + + + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') + +with server.auth.sign_in(tableau_auth): + # create project item + new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') + # create the project + new_project = server.projects.create(new_project) + +``` + +
      +
      + + +#### projects.get + +```py +projects.get() + +``` + +Return a list of project items for a site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} + + +**Parameters** + +None. + +**Returns** + +Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + + + **Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') + +with server.auth.sign_in(tableau_auth): + # get all projects on site + all_project_items, pagination_item = server.projects.get() + print([proj.name for proj in all_project_items]) + +``` + +
      +
      + + +#### projects.update + +```py +projects.update(project_item) +``` + +Modify the project settings. + +You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. + + +**Exceptions** + +Error | Description + :--- | : --- +`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Returns** + +Returns the updated project information. + +See [ProjectItem class](#projectitem-class) + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + + ... + # get list of projects + all_project_items, pagination_item = server.projects.get() + + + # update project item #7 with new name, etc. + my_project = all_projects[7] + my_project.name ='New name' + my_project.description = 'New description' + + # call method to update project + updated_project = server.projects.update(my_project) + + + + +``` +
      +
      + + +#### projects.delete + +```py +projects.delete(project_id) +``` + +Deletes a project by ID. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`project_id` | The ID of the project to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + +``` + + +
      +
      + +--- + +## Requests + +The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. + +You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: + +- Users +- Datasources +- Groups +- Workbooks +- Views + + +You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. + +For more information about filtering and sorting, see [Filter and Sort](filter-sort). + + +
      + + + +### RequestOptions class + +```py +RequestOptions(pagenumber=1, pagesize=100) + +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`pagenumber` | The page number of the returned results. The default value is 1. +`pagesize` | The number of items to return with each page (the default value is 100). +`sort()` | Returns a iterable set of `Sort` objects. +`filter()` | Returns an iterable set of `Filter` objects. + +
      +
      + + + +#### RequestOptions.Field class + +The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. + +**Attributes** + +**Attributes** + +Field | Description +:--- | :--- +`CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` +`LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` +`Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` +`OwnerName` | Same as 'ownerName' in the REST API. `RequestOptions.Field.OwnerName` +`SiteRole` | Same as 'siteRole' in the REST API. `RequestOptions.Field.SiteRole` +`Tags` | Same as 'tags' in the REST API. `RequestOptions.Field.Tags` +`UpdatedAt` | Same as 'updatedAt' in the REST API. `RequestOptions.Field.UpdatedAt` + + +
      +
      + + + +#### RequestOptions.Operator class + +Specifies the operators you can use to filter requests. + + +**Attributes** + +Operator | Description +:--- | :--- +`Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` +`GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` +`GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` +`LessThan` | Sets the operator to less than (same as `lt` in the REST API). `TSC.RequestOptions.Operator.LessThan` +`LessThanOrEqual` | Sets the operator to less than or equal (same as `lte` in the REST API). `TSC.RequestOptions.Operator.LessThanOrEqual` +`In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In` + +
      +
      + + + +#### RequestOptions.Direction class + +Specifies the direction to sort the returned fields. + + +**Attributes** + +Name | Description +:--- | :--- +`Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) +`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). + +
      +
      + +### CSVRequestOptions class + +```py +CSVRequestOptions(maxage=-1) +``` +Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a `maxage` value. See `views.populate_csv`. + +**Attributes** + +Name | Description +:--- | :--- +`maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +csv_req_option = TSC.CSVRequestOptions(maxage=5) +csv_req_option.vf('Region', 'South') +csv_req_option.vf('Category', 'Furniture') + +# retrieve the csv data for the view +server.views.populate_csv(view_item, csv_req_option) +``` + +### ImageRequestOptions class + +```py +ImageRequestOptions(imageresolution=None, maxage=-1) +``` +Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. + +**Attributes** + +Name | Description +:--- | :--- +`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +`maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**View Filters** + +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the image is generated, the specified filters will be applied to the view. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set the image request option +image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) + +# (optional) set a view filter +image_req_option.vf('Category', 'Furniture') + +# retrieve the image for the view +server.views.populate_image(view_item, image_req_option) + +``` + +### PDFRequestOptions class + +```py +PDFRequestOptions(page_type=None, orientation=None, maxage=-1) +``` +Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. + +**Attributes** + +Name | Description +:--- | :--- +`page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` +`orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` +`maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**View Filters** +You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set the PDF request options +pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, + orientation=TSC.PDFRequestOptions.Orientation.Landscape, + maxage=1) + +# (optional) set a view filter +pdf_req_option.vf('Region', 'West') + +# retrieve the PDF for a view +server.views.populate_pdf(view_item, pdf_req_option) + +``` + + +
      +
      + +--- + +## Schedules + +Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. + +If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. + +The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. + + +### ScheduleItem class + +```py +ScheduleItem(name, priority, schedule_type, execution_order, interval_item) + +``` + +The `ScheduleItem` class contains information about the specified schedule running on Tableau Server. The `ScheduleItem` class defines the information you can query and set. The class members correspond to the attributes of a server response payload. + +Source file: models/schedule_item.py + +**Attributes** + +Name | Description +:--- | :--- +`name` | The `name` of the schedule. +`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. +`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. +`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. +`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. + + +#### IntervalItem class +This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. + +**Attributes** + +Name | Description +:--- | :--- +`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. +`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. +`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. +`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The + + + + +### Schedule methods + +The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. + + +Source files: server/endpoint/schedules_endpoint.py + +#### schedule.create + +```py +schedule.create(schedule_item) +``` +Creates a new schedule for an extract refresh or a subscription. + + +REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. + + +**Returns** + +Returns a new instance of `schedule_item`. + +**Exceptions** + +Error | Description +:--- | :--- +`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. + + +**Example** + +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +``` +
      +
      + + +#### schedule.delete + +```py +schedule.delete(schedule_id) +``` + +Deletes an existing schedule for an extract refresh or a subscription. + + +REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. + + +**Returns** + +None. + +**Exceptions** + +Error | Description +:--- | :--- +`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. + + +#### schedule.get + +```py +schedule.get([req_options=None]) +``` + +Returns all schedule items from the server. + + +REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . + +#### schedule.update + +
      +
      + + +**Hourly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create an interval to run every 2 hours between 2:30AM and 11:00PM + hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + # Create schedule item + hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) +``` + +**Daily schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a daily interval to run every day at 12:30AM + Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) + # Create schedule item using daily interval + daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) + # Create daily schedule + daily_schedule = server.schedules.create(daily_schedule) + +``` + +**Weekly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM + weekly_interval = TSC.WeeklyInterval(time(19, 15), + TSC.IntervalItem.Day.Monday, + TSC.IntervalItem.Day.Wednesday, + TSC.IntervalItem.Day.Friday) + # Create schedule item using weekly interval + weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) + # Create weekly schedule + weekly_schedule = server.schedules.create(weekly_schedule) + +``` + +**Monthly schedule example** +```py +import tableauserverclient as TSC +# sign in, etc. + # Create a monthly interval to run on the 15th of every month at 11:30PM + monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), + interval_value=15) + # Create schedule item using monthly interval + monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, + TSC.ScheduleItem.Type.Subscription + TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) + # Create monthly schedule + monthly_schedule = server.schedules.create(monthly_schedule) +``` + + + +
      +
      + +--- + + +## Server + +In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) +The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. + + +
      +
      + + +### Server class + +```py +Server(server_address) +``` +The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. + +**Attributes** + +Attribute | Description +:--- | :--- +`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} + + + +**Example** + +```py +import tableauserverclient as TSC + + +# create a instance of server +server = TSC.Server('https://MY-SERVER') + +# sign in, etc. + +# change the REST API version to match the server +server.use_server_version() + +# or change the REST API version to match a specific version +# for example, 2.8 +# server.version = '2.8' + +``` + +#### Server.*Resources* + +When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` + + + +Resource | Description + :--- | : --- +*server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | +*server*.views | Access the server views and methods. See [Views](#views) +*server*.users | Access the user resources and methods. See [Users](#users) +*server*.sites | Access the sites. See [Sites](#sites) +*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) +*server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) +*server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) +*server*.projects | Access the resources and methods for projects. See [Projects](#projects) +*server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) +*server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) +*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class) + +
      +
      + +#### Server.PublishMode + +The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. + + +**Properties** + +Resource | Description + :--- | : --- +`PublishMode.Overwrite` | Overwrites the workbook or data source. +`PublishMode.Append` | Appends to the workbook or data source. +`PublishMode.CreateNew` | Creates a new workbook or data source. + + +**Example** + +```py + import tableauserverclient as TSC + # login, etc. + + print(TSC.Server.PublishMode.Overwrite) + # prints 'Overwrite' + + overwrite_true = TSC.Server.PublishMode.Overwrite + + ... + + # pass the PublishMode to the publish workbooks method + new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true) + + +``` + + +
      +
      + + +### ServerInfoItem class + +```py +ServerInfoItem(product_version, build_number, rest_api_version) +``` +The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. + +**Attributes** + +Name | Description +:--- | :--- +`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). +`build_number` | Shows the specific build number (for example, 10200.17.0329.1446). +`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. + + +
      +
      + + +### ServerInfo methods + +The TSC library provides a method to access the build and version information from Tableau Server. + +
      + +#### server_info.get + +```py +server_info.get() + +``` +Retrieve the build and version information for the server. + +This method makes an unauthenticated call, so no sign in or authentication token is required. + +REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} + +**Parameters** + None + +**Exceptions** + +Error | Description +:--- | :--- +`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. + +**Example** + +```py +import tableauserverclient as TSC + +# create a instance of server +server = TSC.Server('https://MY-SERVER') + +# set the version number > 2.3 +# the server_info.get() method works in 2.4 and later +server.version = '2.5' + +s_info = server.server_info.get() +print("\nServer info:") +print("\tProduct version: {0}".format(s_info.product_version)) +print("\tREST API version: {0}".format(s_info.rest_api_version)) +print("\tBuild number: {0}".format(s_info.build_number)) + +``` + + +
      +
      + +--- + +## Sites + +Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. + +The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. + +
      +
      + +### SiteItem class + +```py +SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None, + disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) +``` + +The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Attribute | Description +:--- | :--- +`name` | The name of the site. The name of the default site is "". +`content_url` | The path to the site. +`admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) +`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. +`storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. +`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. +`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. +`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. +`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. +`state` | Shows the current state of the site (`Active` or `Suspended`). + + +**Example** + +```py + +# create a new instance of a SiteItem + +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True) + +``` + +Source file: models/site_item.py + +
      +
      + + +### Site methods + +The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. + + +Source file: server/endpoint/sites_endpoint.py + +
      +
      + +#### sites.create + +```py +sites.create(site_item) +``` + +Creates a new site on the server for the specified site item object. + +Tableau Server only. + + +REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. + + +**Returns** + +Returns a new instance of `SiteItem`. + + +**Example** + +```py +import tableauserverclient as TSC + +# create an instance of server +server = TSC.Server('https://MY-SERVER') + +# create shortcut for admin mode +content_users=TSC.SiteItem.AdminMode.ContentAndUsers + +# create a new SiteItem +new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True) + +# call the sites create method with the SiteItem +new_site = server.sites.create(new_site) +``` +
      +
      + +#### sites.get + +```py +sites.get() +``` + +Queries all the sites on the server. + + +REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} + + +**Parameters** + + None. + +**Returns** + +Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + # query the sites + all_sites, pagination_item = server.sites.get() + + # print all the site names and ids + for site in all_sites: + print(site.id, site.name, site.content_url, site.state) + + +``` + +
      +
      + + + +#### sites.get_by_id + +```py +sites.get_by_id(site_id) +``` + +Queries the site with the given ID. + + +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`site_id` | The id for the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site ID undefined.` | Raises an error if an id is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) + +``` + +
      +
      + +#### sites.get_by_name + +```py +sites.get_by_name(site_name) +``` + +Queries the site with the specified name. + + +REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`site_name` | The name of the site you want to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`Site Name undefined.` | Raises an error if an name is not specified. + + +**Returns** + +Returns the `SiteItem`. + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + a_site = server.sites.get_by_name('MY_SITE') + + +``` + +
      +
      + + + +#### sites.update + +```py +sites.update(site_item) +``` + +Modifies the settings for site. + + +The site item object must include the site ID and overrides all other settings. + + +REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. + + +**Exceptions** + +Error | Description +:--- | :--- +`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. +`You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` + + +**Returns** + +Returns the updated `site_item`. + + +**Example** + +```py +... + +# make some updates to an existing site_item +site_item.name ="New name" + +# call update +site_item = server.sites.update(site_item) + +... +``` + +
      +
      + + + + +#### sites.delete + + +```py +Sites.delete(site_id) +``` + +Deletes the specified site. + + +REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} + + +**Parameters** + +Name | Description + :--- | : --- +`site_id` | The id of the site that you want to delete. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. + + + +**Example** + +```py + +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + +server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') + +``` + +
      +
      + +--- + + +## Sort + +The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. + +You can use the sort and request options to filter and sort the following endpoints: + +- Users +- Datasources +- Workbooks +- Views + +### Sort class + +```py +sort(field, direction) +``` + + + +**Attributes** + +Name | Description +:--- | :--- +`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. +`direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. + +**Example** + +```py + +# create a new instance of a request option object +req_option = TSC.RequestOptions() + +# add the sort expression, sorting by name and direction +req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, + TSC.RequestOptions.Direction.Asc)) +matching_workbooks, pagination_item = server.workbooks.get(req_option) + +for wb in matching_workbooks: + print(wb.name) +``` + +For information about using the `Sort` class, see [Filter and Sort](filter-sort). + +
      +
      + +--- + +## Subscriptions + +Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions. + +### SubscriptionItem class + +The subscription resources for Tableau Server are defined in the `SubscriptionItem` class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the `SubscriptionItem` class. + +```py +SubscriptionItem(subject, schedule_id, user_id, target) + +``` + +**Attributes** + +Name | Description +:--- | :--- +`id` | The id of the subscription on the site. +`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. +`schedule_id` | The identifier associated with the specific subscription. +`user_id` | The identifier of the user (person) who receives the subscription. +`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. + + + + +Source files: server/endpoints/subscription_item.py + + +### Subscription methods + +The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + + + +Source files: server/endpoints/subscriptions_endpoint.py + +
      +
      + +#### subscription.create + +```py +subscription.create(subscription_item) +``` +Creates a subscription to a view or workbook for a specific user. +When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. + +To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). + + +REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. + + +**Returns** + +Returns the new `SubscriptionItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# create auth, specify site +# login, etc. + + +# create the target (content) of the subscription +# in this case, id of the workbook add the target type "workbook" + + target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') + +# the ids for the schedule and user + schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') + user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' + +# create a new SubscriptionItem object. + newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) + +# create the new subscription to the site + newSub = server.subscriptions.create(newSub) + print(newUSub.subject) + +``` + + +
      +
      + + + +#### subscriptions.delete + +```py +subscriptions.delete(subscription_id) +``` + + + +Deletes the specified subscription from the site. + +REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. + + +**Exceptions** + +Error | Description + :--- | : --- +`Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. + + +**Example** + +```py +# Remove a subscription from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') +# server = TSC.Server('https://SERVERURL') + + + with server.auth.sign_in(tableau_auth): + server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
      +
      + +
      +
      + +#### subscription.get + +```py +subscription.get(req_options=None) +``` +Returns information about the subscriptions on the specified site. + + +REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. + + +**Returns** +Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +
      +
      + +#### subscription.get_by_id + + +```py +subscription.get_by_id(subscription_id) +``` + +Returns information about the specified subscription. + +REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`subscription_id` | The `subscription_id` specifies the subscription to query. + + + +**Exceptions** + +Error | Description + :--- | : --- +`No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. + + +**Returns** + +The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) + + +**Example** + +```py + sub1 = server.subscription.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(sub1.subject) + +``` + + + + + +
      +
      + +--- + +## Users + +Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. + +The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. + + +### UserItem class + +```py +UserItem(name, site_role, auth_setting=None) +``` + +The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +**Attributes** + +Name | Description +:--- | :--- +`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`domain_name` | The name of the site. +`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. +`id` | The id of the user on the site. +`last_login` | The date and time the user last logged in. +`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. +`email` | The email address of the user. +`fullname` | The full name of the user. +`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') + +# create a new UserItem object. + newU = TSC.UserItem('Monty', 'Publisher') + + print(newU.name, newU.site_role) + +``` + +Source file: models/user_item.py + +
      +
      + + +### Users methods + +The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. + +Source file: server/endpoint/users_endpoint.py +
      +
      + +#### users.add + +```py +users.add(user_item) +``` + +Adds the user to the site. + +To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. + +REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns the new `UserItem` object. + + + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('server') +# login, etc. + +# create a new UserItem object. + newU = TSC.UserItem('Heather', 'Publisher') + +# add the new user to the site + newU = server.users.add(newU) + print(newU.name, newU.site_role) + +``` + +#### users.get + +```py +users.get(req_options=None) +``` + +Returns information about the users on the specified site. + +To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. + + +REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. + + +**Returns** + +Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. + + +**Example** + + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +server = TSC.Server('https://SERVERURL') + +with server.auth.sign_in(tableau_auth): + all_users, pagination_item = server.users.get() + print("\nThere are {} user on site: ".format(pagination_item.total_available)) + print([user.name for user in all_users]) +``` + +
      +
      + +#### users.get_by_id + + +```py +users.get_by_id(user_id) +``` + +Returns information about the specified user. + +REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The `user_id` specifies the user to query. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined.` | Raises an exception if a valid `user_id` is not provided. + + +**Returns** + +The `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + user1 = server.users.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + print(user1.name) + +``` + +
      +
      + + +#### users.populate_favorites + +```py +users.populate_favorites(user_item) +``` + +Returns the list of favorites (views, workbooks, and data sources) for a user. + +*Not currently implemented* + +
      +
      + + +#### users.populate_workbooks + +```py +users.populate_workbooks(user_item, req_options=None): +``` + +Returns information about the workbooks that the specified user owns and has Read (view) permissions for. + + +This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). + +REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to populate with workbook information. + + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +A list of `WorkbookItem` + +A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) + + +**Example** + +```py +# first get all users, call server.users.get() +# get workbooks for user[0] + ... + + page_n = server.users.populate_workbooks(all_users[0]) + print("\nUser {0} owns or has READ permissions for {1} workbooks".format(all_users[0].name, page_n.total_available)) + print("\nThe workbooks are:") + for workbook in all_users[0].workbooks : + print(workbook.name) + + ... +``` + + + + +
      +
      + +#### users.remove + +```py +users.remove(user_id) +``` + + + +Removes the specified user from the site. + +REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} + + +**Parameters** + +Name | Description + :--- | : --- +`user_id` | The identifier (`id`) for the user that you want to remove from the server. + + +**Exceptions** + +Error | Description + :--- | : --- +`User ID undefined` | Raises an exception if a valid `user_id` is not provided. + + +**Example** + +```py +# Remove a user from the site + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') + +``` +
      +
      + + + + +#### users.update + +```py +users.update(user_item, password=None) +``` + +Updates information about the specified user. + +The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. + + + +REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to update. +`password` | (Optional) The new password for the user. + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +An updated `UserItem`. See [UserItem class](#useritem-class) + + +**Example** + +```py + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # create a new user_item + user1 = TSC.UserItem('temp', 'Viewer') + + # add new user + user1 = server.users.add(user1) + print(user1.name, user1.site_role, user1.id) + + # modify user info + user1.name = 'Laura' + user1.fullname = 'Laura Rodriguez' + user1.email = 'laura@example.com' + + # update user + user1 = server.users.update(user1) + print("\Updated user info:") + print(user1.name, user1.fullname, user1.email, user1.id) + + +``` + + + +
      +
      + + +--- + +## Views + +Using the TSC library, you can get information about views in a site or a workbook. + +The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. + +
      + +### ViewItem class + +``` +ViewItem() +``` + +The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. + +Source file: models/view_item.py + +**Attributes** + +Name | Description +:--- | :--- +`content_url` | The name of the view as it would appear in a URL. +`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. +`id` | The identifier of the view item. +`image` | The image of the view. You must first call the `views.populate_image`method to access the image. +`name` | The name of the view. +`owner_id` | The ID for the owner of the view. +`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content. +`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image. +`project_id` | The ID of the project that contains the view. +`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. +`workbook_id` | The ID of the workbook associated with the view. + + +
      +
      + + +### Views methods + +The Tableau Server Client provides methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. + +Source file: server/endpoint/views_endpoint.py + +
      +
      + +#### views.get +``` +views.get(req_options=None, usage=False) +``` + +Returns the list of views items for a site. + + +REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. +`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. + + + +**Returns** + +Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + all_views, pagination_item = server.views.get() + print([view.name for view in all_views]) +``` + +**Example using Pager** + +You can also use the provided Pager generator to get all views on site, without having to page through the results. +```py +for view in TSC.Pager(server.views): + print(view.name) +``` + +See [ViewItem class](#viewitem-class) + + +
      +
      + +#### views.populate_preview_image + +```py + views.populate_preview_image(view_item) +``` + +Populates a preview image for the specified view. + +This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. + +REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.0 and up. + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | Specifies the view to populate. + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. + + +**Returns** + +None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the preview image as 'view_preview_image.png' +server.views.populate_preview_image(view_item) +with open('./view_preview_image.png', 'wb') as f: + f.write(view_item.preview_image) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_image + +```py +views.populate_image(view_item, req_options=None) +``` + +Populates the image of the specified view. + +This method uses the `id` field to query the image, and populates the image content as the `image` field. + +REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.5 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The image is added to the `view_item` and can be accessed by its `image` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view image as 'view_image.png' +server.views.populate_image(view_item) +with open('./view_image.png', 'wb') as f: + f.write(view_item.image) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_csv +``` +views.populate_csv(view_item) +``` + +Populates the CSV data of the specified view. + +This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. + +REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the CSV data as 'view_csv.csv' +server.views.populate_csv(view_item) +with open('./view_csv.csv', 'wb') as f: + # Perform byte join on the CSV data + f.write(b''.join(view_item.csv)) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + +#### views.populate_pdf +``` +views.populate_pdf(view_item, req_options=None) +``` + +Populates the PDF content of the specified view. + +This method populates a PDF with image(s) of the view you specify. + +REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 2.7 and up. + +**Parameters** + +Name | description +:--- | :--- +`view_item` | Specifies the view to populate. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID` | Raises an error if the ID of the view is missing. + +**Returns** + +None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the view pdf as 'view_pdf.pdf' +server.views.populate_pdf(view_item) +with open('./view_pdf.pdf', 'wb') as f: + f.write(view_item.pdf) +``` + +See [ViewItem class](#viewitem-class) + +
      +
      + + +--- + + +## Workbooks + +Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. + +The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. + + + + + +
      +
      + +### WorkbookItem class + +```py + + WorkbookItem(project_id, name=None, show_tabs=False) + +``` +The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project + + +**Attributes** + +Name | Description +:--- | :--- +`connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. +`name` | The name of the workbook. +`owner_id` | The ID of the owner. +`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. +`project_id` | The project id. +`project_name` | The name of the project. +`size` | The size of the workbook (in megabytes). +`show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. +`tags` | The tags that have been added to the workbook. +`updated_at` | The date and time when the workbook was last updated. +`views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). + + + + + +**Example** + +```py +# creating a new instance of a WorkbookItem +# +import tableauserverclient as TSC + +# Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' + + new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') + + +```` + +Source file: models/workbook_item.py + +
      +
      + +### Workbook methods + +The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. +The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. + + + +Source files: server/endpoint/workbooks_endpoint.py + +
      +
      + +#### workbooks.get + +```py +workbooks.get(req_options=None) +``` + +Queries the server and returns information about the workbooks the site. + + + + + +REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) + + +**Returns** + +Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + all_workbooks_items, pagination_item = server.workbooks.get() + # print names of first 100 workbooks + print([workbook.name for workbook in all_workbooks_items]) + + + +``` + +
      +
      + + + +#### workbooks.get_by_id + +```py +workbooks.get_by_id(workbook_id) +``` + +Returns information about the specified workbook on the site. + +REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). + + +**Exceptions** + +Error | Description + :--- | : --- +`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. + + +**Returns** + +The `WorkbookItem`. See [WorkbookItem class](#workbookitem-class) + + +**Example** + +```py + +workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') +print(workbook.name) + +``` + + +
      +
      + + +#### workbooks.publish + +```py +workbooks.publish(workbook_item, file_path, publish_mode) +``` + +Publish a workbook to the specified site. + +**Note:** The REST API cannot automatically include +extracts or other resources that the workbook uses. Therefore, + a .twb file that uses data from an Excel or csv file on a local computer cannot be published, +unless you package the data and workbook in a .twbx file, or publish the data source separately. + +For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. + +REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} + + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). +`file_path` | The path and name of the workbook to publish. +`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). + + + +**Exceptions** + +Error | Description +:--- | :--- +`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. +`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. + +See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. + +**Returns** + +The `WorkbookItem` for the workbook that was published. + + +**Example** + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + # create a workbook item + wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + # call the publish method with the workbook item + wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') +``` + +
      +
      + +#### workbooks.refresh + +```py +workbooks.refresh(workbook_item) +``` + + +Refreshes the extract of an existing workbook. + +REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # call the update method + workbook = server.workbooks.refresh(workbook) + print("\nThe data of workbook {0} is refreshed.".format(workbook.name)) + + +``` + + +
      +
      + +#### workbooks.update + +```py +workbooks.update(workbook_item) +``` + + +Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. + +REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. + + +```py + +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + + # get the workbook item from the site + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nUpdate {0} workbook. Project was {1}".format(workbook.name, workbook.project_name)) + + + # make an change, for example a new project ID + workbook.project_id = '1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e' + + # call the update method + workbook = server.workbooks.update(workbook) + print("\nUpdated {0} workbook. Project is now {1}".format(workbook.name, workbook.project_name)) + + +``` + + +
      +
      + + + +#### workbooks.delete + +```py +workbooks.delete(workbook_id) +``` + +Deletes a workbook with the specified ID. + + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID of the workbook to delete. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# tableau_auth sign in, etc. + + server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + +``` + + +
      +
      + + +#### workbooks.download + +```py +workbooks.download(workbook_id, filepath=None, no_extract=False) +``` + +Downloads a workbook to the specified directory (optional). + + +REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. +`no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +**Returns** + +The file path to the downloaded workbook. + + +**Example** + +```py + + file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + print("\nDownloaded the file to {0}.".format(file_path)) + +```` + + +
      +
      + + +#### workbooks.populate_views + +```py +workbooks.populate_views(workbook_item) +``` + +Populates (or gets) a list of views for a workbook. + +You must first call this method to populate views before you can iterate through the views. + +This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. + +REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. + + +**Returns** + +None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the view information + server.workbooks.populate_views(workbook) + +# print information about the views for the work item + print("\nThe views for {0}: ".format(workbook.name)) + print([view.name for view in workbook.views]) + + ... + +``` + +
      +
      + +#### workbooks.populate_connections + +```py +workbooks.populate_connections(workbook_item) +``` + +Populates a list of data source connections for the specified workbook. + +You must populate connections before you can iterate through the +connections. + +This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. + +REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. + + + + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. + + +**Returns** + +None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). + + +**Example** + +```py +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') +# + ... + +# get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + +# get the connection information + server.workbooks.populate_connections(workbook) + +# print information about the data connections for the workbook item + print("\nThe connections for {0}: ".format(workbook.name)) + print([connection.id for connection in workbook.connections]) + + + ... + +``` + +
      +
      + + +#### workbooks.populate_preview_image + +```py +workbooks.populate_preview_image(workbook_item) +``` + +This method gets the preview image (thumbnail) for the specified workbook item. + +The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. + +REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. + + + +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. + + + +**Returns** + +None. The preview image is added to the view. + + + +**Example** + +```py + +# import tableauserverclient as TSC + +# server = TSC.Server('https://SERVERURL') + + ... + + # get the workbook item + workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') + + # add the png thumbnail to the workbook item + server.workbooks.populate_preview_image(workbook) + + +``` + +
      +
      + +#### workbooks.update_connection + +```py +workbooks.update_conn(workbook_item, connection_item) +``` + +Updates a workbook connection information (server address, server port, user name, and password). + +The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) + +REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. +`connection_item` | The `connection_item` that has the information you want to update. + + + +**Returns** + +None. The connection information is updated with the information in the `ConnectionItem`. + + + + +**Example** + +```py + +# query for workbook connections +server.workbooks.populate_connections(workbook) + +# update connection item user name and password +connection = workbook.connections[0] +connection.username = 'USERNAME' +connection.password = 'PASSWORD' + +# call the update method +server.workbooks.update_conn(workbook, connection) +``` + +
      +
      + +#### workbooks.populate_pdf +``` +workbooks.populate_pdf(workbook_item, req_options=None) +``` + +Populates the PDF content of the specified workbook. + +This method populates a PDF with image(s) of the workbook view(s) you specify. + +REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} + +**Version** + +This endpoint is available with REST API version 3.4 and up. + +**Parameters** + +Name | description +:--- | :--- +`workbook_item` | Specifies the workbook to populate. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. + +**Exceptions** + +Error | Description +:--- | :--- +`Workbook item missing ID` | Raises an error if the ID of the workbook is missing. + +**Returns** + +None. The PDF content is added to the `workbook_item` and can be accessed by its `pdf` field. + +**Example** +```py +# Sign in, get view, etc. + +# Populate and save the workbook pdf as 'workbook_pdf.pdf' +server.workbooks.populate_pdf(workbook_item) +with open('./workbook_pdf.pdf', 'wb') as f: + f.write(workbook_item.pdf) +``` + +
      +
      + + diff --git a/docs/api-ref.md.rej b/docs/api-ref.md.rej new file mode 100644 index 000000000..aeaaa3457 --- /dev/null +++ b/docs/api-ref.md.rej @@ -0,0 +1,68 @@ +*************** +*** 15,21 **** + The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + + |:--- | +- | **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| + + + +--- 15,21 ---- + The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + + |:--- | ++ | **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| + + + +*************** +*** 1122,1128 **** + Name | Description + :--- | :--- + `id` | The `id` of the job. +- `type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. + `created_at` | The time the job was created. + `started_at` | The time the job started. + `completed_at` | The time the job finished. +--- 1122,1128 ---- + Name | Description + :--- | :--- + `id` | The `id` of the job. ++ `type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. + `created_at` | The time the job was created. + `started_at` | The time the job started. + `completed_at` | The time the job finished. +*************** +*** 1948,1954 **** + Attribute | Description + :--- | :--- + `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +- `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} + + + +--- 1948,1954 ---- + Attribute | Description + :--- | :--- + `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). ++ `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) + + + +*************** +*** 2070,2076 **** + + This method makes an unauthenticated call, so no sign in or authentication token is required. + +- REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} + + **Parameters** + None +--- 2070,2076 ---- + + This method makes an unauthenticated call, so no sign in or authentication token is required. + ++ REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) + + **Parameters** + None diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 385222054..55a64a711 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -12,12 +12,11 @@ This topic describes how to contribute to the Tableau Server Client (Python) pro ## Submit your first patch - This section will get you started with the basic workflow, describing how to create your own fork of the repository and how to open a pull request (PR) to add your contributions to the **development** branch. ### Get the source code and set up your branch -1. Make sure you have [signed the CLA](http://tableau.github.io/#contributor-license-agreement-cla) +1. Make sure you have [signed the CLA](https://tableau.github.io/contributing.html) 1. Fork the repository. @@ -40,9 +39,11 @@ This section will get you started with the basic workflow, describing how to cre It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so: ```shell - git checkout -b 13-feature-new-stuff + git checkout -b 13-feature-new-stuff development ``` + For documentation changes, see the documentation section below. + ### Code and commit Here's a quick checklist to follow when coding to ensure a good pull request (PR): @@ -65,21 +66,20 @@ This section will get you started with the basic workflow, describing how to cre Our documentation is written in markdown and built with Jekyll on GitHub Pages. All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python) - If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place. + If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place. ### Commit changes to your fork and open a PR -1. Make a PR as described [here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the **development** branch for code changes, or against **gh-pages** for documentation updates. +1. Make a PR as described [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the **development** branch for code changes, or against **gh-pages** for documentation updates. 1. Wait for a review and address any feedback. While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able. -1. That's it! When the PR has received ![](https://assets-cdn.github.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR +1. That's it! When the PR has received approval from members of the core team they will merge the PR --- - ## Add new features 1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually diff --git a/docs/filter-sort.md b/docs/filter-sort.md index f63e32f19..a7a0d458d 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -8,7 +8,6 @@ then pass the object to your endpoint as a parameter. * TOC {:toc} - ## Available endpoints and fields You can use the TSC library to filter and sort the following endpoints: @@ -30,11 +29,11 @@ fields: * UpdatedAt **Important**: Not all of the fields are available for all endpoints. For more information, see the [REST -API help](http://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm#REST/rest_api_concepts_filtering_and_sorting.htm). +API help](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm). ## Filtering -To filter on a field, you need to specify the following criteria: +To filter on a field, you need to specify the field name, an operator criteria and a value criteria. ### Operator criteria @@ -68,7 +67,7 @@ print(matching_workbooks[0].owner_id) ## Sorting -To sort on a field, you need to specify the direction in which you want to sort. +To sort on a field, you need to specify the field name and the direction criteria for the sort order. ### Direction criteria @@ -87,4 +86,3 @@ matching_workbooks, pagination_item = server.workbooks.get(req_option) for wb in matching_workbooks: print(wb.name) ``` - diff --git a/docs/index.md b/docs/index.md index aec722ade..4687be3be 100644 --- a/docs/index.md +++ b/docs/index.md @@ -83,6 +83,7 @@ with server.auth.sign_in(tableau_auth): print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) print([datasource.name for datasource in all_datasources]) ``` + > `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. ->`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. +> `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. diff --git a/docs/page-through-results.md b/docs/page-through-results.md index b01a1455b..284915cee 100644 --- a/docs/page-through-results.md +++ b/docs/page-through-results.md @@ -1,11 +1,11 @@ --- -title: Page through Results +title: Page Through Results layout: docs --- Many of the calls that you make with the TSC library query for resources (like workbooks or data sources) on Tableau -Server. Because the number of resources on Tableau Server can be very large, Tableau Server only returns the first 100 -resources by default. To get all of the resources on Tableau Server, you need to page through the results. +Server. Because the number of resources can be very large, Tableau Server only returns the first 100 +resources by default. To get all of the resources, you need to page through the results. * TOC {:toc} @@ -30,7 +30,7 @@ Server REST API when it runs out of resources--it does not make a call for each ### Set pagination options -You can set pagination options in the request options and then pass the request options to the `Pager` function as a +You can set pagination options in a `RequestOptions` object and then pass it to the `Pager` function as a second optional parameter. For example, to set the page size to 1000 use the following code: diff --git a/docs/patch b/docs/patch new file mode 100644 index 000000000..fe5d1e7a5 --- /dev/null +++ b/docs/patch @@ -0,0 +1,612 @@ +diff --git a/docs/api-ref.md b/docs/api-ref.md +index 51e4b4e..2cb41e0 100644 +--- a/docs/api-ref.md ++++ b/docs/api-ref.md +@@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST + The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. + + |:--- | +-| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| ++| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| + + + +@@ -90,7 +90,7 @@ Signs you in to Tableau Server. + + The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). + +-REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} ++REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) + + **Parameters** + +@@ -131,7 +131,7 @@ Signs you out of the current session. + + The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). + +-REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} ++REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) + + **Example** + +@@ -210,7 +210,7 @@ Attribute | Description + `password` | The password used for the connection. + `server_address` | The server address for the connection. + `server_port` | The port used by the server. +-`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. ++`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). + + + Source file: models/connection_credentials.py +@@ -302,7 +302,7 @@ Error | Description + `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. + + +-REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} ++REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source) + +
      +
      +@@ -316,7 +316,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr + ``` + Downloads the specified data source in `.tdsx` or `.hyper` format. + +-REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} ++REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source) + + **Parameters** + +@@ -361,7 +361,7 @@ Returns all the data sources for the site. + + To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) + +-REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} ++REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources) + + **Parameters** + +@@ -404,7 +404,7 @@ datasources.get_by_id(datasource_id) + + Returns the specified data source item. + +-REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} ++REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) + + + **Parameters** +@@ -451,7 +451,7 @@ Populates the connections for the specified data source. + + This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. + +-REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} ++REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) + + **Parameters** + +@@ -513,7 +513,7 @@ Publishes a data source to a server, or appends data to an existing data source. + + This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. + +-REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} ++REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) + + **Parameters** + +@@ -574,7 +574,7 @@ datasource.refresh(datasource_item) + + Refreshes the data of the specified extract. + +-REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} ++REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) + + **Parameters** + +@@ -621,7 +621,7 @@ datasource.update(datasource_item) + + Updates the owner or project of the specified data source. Data source name cannot be updated. + +-REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} ++REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) + + **Parameters** + +@@ -673,7 +673,7 @@ datasource.update_connection(datasource_item, connection_item) + + Updates the server address, port, username, or password for the specified data source connection. + +-REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} ++REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection) + + + **Parameters** +@@ -801,7 +801,7 @@ groups.add_user(group_item, user_id): + Adds a user to the specified group. + + +-REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} ++REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) + + **Parameters** + +@@ -848,7 +848,7 @@ create(group_item) + Creates a new group in Tableau Server. + + +-REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} ++REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) + + + **Parameters** +@@ -898,7 +898,7 @@ groups.delete(group_id) + + Deletes the group on the site. + +-REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} ++REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) + + + **Parameters** +@@ -943,7 +943,7 @@ Returns information about the groups on the site. + To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. + + +-REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} ++REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) + + **Parameters** + +@@ -988,7 +988,7 @@ groups.populate_users(group_item, req_options=None) + Populates the `group_item` with the list of users. + + +-REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} ++REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) + + **Parameters** + +@@ -1049,7 +1049,7 @@ Removes a user from a group. + + + +-REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} ++REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) + + + **Parameters** +@@ -1122,7 +1122,7 @@ Source file: models/job_item.py + Name | Description + :--- | :--- + `id` | The `id` of the job. +-`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. ++`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. + `created_at` | The time the job was created. + `started_at` | The time the job started. + `completed_at` | The time the job finished. +@@ -1151,7 +1151,7 @@ jobs.get(job_id) + + Gets information about the specified job. + +-REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} ++REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) + + + **Parameters** +@@ -1238,7 +1238,7 @@ Name | Description + `name` | Name of the project. + `description` | The description of the project. + `id` | The project id. +-`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. ++`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). + + + +@@ -1247,7 +1247,7 @@ Source file: models/project_item.py + + #### ProjectItem.ContentPermissions + +-The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. ++The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). + + Name | Description + :--- | :--- +@@ -1303,7 +1303,7 @@ Creates a project on the specified site. + To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +-REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} ++REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) + + **Parameters** + +@@ -1348,7 +1348,7 @@ Return a list of project items for a site. + + To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +-REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} ++REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) + + + **Parameters** +@@ -1389,7 +1389,7 @@ Modify the project settings. + + You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +-REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} ++REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) + + **Parameters** + +@@ -1451,7 +1451,7 @@ Deletes a project by ID. + To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +-REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} ++REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) + + + **Parameters** +@@ -1534,7 +1534,7 @@ Name | Description + + #### RequestOptions.Field class + +-The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. ++The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. + + **Attributes** + +@@ -1762,7 +1762,7 @@ schedule.create(schedule_item) + Creates a new schedule for an extract refresh or a subscription. + + +-REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} ++REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) + + + +@@ -1811,7 +1811,7 @@ schedule.delete(schedule_id) + Deletes an existing schedule for an extract refresh or a subscription. + + +-REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} ++REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) + + + +@@ -1842,7 +1842,7 @@ schedule.get([req_options=None]) + Returns all schedule items from the server. + + +-REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} ++REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) + + + +@@ -1948,7 +1948,7 @@ The `Server` class contains the attributes that represent the server on Tableau + Attribute | Description + :--- | :--- + `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +-`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} ++`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) + + + +@@ -2070,7 +2070,7 @@ Retrieve the build and version information for the server. + + This method makes an unauthenticated call, so no sign in or authentication token is required. + +-REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} ++REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) + + **Parameters** + None +@@ -2178,7 +2178,7 @@ Creates a new site on the server for the specified site item object. + Tableau Server only. + + +-REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} ++REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) + + + +@@ -2223,7 +2223,7 @@ sites.get() + Queries all the sites on the server. + + +-REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} ++REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) + + + **Parameters** +@@ -2266,7 +2266,7 @@ sites.get_by_id(site_id) + Queries the site with the given ID. + + +-REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} ++REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) + + **Parameters** + +@@ -2312,7 +2312,7 @@ sites.get_by_name(site_name) + Queries the site with the specified name. + + +-REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} ++REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) + + **Parameters** + +@@ -2363,7 +2363,7 @@ Modifies the settings for site. + The site item object must include the site ID and overrides all other settings. + + +-REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} ++REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) + + + **Parameters** +@@ -2416,7 +2416,7 @@ Sites.delete(site_id) + Deletes the specified site. + + +-REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} ++REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site) + + + **Parameters** +@@ -2553,7 +2553,7 @@ When a user is subscribed to the content, Tableau Server sends the content to th + To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). + + +-REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} ++REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription) + + **Parameters** + +@@ -2612,7 +2612,7 @@ subscriptions.delete(subscription_id) + + Deletes the specified subscription from the site. + +-REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} ++REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) + + + **Parameters** +@@ -2657,7 +2657,7 @@ subscription.get(req_options=None) + Returns information about the subscriptions on the specified site. + + +-REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} ++REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions) + + **Parameters** + +@@ -2682,7 +2682,7 @@ subscription.get_by_id(subscription_id) + + Returns information about the specified subscription. + +-REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} ++REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) + + + **Parameters** +@@ -2790,7 +2790,7 @@ Adds the user to the site. + + To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. + +-REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} ++REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) + + **Parameters** + +@@ -2833,7 +2833,7 @@ Returns information about the users on the specified site. + To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. + + +-REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} ++REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) + + **Parameters** + +@@ -2873,7 +2873,7 @@ users.get_by_id(user_id) + + Returns information about the specified user. + +-REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} ++REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) + + + **Parameters** +@@ -2932,7 +2932,7 @@ Returns information about the workbooks that the specified user owns and has Rea + + This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). + +-REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} ++REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) + + **Parameters** + +@@ -2989,7 +2989,7 @@ users.remove(user_id) + + Removes the specified user from the site. + +-REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} ++REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) + + + **Parameters** +@@ -3033,11 +3033,11 @@ users.update(user_item, password=None) + + Updates information about the specified user. + +-The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. ++The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). + + + +-REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} ++REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user) + + **Parameters** + +@@ -3154,7 +3154,7 @@ views.get(req_options=None, usage=False) + Returns the list of views items for a site. + + +-REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} ++REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site) + + **Version** + +@@ -3209,7 +3209,7 @@ Populates a preview image for the specified view. + + This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. + +-REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} ++REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview) + + **Version** + +@@ -3258,7 +3258,7 @@ Populates the image of the specified view. + + This method uses the `id` field to query the image, and populates the image content as the `image` field. + +-REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} ++REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image) + + **Version** + +@@ -3305,7 +3305,7 @@ Populates the CSV data of the specified view. + + This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. + +-REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} ++REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data) + + **Version** + +@@ -3353,7 +3353,7 @@ Populates the PDF content of the specified view. + + This method populates a PDF with image(s) of the view you specify. + +-REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} ++REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf) + + **Version** + +@@ -3484,7 +3484,7 @@ Queries the server and returns information about the workbooks the site. + + + +-REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} ++REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site) + + + **Parameters** +@@ -3529,7 +3529,7 @@ workbooks.get_by_id(workbook_id) + + Returns information about the specified workbook on the site. + +-REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} ++REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook) + + + **Parameters** +@@ -3580,7 +3580,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so + + For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. + +-REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} ++REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) + + + +@@ -3604,7 +3604,7 @@ Error | Description + `Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. + `Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. + +-See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. ++See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. + + **Returns** + +@@ -3638,7 +3638,7 @@ workbooks.refresh(workbook_item) + + Refreshes the extract of an existing workbook. + +-REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} ++REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) + + **Parameters** + +@@ -3684,7 +3684,7 @@ workbooks.update(workbook_item) + + Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. + +-REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} ++REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook) + + **Parameters** + +@@ -3742,7 +3742,7 @@ Deletes a workbook with the specified ID. + To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + + +-REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} ++REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) + + + **Parameters** +@@ -3786,7 +3786,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False) + Downloads a workbook to the specified directory (optional). + + +-REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} ++REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook) + + + **Parameters** +@@ -3837,7 +3837,7 @@ You must first call this method to populate views before you can iterate through + + This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. + +-REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} ++REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) + + **Parameters** + +@@ -3900,7 +3900,7 @@ connections. + + This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. + +-REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} ++REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) + + **Parameters** + +@@ -3962,7 +3962,7 @@ This method gets the preview image (thumbnail) for the specified workbook item. + + The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. + +-REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} ++REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) + + **Parameters** + +@@ -4018,7 +4018,7 @@ Updates a workbook connection information (server address, server port, user nam + + The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) + +-REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} ++REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection) + + **Parameters** + +@@ -4064,7 +4064,7 @@ Populates the PDF content of the specified workbook. + + This method populates a PDF with image(s) of the workbook view(s) you specify. + +-REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} ++REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) + + **Version** + diff --git a/docs/populate-connections-views.md b/docs/populate-connections-views.md index 63e3fe8f4..71128c94d 100644 --- a/docs/populate-connections-views.md +++ b/docs/populate-connections-views.md @@ -8,7 +8,7 @@ views or connections that make up the workbook. Similarly, when you get a data s information about the connections that make up the data source. This is a result of the design of the Tableau Server REST API, which optimizes the size of responses by only returning what you ask for explicitly. -As a result, if you want to get views and connections, you need to run the `populate_views` and `populate_connections` +As a result, if you want to get views and connections, you need to call the `populate_views` and `populate_connections` functions. * TOC diff --git a/docs/samples.md b/docs/samples.md index eede1cb04..b9e9aae3d 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -32,47 +32,32 @@ publish. The following list describes the samples available in the repository: -* `create_group.py` Create a user group. - +* `add_default_permission.py` Adds workbook default permissions for a given project. +* `create_group.py` Creates a user group. * `create_project.py` Creates a project in a site. - -* `create_schedules.py` Create schedules for extract refreshes and subscriptions. - -* `download_view_image.py` Downloads an image of a specified view. - +* `create_schedules.py` Creates schedules for extract refreshes and subscriptions. +* `download_view_image.py` Downloads an image of a specified view. * `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. - +* `explore_webhooks.py` Explores webhook functions supported by the Server API. * `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. - -* `export.py` Exports a view as an image, pdf, or csv. - -* `export_wb.py` Exports a pdf containing all views in a workbook. - -* `filter_sort_groups.py` Demonstrates selecting user groups as filters. - -* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources. - -* `kill_all_jobs.py` Kills all running jobs. - -* `list.py` Lists all datasources or workbooks of a site. - -* `move_workbook_projects.py` Updates the properties of a workbook to move the workbook from one project to another. - +* `export.py` Exports a view as an image, PDF, or CSV. +* `export_wb.py` Exports a PDF containing all views in a workbook. +* `filter_sort_groups.py` Demonstrates filtering and sorting user groups. +* `filter_sort_projects.py` Demonstrates filtering and sorting projects. +* `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources. +* `kill_all_jobs.py` Kills all running jobs. +* `list.py` Lists all datasources or workbooks of a site. +* `login.py` Demonstrates logging in to the server with either username/password or personal access token. +* `move_workbook_projects.py` Moves a workbook from one project to another. * `move_workbook_sites.py` Downloads a workbook, stores it in-memory, and uploads it to another site. - -* `pagination_sample.py` Use the Pager generator to iterate over all the items on the server. - -* `publish_workbook.py` Publishes a Tableau workbook. - +* `pagination_sample.py` Uses the Pager generator to iterate over all the items on the server. +* `publish_datasource.py` Publishes a datasource to a server. +* `publish_workbook.py` Publishes a workbook to a server. +* `query_permissions.py` Queries permissions of a given resource. * `refresh.py` Refreshes a datasource or workbook. - * `refresh_tasks.py` Lists and runs configured tasks on a server. +* `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks. +* `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource. +* `update_connection.py` Updates and embeds connection credentials of a datasource. -* `set_http_options.py` Sets HTTP options for the server and specifically for downloading workbooks. - -* `set_refresh_schedule.py` Sets the schedule to refresh a datasource or workbook. - -* `update_connection.py` Updates and embeds connection credentials of a datasource. - -**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. - +**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Online. diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index a664a2cf4..d1bdc197f 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -3,12 +3,12 @@ title: Sign In and Out layout: docs --- -To sign in and out of Tableau Server, call the server's `.auth.signin` method in a`with` block. +To sign in and out of Tableau Server, call the server's `.auth.signin` method in a `with` block. ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', `SITENAME`) +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME') # or for a personal access token # tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') server = TSC.Server('https://SERVER_URL') @@ -19,25 +19,25 @@ with server.auth.sign_in(tableau_auth): `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. -`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an in premise Tableau server. +`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an on-premise Tableau server. -'TOKEN_NAME' and 'TOKEN_VALUE' are your Personal Access Token values, generated in your Account Settings. +`TOKEN_NAME` and `TOKEN_VALUE` are your [Personal Access Token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) values, generated in your Account Settings. -Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. +Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. The TSC library signs you out of Tableau Server when you exit out of the `with` block.
      - Note: When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying + **Note:** When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default).
      -An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly. +An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly: ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will try to log the user into the Default site +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will use the Default site server = TSC.Server('http://SERVER_URL') server.auth.sign_in(tableau_auth) diff --git a/docs/versions.md b/docs/versions.md index aeab32836..f1323fd0d 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -25,14 +25,13 @@ For example, the code might display version `2.3`. ## Use the REST API version supported by the server -To always use the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to, set the version using the `use_server_version()` method. You can do this when you create the server instance by specifying `use_server_version=True` as one of the arguments. +To always use the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to, specify `use_server_version=True` as one of the arguments. ```py import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL', use_server_version=True) - ``` ## Use a specific version of the REST API @@ -43,8 +42,6 @@ To use another version of the REST API, set the version like so: import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL') - - server.version = '2.6' ``` @@ -55,17 +52,17 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| -|2.3|10.0| -|2.4|10.1| -|2.5|10.2| -|2.6|10.3| -|2.7|10.4| -|2.8|10.5| -|3.0|2018.1| -|3.1|2018.2| -|3.2|2018.3| -|3.3|2019.1| -|3.4|2019.2| -|3.5|2019.3| -|3.6|2019.4| |3.7|2020.1| +|3.6|2019.4| +|3.5|2019.3| +|3.4|2019.2| +|3.3|2019.1| +|3.2|2018.3| +|3.1|2018.2| +|3.0|2018.1| +|2.8|10.5| +|2.7|10.4| +|2.6|10.3| +|2.5|10.2| +|2.4|10.1| +|2.3|10.0| From 16e0778043255bfbee7e622af696590fc47ea3ef Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 6 Aug 2020 18:01:40 -0700 Subject: [PATCH 061/158] Address review comments, remove unintentially added api-ref-* files --- docs/api-ref-x.md | 4103 ------------------------------------------ docs/api-ref.md | 2 +- docs/api-ref.md.orig | 4103 ------------------------------------------ docs/api-ref.md.rej | 68 - docs/dev-guide.md | 2 +- docs/patch | 612 ------- docs/versions.md | 15 +- 7 files changed, 15 insertions(+), 8890 deletions(-) delete mode 100644 docs/api-ref-x.md delete mode 100644 docs/api-ref.md.orig delete mode 100644 docs/api-ref.md.rej delete mode 100644 docs/patch diff --git a/docs/api-ref-x.md b/docs/api-ref-x.md deleted file mode 100644 index 2cb41e0e5..000000000 --- a/docs/api-ref-x.md +++ /dev/null @@ -1,4103 +0,0 @@ ---- -title: API reference -layout: docs ---- - -
      - Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. - -
      - - - -The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. - -The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. - -|:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| - - - -* TOC -{:toc } - -
      -
      - ---- - -## Authentication - -You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. - -
      -
      - -### TableauAuth class - -```py -TableauAuth(username, password, site_id='', user_id_to_impersonate=None) -``` -The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. - - - **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). - -**Attributes** - -Name | Description -:--- | :--- -`username` | The name of the user whose credentials will be used to sign in. -`password` | The password of the user. -`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. -`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. - -Source file: models/tableau_auth.py - -**Example** - -```py -import tableauserverclient as TSC -# create a new instance of a TableauAuth object for authentication - -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') - -# create a server instance -# pass the "tableau_auth" object to the server.auth.sign_in() method -``` - -
      -
      - -### Auth methods -The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. - - -Source file: server/endpoint/auth_endpoint.py - -
      -
      - -#### auth.sign in - -```py -auth.sign_in(auth_req) -``` - -Signs you in to Tableau Server. - - -The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). - -REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) - -**Parameters** - -`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. - - -**Example** - -```py -import tableauserverclient as TSC - -# create an auth object -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') - -# create an instance for your server -server = TSC.Server('https://SERVER_URL') - -# call the sign-in method with the auth object -server.auth.sign_in(tableau_auth) - -``` - - -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) - -
      -
      - - -#### auth.sign out - -```py -auth.sign_out() -``` -Signs you out of the current session. - -The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). - -REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) - -**Example** - -```py - -server.auth.sign_out() - - -``` - - - - -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) - -
      -
      - ---- - - -## Connections - -The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. - -### ConnectionItem class - -```py -ConnectionItem() -``` - -The `ConnectionItem` class corresponds to workbook and data source connections. - -In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. - -**Attributes** - -Name | Description - :--- | : --- -`datasource_id` | The identifier of the data source. -`datasource_name` | The name of the data source. -`id` | The identifier of the connection. -`connection_type` | The type of connection. -`username` | The username for the connection. -`password` | The password used for the connection. -`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). -`server_address` | The server address for the connection. -`server_port` | The port used for the connection. - -Source file: models/connection_item.py - -
      -
      - - - -### ConnectionCredentials class - -```py -ConnectionCredentials(name, password, embed=True, oauth=False) -``` - - -The `ConnectionCredentials` class is used for workbook and data source publish requests. - - - -**Attributes** - -Attribute | Description -:--- | :--- -`name` | The username for the connection. -`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). -`password` | The password used for the connection. -`server_address` | The server address for the connection. -`server_port` | The port used by the server. -`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). - - -Source file: models/connection_credentials.py - -
      -
      - ---- - -## Data sources - -Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. -The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. - -
      - -### DatasourceItem class - -```py -DatasourceItem(project_id, name=None) -``` - -The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. - -**Attributes** - -Name | Description -:--- | :--- -`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. -`certified` | A Boolean value that indicates whether the data source is certified. -`certification_note` | The optional note that describes the certified data source. -`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. -`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. -`name` | The name of the data source. If not specified, the name of the published data source file is used. -`owner_id` | The identifier of the owner of the data source. -`project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. -`project_name` | The name of the project associated with the data source. -`tags` | The tags (list of strings) that have been added to the data source. -`updated_at` | The date and time when the data source was last updated. - - -**Example** - -```py - import tableauserverclient as TSC - - # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' - - new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39') -``` - - -Source file: models/datasource_item.py - -
      -
      - -### Datasources methods - -The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - -Source file: server/endpoint/datasources_endpoint.py - -
      -
      - -#### datasources.delete - -```py -datasources.delete(datasource_id) -``` - -Removes the specified data source from Tableau Server. - - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source) - -
      -
      - - -#### datasources.download - -```py -datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None) - -``` -Downloads the specified data source in `.tdsx` or `.hyper` format. - -REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source) - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. -`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. -`include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. -`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. - -**Example** - -```py - - file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - print("\nDownloaded the file to {0}.".format(file_path)) - -``` - - -
      -
      - -#### datasources.get - -```py -datasources.get(req_options=None) -``` - -Returns all the data sources for the site. - -To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) - -REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources) - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. - - -**Returns** - -Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - - - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('https://SERVERURL') - -with server.auth.sign_in(tableau_auth): - all_datasources, pagination_item = server.datasources.get() - print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) - print([datasource.name for datasource in all_datasources]) -``` - - - -
      -
      - - -#### datasources.get_by_id - -```py -datasources.get_by_id(datasource_id) -``` - -Returns the specified data source item. - -REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) - - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The `datasource_id` specifies the data source to query. - - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The `DatasourceItem`. See [DatasourceItem class](#datasourceitem-class) - - -**Example** - -```py - -datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e') -print(datasource.name) - -``` - - -
      -
      - - - -#### datasources.populate_connections - -```py -datasources.populate_connections(datasource_item) -``` - -Populates the connections for the specified data source. - -This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. - -REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) - -**Parameters** - -Name | Description -:--- | :--- -`datasource_item` | The `datasource_item` specifies the data source to populate with connection information. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. - - -**Returns** - -None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the data source - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - - -# get the connection information - server.datasources.populate_connections(datasource) - -# print the information about the first connection item - connection = datasource.connections[0] - print(connection.connection_type) - print(connection.id) - print(connection.server_address) - - ... - -``` - -
      -
      - -#### datasources.publish - -```py -datasources.publish(datasource_item, file_path, mode, connection_credentials=None) -``` - -Publishes a data source to a server, or appends data to an existing data source. - -This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. - -REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) - -**Parameters** - -Name | Description -:--- | :--- -`datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). -`file_path` | The path and name of the data source to publish. -`mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). - - - -**Exceptions** - -Error | Description -:--- | :--- -`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. - - -**Returns** - -The `DatasourceItem` for the data source that was added or appended to. - - -**Example** - -```py - - import tableauserverclient as TSC - server = TSC.Server('https://SERVERURL') - - ... - - project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' - file_path = r'C:\temp\WorldIndicators.tde' - - - # Use the project id to create new datsource_item - new_datasource = TSC.DatasourceItem(project_id) - - # publish data source (specified in file_path) - new_datasource = server.datasources.publish( - new_datasource, file_path, 'CreateNew') - - ... -``` - -
      -
      - -#### datasources.refresh - -```py -datasource.refresh(datasource_item) -``` - -Refreshes the data of the specified extract. - -REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. - - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. - - -**Returns** - -A refreshed `DatasourceItem`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://SERVERURL') -# sign in ... - -# get the data source item to update - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - -# call the refresh method with the data source item - refreshed_datasource = server.datasources.refresh(datasource) - -``` -
      -
      - -#### datasources.update - -```py -datasource.update(datasource_item) -``` - -Updates the owner or project of the specified data source. Data source name cannot be updated. - -REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. - - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. - - -**Returns** - -An updated `DatasourceItem`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://SERVERURL') -# sign in ... - -# get the data source item to update - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - -# do some updating - datasource.owner_id = 'New Owner ID' - -# call the update method with the data source item - updated_datasource = server.datasources.update(datasource) - - - -``` -
      -
      - -#### datasource.update_connection - -```py -datasource.update_connection(datasource_item, connection_item) -``` - -Updates the server address, port, username, or password for the specified data source connection. - -REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection) - - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. -`connection_item` | The `connection_item` that has the information you want to update. - - -**Returns** - -An updated `ConnectionItem` for the data source. - -**Example** - -See the `update_connection.py` sample in the Samples directory. - - -
      -
      - -## Filters - -The TSC library provides a `Filter` class that you can use to filter results returned from the server. - -You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: - -- Users -- Datasources -- Workbooks -- Views - -For more information, see [Filter and Sort](filter-sort). - - -### Filter class - -```py -Filter(field, operator, value) -``` - -The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. - - - -**Attributes** - -Name | Description -:--- | :--- -`Field` | Defined in the `RequestOptions.Field` class. -`Operator` | Defined in the `RequestOptions.Operator` class -`Value` | The value to compare with the specified field and operator. - - - - - -
      -
      - ---- - -## Groups - -Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group. - -The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. - -
      -
      - -### GroupItem class - -```py -GroupItem(name) -``` - -The `GroupItem` class contains the attributes for the group resources on Tableau Server. The `GroupItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -Source file: models/group_item.py - -**Attributes** - -Name | Description -:--- | :--- -`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). -`id` | The id of the group. -`users` | The list of users (`UserItem`). -`name` | The name of the group. The `name` is required when you create an instance of a group. - - - -**Example** - -```py - newgroup = TSC.GroupItem('My Group') - - # call groups.create() with new group -``` - - - - -
      -
      - -### Groups methods - -The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - - - -Source file: server/endpoint/groups_endpoint.py - -
      -
      - -#### groups.add_user - -```py -groups.add_user(group_item, user_id): -``` - -Adds a user to the specified group. - - -REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to update. -`user_id` | The id of the user. - - - - -**Returns** - -None. - - -**Example** - -```py -# Adding a user to a group -# -# get the group item - all_groups, pagination_item = server.groups.get() - mygroup = all_groups[1] - -# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba' - -# add Ian to the group - server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba') - - - -``` - -
      -
      - -#### groups.create - -```py -create(group_item) -``` - -Creates a new group in Tableau Server. - - -REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) - - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. - - - - -**Returns** -Adds new `GroupItem`. - - -**Example** - -```py - -# Create a new group - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - -# create a new instance with the group name - newgroup = TSC.GroupItem('My Group') - -# call the create method - newgroup = server.groups.create(newgroup) - -# print the names of the groups on the server - all_groups, pagination_item = server.groups.get() - for group in all_groups : - print(group.name, group.id) -``` - -
      -
      - -#### groups.delete - -```py -groups.delete(group_id) -``` - -Deletes the group on the site. - -REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) - - -**Parameters** - -Name | Description -:--- | :--- -`group_id` | The identifier (`id`) for the group that you want to remove from the server. - - -**Exceptions** - -Error | Description -:--- | :--- -`Group ID undefined` | Raises an exception if a valid `group_id` is not provided. - - -**Example** - -```py -# Delete a group from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') - -``` -
      -
      - -#### groups.get - -```py -groups.get(req_options=None) -``` - -Returns information about the groups on the site. - - -To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. - - -REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. - - -**Returns** - -Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -**Example** - - -```py -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the groups on the server - all_groups, pagination_item = server.groups.get() - - # print the names of the first 100 groups - for group in all_groups : - print(group.name, group.id) -``` - - -
      -
      - -#### groups.populate_users - -```py -groups.populate_users(group_item, req_options=None) -``` - -Populates the `group_item` with the list of users. - - -REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to populate with user information. -`req_options` | (Optional) Additional request options to send to the endpoint. - - - -**Exceptions** - -`Group item missing ID. Group must be retrieved from server first.` : Raises an error if the `group_item` is unspecified. - - -**Returns** - -None. A list of `UserItem` objects are added to the group (`group_item.users`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the group - all_groups, pagination_item = server.groups.get() - mygroup = all_groups[1] - -# get the user information - pagination_item = server.groups.populate_users(mygroup) - - -# print the names of the users - for user in mygroup.users : - print(user.name) - - - - -``` - -
      -
      - -#### groups.remove_user - -```py -groups.remove_user(group_item, user_id) -``` - -Removes a user from a group. - - - - -REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) - - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to remove the user from. -`user_id` | The id for the user. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. - - -**Returns** - -None. The user is removed from the group. - - -**Example** - -```py -# Remove a user from the group - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the group - mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') - - # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' - server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` - -
      -
      - ---- - -## Jobs - -Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. - -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. - -The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -### JobItem class - -```py -JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0) - -``` - -The `JobItem` class contains information about the specified job running on Tableau Server. The `JobItem` class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload. - -Source file: models/job_item.py - -**Attributes** - -Name | Description -:--- | :--- -`id` | The `id` of the job. -`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. -`created_at` | The time the job was created. -`started_at` | The time the job started. -`completed_at` | The time the job finished. -`finish_code` | The return code from job. - - -### Jobs methods - - -The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -Source files: server/endpoint/jobs_endpoint.py - -
      -
      - - -#### jobs.get - - -```py -jobs.get(job_id) - -``` - -Gets information about the specified job. - -REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) - - -**Parameters** - -Name | Description -:--- | :--- -`job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory - - - - -**Exceptions** - -Error | Description -:--- | :--- -`404018 Resource Not Found` | Raises an error if the `job_id` is not found. - - -**Returns** - -Returns the `JobItem` requested. - - -**Example** - -```py -# Query a Job - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the id of the job from response to extract refresh task, - # or another asynchronous REST API call. - # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" - - - myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' - jobinfo = server.jobs.get(myJobID) - - print(jobinfo) - - # - - - - -``` - - -
      -
      - ---- - -## Projects - -Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. - -The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. - - - - - -
      - -### ProjectItem class - -```py - -ProjectItem(name, description=None, content_permissions=None, parent_id=None) - -``` -The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. - -**Attributes** - -Name | Description -:--- | :--- -`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. -`name` | Name of the project. -`description` | The description of the project. -`id` | The project id. -`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). - - - -Source file: models/project_item.py - - -#### ProjectItem.ContentPermissions - -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). - -Name | Description -:--- | :--- -`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. -`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc - - -locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject -print(locked_true) -# prints 'LockedToProject' - -by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner -print(by_owner) -# prints 'ManagedByOwner' - - -# pass the content_permissions to new instance of the project item. -new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') - -``` - -
      -
      - -### Project methods - -The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. - - -Source files: server/endpoint/projects_endpoint.py - -
      -
      - - -#### projects.create - -```py -projects.create(project_item) -``` - - -Creates a project on the specified site. - -To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) - -**Parameters** - -Name | Description -:--- | :--- -`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. - - -**Returns** -Returns the new project item. - - - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('https://SERVER') - -with server.auth.sign_in(tableau_auth): - # create project item - new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') - # create the project - new_project = server.projects.create(new_project) - -``` - -
      -
      - - -#### projects.get - -```py -projects.get() - -``` - -Return a list of project items for a site. - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - -REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) - - -**Parameters** - -None. - -**Returns** - -Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - - - **Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('https://SERVER') - -with server.auth.sign_in(tableau_auth): - # get all projects on site - all_project_items, pagination_item = server.projects.get() - print([proj.name for proj in all_project_items]) - -``` - -
      -
      - - -#### projects.update - -```py -projects.update(project_item) -``` - -Modify the project settings. - -You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - -REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) - -**Parameters** - -Name | Description -:--- | :--- -`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. - - -**Exceptions** - -Error | Description - :--- | : --- -`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Returns** - -Returns the updated project information. - -See [ProjectItem class](#projectitem-class) - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc - - ... - # get list of projects - all_project_items, pagination_item = server.projects.get() - - - # update project item #7 with new name, etc. - my_project = all_projects[7] - my_project.name ='New name' - my_project.description = 'New description' - - # call method to update project - updated_project = server.projects.update(my_project) - - - - -``` -
      -
      - - -#### projects.delete - -```py -projects.delete(project_id) -``` - -Deletes a project by ID. - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) - - -**Parameters** - -Name | Description -:--- | :--- -`project_id` | The ID of the project to delete. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') - -``` - - -
      -
      - ---- - -## Requests - -The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. - -You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: - -- Users -- Datasources -- Groups -- Workbooks -- Views - - -You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. - -For more information about filtering and sorting, see [Filter and Sort](filter-sort). - - -
      - - - -### RequestOptions class - -```py -RequestOptions(pagenumber=1, pagesize=100) - -``` - - - -**Attributes** - -Name | Description -:--- | :--- -`pagenumber` | The page number of the returned results. The default value is 1. -`pagesize` | The number of items to return with each page (the default value is 100). -`sort()` | Returns a iterable set of `Sort` objects. -`filter()` | Returns an iterable set of `Filter` objects. - -
      -
      - - - -#### RequestOptions.Field class - -The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. - -**Attributes** - -**Attributes** - -Field | Description -:--- | :--- -`CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` -`LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` -`Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` -`OwnerName` | Same as 'ownerName' in the REST API. `RequestOptions.Field.OwnerName` -`SiteRole` | Same as 'siteRole' in the REST API. `RequestOptions.Field.SiteRole` -`Tags` | Same as 'tags' in the REST API. `RequestOptions.Field.Tags` -`UpdatedAt` | Same as 'updatedAt' in the REST API. `RequestOptions.Field.UpdatedAt` - - -
      -
      - - - -#### RequestOptions.Operator class - -Specifies the operators you can use to filter requests. - - -**Attributes** - -Operator | Description -:--- | :--- -`Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` -`GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` -`GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` -`LessThan` | Sets the operator to less than (same as `lt` in the REST API). `TSC.RequestOptions.Operator.LessThan` -`LessThanOrEqual` | Sets the operator to less than or equal (same as `lte` in the REST API). `TSC.RequestOptions.Operator.LessThanOrEqual` -`In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In` - -
      -
      - - - -#### RequestOptions.Direction class - -Specifies the direction to sort the returned fields. - - -**Attributes** - -Name | Description -:--- | :--- -`Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) -`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). - -
      -
      - -### CSVRequestOptions class - -```py -CSVRequestOptions(maxage=-1) -``` -Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a `maxage` value. See `views.populate_csv`. - -**Attributes** - -Name | Description -:--- | :--- -`maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set view filters -csv_req_option = TSC.CSVRequestOptions(maxage=5) -csv_req_option.vf('Region', 'South') -csv_req_option.vf('Category', 'Furniture') - -# retrieve the csv data for the view -server.views.populate_csv(view_item, csv_req_option) -``` - -### ImageRequestOptions class - -```py -ImageRequestOptions(imageresolution=None, maxage=-1) -``` -Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. - -**Attributes** - -Name | Description -:--- | :--- -`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. -`maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**View Filters** - -You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the image is generated, the specified filters will be applied to the view. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set the image request option -image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) - -# (optional) set a view filter -image_req_option.vf('Category', 'Furniture') - -# retrieve the image for the view -server.views.populate_image(view_item, image_req_option) - -``` - -### PDFRequestOptions class - -```py -PDFRequestOptions(page_type=None, orientation=None, maxage=-1) -``` -Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. - -**Attributes** - -Name | Description -:--- | :--- -`page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` -`orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` -`maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**View Filters** -You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set the PDF request options -pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, - orientation=TSC.PDFRequestOptions.Orientation.Landscape, - maxage=1) - -# (optional) set a view filter -pdf_req_option.vf('Region', 'West') - -# retrieve the PDF for a view -server.views.populate_pdf(view_item, pdf_req_option) - -``` - - -
      -
      - ---- - -## Schedules - -Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. - -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. - -The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -### ScheduleItem class - -```py -ScheduleItem(name, priority, schedule_type, execution_order, interval_item) - -``` - -The `ScheduleItem` class contains information about the specified schedule running on Tableau Server. The `ScheduleItem` class defines the information you can query and set. The class members correspond to the attributes of a server response payload. - -Source file: models/schedule_item.py - -**Attributes** - -Name | Description -:--- | :--- -`name` | The `name` of the schedule. -`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. -`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. -`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. -`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. - - -#### IntervalItem class -This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. - -**Attributes** - -Name | Description -:--- | :--- -`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. -`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. -`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. -`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The - - - - -### Schedule methods - -The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. - - -Source files: server/endpoint/schedules_endpoint.py - -#### schedule.create - -```py -schedule.create(schedule_item) -``` -Creates a new schedule for an extract refresh or a subscription. - - -REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) - - - -**Parameters** - -Name | Description -:--- | :--- -`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. - - -**Returns** - -Returns a new instance of `schedule_item`. - -**Exceptions** - -Error | Description -:--- | :--- -`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. - - -**Example** - -```py -import tableauserverclient as TSC -# sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) -``` -
      -
      - - -#### schedule.delete - -```py -schedule.delete(schedule_id) -``` - -Deletes an existing schedule for an extract refresh or a subscription. - - -REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) - - - -**Parameters** - -Name | Description -:--- | :--- -`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. - - -**Returns** - -None. - -**Exceptions** - -Error | Description -:--- | :--- -`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. - - -#### schedule.get - -```py -schedule.get([req_options=None]) -``` - -Returns all schedule items from the server. - - -REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) - - - -**Parameters** - -Name | Description -:--- | :--- -`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . - -#### schedule.update - -
      -
      - - -**Hourly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) -``` - -**Daily schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a daily interval to run every day at 12:30AM - Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) - # Create schedule item using daily interval - daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) - # Create daily schedule - daily_schedule = server.schedules.create(daily_schedule) - -``` - -**Weekly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM - weekly_interval = TSC.WeeklyInterval(time(19, 15), - TSC.IntervalItem.Day.Monday, - TSC.IntervalItem.Day.Wednesday, - TSC.IntervalItem.Day.Friday) - # Create schedule item using weekly interval - weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, - TSC.ScheduleItem.Type.Extract, - TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) - # Create weekly schedule - weekly_schedule = server.schedules.create(weekly_schedule) - -``` - -**Monthly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a monthly interval to run on the 15th of every month at 11:30PM - monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), - interval_value=15) - # Create schedule item using monthly interval - monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, - TSC.ScheduleItem.Type.Subscription - TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) - # Create monthly schedule - monthly_schedule = server.schedules.create(monthly_schedule) -``` - - - -
      -
      - ---- - - -## Server - -In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) -The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. - - -
      -
      - - -### Server class - -```py -Server(server_address) -``` -The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. - -**Attributes** - -Attribute | Description -:--- | :--- -`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). -`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) - - - -**Example** - -```py -import tableauserverclient as TSC - - -# create a instance of server -server = TSC.Server('https://MY-SERVER') - -# sign in, etc. - -# change the REST API version to match the server -server.use_server_version() - -# or change the REST API version to match a specific version -# for example, 2.8 -# server.version = '2.8' - -``` - -#### Server.*Resources* - -When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` - - - -Resource | Description - :--- | : --- -*server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | -*server*.views | Access the server views and methods. See [Views](#views) -*server*.users | Access the user resources and methods. See [Users](#users) -*server*.sites | Access the sites. See [Sites](#sites) -*server*.groups | Access the groups resources and methods. See [Groups](#groups) -*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) -*server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) -*server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) -*server*.projects | Access the resources and methods for projects. See [Projects](#projects) -*server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) -*server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) -*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class) - -
      -
      - -#### Server.PublishMode - -The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. - - -**Properties** - -Resource | Description - :--- | : --- -`PublishMode.Overwrite` | Overwrites the workbook or data source. -`PublishMode.Append` | Appends to the workbook or data source. -`PublishMode.CreateNew` | Creates a new workbook or data source. - - -**Example** - -```py - import tableauserverclient as TSC - # login, etc. - - print(TSC.Server.PublishMode.Overwrite) - # prints 'Overwrite' - - overwrite_true = TSC.Server.PublishMode.Overwrite - - ... - - # pass the PublishMode to the publish workbooks method - new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true) - - -``` - - -
      -
      - - -### ServerInfoItem class - -```py -ServerInfoItem(product_version, build_number, rest_api_version) -``` -The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. - -**Attributes** - -Name | Description -:--- | :--- -`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). -`build_number` | Shows the specific build number (for example, 10200.17.0329.1446). -`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. - - -
      -
      - - -### ServerInfo methods - -The TSC library provides a method to access the build and version information from Tableau Server. - -
      - -#### server_info.get - -```py -server_info.get() - -``` -Retrieve the build and version information for the server. - -This method makes an unauthenticated call, so no sign in or authentication token is required. - -REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) - -**Parameters** - None - -**Exceptions** - -Error | Description -:--- | :--- -`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. - -**Example** - -```py -import tableauserverclient as TSC - -# create a instance of server -server = TSC.Server('https://MY-SERVER') - -# set the version number > 2.3 -# the server_info.get() method works in 2.4 and later -server.version = '2.5' - -s_info = server.server_info.get() -print("\nServer info:") -print("\tProduct version: {0}".format(s_info.product_version)) -print("\tREST API version: {0}".format(s_info.rest_api_version)) -print("\tBuild number: {0}".format(s_info.build_number)) - -``` - - -
      -
      - ---- - -## Sites - -Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. - -The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. - -
      -
      - -### SiteItem class - -```py -SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None, - disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) -``` - -The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. - -**Attributes** - -Attribute | Description -:--- | :--- -`name` | The name of the site. The name of the default site is "". -`content_url` | The path to the site. -`admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) -`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. -`storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. -`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. -`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. -`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. -`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. -`state` | Shows the current state of the site (`Active` or `Suspended`). - - -**Example** - -```py - -# create a new instance of a SiteItem - -new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True) - -``` - -Source file: models/site_item.py - -
      -
      - - -### Site methods - -The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. - - -Source file: server/endpoint/sites_endpoint.py - -
      -
      - -#### sites.create - -```py -sites.create(site_item) -``` - -Creates a new site on the server for the specified site item object. - -Tableau Server only. - - -REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) - - - -**Parameters** - -Name | Description -:--- | :--- -`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. - - -**Returns** - -Returns a new instance of `SiteItem`. - - -**Example** - -```py -import tableauserverclient as TSC - -# create an instance of server -server = TSC.Server('https://MY-SERVER') - -# create shortcut for admin mode -content_users=TSC.SiteItem.AdminMode.ContentAndUsers - -# create a new SiteItem -new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True) - -# call the sites create method with the SiteItem -new_site = server.sites.create(new_site) -``` -
      -
      - -#### sites.get - -```py -sites.get() -``` - -Queries all the sites on the server. - - -REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) - - -**Parameters** - - None. - -**Returns** - -Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - # query the sites - all_sites, pagination_item = server.sites.get() - - # print all the site names and ids - for site in all_sites: - print(site.id, site.name, site.content_url, site.state) - - -``` - -
      -
      - - - -#### sites.get_by_id - -```py -sites.get_by_id(site_id) -``` - -Queries the site with the given ID. - - -REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) - -**Parameters** - -Name | Description -:--- | :--- -`site_id` | The id for the site you want to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`Site ID undefined.` | Raises an error if an id is not specified. - - -**Returns** - -Returns the `SiteItem`. - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') - print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) - -``` - -
      -
      - -#### sites.get_by_name - -```py -sites.get_by_name(site_name) -``` - -Queries the site with the specified name. - - -REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) - -**Parameters** - -Name | Description -:--- | :--- -`site_name` | The name of the site you want to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`Site Name undefined.` | Raises an error if an name is not specified. - - -**Returns** - -Returns the `SiteItem`. - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - a_site = server.sites.get_by_name('MY_SITE') - - -``` - -
      -
      - - - -#### sites.update - -```py -sites.update(site_item) -``` - -Modifies the settings for site. - - -The site item object must include the site ID and overrides all other settings. - - -REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) - - -**Parameters** - -Name | Description -:--- | :--- -`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. - - -**Exceptions** - -Error | Description -:--- | :--- -`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. -`You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` - - -**Returns** - -Returns the updated `site_item`. - - -**Example** - -```py -... - -# make some updates to an existing site_item -site_item.name ="New name" - -# call update -site_item = server.sites.update(site_item) - -... -``` - -
      -
      - - - - -#### sites.delete - - -```py -Sites.delete(site_id) -``` - -Deletes the specified site. - - -REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site) - - -**Parameters** - -Name | Description - :--- | : --- -`site_id` | The id of the site that you want to delete. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. - - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - -server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') - -``` - -
      -
      - ---- - - -## Sort - -The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. - -You can use the sort and request options to filter and sort the following endpoints: - -- Users -- Datasources -- Workbooks -- Views - -### Sort class - -```py -sort(field, direction) -``` - - - -**Attributes** - -Name | Description -:--- | :--- -`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. -`direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. - -**Example** - -```py - -# create a new instance of a request option object -req_option = TSC.RequestOptions() - -# add the sort expression, sorting by name and direction -req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, - TSC.RequestOptions.Direction.Asc)) -matching_workbooks, pagination_item = server.workbooks.get(req_option) - -for wb in matching_workbooks: - print(wb.name) -``` - -For information about using the `Sort` class, see [Filter and Sort](filter-sort). - -
      -
      - ---- - -## Subscriptions - -Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions. - -### SubscriptionItem class - -The subscription resources for Tableau Server are defined in the `SubscriptionItem` class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the `SubscriptionItem` class. - -```py -SubscriptionItem(subject, schedule_id, user_id, target) - -``` - -**Attributes** - -Name | Description -:--- | :--- -`id` | The id of the subscription on the site. -`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. -`schedule_id` | The identifier associated with the specific subscription. -`user_id` | The identifier of the user (person) who receives the subscription. -`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. - - - - -Source files: server/endpoints/subscription_item.py - - -### Subscription methods - -The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - - - -Source files: server/endpoints/subscriptions_endpoint.py - -
      -
      - -#### subscription.create - -```py -subscription.create(subscription_item) -``` -Creates a subscription to a view or workbook for a specific user. -When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. - -To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). - - -REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription) - -**Parameters** - -Name | Description - :--- | : --- -`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. - - -**Returns** - -Returns the new `SubscriptionItem` object. - - - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') -# create auth, specify site -# login, etc. - - -# create the target (content) of the subscription -# in this case, id of the workbook add the target type "workbook" - - target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') - -# the ids for the schedule and user - schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') - user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' - -# create a new SubscriptionItem object. - newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) - -# create the new subscription to the site - newSub = server.subscriptions.create(newSub) - print(newUSub.subject) - -``` - - -
      -
      - - - -#### subscriptions.delete - -```py -subscriptions.delete(subscription_id) -``` - - - -Deletes the specified subscription from the site. - -REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) - - -**Parameters** - -Name | Description - :--- | : --- -`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. - - -**Exceptions** - -Error | Description - :--- | : --- -`Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. - - -**Example** - -```py -# Remove a subscription from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') -# server = TSC.Server('https://SERVERURL') - - - with server.auth.sign_in(tableau_auth): - server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` -
      -
      - -
      -
      - -#### subscription.get - -```py -subscription.get(req_options=None) -``` -Returns information about the subscriptions on the specified site. - - -REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions) - -**Parameters** - -Name | Description - :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. - - -**Returns** -Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -
      -
      - -#### subscription.get_by_id - - -```py -subscription.get_by_id(subscription_id) -``` - -Returns information about the specified subscription. - -REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) - - -**Parameters** - -Name | Description - :--- | : --- -`subscription_id` | The `subscription_id` specifies the subscription to query. - - - -**Exceptions** - -Error | Description - :--- | : --- -`No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. - - -**Returns** - -The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) - - -**Example** - -```py - sub1 = server.subscription.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - print(sub1.subject) - -``` - - - - - -
      -
      - ---- - -## Users - -Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. - -The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. - - -### UserItem class - -```py -UserItem(name, site_role, auth_setting=None) -``` - -The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -**Attributes** - -Name | Description -:--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. -`domain_name` | The name of the site. -`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. -`id` | The id of the user on the site. -`last_login` | The date and time the user last logged in. -`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. -`email` | The email address of the user. -`fullname` | The full name of the user. -`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') - -# create a new UserItem object. - newU = TSC.UserItem('Monty', 'Publisher') - - print(newU.name, newU.site_role) - -``` - -Source file: models/user_item.py - -
      -
      - - -### Users methods - -The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - -Source file: server/endpoint/users_endpoint.py -
      -
      - -#### users.add - -```py -users.add(user_item) -``` - -Adds the user to the site. - -To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. - -REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. - - -**Returns** - -Returns the new `UserItem` object. - - - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') -# login, etc. - -# create a new UserItem object. - newU = TSC.UserItem('Heather', 'Publisher') - -# add the new user to the site - newU = server.users.add(newU) - print(newU.name, newU.site_role) - -``` - -#### users.get - -```py -users.get(req_options=None) -``` - -Returns information about the users on the specified site. - -To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. - - -REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) - -**Parameters** - -Name | Description - :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. - - -**Returns** - -Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -**Example** - - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('https://SERVERURL') - -with server.auth.sign_in(tableau_auth): - all_users, pagination_item = server.users.get() - print("\nThere are {} user on site: ".format(pagination_item.total_available)) - print([user.name for user in all_users]) -``` - -
      -
      - -#### users.get_by_id - - -```py -users.get_by_id(user_id) -``` - -Returns information about the specified user. - -REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) - - -**Parameters** - -Name | Description - :--- | : --- -`user_id` | The `user_id` specifies the user to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`User ID undefined.` | Raises an exception if a valid `user_id` is not provided. - - -**Returns** - -The `UserItem`. See [UserItem class](#useritem-class) - - -**Example** - -```py - user1 = server.users.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - print(user1.name) - -``` - -
      -
      - - -#### users.populate_favorites - -```py -users.populate_favorites(user_item) -``` - -Returns the list of favorites (views, workbooks, and data sources) for a user. - -*Not currently implemented* - -
      -
      - - -#### users.populate_workbooks - -```py -users.populate_workbooks(user_item, req_options=None): -``` - -Returns information about the workbooks that the specified user owns and has Read (view) permissions for. - - -This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). - -REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | The `user_item` specifies the user to populate with workbook information. - - - - -**Exceptions** - -Error | Description - :--- | : --- -`User item missing ID.` | Raises an error if the `user_item` is unspecified. - - -**Returns** - -A list of `WorkbookItem` - -A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) - - -**Example** - -```py -# first get all users, call server.users.get() -# get workbooks for user[0] - ... - - page_n = server.users.populate_workbooks(all_users[0]) - print("\nUser {0} owns or has READ permissions for {1} workbooks".format(all_users[0].name, page_n.total_available)) - print("\nThe workbooks are:") - for workbook in all_users[0].workbooks : - print(workbook.name) - - ... -``` - - - - -
      -
      - -#### users.remove - -```py -users.remove(user_id) -``` - - - -Removes the specified user from the site. - -REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) - - -**Parameters** - -Name | Description - :--- | : --- -`user_id` | The identifier (`id`) for the user that you want to remove from the server. - - -**Exceptions** - -Error | Description - :--- | : --- -`User ID undefined` | Raises an exception if a valid `user_id` is not provided. - - -**Example** - -```py -# Remove a user from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` -
      -
      - - - - -#### users.update - -```py -users.update(user_item, password=None) -``` - -Updates information about the specified user. - -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). - - - -REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user) - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | The `user_item` specifies the user to update. -`password` | (Optional) The new password for the user. - - - -**Exceptions** - -Error | Description - :--- | : --- -`User item missing ID.` | Raises an error if the `user_item` is unspecified. - - -**Returns** - -An updated `UserItem`. See [UserItem class](#useritem-class) - - -**Example** - -```py - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # create a new user_item - user1 = TSC.UserItem('temp', 'Viewer') - - # add new user - user1 = server.users.add(user1) - print(user1.name, user1.site_role, user1.id) - - # modify user info - user1.name = 'Laura' - user1.fullname = 'Laura Rodriguez' - user1.email = 'laura@example.com' - - # update user - user1 = server.users.update(user1) - print("\Updated user info:") - print(user1.name, user1.fullname, user1.email, user1.id) - - -``` - - - -
      -
      - - ---- - -## Views - -Using the TSC library, you can get information about views in a site or a workbook. - -The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. - -
      - -### ViewItem class - -``` -ViewItem() -``` - -The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -Source file: models/view_item.py - -**Attributes** - -Name | Description -:--- | :--- -`content_url` | The name of the view as it would appear in a URL. -`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. -`id` | The identifier of the view item. -`image` | The image of the view. You must first call the `views.populate_image`method to access the image. -`name` | The name of the view. -`owner_id` | The ID for the owner of the view. -`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content. -`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image. -`project_id` | The ID of the project that contains the view. -`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. -`workbook_id` | The ID of the workbook associated with the view. - - -
      -
      - - -### Views methods - -The Tableau Server Client provides methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. - -Source file: server/endpoint/views_endpoint.py - -
      -
      - -#### views.get -``` -views.get(req_options=None, usage=False) -``` - -Returns the list of views items for a site. - - -REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site) - -**Version** - -This endpoint is available with REST API version 2.0 and up. - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. -`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. - - - -**Returns** - -Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - all_views, pagination_item = server.views.get() - print([view.name for view in all_views]) -``` - -**Example using Pager** - -You can also use the provided Pager generator to get all views on site, without having to page through the results. -```py -for view in TSC.Pager(server.views): - print(view.name) -``` - -See [ViewItem class](#viewitem-class) - - -
      -
      - -#### views.populate_preview_image - -```py - views.populate_preview_image(view_item) -``` - -Populates a preview image for the specified view. - -This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. - -REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview) - -**Version** - -This endpoint is available with REST API version 2.0 and up. - -**Parameters** - -Name | Description -:--- | :--- -`view_item` | Specifies the view to populate. - - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. - - -**Returns** - -None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the preview image as 'view_preview_image.png' -server.views.populate_preview_image(view_item) -with open('./view_preview_image.png', 'wb') as f: - f.write(view_item.preview_image) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_image - -```py -views.populate_image(view_item, req_options=None) -``` - -Populates the image of the specified view. - -This method uses the `id` field to query the image, and populates the image content as the `image` field. - -REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image) - -**Version** - -This endpoint is available with REST API version 2.5 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The image is added to the `view_item` and can be accessed by its `image` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the view image as 'view_image.png' -server.views.populate_image(view_item) -with open('./view_image.png', 'wb') as f: - f.write(view_item.image) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_csv -``` -views.populate_csv(view_item) -``` - -Populates the CSV data of the specified view. - -This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. - -REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data) - -**Version** - -This endpoint is available with REST API version 2.7 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the CSV data as 'view_csv.csv' -server.views.populate_csv(view_item) -with open('./view_csv.csv', 'wb') as f: - # Perform byte join on the CSV data - f.write(b''.join(view_item.csv)) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_pdf -``` -views.populate_pdf(view_item, req_options=None) -``` - -Populates the PDF content of the specified view. - -This method populates a PDF with image(s) of the view you specify. - -REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf) - -**Version** - -This endpoint is available with REST API version 2.7 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the view pdf as 'view_pdf.pdf' -server.views.populate_pdf(view_item) -with open('./view_pdf.pdf', 'wb') as f: - f.write(view_item.pdf) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - - ---- - - -## Workbooks - -Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. - -The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. - - - - - -
      -
      - -### WorkbookItem class - -```py - - WorkbookItem(project_id, name=None, show_tabs=False) - -``` -The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project - - -**Attributes** - -Name | Description -:--- | :--- -`connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. -`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. -`name` | The name of the workbook. -`owner_id` | The ID of the owner. -`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. -`project_id` | The project id. -`project_name` | The name of the project. -`size` | The size of the workbook (in megabytes). -`show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. -`tags` | The tags that have been added to the workbook. -`updated_at` | The date and time when the workbook was last updated. -`views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). - - - - - -**Example** - -```py -# creating a new instance of a WorkbookItem -# -import tableauserverclient as TSC - -# Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' - - new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') - - -```` - -Source file: models/workbook_item.py - -
      -
      - -### Workbook methods - -The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. -The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. - - - -Source files: server/endpoint/workbooks_endpoint.py - -
      -
      - -#### workbooks.get - -```py -workbooks.get(req_options=None) -``` - -Queries the server and returns information about the workbooks the site. - - - - - -REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site) - - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) - - -**Returns** - -Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - -**Example** - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - all_workbooks_items, pagination_item = server.workbooks.get() - # print names of first 100 workbooks - print([workbook.name for workbook in all_workbooks_items]) - - - -``` - -
      -
      - - - -#### workbooks.get_by_id - -```py -workbooks.get_by_id(workbook_id) -``` - -Returns information about the specified workbook on the site. - -REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook) - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). - - -**Exceptions** - -Error | Description - :--- | : --- -`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. - - -**Returns** - -The `WorkbookItem`. See [WorkbookItem class](#workbookitem-class) - - -**Example** - -```py - -workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') -print(workbook.name) - -``` - - -
      -
      - - -#### workbooks.publish - -```py -workbooks.publish(workbook_item, file_path, publish_mode) -``` - -Publish a workbook to the specified site. - -**Note:** The REST API cannot automatically include -extracts or other resources that the workbook uses. Therefore, - a .twb file that uses data from an Excel or csv file on a local computer cannot be published, -unless you package the data and workbook in a .twbx file, or publish the data source separately. - -For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. - -REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) - - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). -`file_path` | The path and name of the workbook to publish. -`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). - - - -**Exceptions** - -Error | Description -:--- | :--- -`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. -`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. - -See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. - -**Returns** - -The `WorkbookItem` for the workbook that was published. - - -**Example** - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - # create a workbook item - wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') - # call the publish method with the workbook item - wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') -``` - -
      -
      - -#### workbooks.refresh - -```py -workbooks.refresh(workbook_item) -``` - - -Refreshes the extract of an existing workbook. - -REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. - - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - - # get the workbook item from the site - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - # call the update method - workbook = server.workbooks.refresh(workbook) - print("\nThe data of workbook {0} is refreshed.".format(workbook.name)) - - -``` - - -
      -
      - -#### workbooks.update - -```py -workbooks.update(workbook_item) -``` - - -Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. - -REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook) - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. - - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - - # get the workbook item from the site - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - print("\nUpdate {0} workbook. Project was {1}".format(workbook.name, workbook.project_name)) - - - # make an change, for example a new project ID - workbook.project_id = '1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e' - - # call the update method - workbook = server.workbooks.update(workbook) - print("\nUpdated {0} workbook. Project is now {1}".format(workbook.name, workbook.project_name)) - - -``` - - -
      -
      - - - -#### workbooks.delete - -```py -workbooks.delete(workbook_id) -``` - -Deletes a workbook with the specified ID. - - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The ID of the workbook to delete. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# tableau_auth sign in, etc. - - server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - -``` - - -
      -
      - - -#### workbooks.download - -```py -workbooks.download(workbook_id, filepath=None, no_extract=False) -``` - -Downloads a workbook to the specified directory (optional). - - -REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook) - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. -`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. -`no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The file path to the downloaded workbook. - - -**Example** - -```py - - file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - print("\nDownloaded the file to {0}.".format(file_path)) - -```` - - -
      -
      - - -#### workbooks.populate_views - -```py -workbooks.populate_views(workbook_item) -``` - -Populates (or gets) a list of views for a workbook. - -You must first call this method to populate views before you can iterate through the views. - -This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. - -REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. - - -**Returns** - -None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - -# get the view information - server.workbooks.populate_views(workbook) - -# print information about the views for the work item - print("\nThe views for {0}: ".format(workbook.name)) - print([view.name for view in workbook.views]) - - ... - -``` - -
      -
      - -#### workbooks.populate_connections - -```py -workbooks.populate_connections(workbook_item) -``` - -Populates a list of data source connections for the specified workbook. - -You must populate connections before you can iterate through the -connections. - -This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. - -REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. - - -**Returns** - -None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - -# get the connection information - server.workbooks.populate_connections(workbook) - -# print information about the data connections for the workbook item - print("\nThe connections for {0}: ".format(workbook.name)) - print([connection.id for connection in workbook.connections]) - - - ... - -``` - -
      -
      - - -#### workbooks.populate_preview_image - -```py -workbooks.populate_preview_image(workbook_item) -``` - -This method gets the preview image (thumbnail) for the specified workbook item. - -The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. - -REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) - -**Parameters** - -Name | Description -:--- | :--- -`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. - - - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. - - - -**Returns** - -None. The preview image is added to the view. - - - -**Example** - -```py - -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') - - ... - - # get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - # add the png thumbnail to the workbook item - server.workbooks.populate_preview_image(workbook) - - -``` - -
      -
      - -#### workbooks.update_connection - -```py -workbooks.update_conn(workbook_item, connection_item) -``` - -Updates a workbook connection information (server address, server port, user name, and password). - -The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) - -REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection) - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. -`connection_item` | The `connection_item` that has the information you want to update. - - - -**Returns** - -None. The connection information is updated with the information in the `ConnectionItem`. - - - - -**Example** - -```py - -# query for workbook connections -server.workbooks.populate_connections(workbook) - -# update connection item user name and password -connection = workbook.connections[0] -connection.username = 'USERNAME' -connection.password = 'PASSWORD' - -# call the update method -server.workbooks.update_conn(workbook, connection) -``` - -
      -
      - -#### workbooks.populate_pdf -``` -workbooks.populate_pdf(workbook_item, req_options=None) -``` - -Populates the PDF content of the specified workbook. - -This method populates a PDF with image(s) of the workbook view(s) you specify. - -REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) - -**Version** - -This endpoint is available with REST API version 3.4 and up. - -**Parameters** - -Name | description -:--- | :--- -`workbook_item` | Specifies the workbook to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID` | Raises an error if the ID of the workbook is missing. - -**Returns** - -None. The PDF content is added to the `workbook_item` and can be accessed by its `pdf` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the workbook pdf as 'workbook_pdf.pdf' -server.workbooks.populate_pdf(workbook_item) -with open('./workbook_pdf.pdf', 'wb') as f: - f.write(workbook_item.pdf) -``` - -
      -
      - - diff --git a/docs/api-ref.md b/docs/api-ref.md index 71e0a3a15..628221247 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3742,7 +3742,7 @@ Deletes a workbook with the specified ID. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). -REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) +REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_workbook1) **Parameters** diff --git a/docs/api-ref.md.orig b/docs/api-ref.md.orig deleted file mode 100644 index 51e4b4e26..000000000 --- a/docs/api-ref.md.orig +++ /dev/null @@ -1,4103 +0,0 @@ ---- -title: API reference -layout: docs ---- - -
      - Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. - -
      - - - -The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. - -The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. - -|:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| - - - -* TOC -{:toc } - -
      -
      - ---- - -## Authentication - -You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. - -
      -
      - -### TableauAuth class - -```py -TableauAuth(username, password, site_id='', user_id_to_impersonate=None) -``` -The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. - - - **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). - -**Attributes** - -Name | Description -:--- | :--- -`username` | The name of the user whose credentials will be used to sign in. -`password` | The password of the user. -`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. -`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. - -Source file: models/tableau_auth.py - -**Example** - -```py -import tableauserverclient as TSC -# create a new instance of a TableauAuth object for authentication - -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') - -# create a server instance -# pass the "tableau_auth" object to the server.auth.sign_in() method -``` - -
      -
      - -### Auth methods -The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. - - -Source file: server/endpoint/auth_endpoint.py - -
      -
      - -#### auth.sign in - -```py -auth.sign_in(auth_req) -``` - -Signs you in to Tableau Server. - - -The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). - -REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} - -**Parameters** - -`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. - - -**Example** - -```py -import tableauserverclient as TSC - -# create an auth object -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') - -# create an instance for your server -server = TSC.Server('https://SERVER_URL') - -# call the sign-in method with the auth object -server.auth.sign_in(tableau_auth) - -``` - - -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) - -
      -
      - - -#### auth.sign out - -```py -auth.sign_out() -``` -Signs you out of the current session. - -The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). - -REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} - -**Example** - -```py - -server.auth.sign_out() - - -``` - - - - -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) - -
      -
      - ---- - - -## Connections - -The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. - -### ConnectionItem class - -```py -ConnectionItem() -``` - -The `ConnectionItem` class corresponds to workbook and data source connections. - -In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. - -**Attributes** - -Name | Description - :--- | : --- -`datasource_id` | The identifier of the data source. -`datasource_name` | The name of the data source. -`id` | The identifier of the connection. -`connection_type` | The type of connection. -`username` | The username for the connection. -`password` | The password used for the connection. -`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). -`server_address` | The server address for the connection. -`server_port` | The port used for the connection. - -Source file: models/connection_item.py - -
      -
      - - - -### ConnectionCredentials class - -```py -ConnectionCredentials(name, password, embed=True, oauth=False) -``` - - -The `ConnectionCredentials` class is used for workbook and data source publish requests. - - - -**Attributes** - -Attribute | Description -:--- | :--- -`name` | The username for the connection. -`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). -`password` | The password used for the connection. -`server_address` | The server address for the connection. -`server_port` | The port used by the server. -`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. - - -Source file: models/connection_credentials.py - -
      -
      - ---- - -## Data sources - -Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. -The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. - -
      - -### DatasourceItem class - -```py -DatasourceItem(project_id, name=None) -``` - -The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. - -**Attributes** - -Name | Description -:--- | :--- -`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. -`certified` | A Boolean value that indicates whether the data source is certified. -`certification_note` | The optional note that describes the certified data source. -`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. -`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. -`name` | The name of the data source. If not specified, the name of the published data source file is used. -`owner_id` | The identifier of the owner of the data source. -`project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. -`project_name` | The name of the project associated with the data source. -`tags` | The tags (list of strings) that have been added to the data source. -`updated_at` | The date and time when the data source was last updated. - - -**Example** - -```py - import tableauserverclient as TSC - - # Create new datasource_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' - - new_datasource = TSC.DatasourceItem('3a8b6148-493c-11e6-a621-6f3499394a39') -``` - - -Source file: models/datasource_item.py - -
      -
      - -### Datasources methods - -The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - -Source file: server/endpoint/datasources_endpoint.py - -
      -
      - -#### datasources.delete - -```py -datasources.delete(datasource_id) -``` - -Removes the specified data source from Tableau Server. - - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} - -
      -
      - - -#### datasources.download - -```py -datasources.download(datasource_id, filepath=None, include_extract=True, no_extract=None) - -``` -Downloads the specified data source in `.tdsx` or `.hyper` format. - -REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. -`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. -`include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. -`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. - -**Example** - -```py - - file_path = server.datasources.download('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - print("\nDownloaded the file to {0}.".format(file_path)) - -``` - - -
      -
      - -#### datasources.get - -```py -datasources.get(req_options=None) -``` - -Returns all the data sources for the site. - -To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) - -REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. - - -**Returns** - -Returns a list of `DatasourceItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - - - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('https://SERVERURL') - -with server.auth.sign_in(tableau_auth): - all_datasources, pagination_item = server.datasources.get() - print("\nThere are {} datasources on site: ".format(pagination_item.total_available)) - print([datasource.name for datasource in all_datasources]) -``` - - - -
      -
      - - -#### datasources.get_by_id - -```py -datasources.get_by_id(datasource_id) -``` - -Returns the specified data source item. - -REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`datasource_id` | The `datasource_id` specifies the data source to query. - - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The `DatasourceItem`. See [DatasourceItem class](#datasourceitem-class) - - -**Example** - -```py - -datasource = server.datasources.get_by_id('59a57c0f-3905-4022-9e87-424fb05e9c0e') -print(datasource.name) - -``` - - -
      -
      - - - -#### datasources.populate_connections - -```py -datasources.populate_connections(datasource_item) -``` - -Populates the connections for the specified data source. - -This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. - -REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`datasource_item` | The `datasource_item` specifies the data source to populate with connection information. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. - - -**Returns** - -None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the data source - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - - -# get the connection information - server.datasources.populate_connections(datasource) - -# print the information about the first connection item - connection = datasource.connections[0] - print(connection.connection_type) - print(connection.id) - print(connection.server_address) - - ... - -``` - -
      -
      - -#### datasources.publish - -```py -datasources.publish(datasource_item, file_path, mode, connection_credentials=None) -``` - -Publishes a data source to a server, or appends data to an existing data source. - -This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. - -REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). -`file_path` | The path and name of the data source to publish. -`mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). - - - -**Exceptions** - -Error | Description -:--- | :--- -`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. - - -**Returns** - -The `DatasourceItem` for the data source that was added or appended to. - - -**Example** - -```py - - import tableauserverclient as TSC - server = TSC.Server('https://SERVERURL') - - ... - - project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' - file_path = r'C:\temp\WorldIndicators.tde' - - - # Use the project id to create new datsource_item - new_datasource = TSC.DatasourceItem(project_id) - - # publish data source (specified in file_path) - new_datasource = server.datasources.publish( - new_datasource, file_path, 'CreateNew') - - ... -``` - -
      -
      - -#### datasources.refresh - -```py -datasource.refresh(datasource_item) -``` - -Refreshes the data of the specified extract. - -REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. - - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. - - -**Returns** - -A refreshed `DatasourceItem`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://SERVERURL') -# sign in ... - -# get the data source item to update - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - -# call the refresh method with the data source item - refreshed_datasource = server.datasources.refresh(datasource) - -``` -
      -
      - -#### datasources.update - -```py -datasource.update(datasource_item) -``` - -Updates the owner or project of the specified data source. Data source name cannot be updated. - -REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. - - - -**Exceptions** - -Error | Description - :--- | : --- -`Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. - - -**Returns** - -An updated `DatasourceItem`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://SERVERURL') -# sign in ... - -# get the data source item to update - datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - -# do some updating - datasource.owner_id = 'New Owner ID' - -# call the update method with the data source item - updated_datasource = server.datasources.update(datasource) - - - -``` -
      -
      - -#### datasource.update_connection - -```py -datasource.update_connection(datasource_item, connection_item) -``` - -Updates the server address, port, username, or password for the specified data source connection. - -REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} - - -**Parameters** - -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. -`connection_item` | The `connection_item` that has the information you want to update. - - -**Returns** - -An updated `ConnectionItem` for the data source. - -**Example** - -See the `update_connection.py` sample in the Samples directory. - - -
      -
      - -## Filters - -The TSC library provides a `Filter` class that you can use to filter results returned from the server. - -You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: - -- Users -- Datasources -- Workbooks -- Views - -For more information, see [Filter and Sort](filter-sort). - - -### Filter class - -```py -Filter(field, operator, value) -``` - -The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. - - - -**Attributes** - -Name | Description -:--- | :--- -`Field` | Defined in the `RequestOptions.Field` class. -`Operator` | Defined in the `RequestOptions.Operator` class -`Value` | The value to compare with the specified field and operator. - - - - - -
      -
      - ---- - -## Groups - -Using the TSC library, you can get information about all the groups on a site, you can add or remove groups, or add or remove users in a group. - -The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. - -
      -
      - -### GroupItem class - -```py -GroupItem(name) -``` - -The `GroupItem` class contains the attributes for the group resources on Tableau Server. The `GroupItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -Source file: models/group_item.py - -**Attributes** - -Name | Description -:--- | :--- -`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). -`id` | The id of the group. -`users` | The list of users (`UserItem`). -`name` | The name of the group. The `name` is required when you create an instance of a group. - - - -**Example** - -```py - newgroup = TSC.GroupItem('My Group') - - # call groups.create() with new group -``` - - - - -
      -
      - -### Groups methods - -The Tableau Server Client provides several methods for interacting with group resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - - - -Source file: server/endpoint/groups_endpoint.py - -
      -
      - -#### groups.add_user - -```py -groups.add_user(group_item, user_id): -``` - -Adds a user to the specified group. - - -REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to update. -`user_id` | The id of the user. - - - - -**Returns** - -None. - - -**Example** - -```py -# Adding a user to a group -# -# get the group item - all_groups, pagination_item = server.groups.get() - mygroup = all_groups[1] - -# The id for Ian is '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba' - -# add Ian to the group - server.groups.add_user(mygroup, '59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba') - - - -``` - -
      -
      - -#### groups.create - -```py -create(group_item) -``` - -Creates a new group in Tableau Server. - - -REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. - - - - -**Returns** -Adds new `GroupItem`. - - -**Example** - -```py - -# Create a new group - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - -# create a new instance with the group name - newgroup = TSC.GroupItem('My Group') - -# call the create method - newgroup = server.groups.create(newgroup) - -# print the names of the groups on the server - all_groups, pagination_item = server.groups.get() - for group in all_groups : - print(group.name, group.id) -``` - -
      -
      - -#### groups.delete - -```py -groups.delete(group_id) -``` - -Deletes the group on the site. - -REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`group_id` | The identifier (`id`) for the group that you want to remove from the server. - - -**Exceptions** - -Error | Description -:--- | :--- -`Group ID undefined` | Raises an exception if a valid `group_id` is not provided. - - -**Example** - -```py -# Delete a group from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') - -``` -
      -
      - -#### groups.get - -```py -groups.get(req_options=None) -``` - -Returns information about the groups on the site. - - -To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. - - -REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. - - -**Returns** - -Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -**Example** - - -```py -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the groups on the server - all_groups, pagination_item = server.groups.get() - - # print the names of the first 100 groups - for group in all_groups : - print(group.name, group.id) -``` - - -
      -
      - -#### groups.populate_users - -```py -groups.populate_users(group_item, req_options=None) -``` - -Populates the `group_item` with the list of users. - - -REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to populate with user information. -`req_options` | (Optional) Additional request options to send to the endpoint. - - - -**Exceptions** - -`Group item missing ID. Group must be retrieved from server first.` : Raises an error if the `group_item` is unspecified. - - -**Returns** - -None. A list of `UserItem` objects are added to the group (`group_item.users`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the group - all_groups, pagination_item = server.groups.get() - mygroup = all_groups[1] - -# get the user information - pagination_item = server.groups.populate_users(mygroup) - - -# print the names of the users - for user in mygroup.users : - print(user.name) - - - - -``` - -
      -
      - -#### groups.remove_user - -```py -groups.remove_user(group_item, user_id) -``` - -Removes a user from a group. - - - - -REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`group_item` | The `group_item` specifies the group to remove the user from. -`user_id` | The id for the user. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. - - -**Returns** - -None. The user is removed from the group. - - -**Example** - -```py -# Remove a user from the group - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the group - mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') - - # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' - server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` - -
      -
      - ---- - -## Jobs - -Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. - -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. - -The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -### JobItem class - -```py -JobItem(id, type, created_at, started_at=None, completed_at=None, finish_code=0) - -``` - -The `JobItem` class contains information about the specified job running on Tableau Server. The `JobItem` class defines the information you can query from Tableau Server. The class members correspond to the attributes of a server response payload. - -Source file: models/job_item.py - -**Attributes** - -Name | Description -:--- | :--- -`id` | The `id` of the job. -`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. -`created_at` | The time the job was created. -`started_at` | The time the job started. -`completed_at` | The time the job finished. -`finish_code` | The return code from job. - - -### Jobs methods - - -The Jobs methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -Source files: server/endpoint/jobs_endpoint.py - -
      -
      - - -#### jobs.get - - -```py -jobs.get(job_id) - -``` - -Gets information about the specified job. - -REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory - - - - -**Exceptions** - -Error | Description -:--- | :--- -`404018 Resource Not Found` | Raises an error if the `job_id` is not found. - - -**Returns** - -Returns the `JobItem` requested. - - -**Example** - -```py -# Query a Job - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # get the id of the job from response to extract refresh task, - # or another asynchronous REST API call. - # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" - - - myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' - jobinfo = server.jobs.get(myJobID) - - print(jobinfo) - - # - - - - -``` - - -
      -
      - ---- - -## Projects - -Using the TSC library, you can get information about all the projects on a site, or you can create, update projects, or remove projects. - -The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. - - - - - -
      - -### ProjectItem class - -```py - -ProjectItem(name, description=None, content_permissions=None, parent_id=None) - -``` -The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. - -**Attributes** - -Name | Description -:--- | :--- -`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. -`name` | Name of the project. -`description` | The description of the project. -`id` | The project id. -`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. - - - -Source file: models/project_item.py - - -#### ProjectItem.ContentPermissions - -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. - -Name | Description -:--- | :--- -`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. -`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc - - -locked_true = TSC.ProjectItem.ContentPermissions.LockedToProject -print(locked_true) -# prints 'LockedToProject' - -by_owner = TSC.ProjectItem.ContentPermissions.ManagedByOwner -print(by_owner) -# prints 'ManagedByOwner' - - -# pass the content_permissions to new instance of the project item. -new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') - -``` - -
      -
      - -### Project methods - -The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. - - -Source files: server/endpoint/projects_endpoint.py - -
      -
      - - -#### projects.create - -```py -projects.create(project_item) -``` - - -Creates a project on the specified site. - -To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. - - -**Returns** -Returns the new project item. - - - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('https://SERVER') - -with server.auth.sign_in(tableau_auth): - # create project item - new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') - # create the project - new_project = server.projects.create(new_project) - -``` - -
      -
      - - -#### projects.get - -```py -projects.get() - -``` - -Return a list of project items for a site. - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - -REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} - - -**Parameters** - -None. - -**Returns** - -Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - - - **Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('https://SERVER') - -with server.auth.sign_in(tableau_auth): - # get all projects on site - all_project_items, pagination_item = server.projects.get() - print([proj.name for proj in all_project_items]) - -``` - -
      -
      - - -#### projects.update - -```py -projects.update(project_item) -``` - -Modify the project settings. - -You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - -REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. - - -**Exceptions** - -Error | Description - :--- | : --- -`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Returns** - -Returns the updated project information. - -See [ProjectItem class](#projectitem-class) - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc - - ... - # get list of projects - all_project_items, pagination_item = server.projects.get() - - - # update project item #7 with new name, etc. - my_project = all_projects[7] - my_project.name ='New name' - my_project.description = 'New description' - - # call method to update project - updated_project = server.projects.update(my_project) - - - - -``` -
      -
      - - -#### projects.delete - -```py -projects.delete(project_id) -``` - -Deletes a project by ID. - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`project_id` | The ID of the project to delete. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') - -``` - - -
      -
      - ---- - -## Requests - -The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. - -You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: - -- Users -- Datasources -- Groups -- Workbooks -- Views - - -You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. - -For more information about filtering and sorting, see [Filter and Sort](filter-sort). - - -
      - - - -### RequestOptions class - -```py -RequestOptions(pagenumber=1, pagesize=100) - -``` - - - -**Attributes** - -Name | Description -:--- | :--- -`pagenumber` | The page number of the returned results. The default value is 1. -`pagesize` | The number of items to return with each page (the default value is 100). -`sort()` | Returns a iterable set of `Sort` objects. -`filter()` | Returns an iterable set of `Filter` objects. - -
      -
      - - - -#### RequestOptions.Field class - -The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. - -**Attributes** - -**Attributes** - -Field | Description -:--- | :--- -`CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` -`LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` -`Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` -`OwnerName` | Same as 'ownerName' in the REST API. `RequestOptions.Field.OwnerName` -`SiteRole` | Same as 'siteRole' in the REST API. `RequestOptions.Field.SiteRole` -`Tags` | Same as 'tags' in the REST API. `RequestOptions.Field.Tags` -`UpdatedAt` | Same as 'updatedAt' in the REST API. `RequestOptions.Field.UpdatedAt` - - -
      -
      - - - -#### RequestOptions.Operator class - -Specifies the operators you can use to filter requests. - - -**Attributes** - -Operator | Description -:--- | :--- -`Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` -`GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` -`GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` -`LessThan` | Sets the operator to less than (same as `lt` in the REST API). `TSC.RequestOptions.Operator.LessThan` -`LessThanOrEqual` | Sets the operator to less than or equal (same as `lte` in the REST API). `TSC.RequestOptions.Operator.LessThanOrEqual` -`In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In` - -
      -
      - - - -#### RequestOptions.Direction class - -Specifies the direction to sort the returned fields. - - -**Attributes** - -Name | Description -:--- | :--- -`Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) -`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). - -
      -
      - -### CSVRequestOptions class - -```py -CSVRequestOptions(maxage=-1) -``` -Use this class to specify view filters to be applied when the CSV data is generated. Optionally, you can specify the maximum age of the CSV data cached on the server by providing a `maxage` value. See `views.populate_csv`. - -**Attributes** - -Name | Description -:--- | :--- -`maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set view filters -csv_req_option = TSC.CSVRequestOptions(maxage=5) -csv_req_option.vf('Region', 'South') -csv_req_option.vf('Category', 'Furniture') - -# retrieve the csv data for the view -server.views.populate_csv(view_item, csv_req_option) -``` - -### ImageRequestOptions class - -```py -ImageRequestOptions(imageresolution=None, maxage=-1) -``` -Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. - -**Attributes** - -Name | Description -:--- | :--- -`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. -`maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**View Filters** - -You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the image is generated, the specified filters will be applied to the view. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set the image request option -image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) - -# (optional) set a view filter -image_req_option.vf('Category', 'Furniture') - -# retrieve the image for the view -server.views.populate_image(view_item, image_req_option) - -``` - -### PDFRequestOptions class - -```py -PDFRequestOptions(page_type=None, orientation=None, maxage=-1) -``` -Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. - -**Attributes** - -Name | Description -:--- | :--- -`page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` -`orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` -`maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. - -**View Filters** -You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. - -# set the PDF request options -pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, - orientation=TSC.PDFRequestOptions.Orientation.Landscape, - maxage=1) - -# (optional) set a view filter -pdf_req_option.vf('Region', 'West') - -# retrieve the PDF for a view -server.views.populate_pdf(view_item, pdf_req_option) - -``` - - -
      -
      - ---- - -## Schedules - -Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. - -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. - -The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. - - -### ScheduleItem class - -```py -ScheduleItem(name, priority, schedule_type, execution_order, interval_item) - -``` - -The `ScheduleItem` class contains information about the specified schedule running on Tableau Server. The `ScheduleItem` class defines the information you can query and set. The class members correspond to the attributes of a server response payload. - -Source file: models/schedule_item.py - -**Attributes** - -Name | Description -:--- | :--- -`name` | The `name` of the schedule. -`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. -`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. -`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. -`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. - - -#### IntervalItem class -This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. - -**Attributes** - -Name | Description -:--- | :--- -`HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. -`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. -`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. -`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The - - - - -### Schedule methods - -The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. - - -Source files: server/endpoint/schedules_endpoint.py - -#### schedule.create - -```py -schedule.create(schedule_item) -``` -Creates a new schedule for an extract refresh or a subscription. - - -REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} - - - -**Parameters** - -Name | Description -:--- | :--- -`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. - - -**Returns** - -Returns a new instance of `schedule_item`. - -**Exceptions** - -Error | Description -:--- | :--- -`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. - - -**Example** - -```py -import tableauserverclient as TSC -# sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) -``` -
      -
      - - -#### schedule.delete - -```py -schedule.delete(schedule_id) -``` - -Deletes an existing schedule for an extract refresh or a subscription. - - -REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} - - - -**Parameters** - -Name | Description -:--- | :--- -`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. - - -**Returns** - -None. - -**Exceptions** - -Error | Description -:--- | :--- -`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. - - -#### schedule.get - -```py -schedule.get([req_options=None]) -``` - -Returns all schedule items from the server. - - -REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} - - - -**Parameters** - -Name | Description -:--- | :--- -`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . - -#### schedule.update - -
      -
      - - -**Hourly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) -``` - -**Daily schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a daily interval to run every day at 12:30AM - Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) - # Create schedule item using daily interval - daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) - # Create daily schedule - daily_schedule = server.schedules.create(daily_schedule) - -``` - -**Weekly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM - weekly_interval = TSC.WeeklyInterval(time(19, 15), - TSC.IntervalItem.Day.Monday, - TSC.IntervalItem.Day.Wednesday, - TSC.IntervalItem.Day.Friday) - # Create schedule item using weekly interval - weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, - TSC.ScheduleItem.Type.Extract, - TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) - # Create weekly schedule - weekly_schedule = server.schedules.create(weekly_schedule) - -``` - -**Monthly schedule example** -```py -import tableauserverclient as TSC -# sign in, etc. - # Create a monthly interval to run on the 15th of every month at 11:30PM - monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), - interval_value=15) - # Create schedule item using monthly interval - monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, - TSC.ScheduleItem.Type.Subscription - TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) - # Create monthly schedule - monthly_schedule = server.schedules.create(monthly_schedule) -``` - - - -
      -
      - ---- - - -## Server - -In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) -The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. - - -
      -
      - - -### Server class - -```py -Server(server_address) -``` -The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. - -**Attributes** - -Attribute | Description -:--- | :--- -`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). -`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} - - - -**Example** - -```py -import tableauserverclient as TSC - - -# create a instance of server -server = TSC.Server('https://MY-SERVER') - -# sign in, etc. - -# change the REST API version to match the server -server.use_server_version() - -# or change the REST API version to match a specific version -# for example, 2.8 -# server.version = '2.8' - -``` - -#### Server.*Resources* - -When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` - - - -Resource | Description - :--- | : --- -*server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | -*server*.views | Access the server views and methods. See [Views](#views) -*server*.users | Access the user resources and methods. See [Users](#users) -*server*.sites | Access the sites. See [Sites](#sites) -*server*.groups | Access the groups resources and methods. See [Groups](#groups) -*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) -*server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) -*server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) -*server*.projects | Access the resources and methods for projects. See [Projects](#projects) -*server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) -*server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) -*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class) - -
      -
      - -#### Server.PublishMode - -The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. - - -**Properties** - -Resource | Description - :--- | : --- -`PublishMode.Overwrite` | Overwrites the workbook or data source. -`PublishMode.Append` | Appends to the workbook or data source. -`PublishMode.CreateNew` | Creates a new workbook or data source. - - -**Example** - -```py - import tableauserverclient as TSC - # login, etc. - - print(TSC.Server.PublishMode.Overwrite) - # prints 'Overwrite' - - overwrite_true = TSC.Server.PublishMode.Overwrite - - ... - - # pass the PublishMode to the publish workbooks method - new_workbook = server.workbooks.publish(new_workbook, args.filepath, overwrite_true) - - -``` - - -
      -
      - - -### ServerInfoItem class - -```py -ServerInfoItem(product_version, build_number, rest_api_version) -``` -The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. - -**Attributes** - -Name | Description -:--- | :--- -`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). -`build_number` | Shows the specific build number (for example, 10200.17.0329.1446). -`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. - - -
      -
      - - -### ServerInfo methods - -The TSC library provides a method to access the build and version information from Tableau Server. - -
      - -#### server_info.get - -```py -server_info.get() - -``` -Retrieve the build and version information for the server. - -This method makes an unauthenticated call, so no sign in or authentication token is required. - -REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} - -**Parameters** - None - -**Exceptions** - -Error | Description -:--- | :--- -`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. - -**Example** - -```py -import tableauserverclient as TSC - -# create a instance of server -server = TSC.Server('https://MY-SERVER') - -# set the version number > 2.3 -# the server_info.get() method works in 2.4 and later -server.version = '2.5' - -s_info = server.server_info.get() -print("\nServer info:") -print("\tProduct version: {0}".format(s_info.product_version)) -print("\tREST API version: {0}".format(s_info.rest_api_version)) -print("\tBuild number: {0}".format(s_info.build_number)) - -``` - - -
      -
      - ---- - -## Sites - -Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. - -The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. - -
      -
      - -### SiteItem class - -```py -SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None, - disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) -``` - -The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. - -**Attributes** - -Attribute | Description -:--- | :--- -`name` | The name of the site. The name of the default site is "". -`content_url` | The path to the site. -`admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) -`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. -`storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. -`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. -`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. -`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. -`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. -`state` | Shows the current state of the site (`Active` or `Suspended`). - - -**Example** - -```py - -# create a new instance of a SiteItem - -new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='ContentAndUsers', user_quota=15, storage_quota=1000, disable_subscriptions=True) - -``` - -Source file: models/site_item.py - -
      -
      - - -### Site methods - -The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. - - -Source file: server/endpoint/sites_endpoint.py - -
      -
      - -#### sites.create - -```py -sites.create(site_item) -``` - -Creates a new site on the server for the specified site item object. - -Tableau Server only. - - -REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} - - - -**Parameters** - -Name | Description -:--- | :--- -`site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. - - -**Returns** - -Returns a new instance of `SiteItem`. - - -**Example** - -```py -import tableauserverclient as TSC - -# create an instance of server -server = TSC.Server('https://MY-SERVER') - -# create shortcut for admin mode -content_users=TSC.SiteItem.AdminMode.ContentAndUsers - -# create a new SiteItem -new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True) - -# call the sites create method with the SiteItem -new_site = server.sites.create(new_site) -``` -
      -
      - -#### sites.get - -```py -sites.get() -``` - -Queries all the sites on the server. - - -REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} - - -**Parameters** - - None. - -**Returns** - -Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - # query the sites - all_sites, pagination_item = server.sites.get() - - # print all the site names and ids - for site in all_sites: - print(site.id, site.name, site.content_url, site.state) - - -``` - -
      -
      - - - -#### sites.get_by_id - -```py -sites.get_by_id(site_id) -``` - -Queries the site with the given ID. - - -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`site_id` | The id for the site you want to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`Site ID undefined.` | Raises an error if an id is not specified. - - -**Returns** - -Returns the `SiteItem`. - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') - print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) - -``` - -
      -
      - -#### sites.get_by_name - -```py -sites.get_by_name(site_name) -``` - -Queries the site with the specified name. - - -REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`site_name` | The name of the site you want to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`Site Name undefined.` | Raises an error if an name is not specified. - - -**Returns** - -Returns the `SiteItem`. - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - - a_site = server.sites.get_by_name('MY_SITE') - - -``` - -
      -
      - - - -#### sites.update - -```py -sites.update(site_item) -``` - -Modifies the settings for site. - - -The site item object must include the site ID and overrides all other settings. - - -REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. - - -**Exceptions** - -Error | Description -:--- | :--- -`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. -`You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` - - -**Returns** - -Returns the updated `site_item`. - - -**Example** - -```py -... - -# make some updates to an existing site_item -site_item.name ="New name" - -# call update -site_item = server.sites.update(site_item) - -... -``` - -
      -
      - - - - -#### sites.delete - - -```py -Sites.delete(site_id) -``` - -Deletes the specified site. - - -REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} - - -**Parameters** - -Name | Description - :--- | : --- -`site_id` | The id of the site that you want to delete. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. - - - -**Example** - -```py - -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. - -server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') - -``` - -
      -
      - ---- - - -## Sort - -The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. - -You can use the sort and request options to filter and sort the following endpoints: - -- Users -- Datasources -- Workbooks -- Views - -### Sort class - -```py -sort(field, direction) -``` - - - -**Attributes** - -Name | Description -:--- | :--- -`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. -`direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. - -**Example** - -```py - -# create a new instance of a request option object -req_option = TSC.RequestOptions() - -# add the sort expression, sorting by name and direction -req_option.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, - TSC.RequestOptions.Direction.Asc)) -matching_workbooks, pagination_item = server.workbooks.get(req_option) - -for wb in matching_workbooks: - print(wb.name) -``` - -For information about using the `Sort` class, see [Filter and Sort](filter-sort). - -
      -
      - ---- - -## Subscriptions - -Using the TSC library, you can manage subscriptions to views or workbooks on a site. You can get information about all the subscriptions on a site, or information about a specific subscription on a site, and you can create, update, or delete subscriptions. - -### SubscriptionItem class - -The subscription resources for Tableau Server are defined in the `SubscriptionItem` class. The class corresponds to the subscription resources you can access using the Tableau Server REST API. The subscription methods are based upon the endpoints for subscriptions in the REST API and operate on the `SubscriptionItem` class. - -```py -SubscriptionItem(subject, schedule_id, user_id, target) - -``` - -**Attributes** - -Name | Description -:--- | :--- -`id` | The id of the subscription on the site. -`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. -`schedule_id` | The identifier associated with the specific subscription. -`user_id` | The identifier of the user (person) who receives the subscription. -`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. - - - - -Source files: server/endpoints/subscription_item.py - - -### Subscription methods - -The Tableau Server Client provides several methods for interacting with subscription resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - - - -Source files: server/endpoints/subscriptions_endpoint.py - -
      -
      - -#### subscription.create - -```py -subscription.create(subscription_item) -``` -Creates a subscription to a view or workbook for a specific user. -When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. - -To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). - - -REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. - - -**Returns** - -Returns the new `SubscriptionItem` object. - - - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') -# create auth, specify site -# login, etc. - - -# create the target (content) of the subscription -# in this case, id of the workbook add the target type "workbook" - - target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') - -# the ids for the schedule and user - schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') - user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' - -# create a new SubscriptionItem object. - newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) - -# create the new subscription to the site - newSub = server.subscriptions.create(newSub) - print(newUSub.subject) - -``` - - -
      -
      - - - -#### subscriptions.delete - -```py -subscriptions.delete(subscription_id) -``` - - - -Deletes the specified subscription from the site. - -REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} - - -**Parameters** - -Name | Description - :--- | : --- -`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. - - -**Exceptions** - -Error | Description - :--- | : --- -`Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. - - -**Example** - -```py -# Remove a subscription from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='SITE') -# server = TSC.Server('https://SERVERURL') - - - with server.auth.sign_in(tableau_auth): - server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` -
      -
      - -
      -
      - -#### subscription.get - -```py -subscription.get(req_options=None) -``` -Returns information about the subscriptions on the specified site. - - -REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. - - -**Returns** -Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -
      -
      - -#### subscription.get_by_id - - -```py -subscription.get_by_id(subscription_id) -``` - -Returns information about the specified subscription. - -REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} - - -**Parameters** - -Name | Description - :--- | : --- -`subscription_id` | The `subscription_id` specifies the subscription to query. - - - -**Exceptions** - -Error | Description - :--- | : --- -`No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. - - -**Returns** - -The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) - - -**Example** - -```py - sub1 = server.subscription.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - print(sub1.subject) - -``` - - - - - -
      -
      - ---- - -## Users - -Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. - -The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. - - -### UserItem class - -```py -UserItem(name, site_role, auth_setting=None) -``` - -The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -**Attributes** - -Name | Description -:--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. -`domain_name` | The name of the site. -`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. -`id` | The id of the user on the site. -`last_login` | The date and time the user last logged in. -`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. -`email` | The email address of the user. -`fullname` | The full name of the user. -`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') - -# create a new UserItem object. - newU = TSC.UserItem('Monty', 'Publisher') - - print(newU.name, newU.site_role) - -``` - -Source file: models/user_item.py - -
      -
      - - -### Users methods - -The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. - -Source file: server/endpoint/users_endpoint.py -
      -
      - -#### users.add - -```py -users.add(user_item) -``` - -Adds the user to the site. - -To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. - -REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. - - -**Returns** - -Returns the new `UserItem` object. - - - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('server') -# login, etc. - -# create a new UserItem object. - newU = TSC.UserItem('Heather', 'Publisher') - -# add the new user to the site - newU = server.users.add(newU) - print(newU.name, newU.site_role) - -``` - -#### users.get - -```py -users.get(req_options=None) -``` - -Returns information about the users on the specified site. - -To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. - - -REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. - - -**Returns** - -Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. - - -**Example** - - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -server = TSC.Server('https://SERVERURL') - -with server.auth.sign_in(tableau_auth): - all_users, pagination_item = server.users.get() - print("\nThere are {} user on site: ".format(pagination_item.total_available)) - print([user.name for user in all_users]) -``` - -
      -
      - -#### users.get_by_id - - -```py -users.get_by_id(user_id) -``` - -Returns information about the specified user. - -REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} - - -**Parameters** - -Name | Description - :--- | : --- -`user_id` | The `user_id` specifies the user to query. - - -**Exceptions** - -Error | Description - :--- | : --- -`User ID undefined.` | Raises an exception if a valid `user_id` is not provided. - - -**Returns** - -The `UserItem`. See [UserItem class](#useritem-class) - - -**Example** - -```py - user1 = server.users.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - print(user1.name) - -``` - -
      -
      - - -#### users.populate_favorites - -```py -users.populate_favorites(user_item) -``` - -Returns the list of favorites (views, workbooks, and data sources) for a user. - -*Not currently implemented* - -
      -
      - - -#### users.populate_workbooks - -```py -users.populate_workbooks(user_item, req_options=None): -``` - -Returns information about the workbooks that the specified user owns and has Read (view) permissions for. - - -This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). - -REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | The `user_item` specifies the user to populate with workbook information. - - - - -**Exceptions** - -Error | Description - :--- | : --- -`User item missing ID.` | Raises an error if the `user_item` is unspecified. - - -**Returns** - -A list of `WorkbookItem` - -A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) - - -**Example** - -```py -# first get all users, call server.users.get() -# get workbooks for user[0] - ... - - page_n = server.users.populate_workbooks(all_users[0]) - print("\nUser {0} owns or has READ permissions for {1} workbooks".format(all_users[0].name, page_n.total_available)) - print("\nThe workbooks are:") - for workbook in all_users[0].workbooks : - print(workbook.name) - - ... -``` - - - - -
      -
      - -#### users.remove - -```py -users.remove(user_id) -``` - - - -Removes the specified user from the site. - -REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} - - -**Parameters** - -Name | Description - :--- | : --- -`user_id` | The identifier (`id`) for the user that you want to remove from the server. - - -**Exceptions** - -Error | Description - :--- | : --- -`User ID undefined` | Raises an exception if a valid `user_id` is not provided. - - -**Example** - -```py -# Remove a user from the site - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - -``` -
      -
      - - - - -#### users.update - -```py -users.update(user_item, password=None) -``` - -Updates information about the specified user. - -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. - - - -REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} - -**Parameters** - -Name | Description - :--- | : --- -`user_item` | The `user_item` specifies the user to update. -`password` | (Optional) The new password for the user. - - - -**Exceptions** - -Error | Description - :--- | : --- -`User item missing ID.` | Raises an error if the `user_item` is unspecified. - - -**Returns** - -An updated `UserItem`. See [UserItem class](#useritem-class) - - -**Example** - -```py - -# import tableauserverclient as TSC -# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') -# server = TSC.Server('https://SERVERURL') - - with server.auth.sign_in(tableau_auth): - - # create a new user_item - user1 = TSC.UserItem('temp', 'Viewer') - - # add new user - user1 = server.users.add(user1) - print(user1.name, user1.site_role, user1.id) - - # modify user info - user1.name = 'Laura' - user1.fullname = 'Laura Rodriguez' - user1.email = 'laura@example.com' - - # update user - user1 = server.users.update(user1) - print("\Updated user info:") - print(user1.name, user1.fullname, user1.email, user1.id) - - -``` - - - -
      -
      - - ---- - -## Views - -Using the TSC library, you can get information about views in a site or a workbook. - -The view resources for Tableau Server are defined in the `ViewItem` class. The class corresponds to the view resources you can access using the Tableau Server REST API. The view methods are based upon the endpoints for views in the REST API and operate on the `ViewItem` class. - -
      - -### ViewItem class - -``` -ViewItem() -``` - -The `ViewItem` class contains the members or attributes for the view resources on Tableau Server. The `ViewItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. - -Source file: models/view_item.py - -**Attributes** - -Name | Description -:--- | :--- -`content_url` | The name of the view as it would appear in a URL. -`csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. -`id` | The identifier of the view item. -`image` | The image of the view. You must first call the `views.populate_image`method to access the image. -`name` | The name of the view. -`owner_id` | The ID for the owner of the view. -`pdf` | The PDF of the view. You must first call the `views.populate_pdf` method to access the PDF content. -`preview_image` | The thumbnail image for the view. You must first call the `views.populate_preview_image` method to access the preview image. -`project_id` | The ID of the project that contains the view. -`total_views` | The usage statistics for the view. Indicates the total number of times the view has been looked at. -`workbook_id` | The ID of the workbook associated with the view. - - -
      -
      - - -### Views methods - -The Tableau Server Client provides methods for interacting with view resources, or endpoints. These methods correspond to the endpoints for views in the Tableau Server REST API. - -Source file: server/endpoint/views_endpoint.py - -
      -
      - -#### views.get -``` -views.get(req_options=None, usage=False) -``` - -Returns the list of views items for a site. - - -REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 2.0 and up. - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. -`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. - - - -**Returns** - -Returns a list of all `ViewItem` objects and a `PaginationItem`. Use these values to iterate through the results. - -**Example** - -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - all_views, pagination_item = server.views.get() - print([view.name for view in all_views]) -``` - -**Example using Pager** - -You can also use the provided Pager generator to get all views on site, without having to page through the results. -```py -for view in TSC.Pager(server.views): - print(view.name) -``` - -See [ViewItem class](#viewitem-class) - - -
      -
      - -#### views.populate_preview_image - -```py - views.populate_preview_image(view_item) -``` - -Populates a preview image for the specified view. - -This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. - -REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 2.0 and up. - -**Parameters** - -Name | Description -:--- | :--- -`view_item` | Specifies the view to populate. - - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. - - -**Returns** - -None. The preview image is added to `view_item` and can be accessed by its `preview_image` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the preview image as 'view_preview_image.png' -server.views.populate_preview_image(view_item) -with open('./view_preview_image.png', 'wb') as f: - f.write(view_item.preview_image) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_image - -```py -views.populate_image(view_item, req_options=None) -``` - -Populates the image of the specified view. - -This method uses the `id` field to query the image, and populates the image content as the `image` field. - -REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 2.5 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The image is added to the `view_item` and can be accessed by its `image` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the view image as 'view_image.png' -server.views.populate_image(view_item) -with open('./view_image.png', 'wb') as f: - f.write(view_item.image) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_csv -``` -views.populate_csv(view_item) -``` - -Populates the CSV data of the specified view. - -This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. - -REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 2.7 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The CSV data is added to the `view_item` and can be accessed by its `csv` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the CSV data as 'view_csv.csv' -server.views.populate_csv(view_item) -with open('./view_csv.csv', 'wb') as f: - # Perform byte join on the CSV data - f.write(b''.join(view_item.csv)) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - -#### views.populate_pdf -``` -views.populate_pdf(view_item, req_options=None) -``` - -Populates the PDF content of the specified view. - -This method populates a PDF with image(s) of the view you specify. - -REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 2.7 and up. - -**Parameters** - -Name | description -:--- | :--- -`view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID` | Raises an error if the ID of the view is missing. - -**Returns** - -None. The PDF content is added to the `view_item` and can be accessed by its `pdf` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the view pdf as 'view_pdf.pdf' -server.views.populate_pdf(view_item) -with open('./view_pdf.pdf', 'wb') as f: - f.write(view_item.pdf) -``` - -See [ViewItem class](#viewitem-class) - -
      -
      - - ---- - - -## Workbooks - -Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. - -The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. - - - - - -
      -
      - -### WorkbookItem class - -```py - - WorkbookItem(project_id, name=None, show_tabs=False) - -``` -The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project - - -**Attributes** - -Name | Description -:--- | :--- -`connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. -`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. -`name` | The name of the workbook. -`owner_id` | The ID of the owner. -`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. -`project_id` | The project id. -`project_name` | The name of the project. -`size` | The size of the workbook (in megabytes). -`show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. -`tags` | The tags that have been added to the workbook. -`updated_at` | The date and time when the workbook was last updated. -`views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). - - - - - -**Example** - -```py -# creating a new instance of a WorkbookItem -# -import tableauserverclient as TSC - -# Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' - - new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') - - -```` - -Source file: models/workbook_item.py - -
      -
      - -### Workbook methods - -The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. -The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. - - - -Source files: server/endpoint/workbooks_endpoint.py - -
      -
      - -#### workbooks.get - -```py -workbooks.get(req_options=None) -``` - -Queries the server and returns information about the workbooks the site. - - - - - -REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) - - -**Returns** - -Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - -**Example** - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - all_workbooks_items, pagination_item = server.workbooks.get() - # print names of first 100 workbooks - print([workbook.name for workbook in all_workbooks_items]) - - - -``` - -
      -
      - - - -#### workbooks.get_by_id - -```py -workbooks.get_by_id(workbook_id) -``` - -Returns information about the specified workbook on the site. - -REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). - - -**Exceptions** - -Error | Description - :--- | : --- -`Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. - - -**Returns** - -The `WorkbookItem`. See [WorkbookItem class](#workbookitem-class) - - -**Example** - -```py - -workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') -print(workbook.name) - -``` - - -
      -
      - - -#### workbooks.publish - -```py -workbooks.publish(workbook_item, file_path, publish_mode) -``` - -Publish a workbook to the specified site. - -**Note:** The REST API cannot automatically include -extracts or other resources that the workbook uses. Therefore, - a .twb file that uses data from an Excel or csv file on a local computer cannot be published, -unless you package the data and workbook in a .twbx file, or publish the data source separately. - -For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. - -REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} - - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). -`file_path` | The path and name of the workbook to publish. -`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). - - - -**Exceptions** - -Error | Description -:--- | :--- -`File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. -`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. - -See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. - -**Returns** - -The `WorkbookItem` for the workbook that was published. - - -**Example** - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - # create a workbook item - wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') - # call the publish method with the workbook item - wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') -``` - -
      -
      - -#### workbooks.refresh - -```py -workbooks.refresh(workbook_item) -``` - - -Refreshes the extract of an existing workbook. - -REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. - - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - - # get the workbook item from the site - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - # call the update method - workbook = server.workbooks.refresh(workbook) - print("\nThe data of workbook {0} is refreshed.".format(workbook.name)) - - -``` - - -
      -
      - -#### workbooks.update - -```py -workbooks.update(workbook_item) -``` - - -Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. - -REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. - - -```py - -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') -server = TSC.Server('https://servername') - -with server.auth.sign_in(tableau_auth): - - # get the workbook item from the site - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - print("\nUpdate {0} workbook. Project was {1}".format(workbook.name, workbook.project_name)) - - - # make an change, for example a new project ID - workbook.project_id = '1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e' - - # call the update method - workbook = server.workbooks.update(workbook) - print("\nUpdated {0} workbook. Project is now {1}".format(workbook.name, workbook.project_name)) - - -``` - - -
      -
      - - - -#### workbooks.delete - -```py -workbooks.delete(workbook_id) -``` - -Deletes a workbook with the specified ID. - - - -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - -REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The ID of the workbook to delete. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. - - -**Example** - -```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# tableau_auth sign in, etc. - - server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - -``` - - -
      -
      - - -#### workbooks.download - -```py -workbooks.download(workbook_id, filepath=None, no_extract=False) -``` - -Downloads a workbook to the specified directory (optional). - - -REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} - - -**Parameters** - -Name | Description -:--- | :--- -`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. -`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. -`no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - -**Returns** - -The file path to the downloaded workbook. - - -**Example** - -```py - - file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - print("\nDownloaded the file to {0}.".format(file_path)) - -```` - - -
      -
      - - -#### workbooks.populate_views - -```py -workbooks.populate_views(workbook_item) -``` - -Populates (or gets) a list of views for a workbook. - -You must first call this method to populate views before you can iterate through the views. - -This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. - -REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. - - -**Returns** - -None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - -# get the view information - server.workbooks.populate_views(workbook) - -# print information about the views for the work item - print("\nThe views for {0}: ".format(workbook.name)) - print([view.name for view in workbook.views]) - - ... - -``` - -
      -
      - -#### workbooks.populate_connections - -```py -workbooks.populate_connections(workbook_item) -``` - -Populates a list of data source connections for the specified workbook. - -You must populate connections before you can iterate through the -connections. - -This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. - -REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. - - - - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. - - -**Returns** - -None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). - - -**Example** - -```py -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') -# - ... - -# get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - -# get the connection information - server.workbooks.populate_connections(workbook) - -# print information about the data connections for the workbook item - print("\nThe connections for {0}: ".format(workbook.name)) - print([connection.id for connection in workbook.connections]) - - - ... - -``` - -
      -
      - - -#### workbooks.populate_preview_image - -```py -workbooks.populate_preview_image(workbook_item) -``` - -This method gets the preview image (thumbnail) for the specified workbook item. - -The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. - -REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. - - - -**Exceptions** - -Error | Description -:--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. - - - -**Returns** - -None. The preview image is added to the view. - - - -**Example** - -```py - -# import tableauserverclient as TSC - -# server = TSC.Server('https://SERVERURL') - - ... - - # get the workbook item - workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') - - # add the png thumbnail to the workbook item - server.workbooks.populate_preview_image(workbook) - - -``` - -
      -
      - -#### workbooks.update_connection - -```py -workbooks.update_conn(workbook_item, connection_item) -``` - -Updates a workbook connection information (server address, server port, user name, and password). - -The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) - -REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} - -**Parameters** - -Name | Description -:--- | :--- -`workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. -`connection_item` | The `connection_item` that has the information you want to update. - - - -**Returns** - -None. The connection information is updated with the information in the `ConnectionItem`. - - - - -**Example** - -```py - -# query for workbook connections -server.workbooks.populate_connections(workbook) - -# update connection item user name and password -connection = workbook.connections[0] -connection.username = 'USERNAME' -connection.password = 'PASSWORD' - -# call the update method -server.workbooks.update_conn(workbook, connection) -``` - -
      -
      - -#### workbooks.populate_pdf -``` -workbooks.populate_pdf(workbook_item, req_options=None) -``` - -Populates the PDF content of the specified workbook. - -This method populates a PDF with image(s) of the workbook view(s) you specify. - -REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} - -**Version** - -This endpoint is available with REST API version 3.4 and up. - -**Parameters** - -Name | description -:--- | :--- -`workbook_item` | Specifies the workbook to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. - -**Exceptions** - -Error | Description -:--- | :--- -`Workbook item missing ID` | Raises an error if the ID of the workbook is missing. - -**Returns** - -None. The PDF content is added to the `workbook_item` and can be accessed by its `pdf` field. - -**Example** -```py -# Sign in, get view, etc. - -# Populate and save the workbook pdf as 'workbook_pdf.pdf' -server.workbooks.populate_pdf(workbook_item) -with open('./workbook_pdf.pdf', 'wb') as f: - f.write(workbook_item.pdf) -``` - -
      -
      - - diff --git a/docs/api-ref.md.rej b/docs/api-ref.md.rej deleted file mode 100644 index aeaaa3457..000000000 --- a/docs/api-ref.md.rej +++ /dev/null @@ -1,68 +0,0 @@ -*************** -*** 15,21 **** - The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. - - |:--- | -- | **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| - - - ---- 15,21 ---- - The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. - - |:--- | -+ | **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| - - - -*************** -*** 1122,1128 **** - Name | Description - :--- | :--- - `id` | The `id` of the job. -- `type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. - `created_at` | The time the job was created. - `started_at` | The time the job started. - `completed_at` | The time the job finished. ---- 1122,1128 ---- - Name | Description - :--- | :--- - `id` | The `id` of the job. -+ `type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. - `created_at` | The time the job was created. - `started_at` | The time the job started. - `completed_at` | The time the job finished. -*************** -*** 1948,1954 **** - Attribute | Description - :--- | :--- - `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). -- `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} - - - ---- 1948,1954 ---- - Attribute | Description - :--- | :--- - `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). -+ `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) - - - -*************** -*** 2070,2076 **** - - This method makes an unauthenticated call, so no sign in or authentication token is required. - -- REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} - - **Parameters** - None ---- 2070,2076 ---- - - This method makes an unauthenticated call, so no sign in or authentication token is required. - -+ REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) - - **Parameters** - None diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 55a64a711..d3f402a77 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -76,7 +76,7 @@ This section will get you started with the basic workflow, describing how to cre While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able. -1. That's it! When the PR has received approval from members of the core team they will merge the PR +1. That's it! When the PR has received ![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR. --- diff --git a/docs/patch b/docs/patch deleted file mode 100644 index fe5d1e7a5..000000000 --- a/docs/patch +++ /dev/null @@ -1,612 +0,0 @@ -diff --git a/docs/api-ref.md b/docs/api-ref.md -index 51e4b4e..2cb41e0 100644 ---- a/docs/api-ref.md -+++ b/docs/api-ref.md -@@ -15,7 +15,7 @@ The Tableau Server Client (TSC) is a Python library for the Tableau Server REST - The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. - - |:--- | --| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#API_Reference0){:target="_blank"}.| -+| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| - - - -@@ -90,7 +90,7 @@ Signs you in to Tableau Server. - - The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). - --REST API: [Sign In](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in){:target="_blank"} -+REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) - - **Parameters** - -@@ -131,7 +131,7 @@ Signs you out of the current session. - - The `sign_out()` method takes care of invalidating the authentication token. For more information, see [Sign in and Out](sign-in-out). - --REST API: [Sign Out](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#ign_out){:target="_blank"} -+REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_out) - - **Example** - -@@ -210,7 +210,7 @@ Attribute | Description - `password` | The password used for the connection. - `server_address` | The server address for the connection. - `server_port` | The port used by the server. --`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://onlinehelp.tableau.com/current/server/en-us/protected_auth.htm?Highlight=oauth%20connections){:target="_blank"}. -+`ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). - - - Source file: models/connection_credentials.py -@@ -302,7 +302,7 @@ Error | Description - `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. - - --REST API: [Delete Datasource](https://onlinehelp.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source){:target="_blank"} -+REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source) - -
      -
      -@@ -316,7 +316,7 @@ datasources.download(datasource_id, filepath=None, include_extract=True, no_extr - ``` - Downloads the specified data source in `.tdsx` or `.hyper` format. - --REST API: [Download Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source){:target="_blank"} -+REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_data_source) - - **Parameters** - -@@ -361,7 +361,7 @@ Returns all the data sources for the site. - - To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) - --REST API: [Query Datasources](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources){:target="_blank"} -+REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_sources) - - **Parameters** - -@@ -404,7 +404,7 @@ datasources.get_by_id(datasource_id) - - Returns the specified data source item. - --REST API: [Query Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source){:target="_blank"} -+REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) - - - **Parameters** -@@ -451,7 +451,7 @@ Populates the connections for the specified data source. - - This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. - --REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} -+REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) - - **Parameters** - -@@ -513,7 +513,7 @@ Publishes a data source to a server, or appends data to an existing data source. - - This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. - --REST API: [Publish Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source){:target="_blank"} -+REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) - - **Parameters** - -@@ -574,7 +574,7 @@ datasource.refresh(datasource_item) - - Refreshes the data of the specified extract. - --REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now){:target="_blank"} -+REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) - - **Parameters** - -@@ -621,7 +621,7 @@ datasource.update(datasource_item) - - Updates the owner or project of the specified data source. Data source name cannot be updated. - --REST API: [Update Datasource](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source){:target="_blank"} -+REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) - - **Parameters** - -@@ -673,7 +673,7 @@ datasource.update_connection(datasource_item, connection_item) - - Updates the server address, port, username, or password for the specified data source connection. - --REST API: [Update Datasource Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection){:target="_blank"} -+REST API: [Update Datasource Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source_connection) - - - **Parameters** -@@ -801,7 +801,7 @@ groups.add_user(group_item, user_id): - Adds a user to the specified group. - - --REST API [Add User to Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group){:target="_blank"} -+REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) - - **Parameters** - -@@ -848,7 +848,7 @@ create(group_item) - Creates a new group in Tableau Server. - - --REST API: [Create Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group){:target="_blank"} -+REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) - - - **Parameters** -@@ -898,7 +898,7 @@ groups.delete(group_id) - - Deletes the group on the site. - --REST API: [Delete Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} -+REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) - - - **Parameters** -@@ -943,7 +943,7 @@ Returns information about the groups on the site. - To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. - - --REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} -+REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) - - **Parameters** - -@@ -988,7 +988,7 @@ groups.populate_users(group_item, req_options=None) - Populates the `group_item` with the list of users. - - --REST API: [Get Users in Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group){:target="_blank"} -+REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) - - **Parameters** - -@@ -1049,7 +1049,7 @@ Removes a user from a group. - - - --REST API: [Remove User from Group](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group){:target="_blank"} -+REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) - - - **Parameters** -@@ -1122,7 +1122,7 @@ Source file: models/job_item.py - Name | Description - :--- | :--- - `id` | The `id` of the job. --`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} REST API. -+`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. - `created_at` | The time the job was created. - `started_at` | The time the job started. - `completed_at` | The time the job finished. -@@ -1151,7 +1151,7 @@ jobs.get(job_id) - - Gets information about the specified job. - --REST API: [Query Job](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job){:target="_blank"} -+REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) - - - **Parameters** -@@ -1238,7 +1238,7 @@ Name | Description - `name` | Name of the project. - `description` | The description of the project. - `id` | The project id. --`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://onlinehelp.tableau.com/current/server/en-us/projects.htm){:target="_blank"}. -+`parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). - - - -@@ -1247,7 +1247,7 @@ Source file: models/project_item.py - - #### ProjectItem.ContentPermissions - --The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"}. -+The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). - - Name | Description - :--- | :--- -@@ -1303,7 +1303,7 @@ Creates a project on the specified site. - To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - --REST API: [Create Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project){:target="_blank"} -+REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) - - **Parameters** - -@@ -1348,7 +1348,7 @@ Return a list of project items for a site. - - To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - --REST API: [Query Projects](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects){:target="_blank"} -+REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) - - - **Parameters** -@@ -1389,7 +1389,7 @@ Modify the project settings. - - You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - --REST API: [Update Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project){:target="_blank"} -+REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) - - **Parameters** - -@@ -1451,7 +1451,7 @@ Deletes a project by ID. - To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - --REST API: [Delete Project](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project){:target="_blank"} -+REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) - - - **Parameters** -@@ -1534,7 +1534,7 @@ Name | Description - - #### RequestOptions.Field class - --The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm){:target="_blank"} in the Tableau REST API. -+The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. - - **Attributes** - -@@ -1762,7 +1762,7 @@ schedule.create(schedule_item) - Creates a new schedule for an extract refresh or a subscription. - - --REST API: [Create Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule){:target="_blank"} -+REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) - - - -@@ -1811,7 +1811,7 @@ schedule.delete(schedule_id) - Deletes an existing schedule for an extract refresh or a subscription. - - --REST API: [Delete Schedule](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule){:target="_blank"} -+REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) - - - -@@ -1842,7 +1842,7 @@ schedule.get([req_options=None]) - Returns all schedule items from the server. - - --REST API: [Query Schedules](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules){:target="_blank"} -+REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) - - - -@@ -1948,7 +1948,7 @@ The `Server` class contains the attributes that represent the server on Tableau - Attribute | Description - :--- | :--- - `server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). --`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm){:target="_blank"} -+`version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) - - - -@@ -2070,7 +2070,7 @@ Retrieve the build and version information for the server. - - This method makes an unauthenticated call, so no sign in or authentication token is required. - --REST API: [Server Info](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info){:target="_blank"} -+REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) - - **Parameters** - None -@@ -2178,7 +2178,7 @@ Creates a new site on the server for the specified site item object. - Tableau Server only. - - --REST API: [Create Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site){:target="_blank"} -+REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) - - - -@@ -2223,7 +2223,7 @@ sites.get() - Queries all the sites on the server. - - --REST API: [Query Sites](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites){:target="_blank"} -+REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) - - - **Parameters** -@@ -2266,7 +2266,7 @@ sites.get_by_id(site_id) - Queries the site with the given ID. - - --REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} -+REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) - - **Parameters** - -@@ -2312,7 +2312,7 @@ sites.get_by_name(site_name) - Queries the site with the specified name. - - --REST API: [Query Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site){:target="_blank"} -+REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) - - **Parameters** - -@@ -2363,7 +2363,7 @@ Modifies the settings for site. - The site item object must include the site ID and overrides all other settings. - - --REST API: [Update Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site){:target="_blank"} -+REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) - - - **Parameters** -@@ -2416,7 +2416,7 @@ Sites.delete(site_id) - Deletes the specified site. - - --REST API: [Delete Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Site27){:target="_name"} -+REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site) - - - **Parameters** -@@ -2553,7 +2553,7 @@ When a user is subscribed to the content, Tableau Server sends the content to th - To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). - - --REST API: [Create Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription){:target="_blank"} -+REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_subscription) - - **Parameters** - -@@ -2612,7 +2612,7 @@ subscriptions.delete(subscription_id) - - Deletes the specified subscription from the site. - --REST API: [Delete Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription){:target="_blank"} -+REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) - - - **Parameters** -@@ -2657,7 +2657,7 @@ subscription.get(req_options=None) - Returns information about the subscriptions on the specified site. - - --REST API: [Query Subscriptions](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions){:target="_blank"} -+REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscriptions) - - **Parameters** - -@@ -2682,7 +2682,7 @@ subscription.get_by_id(subscription_id) - - Returns information about the specified subscription. - --REST API: [Query Subscription](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription){:target="_blank"} -+REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) - - - **Parameters** -@@ -2790,7 +2790,7 @@ Adds the user to the site. - - To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. - --REST API: [Add User to Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site){:target="_blank"} -+REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) - - **Parameters** - -@@ -2833,7 +2833,7 @@ Returns information about the users on the specified site. - To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. - - --REST API: [Get Users on Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site){:target="_blank"} -+REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) - - **Parameters** - -@@ -2873,7 +2873,7 @@ users.get_by_id(user_id) - - Returns information about the specified user. - --REST API: [Query User On Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site){:target="_blank"} -+REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) - - - **Parameters** -@@ -2932,7 +2932,7 @@ Returns information about the workbooks that the specified user owns and has Rea - - This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). - --REST API: [Query Datasource Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections){:target="_blank"} -+REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) - - **Parameters** - -@@ -2989,7 +2989,7 @@ users.remove(user_id) - - Removes the specified user from the site. - --REST API: [Remove User from Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site){:target="_blank"} -+REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) - - - **Parameters** -@@ -3033,11 +3033,11 @@ users.update(user_item, password=None) - - Updates information about the specified user. - --The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"}. -+The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). - - - --REST API: [Update User](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user){:target="_blank"} -+REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user) - - **Parameters** - -@@ -3154,7 +3154,7 @@ views.get(req_options=None, usage=False) - Returns the list of views items for a site. - - --REST API: [Query Views for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site){:target="_blank"} -+REST API: [Query Views for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_site) - - **Version** - -@@ -3209,7 +3209,7 @@ Populates a preview image for the specified view. - - This method gets the preview image (thumbnail) for the specified view item. The method uses the `id` and `workbook_id` fields to query the preview image. The method populates the `preview_image` for the view. - --REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview){:target="_blank"} -+REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_with_preview) - - **Version** - -@@ -3258,7 +3258,7 @@ Populates the image of the specified view. - - This method uses the `id` field to query the image, and populates the image content as the `image` field. - --REST API: [Query View Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image){:target="_blank"} -+REST API: [Query View Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_image) - - **Version** - -@@ -3305,7 +3305,7 @@ Populates the CSV data of the specified view. - - This method uses the `id` field to query the CSV data, and populates the data as the `csv` field. - --REST API: [Query View Data](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data){:target="_blank"} -+REST API: [Query View Data](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_data) - - **Version** - -@@ -3353,7 +3353,7 @@ Populates the PDF content of the specified view. - - This method populates a PDF with image(s) of the view you specify. - --REST API: [Query View PDF](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf){:target="_blank"} -+REST API: [Query View PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_view_pdf) - - **Version** - -@@ -3484,7 +3484,7 @@ Queries the server and returns information about the workbooks the site. - - - --REST API: [Query Workbooks for Site](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site){:target="_blank"} -+REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbooks_for_site) - - - **Parameters** -@@ -3529,7 +3529,7 @@ workbooks.get_by_id(workbook_id) - - Returns information about the specified workbook on the site. - --REST API: [Query Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook){:target="_blank"} -+REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook) - - - **Parameters** -@@ -3580,7 +3580,7 @@ unless you package the data and workbook in a .twbx file, or publish the data so - - For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. - --REST API: [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"}, [Initiate File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload){:target="_blank"}, [Append to File Upload](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload){:target="_blank"} -+REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) - - - -@@ -3604,7 +3604,7 @@ Error | Description - `Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. - `Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. - --See the REST API [Publish Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook){:target="_blank"} for additional error codes. -+See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. - - **Returns** - -@@ -3638,7 +3638,7 @@ workbooks.refresh(workbook_item) - - Refreshes the extract of an existing workbook. - --REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now){:target="_blank"} -+REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) - - **Parameters** - -@@ -3684,7 +3684,7 @@ workbooks.update(workbook_item) - - Modifies an existing workbook. Use this method to change the owner or the project that the workbook belongs to, or to change whether the workbook shows views in tabs. The workbook item must include the workbook ID and overrides the existing settings. - --REST API: [Update Workbooks](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook){:target="_blank"} -+REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook) - - **Parameters** - -@@ -3742,7 +3742,7 @@ Deletes a workbook with the specified ID. - To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). - - --REST API: [Delete Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31){:target="_blank"} -+REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#Delete_Workbook31) - - - **Parameters** -@@ -3786,7 +3786,7 @@ workbooks.download(workbook_id, filepath=None, no_extract=False) - Downloads a workbook to the specified directory (optional). - - --REST API: [Download Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook){:target="_blank"} -+REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook) - - - **Parameters** -@@ -3837,7 +3837,7 @@ You must first call this method to populate views before you can iterate through - - This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. - --REST API: [Query Views for Workbook](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook){:target="_blank"} -+REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) - - **Parameters** - -@@ -3900,7 +3900,7 @@ connections. - - This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. - --REST API: [Query Workbook Connections](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections){:target="_blank"} -+REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) - - **Parameters** - -@@ -3962,7 +3962,7 @@ This method gets the preview image (thumbnail) for the specified workbook item. - - The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. - --REST API: [Query View Preview Image](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image){:target="_blank"} -+REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) - - **Parameters** - -@@ -4018,7 +4018,7 @@ Updates a workbook connection information (server address, server port, user nam - - The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) - --REST API: [Update Workbook Connection](https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection){:target="_blank"} -+REST API: [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_connection) - - **Parameters** - -@@ -4064,7 +4064,7 @@ Populates the PDF content of the specified workbook. - - This method populates a PDF with image(s) of the workbook view(s) you specify. - --REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf){:target="_blank"} -+REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) - - **Version** - diff --git a/docs/versions.md b/docs/versions.md index f1323fd0d..70076aa6e 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -25,18 +25,28 @@ For example, the code might display version `2.3`. ## Use the REST API version supported by the server -To always use the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to, specify `use_server_version=True` as one of the arguments. +There are two options for always using the the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to. + +The first method is to specify `use_server_version=True` as one of the arguments, for example: ```py import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL', use_server_version=True) +``` +The second method is to create the server object first, then call the `use_server_version()` method on it. There are some situations where this method is needed. For instance, if you want to disable certificate checking, you have to do that after you create the server object, but before you make calls to the server (use_server_version makes a call to the server). + +```py +import tableauserverclient as TSC + +server = TSC.Server('http://SERVER_URL') +server.use_server_version() ``` ## Use a specific version of the REST API -To use another version of the REST API, set the version like so: +To use a specific version of the REST API, set the version like so: ```py import tableauserverclient as TSC @@ -52,6 +62,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.8|2020.2| |3.7|2020.1| |3.6|2019.4| |3.5|2019.3| From fafba5d44cbe3101b210f1ff47e0f18df22204c1 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 10 Aug 2020 18:59:33 -0700 Subject: [PATCH 062/158] Prettier reformat only --- docs/dev-guide.md | 106 ++++++++++++++++++++++++++++++---------------- 1 file changed, 70 insertions(+), 36 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index d3f402a77..b60585b2c 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -3,24 +3,30 @@ title: Developer Guide layout: docs --- -This topic describes how to contribute to the Tableau Server Client (Python) project. +This topic describes how to contribute to the Tableau Server Client (Python) +project. -* TOC + +- TOC {:toc} --- ## Submit your first patch -This section will get you started with the basic workflow, describing how to create your own fork of the repository and how to open a pull request (PR) to add your contributions to the **development** branch. +This section will get you started with the basic workflow, describing how to +create your own fork of the repository and how to open a pull request (PR) to +add your contributions to the **development** branch. ### Get the source code and set up your branch -1. Make sure you have [signed the CLA](https://tableau.github.io/contributing.html) +1. Make sure you have + [signed the CLA](https://tableau.github.io/contributing.html) 1. Fork the repository. - We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/). + We follow the "Fork and Pull" model as described + [here](https://help.github.com/articles/about-collaborative-development-models/). 1. Clone your fork: @@ -36,7 +42,8 @@ This section will get you started with the basic workflow, describing how to cre 1. Set up the feature, fix, or documentation branch. - It is recommended to use the format issue#-type-description (e.g. 13-fix-connection-bug) like so: + It is recommended to use the format issue#-type-description (e.g. + 13-fix-connection-bug) like so: ```shell git checkout -b 13-feature-new-stuff development @@ -46,55 +53,82 @@ This section will get you started with the basic workflow, describing how to cre ### Code and commit - Here's a quick checklist to follow when coding to ensure a good pull request (PR): +Here's a quick checklist to follow when coding to ensure a good pull request +(PR): - - Only touch the fewest number of files possible while still accomplishing the goal. - - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. - - The code matches PEP8 style guides. If you cloned the repo you can run `pycodestyle tableauserverclient test samples` - - Keep commit messages clean and descriptive. - If the PR is accepted it will get 'Squashed' into a single commit before merging, the commit messages will be used to generate the Merge commit message. +- Only touch the fewest number of files possible while still accomplishing the + goal. +- Ensure all indentation is done as 4-spaces and your editor is set to unix line + endings. +- The code matches PEP8 style guides. If you cloned the repo you can run + `pycodestyle tableauserverclient test samples` +- Keep commit messages clean and descriptive. If the PR is accepted it will get + 'Squashed' into a single commit before merging, the commit messages will be + used to generate the Merge commit message. ### Add tests - All of our tests live under the `test/` folder in the repository. - We use `pytest` and the built-in test runner `python setup.py test`. - If a test needs a static file, like a .twb/.twbx, it should live under `test/assets/` +All of our tests live under the `test/` folder in the repository. We use +`pytest` and the built-in test runner `python setup.py test`. If a test needs a +static file, like a .twb/.twbx, it should live under `test/assets/` ### Update the documentation - When adding a new feature or improving existing functionality we may ask that you update the documentation along with your code. +When adding a new feature or improving existing functionality we may ask that +you update the documentation along with your code. - Our documentation is written in markdown and built with Jekyll on GitHub Pages. All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python) +Our documentation is written in markdown and built with Jekyll on GitHub Pages. +All of the documentation source files can be found in `/docs` folder in the +**gh-pages** branch. The docs are hosted on the following URL: +[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python) - If you are just making documentation updates (adding new docs, fixing typos, improving wording) the easiest method is to use the built-in `Edit this file` feature right in GitHub (click the pencil icon). If you are viewing one of the pages on [https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), clicking the **Edit this page** link at the top of the page will take you to the same place. +If you are just making documentation updates (adding new docs, fixing typos, +improving wording) the easiest method is to use the built-in `Edit this file` +feature right in GitHub (click the pencil icon). If you are viewing one of the +pages on +[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), +clicking the **Edit this page** link at the top of the page will take you to the +same place. ### Commit changes to your fork and open a PR -1. Make a PR as described [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the **development** branch for code changes, or against **gh-pages** for documentation updates. +1. Make a PR as described + [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) + against the **development** branch for code changes, or against **gh-pages** + for documentation updates. -1. Wait for a review and address any feedback. - While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely pinging - the PR after a few days with no response is OK, we'll try and respond with a timeline as soon as we are able. +1. Wait for a review and address any feedback. While we try and stay on top of + all issues and PRs it might take a few days for someone to respond. Politely + pinging the PR after a few days with no response is OK, we'll try and respond + with a timeline as soon as we are able. -1. That's it! When the PR has received ![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the PR. +1. That's it! When the PR has received + ![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%" + width="5%"} (:rocket:'s) from members of the core team they will merge the + PR. --- ## Add new features -1. Create an endpoint class for the new feature, following the structure of the other endpoints. Each endpoint usually - has `get`, `post`, `update`, and `delete` operations that require making the url, creating the XML request if necessary, - sending the request, and creating the target item object based on the server response. - -1. Create an item class for the new feature, following the structure of the other item classes. Each item has properties - that correspond to what attributes are sent to/received from the server (refer to docs and Postman for attributes). - Some items also require constants for user input that are limited to specific strings. After making all the - properties, make the parsing method that takes the server response and creates an instances of the target item. If - the corresponding endpoint class has an update function, then parsing is broken into multiple parts (refer to another - item like workbook or datasource for example). - -1. Add testing by getting real xml responses from the server, and asserting that all properties are parsed and set - correctly. +1. Create an endpoint class for the new feature, following the structure of the + other endpoints. Each endpoint usually has `get`, `post`, `update`, and + `delete` operations that require making the url, creating the XML request if + necessary, sending the request, and creating the target item object based on + the server response. + +1. Create an item class for the new feature, following the structure of the + other item classes. Each item has properties that correspond to what + attributes are sent to/received from the server (refer to docs and Postman + for attributes). Some items also require constants for user input that are + limited to specific strings. After making all the properties, make the + parsing method that takes the server response and creates an instances of the + target item. If the corresponding endpoint class has an update function, then + parsing is broken into multiple parts (refer to another item like workbook or + datasource for example). + +1. Add testing by getting real xml responses from the server, and asserting that + all properties are parsed and set correctly. 1. Add a sample to show users how to use the new feature. From 7f3d9ef8d7e2e59dc938ca24d845a685b1405a3b Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 14 Aug 2020 10:06:45 -0700 Subject: [PATCH 063/158] [DOC] Add webpage_url to workbookItem webpage_url added with #661, ready for the next release. --- docs/api-ref.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index 628221247..6fc697d38 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3436,6 +3436,7 @@ Name | Description `tags` | The tags that have been added to the workbook. `updated_at` | The date and time when the workbook was last updated. `views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). +`webpage_url` | The full URL of the workbook. From 2ccc63b8681e39056184b0cb8348d883521075c5 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 14 Aug 2020 10:23:53 -0700 Subject: [PATCH 064/158] [DOC] Fix example under subscription.create() Fixes #664 --- docs/api-ref.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 628221247..a5131dcd0 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2579,20 +2579,20 @@ Returns the new `SubscriptionItem` object. # create the target (content) of the subscription -# in this case, id of the workbook add the target type "workbook" +# in this case, id of the workbook and the target type "workbook" - target = ('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') + target = TSC.Target('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') # the ids for the schedule and user - schedule = ('b60b4efd-a6f7-4599-beb3-cb677e7abac1') - user = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' + schedule_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' + user_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' # create a new SubscriptionItem object. - newSub = TSC.SubscriptionItem('My Subscription', schedule, user, target) + newSub = TSC.SubscriptionItem('My Subscription', schedule_id, user_id, target) # create the new subscription to the site newSub = server.subscriptions.create(newSub) - print(newUSub.subject) + print(newSub.subject) ``` From 2a7a9d991766797de7b70e5930b5d07ef99d90af Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 19 Aug 2020 10:33:03 -0700 Subject: [PATCH 065/158] Restructure and improve Dev Guide --- docs/dev-guide.md | 133 ++++++++++++++++++++++++++-------------------- 1 file changed, 75 insertions(+), 58 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index b60585b2c..a7d35b157 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -4,7 +4,7 @@ layout: docs --- This topic describes how to contribute to the Tableau Server Client (Python) -project. +project: - TOC @@ -21,11 +21,9 @@ add your contributions to the **development** branch. ### Get the source code and set up your branch 1. Make sure you have - [signed the CLA](https://tableau.github.io/contributing.html) + [signed the CLA](https://tableau.github.io/contributing.html). -1. Fork the repository. - - We follow the "Fork and Pull" model as described +1. Fork the repository. We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/). 1. Clone your fork: @@ -40,16 +38,14 @@ add your contributions to the **development** branch. python setup.py test ``` -1. Set up the feature, fix, or documentation branch. - - It is recommended to use the format issue#-type-description (e.g. - 13-fix-connection-bug) like so: +1. Set up the feature/fix branch (based off the `development` branch). It is + recommended to use the format issue#-type-description, for example: ```shell - git checkout -b 13-feature-new-stuff development + git checkout -b 13-fix-connection-bug development ``` - For documentation changes, see the documentation section below. +For documentation changes, see the documentation section below. ### Code and commit @@ -60,42 +56,58 @@ Here's a quick checklist to follow when coding to ensure a good pull request goal. - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. -- The code matches PEP8 style guides. If you cloned the repo you can run - `pycodestyle tableauserverclient test samples` -- Keep commit messages clean and descriptive. If the PR is accepted it will get - 'Squashed' into a single commit before merging, the commit messages will be - used to generate the Merge commit message. +- The code matches PEP8 style guides. Make sure to run + `pycodestyle tableauserverclient test samples` to catch and fix any style + issues before submitting your pull request. +- Keep commit messages clean and descriptive. + +### Adding features + +1. Create an endpoint class for the new feature, following the structure of the + other endpoints. Each endpoint usually has `get`, `post`, `update`, and + `delete` operations that require making the url, creating the XML request if + necessary, sending the request, and creating the target item object based on + the server response. + +1. Create an item class for the new feature, following the structure of the + other item classes. Each item has properties that correspond to what + attributes are sent to/received from the server (refer to docs and Postman + for attributes). Some items also require constants for user input that are + limited to specific strings. After making all the properties, make the + parsing method that takes the server response and creates an instances of the + target item. If the corresponding endpoint class has an update function, then + parsing is broken into multiple parts (refer to another item like workbook or + datasource for example). + +1. Add testing by getting real xml responses from the server, and asserting that + all properties are parsed and set correctly. + +1. Add a sample to show users how to use the new feature. ### Add tests All of our tests live under the `test/` folder in the repository. We use -`pytest` and the built-in test runner `python setup.py test`. If a test needs a -static file, like a .twb/.twbx, it should live under `test/assets/` +`pytest` and the built-in test runner `python setup.py test`. -### Update the documentation +Follow the structure of existing tests, especially if new server responses +are going to be mocked. -When adding a new feature or improving existing functionality we may ask that -you update the documentation along with your code. +If a test needs a +static file, like a .twb/.twbx/.xml, it should live under `test/assets/` -Our documentation is written in markdown and built with Jekyll on GitHub Pages. -All of the documentation source files can be found in `/docs` folder in the -**gh-pages** branch. The docs are hosted on the following URL: -[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python) +Make sure that all tests are passing before submitting your pull request. -If you are just making documentation updates (adding new docs, fixing typos, -improving wording) the easiest method is to use the built-in `Edit this file` -feature right in GitHub (click the pencil icon). If you are viewing one of the -pages on -[https://tableau.github.io/server-client-python](https://tableau.github.io/server-client-python), -clicking the **Edit this page** link at the top of the page will take you to the -same place. +### Update the documentation + +When adding a new feature or improving existing functionality we ask that you +update the documentation along with your code. See the Updating documentation +section below for details. -### Commit changes to your fork and open a PR +### Commit changes to your fork and open a pull request 1. Make a PR as described [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) - against the **development** branch for code changes, or against **gh-pages** - for documentation updates. + against the **development** branch for code changes. 1. Wait for a review and address any feedback. While we try and stay on top of all issues and PRs it might take a few days for someone to respond. Politely @@ -107,33 +119,38 @@ same place. width="5%"} (:rocket:'s) from members of the core team they will merge the PR. ---- +## Updating documentation -## Add new features +Our documentation is written in Markdown (specifically +[kramdown](https://kramdown.gettalong.org/quickref.html)) and built with Jekyll +on GitHub Pages. -1. Create an endpoint class for the new feature, following the structure of the - other endpoints. Each endpoint usually has `get`, `post`, `update`, and - `delete` operations that require making the url, creating the XML request if - necessary, sending the request, and creating the target item object based on - the server response. +All of the documentation source files can be found in `/docs` folder in the +**gh-pages** branch. The docs are hosted on the following URL: +. -1. Create an item class for the new feature, following the structure of the - other item classes. Each item has properties that correspond to what - attributes are sent to/received from the server (refer to docs and Postman - for attributes). Some items also require constants for user input that are - limited to specific strings. After making all the properties, make the - parsing method that takes the server response and creates an instances of the - target item. If the corresponding endpoint class has an update function, then - parsing is broken into multiple parts (refer to another item like workbook or - datasource for example). +If you are just making documentation updates (adding new docs, fixing typos, +improving wording) the easiest method is to use the built-in `Edit this file` +feature (the pencil icon) or the `Edit this page` link. -1. Add testing by getting real xml responses from the server, and asserting that - all properties are parsed and set correctly. +To make more significant changes or additions, please create a pull request +against the **gh-pages** branch. When submitted along with a code pull request +(as described above), you can include a link in the PR text so it's clear they +go together. -1. Add a sample to show users how to use the new feature. +### Running docs locally + +To preview and run the documentation locally, these are the steps: + +1. Install [Ruby](https://www.ruby-lang.org/en/downloads/) (v2.5.0 or higher) + +1. Install [Bundler](https://bundler.io/) + +1. Install [Jekyll](https://jekyllrb.com/docs/installation/) + +1. Run the Jekyll site locally with `bundle exec jekyll serve` - +For more details on the steps, see the GitHub Pages topic on +[testing locally](https://docs.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll). From 01231391d187038fdff185ac8717f776e72b9924 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 31 Aug 2020 15:11:39 -0700 Subject: [PATCH 066/158] Fix a couple of headings and correct spelling of req_options (#683) --- docs/api-ref.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f5434df41..4b95a1277 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -79,7 +79,7 @@ Source file: server/endpoint/auth_endpoint.py

      -#### auth.sign in +#### auth.sign_in ```py auth.sign_in(auth_req) @@ -122,7 +122,7 @@ server.auth.sign_in(tableau_auth)
      -#### auth.sign out +#### auth.sign_out ```py auth.sign_out() @@ -367,7 +367,7 @@ REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-u Name | Description :--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. **Returns** @@ -949,7 +949,7 @@ REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-u Name | Description :--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. **Returns** @@ -1850,7 +1850,7 @@ REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/ Name | Description :--- | :--- -`req_options` | (Optional) To filter the return items, you can specify request options. See Requests and . +`req_options` | (Optional) Additional request options to send to the endpoint. #### schedule.update @@ -2663,7 +2663,7 @@ REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en Name | Description :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. **Returns** @@ -2839,7 +2839,7 @@ REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-u Name | Description :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. **Returns** @@ -3164,7 +3164,7 @@ This endpoint is available with REST API version 2.0 and up. Name | Description :--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. `usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. @@ -3492,7 +3492,7 @@ REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_a Name | Description :--- | :--- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) **Returns** From d1c6997330449cf1e25d0944d95d18c6f11df593 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Tue, 15 Sep 2020 09:58:11 -0700 Subject: [PATCH 067/158] Update dev-guide.md (#692) --- docs/dev-guide.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index a7d35b157..46c560d7b 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -38,11 +38,22 @@ add your contributions to the **development** branch. python setup.py test ``` -1. Set up the feature/fix branch (based off the `development` branch). It is +1. Configure a remote that points to the source (upstream) repository: + ```shell + git remote add upstream https://github.com/tableau/server-client-python + ``` + More information about configuring a remote for a fork can be found [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork). + +1. Sync your fork: + ```shell + git fetch upstream + ``` + +1. Set up the feature/fix branch (based off the source `development` branch). It is recommended to use the format issue#-type-description, for example: ```shell - git checkout -b 13-fix-connection-bug development + git checkout -b 13-fix-connection-bug upstream/development ``` For documentation changes, see the documentation section below. From 03d24cc29121597b2bdc04cb3b1684387e7afc4d Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Thu, 1 Oct 2020 10:44:16 -0700 Subject: [PATCH 068/158] Removes an example using groups.get_by_id (#688) Groups does not have a query-by-id endpoint, but was included in an example (#682) --- docs/api-ref.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 4b95a1277..0fe537ef4 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1076,7 +1076,7 @@ None. The user is removed from the group. **Example** ```py -# Remove a user from the group +# Remove a user from a group # import tableauserverclient as TSC # tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') @@ -1084,8 +1084,9 @@ None. The user is removed from the group. with server.auth.sign_in(tableau_auth): - # get the group - mygroup = server.groups.get_by_id('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') + # get a group + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[0] # remove user '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d' server.groups.remove_user(mygroup, '9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') From 243fc995dd909c182c32e357dac71dbe37fa7073 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 28 Sep 2020 19:15:28 -0700 Subject: [PATCH 069/158] Add troubleshooting guide, rewrite sign in page, general improvements - Add troubleshooting guide for capturing REST API traffic - Add docs for site_switch() added in #655 - Rewrite sign in/out page to be more clear - Add docs for PersonalAccessTokenAuth added in #465 - Some general edits and wordsmithing --- _includes/docs_menu.html | 3 + assets/fiddler.png | Bin 0 -> 293071 bytes docs/api-ref.md | 1600 +++++++++++++++++++------------------- docs/dev-guide.md | 17 +- docs/index.md | 17 +- docs/samples.md | 2 +- docs/sign-in-out.md | 113 ++- docs/troubleshooting.md | 54 ++ docs/versions.md | 9 +- 9 files changed, 996 insertions(+), 819 deletions(-) create mode 100644 assets/fiddler.png create mode 100644 docs/troubleshooting.md diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index 5693ee67e..e627e8f44 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -22,6 +22,9 @@
    • Samples
      • +
    • + Troubleshooting +
    • Developer Guide
      • diff --git a/assets/fiddler.png b/assets/fiddler.png new file mode 100644 index 0000000000000000000000000000000000000000..cb5fde8e67a6c50617dc57f119e66e1b101a6621 GIT binary patch literal 293071 zcma&NcUV(hvpyV}fCWNFT0jt#Dn*bQngWUxktR*)N>@4|p$RBmsvw}CBB*o$DGAa- zM-ZeFAoLa>KoZhEp7*@Z`JF$%JNruZwX(Cr4z<6_y1?q?H?2d2oyoqZ9c1&!-W4f5pn}3c-#0jkDhWW*ul*!tkX~nyp@T^$OJyd2} z8~IrTBJyOIWtipU48uZa$3L$V{ypO42g*9gH~$9CJ)tG{&3K#p+5oY>(XW1PVOsBv z$;sXq1|8n>oz?2wRO*`S70!5iFM~3zj-=AimRAj|h|h=&L42(NLhc?wTQ}HH)=Z7+ z4+?&BOoI}46fM+|Ow#Y=A-B&QSZrQQ0n|3$sEVVxuF!1UyPyWh#4 zcXtqPVu|NIaF$B##F@t|mo&{BMp-{bi!3M=?in(2xzSBUt9D|3t;3RU16*0BqepTz z0f91aR@C)5b@v=dy(pLOu-^rI-I@NH|Lt&5KKbSnWEwM6%{aoOx|F?p(#xYYGqF#X z#DPWTg8q9|`brc_m1v93xkBN2q34bpQ%myMyB`LZnm%iR8nIeniaiBQ-t>WnB6dee z1LW&VrmA3YaM6Y-i43nPK4U>yE@*LMoQ|f-pI`~KdRNqK8becIZo$`9)+r{*5gQYi zmqj)ww(s0dyZ#FzkMbaluAWW7nZD%~oGDWAKRN)>LQVa-cCzwXxQZbYe`}T!3hF3OqUlN>C3@!PmpxOuqSr| z!;)VOr@1%3H?4C5I3Ioc?gBF4!rFPD%Ng%x`ao?cqNT@+=yLnxX&n-~p zbrLFVvWx6R3Wb*z^s%wFs?Vlr_pGv{^8YM=V<&UG6o*OhL^)(T`B z6lI;HnREhb>*8`{xv25 z;5}_lQ}w4Z&z}ln9!%_d9<)H_TOGd)NT1i17DYvNuF+<3Ah-D1Ut27ik{9knNE7=n zKOGWU&%F+<^B#s(=a?BqWN-|&b`wBX znSfPfcsO1JaSOJ{#-at;EMN`NyZ56vNN1sRnr}k*AL{9Bdzz5{;Ovgbe^3^Z$HBJL zeBOxm>z&Utref~56W^76KQ}t5G|#LZcRaN(dIi7lV{c)2>DzeX1%-z3FoD?y+W#F~ zyF!UaPYhTrAWf5#kGhrq+uHRiROWAfTJ{{P*dI7(`?dD|htUtn(b3WPfu*GU2*eS3R*4H43w!NI``vwUfId1JLRnm;3VrN?->8223h!!?{WoH3m7 ze|U!{1U_(Yu1Os%xT#Rg?V2iMJlryGi$6H1kziupVHbA zu=TiH^Wr*br^9a@yVH*J+s!=^nkK(lh+Pm_!R~ZZQ#^RI+8Enn&EPkSe=@vC8XSQu zbXb20tNmOy>f~~Dg2TS|9l5YDyG0~%Mq0B;B{AKLE3wr>l`j2eWTg?MUyAy94b1U< zG(gpU4SR6*xIWz6+?+Yw-{0R{A`t$d(Jm;V*>D&PrP2dwKsG#zuZpah&}^KWpH|a? z6BPofc{vpo6aklb((@r+yVW37oW0#gxxoG^XOd)r9B+Bu!Am2Q{;8!es{VKt)w9lz z@QZHfAg{=$(IY41eHo%w8j6Btfd2IeF3 ze&U4uK84&k64D@UYHkQVI<=Ho=kA!@)f_YqPka5dyW?#BorV(VniM@6^ChrhiTSp( zwhaSyir5BTmr5r`$I4xA(#pyT`dZ#*iu?Msb!^uT;}y$|_9Bqcl7Xq&5;9?OauPwI zoa}DnFjUg4(okA+r9p3vn;9#V1ep&rElurCI@u0}YDzifm7`Wj1a4I%4j<%&_zQ2k z4i9dHio$`I?c&|z?aRamolr$<*djhi3UPpc4t@r^v5yZDLcBWI7DN3FhFUZp6?7AR z9HNUNW2sZ>RNnFmsZ@#2<;RT5@_f{7P)`>xN2d6F4j88r?cE19HdEa{-jk*n2;Y?- zWQfP*fQ)X||LAGHVy45vrFT`wrrm*u`vljqS4(tX8=8CD*nUU2#K){FZ*P;l5QesG z3kxGIXau`Y-8&qLc!43$y}%SkM=Yq$UGB_n!1#Z72w}8O!Ivqj(lIyK5-A z$t%a2viiu}FBr2>RO!P=MpzLFj8>1s3idpoqs58)K7lZ<{e+x-(Tiuf&E41ppgh6~ zex${ljP2b%-Kl$#YoTyQ)@8Ly*gbWMFkWuqC(y_G>4m-4Yq3PcYk8XI^BZDdl4+!N zD0;5Br8%M*{1ZY@Cva> z3m@#)1yii0XRW_U9Y3mbQi6yBK;9ISA~bT_e6g@K6sH9uMu)Do?z(6#XxM;=iy|P$ zI*jKDb|ox%q18gTh#O}HCtU<*G%USSQxraoARC>~a)!MEZTXt5?rt?&?S z8p1x7bws^%u|@mkfo3btH(|Zbh^`c(FAghSjPqJ_feL{6J-N42%|qPg8MvTTku zzUsTEy^JZ`y5QP-dlJ7cA*%I?GIVcFRrgzKOW8U{*D#x2h|6ZtD_}9m5JYE`ZfFYC zZuO^uA8y6J6E`h_WJZ81KYVyH@abOewL%k^XdGU)aJW}xuJ>Pj=~~HZij)9xOKwaJ zt&jX~^Gf#c#{{6L!8g*^drsz&(rd6|ac z$RSjtGEyiaf3;i6st(kSWA420A%(g%%_9=2BF~PZdEFoK_?7PNdaRdH_` z2n*M<5n6p~{HVL1afF54c^xfb(#jYRqVk!g{8q~(YZc=yhUX6H^oFApA;T!+p+xxU z`AGmc7}|Mbo@qV+DX20ZfoW5Tjoke)*)!V^*&Vq^EQYuk8Gg!&Yh9o0=rfZn6lp=E zvA4Ck-n;6;{YfApPTJbIvW<5*$-B@W^Kuq8^WmdmrXVIWvY#Sdu77d$!PEMKW!vjH zqNQo`yZoW@Y6K#tzze*Pid%GxJM!5$XL$^f=_EY9U zoDgDo`-J>grwD)w?D=3t$?KJpE?pivo<$!jkw-00ZE zoVE0AxKn(l87Ji8!S9H*K3ohUb|fX_t)Hl|rgXtoSaT+C&{ts!DUiGCr3Zo<_>D*e z?J0{nUaJEy^l3?5+Z`jwAS79IPZdLUj-=f~Pr~YY1%%|W@`8aFXcT-zA zg{%#q(m*n|nzc%{5+`S^jofeC= zy4$d+VYrUFU*e}l=8BAHO@{l(j%-c21aAJ8+wd;jslw1-9aWB|ya@+0+hvz!#;^qK zmR0DbJqR11uh{$cF~3qGYc1ILQ=h@!hvQ3M%gd-@uO9NT1}>%~{}*=+4aMpk8~;=~ zv}7%WdGPE)h(0qlk?KDhe~d15CT#XqNIv^gB|-8Rp(Pl;j_TGMU3bZ95u!^vuiWw$o2nL*ZY_J#!Niw=oE+Rv$GqPX1n- z-fV+UDVc~Xy(Dz%?*^N^_X@B|Gy6oQTAWNK*Be!i?#;JkeCZqNEOWw6D=GXJ&EhxX z@>C(G-|Z}ESHi`#fp)n#71p%IG+p*CiAFO%=JX9y=tduFt33KSGq8Tvs>P?)IBM~i zdoPzxfW3$ay2p=-d^n!We(LOd`4t$hEkDq&sUJO= z&B>`AW-ksF{}VEV_%twNIy!0KF*a$?U-vBkzV)M`k5Va!&(X~ju5KXZs{`aqpyG70 zpn5=7QF>n*gF~IC+d6H<)5zrr%|FTsIYFBD74tzQDaT&dqXQ1`|B5~NwZj2DM1?CI z)e<6S1j<<(DK_|ORax@#0?*jo&lgWo@W}DGIpYFlzY-T@s<~P$y}?Pn!6T-i<>l{< z3nlsad|SJkFCT;7@NH$qrsKX;eUHrKwzB>ziU|q|Qi|*ee5UqSzl_mjpeyRr%o?1p z-=r3-y2JU(_4e?jKK0okBdgFyMxoI3&)M0d6_#H;H{X1EXltueg`lWG9)*0{DVXtf z`Z-xH1{xYUovwi3ub&@}{>A$Q<%XW?vD!6bvD*uspPW|sMgvFLRQ}SPfk&#dgY&Aq zlY%Qo-u>pOV(7^->l2$=|FNjrtKitul?EZ=ZKx3b%l`$}*LdO0&Smh8`*)McP$9dj+`pY&3nP;iswm>4h(KPlLE;9c`wSTkN^@@X6^i=O>)_n=n zqK|7i?pZ&5njf;SZj6>b8?3~n-qbE^{yRB2a4I^!FdFT8|0H_Ih*pAaLKa45}C+1#WQpdew z{ReC4BO|iJH09+EqK(NLoQH7QsG(D8Oy@G=6Xc1K8PzyEp?A=1H}G5tf{C;c2w_6vs4qk)8qKlqBTt62X-y?fAWG6e=aZtN@0LmXnt-%GXnq8mTD zBFs*L<~~!3Skz$e-@tu}QuP@nzS=L@1foA_PiOFBY1=5%jdYzfn4Ys z51*2v-LHq*8Z%AKMFW=ntP5j1dO{~Mro=(1oG=*i6fZ(OXgRL{?LD+b+<***PzDu| z8kN54RD$Bbb{ST_>bOyfSk&rOY)i4|o!AsF9+8PXfn(?U0DXo2m|g(VkSPLWPB6+&a*@P#a2VJ-c=$Gugb&CL z4J~c3Dr#*i7J@-uYlPLjDY9+Nv#N4T(T_hrHQ9ek#8@9IY*3{q#-&SmoFL|!I|8@- zqa-CIEytG56uBN(+V)Vj*HC<4)j>%b%YY!@|A-s?7zD62?%@~Dp2_|^TW%M7CpkR{AFbXI|4R6i-Sv;IfQzw zLq$Hs1X(z7DFQLHv$XGG4^N@m`#A#&_x@3-;YzHNL zKTM|)_O${o_+T#ZHdf#9M4f+(%4J31^vv-rOQBN2PB8&VHoQUy&#%umY*Kd|ywWW# zgDdkMN@kAjn`N;lb&M(GyiG1mb$$>X&DK(2jrG*o*rSO)Czdtz*vnG@LjR6$v-h4h z(CeK0#T&0VFY;+K=rq6GBWkSAK>-0bhHqq--@UkE@GO}yDz$AFDf=~PsQgb^+R$$N z{R!)J!uKCIcy0^M(W$D9P0v7DQ2v;P?%a`H@;vhRJeM|{g-uL2?27%1YpsA1hO`{= zhh;`S=@Pt1M?xBuoN$Z*drwtULWk9-a^FS&9{u}wVdi{2dz2hh%GC7{JF}Wfh?>Kf zB8j&`l8`}K2u)nHG>}_c3+-0@ToBCpjL~39GbsL%0-{8Yg=^G0CGAO{6c?DY2}#@g z@D#=2vN6Z#UA3w-tM`*P{G+0Gm57C@Vk-A&hq3CA-@8$f@OSh=bSvQtRiUQoD;FjG zBtPVW9d*j4i)Nk<6ibmns;d2M%F(AIdQA>1jeNg}I*@w1_LeR1BK$C$zl-%cjPn}E zjGED3Me@yY+6HcceF>rvs80Z?@y-(67FY|EIOsRoK~2E@KVIlCAEhoD>tZ1|efJ>A3T&|_U4gF%xMeZaTi|a$QU9U_{%n(qrCw6V}s;CQs|-H^NIE9g2(+d)rH!^DzF5FjQzKEyK53Uzk0|COn$O>IfJQVV-FI!fI?ye=$6tuqYWyJeYLjy%HHqK_U+_OIN6+11`8EESmM~G z-fS~-h(89i?i6;=4snK`asD`Xuh{YRr!F&PTlh1PB)wLZ_e^T0at@Nms?S#v?d9wm zlHGH1(Jz1jPgfGzY~UAyGB0LCzzNnzEW{{brI0;)Zd1wWy(jpLoq{*Z?8~ai?uJnO zQo_^q;leMOQ{GSNFGu=KO?^coSr`@*;QTK~5@$nfp>pV1c*|sp;Azj4Xe-9=5*Abl zLSR(L3D{DcV9heOJYlh0P`w*lrL4Pf={l^nDe16f64#v+aSfD+22-Xw4K6~ZsWI?T z9F27cq9=KlKn^C+a5!%yeiHqh3QMe$O7>0%r`3QATidjw;0RoT9h-?Lxx1c^C-uLEa&ToR)eyc2P6O z@6BTPw2RwRlK@Sy7A(2;?ZsLVFx2;b4;lA+2c#t1|EzztcA;L7zJ1lXKdaB8 z>+h2W^*4%q4SpzDTLDbXVr}SwbNI=$huh`y)gJ@5+wntwFgkUDf*w#i-KqcP+wO$R zitfK3aPx2<2nnw$4#@c`!J+fv75QM+>jdC4;YaPV#nd;7H+mj#${s{Sk*$WRVw}o5 z)z&mEEMkoWlJpQc&k?6vUyoKYP4DLPIdUh7*UCsgVTfj0rte~Bx-Mn)P5aKd%G-%= zHHpM(In2<~#nee#Uft=DfSjSTfTnunyn-DbqT&HF)+b*1LoYD3)ZlRG;M{8Lt(VCH zt_Z`NAtlPU;N6)N+yNm#eK5;A`^@3O$3AvNrg5K15p^hoN^O&tmJS!4vAb+Dc1b?4 zYnIJ|5$NJ^WI?0vADK+nc0Mos+7W>>IEn;!;7A+NPylJtpDq-68XZQ{MZNGN7!=5+ zQFAzU{glLbVY4F>RVG*Q)n=c`hW5gM%TVDRYI8VOn0M9HTo-=rx{^;R&!_3h#9wz$ zw^l+OX}#1=NKGVmn@bjiTlvFKyuwczjSNn^XL3kSmx%js?>q{uf4BB=!1GCo?g{xu zZhOASy~jh|(w{FOx5VhWwyWKq{1>B)i%HCH4&=iQU72SFw0PeRc3=H|vNwOP&V8f< z&e`kU{@e_B>(KUtz&K1W09d71-l1@*n3>q2a% z+=EV0rPA1Xw*f0x{m11JiM-e7`eUNB`jdB9=3)&2zs_Bj0%~+kZd#Nbr0yUOw21jb zt6G70VE@&Uo-*kZZEyT=h)^6j>q1BT_*3lKkhi+QwoPC(?=q2|k(N&3hW-uP7GIeO z*{YWy*AahlBf+-AeyMu*A-?cJMVE!C)A)COGff#q?!{9f^sx50<_~02q>27c-c2v= z6UhuLBPg87?ag5J?bekEZ|KQiJ23L_(SzYeD22O=7ozp%iDLMXr}U+G+@~QPX&Y@n z-w2LXZjkCo%Nhd3{V&?scL6!whYac4Y!(>lD8MgUVab>ydv3#}v!-xiVyDfiqzy?M z{T09D((cnZue`t4f`PMv20z~~=s6I(nAsl;65H2M4VQVBLs{cK9jV2P67p{!F?6xC zkC4(|46~??Op73@q_2jc9QzMkCDw0sV7ysNUKV(L{sU^e1G{yad*tSF)g#)!fl-+M zy`sM(IECTOtH7mLgI@KT;^*HzuB}&Swhufh8P^?hOjU-p=JXV{rWN%McAwiwM%L_P zyFwox5IS5LG&AybvysR@2ql5{f4oNyx)vtS$#J8S_6ABG@0UP>9rZzuN0?NeXw1v~ zOI^p9+e>r-1kD+!rW17Juu2}vBn^&(O?0%-p0wss+JwH9de}z*Inrrj$P!|TrEqw3 z75FL=^kVt)38PLh4ehZXb=ikc^*Q~`@kzZv?P|fdd;;&QI-H*OJ$QIKja$SsZN2st zp?1dY9nFKQIs`gtu`CnGmoj~eyz}`-|$KO4}=CxJqZZkCGJk4CF3TuYm!njyR_?3 zLUL;%s5)%0dT>)Xo?Q<4=6iv%H*dl%b>}TTU*4FeQvitEc{_c>RyaUE-SIjUkfEZ* zio&7g26tEqX6INgE3Djs*o5}L+?0hf1xK(mG(4HglWw83xe}fx7NUg?&55#u*Gs9V zzaY{fpW4rD-m)@&|L3cdxI`|U6TmKN>Hsg)IrJmFK+Omd0aGSBk*}Q|t^{&x*c{!G z|3P=jtyM>@Rww>XSprPo7Q*}syBntEpBf=^=5U3@aKmhj6fLgSU$Zo_e1&`pb&eO{ z5esuUI#QDK;x*z=9XC%xUP+#!gG4+Jy!>c5RpG+X+&-qbMH>i)?QJP$rV(!ikDi%Z zzjaGTn*hoiJhBh6f{sWdaxVA)KagpM^#(9^&@B%87{`8G^BASyTs8{pJAtyKx)TDx z)ugDe5PQbM<2oy79_+a6UDPQ*MB7J7q6_hBvbF#+`2|4`42n)aMDw;=QyrFDXh`WN z7I3eevxLd+CyETh`pgH=%t5W=eeqKwT`*TT{~D?-jy3Ltyyh3ei`r>%Ifx!c98Wd+ zP7W8=G7}Ea$QoBpdM5ha)oFFi&WGhU&aQ5TYdv(V8rnB+-hA_`=II~zov>fFoJot; z_|62@GLPc0J4JqTP0S-T_1OrIUM;?x&y+B@17>k>?VJ^1@NKBIf+A(j4|J#DoPuHc z+vrba!oh~Nhb|@3#d=IpfCmpBie2e!iCB24-F^ib%yb3ls83JusN^Au#?ns90EM>r zw`v5k@mit#=}c^$pz!p8X7ioOM?YTUlx%5>fpTWtOc!kwE;Lk&sLs%i(5Ku_0V?cY zBt|4MVM*8#G@qNU^6Nx_Y_9A#m+0)iaO`B8=6=*&8`>$e&n3POqWMFr@#u3npKmr|uGK=r7MA1@w`lJySAGm~#>xQ&&TG79CQn z;ITbIYH+4?linv&Q!(Z%Sb$3(zgIEFG($&zUcqJVWmLoy^BXp(^)I=4VdkUl)Wr zB%SRr&NHo^xzwG(G)NX-CTjj}#4Jtnr+>nh|Kz!tYl6C_ECDouV4!fv1DnxW?W5DQ zj^F$^3O=(k2_zX6=N-O)d2kRLfIds~h5soGSx{vf`CH`#rpeSm2F$QUWibxkv%I4sR^ z6>cb`c^Tz7;JF&&ynhUbqZr^Whx7LcCiRC2M4nVF#Vt^D6{W=*id>W`y9fC(`u!BG zk&KBuENw*acd!yEw+}G-XZBVAK^~&_J5P(4Ad`nK2Zcgw32A~^9G@^LTET2xyDjK6 z&8S4g{AVBf@r>1Iw{IrnlLJBGnK>S1GbXQoSAPs=?z%+3=l1j4>;AjL^aR(^55Db!>8~=zYfNsDx znpNZ+^tQ$|S=rAu=$^ZO4X%ue!T)}@OYp+~Y5_`g{jG69HkpW)r|z!Tsfl@xXba{} z{B=gKjNgmP3&U2Vuf`~663;Sv2Jshb@1|>Zbd1f~JiFi%9a624C+%kWKq03m4V2bq z*#&*moq6?Mj$uo`N9K^Tkqnb&t*cev6gwXhgC)hjvHxrTBDL0}z4h0tQ53$w4XhAT^?=+;ON3(en$G@6JnH3zi&LeGLp^@CNAPHZ#PZSf@ zF3sg0!R5i(=%#=KDP9$TF*F*@ohleXPdaI&%=OZa8Uu%DX_BRZ z!jS9IY~Uk}Q%B)Qe+;Vyi3xQy#|h?Dxg?|!3Zw^WbSC5utlkKCHlmj7opaGuA!{{c z>=pe_b*OGJ+~%GK^$ByKLqps!X@jAEFRVZzZ{?>ivV{^S$4g2bIC*e?oV28TN;11d z-dnt)hP)Nw$)JinF;m;F7DPGztzYjo$E;5|TGVDhpSxbrgnf)JA|$GOb|v9Uc|55S z5eFcH^n+by1hE=2Ag6&yuRd->X%5HjTi)kSov^0Eh$wA3kKve;3_r{=a z&2p1}-JV@~k&erVj;Yn=JV1?1)g%Z;*ig8Z)Pr}P5OVwoql5-(tqbFT$E{sRid*#| zts$&yoXyVQ-8@qJ#dYalmz-uF*hD%3bQn0gzCTxU3NTIR)Pexm z?#vGka-UrbYqRv&)3>~CHV1dz>#|lNw9j+gfae~g`dlyh0v;#;@3wf$6@JoJ(0lbT z-lruiU_wazzC%r}Ntx@LnTx*psz&gU6Z?jQh(nXL63q+$Mbg)cw$zO@T)IOB&oz8r z&SDF^xCh&s-aeurI8yh^<-P{4JC<}4A5Wb!3^^=#^L(9wNw)4UT@-AbE{2x=%|uX; z&DiU-uWmcrYL%@Z`vxW8ClXMzUPd5`d2*4l(c#WE0FL^5qVDy-QAR|@F?!X;oaro1 z8uLStPwaqp2Fde4oemrw;T$lBVT`Dv$I7jFG^ZbWlJFCk;11231~ngLyF&r^$G$xY zN@ppfU!e`|L-}K=Mo!K1jMpDzjd>YciCqvwn>s6mo2K?F62#*M%pwHa+gza!p6(yd zK;n&@*zN5-0Ii}p|05LhV%cCV-Dm18QdS>NWqYVKa0_JLiFhuW1?K8uTt0Nk0rSe^ z%O6U^q15wMl-}LkEnTw36G$CJ96X-3U>ej1lYCDRM@c(9F3>*!C9vAJkj8HgS;x&> zS}&{gh3>!`G1xz6;UbY@ydA75QiT=b}BqleWrK`?q?S#&}Tf2-D|Olxm&BKe`AxEpZ|C) z;!%iC-95-t;!|7m&mRSjg_>q4i$Stq|LR~~9v?gsN82W&7Jk?0dHy`@n4Cx+LINS=W&%c3o!=-FcAuH3SmPvh?C0FCgimWC@k_FL;6@fWMT&u+g%N zXHB!4YSR0F6k2Q91yDAiyWm#<1)zM86M*JiIpE3$%835wha_8J*i5%{`ZleZKg~)r zfMz94R0j4b<-kK^8f2DBn+rcY(`v>`d`i3^?mg^GXQrCCL3uEU^J3w(p7@z98Zq?g z-Y#S@Uls=WNK`}o*1BL$(QPbVwS(HjyKkm>MedllpWF+{El%xZti0&NZ~<0c>HaQB zJHv#h0h8!#L)1h@F`>u|=8Cei9(k1@w}S`%mm~6sW~O=Sb6f78V92^Sf+bxyO@q5uqynk>PpKBkppyr3as#x;Auf z9zm}hT{rtHSD^(y?%yt}Vx>;ww*OcjKTQ|X-?G?}de53xIIf5@>viZjo>c`W=7Du# zX*F`)iNmZrKgP$ZNb~*O zZO3OpN&8d3=G?d1NI_`1?C}TfR^!T*%uh&HU(b;py)w zqsT}XKc@&v#imXi-0xU#)L@n6H_?Ulc+eqFU88kQ4;;d)5b}6F=4WT*8q0H`Z1o$s zrqMdzrO`=Y+?PjtfX`<`B9>+f+zj*z4)pP9bEx*pkOhXwr6buQqPv2lH~57=%!6|7 zOfP_(p||EijYDag@6wP+P#TJyodyLDiT|nd*3cZF$?M&?aW3SY1@*=e#}-!pc-#Ur zYUKnjkAgm6&~%YF9@OMj|58@;lkNrM8q2t1$RdI~Zb3DBk!J02M&V0g8q!Z|`t-Eu z`}f9ZtfaJuUZA|T@)Sd@XzBYOR0Gm>Rn$!|Z8Nx+$PswMgBvDl|PuFA{616)s40%cBodE^eq0cq8SwUlH$q=`a|7J*NGj@$b=7r&S| zCc(c%I=+8po;c5ysG0vW3A$JM*3?R(XA7BCfrPHHY)>ejX^DA;$J1pOiS!pxOxLPV z1=a5r5->!_o}3wP@O=*kr(Lr*WJ_zpX~iwt-)WC%O`xPn1;4rS#L6w>n{tFqE1};9&0gy=58}sEvND(_}ncy zZp;Pl0N9bTqLTLiyWiQ_xBwlUYoJRMq~^!5&Y87pH*0IZD8I16%!InA2>}6d_GUM< zqvis;*4ERa^FYo~p^lLgZH~h7+Rdnoz~HF=OOHupKv0;mbP_f@a|*cSAl%L;tbGw^ zw!lCuK&Q_%!{ji$8p^M(O`1Pb8jZsps>nR3_8^S-_iI&na7O$sL|UY3vdt!!=K4^EuoP}*EA2(yN78P zAnVb6q%}4{WAjmi?ws8C9O?BcQ87E!g}P}K(i79yx_uFFRolb24f z&Y8$ZV_9HVqj&v*T?OTtrHG-WxtR`w$U`nRX6AHHnqzCb@~b=v^yfc);z$2WGgtL#&@Yt6emFaZKs`a zpy92wD5lL|jfu9mG`;Vf8M(Q{#^^Sfcz`~4g{3VnYB|liq9@d6z0&8-BC`f~fy z3DvWP;Pd$u4Pg{k&G3n9+`od-{FYqw#PyI%ifMC)Pq(sqYX@mItux~CKyiFW<2o(8 z+Xg$)QiH?!Jvscr`mH}DGJ&$ir0F`Vs5$J&4BiV}b=ZL&(R*DqqMgE=a{L%A34*@3xZx@4-XdlIv)zdcvjgCYLrAlSyQtmxc^Ri5NsCS9rz$K%$pxQ%GT~U5z<@%h< zYwqx`^h!=Yfl(=Lv_|Nw)icw`PnNuDyOswP@({wO>pQSrrzva;*lS8;0)%m1#z*kk zC*s~s2#X5@c&p>uV%yl`Hsk||TNt4zQjD*XI)1PNKW-rg zCxox?Zojl|uo2IBJ@V?R%}iEJ$Lj_|^Hhsbud(+fd|IAvh8h;NCzu({=ql8)Oua$U z1p3+gj0yQo8m~xPkdc*1RSKnlA|?AC0*8q*Zk`6Yq>h3_R+xTYc+xIR^MY)-aUw z&?Z@<^FAyk_<8}I z6RtE<8utG9%vYU7>ZgUw(|=cc{7^~a-)S!|B*q~DViOK`yv@PQm4Y=LX=6ol!du&o z73}Oa?Chh|7Xc!Zmk*AeCqgPas(%M<&!83k;d$xlH^gyG^%0tX1$l2Tolg7>t|&`( zbzh)b{AWQZIr|r#&~M8uFCLaH%#WlPb0*DIF^Tn$Du1Nt*=a>+o_?U$e;t_qyCrHY zqUN#Q(Uou?u%!9EGr?!k!I500#3lWhq2|dnZXUxo(rzoD_uDYe@9&J)8gZ>aDDTIb zDsleKogYL!_4SFImYhxoO1kom@$G^UCw+|&=%3oI6I*KIGuI=2fS4JlZdmrOXOhn# z$ro1mssz%*Cwghh2l(_jiRV6`eAe+{;}cvwyg>_{^^J6?j$ z%ZERFt-Rg(Y}$qEUDiVG#RP;Opd(l8Hm|(Pnt=c5YOa(2N-vv$W;iF9e8i!A9=~|n z-@jh%he}{#GS;nDWImwPs`Tb%{&~s1>Z}Hd2TnOnlr`x2D5`axCx~BP+c(o=@T?5V zAHP3oMZBURO$0w*;pfcFdiwNR{UB}RuRc`mhW+Tv{gzuUaAf&vpautQn7}HPGp==Ao9l+!dG8rXrm_a&*yYH(i>YpVXoy zOd2sVjg-wi!IAJq%AWyY7u1ClLDa&Ffw@7x=3SSiTaL1{i@h>5zY2D{5h+bnyi2q5 zAC2EvJxt^k#2a1;DfTpJ|8IfqKPS(s@Pcul1_68((*yRI{Wc#PG@!rmV4~)Gl@0+*o@HwK-YJGm?7t*6a^bf z$tir`@id^T<>KFII&Fx$wk(b-YA>5QI`u$N4zLV-`3Uea;#l{$4}R%+*@s=-m!NAA zcj~9l@mqck2XsAubS*hgZP(qu`Ngj045e7ALzRbNbD;j)I>5M4%iy`rGVuEBxF6@$ zSr6x>l2x0CNi`Xl9}zg;3sLrQ8%@Sa%&&9F9#2M>xfIs4jPn&N0KJY=fE8Ui0DIz8 zoPg$9-fN>K82Q|{N0AaUoWU_pg}|$8M&*P&@%2&IZ>Hqtry4>qXO7Rt1q@;O%Xj*& z`v2a45q8T{GeA}{7;4mbj^^bhZEjTTn9+qBJFA7ft;aGKVL`0TgKdJ>p)6V7A%IxP zkoTyb@1B1mZk_sm(eL|6*tq4xe23Zi`r8{klS7WL4v$Sg1m#B4>Ns{ZX*%6w={0D^ z)GUi_5~q}vGSDsP7rcqkLtEj~WNCmxB|s)OFbeJ0cSvFiYN8D0I(j58(7BHI8U(zJ zw6}Iau4o3oD@dLT>+XGLr9YW+Y&?9L`zGW6!2CP$cjbPpaO`94uYvkV4^eR~#)jH9 zR~&Zs!Y|!w3&Hb0dYC)BmVO*CHqJ*Jb;>l#c3h&1UwVBmV`p9E+atX64*Rao2cuJ$ z#b}k(t~et_Gx^}!VaAIB!x5DuQVQ{wCdRhXqIBBQjD|QDKw{?r&6x4HjT_?!C$tn( z;o%ZM6%FVOYcP?d#*Q6YKjZ>@{LmjlNzmi$S#_aFOaiQkEhX6HByls7rk+K!R@64D z-2^B^_IUd@`_0pNZznyJ<$~tMZ$h@Qa*Jmh_6bh&h5@d(y2{NHRTidbOq?Qv5*PL6 zMbE0W^-J5ure!(bPT!t_qn#FyR;``Fdd{jOfzMmsfBHc=xCJMy*<}T9eVP_M=0`3T zMNIyQEJ3GH@S-QXRG>o(ZZ(wV>ihwPNaV~HPz$s{YStf^S7xHQbOnXaYY*#Crlygq zN;W;OKdib9U<}-yy*Q8fWzt=E`!P@fO)EdMYYK!+r*XEifK&E*eznW74Dr>jR--8# zzdh!~IkVEt$_%LnjRCgvV(1g-cNPu?VOsls&;l)kF!RqtZ)R)-z$SziIxR@f_iN{d@@hvE(c#&9S$V2m*~+?@?~m%g(2H;8}6>d-5Idq zHe~p4|M}$J``!EJIc?9=)23SeNo^J?DE6Vt3urK9S1anE8UPFi!)?)9Km{mS@i7jkIooW^6RYjth% zvboM`PYCt&w>C?ke_iE(Z8D*PURCTE}3p9vH3A#ZS#sdl(#C+SVKu$DSI>b}v?vksSK7 z({IyxQNtFyL6g6e1Ph=re%)*Ka{||>fCs%O-*vESY9+D!2i6yo{VcdI=uS^<{$LFp z@&guc2#aS8VzY1CSozF%zhmlPXbaEsYo}?IDaa;)l&i;fe^A4i1NQNcrvu`&aN!I# z@N+(H^e_={c|EC-K0&&QH1nzhmmjrT z%$bvT3{>(_r4|JG5~V^U>_+ir$Q3-XL=9)L*Lzi&<;Go7zZ<-i2R4^ONYO_GMI_g-z(-!7p(aughpR zIWZQk@WKvZr^>#`9aS_i4FF0f>IZBrd~!j&cE92r)B;2`H10#m089}yL~wB9+Tbe= zaBwY1HjzBXG0Wj{qL^PJ!9CSm^V_XGuvXVuwLxm~H-Td1v{Dq?`Tl_A#}2iIKd~>^lOHvxG&63_UV4lr6Nu5T4x0&c=DI9Nq zA!l4y7^q`33ZRp%Yx(Fd%OXG}cLERj-h$0&xM%}H#!6)7O>a|R!LzF(R$TLbFagJ{ zJWZq4ne$$eu(N^Z8MX<*`*#P5@ojPtk+y)V_bT7B1 zFFWFoX)9H>)t9W0F;x6}EI4$0qxopCV#I2g?$=g{SBD3 zK2K(2BDoSE`h2xIbv5DU!qp^B6h1m8r|n#=I>Y?n#9Z-h3?*NI&gadX{po=i22D>Q zL2^RA4owPY{m+%P7ULkCM+cykf<7>Y2~&DmMLWx^>^)(0tIu+mRwxFX$6|#@w)iuM z;pW&J;Rz@T025 zNS?Pb`W6I#ZmViOfa7%hyParCiA$Je04@rWEw)J80SNmKyB;@Tq&I9~2LpohlD7XC zW0qV;XImH)S>~gKiRHRUE8x%=1|AdTzwfoKuiC}Lewx$Cd=gpaoMrTorQKvJ=#2#w zx-h_`aT1`u5mCp81kO1e;onSF6lG81v5MS_Hw4)Q4jAZ!v!J&c5Hj zD0!HFCTasx40}`q=LEqAT_Dpf#3hEz_lmE0(CM8~KqQ|M=oSOgnhLOh>?=A$Jm}H_ zzza-viam6J;hpQ=>X>i_Vbz}6MSV7%U74}1cnWWSna>lolhHhhcwa)_R_)1M43eWD zDTjb?)#2wfPEPuN4kvMtBPkixh|urbrUQ^)A%{KOgc+$0B9fiQOE+{YyNp;$a-hrn z2H|a{@TjrrHt%TDqmH&aO?GZENE(nU`yPM4`6k_M<*Co8c%6jlN}@Q!#&3^y$zOd` zq|kw3_R}VwAyfupiCk&ng^4fQjL0A!=to#KL3wLv90PXPYZURNoS%J8SkfH1<}*hR z^B+xk+mtUmB%2g#%xA^}+8A#t`-uE2(j<(dHUs4H$e=+#JTbYnY(>E>cJ0O>jPu6q zU*+?25ywl(`O8TtAi8-uujn&4>TUz(4hHrMd3Afz`0GtZejy?gl{cP}eTSTX@KIpF z+*ySfHmNe?uAMe6qHe9I5jX(ff29ci<5d(4D5m4WzkX!mSCyexh&8-B`*1U;;bEND zz@j;jT85QGz7?yFiMK7f(swb11K-YtdJ=t1x?<+?%42RdB|6dOh{#%XeZK8w@aK>; zS&{$S%d|XXR<0SozWTEK>|n+p6nfiLzAp-Iw10fTqfW;kOLP2ik;dHIVB3LAOsyXA zFPr_{c#;H7s8CNz^8TJ}0?A&lHh!X_?V=g~&?h{=dt>y>;;(7#AVL-_GLctk2;r_Nf-gx?B_`1m z{%*lQq`4^E7NPcqt1R{%j<+P8YCr|Zf%<32ES`9*5T1QkN=92SuGnm5m%u$+z_VSC zg!U>>|8U9{VyZX#VccEqW>oRjkQP<;0-kvNZ!h1QeUEhC*c7V~)O;F3XaDt;I7-XW zofF=+cCWJ>x8YPhvI=G69z2{Tr{E@KVZZZVThNehzP-0dXM<#CyNew$#q(okyvUmm zb<%A(&m?czhD>&@JF|C>j{DG$X7n6v#Kh_qrANaL_-M$b$(}06%-fSUcr}X(_F_~R zlVZq|n}VR7xQWxOuh)r!a8YSV#J)3auZUXuZ9Ai0Fz+@D-^DCc;>%Bwd+{_O)Z* z(>DmiC*>_V%yw6jaZ&&}Pp?3)tbL*$DB~TFx&Mvbk@Xv69TWON0?xLZ9M%7}e6E`S zG^yECr{uImX85awQ7WNFm5~9=tWPx$TbjOqB}-^k28151+nwePtW^zGO+`=EFB^+8 z{6PI%@4bqHmCqRD_`!@gx z)pF3II{cGm|3$UeUQP^^l>|}J*yNqgjnwW#Tl6SDKuCMR31D7~f{qD-msTLs+gj?Y zKvs*gabc0#W1$>SzsNLC;O|GxBnI4>E%uEO&~}V97@FK3 z`or8D&pu*p{uKoNM(x`5$@5n2h%N;w^nCo-y`BySsqU@ifFSN0TG`bp6rA*tJFv|7 zu5o8~;o8h4o<~{hg>c3AQ?~S9G*}$xhYuKJ`XnEpkC-{COljMCZWB-^KJKx_3CTE| zt3?;{IC!ot7jnDBy{^l|)^a&P>2kD^|FhO7*7D;IJ94nsOKp#bWs-OA(E6`%wDCJs zNIsD#@XX)kUaxMe*?LyNuKxW3cF~UMs<>ciJ|cYlHT^dq6R}ckNvVjm40?BohqE&=@N^7s;ywYg=#Q%eD4W}{?ff8xS&l7aP zM>DroF&9ozg`d4l@Mq8VF_Fjm@vBkD;ANT(#K>)J)0x zJA1BXzx$9y*VMYRd&f2SiK^_}do1Z|eCjeFHyIcHO8JU2smb&l{X|jJV?PHjmqtTS zw;S{d=?#iwgUK~x2U*(`L4_B1Sz*9gqxtXQu&%b>^GWDguf7ue1TYE zX86{aj|zHNNj*JAea?s6k}ceYjM@M&JZiLzP&;e2Qo;{F!g$dY&D3NEu@OI{zCkn% zs1UE)WXJ6^_JJ(litwon(AwiWnn2S&(6}%US_31V7BK)4sYA5Dnj|K`F9-Bf8UajD zMk6+Y6(``(w+-yC8UbFTklMhyWLsQN>`TyKNn-#ie>*ZW(l_Rr`zJ6;G-Cv2)x7$4 zBK1CQ1}RtelOR&r=jgZGyUzWR*MAvs=tM|Cfl9g@#WgMtZH^)#^STyAb7r5%y&k?{ z2D7L0#T=OroNj0KMMn(HtaoGoPS(S7`=BqSZ8RrR`r_v%wyF`*Zr($7w{us!`HcbB z(s$Y;o=}oFrZEO#JQXjVyXRTE`}kSQM7*oLb`EAobsk0KWcPGn&ib6KyOh_$ZuF@r z;a_hIvPbcEKc~)$1C3nrQrBDDdzteM@sn<}i#$|UoG;>jDwH+*V@>we%U?It^{4+b zycT0HGu1;Sh~fM+%^fdj02|DHvoUgrNK#gg6RiR&^F$PB3}ASlp7p29f^??lI(|LH zRhq4r8T!clt~Qsrv7VH%&WuN9H?QC=lf^r#4c^0ozJV`2W|+WEVkqevM)+<*r0qF3 zr~K&Nc^LbsbU^@?{&BE;J|5iDZ*~b8n~mO-eL2D32^ASr4}L}fon%m1;FD+bFTt@p zJPhjot2u7gO9_~s8l8_qL&M{hbVA zVHj+b?sD$T4X<}Axw11~+xE0hGJ2O_&uQkJEiIWAmuh4g^Rh)^uart&TuE)YEQw6v z1UeqJ;~u7-NG-Q4-}oiGye8XqB@9uR8kk%fuiAVFHM~+*8l*)y6FLYL6n0yfU8gf$ zc?2w3^P5wHlT>bnP_3jjE*Toh8{Ku zQUjPg(J*pX`aS|kWO93u=qj*-d6oPf3j&j-hJnE}Fe?zuG70tYxbH0<5*ro9xbyQ1 z<7qw7;Y5O#LCs}!;nRmRC)dRxlBehL=r1hXXc26Vup@d=9wO{-@GvgJ%RLch4Dw_? zK1}xr@`UH4X2%_m`L5D}xKVYWS5JofnHB8W&vr66wvOngq&N(EbAcLRWnVL#P|R7o zrzdCAotvY@xwf=@0eB(@MS-NleX~-CF(IaBpG^8hLJaa6doWGiwD=3Q72WG(!I(GaJWKqvm?&|#vJ`2YzZ^Q9}Y(E2SS5LRPT zSNjAYS9yhonyyzg(CkMHjuv$aO(-eN{~G$0y|_&d)>mO*#%5)Ts&j(X-<07gr!+XMo z3*(Bvr6@s1^e3gp(4a~6c>FcsaqS403eM?}rznf84>?H$(xBq_zPuAxZ-`p$<1J(6 z9pm&-r|2E<6d5ggTn_#RXwCw#59@mg9AhR}tLaE9@mC(G2z1)IoEGBV0q{jZ7LLN& zKA9k7(KhiGUz{l3N_I$Vfd|N)n`Z;MX#u#Ssw2V^tEk7Vvd&K80KY=vI;xVMAl(Qw z4)8ag6u+DP^UOB}@$#>ZYT7ewB&J2PqeBB3B&`cI$Ulk*TIKtjh6%y66jLdDXz}2n zxBC|>g~_94aRO_H044wfe-MV3VF9q#TiNj}IDq1Y0nZ!h*+)IK&h$WVo7TB{?0maJYZ|kx4g-w;W`No;jcv35N7xl9Jy~sl|(E z^%nd89#pi#Fy$;kg@PKOI{bG`H|E9HS?&JmLezA1D7<1=5$Y>mY#>ECG}sUX(a-nZ zAINoP1S6GxBbYpS%VKRh_lT)B;p}Yesupf!Z+6mf*M>3htKZBV5u&lG;IKz9=jT}3 z2pFTwrgOarcUFEDCaf}f0^-KGNvSJ4%FL!w4cYa$ZWsBykMFcyxe#XwNUn0~uoYEVlbnaWAt3 z;5GjVO-L{VU|RfO#qRkn$V%*QyWiAi>6@hY9oZHMyM?*$mK>_doYS9Q_qZX#igOfG z*+dSUgEL&7T(%}?Y0KW_*nWJIo7N`z>5p7;W0y3bOZ>u(BawI zaUeXT|7!r)DPBlz4-4Lu77B*^!7T(%PX>YTGcar*WVl3~4sbGjhsgyX znQ|aAtfyDAtnVIcr|y(?`RoXV8fG{93&m2NcRONu(?^R@0TiD0cu2_GGJ==1R&1Jc zAIb*0*X9hNM2Da58dSmWHnO65J;B;+qA~tvbTP6bocd&k^Afz~+SpE98`TtpBGDf~ zc5M7CZ~y3*ng2D^)*o8wrO)gpylgZpV_WZ;t>>$$obw7C+h{bFY*869t%x(&o44F> zJW6U+yq0UB>-*K9n#x0pDk*~p_YMaK5B}5%OpSh;tcEgF3}En!zfKwy$PbD4X<#B_ zytsbBBR{RU)AMoTtA@Owqu207c1>bJKmQ5e7q*<*4#znCop={L3Dh;h!lebsHi}0W z9G`P5FrjYx?SwU+*;YwhLZE$c=FssM#)vCw92Qy{6%G7nYST$9MN2bWd3Aei86-;- z=wb1}X*bf)tz0Z8-=}-D=-VilL3fkoE1_sG-Twpw90YkLtYaf#i(SBSsq?WCAjVn} zU7mk=Ic5wP#6%!#OC|xKkqVP1RZ=miZjiFq^B3z$arTo+k{@tcZzM{mAGnk6vvLV9 z)a#MvvmQ1djaO+RU)^up?;a3XQ6%U$PiSAe(f+WdcG+U_Qu~m&L1X1|Qbo*cxXO7Xb#AhdbpCn69~uv4?VoVxBbOpQQ#~=B7Sc4 z{b;rB$((j3AZA{fh#D~;@sqO;onK*v3nbj(bH-ebPosp3`MrW!x{}>^gU9D{7 z?@No7WXal@U3L_h(_Z0wj)-a}7gTLgC{;{N*$V%tevKOQnaeSgxLJiqwa&lf zh%*K5P^CbO8!R=|yx-IJeB=|iW>3Vy-#Wz#|iQ z0*6OzU3Uhl-0u zm}WXD?=pbUKjjbSR@f`?vrMEahqEx(9E-D+XkiJ~zJ#;0BWT3M;_2GwqO1h6FzowC z@ltezM!Q--0=^xay8*7>YsjkBEw%5+oeFUr$dx0LOWOT+gnF~1*Fi;&lIypWLGRrB zbnd4?rf=||UK!mlPF)b)Vc2pYq+$R-_;@#>Zy7X605sMp8>5EOWy6>&62OlajhQRZ zu0cq)s|pez93OxcF5gw&*8>n=+6txql&`~!j(cv>v0)Xt;(VzhbXZKCocIjlJ&*iF&(5|yt_{oC~8 zj}$qtC;FP==XXN5`RE>$+WjcD_Ie}QWrBCHD@@QVsc-x=12CP1P?lxU;IQCO)(cnq z68*o=UL2N$o`B2ng?RxMUyBUnG)M^2%g_uq&Nkn7jKCe*B-9dgZuvB%U{RkC2g$#1 z<|Aj{T&DyPL5gzanm}+!iFqu?M<4JZ=*^|5eL{T@qZ~E!4)aG0B?S=Y;YcR@&c+3E>aB%>s= z0_~5nv;a=Kg;Qv#>#{tF2IK2z)Lz8=Wk%{ybj59IVsR@ml?{ZulM0uf>@%OrW9mZ1 z7d0s*UN07&w<+m6<5dMiXbS*WNR?`<{j*d~$pRBwdf&1T z&J9W1iSx6o*uLXW-xgq3EHgMX!DVj0MBy(>Y7RL#E936~MXuZz#)UXY03alQARwY} zZ&y+TJUR8zkYz$N%O4d~aMnEtFb^|AQ?x~ZnSS9Taw}i57k(k)5eIjxsPKN?>1}nZ zd6@D$y9-`}3#-1x)rns|k+|=kDhTYyEBdAhvcl)tEYa?lxImx6iLc^vK{sh(Gch9x-UpyNE=)_O) zbpI+R?2$$b`udwe@tL~C50#R@-^X1fPW%1MJ&k|6KaKruOrA_!CA~$FAw8*(WZ^1u z9-bN#@2e#Xc)7Fi97bYo@~rk{w@mkiXbRcXNR7`0tzncU*50L1+Zg7jGOPRnp6g#@ zbonWpT<|YXa^yb4k*`6}<+g<4MU2a&NsZ~$VzrUiDE3jO*)mRMKZ_y(T0pLXL{Y8N zKK3aZs&1lLka!qsz?;zySi%&1zHW+4kiZ7*lSA~yg&y}Z-J4PRp7*%#-1A-HOc19<10Ai$?>2?m(xTd^D!Ge(rmpZ8LlhyiPHn{%T)A zDVGhE>+qbhGi%)(hmiy2h{t2qj#TNc?ocDA{CSGeh&+ld_?uusJtkTbC`H*7mCl2dN zs>jM^Ut{Q`=;z0z9)dbXS|{t>7bQ-AS@n56JXWoUTwm>Mbc;+!oD~e2e&+Hn!JHQ_-sXvjR9hhQ^l9FFv#w4Ul!1$0N5|``m{(SH zF{O@uDcrPtb-a>F7-S!jyvv3j`f9qoV5{hyO!jD8{qEkT(G2&x8(uV(@}~dr>SAluZo_1k7JQD&Jcj z8rUed3j$t5tw|egl}2>CvT`!qDgGj+gZJDit@;N~jh`0EuFuOKS_Fm)vHpXIRln=) z958_0f>D}`ep|lpCu=P2q$4qh^5W>L%L&T+hx3v8Jc$yMk{TnweYf|j8GPt=4eYso zEA7%nW}5&|NZP-^1YV2&}3YW!cG`|MS)k>Rp9w2Rf))N_~t88cz_ri_?g``b(1Jd zic$-W%j(!VtUb)BOk33P=W#9E@b^) zwj>`N&0!nV<6YZB$w$X~d=~1pfhW>Q({Zhh2@66RjAF8L?28nJ<^ygTKRv&-TG;| z=I#YkFrQslRhrkE4J!?HP80SbJXzg6k~r`;lmxdVE!Dl~P0$jAAvhn`?4CQUAVN(< zgs+oQL<#tPzZRWsF3=1%6S18dmW$h7&Y|ArNy4QY(| z8mp3Pj8leR*w${w*ZULyJ&^rB0nEoUH~TkuSP8~5n0XntKZB}XuwkNttc@cHl_d-B ztZ~k}!Vxd1AJ_PN06V4yCJR{C6L=!WPD-}Gj)GdYPPq5DMKVydS6n|q`!O)p%P_w>aJ`JC%VGdB|)_DE;4YM^daS`EfSdltjVh;BXMIL5p zk>;(2S~f?`_Wn%^<+)yT%hF<5blRoCPQHVcyXDq=$DrKF@QJv*c)lrV?w>B2Nmi=& ze^z~z$JTB;DT36p=RVN;8paU#aRp7^WKC!dGVw^0fx0as+nt{z4x4@x&w{iL&w%(j zH6Td_K;=aMc{~=(i%11%WR%Ce{y|Iwd(6{EGU!2)Fkt5xTq(fXGZe)T0`1UNeO+3X zoqJ&l2C<7YTjP+cJsOJWlMg-k=-shMgIh&06zoL`?PnVrY9@slyuo};!!byF;U+BR zb?9TrEYME#=&yw`4q|@o&vXEvmQKZ`nBSPQruf6HT1?J0{{Gb;e?uO4Hz_tXZFsAw z$32P|=lwwACp|fH;edOFa{`;qDqC?#km76+n64Kc}#C2|UF4P=icHmn4)vO;}6HgI#{FEl^zZM~u0 zS`UcQ=5CNYO8ZI1Lm{kYoC$t9$7}O-QZjlJw03)) z!d&x>aNnLkZVbXJXt$okj@~VZ7lO{8@|@l2(eGC__u2H@2M886Hz0QzH1| z4SwXGm#E0LLm#Gl>ydC+saKAq#4BT*Dln7c2L-BvZ-Os0PULPgtqG*~N#J-;L*BO2 zDlQ>8QFf~cFqwMg`tdT(S`O?V!%7Dl_ z2-F3y_s?ez1Y1P*zmE(adUHuJY3ILbYb&4MY=0|!7NUnPX|$2mvcq$#-Ti$?uuKM} zH*6tCSDhr`hSO%&&VsC82wEB=%yp}Y!CaO0%i-3ELLn?n3F@{|)X^g3;1~AH&i^&T zV9D6@aTePEDpY8R3e>#>GNpzE5x_0YNdqn9kS`f3+T|kJQ5X>Bw1F0)@aK+*pNtjM zy+xm-AxXt?zR~p7ehpEg=iIsJ4w|noK%2&MN0O0+ei@;+BLqbp7Qe;qj=SWHJM3A7 z?zz$X%L7hm^-063O!+oQyluz)n{qNK$)1l2F2L!kw_y@gTtUX)72gUSzyFr(e;ZLE z)g?g_mMOC_t>^GvS+yLtPWAV!4}VhCP=W<7 zv2N7A>FyP)m3mzchMzhFnh;kXP@lo!Oj$u|zQd&yG)q0t6^p)p_?Xye@1u(f{jWJm z{Cg_!w>TmNcoqC|<<9)+XzVe1C!kNmKukPxma_|Cq#gYz%%AlUOy=@-;j_+KPAaeP zc4V~#dEWK{p%Tm8a!EFm6T*`S0`0@VL&h`VK?$Va$Qi3thSR|c!R8Dehz$#N1aU4q zf~y7_MxkJ=QGE%;d+QqciGhlS*l?&sIivrY18Z@MslGlvH8FalPyyt=sfrDdj=a0b zG5XL2Y6k_<;<3X5&T41nF)%{r8XFeE`CS{hkVb5~^I|veEDJN7|1O?hA7@m`ZV-is zH#x0`oVwXA)X3KP#N3G9cc{J9WEbTpkoR@+>eTd|9_r@BVAs6pg)Sx?W-sj6U-uLW z@aNwp2|#3qGlWsFnKzV^E8%g?JNSke!|vl<7Vq~#5#p1aLkGaU%4uirf6vR8FZJ6~N^eX}>0cqg zvMfZ#6%>C(L=i0sn#e)Jd$Qpb+)k;d0mTufaCF5tpl%UO6pVgN;7b94_H%&X;d6#78fJeZq*>WSY6j+9L#Ip-y!-n?bwngXRuW(MRGIPnwQP7v= zR8+Um*llk&>vA0g)BWML$-|AMIT_x`rJX)ry6t^O$Kuf)#yploCL9M*8#-sETQ-YXE2~XLd14;yeZrG^Eg^7sv7n7j) zjBH4&@C3*d0@cH8dYnneZG##&7R>-Z%O!WqFQeBm*n&u;3(Tr%+ui-e24B63%Xo`C zXoIZxu?`cdWs+wFk3W59bU+yONU5@?&(5u}b0zMKnGpddmSuC{APphCsfh)WVWhPt zGL5yIM(mYmnyBCN^Jus8Rk3wG1L4h*M#+NhsBU+sb2G$?&DoW3z&3K9iPiaeC2M+P z*xk_JZb3yiRR(KJw3nt2qcG{p@)AOrXZY=CSCj~??jH2`!z@J{243v9B*QvhO`V&h zRV9e6P!n0TZu)M}lPfdsAJ^t|XVkRW2Lt{12dMR%+EUc?b^wGr7mK!{5Hw|Df96ALcJ3K$|cter!Z zBrvfMyiq+4VlbyiiQ-kt{2cC82-RHOCm-HPr(Sk3zdzIu$_wP!DlX#2PLjTKo_@@^U6$q*;rt*bS#-sNU_yA+Hc%-B$9fKhzaV-sPNvKCN;8NDMX{A6Fb_p>QictK zChHxUpfhn|`MKprLORty3BK=Jy4!z>8)^dBGkwMxhni9IU=hkKX7H@bMSo56rdfKB zsHqdvIr(Tb7ekQws2nCg(AZh|UHJ1pc4_kt+^+ozP+Yu2{CLidi&UUN zQ15XAN;cXf#D?=?tw-OfFm`%Uyw^bmcWNwcL@j9 zJ`kM#1iYH#mVhhbXK+)nIS=s9W`~HMz>Z*$e{e&h>L8F&74J>1m4q0t3HMI?&BhbgO+R`5&a9H98mQV0@KO@ zO**4+5+KBD(G(Lf;Ix?_LNJtZ`=8h<2%f=Zz~*1A5y8NQZ75p*J4MFrP`xxTa_UJC ztq|N4n0%yj2SWPKPY2^7c|iTs?hpxE#KJme2~tA52-t9ZEWw-w;@{y9q6H%lzuzZS z|2||eDvj*1Huz_kyLOkv<&wx>e^u35#qe1xM1|l>7ry{Zs|xpDfQaWC)(UTXL^oQ0 z=%BpvBcst^XR%+FANL7F`u-OC$FCx?24sQ1W>kn_j-e!i(~}rnOWAEN9~4;$)6Rq_Q%{;dweffF>s>p>%h%|m7rP~41_!h2}=tIe|?U=jgj-J zrs>yedIP$T`t~OocEyed=`eo%XH|>$Bb*w@Ib`Eq4_{%4D$rtmIze2E(M|#GEY4cz?x_uIuirZ7^(F{kvNtT+TJEa3`tS$j@xlEx?Ay_oCI+)prvWb|7)a$m0WKUu^8Fj9;`#1Cyr# zcBz;8(Sks*kdAq!ws$eu^sK$)~vP#o$K2-53fA+PKxMWy5PXa!;F` zTF0|NeCMmb8fly!{_^$$gO1nU}iWzV&DPp@NKfezf-b)nl zwQ_>bWoxEj;ri}8K!EVt>RgcVtfkFv>F0&jL;Aj8S4QzsIoWwN+mMSyU?2WNGiBkS zA6mv3;(~5XFu@Rew)}xf%CNc2WlYfHerP0xUqpnRh=}N4gaX;JAMlm(r}!l#?5ck4 z6@&U$XCW|jqiR&m;aPC*BYCZQ3aI^Mc1tM5$13A~BrrQ^3Ai;#(Z*&s-w;*N!J%b^ z*uv7fH@t?-&EzwDZK{%cv+J>(zN+5(8UHer z8NHZ%6iKZWzWs~=_ZVB-zG^9<%hX_zLyi^SVs(Dzt}aIYr%$;GZ`j9>dKCPk*P+Cb z@=ny~|Dqb+y>a5z`e0>gWu=n$CN3}#6aY9Ev|%AvxGU73dLy2;VP4-q0fpUHxt8r{ zc)7odxKd!r;QXvV6SvouYA#R~+CHCuUVpgp*ZFX%VSz?D%*U?bFaI-l)i*mz69K-D z9UlM99tKMj6KPU1GL>3g!QI_m=i@bbUI6na%5J+R(dh~na?_gwp8W%yTPRHeLq|bD zc2Od@Mzze#PLtUs*f}2`;Td-~MYcLb_I~S$+(vrA4>)3Qk%hVI*oh+-3PUfkjQrW) zmnx%*q7r#7s-l9-B7Jeu(YO-<{x&u?*BJkz0;U_~gFi0rb8gECg!h=%0UPUcq}pvP z+ok32gO;eFh~PrtSFOwAjv_4NHz*109$?zM?tcSv-k!!n-nZR*)>bhke$4O1l}P{! z6x}L0ew8qOd8xUTKK!9X-2Yb2u*H-9v9aZUNyLD7!2QCuUwcPKM*tZ5@F=UaFuOCm zK#OwV*AA#(3>OFf6^w$!Zw0yyLC&6>kCDl+a<0qpjgq zdWl#DcVZ6>WzfH|hq2_yE;#K>G6w*r%P5?}!26g#q}r<~ndn-GJ&ihASQ4-?UaT@M z2!hNH|%DLR*5FS^TrjJ!j6f};B%8r9vUCr`r<87mZ z1zTppkWK-wL~y6tc=j%sF;Ie2k^b)JAF^&gmBeWNixHniwv-V1b%ZcX?us>BUtwoHFl(|$m9WRCSe+kW` z0&mdZK!e}Zw)2DI65N~3LUP_VpnL|MU)a0VvgJ&GE6dACBj&#Ga0p+ZgM(8iCf+fL zE!roT|GU{Nt0Es{ksm%P1eQC~#?v*<`wB8;g(tBD>`f8DA|oS*$YI+I)&UprbMKp` zS0liV>$7Qq?}i)(2nfLMCpGl2dMIHZWt8y5r7n8hHi1wui2Hx?TTrIRM8W zK;t(w#ZKsH{^(~wr{5SY?B-E3)qzY$9uy_O-Q=*x;zc$Bwt;!5)_VBsw+mD#UIJ35 zC)C$|1|v&dstDI-Im8&iFy*IHwt;PFeH12sc+Jn$n`|*>h_5ztp{+T2W89ev}2n?@hpDQJ-68o{nGY)`Ea+fQ3#bM+xEjyNg!E7 z{h_i)bN1o&)pE;+X>c5ZJR%CCv7GO z;HAm^^AIajM5ZqV%;4WtA+X0$IN3o}NF?A?hdPt<{&57qfa3W<&eOwy$S)MmQV^l1 zN$TjSzF+J92u-8kjjY$|HK+4kp4RW4WTQ`F9+J~Gx+OCjQ&eWSr*-UxDSnBhb+s7& z`nR;N&QEnus~4Ki0$c8TQzr3qP#PpP%fIZhj{P_dKltME$xz?|Eg0Lb?9{J7O=H)E5%e)LADmXw?np~A`C=Wa1lglU6A8F?bH0{Z}s6xv}EaKOjNK8 zldT{A$%w>7>PezY*(lBC-Qt#?0;T`E6%s0<(1A~^X4j`X{fa|!nwE98^CqLIA{F)Z zp=paxTf`0wir(HnuY3i5AUm}s?KWN zReZy(idXy<6wq}cT-qt6uScv;=9)A1kNf85=QDKB72moD%)h?*Ri{RGDKzrG^5AnE zUgIJUakJ3+k&&6zekzYo5_gm^)h>_>IegsdW=7&_g*U>c3zv-7@a?=wmfD;S9~6i? z;a%+-a2fx#gj&>`LsdGX>BwEO?6^2hq@3g*m{=^-HPuCRR+WM5T>nO!i)#$i_hI$_r$M*ZpX z&%DUd%g_KX5byWD@$J>XhQy%Oky+;r(UX9CUl7dQQG6u~9Wz`pfs}@#wD;Y6dp}Je zjCTEfC-ynbz{+j^n1pKuzw@k^+~sjefd)!_B4GnJ4}&p}`JYBs+bduHGarf^K>j0X zLSj-@W8>8qFbqe%zOG(^?{>vT&qpk>`l7}?M(_{#;Ty&O%Gf#;bVK|^K_1Q%OFwM& z3B%LrBETCd>fjAM)dA4oI}p&1v_?DuXebCi%=W$P?aSb5|9SDvWb}3{F7Ya?Fqb^n z-!=dR*^OT4dHh?-tZ(!~Sgf+#d#6VC0JfE*J}DJx{XOvIC8X$tp@%&_J{7Go8UqJ| zWLA-5VbOt6K!S=@)v%pz=~~+k9sT2K(v|_LZk^q7s8sZwHcXk7hIR5n{&E3ZPFs;l z@+&_bp56rkqCjNB(0GfdmNZplJu2XKVz+;=U)tA}VS^F25GR=5K0Wi;vNx)BW1eFtDtQ=k=Wk{i(Z$hY(f$4aIl)Xbmmi ziyWo&vFD9eZq5O@ZmzC>_^zp{w>0+O9?DPFy-w(*aBxMp~+mx!%&_CDK=!y0YA9?*EUg zw~lHn>ejt?2ofAxTtkuKT8cw(TC9}fZl!2(m*7w=Kyim+EneKExKpgS7I!Ot^PcaX z``vT%PsZ3I$yj@4&$ZW@`7d*M5hR>jX(Is4h7sN*^P4f0`w*4DJ%g6 ziW`Iuo$rwZV9CEObcQOeM?Rvl&FhJvuYDQstdc`hBjM1AG{Rbi`t*-+dA`L zV6%lMM7OPGH0anB<$qVfgY{8HwrAbn$V;_gA@2*8BDd!rN-!3)XG&T?cDtbFA_Hh0 zy=0yLyG;epiJ1(gggUyu*>T?sPNpn-8e!jmH$#?N((>W(Snj!spMAEDA>-uL4r?zi zo2<83L3)@jfhW#XZa^33L6HVMJhyWEMHxg^mINj25vtIB=i>uja~x_GC|>^a2a^@b zjT(lRJqa?VnRUh&th4{{!G*ofULvR0$wfFo`b_E2U9?w=xR^4k=@tlAUng4lc?_{% zX$*Uzh{-9`YhNx96dn@7$O*Z|pmq+Fi8| z*zC)5GK)Wz{z~|=8fd+5E$?a8gP^7!q1G(LoePu-fJ$p<8#2VmWy|SVE>sE|T!=>F zo<(hLo_ZUB4_*eP^1BvS5Na7`5+|KWiL$?yv^L?TdCSH;7F3&y7G0~X;Z4DcNlY}sy8(*?XcW)+he|_LtG#4iM1)q1|yKI z<$NdmE6VTAH6h$4Cx=rdk^k1lR=TECN$Fm&>z4JYq10wqEW*Ekp(w1#;|rGjT-%#b zs(*i*czpsDeICL*6A)32 z)<}U1otu3AXap8-_v}vKz7-K?M}@ z*HkZf5VC)n&dkg#4@llXm4W+X9@4_JTWV_FIStL`?C}gW8b(eZdt47 z-^73MdU`%LgXOG^`i4K`Q(P6xRYBT(nwnkN#742!QhRkH*2v*VWu4yi{Jh8l&mS|A zymPZqHhz){jVJ1fo6cjS!$MPUQvuR7c^|)52lSSv8Bfk03)ezX*WP%MQY%SgLwZ@Q zOu{lLFCxc&RiY4}-;!@u{P>Izk3Nv@3l%LQ#pHqP3zCejH5!S@c~kQ8{`}?IKv{3^ zO)s)d=yZOD#@*X*L$d}7TG>lwVXJ^@PXK}Ej(#!ufg98O{Gz?J%ouMhH2CZJQ*!ho zAI$BhMU60K?gFWNm5gXXm`2n5NlA%AKXoF|Q?;(+cs$yMHKzIGj`cH=ZPuF_XVma{ z{-4AkW~uZOeuq_xyl0=&C!_5D;R>|h2RsAHRB;jh6f#()**Hy*+YW-Davbz<%$HgH z#JQOahbWTFBy9d0stIuknPELBqGVIGuWNZni0Cj(u6H#6gu3evUJw3`VIC7(6xmP`M_<;GxAsB^ z!gdZ6j*g1^?31YL-)Ab>u5ub0$W~Dlu`UM*Cc_a=-Iz?mj=qleqgh&@(eb>lfm#3Z z)DTMevg4)b3yM?Bh=$$Wg4MvJY<~iu2b2kpjc-^{In8Dj4ZJ&DJJ<$uw_o5)baa@y zyoJO5@|Vu>JflV}gI_gy-SeCx4kR3u%8#FY|6v2+`S3){Ch*;Cc1hIXDuZvPbSaSQ zpuWULmDqupjHnQXl}HDKU7O6(yrdFxOJZrgMU$$t$}7%~D{|mGdXL{yxjwz`FDGM9 zbgM3{N3Z{EsY>JkI)h;wq*pCpk>9nyCbp<@*?ZG4v^UqNZHdNBv5;nbd<;i(*ECif z=lqsvnUnLKU^c-%kMz6GpAc+EE#ndn^d849C;I96m}OE7WoJfF_11TmW%7!aZ2Ad{ z(|5mlNGmxzK(jOrxo`gFA}K0@FCOZG4|4b$Vb5^REYHBx%YTUn*dtf!Du`#G zDdMffZgg19LXhM`I!*oV_xGIPFBEy|>=)?Atf{)X=-1Z0f}rqiakmz}Gxml?@0@&f zNggSI*G(K#y7BSqj$3=KTLg~nYY|;}FGgQhka&*T4>*$`o1lfWQocs@7vBl`ukmsk zHhrHlC1&n)_3&6GtfXLwVRd(1>=S_bw%63uVrg4RT|8*V&{LXI>#twEeDAo%^ON@TDCK4jzxbFozBOLr#&O- zhNX>k#&jQqUb!8)eAsAg@>ngH6^D6f6TOe8Va1Reen3rJ-#fDqn7K8UAYr$xa@nQj zMB)>z-fQnk z!-esh-%BXqKJ#xkP7K|jWF$4W6q8bN5&i8raN~z6fIJC^BmqfI(Sq6K_i4dR7i}tu zI0uKhFFc=HBV3J2yD?~e;OPRQ1nh`S_x301gTjT*k!j^=403@-gD6UY7~fDaG!nWH zH-7yF7v<^J@xj4S!tLMhm58%^M6YJ8IOg>v0{<8&I(8SSmRoQFC--&u5z* z&pBmemN8@-xK*=i=NeF5Z7+2(?Af&X(zvL;(uYi*JJ`o8&CJBm%a1`{y^@k9xr{va z#MU%LYTrBQ)~b(C9>3^!CeO{GZqfXy+km6WFA}Mzw3{s61|3v%Tq%5VNLiU~F$GhqG z(X>W)VD@Q}8rS*_yZQm`&DLi^iH-ebgWa(eEujecwVc=Jwqa(!)Lup0bqkEpwzr9s zkQ3|VoP9sz*_zS+@LB`+2l!iQO$PLo%PT2;FU^tJ{->aLR$t3%J*EU|U_T$_KVFj1 zsP3>wiSF+wv1&R75%a8Q`v0y4ZSe?Z_8Yv%Vn=bMq){+E4cDt2f8%Y64i*GSXQ(yr z>_G`uQyzpB1_y_#Z0hONjU90Uv6@8ZAWT!*3w6h`pR`fiu~EM_Z2XJh+w*7>P2WGD zMpe?^;0YucRfS4wVXg(2nh3P}d$dt(=lteDdlR3aj%F`R=*8baj>&cPlP$WyEcD9VMIfW!-*Z#Zx;soyo&mm4w<{32=d0Cda zuTgp_`p5qX-MWZIZbp9d!$L*SNEVnK;G$bEcBI|mJ6AGR6|aD`y2v4ArIc5SXuc9@ z!n83leLCP^tB4O@N+L-s)*kRJ757T4P^d{J=<@a)m2S-G3RU!?PLIdlu~ZJeWu4MC z>s9G77kce{lyrTXEE3ZXNz~v&F@IwNy3NY9qjD*brVCW&2nb4FOEJ zpDH_0InZxXuk7-_C3s(piP$E33Fx|5GB6eRFanK7a)6VDbc7+`)Hj5o5~gyZk7>Ky zGoVfio9L|aEuse(RIgC#)gM~2(iEP>!FEk-pE37$Z4>>r-fc|r`%=Dgao8Dj(y8Zh4BQTf{5a_RA) z5z7*A|F*%Ld^;)0sQ12d{&W8K>)gKa9N1@f1tS_uy^WuQohU5Dt(_QzU!P-f1R_%1 zNrGN52vPfjbgg>GT}+E#>3R)EKQ5qs7e%QZ@W(icu#x^z(ux_0mhyF0E62ciz^7u2 z=zd(7$`yrk9V@q?u>bxp#|h0tsre_tCC6pX4nyj?5GkW;0hvnGk&1@rC4vfC`jA^M zAkWz;50dCD3TW@F=~#KIUSW$BI!wfD%2J<`TZehmh;~o;^aD(Q%ZY-P=hx;W20}5( zIk2&y5DW+?`X^9MMMamprrl^Qc69U4pAj(er42+WY@6JzzNNWt+oxXv+gpo1+#f8u z!V!TiB@iAWNNx&~&B~*6|L`FC^b`ZZ?g?hwc1ni4kW>vsECY{voBwxbF7Sn9i4m2; zr8XF{$Uv}m4Vsm$8Y2v#E&Zbookhf@j@Tq$yQgw0&bTTF!CY>Iew2Vr{|8TOV#gJJ z|4syko{aLtA2@S$hgTw>8igJKH=_xHur@`Ea1`hus7tD*6)+d10LfZ-^3$QJr*nsp zT=PIjV0`|W6)*)uPUm4H*HF0#6TG_E=S4lpG07f%hbeVNL;T%~mcxlN$mzg{^-d_8 z$SavgPg~T0Sm^T}AMKh##KG~#J35>-zpU<8`WXp#|FX_gZ)wLA=q_UFR5srNzTLOD zDJPGpEG}&XZf><2UUM0bXoqfF7Dt{A*(_Cp3D7B1Ct0}K zVcl3Il6+{9Nu>o~nMRgk`Peh04>qQS#g-8+>=($%Fek$fiyfU=AmTj8lml@|>Hf@# zdCo~XgE7;I2HdFhrdGZqEC`OEZpQ2C{{7?gJje7!9SW3iV*Gn)X}pW8&5g}z8`@Ih zhS}0BwV>Zwi=a{+fjL3pIANYOy2Zzj``*12&^@g!qD*F&D1r`x1LWp*+AvfStrZEo zG&$2*Ry?hI)jCVZGhoK_W&iDM2s61wsy1yUF(pdjNz+dgY}bej;Ps? zF&%Z8MTViT&*|Tf3K6=JM3+V9yyvi*qo~oFeum_>Yu?zxG(AFUVPBm_|CIQ!2MAOUl`7qvhxJS6?4hQ{U9-emu`X}Tcu~?-*F+<`HB=0OU@d86PzlH@ewXs z0joKFl6UltcIU=kqob(DSDOurfBMfI2+E6v>W}B-Q;OA{Si+rl`Z2fWguRcRnVPP9 zL=k*-^$?7`7|}4h`*-`?njm<*EU#C5)k6mQgKs};oUV&V2Q|0!j*j!^gU_ReZpD1l ztr|Y}|Fi3%#zTN2bMVE`X6pG-ZJh;aM0!)H|4D4fn z{WAYVn8W@sY#2cBrJZW!pi*8$&fJ^J3H9Jz>28(7DFrc6A=yE}U4e37(<7)8#hhw- z9)qp0b`l1!Ts4UW2j_GgT}d@CEyMhEcP@p>MIF!zmPi8r(B;%&9Cco9rjKKdVD?EJ zk4aXY{0kWGrf3NVGf+FXChZex@3{tk8y?(sgxit;T`oGlHnHQ%Qo!U47>4y7JGV!e zZWNO+2dM+8q+?)2#sxt_(y3S>>nveS2GotxbeT zyhX%d%ybxw5p-clRrkfXudNe18aGsyqyILpnoyG>lf;0i>k@u)P$6M?*}wX8@R-=s z9{+cMBq!RPTks)T|P4-|JqVTY$gF2xlXKTwYwP zJ6GNPeI8h#ah!eEUsv_sz<->9EAt-N0L%oWLC+tw*)rB@{z2--H3LSJ{OY+zjJ)zuC23-VI6&45Vu~q|X^& zzSB_<-nd5d+P+|FocPU-KsJMwdMM}7t07A+wP&%DVq_%KOJZJ;C9q&NMc$;BkNvg)E^rv3Ey;*8RV2b&BaXxh?c|P5z zB7BzLo3?v9?(alyaiCI%$oj$qM(+%q>DHbWYbouquu;9}2{+x5B6Mf}#>|-y6r9){ z=%^VR&G?q+tEf~o=+!RW$^mxRjI62}-F6^>a1=5$s37e^1I;Sv4?UTdp0SR*!mg$K zX$J7x!K33(fOFgf=u?0X0q`6~Y7RF(>c8*!jFR=doxcA82$zgxiwdaXCKaqb8Lm^F z{mUW3O#;LAb59cMfC9PyE%P>oG-1Q42LLrlHIA;aMJfo%;?W7h_ZG+K-<$rCeGY~W z`O;<9PQ3-qRT{DM^H#X&Rj`l&6Qa1Sc=q_HvHASOi_bqPy6(O&`}Y3%sMtN-TWM+f zjAssRbDHYM_O}Z5%Pkfp9F&0kupmpo?X78b^S3E>cwP8g1JZtwWF&hBVtyVy>KGfw zI&#llheb|%hfg)pBRqlwI|{Rkz64Rx_vXG2>CxAZHTyJcp?3q5mhOIU3Xd}MzqSu^ z{TUS#gE=+tg)xo>L$fD8$C>Cr^Rv?kfuEI;KH4wRCgfS~A0y)DgQ~k5gzIJw5NG>F z^Eqd2RmDC|jWVyZme`AqGZMe+O*?(gQO^m|8r-Z5AOK$K4fAW1P0y(1ne44B2_Z@1 zq{5t77iODD2Q3#RxEvBIerl|`-@i!^k`^~z*0^|6(XjB1YAOHqOvrbmF%r<~@A#Kf zY(1O;2<)cT+z$y#J~}!kA5=Uk#pvHj&1Cv4#o!;7h(Rs1IG6|6fYg+fuMV?dJL>S+ zgL9wI=jg#Wik?IEo|pH}&*DLJTxq&m&*PJo4{hg|<2)+9J$rs-7*Qo-2!gz&rqs?@ zu5X{Z&n%y^0ZBTr(_e$jF{Wf@Fm#ouSvllwSO9#0=*~b?-*31h(&=XJA7%$SfbV0Z zq}TZQ^e)ibB!EhX2F^Pt_pUkX^WV5vz$RSiiLwLt{DGY>Cf3;@qQk&+`$pQ1`sg#= zo2`-~3?fe@!7zqAvg|4*_ zfT#taAi5pZk2`=4F#=S5p=WH>2>cp&>SqF**VdyYp&$T^{&_J}D7&UOC>%`cQ{YJx z5c%hKU9<`XcB?jy>=3hl*n`{Y`-(n)$5B<9oV8T!c?YY}&?D!UQB|$mIXyA0^|L&A zT^?Tei&_#tYPNl-vNJLkdguQB`zj&;dvW~}i74wXA>8k6aB4Ty7mFVTbzWf?;_8&z z8P*Sskw+(sd~KMYW~O|6NOFxRzM7)`%0(HgxNV#qK)25?D)xC&V&8*3MxWY_1A`#G z7Tes1frY-e$KiCDTxh;UHRjb};@RI;r>4W;Ul?~5FL+pdTh(?CBUamP(4kn8@A{ho zj}EC?cmLiEz-3h==pJYD^IR0-g29kOrm~SLD9G);WS8Zj?;nZr+?~?5O8kYti(ww< zOTBEyXjH7|hKpT1?1dZdu%Ov0)m+R)>SZ&JSSoz|AkS6N5$;a!C|vD8-=E|1+dQKu z&L{-`r?W~J=0gRg2+WekF74y93kYG=1@g)&Nyy>%ub%@_7?4N}ZeU#s@9V59PxJAF zDVOFC{je}^_GBInGOk%63(W99Jre_LqvWAXt-rllk5+QAyJCw%8-mr;qGdI8EHY{x zfzB6Rq`}Pa3CE>77IaKoJ9HBoiuJa}kIfmpqhHhGG=&!YB$r=%(p`r&ZF#Bw#I?O1 zrK3IbbBoJ@K*NPg0ZCp?b2t>=+~*?qTVE0Gfr8#@94~)rN_e@o@1)HmVjSs}U0L#;mc^8Wvt`*cZ=BD!4ZR20NZQV2|w1Og{&L(}929QBOR zEa3$3O6?FdC?cjHF@%W7L$S{>lgMirUl(X<=rh-sS~M3lceQ> z0$*Wkt#3_2y*cKUT=69w9$O4n*N6Xr=+8Sa-SOI-Lz=?6UK6xlST|DH2-{Q9W`Z`h zNds|yVSIbJXp>1%)%M8F#_1bZEc3$mS@f@((hYhlKjWA_a|$T~yUf*Hpz~ zc!%|@#^-wf20!!sf@-Pve6>;K!-rfB;#JhT%NC{M{4Mv9gY%b5p6uQZl7Q5I_muRI zXk)=hSWq8MP3;0|U(}OmH(J6Q0EQ0GS=2|khn_JZ@{A)fV8!ckQZbBNX!NpI8Jsn5 zR0}O!%scBB-BF957d21{5m6 z=CT2NFcO+T8l)PD8#NP&=OzL5SA4)iC)pcj`PW{<7yGd#hGKzcf7{0-w##2mSRAC_ zP{l|Lg8ZN60gVnE0s&O9WD@OSTcCduM-tyYpq3Q_qyM+df5wXqlYzh>?~*2b0wonp z`kX=i7fvp4hCfNxEMNra|4)Wu#!bKx)UR$2xfR7jXm~;-jnsz8p=_i`?Zj7Fzyuu< zDT@J-<*?g20?4Tq$5}dAbukqBT2&7H?68eG!3Zu!43YXILIt%v9G!$upBth8*E7YKD1`rfM76aXZxhxcKj&vuQqSxQ`;C3y|$N2+GS& zES`w}A@}tj+BL`4C72C&V_2+je1;Z0Xq?Kk3`#swe3!DF9>~MN}8P`TSb?SX@ zaU#+idBB3AtUMB80xpeX)~79SxkS z8D-h^`iFG+|{~_g}srF{Z{M^%GG%vtN$W1yP|}DyHPgBh^B~sJy7Xe zn$6)x-Ta?%efZiy$Zz%_R;Kww2cv&Lv8dxcD;4OyAK}FYSIm=Qz@^~hH~)j^zNZ%e zcbw`*`?qP^Aq_b!_W!odL|RFXix+mB(ZlYEwEy5C3}OK_9}I<42%=tx5Ne2v&^;`2 zU$R#%7ZEshZT_LK9bwZi+h?`!akn=~{kv$RX1gH4l}2`3&x6X}cBPQy>EF_RmcIUd z*0)xQqR5QWZ;yE!G}gKolw;wS&tj@BjLda;AuoZ0R0!k09w zHbR|$hNngf(fTi&;5m9_8w-dO{^^s*I#kT|$S_22*4F#u85Y7SmR;&tJ+S9&dk|}~ zZG2cT*M?d(mbf_E@?d+{U47uqaVPlbXO(eEeY0&9tJmwfy);v+n6aUK`q9lR?mRa0 zVNv`^chm->+5hNRc|r4sMl}w5GMk;=^}@qY{oQM}qzAQ@Ewf&I{5!YS+p)jvW{F~L zPf>NpnB)t#S3WC^+0&1A!A~kX70LeM1+C6#2Tl3BE7Yxru9=qRu6}I`$4&1DT?EjQ zXhBZz3SR7FqeX!?VW;%4XZh52e}R%#n|hHnH#$RlU_4&)2Z!Y`7sHoHJVfE*h5aE{ z=YRgwcaEArv`Hch+MdMXY8dy2ww#Xb!2da}_QCT7tj&=MDxWS0BkBXapMJ6P8ZF5P z_2J~?#QUN8Lh&~jmteia+ZPO0jIv+%lW|j{ULggVa&T0P{x+mC0{Oa%=`oEHgss)9WbR-jX_^AYn@Rk?V#mVOV6J~fkX#*aksR(VTgOjuFH3oxYl}H0J!g7 zZhUC4(>I~wewX8SE*(%9K)YD<0`qKzSW*va7xbzmJx3Y)qP8-<5R^uy68A42-Ekdt zq^FAV*YZKnk3=_WwdVM%7i!noCF*`ZGYmozvX1Uaif>nV{GiG)G9wo9Q#XR!1X5&3 zFbo@PG%Ow|j|QD}lhIYetkDQ;{f)H&Pu@`Aj9uDz;!}cM3-JC~%6?NY!Yn8A&4{L+ zwVU)FZmiH;UU~G#p;&SW1CiX)C0p5=--|W0y-KByp+!IUqd$huc^*0W@Yua|QMcWE{Vf8o3${$EMVH`rf~9Do!XY#keF$;SqVld-{I zq9Ai0NGWzKAuI(PESC>R^_Q%9Kpz)X$~Y-!3cn6c-{ij6a4kPNQr^O$@%-TCW|3c0 zVyMTebt3K@sZm~hwNN%Ki;6e!DQrvARgWgI&irR}^z4SOg6W5;1`hi~4cb?_9H%%B zyw~T@fkI$%*Ufd^*|p{Ot}$_c!>mI_QMvy3UlPF#>~N(3R z^Sewr#bzN+S)?1Ukck|W2!)Lue$TE3VtB+t@VyD^;LS!A^MjNYk)uS)@j>B&KhLM4 zyIW#h>Y%cG^PXe67C86)ekD* zS@1`JbZx>w1M$YUyw|>>XZ2-ndgx#yz)|0-c7Af#g;C$|{>0n6Htj=wy@j`T*th6R zYR34;C>l0nx|To7hRVnyIOZGTS}$s694(D!QVLxt;Wq@@rwKVl;uztb1lrpTD8X`y zx`5T7ZaGx;$G6X~EYatprrwB5>Lf=2eSQ_Q*+ngY@Jr+xvm>IAn!{`Y1u}?79d`3v zRHkfi$K*iCR^+fU7^pT$oO3I}!SRH#Gs25KqY+9-W%gOxNK#sISWqrj=dA6kf~BLK z8;Av7&wjLg^_hdlS;(dD83RX-gp&=Lj-gJXTz+t6 z@lQmsS1G^P5?Qm}{qp;}U)|Wq7%d0BOLec&*2K)^uTi&PVj0c{)*YGQIKQIFFnl@S zI5#e|WIY5heMYzoGyK~d;LrE)C}ud~01F!ZQC)}%qYap>Oz%9l)<6%v>#6k#$gO;D zueXII!+N1tiGP~87RlgQisZ(5OTCxU@_J~Siw>n|?lFBMip&!T-AiN&S)n1aV+dh> zKB%BgTO81)Qc^-rc61!77&|x%7*rzJk;5Tx{j18fX>*)31;4V zNbk6y!;zqgGHiYAFM1e?LU8v;Kt8TT&}b^dKA9U}{SqoD3;MQ?4IRBeQK-({>N*r~ zrn~8K&RV8@66S!hC06KCKm~C@z*9+WRuw!V<++`?M5b?ctSXpW5_v$tte6=s^ zi?l18oF$8#o#Iqp>^{v5t_!`sSTY1slc+KT!L!}^-NzbIkT-^a=j#`!B&djULX_|c zh8-Qe0N2+aA*Cl+1P~}`0}6vjKK8Scyr*w0{ySvWirnWY;cf@A8x*9t_P#E9G@{xa zwUE%Xh^g^U(c!j6oDe;pILueoVWsQgYF zJ1@3}ZqB~*YKWqVMv_N6lA`m*!W4oRmD<|Gp_z&T8DJ7FC8k<`Sk49BS1dpxUA1T0 zpE@7tM>~ssznx#BJ(@H()a0QdRz4*A%a$m=|#j7~@tC!esbaFkk4r)My37mMN zI#LL<$7Dh}z7W7h0~q3Sf=U@B@hgBELI`qsJU~QOnT5q9DZecXfxZ!{y{sw~+`M@; zyBOM0U9&L;m3Jy72f6Lf*fsk5cWSrRB;dy!nohhAl*z4Z8@mnNbh3doTeRSs92+zT z?30&Z|0;B9TyHg6TRq?Iv%BVgz=ltC2tMS(F?Bnx|AG%AuDVnbHtlkR* zf?9AA z4RPl4VV~KiGHW{I4XGRVz@K5PHq;LIsa0{u2GggaXHah_e-^Svpp{E`*9N@*F&!uU zg1e6yBqPMQZ>Xc&q>KrT9O_5HnWQiHHA8dSPc!+hN8RGZ9iDJNs3w*A$typQu?~a* zAOcuS8tOv?@=gX1VAz2Y|JQ6N2{NB2(8k1unkc?k;P%Umi(=9bTkjt(2Uv84BdS=c zfZ7kocLPOFiDTk-QsPhdinX|B$cB@F!-Z_AV%U2*AN2cw;xn#QA-*2_W;cHy!3Px2 zC5#n#Zw7z($8GyR#JAkvNeo7|d&_b@uJPY&RTv@^lUHB|^Kj{DC4*((V`0=JvspA1 zOS1XL?J+T~cHgzU79YoUJS0npwL|=5@1LdT5ovpzMC+B-pQWYWDx+qzTSlJ^h<|(# zb~C8yetHZ-YxKG_Xmoq!0=?E6$nvO z0!vT{TBUkv|21(uh;o#R(LbKt5qn^Mb+bYR53faO3b?PRoJoj9ba8}{h(2kTC#Ext+9PtkA4Fq-P z;34B7bL;e8{U$dX#c4T&@3=_IUg)^(`bcc$PRz2|+`^)2Y#HBAjIPkz?=JS{t}szU zOZ@R1kyeh$wrFzBrqfi+)3~(_?I!rGbU^ zH&gHBYM&Ymf+UQR<#nPj>9)4E72gh8vvAE;r$CV|kKNT`u9umlS7|540qq9-NxNh9 z;yKbBvv-$d;`ky*vsFd{AA`F(+Gofg-4EyO`Zx&yCmeKzDG-5kgp_XWo``2bPxIu} zZl>9&J+hRPqyx1O zi~jREaX>>4ZS=yY;gvECjg9krz!=)$d7kNLj2}gjRfMpK_yj<)aexRcME9NP#Cidi zAC8k9ISHR`C=Ruxo{NajFETXGP+VH&M*Sd}tv02|7l2ge4p&Ku6_%gR`3P^{z0Ogc zO46Bk2)pY-$kANDFndX%lI49F!yKC&C~L_2N<)?s=&U4|(HM_NcgS>{PQls-VadzI-~wskhQ@Xct@n1zKa&RXkDd6_b|v2v!chJEX$rsrNs z(dJqhZBj}KSyY{g*5Lx5^^vNQE$xkGJo$h%>k5!?jt1MaO{dsj^1sU~qIsMAaU*Sj z0fT~C#IV=TMbAdOCg6CsSS^23)&Dj@^n94_Y&8h~t-gK+LN1nugF~;bG>&{-F{$FI z*%A$oJm&Pd3=ikb=@0<1&DciTc|#Y(@m`Gswci=vrxR!9AF!fZwKgWm%;N8 z<`X2Kad63fg@e}bU#{rg!B5^#6yl5xQdw};@ zk$LN;77bYdP$JyZg(1L+4Ir3W##sRvO2mI;U0k+Vet`LZKK`G}`&IP^`W72{3;5I_ z3Y!lOf@uVh>;gg6%;EZkF(4-%6sQtS{Kw&>EqnfE0S=wpvf)&|_O=7uyXNI>%a0#_ zKBGSAiDD<@li`N+^r$A-Ex7G8e*DA_4k^eSHC}0zr)54R+%($uoEY7gs|!(ow&eQ&I%+{giQLZgkJ)}}45~_goh|c`>wWV-)kJ?<7^l0D{e=pEf<}<` z^M)YZTI*=>4SM ze794>E7hb!OfHO&aLs6rsyen9pWBViB69+5uTq2{saP_9-|=3-!v#$ccGf z8WyR|WgVb9vC2F*HH9KZs?7UE7c`s|s}kyX5?|SwBv) zw5*Az4s*xEto-zMrg74?^oj@EYF(PWi=Wx@Z#~jppD)Z!nA^W>(eLh%*Yp?UxS8Z5 z8EQAvOyOiz(*csr*>+?}x)C_t6pm*SsCaepik zHN?aYKE^%AT6RAA*BB}3h6X68qrzGoD^iZhfoD}b%?BAPpikp2KtxkP-kIR4^s5kY z5?mnI@6P?H4UYiDu6s5plyA55U5BNU*Y%RS87pr67 zOb>E~-hQYYaHE&bfxovk&2d?dm3TZYu&qmeBOmkW?g4XF0phBhk%sEr=i=UJU~CZv z5bV*)uF=R+9_<3GWnL zL>AYCy>c&a>iF_j&%+SMHg6@bXxXi&&pRJ*Lj?j zSBs~`H6gF(nvKu@e$Z+7R07UQ9(X@nE_+npqcWgZujv*Y9w*Jh_HB;*6?T1rqE|g< zJdbZ$1}Z8ylMJ{AAYgJV6saHs;?)o=PiYPnwqhxqYm@(QtIibGozGMgJ}22Vig24d zw;DAh|808{-PqI9^LSlG5q5XEkECtYX@p8YJw8l-6186x)a*=O)2{HnUUCP$A)?xy z{*ml+f7*B8Z2adv-`5c0`9T3iN!)!d*PpU;X<1!ZM46%(9>YrMY!8|^Np6wC17XIeZAsuWN~%yhktei_WkTqxg z5AeJ1V_m_R&y8#5JUUyYU;oDVR5Y^|Cr>kRXJv77S$42u3Lr!S@0>*uu(YpaJK6x0 z1_kzACCik`%sAg&DNHX78w5Y`!LawB$AG0IJL0z*UwML|>~D?BLpx}`yF3&g+~eH! zuMjD43u$Wh)|E5_-ln5b%a1FoIbu4mI2Ys~>=?T4g2hA2t@@B(EDAcd{;wsP*;_$i zvlktJCi6o8$rl)~G(Q3tTJYv9A*y6M6o3RNvEg;QowbDIPJiPwM}oz+xtUFi7zV#K zl*Ff`nE&{}Kfe0wjUx$}w!z<01sz5eOA*zX|6`Z$nMm2eV07Hs&E580a)x4761XW7Gh**VSS zYSUEjtBY(L4{J!wKJVAtpf1(Lvj*)DMqoBYpLCATV z4>}7BC73;Dm>Cc)66ipeU_+@4AwEf9>ifa2dyh-xTi(|iZKK6|Q*xK9^D{oNH#;#= znX+Lf3O>48rAg9EytW)1YZmpb#xkmz=HY}lhh{4Mj^EFx)OM~C6O3t#Zo#Q-8Yn1c z^%@6DEK5mjsa470hUXN*sE^+8aC(718o&=Ic3ed2e*%7K-pDHtPeVdGGRr^P&NW1& zP?b(eXuWrhJWbQ6uX}dmGZZBZn4^BMdni5J z84jE|Z=%uNqprigIBx}c9)A1tZGTG(Z|7earvKNE8x@H*FIO02mA%!{RQ)w{hkf+Y zqOF-8H1SO6K(n{576&N4eJvN0iU4tpZ=KQ~4)jn4M#c%1>nJXHE$hnmt9hGfs~{R6 zY>In1PZoQ3skt7pm=d(V=*%Sc(8U`SQvyI&CmjH-x z&eBDFUbQKCrBm_Z^QVUU?WvcWGygEQQg=BlCSnTq9>4E>t4^>+gEd_597hW*JFHZh z-$viPwuir2OELKU%Vnq6Y)9h{cm1MM1Zc2DzIXli47xyg-^hVZa`mMd z4C54o5(5xIHZXSyrZm#{!qJ?=&d=yy+owz3%S;cn6C(&vY*kX%Ey{;W1JHxBOU2&tlVe@*s@r>)5j%kQ4&FJB6@gU2=S zG}pNIojdhW7&nYO-#ip7)fCiV4?^!NrrUmZWWt0^Htyn7@A&&;-M>M`*C-b1 zS}>@dYZU0PL9d+Qb<=7dAs12NnjfEiTh|w{P;zg;S*eZi@!yl5LnX=f>Yt7!oQZ|mnC{6hR$Swi5Cja>uE2={SQciaYtyZuyLP9+U){_Bh=w0HXtbRR|sy^t1$<}+c zK|S#04ui%6M&o_J6V>>)KGPll$aiY#H*zhpeLJP!I@W%-bUYPJ7?F6+_i?xb7E4Fo z3+^?#Zd)2$A**jK6{r~3tZ&Z(6cR~+5}Y3|QBJG<$M@FoP8#G4-+HMZsrtMn$2lIc zqd#V-Pbx~#?N9h^nDoQ!`0J>mw=iH;L4Ia4MeLRLgiHAvXI7bPbsCo>;;QXzkj*sW zJPH?vV*Y{#bsHSxb1@+=^&%8f9?uSfH=IJE(4+2-TI=2%wO$*VT95(HH2wPqkyQMR4`uR<{;ls-2pyzz5WMG)spnuJ-!%Etu6T8#=McuNcUplgsP$MrA7+X z1$GL>RD@e6Z{R}!HtTJ4HT!&xRkt9Unj^D|{aBsy{F>)~330m73Vkp^2>dli4y;w>KQ5v6P$SoM-AQtSK zaphQyBauLiCtu;bYz$;tBE1e!ubgCW99@Gn3Wj%3dV9rz%^DDN!rXo;jAJ;E@h>>Z z(vAoJp>NMM`bn@P)NI+4d`zs*W}y2@>rRr^-@EDk{0O(Dd|q>?*8U| z-|sxn{J1~nnRD-%yZ1Wl?7h|tX@JB8cA9xtXkg5=48UCc$xZO%jlPXRso|4vkw9?p z(GRy-LK^OA5`H3Mst*{&rX}47JRl%ILQt?jx_J;<4z&pMFhzlM^l&)2biDN*p`cXr z{A0y3$?qmxg#)e-*p^ETLOgG|P2xA|MC|73rt5!(U*PX@>XX7TDnL|qpJiI#W8t1U;vfp?JX`H=kcTq7m)1I&F4H3WO(eD__4B2Q0x;UJz&Ze3fibM z;)@3&D7X!F-$mdoQQ5La-=1QWTA@j?pyOP%O%5Jk+5v8W2*vjVkj00YbL15`Y)Bv^ zUA;5~5Vu(%uMM%wMqiy3inMR3;!ml84%B1qM>Ig&vsHYj7&cYlRO4_}UZH-Mf#2YG zqHM$AEkT|4oGxeoP@Dju6-&J6fYg?AIV-X@_m{NrC^0lfP}&?qHX^{=^$_IEmNQI5r3Ltc??Nw|N8bLQ!DYWWPjrt|9UaI;T# z5yEC2{wopeRnlGE-K#Tw(N~)w3J{#v=@H-3Dj3fgqrHK8c|1mIWAIC_9D!?neZBK~ zl1`tFk#Am>(#8I~)8Dn0zXyBu#UOw)iVi5kz67-dj9977_|%J3)Zd1gk0nO>`-hVpi7P4x5j>+#u({#x}IVLehM-K*s`Qs;20^Q zrM9#m>wCbda*G~wPGR-a*|vRwX)@FR*Bs@3T$gPH{G49gwS}D0cf2oj{oPru2V|H0 zTHJoHipT%5oiW@7-15!1TWHciPHavI^KBy#ZuI0e?@(a&3IO2b_M&$iwvV3_FMZiv z;CkKA&^(2KnmRE9khw?4JwbIL&)j!S=gKPNad9KJ>6ILuOVWo*^d>p%E8C1-zU8{f zJ>ArF)#eIs&oeO6Pm37>IBQd%Z{VR0e_P-W++v&T_EW$x+(Xu1mNklIipdNdR%{Ma zL2W@V(FPPEH*Oj3d?G0!)*s}JGx?v3hH5CCUlD8#=%qObN`>u}4cwdezZ`qybanJ| z@0r`1lZwV4KC|k-dDI7M&30>T2F)`z-8Se}#XDlXXLsy~RHmX=Mv?e1L_Crj-h6~9gEq42kycy+E|nR0cpC8ms9dR9>ef6o%lFbbp`9j)swx=IScM-SFr# z;j4gPsg7TMkhVm1F@Sbk!U>n!m(s-B>V|z(%50j9l<%1){xJPe*LEi?p*p2^&kmHb z<0Il|@8g}3*XN%gnPZs13AH1+0vPBA`&s+}On`n{fwr(<+i_y|oi2YljdAS<5DaT6 z7N>Fr+zp8R1L7-Tz(=#L>-V@99fH(1GCIz7S2ZC#&oIPDS4lex&5 zUBs^f?RH>lLjlbcol1{Nvz)y-rUHCtWn8+0r?2o4o#b1X6 zdba}t?Zr9(V(`_MfFD_CU5MvpHgus*HtbQpKR*7Y6kWZ~qz6V{*hl&!CM@mS!vCC^ zbZXb?&ry@uqxgJl7f2AKqZk^dUi;w)i$lpS~@1Tl^GrFZ#l5 zY`HFwCaL;@wm-~8&h{hYKkN^$z<|JwWWD6RNm^2}$}XAtP`sAQXx?;(e{#f50n*B| z=+!e+VM%s|%}yS>a>u8vA7glOQutU=5rKpU%@2OsGF&L9-bX3nk4*Ji_~5D;qQtAe z0=%eB_$O$8wUT&FXp2w?jB%BA7d?2SxD8Ksw{4GX<*9tsvLtZ?iptOXr?HlT4Xp>d!5b$k#LXCN_`P$5t(R~R{2Q%5_z?9LgGx5r$Pdkj)G-MT z$EKoL+06)nXeW6vRe(Z}z459hVHPPoH0cNGRjvK}t@uTy^rdz?Rlr`mFL(__j_DYf zE{fT}+kET%1TeK5uZT8UWS0Ywgh0;&H8loK?(+yq7J$LLyU!`8)4TobLE(sjcEG+Gf{WW6z zCmKEdKJoW~WT}95I|7bw;LAxEr&2Y&+J-4sKM`H0Adp{{2VIMeJDyzY$n{ZORxekR|M; zuE_P`RJ>=3HwcQOE%!jP8VBWBP&_euLwE&^P6)h}O@(jHoN7J+)?OXHCHODPs{#UK zbQ`s$fsP>{f)2Q%MymynvQop59RTtJrLK;GG#2udU;w{{YV8ep(^$hKg6Lt`ghdZ0 zFX-f)zQKg7YCM)|*h#^x%ZnC4DkmFs`-WK!dkKtz+d_clCfs8|PHBrX1>L2k5u8b? z{d@dw{P({N)e?IVpmp#>0AZ|Yj4u#`iNeRQWy9Q)+R5%Bj`AGIu{1JsF^+yE+*P&p zlMKcOyqh{45x- z(){_&tRnMQoIPdbMKu+Qz)!R9u&}Ug3C$AU8^q`4PGf!N3x^zzyndY=-3m^X^>3*& z_sXGb$;ayl#4PY(bJ^cg-m8DtcTgU*Brk3BZc4(^!|InlO;JDO4Uk>3CM_0 zbrg!+L0WPifG^PFTPNwXff0ufgjSUH1|^aNw#wB5I3RdeY{bV@5b7HIZ#f&kT=?DQ zaDx&-#vumWk_HDb(dxemy;w8R#v9#u3!L7)Bt@U52rOZ%5Va6h7g+M7K1p-g*nDyQ zokO(>Kzv}&gqk6F%Q$p^cS`%bmc}W+hkhPj z?e@>nZrR0`Zd!h&2{Q(PFboik<*jQ$^J`7HblZ#m#(e+lExD4)!zYfRmAQCpM`9o;jzoJ1}|IbP}3$u)G~u3c#1BV zf~9pUxUS*peCJ%o@_~D(S@yr|i~M*sgKkt4BkZB>W)Z<4gl+;27_kjZqcKWBj30gF z!K-o3UWt{K^5;4cm=a~~2&2{!@RhZvKc+&1?`*n{sydqM0w{?jPvb$9jT^=zSxVPf zwk$I--kh%Z!w7tIyFq#6sVKUHV$=3$rBl|_02Chl6%`ip6TE0RL?Fh*rl&-M|{bP3ZF zL|DiF2V4t({91tUUA{+eyq?CQgJ&ecbq~b(T6V zT((O`a0j(O*Z5C|hi{e4=5DJ1+*}$!Fq@$Gl1*$o=E9wLSKk^){zS!IQD#9_d7HM- zD0Z#g7gaPw7vE`O5N5o|p3e;6oXP(CV+7F+YDyybhPP}$*H@D9AA;$-C#%|*Z-$U# zpDuqtjPKD5f-)dH<+Y$<>&ahpLRY03Ap@jt#ItX@x6ANBfhUyQrUQMABo{+t5g{7( zYT}c9Z0P<>uHogTUpMELjxmX8pBEd>XbZ8uTqn81&eVR@#fpCAvjGGP83)MzjdN$^ z*lx!dW-O4QvcIgwXb@fpKkuXq2niUF8Fu(R|8c$UNYQVf7!#pgcD-=6Rn~zhWn!vP zk2CZ&FHhgto&9Mv#Pyg1Yfh9gKoyJ#D&59G?GiQ>|F`}jhN}y}*#UEX=11J($1|4U zmGqdQ4Botio#w+Zf`gq7l)E?iu)?W(_&*C6w@vjJW2Ojp%khdCiyE(4o?(SvoYVjM z89D7x81@b5S;i`x{T44M+U84(W)*~yP(qY>xHW?cO=b)DjjpIX4&;E0zjBJzi}l_42Fd` z>E*n(4)JO`3bwt^ac09mxKtAb;&cl+3m{H)uHzjSv>jWaue0ZtMu3zKPgwpX9rO{)=xz(>h zHkyZ=#3;@a>wXW(md{v)F$_TEBXRWJ5F2oO{k~Gk7la7)0$|!N_@BRN_G7t7?&TTM z8w29!(Z|kNHY69By@TvOW;4xE8P=ZxC>JPVubq_|o$U&Z7*qFJCTkZzwb^ZHEwkNs zJG-oBxitUu9z$}v4Eet%10ety`s7sf92e->N-QvUxR<7OLp=Phj<6*K$AeBqg+=H-fbBt=b9Q3~=;nxKAkb|cj??@s;S?4kGj$zfBs)1q3W#li5RQ1n0uwhO z!Vc1PFa2n|6S?Or@I{O_)#F|tNl8DdvlloFx~s-r#GHAN4m*9P0-Of7er=hufUW&P zc|TfEEhii%&ce2(3H*?wgcgAiL4?&03V0aP9ZXfQT(>7t9UGxV=j zYg_&rA<7yFw2Lx7igf_wT^FqiW^YGXNPaPC)>ss@1K;+m|C#UNU5C^cWd8sZI)?cs z-BFI^g3xSr10sV05Cbb4+jl}F)?=rEDRLBP9gd*KOFT;6+#zszmhxXxagBUM6@0~^ zrx>DBWpHE)?_1-P7A&TJ;VGW0T`(@rlo}28;GOqGSp@tDVR22coVuCpw`09! z4l_fztN*_zDGs8@ZukiL~Y zVUNj#ZFC)TF6h$SA63vQsej5FM5%zeKkW8S8qhUW5BPqH8L4@z!<1KYJ6NIT&G*Cv zlvv6<={#?+Tx7ZEd=Rdhy(ohHwd$skcJHr)&Q1-@-@t}v<;>GDdx|(Xt2fw;)!neT zfGlX^P`)kJtyf7J9)O-47U|!AzM~Pp$+U z1cV`YQ^w~nb^dt+kT7SLEA0lS^NZ-;5fMe69bIfKB>b!5ZfF70BtgZ1D71T0%|H@} z&{3{aH$lAKS((c6FYj^A6PODrydwbC2e3O(kP8$ni*{2TkYdC)foOv;UF`4gWA1-H z5{kK{gVx2_fF|e)`RES8`Pirs-rQ$7z}v?qc&3h8QUERhsX(MU2xeL~y_f|#IPQeR zZl;Wd)jt&vPS9d+4_sXf+Tk*FqZ|B_LcDJX_&KVlPNo(MMmeSKB9t)^(U{H*A5+rf z`g!*8F4)nfHaKVm%G>yg#gI~$k_NECMOTht%f!uLPPkDf;&HS6DOuqATt%=z{q(07 zhGILN$dZ6#3s(0L&O<-CrD5vzxYKPf_QD4^F#*x#WAwr71B4NI+S$?ZK9J_ADVPT5 zaZjffBEXa%tI)U}nZ<(>0SQPR9hJrV#4MAb_1Jz9S797%rm+(>v0bW4-`eG+k(cOd_X zW{AnlE=>IEc+$@qhex3{9L+H*;CDUjEw%eaF(u`#XsaANMGO3PEhE@$AUVHJ#`4PZ zd#5z~^3MtZ&3ArgFomMFu+p=Q7_*9mRIqd=6_ya&gm^DA2lt=&xoAJc z;6||5Jx1CBi+D?4`H1DoSFK8Z+F$zyu$jOjLTQp=y<9sY470 z-?hfK%M)YtFi&nqseTV7V(5vLzI)||p{;Y=U9NTk;6_IM7NN^({pk6(II6gn$ z&3{W9cj{DAxz9*B6YrY_V;p#MGd}epTi7l)7`j8^9c38J`O)( zY2gnhUJXsB?V|j|ARU9Vw?x-79yMB#5b7PB)}?WE8Y^HSo+7JcmU}VupvoTCCF&y` zu$`|aX+vLprwqnrY3cR>i8_ou z;W3a$Z93qxqI|iUvpiAtxbqpl2RD=NXoVLNeeY-&+X#{kWTx9He&uDvk-$0lbmv-X zEQkE`%THDEW84=G(+Oarh5Q=US&bepG)r@)30+*xdoi;FT9lx8$ z_lx?pwbK$d9u)RNQzAUU(KR=!nw7IiI=d)EVWW%w^h-9@tVSN6hED3^>OJ2xq4Z3N zXi$2UTQ`;_KJ0#Ci#m+A{Cfvr0?PC~S-^W9;FM8M9_sv0s8Co#nk*^c*JFw!{s(yi z`;IHQc=kGmnya0xKWKZ?aE)Jc8CUVX=`X689yRrlLa|iOIn&P(NM%fBFeDoif}IO~ zK~f|Dr*JfjD&8bzS2uO+{>^hhSeiex{ouhw4(Ehhi&}o&h@IxZb`Hfv#q)nsqWigi zE=?g=3B*3waL8`{no-dk5Ujt5+xR+pqbl`@2?jgGHpLS81ydRe@I@(v)-46{E$a;% zRSFE|%^4l>uH55JYTvPASE`;H=s`QFLQx&l7AKAddcD=;H;+;8scEfb8#b@BnGhcw zyzei>nV6Wq{e|?*{A!6Lg;ScsPNP~evjL{kfapgfaeCB>ZQk};3{-{3fjA$fBqoGu z$3U05Cx3aWV+dOFd&9w5H+y(DkJ{rHOAHu~4Rn0_h)m70$LmL$9zU_F+G-ap%rx_# zgCYhW`-W4^6ZLPj(;f%fX!`HX1fCa_O#O_IG^1WITmK;j8l7ZAG@=@pD_{?>vog;u z-8Agy9l4);AtfzItz6nErJY$%O%_@(Cn{5fo9D_M?%jUpaAd)6;CAQJtkj(o_jhG4 z86)98?IqHq<4vm@-_gcH48OYzqKZ4?0pwAi zv{6~NC@R#uc-rCvpNs9?FzF`Vo8F;P5g~cT6ixrE{H$1V92gmCBnZqD@Ir2Jq>xW| z!HH4vrP@`O&}wz3&@ZQ)Ig2#BoD@2Po8-4Qwnu#y;SBm2Zd3Rt7ppVjbqpLh8qs{} z0;^Xn7BGMP#l7!|qHOtE-qR~-_2+5JH%xs;8#EL7s@y$}YomMa0|yZzlx^{LUF*%M z{5K4XA@=i-@UInq>cucPGYMZ$`ilo6s%ty`8GHOyZmsIt zG`opodI}eYE9uUK&16ar(T89SeLZIS&@+^c*zTeQ3<+O7Db3f-#inle5RW=TDoIbt z&#K zjWC%~A&oq03`oEm;!`Rjz9Vh z#Mm+O(Sw^gx7=_XRK$-5`e^AWC<@MXKuOfEu3bOfo2zs*z%CRNR?B1>Wf*E%C^~9~ z%NWE78O_R4>hq71{S6Yr{1 z-z7j2;qSsoA(vg%B`zYJq0Aq><9XwWsjl+A#&hvV5DYUQGWnKH_7r@jK!LQT=eF33 zANt2nBC5llt{q9>Xrz#_e)R|-(nPLOP=kApAM~slW@2_Y41UOHXC=4XB~h@*o)4>a z5sil3|2&NKhQaFwLr&qs(EZPv{*H{R(snuXg;MVYegD#BNbGwyTJE)0Yr}%_;(>46 zfgk0p@d@yA?ok=03j=jG_T?FUcY5B<1wn|-*EsPb2^F@egXDU76f1g^uz(?-9wC}Y zm=I06NdPA;bEg0_qE8VW;sxJ$^kwkRc3mS8P)TBoIqlvts8)%*(m8N-~xC zWUV^3WjVJUpFk5e=3AP|jUEdw@SZUtY0I9tFAfz8<8Ylnchc4U5ePE)9`(WKbqt)cY#Tq9{OQ+A^Jb3JL21_W6!aJ_fpNA$E_g(`7IKzW z(cMnmFizu_f}xH9Ql+haz|U5pHs{U#16 z{jne&VDs1jL#A@cy}#)1;#2bO*U}Axui(#|JZ!q=c@)1(qC^5Lo3@?g|q7YLz z=Zpid&dYf6p?3fDZ4ZjeT+%B4*iAA{pVSh`Vv=CVcKez=^dd9a|6o$lntAR$vDcEG z)<{Z?yaY;HH*I~!pNsRV-+N;BaKbrw!TH7nZq*{wu@ zYHy&pU1=^eL`;E^fx?Jz4Z>}_PZZ~d`|V#StO;k9Oc&_HZwdPdd!SI*oI3FaMr}Wb zfa84L(HdRK#Gce{b>#zYQBEpbJi}@C7e=2G9wd`#0s_437j>TX-6UGm5RuVeDU-XL(T8mBkR&Q%)jn_5ezsXW#?qMqzBLmR@00xm-*V*gBgAH11M zevKs)_TGw$U({RiTOu?*7(J@H1)$LQGV;2XK%jnr9ias~bzwrtQtG1nMIk-wN#t;= zohv&}vENvk?1=nT-1z;l+y4F-y}R}9hJIk9*pk0H>jH=h#9*-$9!XdzNG{7yP-*1sgA zb5MK71C5{H-Y*Kb>N$uRZSc4ahsIm?d1&{o#`fV4J&TAkemwt{YUQq~e(?ZC1u3;? z=ezz&?UxjGZd{TdQ@1};b2q)~5ckHXxjWODUuMd1<|^_>jsNGV01lynkcpGny5Ue| z4l?@O0O&UVn}aU?EF zp|266#!3D3bQkQHOMeK@)6v3=EcQ z+$+C)^$Jgat~VB7!)f{n_AB0IE(m6#NhgmZk0l>6O4E;>L4D8W@wq;FLjRkS~K2TnJu}A%6T5Oy2THGPsT|kRp%D-Q!kJoQZ_O z$ly^;OpDSKx84e**7Q0c&$g4tR*}RG{=0^nv~AAcYocz7_k!XC>^S~fe6zjI@GY4S z@fDqvyCyX#`vRn`TwT8~?*xjz1N@^V5mXcqS$4lr{OP=2 zQc5mX5+g`pkjuW@_uyx&^Qo;$peK)`ClCvDRr$<_s6;<8e+!Ld{iQ@bA%X;Jt zkIyoxdK5!x^A@Oy;dSNuNPitt5)u;e2q;KP40@esP7cpXhHqxwki(rQb)`UB6PVh} zhzTBQ(4eL7^D9mCrI9r0tlhHyEq1}NVfeCjr;?aJ`8_Y@z31QBC`WZxJB z4pe>QdemjMGG+zM)mr1^dLMU2kadq-t?lA1SF|O!dpJZ2jIp|M(t%dA$K$9$0+J!$ z2cX-l?97lJS#z*_B7djP$=fMj9yBS9l^we(kNoh(LEoK23hKzvkavcp`m%HH9G%r` z6*Q{QPxLqR!nMf|2S$v|K}F_c5W4%=T)qsHz%77MpBDPU^<{s{Ad;wsfAYmx@ku!y z^@fZtqt&J~Z>^(#NI!1^so%44Lg~f6z2WMWdq;c6_3sPibFlTGZ?w~5Q_>JC5b+A% zEZ7CnI;0T%39AD;U7R536y*{`LGmQtlX$Le+h+8T-@`{h{ISP|n)i0Hbz!zHA7JmqoD2vr_$j2;>Qphp7==+!}y{c7op0*zMV!eA^2 z>sKfPnwKb6a4tr=HW$v((!UCFWhw0!L)+TX`#v8w#>wZnN(Ad`U*Mt>k6VbRT>lST z2O8p0zUXr(4b^hmT(a|)BF!kFP}fs6Ndg0om}sH-#l9=8gEW_*@srgWhOe}1-MhBe zd&--JbyKfvDw{{j7Z0BcYN%Bk%tfKM!UIuL?Npp#)=rSYVmcJ|Dmn63^&2qcGBV6C z7@CEbFRfKvcljt^Hl&1#jxG=eqT4aJ0gi6kD^Jfw9!zV_4Q02 z2d{&aL~H^1%6ixSM()LekvBsGQ%twV(4P;{dud0z^5^15&wbfn&Zya}WN*?O3|!J} zy?m{sqvNLIG4$$Ua#0M7fsY&Q9Hz7!Sf3`id0x`3LJI%3MSXX}0)s*VSF&KB<6;2P zqaFl44w3FIv_ehEv?>-N=AtgjP^_s@`}KDsiplR+($(;Xx_F+#Ic*r#07geopAggHdEp=WFjQ zS%HG|NRYxs{lo5v5OBx9IcanJcNvj!25Mc1QnLWK=;6|{=JFny$XWqC?SO%SfjwnZ zcv6!pE{GY5*cY`|hr$97a1O~`&^{FA0y}--7_g46Z8E{^al)_RKt!5dIy)IJQP102 z6!5k^$NhTcScry(#sX~Sco;I% z6hlLkUZe^79_K2q%Jbt3v?lqY^O;h^A9RPodmo>V#?!XRUi*FuwGI~=N*i_!29t=l zwfh`;`)o(QJx7jY;ea^TnhyxrG>1Or&@9yEcj$Nv`pnvv(iXSQgrBvJ@n6joB|tfl8lrBxZrX zZFtXaEAQ1`VY=)8Od1rxAt4;na<(IQ0+&1s1~@5a`$^$j5}=R$SLl}l1`qrQA%)w( z5p9=$5-eY$pO~m9c&+0ZMCKta0N}@zDf`Y%sf#cH2hSVnbpc|bGS#n888C3i!ru6) zYwG=FL9-S&MfapET=GL@V^fn%fm&uxMFoy_fUB$fOPxu2HkDGtUxRB9d#Xl69J{t? za!0rSrJxVC&3M=gmlBezGY7x28U2m)y)|~r!m=D8ELHm_q%%uUSylx4~%_Ar0pxCOinX zL(Y%9>L3P5uK`x2`Ef-WFEQB}1|o^P!9ja>4>z46xzfe=Abzlpe)c_79`&x7D3Bqh z=%gYlg3Szj*z=)Mji=m><0M5;#a!H>kcjGHR%4OPT(_#(uF#UIpv~O}0{|R*YR*JIyvT5^K_%k~@M0+amZ{ep49$lko;(}?gtl$fr zrr3HBGUf(`roMl1DIG8FSwtj$F&Wp#4q@_93y4v#9NWDv4fMi;TS+dM*m_x;F3us`@$K4Djabtg&0pL`z5FIsq)?F8C5Iak>_P$=9^h@oKV^`oAHM& z!Hs28ypBj197G1E4(SXrml$SVz#Sy*;mP%*ng9vU*4tsPqddeaD#7cTI6-|knKu;!AS=qOLiu8U`;h-bYF^rN!3NBx~ zp@HL{dIK(mN3F9x#gkQ4beikB6wnuVb%x6y9b8>iyn_(+?3h0N7MDAe_J3dB+&dfj z<44(<<=@pTDqYNOpOwx$38={qb+ICH@gBjDaM-_bk1OnVhlF&Q5w%EEHZ**GYfLZc zHMRuqhhea$g4epkLV&9lB@`KcATK{6QYrAmI2oKg>$;^KW@_(qyk*IqXkn&hI!Wu3 zQM;$v7mp{DV%7b!>9b1P7xEQXII=-2Hp9ZL_v7d2hxIj1`dd1AJW`IJ7rw{y`@9=Q zF|k`UGF^@(#ASQ?_fa#?>?>$X{fqA=-8vV(03$^8%2C8#lEMK3gkEB#+Nqq+F3)|x zva!iN6%vYRoUhr}G+d>@`hZWIj%^gc94CO?{p8Z$Oi)<(`SO+?HC_PAzzN>KQN{B$ zWygoL3vD>m=Z9&jpj6&Jag#e~0^JMA;u?BiNwp(UXnZsqLe$XcDNW8glI(>^qe_^K z!PRD=ij+NuW{3;6yo43^R}HKCMqG$AEct>fuItd0@M=ZwLjPa*r^5;bSL^R)^-^G} zWP%%wiAm&|@eN-l#>L&|i}pMIX`|xO?FK0Zm$%01f3VNT8WE)MW^@=01e_=#^IrjC zO5N5m#uL0K*N2@jAC_o!mC-z99nG#ac~#XfxG(%tC@7NOzkBy7lpL<=dwfbu<0;fP zdwRa0Bms-$yY>7@CX9VFIw=jfLDi$}=l5mGU7do+H9(bo%^i>99crC*Eo_rGPwy=S z7quilXN@PZ9)Df^F8}UJ9FtbGzANVohs2#8|7NwNU5TR)`9CvwxtIm26DImYYEpJ| z4hLJ@s*c%bGuJ)vPEP`hf=7TG6&d{X4KWx6> zUJ%>53H5$Y2<>9q-rqNu#Rv`iq2wDU)AU{o<0epQnE}s9X_$R=;WzfC`WRztU{(+y z19z1;T*0(efd5YWw&@(Lz2XqBl-A;hf0gHR{O5D@GRRnSK5WN^Hq4I>vcJDry{7+0 zYt7yIWtSYhaO{STbt64#9P#isjja3jkOW?mrCK0(RWI7xt!QrMT-x!!u?s~@g}+fn z?G^x6J?M`kBW4eFCt+ahZ2$=z6#~xPmL!9B2LoanK`R)zF@cGe^uUOjuA*mvd!t)g z7UI{;+oW36hj;X6jlo#SzwNeA?*&>ta)BdKc=`?}6M~RmSVT(}MR%Ku2V!=_gTaeE z!SY6yVZJJmK-|{+OyIdLDg5iz*EAr(swVY+L$}kH!$cW%JExACdW-;~;G0PQH7(G} zR{-P)guFF=tp}00Acc1`)wX8Q24-c#z^sQlvbtDLJx#us?T}kzuZQ#v%`8BEOZ zxp8m0_(Ak_LvrJNdJ;7LJuWo~h`HvkukM9WZdnk(e5a$r-E~vv1nGITMht(_4uzkb zu%dzPe{#~45NCN4J`~=(C<|N-AOQXfEaV3e5C7jh$`ip*w9F>oivV*t>XwF0VYn8C zsNo2_pN%KeRV0QR6&}(PBOu_Pm@qRE#=p9hh(mmMN6=o7#H20M%D#cf;$QF1QNrwc ztDvzM7{qGI=r;f%ibQbMu0hgj8_50QO`~?Ox4H>0cmx!tYJq}nZB=V}E3u2wsa-Om=d#i$Jr$;VU)Za`7QlQc)KffI%24U* zE(Z;0&Spb#^KdUS1Rg}pmiwDnO(sTFs70^T)~lWwrT<_w4ZXL!8wNwqm43B7tuktN z{Y7+o^g8vk(ZmJiC57WJGGciZ+b9R@rZVmE=GhsZr&9ajZy?apxTff42hmZL>HZ#O zM4N)WGLs|ve}TT$z$r3>R2&>LnOb4kOd8yg!MwTr()c+f908LAy>nM2y@1=(uep1s zHPX{otTKA3`gFzv**G|K8*J%rsD@v*sVj6U96KkQnu*dO^1{Zy4Y7?jH;7{3BeOCR zjqmLXy1FO~4KwtE7nx&ITdEIvofhXMwXMxf&6%x<;Zu`R!ZH&Je&@?eEih~1max`) zD2a@KO3ZJ5!{0~^2dkC!gW;EOVCBRScx$lI`{_1Z@-^gIMky|?dmvxudhr=9K zYy}DsV$#`_+2s?pqIOwjern!(&~@Y_i*b>!O5 zK=^P@`qi{f%4E2b-0I~Ly0UWQ^C1xf4#8j9?wLOEd9C{fAF&iAb@dxR@VD?gCx(|u zxs70b;$*@`yhLV1v~M^^R$!Yzew7=lVEaM1nF0N^#nglMtNKp)#VJJJYM* zz1(5*5lGsB^i*(vow5DsmGaoaM5h!U#e~-1Qp_mI>uG)hKchpUvdP)gUt8O|oe~rO zT`m<$en#4#EHQ7#(8Af-2T3H-gI|?{%0mypv6ft1#rd@o-ezye#St`x{{LFG zlrV30ah9u)A^eDoiQ(QgOemkqB!F3A7&Gt-IRf!MU`qB>$s(V*HmtkoM|I-yabyL- zJMNyzR8j<@hmvwJzhB3h+{9tyGhuywEytsE+yb#TIPu+66PC0cNK05x1B!FP?CDd* z#h`%}F=9QyNiH#5<*}E6A%({G$2NsoS3sc1&IxKs2I2r-{lo|6Q`an z=M^yGYH#!ehdcSAtt3eiiZ)K+vyLy#qP+6)!ml-k1~0Jq@rPm)u4jxs7|Qn}jN636 zMGqxs%1A)!iPZ%}e#ykQ&vfai?>w9a8LOE$>lXS0m>T`()g2{f|D->9QS~G1PqnJo zbrsGXmhZqzj-8P&l|Xj1u8G1Bac$^?v@u+f=z#c+B%- zW#rz8J+W~AISbNKUflR06^3wq@g&|YFS4$zv_XBRcn4xk<}w!{Ps2cCHnOoC#QrHE zK{Z97RE|yt0#Y3KDP3y5K0^NJYlgTBD7f;t-DW*Uc6)E1#XpO;>$f*iQNy)VxOH@X z=)vV2XORwB8hzPd0ueta0;Q;}jyZJTtcac*oAzNetdoYuaQNRf8|cH=;Gdk4&@bP* z$vd#kskN}>kM zeu=z~o%%*ca(eaUd6(|sl~}Wg{hz}}x;QFU+o{}c_`&(HvG($TheELo(oq-T!Z%IC za3lt{pa{5Q>XW}#;m;gwyOf)gu9^JfTFj=-t0|)=hE*?VZlW^j?UHVeJ{<_nz-wo# zPPzMf214N-cFqq0ESrl+qI{NccS${JyP!oT1642Iktje90qNnp5Q|fL5NQWPqdu>% zd(_297W)tSYMG4+Di|?};vNORG@_4FW~Hw`d&7+A=vc5ajEl=q6S?*tV@4dlt$XR4 z>3=fxDBp|^FZ<7-_fI>Jd`@9uI2#)ql0``9^%pY~ARpxF?mqg{a;Rs|JrOGyM?UJQ zh{&q08=dFCEWX zZ@Qtb;nH(#L_RL~Mc)u(&YynPu}R(4^s&RH)rhNhr&0TVa+39V%Ejqzf;`N-4P_n!w{lEE8CS& zxT&e4!mz$7+Qj?zOBXy?NqXX?mlp*@b&M`>GvcH%1wgN28#tJPrLwXT8AbT|_3N?W zVZ`s>zg<_m2#!BUKqNjK0wc`avFKQWHY5pq@8*_7M~F>MMphmUijI!fP*WpRib2!3 zh2G82wTsC&H}A|mSi%E zHgFUbxy<6pLoyhTLJBk434(l25Wm<`G#d?E8K5!fQhR>OXi?_=oF{^aae{y3i}xyp z9++k1OnRDM2cx4o`|Fle;_B6l!pr+ZEAcY<*rN&@w!6s4$D3c_0K>i>ZK+KQlEb}geKyjMiGoFcM}rc^MWvzgxfv(`{J?)T#A&`wv!!VGe>}Zq zTvTD#J$z;uhK8Y}VF(2T36ZWLq(eYbIs_#ZkcOc_YG{$}l2QTbl$0*%?r!OK?)$m_ z@A;iC^XbgF&J}C#z4ltfq$t~dTcJ?>m&1%tWmSQ;yUmS90RU!OJF`lKVO{o2O5mif zpdJqgC#MBCWP!vx)J2%>>mPe88^_(w<3@E089eg&r&Bk%&DhbQ+#e*$Nk6XXfzMqo zHPn;I-+92^1&Ck@L2rs~*nT$z4iQfW_7K5tZ7Sd%R|cyFKzJ3?7Ce2~BFu4peZobz zy7&yC3Kf$?yFMQM7VEJQdkBt5CMNFK=i}Wb=@k5F-9!|`2wSoVbZ2eI_%>I}w8cEa z9T0twCxy}C48sZ>J8@!o%3dtJXbw7AyzyIVc3rU~xhB;t%x*IMj7@@Vx8)oMR#y3w zh3&~fAyu2I2bp)T#0ql8$8BAt|5B@0|E^C^)$#4-0tcp!hlem8EGjB$M>KOt3(%kp z4-XGJFg0V5kjSVV7#u7yu+{C|JdKUsL06}<*4M3~Ns5b#hS`5QapG~dqQ%AZ@I6j9 z2vk*7N1AW1rwx zlsFSwGR0Ctww|LifJqYfQ*k_@2nPfffPkUsBm2OD#-t75-O*X~!EW_$m!UV-o)FUQ z(s4pLB^pZ9jj`#pQk_?p^5f8JfIf5ee7{3Li<%s=mc#t!|(6mV?__LAOgrS=nPjGFCB{zU=A~Y&gQV zyg_QDb`j)3Ju+9g3_`FkH9d9h`kq!wq2MzdFfXanxBt9YjJAE8+f|>c`aMZR0`KzxkO4BOkt<%0$HygYY=MNw z3P4tt#M+V5>tQUv0Y;N9Tabl>$nUM|ZfoO!T7<$-=1u?N96GRDeeUSeZwQoI61q8* z_0ivr{ouw}TLv*Lr2}veL;$@S;LsP9BLe;F@1D_kQ0^RrA0OXU+uZcKA-tQw)qS%# z#yV(Vu(J_vvH&Md~!6T@myahT$}OhEY@fGpr{{z-m7-%8jR0Ej>m>}+@8 zFhCn+wa;)*+%p8yqNGtHMz8VzUhxpdN)jhzkT@dl19D9gII+P7!davQ z31Ou1a~N>S2_45Wr3RyhON*jzcU5e9{9?-2z5Swq$?fp`7+Ur=1-7oXlM@474dcKmjI~*(=ceO;O03iK0o8pHu07ork4f@> zynyiM=mZi0WifUW{n>i% zU-dFd94Wm8r6W!XA6w&YZX~}WX;wNrxs9l38))zSxPcKXxbU2E_jnj21ct>*NM2kb zU#Gp2Gh2z?JZ}-k&ldj8#-~+#B8wTK{_RrSR z_{ZCCe+Y1{-IElC`8i|8fAip05FfJK@=E8lSafqWeqT#3Qx~i>M;)U-&czPwZwaY)o zLc|aN=hFJCR{@o}^Yintl+`MKbdMtrJ>!uxn;e zdHY@f^@mejfRWt~la`+H_=PO#luJF1DaNVNyN||K|B**LCld0Hq=JV>ufhA&I4pFQ@A}!U4uSlcufmg+cu*Q~-Nxi zj+7U<2WFGFh;X&f5n8Y;i_VQcYnS!~tHaV`JZTqca~u@EkNu=H<@%B%rC+kB8Xk@a zV4@?0a8c)|9LQKsXK7^cqREQ#L|P9F?C(+RXI{o%{ykjP*L^d#^f@N~uL;*!lW@ct-J7XOk zXeGF(-5q#>Dqg)~gyVvVy`Clpz~&W(RsUDDAOXR9WlZfK5uu*#g5WHtKsayorUSh| zS0G*Li8qs!ZZ1F6QZ3|^=*2D0`@en4fb3L$cH|k~K5y0!Q_fK=JpS8Be9LqoxDwrYnN`{=b+zw=h$%;CGS#4f$1 zdP#;O*Mebxi(2zXv8)QymY)`j)c;~-NL&C^#=WAU1wE3s4?tjv~*&A#hc5&A03CqQ}FNm)qEAB9NHPpl}=tyR)HFotk^{t43aKhiY zmsj}6EfEE`n?LW|`HgMro`?yM{TmkWRF{}CrJ5QRKku|%X^t&5rlmV|R+A0LPzgP@ zDxo;**3%G?_7frEZ!b|h|Bs&pof zhF*RT$jhWK5P}2=H=w_6syJWTMao0C<6LKV4_BN_mhS^C{(t1c0!8@JLlNd;2nAxG zrztkeIf_|oNF0zh2ca#KYAh83%7L)BEJ^=S3x#37ShQZr)Mb8YNxAd(HEDT4&BDYa z|F6OFgI^4na}~PuT8|#6+RhF8pFXvn`}a@w*MQvhfaSuqx+04LDI?XkwS&U~IfJ^# z$M#)ZpfimGZ}WGIu&C(fVA@rCg&BK%we7=keZ*E^)%*9O4sYLf73xn-Ops1LI?636 ziMCx!TceibE=#2YSR~dZfjAHw$-ADZMkim`-Y=RkmJsV=w?%~n3XE2%NdOhrnAh5? za>my~Yr`m+bAONuV4#^z~pZsx8pKY(Xh>{OrtV9oLMq?&DT({iNH8G0{NRZ`MSSeAkVJ*}--XZ(Va zhv0xI+`E6@6MKY9uzKg_(me68d7RF7_{B_JGTfhR-C8;HtgPf<1@APqd53+9luC*2 zkbF8*=;${)Z)kAhGbBRZ^@V64`F!k9a51tWw_Ay9D?5|FX)cHEO61Xn3vx({l3#nF=2p&sQt{3oB;X%&s)2vgs8$5 zY17{TJSI*6j5dEKIg_7clzMoF24$y!2kvFMiZG(S!Rs-UJ7-DO**UfJ+c(!l?P|}@ zCIn-YH^DrW`S}AA`80FF>YAU^Bo_~NXw-fcZ0M*X<|3+$TJaLw+8C#1K51S{j*Rcj z*524gGzf^(y>RlAV}VCvucqZZgYqmi zRQ~vj1`$;&=C%wdbM-O1n9Xnml2W{B)3E9C+q;YU;Va|jkC>I=!dJGztk1cKNjl+6 z!;_zsCiQnWkyZ5mhF=8!T(11)4L!TK=$#qcmfLuYKv-J~)|=BuZr@zU#?V=_lfrWA z>(w%>>r9wilP@}~GxRk^K1}2F935d>^il5b7m~^1gko9jBW1q@AFo5+XlZc(q3-@? z?o973$A=m?wYQ~WKDwE0*&<;ZT)PZ3H&D9%AJ_+NV-ojXC5?UB*WzcvQ~nap5`1z` zwbx5*M*$g;S^^9>-Ui6L7eM9p0x)Hw{u{h1UZAI7D)_OoN5%>W)!W|-Lfxlfz;8qN z)d~I|tTGI4?Ms8)v8Kdj#S38Ih`dv##Zvf-!2&^w5qE>y@0u{+iw&}wCkUBbEV|c& ze$$7zxI|`YNyAzVmt>!p^{hrVA6Dmycrvu)-J-tQ6JFGI23N4v|22Qbnu1^7zLdm)F~ ze8nh79=GLIFmf>dZYSFNtUP zo)*Ju$jsw#MQIBSqE#`Ua9tH!TT##WE5A=iJP2ZEd2TS9_t9YtK&yuVk36()r#sul z`o~D7bA0?f#YERFhC{?N%@b_y^WC=M>_hos*^R$agvXblcY{bqC{@BRp@@gPO?rZDRW zzMJIQd^+R@QmZ=r%X-$p2w09to9aIYI?-SF!Rm0&c<);|4`Hx$(ImF+*s_NAEc$}4|z;xsDnFkVHC+SQpn1bYxn>B=-|Oe-yDcIbbLmp$1Et7 z>4&M%jN_RBw*3YUg1^8;_b6h~fN>u<+dO^e7ae9oHIb$gek?Z54!-L{KG@{ovD;%{ z+W#7ihHBXFgVx8apC~Ikp5SXsYs0aXyktFDqOcf2z3|_lDafn|r__h*`ziTNRzI%0 z^sDH!R}Ev1En2-1k96_a1I>f4IJvkITfMZERH7OD$_AyRP6Q)PfP6e$NWQ7`F$jbK zhhi_~x+Bw&VZ>h^MmA$qb#%BAmhKlTDPCf3LXPq+kv+wEv8`!&_pou{OpoFFK*?pA=c%OoKKeq zTW?<3KKXD}8NB;kqT4R$ z&h6*4(>IrIbuXgdn!L4=-?OE|d2K86@v85))uFBTB_1}v!XMwJJ3T8uiOjem)ckQK zw};>L9*v{p$zD=Mb@!6-UlUzPD!!@+i&24x2i{{1hoK{phI!uVvdqoOsvjS=nNQx` zI`ElvFS`D#!jgQwWO#Xa)l?+0_@I*p?*H$E>3}FSWA!jwTmZtAxG*JYWTZAyjFKJU ziw|C7c$^hEgMjxC=x38@BP=1QMYi!LlDEgxUoUJdPBk^2HX=V~L+eeR;u2}T&PD<# z%sd{Zbz-kb#OI&>wgC^UYMf915=vtX9bJAatbFyUUrSS7EYqE&F7_uXF zIfr*^mJ5g}1(XEo=?RsP8K5L1HE{fOae3RtK<}|$QvjMl9#WR3W22)c$SH}Zu4RP8(rLYPIV+$v$UzsMp{BscX=-7skZYGyCrAmu4SG^sT;;u%=arh zo>$s;a^j9RyZxWMD{9}|sh`R?x{1kIdM(Hwa!laeO-;pYK9baG`DefXBLed34a0@~ zgo#+ePWPwZQ!>gYgfgO}ep_E^)+r|kc6+Bp%8m7yQNb031CK9t#oii!Kaaig{^!-R zDX`+PbvTzXS17V^`q_sse{ncdqsda`?q)rC*_MLqWBE#6|_zpI)3?iCSFxp2uA3%^UBv(t!u+sxmtFC4zh)sQ~)mk%~GK7?-CviW6R8HD@r z4BY?y6n(X+Yc8`{Ya`yd2s)8?ea%1NH|3AmG+fR1J=|ZqVOXrLtu6lo@cw7d>Nt9` z#SY3L)05-@ox}&00CkQ4=pzd&qRTO0fdms$m!I(p_3v-hDkMZPT^2C(_r&Z{td><` z@=Y0PeuSdWd!J)ZF!ykPmg|BG!H*vPRb+hgcWUJ>Gk#;p1ejc6PIFo!Y{#Nf1-BzS zAp_Igx#MrhL7KgotwMVk{&Ypp{&GXuaGP~{2*yco%>tjATda<*=_!`VQgdmVh-)bj zUF5=1594DkZA6hW_4&^)6LFA+a5^$eLJLkYuY?4}#8xz&`yuGsA0a8Ls4R^-h?Rsy12P$5JqvaLOkY`#xBMJMG&+vs{eN(N@f#p8%b0db+y$0=nu}# zn$~CruV5Hs81XnK@)*r%A9XiD8N#gp#N3&`!jdY-e&9MJ3C4#IJS8K0iQ@Q^;=DkG z;FXy!1w+iEc4>mqq;b!(B-`H?_qSimQ*Wxroyo-`4)=>>&u2bp=XkwmkeuS*%}z6k z+5C}fA*4G^7Q-+#;ksAb9Mh9LwlNw_dQMz(xc7chdrkDf&Awchp=MlBpKgrY@5T8suD1Mkrt}ndy zH%cgKIpX8e(_QA@yrWDI_g&b7SOh;V8Jj_sG0)Qs`>ib&K@MG&wx^WtJ+efm1n&43HIHa`s7A8$as67LvkZ=NB;yvu2CR zk#JCvU|+ndt@-x9iCYP_R7X3d^Fpv6Ga)v7NY9wl!E4!!saf3+1;T(0NYfjV0Na4o zJX0pr!o7%z*M~|s44OpJPAKHNh9U}TTL#0sRWkWZm;s7vW1xYoYzH ztCA{#?EGy|J0Nq}_hbq%O(Wt?R-y6>u#W}lb^;uX-OR^zA#-FZ%F@sAxai(&JHk{% zDNrsdfCL22KJ(J0i6T8>bt0tl7m;?hnT`GanV{D;wITl*F1e;ac2KrB1Y{Z4>Px|< zQklFtj+L7F=Ipl^BV4KETZKn-eeU(c+p0{}KE_MVCjreV@VktgB z{C79vA>;;~{1vwgxVMo;TBc?#3R<&QvVFk)CJQ3j2b}1!@}?UDUliu`2Jv3bOomN+(Uz-;E12z2vVdsV@J)KIS1$lsCE zg^S@B7(;?@xyOw!VVOF3HjZD&${Q_i`=2+Z48i#yoU>>lhZA+DW^JOGlD;hLm4tmy zwrINxTXVtysxN4(EM_veFfWND4RNH}?(XzoUrkZR#X6bmLQ^%yW8TSfshW$+QxAg6 zm!WolewLSPiTSB}v{(?6!cEkkf|NGq7tnko5I?(sZN*E~|?G5e! zkPP0fh8cpMX8>)2n!Q=@?{WWoASCR+ui0e^^S!wc2WHRCZM$ioWf6tOpSaD$AcruyVjn2d&1*L{?V0}_72wxF&^U;Hr zY1G4GZ}CSWn*SKQtVz-)66cRg_WqtTMX=!MI(n|}_z39dYi_Fwg!iWyt}pyjtWGb< z<2B_Al==ggW7JnrAyEJaQFg*v7{fiFyy%88ySIS^*g*t>n{LVvee3J`L%4@BnZu&m z70t`4ml>kzHxHT4hiLaeBR4mIc^GB7 z9n85Fs#Q017i6N1km}IJM|CuU4kt!8UO_{nmo{HlMj4*PFT7}RaywjDy%KpCB!*}E zw%ijO!i7#u>yOQh`caO0LO>2z|eZ?KO?d6GwcndJ_N55UTTC zoSLtfC7$saw6Km<-K36nUeZsj=5)wwl$ELVAczr7RhUET!gr>Nxz3~uedtRUcaxaY z5^_CRy*}r1J6U5FRck2K740}S&B8%lE}#G^f!9okkjF4MZJ-2L7C4P%?lzR~)?Va6 zk?MHZPEOVDi&D=Wld{H3f4QEcrCq*9%l_4!ZgL+H+M7rHYZ4=*6U_LB{lX5L z6jIq-P*9VpL5mWdKlpbXf3Whq|KMz!@3!WrkxMd{TjM7muN(cTX^(vh8fUY@c1yed z$^G)|>|XoD=KhJ<4}TWe6-U=Q?c?-YyZwG_D4_b&ey0<zGp%xupOMsnqa7cp4OaK4$yGa>Fvh`?*Qbx4N4kRm=NhWi~PCO6_-JDwy0b)WX@OAX&x;4f<+J`n|Q>uav~Z*pvyxz^uB zk{%x|wPD<|#z|=~Et~E==vuZnd0o!ipOz=@In1pR(u?gG7+jF_W`$tbILdZDR+om0 zVZf-JeM_9*l6h=`dUhMh1l$)?ypXcTo2 zzMeZWTI=}GHU*t3FQ-BAe~ud#W@2$KpwtaJWz$z|1pW$iz)^x zV)Whi`ZGTLQyFXu0f-6lNRE~h|zDP@ABzH#Y;J^tU8Lh=}#^UckbS} zcq{sT+JMA6q&!YP9P-0J1Z;cW^=xRR;5V;V3>sebY9H=>prQ6Ow6}*?A%@RD z?waychZ$v{Ux7B7`@dDB2lf0=YG_`2K=4a0k;*x=F!TPx{GMXmfAW|jv^>&*VGsx+ zBa9evHaNKJ5bEP-KfBqH1qW5o4_R#yRE0+0b>20wp&@rDrusEO;Jw4YS(8rKM zWc&+ief4#3Vbx)9F1Ty>An2#m6ijjJ>ur`FHVfsOitergaoIqWiRucJ14NP(zHOWQ zrqWdEg=8~Erl?!_Y^|e-ySg!#H3=67y1cMX$WTC+ap{2#IT_kHU@UFWHI)5Eu<+B< zZFpuliqT$0+LzaqWgf*fA;x)B049d*^DNF>zu+(EmMPs&p{utE2D0Z z=`K4ZJC?N>Jk-PFaY6xU2}nrf%0XE`-hm znAZ%uPRP)#I`nddzv+5@Eg}9x9i=xU-R>n_NOJvA$wIihWM^Z9Z^ z#rPu!*Ww3{1Lf{(Zf`j|1L-EiCQt1wy)JYEg$3TvJ%+2hUGopSsenX6@I zl-wyBxpU{KtG4H~VfAN~%gu0Elu-BWtf8p{BVA`y6R$@!L#h^;Z~?C)e&3$(L$D=u z^Gf|N=8XYWA>W2hg4W94Xg<1YGkUM>Q7cKo1k$hE42ebzKCfBor9;nX?xU+jZ|l-( zp3!dT2``Ore{x%Y&uY)udmlbg7PPLz^;eA6L-kN#VMGV>-*Kb+EZ60yDGo2JejBZV zglDcHH4O0rbU3c!g{RU^6r(ivIw>QcWKbHeY0g`sGgJQJ$ZXl<4zmMkBLyEjj4znh zxaW|N5!Y3yYgC}8{A^S+jXBMp>=g!9n?E0oA78IlXjE;3HMTwCli1+AX()^cM%OO8 zJ^P58oj0wjH__Wjt>vgofO9oYhoI!!xBKb3(a+@MrYUVVAHPE;9pkZKl~*XBcmK)O zF$6m^@DmX%ft1TX5#4gX>umy7)}VYr`;;%UfhKjnPdgDf1rz)V@uzr8?6iP!Lor~3 zJeT1iG`pg-jQFfnyhk6FX~5G>^!=-0&_ayC&bvB(O?;KG*y6Fbr}#v}6?*z@NJ?rm z;537681i-`#|l_OUc%7!3le2``+i|`&;em*iYr?bENlt245o4#FDC*8rOP?c3VWti zpXv=N$CA*n zCM=PanZ@nR&qUmN8}!js^``oLVydK{L}&B?rdZ{tA7N~igCH0o zI}a;MEt@0ITbTiT&Q|aHnVs#QKYH}sNvlA`tny{yBRbadprP8Vf(&=lm)BJ%UAt;@{4s~U^(IgsmpkKz|2p@;;g zR6)mriUY^jCbaL0u;s5SIz5%d3mHmFOCtuDw^N0kpR6kSi3zzLsQQLp?G{GIXA<8- z6&NJEfAul_R34zW`uc-Tk8>Zdx9Sr8`4d29sw_&cZjn{(*V2cK9U5D-u5(kLjgI=|f&yp+Gu z=@CdfINS3Nd%Y?Al{C&oEMJlP7uI@d%~v~CmKgiu3xA=A07>}x<;T>9K!Rc4sq!*V zW^B5@b8dBFqR@*Ky`9Yqu=vE3YMR*m^}y7=Q5r8zs(~iW>=`~%Z-@L#7=+u^Wsn~x z^l)Ct%Xv&!#z#++Vq&Uqh3;`mp6TcYPt+7lGAha%-q zi6o3~`B!YIIATHF0Lu8V*_qtwLEcfTRmgklhB{i-%Z7i7(^JAo+u%+u+V+Zf-KQN>$O|7Jh+r= z;ai9;6*6J)bbv8rMg}nBghk1)C`;@2HH5le0Wb1I`|!9$Cij>L++R?^wYV$f7tC7M z--^A=i*Hjw0=}Tz)wbe?4s``^4np?&afstCDPTMI>jO~2=n;3iMZ`o1OsrR-)3PR> z+%|dWSR7UB7U13+MJM`bbz~~@-B^JK0;>&={)m3qc$;1cf^CXxs$2BN#o*N|Bx{1g zn~L3Ht-`0zgKDIGR?@IeZEbDCPmUg#$;ru)_l6yQ0>b)u!tG5mqc-wblrpmZDrrKo z*K(q(lGiL}WEcAGR{f|I+H<;jQdOChAPs-9z}@g)$5xNX!xU$L!&r2;gN)|O+2?C) z2$5Lr`xKJV{?jY&c>iSBQK%)l>T_XP&h&Y_R`u(P@Q;P|?<-iNM*cn>XT4VOwT&Aj zo_vWs7-kluR+M+qqFnx6U2=#bJ{w?~E^a_>$%btEo@CYkaaA!cvK3>d&hGr-{$zWi z?x=B^(+mD6{HaC)_+73#b9$r9D%OoD@w&gS4TDH10-RHUmO7+6#=k3c%i+E!I_+gW z+|;^^XISU|wDPi^rH~B@zML&?X+C*%6j_J&{!S6fxnkN_L#1vLk7&S)EAlmCT z8C}1hqGQsV8s*h2P7>RG`}_K{AKR-KIa>vCIC^&onIkqlE;^$ zwIPO_7mi>m$WY689$3d>AE8ab_9jY_n&N|8W# z7Pn;1mFuTUpa}$?D)YWeK0*%99}0YV7Y((lqO12N9$qcL@XW5hs~7Y|-wbP0*0l=d zExwC0y4xL5B$OQ7k@jOKYE=`g7J+}_eF~j z?RO4)T9?atg$KFC^9Lq{|I{zrItvdnStVUtxVJt%m~O_T-SOIRY@;H7dURzZqP;Pg zLed@)7Ym%p?Nj4db#(ngFbTM_?u(=m<<&uSYH&Q?r)IHo`=6IeB(>tAlNWIUQkyre zB=C`_@5X-OA=Hdo_^)0&0nYePCY&|@z*wBhX4hT9NDrvl1YLN9a4z749(@-ql+$+Mi_v!*^ zHEh`7jlP}l;~w>ZA~B$crMeX<6f;kuAMg?PcruDNOo*^=sH!$mIMr5V*e}K%8Dk43 z8NE$PA|jC&kx!H6+fBP^IuSR4Rm#s_rs%lz7wqgH(YPawO}$Y@fx>g8K`eDJO&qJL zL)`Pilm#*TmK~b7L%kAn zW~15PdNg#x^8ky3DKHjmXle$O7iXTl?oMS;_w&X3R^9B%8Y_s3*-E=00G`reVEz`yFVDVz+SjvJP*xvvcETy)!9~pRlfwU>VQEu|yKzF1JQi#bxcN!m^`r|^fnl_} z?T!ftt>nTdG(_1Y?0*YO6v9IpZ~F@<`fZkiRZ#YH zMs2lxP)d5NhK)2T_ov?s?bU>+tQ|rjp58^JURa&_-PmnG+Jvu<*WFHOg~AV)Ugx?b zv=&XMEbCqPv{zKx>0vl=UwES>r031dW#9=5HDAKue`wlvtjJ$o1v(Uc1Ps9vLpyy& zp{9;phObv1adB1kpfG)-vqc)}b7oXC>srZYoHqvF1gMs;$NkCmu1@E0d7NK5rxL-I z^1`YnN6YTsJeD)~WjfON@6&)qlFD1P;{0B~lu_$T z%STCN9Qoad*0)JA(YRIyZyKoPd34*~y<&lCoKMy|u+Fqy-zsfr3w`DFd#e`4b>$H4 z#_G|G6_%8YRzi7#{JQxu`ldttsTK>R2?>?yCz5@*vEBe^K8y8CAw{X^^j255cHnya z{7<~L+8-?+OPr6xfJc%Qh^Q5VibUC}Pb{gv^ZIxTbsfA{?HPK?gmt)SRL@!_{MzmC zRuFDkgpm*kyzC3Rl}ggjpoTxR!oAaFoKP%2zzNgx2fZNEv43fD1{0574!)x2=dZ3B zl;a?OM@)S1m>c|fMA#i-#cCE#dy=#vCeSJOw=khb!DwWMQf>cd&R1WIZcQWgaoqY% z`n2a>_Q{-JmiXIfpw9I$U)1$je#*Bux?hq6$2?QAPI>BfnOVATC!@jdx%ApWU@|)~ zJSOa|1^!BwW3A2PO?y~S;`4G!s;jOV$YEk2aKne?WqY^wlbYb;-!4!W21_k5eEG>% zud-==9nLi>3{YHvh1(QU}K^(3>^$VXR>^4p0`Ty+n9MSqE@?N`J-MG zzGjFwk7*pV=gVI!=CfWO*&m2K)1?m#YY=5qM%l*O%djd++mp%mzv~A0I8RKf(CyBT zC}~N`yR#;|c)@TVo>m^YEd|+)EU%a5Jat(Z9mr0n0u_KlDJp0=W$R^D)&hfX_YF3) zbA@WN>CID|uv=WGh!|p0JXsS)+~oLp zBLP^Jgpdch54bf_yuwA`!Jb04L7ob%i|^t`agcK;11JXz0%!*g09{}U7y%C64nZrA zNPRp2j5!RHqT{Ie6sbLFTnT{MO2HwE6$El_yRR7E{mkX?AC?_`^)Q@`4Q*Ay5uuUv z6(be)Tind_i=Gl|0XbgnPpweEgw5K~gb911bT61*#vD4w@o3u&=f;Tm;mM1Dzh6Z{NtiyHOBn+Uy{bgutib-j7qo^1+Ci(ir!O zv_8+|E;9OzOI|;IrhysTExg0B$%qF(&WVj2w;fe~GZOa&c)?39A_-m=7*YW=pw zHq9{mwFViT#aG9c`pw)JiGVBwtAr|p-!1P$y!DB+K8JL$gxm$yyCu)jXhOZ~=PUxl zjGJ&zctGBp9gqftK}h%uD`nI5zs(x6Z~tV`zu%kq-e5HK@IVZQ;mN)ocXZ@=gHDc^ zQJKD4Zl>fTx8@?si=i6ePWOq5CnoCtbAg|q6C6}LY%mbO?b?}Vxg&1cT5dt@5F?(c z?;kcZl;0?XrsX}N8etB=Xd5YYl8Ob)H=w@0g+2b$&J^IiHw}iRJ)bu0I17U?sPB|! z?!=Klh}9x0hraNEbyj25WhJ8B8mE}_lSUVW;lgW`@^n>VT&wy5lKUUg%2U0DNiLr4 zmIiHxjTT(qY3=@^Wc*wO4;VufaR`v8>SXzVQ7#8h%eOP@dz_*fC@2 z#afE#Bt8Ni^Gpse7+ThMy`YD*1Ddi~0Om(w|kpP35J5n(Q;|JdYYX*pZ=r5E$* z5}R)0bR*Ck^clwpV^50I$s>eNIji(3_j9l2*<2Xc&F~x+a^|aV+$DrAwsLY%NW!>Waf!-2m1`cT;Oq{_c4A@lVNzt=-;GI5DM3n z%fzH|*@uz*5xr^*q>d$tE7&gdg-4t$;Gn#_@CQ0%`RV|4(rL=ndy^^tVN-N1E1eJo zUg#C-{nvhp2#P6CLLx4>IE)8xR+&_u(P=YXJbp(4FLn&LAAIKjn^+#1M+rKi2q%VL zsUuCdzIzC-VF7iGm{e!_#<(O9B5HyI%9oVx*UvNqRe$q_g})zerH$elS;B9PY73MK za|@$pk)s-la!`9WBnIXodKW-JWS1-OKGa1c>}ePHCdG8F$Ne)iLUwH_-&|!~gK$AL z@b}gTLgn9+5Ch6lWm()qxVQ#b7Rr(#w(OX%(FI^gTz4sKrq8S?Pnn73QcxA309@ji zZn70ezN3Gw={@MpdMOnsEA0U6w%ij-CP)f8&RHO*RQ_t$Jnjr729a#g9YJ}v4uxcAovu zO@Ou%$#GUBedAFm3kb|6?}J3-;DZD}L$XMPBm7K$TOAh<+E}^;8Zp=ob-&FALY~BW zP?7LjlLx5kNJQ79So|FuRw9lkmUq5n?t|1JxJLVJLSi#sE13pn5l01@Z0U{EY#mfb zd;M%46~%bw{-7m{g)lNQeUt--<5p()XL`s6AQXx-f^Pg?T`+>cii}ItPV`6`C)y>3 zIOQxD3#Re`P_!$){2guW{4%*{@WgjiO0-aN((6~u7Ur{RSy_w`Dr_H&L+uw|FA7I9 zUe6SU+$f4pkxV0Q;G>N7ZJe81i!zMjjj7JExd>#~EqNQ$9ZVbym-dqv%}O7ggd=`2 ztb`l~SnXLlIz1bbkAXe<`5_HFoUQOAqod)>Au68fHJmxOm6jzYN9e_%)cYgO{SW!x zT53O)h2dEyCnfg=0rzn3Ghde?w=6G(N8#08*QAMzhuw0fc2>eNJL=HZHFPmuCwML| zBiM(_^bC!Cp`#TptE_{_%1Rv1sKp}hk+=$boNv8=v#)-pdPoe)$RG*iNm*Br-{uofhVdj95;vY{A$1+{}qaS?muHr7t z7&!Vc$u$2}x#|+>mDq5f;e!XtzJ$^rf40OzhKeEdYKl#}3^&R+3sqzT5)UDb<|(WC zXk)w`5-^72L{WNJAVah{3eMSL!SY`Gj^X+Q_!V@>$^67xyp=5+8#TO}ZuON>oCUZS zYS{KgxTbB9X~*G#Av^{Ug>k9SJIY~KHrR{XA==c&&j=a46Wn0}My7yU?q?_c*}^!) z+(Jw5Qg%H~DSq@pl%1Ae_cUjmtqMHZL%z;i2qykgJjvWeLVM?w7xXumORF&F3-*ou zD0CR}JoN(i3RuF@mnOqsSCS}pmfeH1bNjy}gN;09g!*R`r^*hY7}A~>C4caWlRg6E zo`QqCe(Dy_NN8A}sS7hBiuzG;d+W?Jim`Gi>cyEf2F-ZqpR7BrM*XboGDc2J2!olk zIXnD8mP00lh{OFFHKD%C=`w{w=(EuCqfp%q&f~skr5*>(h8KVKMXh2#+h#T_svmwL zqR*!W7RS*`m1pvQI}OzVRdap0ipU0Xupz^Ni*3VIeojnT6WE>)TcK7`z*4 z7eH?W=IDm>WD-nbqs-8ME)GqN@Y{X}F-cQCt-G84!byiLBbkw^?$Lt${9miyFWjpV9JJm;r^bKvH$Kqd56=*8bv~zcDOvX14nJ&_p+G&o zgeWA8*F&?uS$RPAKnw0NdQ1SJqa{)*HZG4M3kT^Q76vu-j~$8n1=0Y~ywp<|LNQ&( z+{l1gATs3kz&41or?tW}ju>7*6qbzw{8h4im2BK(XKipe5&8(8M5>HCm;m1y0Qa{d4;3)W4Z=MDO8}R{q1`J?ayoD%a*axZAMF82i@aNmf z#QX6OHnsGe!KGgHEASDY1Q1;+Fm~`~I$P{W0g- z=Q?}#KC#x0wbp$vORk5SLep(`7?k8;tPnJt@hAWL>@I#BW}RL+0d+N4DT0J+;>#IlsDdjh_=Imd{|2TvAl zBC!d<>x6&5V!M*TxvU-3m7z#qgfoCFg)9M$zOVH1YWI9?P1n(wB*ELjR_MDL_UMlG zj_^@Wnr%J>kw|Sc?6u-y2sscY$4-ay`#>S;1tGXL-@E|Q(cR71L6>xx_YIPlt$I0K zzNC`FXF_6=l_fawb7admV{69m-5Hh!xYfQa9ql9YtZfajDr#n#q>ET#ec#o%-4Bl} zf&70p8_E*<-4=1#8}9O^i4SrWTFB35xVr1=OAQ15tF>dup2 zqzeKZcapBDh?RxmBk@q_832_T!Ua$o=F{?S|B{f& zKtS6h{isj&1%w@OPe3W(NKqiW@wA%-k`wxTluTtYX0Y;%UI~Rz9Sj>LzZ^E24zO1` zlf|(=+|^|U(HY2^0p@aU z=i7ektf&7ZTYrr19eNn6v^FWfg!`wuJc+9S;IBkOQGovn_o5f)-+)=8q4#HOxDh27 zWwLbL$7ZkLF5!AwD>6X-YGL36On{I9{YzfTO+fH)j|9&Ft~dm-5h90p$iXwFyd1#O z?SW>Q(`CmGx1>ue>nu9~u#6W{k2lF9?^F9*lF!!0pxwH+naBdb=p=}Vc3*5o@D&Gk ziisZ&fl8j?TOl%^$b%GELVY!X-OaHE*|5KT0T|mKVK&G^-E_3~3z#=V@G3+k&P^Gy z<=udC3waKwGd-#;IW?HIWlmy8J~a<`=ymjP|zDl(fqKVD=C!SqG zhknYpaesDBjNo;2LyCmBDLUu+NvejTv$3eD1OOT(G=2e){L7lz^4s`E4olgkFlDMq z^=G6Be3tvM&o)zy{jg|kdH11YYOX$uGTRgjvFJYR>|0~$RKm6Qvc*9^NogeEzNX#M z!$3u>>g;Ugg3Fo5^x52zTwtcS$81I=guVUZcIS-xmCyI)iBRI?jOnxp7{y22%W>~d zhd(T*kJy}}=qJ}hzbm|MdYApMl$C_asqx|R^EVLyJ3qv9AwjV9oTC`rp%x#7@A(** zpvW;deP=z8M&99&BjT0icDH-3!@Tgm{dErG`kp@s40)~$zwH4zpA_{j>Kl8_?L;cw z-)z{)?L>zf0}#Mqy=Z`TD#E3+6cr8_tO5=IB!Qs_MedM9usDM11HLy^?ugf^6el6% zoScBMj%P)!^EmW=KsvW2Ku8p)`_CE9*aji*YKt2SbOI0fdCS3_KLw3X&SIsj!8z3` zj1BU`#us$BA}VU?Up@!A%Rk4ZQ+&C}YK046LiSx{WrvF%(SJAI!Ks`$06J~Imt>SU zV!<)RQQte@HRhrL4O|qc$+OK#hF|3J9;+XIIb>XXa7D44>%9J1)^%L)?YLavgko>R zkwc7@^6#W*cX-m_AVD9e7jg&RD(@#UWKax-mqfvfzewxOeg17YQ0WgNKW9?jOO3lv zqRV!LEQC~H^ZY3{Jxvb;=A|vkmmw>jOKk!0`#566Z5-_QSz3J*`{^H={$+#JhAKOU z=?dnlIXA4sd)EVJbawkoC%$`#DMHyR_WJ4bwj+Gs=l%Erab&p&bI}@4eQ9 zq@GTWD$$O}oUga!@b0ZbJcHfz`$;lGkdTZZl@&~J6Vf0NZk)E3&_^dofqDxp$r$CP5~0o&@_!_wqT zHn35X`$?X8R;~@xlFp>#!94hLyeQC-_Ew|aThC%|=gMS$0M6`f9SaYA*yF%@`|EZD1 z?F9Frh!$D*lczLJjm^t%8t-DuyDb&co`;6JIug(;yhO1(J}<4W>?)Tzoc03)WT4{N zZ~~5^hg?2+NZ^}U-*P^ExZjj6t0}E(s}+eY?LTT}@EK12L>mFwWH%~Lz*%i2sA%+$ zN|aG{GmDmm%caF8-ndfC=g=QC8^pOhO!|#WSm%3bx-zF_#A4&4){IPm%YoPYC61fY z8AfijsKdV=7aK3FS!a;fel=HA=_Pn;53KFP=5j<6b+ zz9L?x2T_ww%5>;*Ax5JjU7y|pGL>Ye|nO~M*#gXoqA zA9=NQd-lb?y?6;{ZM!J6!@?k@G>>%_7=dnWt@v%CCujJyLHOS@sRRdYYpJPFTlllo z%M+Gmu5WC7IgFf=-E??^m!*@35T8U@gmL%eD0X0ubz&pD%EkkZtA+&Ll@no20~D+` zfurzMS7lV_{Q%AyI}GmrS`l%Q-mI2tM+iZv1Ld4~$WPv8-`8LC{>0U9J?dUb;KJtI z_)J7t9J%%1O(1sNI;j6C_1hUd1|=gF-6)|RY+~jla00qe0FZ=)ss+aupcR8l_jw&+ z{{~KGKCK4dM`z+_8dyv%^2$vCPC(;R*V_V{v?j%tLpZOSGspDcZ<|C0iy$F{TYwud z6enz}xC-API;OCdf*K~07%FD|Baq=!d!(XB{(uLirczF{&lJ5pj0$rcW~Ke9YQryR z%#a@#x9t_6)9yY|yh%;i7Y)gEbB}&D%G~rIpY6&rMps%Ys$RSQ%+Gh3E^FA?pIp>g zCQGs0YM3xyb;^G@5M6NRJ})T%C5i{i)nD#h!EgX~RWH39*H}!jKX~JE*V9GwQNZ>w&IVf(|B7W&e>ity72Ug{;ho4dRrb08&0f*4S zVH?Ny_;5@~bt#4l>d2>kktIXJ9E5)nMg2TsIa&5X9NqWZ<=SgsF0J%H!l0)PToFQ%Z#QM$eh1jVe?s1#ES#Q79kXF<19=Ok;}dcj zd{(mA`@W_(>RrYRh!F0wNE@*$C-LHko-L~=wy#m#?#1J0l5=F<+->0{Jj3`a%M=7( z_N2Y!y+s_t`M%4z7_+_gO*&$`?}f&0B?UYfXD963ifE!wwT_litzSG#cH58_dH)iJx7CDx0<<>dh@mD@Y0=H_6seXpF|A6j;0 zhVm6ipftLT%wn5MUq9xK9hs@-wP0llSZSOW#oPoVM1*g6FkM|e?U&CmM-Dw(eJZvX zv1?RcZDLRP!Q3*iI^3<(oAShypfrv(8lo@3PT15=71mK5259_12wJlgFQbB*G!3dD z0PpmDC!ckZ({zoX-LH84iuS7F$SET5~y4^krdF^=VtUt-Z&^vzht(m-T zWAU09TZ9#MCkK+}EXi9v1%c~CR1q~&aPzZOSmm$>Ib<$@1?oXiT8FR932$;wj|C9U zWhpFk8){`6>%2Qcind)`3-;2GOP*Bx7QC0N^FEd7-LqL9q12-^n(TnV^;~3&S=n|* zXfm(d_9ine(E^p#Box)^ce!_bi!8i6w+?6v2IuP+25MpVY71B1Gd|F*G}Gw4`oH3% z1i&$F%SK5XN2!X_^1OD^1xJ79sIQ(9b-fy^O+y}BIgCr3K#85E>qYeWPp;a)s!V4H z6w^|(bM`(+UgS%=$6YmM=Elv|kJQmWTVr;_q;~Onc48{vrpU+B4rk<2;!Q@~?DsFL zC1Q0^o`!N-|Jo1Pu5R133{}0T+t4z3Iv%l>@r64n3Cpz`X!gD>99mO|AI`r((nzlUBlCD=xzGA zlti8EyGbQ$^{lx*w6v*bq$v-1f)?C;xNyL7skblWj6uNBsljuO*KOa^p!HPDT!@q= z)Y%{#V7K!RyAyqgY3-SLVabpFq?T{mzu(&>h7t|?Qv(`vSP->%EY zVW?ZVaB|vu?>L;&@&;8q+vd&b{I%Xw=0}QN}2$*?{MV1c! z`)%L`tek~VnfKx!h-H>|^ujwL`Qm_b#QV15;7np)l01|7WFN~lk^0P}$=!g|&KKdn zg)Ndlocr(G&NyM*yZ=$Tg#+NYX2@OO+&hA}ec<@Ffg~`>9tKYdFyAHrg01>rrPOCx zfd4sW$@!jCM*h#)exLvgXh%L79~Fkx+Mm9Nixv}=(bRLm7zF$EJ{$GUP!73U*2K0d z@DpEoF3kI zIAVGpE`hHs0oEgkKm3L8dKdPI#R9{S)z4DwJ|{fBg6mz01lvh1aLV?6?{G(goiEX-apWH z#wUQk3&DksW#nFip{wi@INdLSuIW!I0ohsOo(8W}>Or9Z@PCyF;Mp($eb`f?r?S{0 z0W~mTqPvIM>DJkWiv-smq9+{pcWz^lGbK<5f zEKL2Ada~oirDQVMV5p+egBvBL|NdHXqjQP@1abRtSb39L`p&tp^`<|*F;I=wZL#X3 zj`MwBpl&0Zmq=jhhO9jHdH@03HY89Fh{DYwirdQ77%eI+oCjFBxEyUed6>PA^~y5* zt^1>&;ZyZ&P?r7B&*#xwhC&V!f3OJQcxC5RZ}0INopmQJl;_GDvFd)EFto;zxcH$f zHsBkX{O&82|5|_sTK#Oi$A|h|2X`iZ!=JL=P33QNy+(OCXPGT&w^f`SNv$)s$EY-# zQbu`c8Pfb_^o9IHc((Qr4SQtW|OMhcKFMhO4&ySZ&89t z1Vr_P&#S+acWrE`G2|(p+9{8IfkS~6r9b;ZIc;}p96A<`)Yo{>7#QI4^1%9XH!uWyOFT0O^kP^L{ANA&M7Y{)vGY6qMw?2_Vpa~e~$nP z5PKgIc$5zV9H|Ej{R3F}>vO>$)l&E&2JtdLJD%y=JiwRTNvH{ z>i`B1y0fFAViV)rO--a&l@!LpGZm7w>)3evPvr7$vHo~9Mf5hhk1cIEkF6WKLg6i;s$c9&L z$Y++kb{v+v#%4WLXlQ8W0SXH`j(O+K-5Dmz_IT%3si&v4w1)$ z7LNi^!^4^o%OFc2w!1FVpg08qp35PgzIBm+TH^N-XO=V1^s>trOnmo5^mZ`f6KNKe z=TA$}85t?kcnS&%-3?pccO-2Fo}xV50FOqZz`ooseebn$$uhNgY9m4&uvw4JYmWNi&#-3dfFMe*>x6UBn$@At!`rcDe z+*=-~n-@GC7cCE^Ua%r1w0}KG&{Hb1$WT!VJwhTti$^i%!A(yWiHMrmpln1e1Vo?N zikOH= zzw+#GA>FYF36!DaiG{hj(B+&h+viV(goIw1nm%i6Y^2xX6a7EgOUFM0~CMmwVtkgt3nJV%><4=q6c!^z&4?`Qt%Eld8Uv+g=!Y4Ccxzb0SuupDf2lp zGCH-lGmO|8h21_FQ)2Dg9Q$hh=exEs>5CYqC%4zuYH+_b6f0$0Eg{Qs5kcLzWL|BFMb z`i}RsuEg9Q%pW-fU&4Q4+{i+3cJ7GZ}Vy$n#yl6^)cJ3b^iJE zL~i1`Yf~-sdhQX`9K!cU^!CocmfVjOYP>J1BxB;UD=+a{rnfWD4d`>H0q#)RkPu7h zv73K6T8;tF(}a1#g#2#zZtH4l9$5J=xlK#t&&}2{g|N7QkRSh7gNDRS0&8l?_!|2S}mtbANi{>INd;|6YEwFqGd>iUM0h>3t;hs#$2s{G#ffJALNnWYB9Rux!x(g@=vpU6 z{{P-IJ}1_B7b*%~aK%$DWDQwl2&IM}0$f0-Y{gPh15qO(T3{$o85CdU?!pqo`Gqzg zHJl~!t-M^*dnjE{sV9b+tL5V3?a74J05&X1(@?qe6H0NPi@#98Gm)xZRSvf6f4x_K zyd2Kjf3h`Uy)#+%$oL#}cXxd-)H?IiCXxkQajIWq8-L`Pj!j6(NxtZ(>wK-qx?Aac z`u zrF+rU_~@$iaLIm@3V$KadG_G~l|;HZ|3_NK zZv)L2t?wQ^n=<#qy^gzAFM-wsM)U-47*#M66lEvHi|t|`dtqtl)HPGTTI;arD#^sT zUYX%{6kNMC-{YG^Ijp+riB_7T!cgjWnKU#!aQLxwFcc|YO!wy<7F?A0)T4Aqvn|B4| z{mJO~;QK8Y&BoA1lM_(qzB@hE(tb8;Z+*1# zd%W4p*>Vn_#T)K>vI#57_WfaHZ5`iEp`$6W_q=f}L2d19&N+3m%!ukm^AE@bH!dgm z+Z$6K#g+r9P!4M1V0u4vrdtf`HTK5!9lo(4eFcDvT)#>e)l>(M4KO6qMvAII3?`?; zX)h0`Fs8UY;jDpab;55e+V7f37@jNFe`VuND_Xi%#Y`OIN#US!+>ms=rSBeP`rn%J ztyyMcCXJlm3I=2^3i{k&6>r|sPi94+=l1AE_;7CQ;8%xVI~r%5eP7z`9lm3Xw`T_s zA9Z!Q^LJHs?vtn9FXcHST>DNyw~X7vOGx;0ZxOzp8EJ~6f$7UW&YUEtg{D5;Hzwb@ zWrWFxM?(2oqd{ih^@C>?@t`RBnvXoO@fgel2BXKl--;X``#UKQyU{=-+Yt@dSimY&{ad=vuelS7JrH6urGll5eZJ=uHr;gSC9T;hXT?k0`&QBiF z6lZ#`sJLFPr}`}wFIdl>q?=~4J>hvG*iJenA_pk`UOMQ`_Ur!y#(mlcVFe znoPIJ#*&d!468co!MN=HT7d{k91X$--uohX%HtfppFq$_I-1MoUi-4!>3##Lyy2l6 zQe1PeT8PZWpsJ0s(D=I~fa{_Ux^K?8y{ubo&(Xo>@E86BEmW4`#o-#Cr(vA~eYWs4 z#dwl5z(w_%J&?jFd+eJUtc>8(S=S z!wY8HCCDqa04)lKR)Mk_GJA38)mUv>__Lw!>~Qo(CiJG0>qhwrp)N4XzcEi=fs}0} z-5UfR5q#Z)x>1nQi_G`xguA*d5kv)Coh7uT^%DS*r7WdYthLoXf&6#ms#GVTj_n z;W?EGIon@p`zK2CAxUTx#pBbTQxbo#45Y*9x>6251dL_d zY#+UA0c^!#Exi&4Cn8h^+$s$WwQs`O|J0W@h-oSKY|##l zKI9K%8Sitxev>cVbAd7nnJCWQ>c86bG9@ny15F+${v@(~MRO2o)ziY3ex^b37Efn` zrayEhOu$Vx-U^+h?DJ&n+~k0yU0+*U?}@~U&?{XEa=R(Yk#g%tIo{T_7uqI`@=pg! zkgGF1g-5rxuYeqsPxyj96CV>xTG*C|;e5esmZt&=OuWc;tj9Io4`T2osD}WGwe8>hvD&A~!k$Kdd{X*z zIE15+`RGAs3i9D}q-ayZJkkz3m}GLMwF2pX*!WheGL2CF{L8?5MX)EIJ!R|`eX=)~ zda|YwI21@M@bDH^apyrptL@N8y0?T3XJ2i=~IxB7XtIIGVlbG>1ZsB@S} z*h4Dg#7E*IDA+@csG^y~D7Bs_JnmKn;}RGi^U3|y5Lw_5S@IWLA=$%gRG*`Jbvt8| z^RS#kJe-VKb&(+Q#bDFvq|thckrTg9;Mt7L)5mF^?I+`EM=VeoWvf;t=ID-GxzWFG z%y>p*?j_Hme<+@5G!Z{*K=7-WOZy}b&HC_7tVl{T+MN;CKY)!7zp{CVc zA!}NjUne0aU*I20oUuCb`XY8EP(0K7|Nd9vgi)A|gW|p4+7T(q zYBdj%TpR(`h>Lc48fZ{Y$rCQRCaQD-lRp~==Pmp{cGnOrGZwJRO3U2tO74tp^LCI^x; z6{+DyuGa0%uIq=r$7`&n-hR9-f4`buv}3I1OXXH!lsvQNq2yrlRtp)0h!B*gLA__| zniYC{GL(vQy`@%4uS}mu=aE)2{e%sJdXBJsq2{IBWSK#%Xuc_@iZ3#h77pRGsIn+7 zD@ihGUakIG$0S2uTwD@YHp6ID|2o3Q=OBc)6FFdyE?1ptv5tQI+tNSb%Pdi%Sy`&q zbG>di@9gr?4Xws(ArN7=9%)>>hUVR-^pRvFhA2kzSQ+(LzRt{hIV{dxRjx|>OVlz_B(r8_fVVyBF_3WROb_DkO}|<9cKX3MWc*btK9nOm zfHmMmyUvr%%zW2-!DDI}2udfo4bTUY1Myr)`J=+Yrh1Tx6CVWt_3iWv63U#5*`B}yN-*s)9P&@l z^g$`xhSZ*%1byel=GWLqK|P<$0Kp%6K8AVbmu@>M&dIuC(l6nyc#j1YgjqNsGqU6m z1-up5{OAb5NAn(Hcs=-QyEYktKee7ldT%W2h)oN9rS52RC~UZndh99MUP_c-syPK*`Y$^*%nt#=+tdwqc0&AgI!S+0>GJdNX;;|tRh zI4GtiV<9^sUHmzo$&}WUCCvHa77y_LgyS6k6k5(iQ|OIOkaj6CSMhMm?*fSJR--|(=f9`j#18vabYp)l}fv5GSb{g+9hM<-7w`$CBN==vE zR{t3PNGuW*53U3;07C`jGpqXP#z~I_C%_P-qu!wW3ptS6Bo4EXPV@*JppE=Dv_UIi!}pyNw76nS_)) zMVQMFT;HBA8~ehP#RiiV*e2jw&;4+ZHap;(yB{lH>6+`z!(a`CUh zh?Cyp4%XXO!q0ys)OPMb`t&{3FG9uc@3Jn+@aLb|MWF)N4LyZ;02$p!ml*86u!1Ze zy%j_|&gTW5Y%UQ5NWVRayxvrZ4=p9{BzegyZF4&bnR6Lv=6;%gg80GaKnm37vVzO?FTR?d8xT^fa5bt*}H zFPc@FgQ>)^qxH2(#Xb&JiUO63O#e`TaEbA@f8c03f~d$sCG=*ROyE%A8m2d@G8^3H#u894 z9M?P;^nXU1B;a~70bPLRYLGXCJA<G> z-g~7lmi>h3tkvmF`1Q!-cG__>rS_}yA6KW4p-pCw`Q$cUTXushA5p6}WJ-NbW^R&-uaqwoG0EVp7->+X4rUbl*-Jf za`Wbp=QTEoCRf*gB3;ekK{IV&n46)pZHc(bG_?Ahh4p~qTj-|84DO^heh==XR$B=! z!9RY07s=B%`$a!+EpU*$1~r4jPUGWEw{5Yf{tXo-=W`N!W4+lm8jQr5;2E4>|Ey_@ zeC)z-X1=}1q%8Y~zWkP)!Va2cRxfhc?yT!@Tv}8TV-tIvagCbiv`4^Ol3ZG9Kq4C1 z@_xIk=|6Arul?Dz@lGF;PbC`}0Hz~{&{JIN@93vh}ZFo;~vWJHBhe1WDrZ2<4cQg+Js)Gu`BmE{QE@Q&`Df zp46LV1{wm^p4oZ200Q;OZZhxsXPD{F2h)VRhTH#1c32=GdP9~59d*5;4gF0Xdo-o8 zJ<-h0UzZrEO67ZeSx$$Wg|8>X>b@p?&ud{YLO76ul`C)b8*@9wZBF@m80k3wNs+KX)BT zNG@S2@+5c0D^Zir=3*5I^q~BNFi27w1E`0LCO+2{m|C;KWUlipQ(r9Bj}q~CyXO?~ z{txMB67>NDiui!2Yv^4Ggquk>U;(Z48|;DKQzF@{i0D)RZdL_|NjCUO8ksRUfQ|}! zRTa?!WOXUVnE~2imrgw{a84;JO4R6Qh$_U%V-hY=*6MsP=a3uExC&5v*>KnB00uPC!`uXZXd z)0OVGl%80D%fC0oNas31NKeSEN0s7q2Db*K2A?n~ov{@(;DxXa3UOwB04Wd#l;0Ib zZ{mm(65<)KiM{l4Pg~t&JPnonr9rDewAc9~&IbO7pEmyh@|;PDHC-OY04y0JZCtd7 zatl}lapbh?r2M9~q$1|s2s$AQQ0(0p&N#Sge`rGt84hY}ga{~1wg*FmO0tZ#wKYA@ zQ>oihF}KoZADf3&L2c9RtFP{|>PPOc>kh8d$_5p$Sj(SG@-xSlubTF&zDqVU4W666 z-L>gIA+`P{p>&IKnDW$<5UhMdpw;oPgbm+rK+Z8v2&(ArMqo` zJ6HR%LSISshac-|L3PZ1txP`~i0byWL|diuS0LpCwLZX0U3lS#ECaIl88zEp|47jIZs9 z;77><=P$$sN{vxQ8}Ig`t-p+fhYs&7=r9Bx3}*|@(HaEkm65b{9;6;uSO25AiHzQ# zbsu5j_HcUyw*tQU2;E$gq19hwB8>AjAc*6BR`~!dB>_Cv(3Bmms-CvnnJld*-4U6+ z!V>P0W?yOzdsZk%;9_X!?!~v{GER?}>hYe`U>8FM7%r!pc=jIsh(v~)+<)|moEr6) z7#exsP|K_K55Figg#Ru)EM0&ci;pC=T3n*femC&~S7wSd_dV^X;n<eD z6h)~_3ireBLC@e*N!R$e(axrXIM%uTesAxk#OYUhpi}3trOGwk5+<-vB-}wa#go4u z$o*3Y2u8i)6lD<216Be1T%5eT!v27?om6H`7^)e1$d`0H_F~&^>J*th}{a2R~<4v_4eAw{ttJG#(DM>NynvgZh5F8N7 z6dY&HvTTq^>^8;U%k+_$?W^79ODFfK1@>;=SMmz-u0UGQFY zm8J;5zrF&`Z@m0;+1%egb{n9ZL6}S5@x<*)c(3lvKD$lo!?|_2jpo#jK2M?X>?^y6 zHSGE%)~eLh)^X5qcz_@){@R1QL`kg$uic9;b*eJp*QAEKi-y#52@Zyzts1FUr{+r;W{< zJr8Jr3G$GWC@^Zo%`;fn4NIP}{R3B7$~A@`9-~1C#s7tyVvH|ViOKfZze3&?-wRHn zV{vx#_G4FuRh^=LJc4H;5giQ$iuRn;a^|+}yzA??zp`0QB=zWmqZ)39@yq;TmG*|4 zn?>XJ=7X$uzd7Jrz0fb&asFud~wO`)&A%OY~lf z=ef~=G>*ff4RLGBd0AI$`+0I!Kr31Ob?gy2a2)pX2M1iU0*j)(F!hGJ30FCBk&Iiz z9pbv=WYp$cRO><x)*lcEE!T4!mXtU=F-U*WvMHOCKmSX$udr(<-mD&uE1RR6}z z=dY84AA3oWH4G$1IsY!2Uh0$U>vz$Fka_dulmbxI*m659?#kDxWX%xcHVwBLXm|^>vm5fjd)m)1OXw`Nxe$lBVN;Z|6SU6n8%&amoF&V0-GQ>4{LZ3#v*+=IgufdWy4 z5aS0`?+txF`vbXv74-O-INsJCqU&;%wnDe(*?_!OeR`-;qd0K-cNmMnvgEy3tkWvd zXKxxrb7t2HUUjG=!f%ZS1iS=Y^|Rq1SP)FKa)|YtUSH4-9^AfBj{+zs1@*w)6>#p) z4-cp#)ElaUdx2z$-8nImJ&dP-hL4hYd#+Qs(9)})SFEF^9QYpH@4uP0`m*Uh0B6}$ zk7o;;6UvLRiBt*XOTR6b+A00{I9x2)2Io_F)&3Hb{#W?%2Xc(i=^JipgvVN+FhYDi z5}x1I@Il8RMRbv%+A70$z#?BSBuDMjphuLp)u8Arlga`ZUt3SLg&9=FShi1!Uf{I> z#7)1eILDUUxBEKU5)~ts+y+-_jJD7)9y%XxNKr2HEoOBx{J_w^gtNBRyJ_V#>oPa(5g+y8YT0H9bi-s)(Ju1_2cC zI26tI=)+%p7<&L({7l}bmo-SzY1dmb&Ig-{v&FR`bFy5CkHK6v2OZ?DZZa&DSHHI) zQ9s6&G^+OxBQBlihCd~Q)Tz{J1SW}%-SlOC6MlEY=@gcr!wl%u7m9Sq^M9j9Eo z${X_FRqo>>FO*;sD^B5i+LP z@7;+b_38v-nc1f=KV9deQ`w2{HT9iU^{1ioi*E1RubghLc<0$L&Mkrgizb{P;(w3I zx#nCX5*%aB1=phla_?Nk#ChpIKmX?!aX?S=90^D6D9CAfA0+;H^E5KEuw1;zQ?Hqs zyKTD0j$J(8)%{s9jujT$KS2IA3sa74*i7#^;A<;t&Dz_fT9DVA)V&w%6O!%?EW8^? zd6?S3vt^a4$C*&g$$6UImMMNJe}AS=F`#h%XeV11@6-OkHi%EP&-P2H4n#B5wmAX4Ur@y5sM1!MZh+YF!D_w(Qk79F zRe*JbA1*|ZJ*1^vbKA2yt-oSeFmIntUoyDyqy$!*f>FPI0>q@>0$tVj!OHv3Dp4K_ zxO(acro>9XrAs+KJbOqAkD%mcAz+N584D9OdFFLKds=o-(-teE2!~T}7?_yz7*_rn zzKG>wMrNB6qj`^1KGX==`DO(O+WLTkT%6P6s`2>;dkb*12@OLs8ye z_&(8(@=l$(4rBr0M^cm35 zPc=fj&*=mghR`xzTuEUP4$1gRON@XF6JeV^GNVfW@PLhbRv(`d=CQmEQ>NOXgC&zx zV{;g-#n*p#{nw675p?O8EgQ0x1*VSK2&zZ3yILF5NGz_^V9bEw^Lm$qShsPDY<%UV zP|2}iZZN8s4UW1IeVC%~@Snir?nHVlzuq)j6n**fp;^GtU*W*{P#jf+!$-gq4-t-o zRNQ*qSYu`s`HqW0e_)VHztf53Ig5c+aqE)d@~2zR1S2YzF*3)QWE{D^6B2L8M zi&lLL%X_`|ZjVytOae!4i<<09cQV!O(utg^H@qd|UiU{7E;P%*FRwW786Cl39NYW= ze{}%SaToC++PonQpu8GR3}pgHvsNP98U`q)Nl+xn9w9)N>m2CuAh{)gEAV;cO6uyo zS3@Z`we0WMAOi9emEb4?dJR@Nx`a+Lq-5x>vlnS0$4Wau84LZdTBWBU(XQ}C*=S5 zR>?=xskb5On_{;(9Yb{RMZgkb(6tQ2k2noQab6{eGVNkywF=wm)k=}Eb=F}3Le+&; zwDvQE;9lOa@jy`NGXQD^-#kwfaa!{cE!V)8a=EPJ2h6dfnlwf!b~GbJ`!t-g=mzG) zYw^=r1yG;rRv3su3<*h|V`LkTw}(88V@bq%r2{@@+TlYb^dOQsXVq6Zmmiz>IbqIL za#`;;P3cU6ab`Aah)%1^id1rywCZA=dfCABB&eh{P(sPW%NdzWyH4CKj`{#E~ zUmWu%A|@yk46z$&DEV!OgJ_S>Y%JOT$JANJMfJq*{_L{A;?hV-E!`kU=K|7F2Hhdu z-Af}=6T)^VOv&1pEwBv?!3!j z?=5J?YEq}%EDn_+{4cC}TjtsKS9r*eYbyjbW z+Ev?PmP4E=azg=`XA=jsyTnz!KaguI%PTY>dt3B8YraoDmvQZaEnWAN1yup=zBfH+KWQ$@flpb&x&-XvO| zDe2eeWJbVu?(yB*`>I@zlG54{^*l1Kvn-ZIaOb`!enRBhvESS;Ry|2DI8gBAKKr*b zcGL~HCHZ&of7wrL#%bDrKk`sD$KFt%;`!vLWW$+29Hpz2o6$iK&B(j|E~=aznW}58 zxcqY1pPrC6HU8b?gu>Y6-9dhZKIl=&uMrdpYkQSIjGPoB`UpYVmW4JRwG3YDTZofW0d~~MeRGj&=-%n4lf6@6yqS|O6{mc zebzX7LRe#>+HWbH&+Fr9KT`}-os`BLoCK(es*8+kB}iB<=~JBiv%-W~YQsE}!ub0h zTrd+CgYyo4U!r1>xaz*`{n<64Sj&^Q{>9goMRu6XMn$uu81I2ulv!Ol+&s{pPJlb! zWIc1gh1+;HP&2uxH6USDyEsekLZ4cFOGl^asbL7$QHW>4yWF$9Tv}cPo%h$Zc8oLF zV#jZ)dQqMrq$2Oj9qv_sXs~n6*)!gHh>qfoKEx#b^uYAgChl%LU}Tnvt@EyIzF87D zEPcaO2InFfGKwUQ)EjMDcj(wkiwq|o)SUY|GV{lcS}SO{qq%zo@WZvJq@1Eyi|=EuAz76sj<{#pH#FfbUv_7jc+B&g@5b5j;reJ&ZT^@s zz_pjY4xG#9{@H1#>)B^_UD7&1(p}}IWyl4mm{KzQuU}y zzDWEU5-9rPSSqe-if8b-A~WSD{H=6-mI`a_+N7bURN0`URWf+^)Opy(7O5Pd4}MOK zLN5-3PpXTHfOa2=dGId?(@uJcX!@d^xp3yioc^J_;}j{lgE;@eDXBh^K?1q4q!LQm zQ1I@e+*ddfWZolO+@xjf8{4}sQ_flSRhvZY%iimE&6T_1a~-Z;)VF)fb%y2!xz70_ zY^tyHnGV){=9mW)-Q2ZqSrT6f)7h8`_qZl*0pg-uY5wEoc*Ur z{#mz1VwoBN#!?%jawR#A3HS2#{T@5y8*csu_7^`Z_WDoqEV7{_^*>%45WfjC+jHEN zVY+`c{5Vctt=7Q(ZKp9>!$riORB`BW<4XK*`>mfunWhm+A7Zy#v03B&#^fp5#wa5K zvf{^QTOLEk|GP)c?PKBN#H@h*65G{}1`8nSovst-=r3c0#&G59R9Ds4!{z4VN++lQ zhsKrQGo7ils;$14$g+IEINDN#KoT23aVCk>2GQe1w5K~i+avniAW2!@nmW(eO&owLM z-f06?R(^~TS7I-6r&K4tt^`vEGaPj*wS6do5s|>8Nevc0h`fA90s34}CF+p!vffSko zVYJQ^)}Sy+;|le=bp@Xe?bZ5dPm=g!BY)ZJc=YJsb$A76FqJyeLBp-r!v(E7zD8DV zc;y>put|b1`(G+HTvG~N&6@j!JacQ~pMNggFdN%$(HlMR3doh*aqJH+^29ZyFRP2( z#_xGy9%=q6>vb)I#;(vCH3i}eZr7rb>Z9j!k>u>&mi~A=|FQxfN_Rv>6pgmA;$@go ziF{m_Qjw==IZTkg)@?$F0Yo8IYIJ{UmJF^4ekq&?<9L={2rIJDMW)k%Lt~W);le?S z50Bj`h7ol@m1LxvljMs5lO+$Ox;pFt6Ib-@@R9re-`M9ynMG{ zYC;Re}ew4S^eYxKe%F4M~_AvNK!;wA>48 zW|c(BY1%x4N=D4N(@L2-Soo%XPBfBqePWpVL<0*oQ|nY$403@c{?Zv&pstGr!GOP4 zX!~GWU#B38i6zeJe~-m|H_L{UYsm9@S_`5j7M!l0foo!cy|C95k8)p%b()rwhklir zs3pxsk68$Kd+ESsCCH5&h$1k)bxm^=KzXEmsuX718b6|ecx|Pfg2DzlnRj@>W|*R| zJCzhOCw2Cy*`Ki@%s}#E#2K3bXnWT@?I5)Rv0}IRq)($2x}dd8smiMsOJokuHoU#z zRyVxtLbhx$xqL7a$>N~!w&gJY_3@^nVP0`jK|<|9{XW5A*iEIW)T7`P0c^vZLWrbR zsyA_jiFq^sl;3lAR^;cYnGRdBN>g#ew8!1E3r|0eL`u*OF_hYt3!&aGd!R)zUd=e6 zpH@KK-=e7XV~=F!-Ist@nS*?#`49c;p9vCI_X_id^CswP61xb6TOa-X)=Ton!h0}UiMa1lMl(YVKz(y3|fxCRI9SnN?-?B3Mps zyC)*|n5wW)Zc`?}taEfPyS&tHH|Yoep$O@(m{j-f_mO#4 zrlbStVt0X?TuK#4H&|CPYMi;4a2LQ^6~K6+725VSj%;w3_0--oqz@nx*Xt&ZtO3+Y z!tP8+SK|C{*vyt)UzHfD3avtFhyCI$g`M3&rvy7{!snRD#CEnx^>cW}*jEJ}U7HnG zIE7dom}Uvl@0P@RN!{*QyFS{Dt?|;h&QFn$l#e}>?KP^TO*g4s481yxg_mB5D+N{< zpVoIc-|vQf$0T7FquDo1>a}s7+Y&jBOr)&UML9fVgY&s*pE`}@n^o{4xD6~D zjafJC>p|o4E1WYExRGc`BcwB^N1Gbbrfn~A`?r!ouh>Ry-pI}@M$w-f^L(}~2rW94 zpOK_08a;-#&5m%Tej#1JY83G7siP$Z!SB(LTOtVOe#+-G^$lW1?)4H%j}Y)j2y6R= z_NBD3h(aW_lB%}pZE7FA)D; zDsm;$qNn!Gh9eU`ibEwA&cB7Edtx676Ts_eL*1a7fxT3oln~$`F`AbUo?;Xr%r%%Q zntD`bjP~)91sN7^u&~f<>)wmF+i8aQl9R@*UP%esJ`Jo6%%L4t0KMHejE8|k!lYt^gdzHH(Diu!G%e|8*76B6bovfq?=*_t^cmL2iY%a?B%5LPUikaFjv)*Ft;|#fw_<+rNKk7n)Yk@AW1$SL;<3m!bTW z@U{T#Wf=`}k+Z;#C!yZXRpiEVS;`#^_gj&QyF9G1phnx61L^(!n~6T%QEI)^7@xiC z&WQmH4NlZr?Oaq0H>xM@^9?$;^02Nnc6Yw{g0t{?)%w|DOtnDp3u%*gb zTe#RfRh;Q~>GyFvf{UXadhcc7i4 ziS9=tP|cvtv__l3PP=9XLdtLVkq}9UsqrRQ;Is*~wIR-Qj_;9uKsbBf>xlsXf7PC{-_uT z-ya2)wCjdjVyt`)Jw&XH_5$tk=98jKZeFDyflq%SsJagHeK3#rC27;&Lj;-#w+ovO zxdvPh%F)r(4SxtBG6lapcp2MYNBmi)38DjnE?DpfzN(W-KG92UY2Rd6LIc{W70_%k zBHL5*x)?tx2ojcDcwzXjiqw(P;kppHDESn58T|zZi?+Ln+^~t83>%A?%`yUs94=36 zA(}e9H_sA@k&hA>dbD_pH2YHH7fCaZ4n@@YFWeIuBl_gsK;kJDK|K|XS`A|O!b<09 zH)zr!-ngceYgLMgJ)jM(;86V4ywsNq5${GdQj-V{1un&A^OV%^_^y+>h(B%LKDc}``Fr!Ki|tTlQ~K5B zPkL17ZE9%USJNimpKp6AeHGjpKWwa~ZYYspVPHiDbWh9n%`VH{(@MeFh~u79N8lra zyrM2-unNDPjYvu=BK!O`d6Qp@)yi0*m}8*V%vkYX^^jM>ywuvL`Ao=zaB&TK$2|kz zi3o*p{Btb_Xtzy42_IoadFTo%P<-TivnrjFwy9pg zw~tik56v9o{Ohe#s{LI)X3TPGfA~Y}pAIkZl^V@ZpCgTo$Z>4it#HZ8tdu;9>y_|0 zaG$wRF16IwIGHY6b+|agIuY%VA8Z4m-FII+C82Lo%0@pdhclrTpbEZguPu%MudCiy z5eS>U4tmIh|3B`UMJ%?xc8OkMNb~*Tfex!X0t?^8q@85G(lcfGjR{Q*Yi$mivfakY zYl;)Q0vsy!_oWw{1WKqBdDElcIP>Au5SPN~G3!}26VUMk?D8! zi>j!L2~;6N{b@rpeA&dA9BAqak&-K?W?fy2x=EM}Fhx7249ZTq0gLFr{G=+p`Bbw( zCKNvcqma5UDBJVH=V=k}Vz<9aIz(W7?n4VxCZ>yNciqA^P?2DMAVswX@xrqvN;HmV z_#DEI1s6XV`O`~Gi1iKqd8$VlSy{mSO*~cA7j2B9fs_&in=uvqOWr=Wj(*){Pycwm z5J3oMSDXeIU>*)x2*jbjBSj)OV&EV+5ONWfuuwAg(^(uI;*<_xq?Y_Is2#%$;%yhs8)jzRo9Epugvy8y*ky9)CdRsAA0ks);kre zmCar!4yAWq#ET;T;s*aTH$h&Ii>&&K$9vg0P&sq>6!F5}>Ew~m7#ud0xpau68bC$5 zla5aqVTFc6M%papBSJ)=wX>P(ioB1TtigD%W3T)ZVj`9MaLidAl~jzSKd zSSfQvQ6v!T7rHU-dYv{5hEO3_kX1;pUzB(Uj5LIy6lckM1eim3c}K$A>BZNtA(46! z)os$zD4W~S2W`yJwCr^{KmP6Rl4`D|WAH#RT}#xV3@VU1d025rVCUtz;UE#*JqjrB zC)JiL%z<&7N>bsXZk{eGdH^Y_FCp1k+Gk|&Syw_t$$NbF;ON_plbT{r7=9$i9`YkQ zILiz@_+zoN8S^#FqD*{?0pd_7;8)IroX#rMUuPOFZCq>KOQxrGI&V4bx_}=GpNQUB zJY+UDKHK2VSQYRdcPo+!=I@mV93E$6zmvJ*|4;lR&}U%#`@xM%6RP?nx(bB$XnK!% zH*3T~binTU{bjQk$q4!R5G>$8%y*_(>gFHC#*FwrO?skp{Y!&N3@OKj7hOO(#SQTs z|HI?!+EXv@b1hon=C7=gURsbISa|$KEsR#%r}Oa8)+rD5*BLMr?1*1J_c5=v+jTK) zE8@lCu2H_v1ryElNV12hu)l9zbNYWju9u@ z6!+6Ut?+OijWv;-CPK@C9+qJ|ZVGE6jK_z(HA_(N_cM`b;cQ5xCg$N{t-duBfHU)GQM@JT|p$Cr(%iHy*tuD@N3!V3$Wq;@^B;P$jQRebXY$bUiB{-Rj#tDA6uzwIKa^A(o2UNC#*z;1@3HUEj{2o z#fWf{>;yB_n}VFW88w>r$iOcV-%z%tbjHI@(>0* zaYI!J6<`P_4(94=ja)fo_-?S5Sx&pnX>>`n_I(^>H8%`~8k>E4NP$FDu=SvDn?jrM zUi64xbqIvzH-DYC5;z%<)5f#9aJOqG#KgfnjD03x$ATmoO%Zt_gfaQnm)I_q3@*lA zOpL8bfUm;?3hu@_VSZ`^e*O%ee)dER+Y3($P(;U9lI$}@PF)}?`z>=sweJ9*U;bc4 zMpCygF0+L}wF^RZ?1qDX7TNW==sRrzUO^vu1zIpKQ(p zEj_(&sBh<=j|(`bUqCoxe@j6u?4XM7=}Ldh3&7SbHF@&oaz z=kOaQc5Iw_hEIB;Muchb0Mp);3ixg93XEW=zEkK zLNmD#975Z`;j$$tFf;FVQt+Z52?KrN-9~{^{@(S#Lp5SE#sjt`FJ}p&X-kqZp*@1p z`cG1%t>_%_7wepJ+kz&IEz%YPqCW9o0PTMcab`lP2?HbB0P;2K+|tUJb!@rc3uawM zx^f#CQX*>KI65=1|60#`GhYB2ty19M;^c|qtK5$;0=B-Rf0+5|j~YioL7E=S5EolbsZOmDEAlvt@ifduM$mOIGDCRbX!-%QSR#g^2~$Y zD<0(b#N2q8CGgaFNwtJZ1ub9V>oB|Hf+febW_(-^jF_bhLj%Fx6wW6<>G?$Ghro`o z1sdJTby9fcM1yh5Exz_I(Ooi65Ii(zB6VOMtxdfM0l>gG2+M~RQ=v668!tNpj3V#25diI@_V7-yZd8hDx+T9OCFtYPh@FCm zQ%o*DhhO%^?VmTBqKQ~2AxyYM${)pYvllEnKAT(yz}N#Kl_D zl=<$698zdkjK|6}4qH|_s_2k6qXp!v@yP)c%xdWa7oR~`JM7$XD^#ZX+(b=ybzP0m z)|DW4J3D>-cBS44lx6X{w;8%#9F47Uxve9<_1pa?k0==to8uUO&kFAg4U!}xQth>6 zwH`lDb|f2-mia#o4Ji20wI|PX5SWl<=g;JOH5hLd$T)vGMe|{ZA5aHU6 zL|$wWAJcn}wpk)1+f0CVetUCf(REHPQoNE)carQ1yIEfB8hiz`8)&@LMl)!(W?O9) zUP>Isv!=zLBvoq|C`IJI6KbX2#-MoJETrXCC{Bhr&AgI3x(0Sh{k9 zNWnn#G|*$vqe=}5HLkoXh2g8;(k?RNoMosRrf=WTL36&O zdh)Ia>!$iUX6TJvAkhl;r?Lm2T|B?*4q(yv0)}EP41q0Inar4ghZT#yWxh;M16rg=$1Nb$kY7sze92G&;%jKj zrkSYWA%FhD6h<+V=g>mWN)obj`4vW&_3*(TRrTHlLGD}Tu>k_Iu~TaKz=I>jBofop zzy~um0lzCo1kTdgwSrz!uGp{7-*0z)59U)TX17P;D8{Z!wkc+p0tG9?x%nybuPqB+j<-@WFM2u`bb4Uc}J@i5E#d1-!^`=E&2v z$k!zDO^OMY>H9)yNE&xg{8$apx4|I7I(0#3MMnMqPsy8J>TI)-rPaUnfm8#ycr=yk z?RLvS^s@^|g-J3d1~meRn#RD#0PLR7fcES{s>3ad=h%)AIriAl(hkH%J8qckScY^b zfgF1nYsYi8+-I96ZQJ#NHI)>p89ih&-ZR^-=Q|qF7C!=KxXkK6AZO@$Fs*uzdRQyi z3uKp*@!pR@GU(K7lZMKXT=r^gX*tX{){}mXJ=~=Tk zPKry_;l*^h4pcsf_qqON?#YT57-E;EGciuiN%vSw3Jx;Fuo84o@ivO*rp6$fe2Q|n z{@%M$J`LATcLS%8aU;o2&8hoe1k+PfkWJL9UH`(f7?=DTHRH#qw!Q0u9!I`6&@>h6 z4{5_51y$Hz)FK(92hZ^?d7h#5jB-b3_0?HeX=Xja@1}?p+kG=9>)WLW-o{v0dvxJ6 zj^eF*fADE|_;O{oLs#%9&MY%a#`woLPav86&DZlEfv&c-ibmzsWTJT33Kpq9^)G}G z!A(w0QU-GG=Fs~>w6K=g-kbZs+06NjZUxEiPMyFV$?6dD%8oh;&I&A2w4G;6V&>+X zQ&^IVwDB+ zd=HQXYUX|&Rdl?f1?&b|k270hbmhOMP{U2Bt(wG)x!`Jsveu}6;*Z+Qlo%9o&UJk% zGx=&(a~OWzGBIM4dll@JRd2Rjf>z|cr3b(l-}PAL0MO+!Sw<;&WocuajU>=nH3FNm9{)|kQGkQYuM}4T?nx2OOLSnpC$>0uZx3`eTY%RfwTDbM4@B; zZi@c9=C2pYCMqt8+g62y^WtyFSiAeU*+S0Iy#*%to)j=-Vm0r}JS~4gDU;zFTSJxg z&4cAAK|)O?`1{D%x#2`@c~Ri#d4qihtSd#H{GdcHNr&%YyhB)rq1%6+W1l%oz}v8K z=$pi`*&he4{CoaEBK)gou9`iEByF$D0W19QzLXrXIVgr7@{M=86US|M|CNyib>7A5 z*D@2NQb6o&ZlI_^;K7#D*kz}!Zc2r_%HwxyzomEM-}md_{+0P7<2RbuX}L|mKI;hM zElymjz<0$I+@;)KofTF-C`@qKhqmou0(lE)8|_c1;g@gG5F*S{+!zSAzX8yqO)6*P zXJ2H|0g7_3=B%pU=`4>EQ_e1^v z`$nw-Sy~@`Z~!S7wo~uY(DP$5K0TN+Ozzy_qr%9n4kaOB#Z@pf)RrTUCQs*9 zXZu=Eboh<#U6D}6uuKCtH6-I}gEli3g~$>vGMYOTZ36^?!_EP677#-791RoNU`Ozex-MxK+)+ho~to>i2BnEgbq(6~no&q~l|l=~*b8 z*YIQgVqf#%t+&mauQf%jQ`Ex~Ex8Nd%9VRTs@T%b#7Ud`d;93eCOz%N$3Z*7y}=K! zX}0C3p|)ZB6+Gvth%{ypr` zQi>X$Vjp|oB!YGGRaIeh3@(L9%Z55`HgI9xj1c0*2MGE^gx7!(Lh|x4L-$1o05;bD zv|Y*7+SM;wjR4Y32a9yfickFv@+s5EE$kAvvum|8BBpjl?N~e&*IEDRV);5b)PB`t zrRjI0jQc=X7MPR8H6oMq6E5ew7OIU!c6+KlX@iL5GF2J(LC&w0H4hK^wJ}Ak>m66@ zw%D=p&o(Q3TSUu&NI-kM*uu-6tJF67Gb&%0x4 z7rjIg8Nb4kCUOKF-eMv~qZoF;h(pd3fR$d#s9c+2ryDVeeq;fGes8T0H`53{`^r9=0rSErAP)9Kks@$_<#L*W$KrdUmQarTQrBN{yRdd;c3Jrb=>>?re z!?2*RX$V5|zmaaF2rYUIY>amo{MQv*0RDe}o7SJP85ikAcZ6=k_S-N{V;Rl94(sTN z?gy4z0g_L;q{!D*XU`6>*S!@`t&h+JnFq$~8;{TaNn4go26)S>`5>Wp`Td~NhhLO% z0x&z@`7{{bMbZ>-?;~36xz-!--*c!ZA7@4J;Kfm#aasqz_6v)PefC_Xo)zka z=GbzSW?~+`D?@eYS9^5ece^CE7#He`dhmW7i^#Ks&qbu^i1sy^h3 zXc!ix`t}nQ5`!?6V1w%lBCmAAHd5EzsukZpT%5??2&BKE-PZ0sn4K%IC1h6BKS}+` z=e(9N;Ny9WyIf}C&w54xygnp>-^!A}1N&)!{$+HMrox6cu*$Dbj@a>BSb$=B9VIBf zX~CQkpF!i>%MXN%N}pLka8Z2(exll-WZc?mbkHY#sn4&xljPIZZ-{?NJ=@kWT>m8B z&?y^nEofvfF*t*7C$#R5BE!l;-%2l;v|QJ|xb?E2+3x6w0o1x{5^IVL?-Q@hAHN`a z7`HO&4Fk_plNg|?;I*y~M9d{?KwpqW6>$BA1Q!1b6KU=gR2}#vI8*3k7!v_VLhSJE zc9~(>s_{SKg3FT{4$sjM@=(2m|B}1O=Q#=!Pb<1d z7l(DYtntNY-HB>B(NQPr?-6CqEGwExIHTU>V2~#r@LCi**ia7G82JuDuo>XHc||m| zMR6i38ryzla3Bboxo7~$s0^|P1+ZJF9Ff>Z0WVD`ifb28qZ8}4)hO`ZeddP>#eDX~ zg;Y9Rz%YsRxz&R;EAoy;!5W**D6lM`jW~yzF{mQ%yZ2jM*HS|9(xD*p=G1&PvD_qF zU^S}^xzyQPPqKK^7-Ys&AL}1c_hPQ~@JVvHG4etE&f8=!l*Lt&rH?R`cU z18xr-&bCy9Yh{AZkrhF_-n|E-;z$`J&R^oMf{rDVLPqmuZrdW8Y1N!gTQ}zKp}+=; zzSz#j_{;JATvfs7<#oDn<;M&()Tf(^?6<$a@-J*>;jO-fezqV_EV4d1(nn@;cyH5a zOJcDRF{`F~$)Bp00p;gh*E-0*rSP5WhBm^hPyOhcjIiKgoFR$N(CE)BB5Pv9qTCInmft>R--Z`SBp9l*AAR&*SmbLy(4>W46sz}kAH{R zQ4AU}cop>p>xCLtX@Fk~#d;H>c!g}eY&5qor4Ow*7~g6dZFZjcNAYxeZ+L&br zXc(D)P0Z7JDwWnlq`IPo&M02_ogv2A`Rp}iN%fa4mhCnEdNE|R6X%DK?S|9y%pl3pJwWuY3`0{Wo&GFx+v{LIqO%Js?GXI4I3WleR zX)?xZ-e+kjRiIVsxe!G>m;r^QqHs{cV<@o9LYaxo;`ET2(if!{uo%UbdzpxU!y|(G zt93Um_2(o0DC+Qe*1+*)6b3Hk3W|zF+DLmg6L7Q3JRN5SQOIBBX#L?}jrHGDaw>DIw+VoSojyh8 zjE(t+e&!IXIGVsscAM$HhJr2|k@&!;Zi0)v7PdIPNR%Xd&f|wkD^*NZ|AC+SMW2p3ea( z7OE9s#dIO(H6?7M_Os}rk}9sUUrCj)qQC-t)KyPL96B_;6kXvjm|X|SpsLRl3&O8^ z3qT!8Z_ankXiytr_Np&8Jpx2VqR{7%vb?e~b&8|$ApA}4<3TOpdlf@8&fFd5Wynn{ zTP$cqQSQ=BJssod)m()Itf{gWT3GeUmejvjx4R*+szX^&t~-cYB+IehNpZvvyXYYQ z-wVl9=I;hG3TjBhZ%P(ls-4D6iAK3gKl322a2C&OXl5KYu9|@OSgI^n6vj7>beh|! z1zSo$+KC$)?!@SRwHncgV(BeqICWqF_+Y6f{F@HgexqfkcaJ#AiN5t@R{}Bv%_q?H z&ABY^rM9(jb5j$)V9*5fjDlVLRsBhIt;CMo&{`bm_FfuJey}}i*yjpJbGkRc#G#QG z;8*ATB{Qzw^@HeHx~rc=kjoKuEw4S4Gs`usEY3$5v;&JKAAt8Ai>k8a_OVh zRK;YZIDRo~;4!-_o_cb3HqywX;&67^mCR}r0erYz+Fz&k-XQQqf#vil=3e}e;D*}5 z_1)bM=B8#Yf228_Ba_=AQ6%EYsY0!|dh@eY>6wy6`tzWHwj|PvY96wZQz1ZF$4Icl zv=_*$UF4t9KLGJW3apFlXL$PfAhzagOHU9)p?cL$vEZgLysz>nb=^FQR@>;L`o_MM zTEOo+vVm&d`-|`vHE0{IWbJ>l0nd|eQa!3t=j{wnuFEgguMA4Bew@6L z9{k^HF$7SUMfvpJ%8_axXEsK|ia1c)h5=fPJ_$yMlw?^R8T|Hf`#}N&x--R{7T}yF z;IQNXUOMn_GyJn3*S<{Q9@_l;&(DwUSwam)y9Dg5`ROcp2F$UCVe2lz^pwkmuFgxV z7aEPc+wJ1B1LMo&XTdKnr9KBvMkr0x53QH6cBY2fLjy?#f1G$bFK`bqn@%w|FuUHn zMbA@TdM^AJx`^9;@5ixWbvO8f)8XXXcOqRhewA*_J{r>IJ9PH*~SFKhliof{QWbN1EIn(g_{SotxzEm>8k-2^Y| zBvXltG;viI3AZ6-W+xj|h397CcK&d=wH1pzd_3-l|GzKx44BS*F^y`AD97;Mmb+8s zE&Ns$*Hg3!2R&PgmM}Z&`f0uyId6QfJQS~d4&$HrJV#4N5B#h|>AY6pu28EKcbFdg zIws(pYY)ZbB9`o>-EUbdvf+J_-Jj(adq;v*^;V?Ft;cJnEeO~2FS-1be4C}4nm)Du zw`ysxn7y3b)0Y&)m;N?pso^WPIT6&n?Ojp$@xQIypSt{&V6CApeD$(y8jFbOPsC;T zH)M6|FK%f>?w|5ElK=K+MnVmgJNTC&4zPu2@)vcn&SjU<+?mcLgH|7c!e~b>pXW80mG_AnqsZ%fAHDuwQ0M7y;cb5tj{0{N7a&f= zDxRJK9_xH~6EHei@MdwPJ)~1?vWCskJ~jXRDCYWX`wVx>-$oP1=p^=nt1Q_U7T=)+ zLb8zb3FxI|^SpWA&=BY5%syT8yWc%Av@1ijHR?HeTif)5CeuQTVm1W){-Niqw6yi3 zURyf~u69(?bgJab6`1s#a<#@1T6||S^(%Lirnl|*MA)IJJg4#YuyHehojV8PX(JxRKB3|40>BIW%Om^Kw7(pI@VZ7K;y%a1RTK%8tR}A5TLT4MJ6E?_w zQ-OBqxL#2;1djV=I7$Z0H(X_e0Ac^();ah9kiz=B2n12am!0W+tJs?m>??+#|7Mu( z`*?qe{`q)*dY2Q4duQL)_tDSuv}Lu{ktomkCsh?Qt^+Q-9M!wkhUl|rS|z;$!5+pj z(vP|{2i%DEl(9-nJj|2g0Y`v8ssFxq$p;313+*DaIu91z%g<#=5jJgmsppC6{XkS? z`L|biZB;f?1N;ttg&}1_(8VfHG%6B;K3XsLB#Og`Qj;<#EO9HOjb*$prG+oPSlIZ( z{R7QRc6+y-$USrQfW5#AX>4gTNE|Y4y&`InH8$P7@w4seH5Ef5qU_6Cu zVEn~6*IBAvdZLQ;k6{-VYMY79#E^OPLnUjKgj0X*$>0hYX2K3&(zJ>$*0FYLE+VK^IWT0UuXLRtdnRrx5At^?7 zn#Zb(z`_r#>!;7&2josQxZ75t%@*Z4ZwrS0Csm%aPN&bf-n#vVviQ9>+vg`j?Z1s2 zts%7e7Kw`}h5IE6OG(>jyxuqnEBDIWd2vHv%=*fAGf4~Du)An5S*%BD%taG(f2@D! zxs)uV)M+HVP9OhSNSYw28w|87soHkO)5_?h233@D$9J0h56I{9x=Gi5Tgyr4Z)L7V z&ceG@m)1D}h?CjaH(Aw}hIo>9W%XFs5SSE1Jb-YP;@W0{k28`p?Qb(bO1Q&k zZuIZc@INfD(7Oz0#SYi_?*?DCKTqRN`!t7q6|jFoW@y^zt(MK0_5tA5J{pj&GiZ;h zfGEKgzBMgRG^wGA%dqQa^&)q}jmVK`X>fgu)F{C z8{9P=`?FjXQJ7ixltuj*7hcD23=V{0BUtQ6z`fqIyrIui&wHtTCtI{ImC%fU$e?CP zUCE<}=b|N~@{qsYu-JO)hO=Q&jRsm85Sw4Fsdb0oQ+v=Pa?=KDpBT;laGfH`=hpZr z9>NI@H2YkS0ty8{{4Z+A{fHAe2*1AV#&&x+gQC=^wY}J&*5P)pI@4gS>)n?? zE|F7x4(&30QtgT-vpGN{M7h=Bb_$lwtdhC$#4eGyr>b_Y#&-V+$y2PlKUXguO7pC5 zQR{rpEC$f=9y>^6?qQQ@2a7+noDPwut=ns7Q+9*=lMlEdpnD2>4Q{M+9d_DHHR7S8 z(eS9ecd`J)gz4)t9TpD?@cO&y#8oz#PM+GE;eO~ox|uW&0VN(QLo=2>qcoi;@ZwFE z-R?RUqWe0#P&O(xk#T= zdYzg{r8kvLP6>;>z%CQsB9rKiW;P22sN!X8A&}=={QIV_vZphR?d7R8-Jyj&WHNkL z>o-N4G6ZpQi@Jt@Kl`Spg9%)`JQsBkPIUyM7htY`zuT<&)DRBfm`UpZ#C0{h^R?X9 zJiS(;_NG*p4^D>eN$)7QG&c4=H32K5KW4u6@SjUr6?9Pc*n|rArgyQ$?i&wlBri!- z@X|W|roV}Ct%~Exk-&l|e!le89l&t8kh=?NxtDNy)V9|>eDB{hR)l!3d-fHQohE*Mkz5ZXi4 zEq>NpSw4FOIkt33r9ybxa-Vw+NTmaGs8~wSg1z^++5ko<2p`!{R9Um6k`tr3tQ@H# zoe=uSa_rO^I`@lPep;P_xTr<1AYy4y|EL)H61rE;5sZR%_g`k8cC4YJL$Ex~4UBE? z)>WTk`2SS7J<#f0s$7=_x)#LmN$-c%ikycSr(54(K1_Q89X@N7>XwINUN1-hN^O^} z`>1Zbl~1PCP&-otW}`hR^64Kfbxms$AozJ$PmpH_IMWs93}YV$FZBZ;%mN#f>p?3d z2Pi`g04o;!$pTj~`|MZq6z(2^3r-;jnt9L3*M3BSzfl}1nfb|Dz_5<*>`W++%fRrA zt09{2lCSo_PZWK6Tg+LSg$RIj(+!w7l*z9zK~M)G)H+rIAng{Pf#8e{Z6ZP_3kf|K z@sQ96E2_{#9$%{B1mkWKK<*`Z>)O6e{QFG{^(n>&W>JYnvG2>s_=w8*a9h455N*Ev zAf}jI(L+3>2fx%6#RvLdiG{gZ4mr;Y*xv_U($AZ5I%MHVvxBG&y=qXkoc<}>h!BQz zrb|SaqA=Jnw9U>6VuP?_82cqJLz+X`p&2Bk{}Er+TZ^&%$@`m6(=Wim-hjeaZkMo5 zVaXnz)rz2NMnV=kK^O=cRz}4s$+wX&pLCjo*Vg`GB2SUXk)PP+fZuUREPW8EBBphY z75u))X-DwRfZkZvIOd1=$X5Ve;0pSFy~W%PzsMLTOs=Jk`P5ius50mR_j;X83W4nq zE#`#IBabg60|kz`e~W8hspHk(n;4ofBL6X1Yw0_q2OE9wN6)(CH>`ZG;uo-Ps&W!> zd@$_)gUVaro^GFL3pbb>VBl!L7qI%>o+Y>+U!=rB6eJ`M86nK}HIa(IrMg=XLz(r_ zcbp_3d1Mql`5hz5d*3gp_VF%2B=(b8Ez*rCyAdFagz znaWJ+jxzXCNgX5doA=<{uj;p8!L3v%0NWQOXcNvBwuNSgb7VOYcZxw5$P@5vMb2dZ z7gKK)7FGBD56=t(GjuD>5CTerbPWwEjevx-bW7LJpmZZGNK1E%NOyO4H`4#{`TpMP zdiTMc&B0#lUVGi~i79jFwwq$|*M(uPAGV0oY-Rxj`>uzAqnG;Tz;2#hOJgm3`gDj^omy)1`PDet2v;iY9UhpA;reuRj$=~M> z*zd1SBJ-E${xJPc4;dB=|2oJi9Cq6^Ro?^_4$P8IW!iWV zX$N(VLWv-GA6v#R#-}!(wjSDB!qasfEp%^wYEgk=?91{Djx8D69z0cZ9q1xv{>gTJ zrd=ZMT#T+k%3Hd8m>yHAeEq$}YuO&#Gv0n_^r_MkW6@K5fYE3wwA{MG2x=c#&v=13 z407_jvu$gU2O-;y$llp=9Df|MFrX^kTfEQpBmnw4*bYS%D!dE|fHuqKk-*#=+lvy7 zvGDw}Fad?>fM}%o+mbO)aUVA#4(Wek2%~>7P8MwD2_FX=8&cjbE97U2fj7N*K z8DZ1{5VUM3u^HE3w!yHerfGrO@BnqjkqChrS|{UA6p-cwA}I>+C*^A55W`P9dyg+f zcl(CC%rZrm)13Zpm0X)_&fm>@mi0HW-3bj>EnVA;<+6X0aOn^o^XtB5km=!Mg#R^( zy#L#-)OY3G)c@S~Wb$k?gg3$F&Lu(iN=$oM=sD9)rV{Y_?-zZn6=k7ZM004k76%8Z zk|#O`Hos*)IR{4Q^AnutPuC}oz%?r)47@?g1QN`4Q3Fc*5my)XCU$t<;>zqO_44&> z%r12!Svhc~pL_=+6x_TQa8OcvP7n$m0KZ}@hSwsEpM0?E>F5vEpiHlT?y--lxeSiqM3FNIW4wkl6XeN(J5`n8lZ zhj6dC-z?-ed^*@5bCvhzWH=C>ysmfzcF@s>36>u~&DoT)s(DGiR_vUW7_SecxlnK* zmEZHzVo!reA|fMB0WkQ_`fH5PL6F&}F2b+R_HDrpm>c0o0I?L;3&Jrh!?kZUQA@-8 z>){=Zw8vOdYEbm`05J!v7t}kUI9Bjw5O~)pzv})1*B>w%>kwft4l+5EHn_!@mKvmdGs#aOk{*s?u-T&v$=&xkAXt`jT(m|6?@cnKEuS z4O@-Clv-DnUhSO1u%q=cBF#dCGmOqzRG|0{wmJWwc{uY`!l#du)6B+;FrNu{kEzRJhP+VTR3x`v-vE zokK@cTA8!>vKaR~e6xLcI>ri4=wAFCdEgh|O+97*baZfsO14Q-x?24$s~5XGokuvM8j*=3UKey_%^2$}nl;~u z5WK~C#^%3CxBCaZSLka$>-ATa^~Kd0q1TDz3t_V}qbVdTK8MJz_}(}elU6d{ z@U2w-NYu8p*kXleh~Z*Jk8jH&-cf_S34m)(&-}A+y8)!N00Cov%#u&QvD{t+3kQ%u zBH+|xwz94&yna7tvqNZEWy-dxx%pG~`_1o%$FGiOF7GyLA#JKS6h2(TV5xyp{a>+F zaS8%oSNEH7bg|m^Q8L4%RS01&m~`;9H?-{;z8VL&9}~gQeGu%$Sf5xFKpD~O%f$T= zlP@`pZn8d-OeJ^Zw2ZcTEc^o z&O`A`Bzizo&so^(af^(xNQS#a;rTwIx&964D`luVgm@In@s1K&fQq|kur23X5=8n8 z41J_OU6O@El{(AMeP=;X9I{0&o&kfu;?)0u4KxpzhpPZ$!DJC6+)$Wcf|$M7#@C8G z%66h{i%g|P4R(XTt3RMzhA0Y@!+pe2!&W_x?y(0YiO(oH-fcBq$`Y*{=$XJ=7&wdh zman^U#wsX-4$iTGI3*|!D=F;ycCUs50u4V%<0weal$mGXrP1ipF;OO$TtqWyuB z6XDu-IcmSO~{fef*=-2uJza)5aoxh!EL`$c{a8?8t{JyMy?aK>| zu9^y4ECQ#?PC_MhMcr|GHBFtG9_H>sKD|Os5vBOzr3iop*Iv3|hIW6m(!tDb;r86e}y*`zwkhwOQzf6Bmg>H z8c=GDAKHJ!!{@do3)(~%yzawRmui~0_A*LrR2 zlPVy4I{ZCB_if+^kg=x!MQKz0{vLE?u}_+;C$+d#%L@#j-ok_JL7))C_4>Q|F7G&3 zk2)Fe>^r?HtwSo78xM(;g?F3oFQovk{ulJ6XlIB`j3l+b3)}K%9?wqwqm`qo`$e4F zV6ykE`1(?rKPaWBD~7W2TO%d43qzdeL})zYM_bmP5?j5?SkZCV*@CYT*PpJ*clF<1 zQ0+%ic$z_X*vdlrsmS?!YDx5OSu`j=ukckLKV)cpvI&xVZdC8adua$H92uz3V?5lQ z4m#TTqs8G9F&bJS<+_m5OSchx|KYwzNoYfMc=YEvns)7k>RVPyK2G>l`wYYw@s0tm zfzt_yiTq6h8`nXUJkv7GMeX@^6yi+>|MoiNIgl$Iv*bWn#A}Bm1oUE~`=@8C`p4$Y z*t6Kdr1<5A^DmC8wRK2;hP}wTma6-!+PZ`)-j>FN&&RB$Ppga){$NDa_;Y?#FHkPf z?eDt2GA&IOT=yx>WzGUv33?4&vV5)uM|q0pV28}0tV^x{9(8pR*~*dazCNRANBYOp zLv_qqd{E$gme+LMRXH~+K|g`e7-0Ofh&&>HJHwN0%ybq{*(EvH9@C;6IW?8wVmKs{ zCLmpQVWJg0xHp|uCxpS%z5#XvP7wAmYrymX>M~)I%qBSyN}mXRE{CWCj9qe0OFIvc zti0w-JeXK$@#F(^Hdj*R9zZ$LC;cCzctD!kXEGf$jDTwzc>SH+ozX9#HHSuZ<|XM{ zl2YDkNZ6`iF@9EqmRP%MqXyrKR~O6T^aF54T$S>2LHk{{&W767i`d^}CAj#%ZfD)9 z6vs#V5}5Y|!nJZRryF?Q9uOl$2@GgsA^>oIq*dNq1a&4t#0to1d#PhH=?8F*5)~IM zzlW}TtuCGZ{LH*WDB29^JgCU|$>^6M_S)8~b=?fP8SrR+Ts7UWmJ^;8jb8ZkBL#`6 z@?fJu{}Je_xDwp_oXx0&Mn}Sff2e-)s*kMS*2u~TxxeA=N_0OSY)?}ej)a;xZy%1l zaL(a6aHDop$v`f-zQdKJIHUqn8_(CTmnIH-~yL+5pHa{-%6ZL!W8 z)pvK?SnG8$&lf*^IHUZr?LlO-l2S7%?np~h%U_CMq>{0Oxn8ZP_X}#($MSwGbI8tD zaBgLjFzo%k1PZ2KHhdXj+CyFeMOgH|gf_;Lz&MW~Y>*K&tSj{BXj*T31_Q?zC8D># zCUf)yHOfBf?O>oQLt>^NE&~v_=x%NthN_bN zP_!G|$hg%-o|sR$y=qQ-@1Sa!jR#13j2M{;kEVj6d&jRM)=AmhjlScY;a0>rGhKp4 z7z-NjjKUJ?aqw?Y8c;ZEje){?4 z4SmOkTxqQrPLfFLko?10q747;)}v`2_wBh{2gb{O^7$@NKTeDLiRs&0+fLcHtThv3r&d6uFdPd!*gva` zUqgH(6|+PJ@!F!2o~;~*;=W<{AwZ1P_wQgE3;R-YYqLZ5U0;7~b9UOvG5f2wruD_m z$IPRb`tEL4H-CiKSdyG`d+cl;S{!etMU|;;XO{?oV9+QnaN-Z977QenS{cA68riU` zlDAl+`-oIt><0CqZB#XBd83fcRp4m3C_xbut{;HRCHjaI9$+j9Ca@SKcX}BWj{z`) z*usbFyBKskD+A;JwElt2l`eQTAg7Db%jiCL z$u<-w*#A}(SfN>>r6Qq9t1tm!Vv9O*6<3LD#>Yd>2S0{c(cX~rb%ob51(=svwV%{) z8{r3+h`RxBj8RuwtJy_Ij89{nY>1w(BfZ&57x!r*0f&*m*{%v>PA;P$|IS`v?f8n$ z7vtY}tU&i6TB^Rc*}j6GK8!bnxHkvFjDp0Y)=bJvMxW0ygo^fK+iV@NeLp-~C-~yi zAS6}P`GcrmY(r*=r-yzY$oKvT_e1)r{267E?(IF&gW-8MLm==i(e?c0(5oH_JTbac z!OmIx^aT8`Jo{k+#1C{P5o(>a`~Vut0rcxpzsIvyE}0$mk1UYIV5}H1tC!9v@^u-q z_Z#UkGc-#gq-Hd^&0ihUoD=?F*6IJtLAFF9I=Rczw&&gvz~mqIhIhwf{Ps=(K4bJ8 zbFQ+|h>cl!=WoTOIdZ|PymARRc??yz+oE@-*ZriE?2?!7Qc!FTCe3^Tr$$J~{`#=R z8fT@iUyS!eAXD1HA2J9mEyO!~6cY_S19>|1XksTVgdEb}geM8J_L!@a?1nmT^J^?`4bZuzg)&0mpBrl-Xix{b`Xx{Bs%IvKXv z*6hCvt*)A3!j;!Cj)Rk$=h?#v7$YO49}LF*W6*mEv&_smT?Kk@P5}o+5JedZlu%&c z>?Jv3plSgFnWhb36_mfDw;{&T@!f0!WVAOP*k=CKJA#N_yDmC?Ak1RF&U-?X!0m1! zQ{I`x*t4;<2vCsPh>wC!ByN#S?fk@-o>>+1e*d~*bSk*+2mgJ`igBH&AOXaO%7eU$TO@YH2 zI%=kjn{WU|whVjdOf|ZjLKMLKu-`jFk}2hGu697a!OzRI0k2%y{p?zPKE>*w_Ys$4&Bhic6nVot(^~e_-f=sxz4P1f z=$)VFkPa$VSRM}S{!$I-?WJOOR(`E;DSQ3A1*A78o;yuJ^{?|?SF7MgCe39}oL_PG z3HecjAro}phofPAKOooiY!QMx`e2-np{g!C0^AhClKyFL`gOI3Ex{o&vLtH@-#CVI zH>K35t%ZtOfQ5MUe|O=(fJltIhV6_uwQF-SKyOR55hWz$fE1+jjuY~$ncKUD4?~a$ zIiO4(`WpGt=v@2!Z1%V#-b77hdzD##oY|M1|0u@aNOW_M!JdRHek*;P&-eSbnfbJo zDBM8&U~@15s0dWRN}ml|u9yyC5f-iz{*`dLyeZtRkTkx#y#3mEEIGrcdAsSfJLc3T zB?BwH7HfE5Z-#UpX9`cZ0Js+QKC{8hT5PkyV(L1m`5BTn#2fhbCpf4qGv#=}erc+Q zq1&>Q50v|_U_-tP^5+909OL4?KkJ=TFi{~?b?g3ev>T7Wb%UtvMSOL zkG&HLa=o{A6}P_EmbG4RTV~xn{e4Fok%Xco@&U)iL~er{cR^!l`D*HnJayU?+;f=n z^DQl|p(Mrx~!=V(M`CLVBd{St! zKGkFVjdOXyxdxe7M*u!(fi@cGj1Uw*QG31sF{3w;C9J)lv&X+|8o2=Ut!sa9@q`em zDNpq+PKJ)h*L`|-t?!r4E^*^EZCgv4y{AL^sD1a1H@`JC0d|%fvYq@c#ex>Rp4t*> zbe2_@${$)bH+7b@j*vi&d$rbT0~cyA)!W$Da7zm)%MITHZg}_0uEM*dH_MWU>w3?w zeWUu4(_3o6kHU+Qj4$>9OS&8tMkH3^ar6WT(-XSU>)O6I+e}0HAEJ(5>fip#bNuuitcSSJbQT}+ekzCUJiB=kS!h3C zQ26%RB5><8uQ;!p0l7(t^j%q^=}5LH^z8tl@ubDYY`fw8}d>(ty;dEZisoLSQK#!J|Ym^5Gh8Yr3N{LX|HPKUt&ju($kYw}~* zrudfT6r7ie*2w^60%4=YDm;_gKe!=&m}p&E8#=VwcUf+kXHh3<&;;((@8gPvnUeOl3o~4aGyORhD-!=M{q-4oG_^RwUbJ|F zrW^(z(j>U3mNW>vm!kv~-!qDDA4jPp($b}Xv1~xq3M^unqh(S|PLsOGzYWA0rvX%Is=1U)L_P z`iy+Se|$4+;B`cceAb?R`^d{tF>preNzuc7a(A077ZVSs%+_@Gxh#uJBQk8Qc!PT{M79x(5z$3h}(5@QwXCt2mH`N zav6m?SCS6UOsS^(T>IXqFj@?Uofpo1cUt!G93b|l9zTvNGkNrQ9^HVK1@%t#RUEgyQLgh9FyM)Z>stzWcMXVRARwVBJO z6N2-f)6PAAPePd%NzSP$&dlO{QRQxj(aq$nKN?y%({*=$ExmFRZSxa})#-+bDf`@8 zjy}l5Uf8t?X}|O7G<)@LlV}NK@bO~+FG<}w?KZXhNko3j3=h}v{$`kuh-jSa)~U-^ z_wRX$g~YlUBYpe=Df!En+xI4mBNk-%qvL3G#WTH7J?5CF)Y;sS;E4#Afn?4_@NGKy z<$PRo>+!q#(=PJEaV0VIVaT)Zxj3KRPG!U&qWv>ZE*{j>32pJbCRwj^-cO9Z&|gpV z5G8oRC``aAB*G~?iZfzdz#Yz?R5HBSu`bp;rbO9g68Job^9fm{x8Z%tEv(wnLO1y5_H%$Jj< zT$Ks#6UPOC1|$lj-)8n%;oz+amFYiKh~?g~-1jWDct&l@%>XQ59iU1OW*EU?l9a&O zw2vLFaIM|4p=3yeYRfAj3(BxOUL?Bknf~Hw(5`kQa$4%FlZ{QDVIzHa6^1AO4xFy# zI@Vfv)akOzMI%2?*#9PH=~yj+a*16{jBxu!MMj{f4+&=4DF}}mi7cpCX!c4M+Jr{i z6YpRDA`v&)sdCyp0$EiujN9s8`Rlb^ylmpx7HArD@@c*_#MC+Y!$puI8=@@re-Ax; ztk(GPM>Mx3Zcm>et%ABa4d;A5VuActrISG?6FGi>a zC7hLbu`~Vcadb?a%a(*F%+xysI3Ip9MeRLo9Ivx}BO?MY_I6to^i5Yoo1 zu`!Q?DMVbowixR?$BwK(#oS7TM$g-|4cfOxk?{~n1984b*Jm9LK(6I`QIzBBD?cS< z-}Vj+nCP4*d=`CuCFJU3ihMoJy$~#e``UN+ zDt_L1mGY8xcQoWEfcBF7s6HhNWDmYl1H)aenD%EXP!3m9US44m-QGu3KiBsfeWhMt zfK(56BDac1eVs%~O8HZ#&bHR1*9dcx4m1p2_x*b!9>?{@X*jvse6$0GBYtMDjW#Oo zTXWnR>nzi-5vA^#+_pDKT{myrH2C;<9n44vkFCWehMsr241OEF6=~$#LJ51us*T*! z7jOb%m}xY)r8%Vi_J$a?DFS{rq!UB1&iJkZpRQZ0AQ_RC%lzVAkMN;}39BB0S04+Eoo+>Q6H=`L5H>;k5sbDu(_vQ%6Q?uGF131_tVR;|ge7t`uWiGiK zw_JyU9c0~Q*R_e*qcN-{p$H_3hphM(*`LO+nka}7T9_v_fsAO0-R{sWpk&85T63N} z-bK`Rr*94_%v%oYKdMebc^C##xI@nQ2fSZA3EL^XZQ3g;K1g?6$}Xe&V&NY~^!GgT z$y!O|{co5+Y3r?Jj)(~Qzdz+Y zPsZo7{L#DSnX^ORwr{k^`M`Lv;93CgH@NnVQ5_xH)^MiT0z~EXte?G#mFsur&&Mky zcBB}?ZW%CvPpg~O>Go@WZcZkg#5PJqV=zxC^An;H{pEY)IG^r0-SCet2r4d35e)v1 zpV9?A3o2LJgRJj$3y~X#zX7Yt4)MlVhqE85Bv*h>goVVfwT+mH)!hZt!1LDOz(e&= z7M}pTS9qSd!Y7Ein1Vcv{v0JT=1}Rri{;;OU3TI&k%|-MNT?eqcYy%b_P8zQpOFR- zfH0#1{Xw}BA6~%$7+-L|)mE_T)Df4_YMZg@xR#fF{c;g|6uT&)AEee^^UE^BxYkC8 zrqjRl{CTEcYmwn~Z(66%qM@(2ew5{J{RL6K=9A~CEsf7qJ2j)dOoD>ue+wctrI_Ps z`P)QFw=I3c?i>G_T2$3oF2?ZQ^xqTs%J*}XinkE7m)#9`TpWZDbZXjKSJ&)Mog3zQ zJOmvST-&9#>He%7e5AQdzg{27{!MZIJm&ZvzuQi<&3SD$nesz5V*$HL!|KEQI{TuP z_hcWLooh@yb9h`^y|+!ce(Q9<=*l-rAyM4^)7DIW8Fw0zZDMAzT(75|8H==T7zRl< zkJU735%$Ms5}hvPEPWxbh0oSygeuG}EVr3j!=EzCqWG*|cagpryhr`omjlYZIFzRx zdllUBCG>v}(_OiBK0VN}c}Bjm@C37X(kAzz|2OtepE7G9#{;b}ii=yc7?6~rBR-6l za^`3xy9K=wN7g$C<0*)6cDcBXBixGS4LGgeEZsRz=%KF1eb`%ff7yKAe#)pM`r7Wt z&sNya9{Ay04R$_Xfp$$1k_^)iz`)ppi9y?GsA73sm)!Hk8_Sg_@yG^K`M9HFVpb!M znIm{de4jqmavIB|c47SJG);P7EQ)9+E#=h>DF)?bfusN`Nk>HW43|3R&fQh9BP#OKiCa~u=u zqz*US11Z+(BtuypL)1%kXWK0JQbLLGC<~E?;44@T1BATWpm=Ho7eqAWk0_a5a70=X z9C1$*fv5FD15vJ*CqGj0IyNga$LS@_~V1_ORm|*>z)0|aS9av6P>zV1QS#1m5x3t=VC4eI^}LO7zKjOy_dYQ z`T1~a9`-^CV<5F{~`B`6G>CvwPE@IBky>$Io;Q;-7}aFb6Jqu7c&U$x9d)E{IJ2QZ>U%4L9o=jPi7#{ ze}*OD-@0b6sjr+IPQf#^!#H1UweVMds%{zP>u}SyU!a)_a>l0SoHL(B_(@`)p-m1l zm1XjdQw?!H!;=gO5;Fhl+wNsb_Jr(ukv{Y1q~0^;H0}GmcM|1?9_$#B{3Bh^mG9DN zEZ5?(qhVQ0Vr%a2X`F)n+Mn(QvCc1T=Drrz`&1dI5!C0glQl^SCl%tv6W>iebrPF& zw=1|9;H}k}B-&3-vFrDQ3DijU?EfAWU~FqIFzVJgr_Qr??@}Wt-Pe=IT22<|FFAuA zGHw5gS)FJ|4;pBce*tK^7<;RXRUhE;ZPgqneRhMU0BK9hV>LA~BMXFu9AmOKuULlr zFfi4DvVXpM-?)SXXxldJmkR0WofbH-4>?iXSg!-RPfst#mENwxx~tO8HhvjoPCnrA zYNIN7+H*;Y*6(e6P%9FGpYcXOwkqt*-4MVzoq;hsN3O1W8FD#lXgg1!@r} zx4ujI|M{vUr+#H?3>8q}ud+Wt+3d596q-F}TR+Ox6uElPaiB0k zoez9ZI14Yuz~>4)KHJXELmv>ppg=UPbzrh{ZBeOWUMlm;Ovv6TUu8*k7zU$n%on`h zCnl8W5P$QGh@bX0Sw{rI#H>8BuOf~m3WE~1U@B_y7haYPBy1576Aouj zXi?oB0)6Nj`7BDGZ4q?j82-M-;)+;C5XsQOzZ3HOS3teAA^6OK+%q`@y^?=q5K5p+Q*DGd$w0E2dPw)fp=xYUzH3bOM@W9Dgh z8<>696RDko=g^R# z?;z{B4Xzm+JuF5sjOZzK@i!c4l_-C8`{ybLLj%bc%eG{aKA|AS@JP_T|`Q=G6X6&&ny*ovj zreD@&@f~4G2pN2Ec0I1MF z$fcui)s{`l`I_4=>Z)V*OLx<^2%>ZtT=bz+%%kpj#Wca^DbPiCo+|%_q{{`FuKsH_ zAZsQ^qh=JlGgP^tpnMISXsL_T%677Pj13a76d4$b^XY|YS4AXULK;Q~(gAv~jrFi` zzw|u%o%7eSyFjE3XViGYJsC@e#39U#YsluMK!FlH2*<;bX63%S=K*lqf#H6}t;{y0 z*YQdK{lreYLa7zHEQ$@ONPD7%Z`?C}ChnAT@Ki21<{2sZ!2Nrcz4>D7YwM0x_*S@! zC&9%lCIiJpxo@Yd-(EX1lk}0r;L>6Wvy4BPJGX{7SeoK-Zww;jK#kOAE6B|0T9loy zUBvO5zGLs7u4G`>*>&3!r7>I-TFCJFiK=Mty&A1uhd+%uT^N2Y6w=RJ@;)-LMwoN%b+7$&3$9wjcgv%rpN+$M5 zU`eXZ5=d#R=nyFWy}&M-i^)^B!70U8=lV4zq(Bi$omVmLu$fHCV;L_#vgon@6NB7& z49_0p1uDM`fzuo-$Fs)L@{>SI2F_m%6Rgv^PBmw(fncgvB#cEFd{Chn?t%PJE+72~ z1u-y`q*VIX=E!mIvN)C>@qa~bJR4Z!4*?T=h@A$gdP~34iyl4RXGU;w;e@yczRd#| zj`SN7T#Wdp?=#=+Pg$7+wi7^I!4&|aR*RG9Rhb!vp75 zvLq&GEBvdO%0gKaa6h1fcu&a{rQmstG_?SZio^^vlvoZrx8}}yOHR}2ax`a3Mppw& zz_9#A%5A12^GQ>u+O5!m;u7tF5N0;P*r6$23+T$rFP7}!l2+&VRKN>8MSVTBA!WFv z?ECpbaJIW}`8P3Z;2;0$o%OwhD2yo*@8gjQOmL*H7Yj!`{V}igo9|B4=a<2asQzdt z6+J#Ap#CRTH4ykkze6T<#-Gf&NFS&8w(!E*od3l>@(?7TtUq|I=P4-)fHsOnj_|H( zF`b*Ds<%)W@%;ISfwT}_cZh$qCV#bAWm)d%E#|$a0qwTE+)A>+{N&$t)_2N^OfUN& z8-@l6V#=PXej}nxQoJ^Eq3cPxGZ=jIkTxQ4DHjQK(R*e4dMA%^bpF+Zg>+@Dl5Y^l za%ONMMOVD^5C#p2m}3+ifFE4kNmGt&Vjf)I*Y!Fmv|^sA0b+0_!d~{euPATVpIHM2 zLkMx6r$F)MoR-|TNsWKEU_=oYNy{Z;LzRLhWbHwnQJ1yq%Ct`SuvJ|yS=CBtxPWol z#=`9EEE*9TChc1cydKOT^ojwMB%8r7+yMo?#rU0{ zc-eFyR%=|FV3^U8#3dy4UR3wRImddpvnY-iH&x!dng~3L4YSo*>`9t|khAVk=o-HX z&K^l*PPHFiK(t}zvZ|b%2UR*B>p_)7gt!+1NqZW1I+;)wLk8ymiiytx@K>P#`9u_Y zRG_0`5&cfv00r!aCL-;vQNn9t7_rCI!3P-(yq_h13C!vp-2m~xR*VAvsl97Pqv5sB z-QqYgBh??sB~@s;#j?LCEB1U~?-mF|iS+jKgb`gG&YMN!2Ihkr?TX?s1Aleggwq01 z1NRVaFl%*^Ez909Q~pyWCfd)!FgR0A&pv2_mz3X)#1a?!%ykc!R~>JIktRt_h*3mY zX5}yAYof!C&HUZU76??#XM~k|ou@AZ6c0ACW8s4_@V*VgEexZu#(Ps|MD_t5u%qQo ztHKQH9JuEzXcTb6x!6m;1^3?kXn36=5?Jg=TPTDMbNeJVPw2nCrgKRyibND<`*$8j*znBU(3-cvE+%SNH{5SWqHu|6Z=imElg zI33BjM$4vM8Nhb(FF3r%R``NX(Gf4pb%=*-7qJc*{yf+wI}?gdUYNv7lKZ))xcWZL z$?Qa@8e$pedG^!Mf9&McWyNiCs=C zqCI*K`~wyIwHWb{cD6MXb>elkIDOLXD~TYd1xZ_SU!SAzdf%91oM=XY@#GM?w4^v9 zB{IV@*oDN-tPBlZ0ri6CYS448Yns`euo;?nwx=V;mtQgmC-WM@asIEy-VlJ}#G&MF z$d5d=yhauh$zaN0CUX+FG538wXr3JH$* zR`F9=HPBf?o`zP^7yUTbUX_+bSW_Ce!`wj(0|SZ?v`!m^T7(P5=-?Me6tMU;#sISpS41>k=G$}K-R5`W&U~`&;d&BsTp44C+UW z9&JAQnAGAFfi#s^qvyEXA7lOO;g~ z)e=DLUMTkmVky3nEi9w#j@^TWf)(El9Y6@j*MZJR(uDf3N{;kbG7r+0)>GC8oR2n- zq&0>_%raZ9k<2Wot;$E&pTzw3NTx0d1P35T00mLE=Gy{JhiofN~Mmh!Z z+gKbD%o9wZQ#F|wjL3LHGRQMSyZ7(kE7r}2k@(dx&M{w?9B@tLe4cre9<1QN?om)u z^4X;cojl5)IJd!3)PFJ0X_mebH9pK=37{jzk_`b`Rc5Zhu_^fN0dQ3r1pRYyyX9PH z^akyYjZP8N!!NJ>4V(W*q*gACrqXI}jIsK>#3*@g5ba=GF?q!pfFLxm{U+i!wE;>w zNLFkVL?;t5s0~gJ#ZB9ufM!$X-*K-q6n;dN{zaO~g!-K=IWCkCP7DFR`>ZeFV*c(r zXw}>E@Um_oN+Jt-Gh@a8OTFu;{v+kM5k0OWur5UUU>mcEox@9!I%4A!0C z$KOE&Jd{a>%wO<*A~C?~d`^#1NvNl?cMCWuXZZ0YHciSF4=B;uqpKhBpw4kW+c}ixE z)iSIen(iPI;|jeoYmnHA!XlNyVBH-CGR#|l9|!LCi~hAQWOfnlX5vyJuh9hj(Zb9c z6bpX(+Mv^bCTH^&1XE-$e-hv)20?I;%lj|90kJ5NIa^V5jFty~tG^P=kN4xFqTEZY z@sBy^60*W6A=1&Ez2tOnKd0L_Q;qLW>%Pg&7;+aAn$v`1k8-{;KkAQ#DGfA!rfN&- z6%5_3ujw9qc|!LJvj5}Rmoyy<8>RCX7jGAnLNNez2%O%Gtq*Ujg6l&Iwq|mf5Y+!W zUEF}^*Z8o(LZE8-%kq_YfZTjN6mRA$pn-t~Rby!qa9UVfJH=}^TVxIur~{${h~?y^ zz463u+ZXS6a9n7gg^mG2VQaL-0TjwWS+PsWf-;p&IQHP57`dPX+q9yh!>)ReL8t@` zhPd(3Vx2zffVX}7U|VVr8UVK~!W^e7ae<;R$WKzQ9TyOZNmxox7UYaan*EKeB!za3 zOig-_G|p$@EXzR1CdQLXrW%@sQ>n6%eh1)i(a`@Qicjg-I9pLQXRh`dn@1GDSS=b+ zyo2-I9H0_P71K;q%FJHIarNbf2`6kxnh0Cg){iGP$vF-UGYjRRiW=lO<9QXKZp71s zG}K(pY8&!Lg#!fl_S+m(0UQ#^ETGDN9lH*H6hDyaALl0q$^!A4>`9$WFgt5?Da$2z;6GiWf z!?hWI{P+=DQ+Q@FsZ<>$W_I7GR>J5bR#R%t+c_F#PGd@p|7sMp{-JC7<0n*0qpi2u zO)TEhoDbj6^JmL)J!88DYcst@o(oZLGkK-31;`NZ^Wyaa|I!2KulMEKrX;{{uou8hmrVmg^7-RH1G5JX z41`BOf%Pvu{tMHaF6?bg0zlZ*xOtd^ksnZ?Vg0U1B;Nq{oi*HMKtU863mL zrv*^w4$+>08||~@ox+^J{zRex+7r4szkTfT^^QL>cWZ7r?~iTE73RrGw#LzhZjNye z7q;sSzKe(2-j>#WcTLRp%a&u+PjeF&nPV_*9 z#`eW5{@9ll4FT?!R&2;peGL7Ud{j)rA2rQVPLDwUw@SL5069q8zlCi1cH6_gzl&$Dyr#_6mT#vX@9RAFdCHeO#CF`2yU-q6mhuMgr>>~2 zUmpo6wcVqM+k33u#|IF#HgDNAik|EYKpwJt96+y_#UY~DkPH%)Ub%En*A~3JKZ(QG+o&e zR~0c!P@Ch5fn1fpTtCt^1)&K0mFD%GWwjw!B(E$4hYB4a_gFdhxI*N2lXhI$H%eWH zGxyczNupEYzl)p=4Y0BI2>?S?2UA8W`Jq0&HpO5O18p=iyaEjU)>9Lvj!a9PJuJi9)s`c}xnp)`lf%+?jBDc7M2C!9-h4!!4pX8o;sB|MIAjcb!x(GMPx9gsqrXApmTg<-7{9I2%l>0>us7F%x) z!8e||ElmLs3?a~lQGagAD|H#4OdVs9iJBhmsP7f0!kL)qsKPbRP7>y*W^fO~x@fSU zPyeN$i1_aS0`TVY>GRvqfYC0m{4;n_6WgQeiL_8P!0E=0U^x)L5t{-9fd_Paa0S5H zK8=F_1U*j3;yVWw7=7y@;6hf?T={G6Vn8c(dGbRWgnR1YF?{hhKis+Tc&wru5q?Rz zG3Ut-%eCuzRmVFP^%$87_Ax(p%;*cL*v!&v{9K4saT`L)e3B0*(GDPZfMiZoi+gXc-^}h#3z5R+0Qc>}G>7mD?=Rf&I|) z>VR_#&u*@|H}74F5psBMqI(s&uPHp!>ChYdq86z#Ovu!YzkPUrb8d70_q5jVH(FYa zsQsGL)PxenaJoz36 zo~<-RBcb;kqmsTB>T8A|Dbj{&`HD5)zL5oh)otf%2g_xbGLg2jb-i(nBY#|3C>Z{qhAP z05I@65!c7-YSwIkxoKr*AK`q~YDCH5Sg7YBFV;(YwS9ItV@Ie=7!f!wSi{guOe+pb zeF^|){6=bgkzX~~uS#SvKL?%_QaZxBQpU|Nu>q^pL%JDFTl~rAyVExoloLKSkb2^2 zx<)+KDN0qX2gErB;9PEd)XD-#?26Sc|L*|nzXXI@1)S#O0^qbfaK}{8eo?cW-yioP zC?3Bz{)JVJ^oS%_4!|ifA-fNR5xvgO>-PH{G36Wj_5QCy`ok$Z>HZcxDswTt;)Xh{ zZk>^RP6)HDruepTABU)6x~6Vd)$F>7=!0ylc`m=;%W8sOxaR$dto#EGD=YSW@~=aE zScfS9)B$MNTog69A{WvBWUbgD=2Qagr;v{6zdyQf5+fV%cUX`VI9{Z(yL&@}E1n{1 znv$d3bA>}}XbaG2CHl7j1PJ{na)$($hmm0<;Ngq9WgRw~c$K$Cr^qY_O2vu(_Bi1D+r z^LOSyE28ku%I(5&WtXNMcQDezBLL9{95^Dr3M#6WbQzmMNA_Xo2X7MkRy&QZ>mMlpQ$`&bpV)xlMMPSkcRjnhM`fxv0KK;LGK}28WB=Dy1gDH zmiYL>GgRWGQQ{&T@CA9eb53*o@-sa81e?sfPh)Wx?v8WQ1>V~OWC850sJ?)4+V)oH<}y6gfUxH15{KREC0(Z7DqX6LE-`YpKSc`Km+bAqqpH)^2>X z9~IQM6hbZ&Ehu}~f}U65l>8?Rcb=|+H9cM5)cF^4`0?m-uQC25FwA18&qQxr2IY{K zPA-R3;)A+tx zI*Cp1oggq2q}8eD5dEDmtt}xTfq}99yQLddazBJF8aNMO+9(~ZwZkT45p-X44epDIUeVo#>MPJi0jM)>km@}n_KxQtJifDg#HH=H z++7`B40<*Zj0k&Nn6JABjL;#VcM9qOs%74nlbT&V<*tY~2yNlaofx`dky|NT5cg5@ zxuUUfsd45Q=P(}&K*|x%AtYTAz{GFmu!LczVC3_eEmc;-@3~Y# zIU`~kK=}{81~fN_3kNE9FFE3lT3#f*!@KKWW}sby(Q4I4>5m(C@2K7lrClu6SRp$z z$fSLSVi;!_<5-%6+!X65ZgD(nhx`_gID}%1(ZlTH6k?r}4g1&csU){sn1snh9a(kR&R3xnSm$KgC^i+%I|0C+HquN-b_2DE0x8P7L zNO7kWhhRmDI}|HWD8)-D4#7$&7Niu1;>BCMI0q~4?(XjT<(zx(@7rtsnyi_XS7zJ$ z>}Pv$^74+|GTVQe2OEw4#o;!oYXv^!;AeA-u_{)#!8K9&&ng01r`4mfy9RA5$mMXY zGkpW9aB%a{hs7WMG;D6fZ6m*kqb#~}og<2N)*L7?8>8u-+`h$^S3ARG6nHW;_7mk~;Cq>9G?>&zntM`qPP zUUCP)hM}OZUL;gcePg|lxcLc5oY6{?} z0lefj>o#>BcF9F9V5X=XK&5I?dV!=LH&RX|i<&tq*Zw5ceYbTt#j^0&JS{Dyo-%j? zF)`wqd$9jf!GjHfT8-1clYV05oaJZbwoAPqT&L(s6i^vtKl?>SK5AoBS^cxI_?ppvs)%sn7$S0@0N2T%hLRB*IT z{{dm#<5N;p9H8@h%AnZ*8y4?3g@u<5gUBvnH6^X+g#u013LE<~m8{&rAn@;^23&Fw zGSC$T9)k7FTZT4S^?dE8p5GS@5t!rvy^`1LhF9EOrk!l(eJ~ zQ}^lt3N5%?3V6ccn)O)nqn?Peh26F6s5yTKqw{``R;CHv(q??x=Rx=^*|Utvl>_v zOO-j?JM6vB8uik2F1Ok;KOYSiH>DfOy!+@V22^WohUG+y6=^YPu{bncOd_<_lKzBe zL)VbAZTCdzgBapGav&;JQoZD(s#K{74_$^G;Vtv~RSMy?@UMH0&OUE)(qL6~ng0-o zmnclEQ0f?<7<28t7DFLiUBxwn)xE$p$=mH5>eJ^yJD1}&OyR4r{#g{h#&}krZWC&? zsle;4B}apGJ43mXZ&gx+HrnPXvYBM{?Dw$S#w>Tubha0vR^kDQWE0;m_K1i%LP|&~ z7Lw6cIJEBQz^K^B8n?7({&c%puW4|@uq0s~?bvWoGw@KBDew-3T7@KREFAgQDiJ9H zNj6gdcoF27oJ<+MxSZ!D{3>w~uc7)!&708z3e#`48fe4rsU0#CDCinyIw+9#x6EOH zC3IkR72~kFdwJtQidDfkMX*_x z!Gf-Yg$yMueUC|Nv|0Y>;yU**{OhuyCuWM<>B;vtu4cK6>>%T)>^;4ht@0Z6dJG|* zy*Mr3WIo-?NfCMJ`y|%6e$0?wQJ{gNUY<-z7VHZ)rxX+}Z$Z$b%NFpTZ3iVFg>c>`|xZYW}7{8L^KYz01~F08C9PA7 z;#i@dJCOz%9uh;ba1Y>s-!bQ~{OSB{geccgK!Omvt*TfjDG6K*&bUm^M-K{#gR8s^ z7WzARRUZgG?$2*TU>#5nr;CbDX%Bx=8<`Ov98dr77Uh#Tcj=P4>!+ROkjDMvhv2pY z>_(0iww>M!IKQKtoXmLeXg*8NaG&Cc7wx)MOX>aKKq zec@k6vG@`Oy{1+o5qWmnMafUkaDG|_!+S@dtAEAN5z7&sI@VDYPgc)g`31h_!Eyx6 zjUk)&N+c3OnA!OVGh$6FRQ`yH>V_yU%8_ypGUbd4kEWl4TdiYgK^-37PE4(i)k8iu zMR>f=th?4Z_@x*CL752&VBFQhZ|_OdGM*ZS_>hmuzF zpN!4Lo9*SKA`h7p6s+IdPr7mq+{Om-vYT2P5nQF60E!85Yp1>szFrcc=v1blz(d)qEds{4~l@z4LpX@hN3b z%E0ZyZdW&g^sz3%*#q3jPnf83T8W^%`&*7WlK!gO{MU7ZpP<_F)H?sKM-Vzb78%E| zQ|6?vWXnMMo!5GA$iqT8)4Lx>G>)*+xOd3)6obmCkp!P)A?p9bT#2lWF!Y=O_@8t6Rce?4+2M!x~; zEE&)XeA%TH7`s+ZCONNsF{Z(wc%FBa>KpaF%CX70dAEsqz!=I`db<&?KyJ3c&-5p^ znU?2@r+mpNlVC+a#F%~+5+>4tpAMj+mVcgExX<7D&leDZbz|83u1jP9%l1q1~^Dl0xlB6ut}i? z9w%qXUFAnP{Vhx|j6{c#KML%iAOXmoe2yTwP==XFPXk(wnjAKGD*%R>uA7*o@yz4+ ztpZv4h*&^#*L|)I9B@=3i{hITd)UF;R~J7BfqiYqD8%~|$&rgY2;h!Y%DA`&0YZ#d z%IP5tvy{{6_H4=}pU?n&2ITQVL)R~Bn^5P@)k&>ivq9I?ajnz&X~V1_D6j&KTsBa6 z+77<{bAm=O%(3ndud$dAgD+i#x4s#Q^v}iuR52@IPEYEU zR-e>1N=QmODp0;1Fx1jIA1~Tb$@5;^N-+R&_(PRHI?_E$y_qah%c_+o2sZuhyJ^Y^ zF=LxVyp%4%SLWSFcuLR9%~EiHBuTc|`%1Q7jja6|T_Sus3lP<=Skc!rg)bmJ*j)wu z1^5F6hiZK0+G|jaMxT83^smQi^+c{ptUI&Oaq(Zk>Izz8-?YN}vz4$u6+Wb>Ab znoAdU*h_MHC<8lB7+I-4^8iDEM{P03b| zWart*O2d5NAvuDns~wMY+0U9;6CT}fQoQy{o&7j97ulEVz1rt@BzwY41~fJ!F@`4} z6_y|U&{F0Ik|O1go99rxXesqWX&D$?o?QG;3)% zBJk$QlwnmOHV%LxcB;T#fWumd`O71bO>^7+q>MShMjoGEbtkLdQ*d6OgewkzFcLU_ zH;FX!Pel7`8gYO8c*LfdMCqHQD*TZD@``(nhLMIcp}F+td?ETSBN_6Z@MjR*gU}ss zwe_W-7Dz9+CRysi>f%wPLA1b`IKgqY>Pmdj#JEdL`dKtXTa(A`n^m>m{FX=h!BJ{U z7LM!drkwes$KPbNn{ub{N|>Z63BwvArqr%(BQQ4C;>Dc{7kpXO6|X$t(axf$Uz z7moF;aU2o!jXuTn9+xHCN8XBNRK)$)qeF|%)zi!GHxh?nL3pkRIhxg12Vm2EPS`ED z=NhGWc!0#j)?n7{NA+dEgB=S@o{Vw?6Y<5%N!8+k24ub0hJ8DW!+__T#Zyk0$Xn$$ zm_B1;ejIMh?xSq=ar+0OfRy*-`DJ~d)Dq3p{d_UVlWf@2QT!~2p0gm_fPDJ$@8yc% zAV&oj+jwvEam!TLXk+xx@VVLkGakcw?HWMbYiSRKhUNB%xwO~3&h(k0Z={MHrpy+2 z9@lMWH}n$EY)o~RcLpxr-kBeC#A`Sow(LfjzY0=nD7(A*LMrNU>(xV5OPF6Vi3*vb zLF=)K2357+bwQz|{m1!kdOi7PX)wSG3de^dyUReF#PeXkSreVsIkr-c(s;F#BpG)Tgp zk#$=5tk+P6sO%!#g{5&E6Gn@a1PDT;FGxz$6tnE6AW%5j!RAe^7}*a@W=vIk=Ulqh zH;X6T*@L>+g9Q#{Bbzl1gPRHrZq8*xHMgZhzc{7c-|}!5fex}tC1M7X&#IW*qx`2G zDhDL~Vd#VVAuzV0`jFsF*N4oPM=h06MmM=?A%#A^F`9c&PQbSWN`_mckTPyv==NHe zoDtA=)AmAOGP?+pRsf5C$=K}~F(Wt>F3Ohg5-GHXiA_yL{F`YbzWI{`wQ2$-?(TaD zAm193$_$dCm5YPw>H{m3UO@7}+1J}9P4LJ|%1yn+v*z0p&DZ-#Dw%gKgLOhq>!o-o zFC0;<2ltF_jE@qu>dVd#y^==UPcLI5H{g0UOJDb=&(H*C4F{-~e2(uNV`d*uNTm0G zLnNYi`R%uT@Os3^wI>8}UtRQ&1eon1%JLvJ&U0E|55d-vJ7H*-r-P<>=aQdreb~fU zQUs9&Ua2BT&+>2Db|1hY{@sdlSl?6PTh^q0ZI<2bPti1@Frr4jj!;=7XI|obX&%oe z>9YGc_MBs_shqFEO16Y)0D}@%AWp034c6JF>DYcTC;jspZgL2uj6ol?2sZSP;0T34 zl@+ILGlgH`L?rpl`koC0-t3}l7JO0@XM5{*K)ra3;iU%tUBIQ3#)vlfJAyJ!x>Ig2 z3{rgbCBVMrl(WU;Lv#1)vG`e`PnAq2;G{IZCi3HpovzHV1ECi_oepa)0>R|y>O{A9 zUIx<>1*cgy{4BoC(_6wUR`fsCYE_$t==N{-dc2q^vkT@v&%W_H$8PWNwr_`pgA4fF&!EiOd+EVaB)AzEo?ly5%YcyhoN_B+`8vTdlfv*_9_JWE9{ z+93JsgF7p+)geW*p){rcwEE33l`ccEK4-L$^duXqck_C;+NhI5^wQj-$35nQCN9)$ ziU0?BfpX6H;r&Zw2MKP8HERAI&w;WV{O_JVhBPl3Hf&t#5fHXCH>!zdrDaX=Z{6U` zSl@LX^c%h2>;43M^%Qk}-2zsEE7K1E^f`-@6}<-R&CtLgZS-X`ishy%G+pCr8l(Vc zT&dY0VOr9|udhi(K#>p6E5Ft16Wooorm0LRpXD;Z&S@=1JyB4Rw>9XRv(I5Djv^4V zb=br^ExrzZZ&kcJXMxY~pc)bY{$VB;7>h)#%gI+17_kPH%&?;9g5lyqcWHL0FJ|BIi8jkiTgSA5W(#Ib0w3^y>c^@abq;5zzm&@d(Dnrp^U3izOM zCqMP2TbKa#6;|?jgw(4)SjiFaMj*$)0rqAbTR6P+UXsCHU@^HE2bg^bP_feWLgFFn z8>u4)BCiU+RN-$di!Yu;LwLsR0J1lEk{80m0$>Dxwt830i&*+y_9ckIeP|EG2pjK? z=mxE|xnyoRccV_uIu$AOH3o=zEjot!%&GnBMxP(Wq~Yu^HWJ=JHeq#{=h(GjARLG) zNl?Ewyjx__$|{e&WrB$a$|52`vmUl|Y^`ohBmuGEMUT8}Ph_Gk<)W1y^FAj(jQv_9 z0n|j{Fm}t0m}l9YLaN048x$yJPP9|zKv5o**pTZ@?-kryYn!h|3h%fX*Yxtl?lINd zOIr)TNP*#+!2&{FjF|yb{#Zznsg=b$ zmz^wpC_5m50`De%_5QKHhv(rFvpkzq&LKCYMKJfOsoEPA#@56aTqRtk9mP5=fO8Fh z<_B;yt7Ek|-1%bz;{=`wljDy&m&^HLYBCr#BAJ1%3aXAPv|~Rb6o8rG?0v=%H|wa< zTH(92Q`QIIFwK9lQ&cZzPciE$Pyh%#o!3f7#YSE>qA~^}Bk5T!?{(3YfaYjG0b=0q zMyY#Vd$-psv2ah3liabrwQC)$uiEauHM9Zk$_Ka9&D!)$9>O1pt~SDiM%Oss{ZYBr zWmkI4$pO^gB)(x6zXx!_4pJ^3?N|*`41|hEdSfdGGe+o8K~ zc7M|K2^uqAaz)L9KlsyG8_(@q02GR@=uK(f+ZluIve@ekb2>aI+qZc{zdp?P`yLdb zjZu*;E$0C2K*IqE-F4rBvEU;g_ILm|N?@1SnD8u-)_mBp)nbvpAB)Nrl{1LbYFcFw z&~}oOMOYFYxdU#sS2b}x?0-RsoDj7rn^>zsOTti9aOtppHES}f|M$0}lR{qeS8UcP zpg$VcP>N8om(41|n7$JeK|c#Re)G&L5wu_QIxR~Fw==NH59qljb|FMi@+F4J1I!$6 zx63A=CR?9nqQBIAAMx2GX5!Z=#;Q0)_d!O$U0LNV@p4ufgMD@2r9OpE~Nb-!w&5fc?dYa%(v)k`{f_QzpBf z%0+4&{nv0Px@^@k>zYRdJW2bAfNEnq1dQ+iSTY0}W4EH&$$k-=aR&+PQVtSxs9kXWLKA0xI|@PrTXHYfHE6N2$9Utx zHvi4OFgRUH!N|{mzq{0j8*q>)#St;Y$GW|`tv=k%0IL}<%;A7xfUIADz*!eFucgA$ zdVby>d)1Lr(c39~nRCiqaw=)T?RCby2=m*8Wa+?&b1^^4!xH-&E^iZE`lg&6v52Qk zy(YfTM#f|gVPdrhdvWOu$nCl?3V>pt6!V=WyCHv;rM?mFxkszvu`sk;i4{+XcD_tJ6CJ&XpvE`?9plo<$ulQd$xr1k1YVKN?oM#7| zXcltfpciTJuV!151f4xMCGWJPMDw|Npj)di%uEA~Z)GydWd8Ih(w)TTWb__2)krDn zz7xbOvd{QSGo`=#({w`NPMo4reRsP)CyCFje??bpcFIt5t4xFLVubE?kn&^srwJjJ z;lfzUNoD#xNr9n!H9<^U_2ENZ;;!E{~p7 zv#GP=jPg!tPo*^yQn=k3Oi<}l5(eBV1rxwt0|y3k4rLZ?5AOWI?EoSZA0S+*`SNvO zwTD%g5>_E?5EDzqs&x1)FbiKoBT3+0cUNFFWY{;zLVaaQ#;ny_y)>SsdjfDo0Q~65 zO@6J5TTv>}4}bnXhDY=tE#Kz8gV(8lT5Fs)kk9!$6E0&`J^npXONTA!J3hszVFBAw zO%l2EPBkfdsX~bO*mfAx#x(3LKz&OeGFwKLT)hwdrCwzFXKn9rL>b^dhg$woiGV;! zpBbr=DJTV9jo73*_J*lqA+Xgf_$L&ENVU;rx}`H4{4(b9S_zL*9bERH_3KR=2_lWBDAkXaJ9N z0&(ufRIh;jn1oPq2g!LL!01j2#?y5ERol^IjF^oR2{Gpm+s6L2{}@u4OvAk5!q%h0kvHvHj}TM2#Wdg{U7@x$HJt(?32PvI*_rn0^h z@YHUYi7k!C*iW*C*UtVC&-l%J>364D3)t4VJoKd! z5O+V!XSbeb$>kdL;F+>%nc{ueYMeV<`2D$WjFx19Ki!JqY2PFBXXL`;w5r$G(}IK> zcMz6H$n@W|Zc_X)eXLrV*WL@CRcEvh{h!W<@&+1)6f?rwz>|=>qiF*6-zN}gcEE$n zmgH5nx%6%SWqc<|aM@ru=pAqOMmo$C14^K2R{ZFZMb1XH${xi?;6-{&Eh?*JQ!SAP zKGO%0Xz}{Y^d*si_EXWW6J2mdEa(e|?CKpmUSswYkl)Mx6f$oe5z4gDGLrv>d@p^a zne^QB1JEXC^(-j41U?5kGg4KsF`%yd4${cbt@V|7&%0Tfw3s97rq=y}M5vvsn@zRf zu13_HkZ7YvJRXSMvM%?w6B?y!g-O!D&{2~OxQu*NJC5M}J&PJlFVQ|*zd6P^47-PJNg z20AKjry8`K=-);prZh3t4fXk1N;0k*w~WB~NAnutR2%3Yx$U%HYIAowzb1taUXej9 z5v5h=j6)2#0yJy;P51UqOhw8C+J{L0+X(3rJv(0e9-(e__ltpO@xwwql$rY9FdiGp z_V33eRRprm5ej@Btpu0wkw8}(!oJ;<9s*A;qgfwt!gx4z3}{k3Vgf3a!gMsmC{S?H}^kxpKSg#`@@c>|YxJ z`6!s`+eQ74#dlg!MM?u)`L zmWMlA1WBQ=FeAE>^yXZqbK8-`@k343?(h5!#0-=CtA0S}IRJ*nkbS!hO>4ngmIBOP zoREO9JPyB5m&J(5SKKasxG^3V!fYeT!`j+}ee4Bvp#9FZ&tS6<1k4DLlEIPKdwKn7 zK})XPzP(srdD#19kvv5MhE}fc1G#&~;OIirgy*{eg4$xb@7mb;=^!UT&QRE}($d3CD)|)kJsq-l(`FXK19f$qo$yKj?O!Ki9_A33^3w;P}9TjeULYmKh zv14^CT{y3NsYF}-^LH`kDJ*>gC~C<7xQKWxe{4><&7b?;h4Hb~4_G}}Ski;*Z&4*F zXxp2fg&(^+E}$C1ue@m(^ilMS$X>O^>`22KNt5s1ySyy3kxW)Bj>tQR)GVSrA+mHl zd`HlVx~;%@U6Kv<1?2=1xc(y?Se>sv%nqx;2L7f~vv_FlDgt<2f>8`?G1w&sC>L;j z*p$JDURrgK%Rw}w;y4hK`pm$<+|ALiZegaYSJVqmkY6Ff`ZQ^}gi4IpzdBwE4nDWv zG&P`)T;g)^V;IwK-50?x^*M5pY+=xkDSN^D=}NK(c^m6$<)`ac%l`d%&HH_e@sw5$ zmoW-E_9;CRN!`0XiKf?#6HJf1P=X^E_-A$co)v7KQH&R5y-utqk^WQlF!uNLtgWV5S5DZ}enoyavat~0siK-&h!hR`LbZ!i>G*S-wWMsTUVONc%-r*?T^|}lgL^w7?a!M48vU&bM3Zt!J!()=VfnJ%Ax;R5VPBLMqDo3oU;V2`+ zs^S#+ij*o#cE|WCG4=XEdY|JBKH;PEm$nVF#rmVgofq{_qFcvLWUAi* zt2&r7SV5_HHOlsWH*SmltZCnB;vF4)%RoDSSjN;nIWy-XMKc>F7b*phBC0usrRnCZ z4RQm)*x>|;8GRwK{f*z6rK?& z$TKr3>DUX7nutiu6EuLuDHF`hg9z$&f`#TLS>^MWw1~i7+O1 znQoSh5X>R@nsPWLELO5#=J-4=Wc$;WUamI{;WCTaYS9!i{AeHPOi=g7J2VM#NtIc1 zcjG&zTlm!wv(lxhdXk%<{WV1gtl(PKepU1`kzD1%Oy9sD{&sN@1@p4?+$Xmi+4)3T zy1Lbx&7s?%jJ`i0-RpfViV1+-fsweK&!AL5>%WTd4tw~z zj)mGc)GZ_DTgSjn7Aumg*~cv>0Sr{0sw}UfVoE`cBS4pC3#X2p^V#SZKQ^k_0OP| z*nH5uJPDlqA2(Z5=(+1S1d>GMQHj!><`(iwq#}KSemuFf8c5 z@56#RlETh&25iMS8Zw-B1S$TzH=%9O^i4UiTEr5kJcC}1eC$SMRK12Ngfqfx@eLz)Dy~8O$-^R?_qw>ejoXrG6zRe-Cx2_W{FE0XK{WagZ-ZMWsl}hzFItkFZXbLzz%1OL$CJ9J)s!ct- zZye(Q%1ht;`QpluXYqVW!EcD^;NJ6-MD)1!x6SsrTnm%%pS7Cy{@RepJO|@n1qk20`yToqOeSh*Rt7u zoNZQG&9zpr5iAXMfLHv;{ao)ZHFlOQmdb=$DyE(ZtafrqQ`9;=AbHFmRo6I7QrQ+! zOUq{mQfk5I8EZrB2od0V6ot>p7A~kKC<2gNoCLD}{464?#rPR8`)|J@yipm43y)d` z;AIW!F`JdH`_6~=59+Gesa$9>H)evfy(@NbyX!tb#LUc%Di$7_nyMY^s!rWG8HqI^ zW0Lk(o;-L==P~u>y?FYf`sU4>zx`ir#0AT*zSWF*#a3FTqL9v2^|cf!ej$yg@uFsJ)<~Z4n*>V3buD zz7QGv1e9+iEdgeSiyFuPjIyzATlUlK9LToFzT{#3lz$-k`KXm!_$!5UJoHP@c%f3^ zD|F&;5V0#<1snpwXN*R^BEfG{)hQt=gyg4ZGe1P6MdNvfcQx^w|IE#xrY z7YYTZ$ ze)EQNFikYdaqbZj&-z3lrWA5_Wjc*&(;+J-9o(mfwbB;MXl?UIZBS-{>NhJ6y9&o* znwc>|Ag~H3tq=nAYu6{dt~=TiA_bbdx*={`kKrjPA0VtdP3q~lnA$oz7O&E{)-MlC zTn;Doh5KI!3o|e?gZ=!>+=Jf#C#v(LhGUL2&?R9}n3*sxl(!1&PZQv@SA;F-&;TC^ z=+gNB2Y(>?q~K*nfaD>A{ojbG35+OBiq!6As1cs`{0pbu* zQSD&i;eiS7(DSpip%s32pF27_EGCNdvY@hTpHY270rrz6ZKyh#lM%%h1#N9cB_}6> zpdkP7>1j&M63?ylOeSe*!VpK1%|!0hw)&el^K_!3Gg;FD_LE!=i!_!Z{ETX#9=@JH zv;g28GYd=7rEiavo}nE(ioH6dS&Ghu2EBW4|D5uQAp6%ZpnOOip|nYOPY)Irsm0-Z zJ$}tvgLhMtlA4-=ipuY=&}aV%NhL;447U(0O$=ss_eEitRjrC~yWBsRaa#v<3pM@u zAVhW~2fPqX{@-;c-FRm!femeDpjVPne$Gfzwkm7GQi1clTe z86STyqDqcpg~f-aMSxzpyH8jdbg`pY8ZlMXo;Thdf`~*)_VVDCxjo*5q((jOFVxt^ z_ZJ!{P&j_HspFl3Hz@jE9vab815b$qhr4N`kMt%6a&nSj96<+-k$0#XE-YN!96q@M z1kV4BJ`0r|or+-cCzqkX>=7iDu~nrz0`*i<$kdht1v-DC$)iIQw1EFJbcJL?5JG+l zCXGSYAcNs6b#HUzN~2M?Yv70H8gN{Z8TRPv>YCLT*xue2j0p|uTK~J$K9FkOhIbdy zLqtpaE}5{fxVUr9`H7TNQtD>iN=y>(?S_HjFH2FSj~@ltN)XF3wg{nv@%B*M*rcTQ zYQh_Z(0ZCIth=itw5_*%rr)8Cva&CK4PcFgO88y_Mx9Y~l%$_@?}z`Bq$~o+9pkn> zCgP0LaP^TAwSsG`=#%dihV=kir2n^z6TZI&{Fu_{{m18QaHUd6F+lc&nfu^tq@y>*aG)$vko|cdu)U^4>$mL? zox}XKc*vJ8qZ5`QvX81Bh;h-CXV(RGM{JYKf#|Ervi7K2Hxb`!zR7a)7!(C-5mxq( ze}(@oI>ZMPp$Bl?1yI$pS5Ok5BMlB{poxszz?|IHXO+*OQkjI4lyv%P8wzbr8;1n= z_-^F~v&ZzpydV7SC60~;t6#gQ?)m-SWT0jxgV=q*>66bLOrp!!=5dA3a?B}m7qH?- zgqbvGw>3yxSX%m)gOeS^b0LP;X2FCiX2Sf+5W+*G?AE!ualXFP6!u5uyCQ7FxYWh1k8zVkHbv-T?A9E3IIqM)c4ye4=s zf%+6=_*pnOa8@@hR7y~cv&IYbujbrb>P@nW-#y;n?016>zqoudMTg-3D^VwzsO%f# z_9r;_D?s22dxcrDCwoN+0c4B4!e68dwbK*w{bZUWF3= zH#~fII09h#84eclfQx7Zc2XXpMp#J%YqnPjybu%iDWQR`KE8Kwkk!!}1zrXxgD7k&6Oz$edr|Rb^=|E?mk@|M2V1Re+l&U+yXR}^y?V7T2 z=%x9UaP^Adp3h&&y=lBQr-#j77#J9^+uPgL;G42C9+w#EXVh=~3`R#r0#{dwy)f%F zO7{4Jj$W)vHk&<>OinB`HeTMh^@C|MtGYakO>EVW%xr+X2GE=mN1O~I` zb?`F?Nf=VgZ>|94KYu1qBKW#f#0F9dz#&0LzgZR}NA(gm(DqHckTX16J6sT77E)HK z3mG0BTK-7J$izguvGEQfQgHv5aVM?3swxDNp%ItrI|!GSwIef_)UNwNtB!vOMbAz> zS!UX|_4(q}_28#wrDuF(GB5rUmJGltlN&yS8o2I*(k5fiphGF3h_{n$UG)IVOprYn zIz+TkU0GSq(vl-P+sgH^{W&vBUhmsq={hoHwD}6&9|EX}+Kz6fm+a_wgm9wc;${bmTr$Y3D4RdA6)vO0x6APD%fHg~nibx-0s|yl2*FA~h!7M@Kv%7za^MARF(`I*Y=z9`#Z=qD4G=0AVD{e{JNUhUgEI?`HNt|2r0$)?KQt(uuh zDexXv6E$VIz~92%PUbXAmamvd9j6GiiK6E)%$n3GJn}e2Y5NPV9fciW@PCw^YBEM z;fTw$5yrOdG|a|uMha{OOp8}86&`X%zn0M5zz>&tfwl2NPmdkh5-1H9E;{WZAzsZ> zVn8pF#~MWpBNJf1ehtvM;L(ZynrXCL`^LW%viw>B<Se;w5E0y?l#XQtwI! z?cjVDl+lV7!bgZi$CiLCW?&OSW-0PGiq;jm@2OF{s@l+u$JCT!efyWnH#Wl1uRBW| zJDPg#ag6ok4XGirq6gnnQs1zDDK5%=g~3CJqi}iqg#}1L62rF7`PMc5M9)u~*ThFf z8Q6ox34imexw=%&`;KQvvYX+#?AB1;P~W0o=4&0Dh+}OuS53eB1U|Ym{M`urZS8O9 z3QxEcKGsix|BPmBk$MkM1s(&Dgls&Nsb0m!8ras|J1Jr-;?}tGG8!70RXZtc)8_k! z-wra#va+y9av;^iT+XU-E`*HWlh>iVt4G)}M-01HG%^`Kz#QG|~?-i$oeZC~jm{w_cCd$CF zK7Gn}H(hA241`%mm6pg zA@|>QZN>bgl#E4zt1com1Y!TIc>0k+^@mwM3Tl}AVmy@S<~seRd;D3S?mtn7CxMtb zfy5U8W$U1fM)b)v6K{Bbat4T56o~5D0OqccW!dJ{0umoPcyb|WNQc#wHH*-_%*X*8 zn8qj`RYR@o$E{0{3>5?{-=#)dkY6Li)-Oi@li;K1?u*U`>%nAJ=mHb!ekhy{eJ1Ty zcyQ}D3ffDe{s_ZPY8y@&;$R2-dJC7Bu6=St5G!Hy5Rp=l&bTigp=*v8Opw5Rsq`-b zt8Ib+GB+R@5S4uFQ_?1Q6>X#a<#Tc<2oEU|dGQ)U0}sxDcABO5jTr+$8vW~40<-%? zR1iHDGj?w93MTiYoEeO(iv4Hnvb+<{B^iv<0j~cu^DgVSz}3)m_ONv^gR=eO|HK8vY=>JS-Bs0U zEHXfD*plIdTQai>6cGM_?X3$uwc(M3!K-z$0Zs~@2(+)K8oDEIw;1HRy1M0T<_ej6 z*{wZt85G$h?C)}($#BC08_nK8XId@`V1!hyq6zrok9y1tl1-zFt_07)otK(zG(n+v z>?sDizR%H!K)G^9xZdxxWPdDc;Bq0*lt9LcGBy_d1jqaEYrwz&wGmP$Q^xBvJgADLpXBWw?@p5BX~d)c2X`)i5}d;o zVcEg7|2M%RKmqZ8BwzfG4w5*H1sEmRqbohuw)QrGtYtvxJ$OV=4YosSV7vLH-cK!H zpaplfrh(>sZT9DFGg2%F*|mxxCsP8hULiNQvvrD1;5~OJ4u}!nF6vk;K;Fk-@%ey* z=xjrY9T-HRlmL*Cu|z+sthbyDYW@=7jLTD#h?BBna*JRdQ4}Um7xivSMvoWS5KSKZu@<>pZ-@hbg;vI`@q+8uy5187XkP$6dOSy zNzPy;SwaXYG{Qz37_=Hpu7_d#V&oF16Kx9vGfWl?W|?8tn8d*$m{lDizJR>ye1iseXv6G) z6?1RqifHU{k3Zimmx*BY<%hZ+UjRHKV85%j@ApYSh^B?xm6w~F*Y+@dn5^cq;y@cE zl8$sruk%#*tIDMyg*?#*qFI;`aOq_|FOF>GB zRCx8wLX+?Zk!~D}5@v|BnzZBfKr-Z0zU4WLc~16z2YqCsP#!z;;9zV0$FuY`X>I*P z;(PNRDtlqVSnfB{LPx|2d{w_zja&(vIc&T$V!8J8FECM*>xOs3$B0tuObP?||EdF# zG{CQ*D)O9C=!1lk1v4w&{^D}x8NVStkwMRpdqk;(nc``+jd>-&;MntDX?zAoc*E}# zX21`nsQuyd;beRr4cr6za7m>)y!Fm5Q0U72g-oq{2PaI)rV+GGSpOkVLFP82=y^$x zQ|nSN1;#i*@+^ziad#EwB*W`xGRyYA1`cKCqNg$dD@O}N%*JT&djwG7@aL_y%j3ID zLAQ%KOTYd4?wEklt6UUNKbg19J70!P!dIk><6&+@a)Z$WJCp3lH|E@Lo4Wqe4dvkg2IAzbGf~zhY{;qswj@lczmXjR zb>8d;OJ4Qp&u`90Mu(k(vR9u6TS|ol4kYjS%9n2pVRtD@`JcMGagEUZ{|2HF)qlH} z(B*E?Z^m?jZ4ak!y{U=pjQBjy(Gxz!7fA`H_e*Kc4MiBr>D|VaWj#)&DBTR_xARvc2bFoF)Uzfy0fie z-;&P3xj(CV0yAVBHPIV=PYz2tck4bPm?t+Yf)$gtZPmm&dV|*eoOS*WDJ6!#WD~iJ z7*mCv{R6px>u#u!dvx@pK74~opoKQZFVSrNzuDEAP9EAST*=>M)M0W0io}pXKG>-S-}ga4tq1dXaUNGlN=KG1OCxYfWEbq#wh!8=Sg)+P1e%f0mZEjWK%j zY-a4^B=Kcvgaa79uV3tpvBvU8_A6&(inwT8ChDD7{qFkp3o~U(^7p5m(N^zv(GTwn zr}X=m)CX_e@=ZD))EoU0!%(8wOagUQ-PRNT+~w3nD4f4I(Ms-Cf_@_w&5(@qRz%-|TDey{^6T zTI)PxN#zK%?4!+Xac;27)pK>}n!_k0Gm_clFtOx<4SUJ-USPO$7=*r&AtsK2HzCXP)EWf&xiD0 z)%h`RPn19Wu$QmN&dm+e#zkZMki>JcuypV~Jyf?Z&CAPk-WX<(%ro|`sr2^tUI`)+ zK>y{Hxw*L>ausL`=CAsAbY%9V#&c_D2c^wP1`o}!@)aK#P^t1bG<}72txnX%IrF92 z-{%p%--Ua;;8yh{dD2I>zWW3;;=g{A*SD;}r@U4^KKMC`w+}_8BKKNkL=j1S^J4V}2*C_b1VC6Urj|m>t6zP19Y-*VDdi-WfH^&}pdt$s(uw!_Bo{gWM zKYL!he%;+f{_F25^pIhd)3Pij71augy3qR{^SKg@)y;I88XVACYA4rLjdZ^(@@M z=tjV?Yxl=dZ%ozx%Yk$exrsODB9#@Y{>I}a$^7SQl$*S=XkZD!jF7dki$YvnT-WQ} z^wUnJ$vam$UfWD?NG*5Fz%jmGhV z$&3aOiNnL`5q>u7DR$3o{(i6g967Tqe4{TqWRJ8C42Q3a4y_HO_H`|rW$;>5J$K(r z6L1IgkG6{M2dFQd5ou2NZJ3D8ihUOj4vrC)#Mg`&9Q6*r^P|~~)_gmqjQ%BXYSKWO z3rY^{fnsN&O+7d~lI8m>6|pMAab)lws62{Je^I7eA%W?h1uTjD&!%8QsRTf6Pd1E% zUP^fSWF1*O(cT>8zuGi1(%6jsGo?t7mtee9e%0{4LAQYYhK>|crf&T7I*4ezw@Gkv z{UO?vbZBGyCnl;dy?)UF29Ywc6Zn|iqA4dxBloiW@BItVuw|x)v@b9?3HL1UQC#+4 z+JNSQ!6XW5kIg*4z-|^a-98FiZ3>p7#(nfb z!79#mZIc`~W+g#3pl&8q83+#b7ON3C@{r53D;iqB;99Qei7sC? z6{v>*8j1hJN;$R03TmLVmhxFC<~RKejP0b}<~Qpb|J&28-(TGe5dU)ZZHa(lOMo6` zgtIQ1nHq(5sB++3g;+52FX-(FH%o={F(4eVz#QUuZ7LvyMjcwal;Ou(zp!H*qoB(GZ`5CA0_)o*Wie)Lhwp*-G?!6y~-lHx$F7l zH`y&K(Z2N}#do zb7;8J665<(#nQNVc&ms)L?QP$;KZ zY+hu*-r|Zz3&NA?7}EMsR8pc$i2XU$vANK4#P8GN9~+EMC0fA}>uK0accf$WGL(5) zNq8e)2KyD^%UbH< zYPI^O@~~Qsv8?HA?W96wztZcyZB}P2Pe|o2mz??IK@r^`EFx8|ApZAT+D;js-+ziO z&QB%2IeTTYx92Nj(oO-gsD~Fc_ERozqG`3CKD=r~W9FTr8DG5Vei1SMv$;9hNm-e3 zrh#)u_j=%B4e2KV32#8L-Z&+As?K2M=+?<^-gSiZ!kWji4O07`2UOISY=dD<| z{Dz|bx>;Wyonwrb7LRsogrx9qzlq~~Xwz|B94nvnx--?me$I0A@HuVq>l&Hkhuk%Z zql$5#{TUaY6mws2QL?_c)6>cy?A~F*M*Vk75is~^IC|#pgf04p!pM-L>qC*s)|p~6 zA&qE!2;fwOd~te;Beg@Bfn(7E&*~OC4yJHM!;SFC@~?}1Ky*#AjfQNhxl@G6BApHZg|Lbvun_Nom@KHi2;=jE%+?s6x70&8InH# zTD~-VT$CjxF6y_7E^@^X9BIA5QsI|@Kt5C92>26dem_YDhdsmyS+21@)TF&w!Yl5$ z3b2gt7r;4CefiQiK7UQf+&27W@q~5tqXVm0JTh6*s3#e@RY&!1^Iq8(9%cuxrmL;W z)unt)9DaW;mV(Rav9G7KD;e{fRVLP}?K0Vj(Id`syikXerdMyzi7OMwZ)@!Hsq1gDNpntZD0xJI>tw+GI zQC_Bjcl#+AXZn%4o8!&DPG1l#9y%{RJEeT8A$O@$XqL>XOS-bU8nOJ=e!!D_NO;}< zu*K(+_l#p^1sC-Uyz==~8t{qE_vAq|o!D~~P#_Uz)($Z)#`(s(_idGC?6WN-TPP6Z zs!!6tK>9nOIxpT!X->+Y!fg?$XfD>gD^vBDzRr_^Cue*_qVj(s?LM5-IXUiVFqfBe z;=3sidtLqpd3wEZiJZXfjg9{+Nvw@yj6K(MO|SKmAw##p@$tkDPAn9?An$tGYSnO) z%w#!-O9K9rN3x!e9J|CcMA-m7j~J27)#DQfQh0$1{@>N$n1tgWM!Ij_C+z*$ek>X9 zk*WLIDFh9&$%+-Je}W$G_>U$xKY*8NiXn)xQGDA4K+h}$D$d{z&eedN0}29?MBv~S z{OO_zLw}M#SSvxvRld2pMtvmAt;$+&qiA)xwTZY-)V{sA{Zl-FTV>W0Yhkm6N#3e| z5lUn7)Bi5;{A8}}MK5$6u1KErBd4b3Z$H=y4H|1SJ`tgH0IlMs3HdYCL?%O|OU*F^};b_%NcJf==SGrBUj!7!AxQfzW(z944 zmXt+E@%UXCRhs6VKK)4i@^jcDs*_&WSv}n!th|yP3{UTrWD(9p2G3tTkl?WN`2Yjx zDt-|Wo3s66N1lgebu_BT8Yg0w|Id^lfy0h1$K8g-OO3eq^T-h|XX{VT#S_1tzLGd} zIxtF~MzenA>7C@`leA0y&L5~5YIXtecGILEwK_^lHs3U(TM#_-xr~{ms7<5@f1vA0 z;ka_wXS&~QA!I->R3_|F@}yEzh4utZb$H!Y?>kfa+vaOJXFT@n2{drvvk+X?=|=|7 z9!BmCiT)0AF}(WVrk={9Q(O9XRLeBL@A}Lk-%|Kx{7lZ+7=hqlI4QBJ$9F6ob}sJ; zQifek99TEq`Dy_lNUD%$&xtYAS!<^{OWJrXh6pQz0?q9C$NE=;sNOQ50o3rpy6ByVo}6kaUN7>JFW>zPEQrbs>Y|k`#4}# z7PrEf=-?+im4pI}DOKRUuYV6Svg0jwVDl|z)^NdP=4KL&Drx^SjE?cr87Q2Q28L0< z*?1d4@)b80WXilhuo$QuAVcxA3PCOCK#r6tC@3H`qZRO}QP)Af%olPIJ+{;h4{nhND-@fOP zq#;X*#dHzFMhS++3`>$eks`dOlZjcMW&FP%6I&9XaQv%4V6`=j-fkoxr>BrQ@9QjJ`nD9gI$H_#OEJJ_y z5d*)R{C=L_J3LyQhpkq@Q=~w||1i^OJi&&E$Q{VxzJC<(-ZB)&>o*PBD=07`!sB|O zVpv45HZpjN{1KWjh8SMJsqQA^iR1+Hhm%lq|E=C=@ft8VK4yop6sikwm%NTr@F=|_ z-;q{E;G%1rzJuv?2pB10Jk8FR{3IcpBI+nE(H6B6Hn2v)*UncWkdR{W2ebKmQgk+{FM9|2J*J2Itbj;B?>MR*Wn-J?npm zc&a5XeHGSYuloH6nTLeyu6eJO=FYo0TBc?&gxBE%x{#`$8oIm;psDgcKgT6KTS?S^ zX#7qS0GkB#=%fnhsQO+5r$qK%jR+;%l?Mpl5$matC>gV)X4O5PB7+x*{+;yp#07z! zGz`U!*q^B@sT<&qbws5RYdBJlpb85-{8w$`P6tVaY@sg>gL|Ynz#u6bZZ-?{mesXo z6z_%8!usJ^xX+^6lCL@;p5ueg&?9ikn+DaI?E``Q)T7{#%fP_Ow&P!mp}VUtYraE> z^h|9;JfZ;TeCpB7Lo4p1hk8_?-p#a}rA)qz0h2{B6YsvjDfvIaSTxXcVhwk8{I%~w zQ(SsGcDo$j?iSY>_YBQD!ZgFSq`w*;q^#K^_G(8&Vn8maTWmezoYv~?&0M<`<%--CrfA&p`KNNTL=}EG}d|*Fp%e1Gf7@S zOG`cR<$-BDkd|J9nWJ4MxAIGyEUL-WCPO5Hi zY)kn0@hcNdH@tSIUhV9fg=UQ}c&l`@>{@e_e1_FZeLHpX1=1JvB%=^;VC9!_;35E# z6yN-+Oh5mbq<)pjFV-6=TNW4O{xY6a*@jj1s$E+ zc=u~=sz%_!3loYeSQVb$29_T(50CnW;EwU(+rRbiey0})Lfv0-1g7ded`v2t4JXT^ zZm0_PM?7U!sjThtWOx{w9oJ{``<>O1=n=}*nl(;c@Ys1UGCau(7|j?*n`EvE;v_)d zSs6Lj3>AYC;u1fr&syIa#1_2uKljQvGck~{Sh?1R=fL5iZ_l`37a8fV0)h>nj2&jv z5tV+|>?SUgEG})^b|o-*{~7#Y@tt)`RT)tTfq``1u}#y<$63Rt+f8krHN;9>g{0aW ztWAD|T(u`&@BKHfTt(08mp7`pNJn!&+gYn9U z*DKx~^SYp}&NvkenhZOa+r0?T|Ey*lZ4p9>=8{J$^8!835rnEwB#jXVo!sRiyCg2GTW$cSE~xl5kK7P#xnux(^=y^A9}Qhkoy$I|y!{Q{ZEoXtt9~ zZs>WWS)#tIL(zvG0Du5u-LT~I>Ewp2?mBVM*%C4GLTNaX1kTF~sv^}7U~vJ3yC!69 zSAOyW7@r7>AWk}JmO$anJ03XCLGlT|DDH)C)=j{{0Q8^LIH{2A2i;0T;C~lNb42G& zu{bE|dK?tjC%~MFWh45TuJNS^V$FO5-3tbe#DM`|*gqF0l>)iIEDY^?sujDW(TOV3^*JpVB_ou4>V)^7OW{EBnIqorF@c*{Z!TwX^e$Zr&tJNwk`RQSw;b#zHlxZBThnAQp|il9;8WIGg}Wa7S|U zg1`s>-L?(@)ncF=e^aadR0jwD+6j91-PuI32DkI<_dgsT1p!dBpTI$glE4p%Pdu>X z8=+0f2plg1t_nt$jY=Gp00|uUk66{`$@CTvt@c08Hs5zQ@7-f}amf5*EYLd-5T^qi znD9FslqCxr!dxF zijd}zZy%8OHFe+qQy+$f#gOVsW>x4Pp!&g#?Wg2BV*i@j?<><2jqk9C8ynr_zNa({ zJ#04r&cLwj>zRQC4BrB=9TyKI9#$^jE#JO7I14(}WmeDxY^=a5ouklhoo~RX4~EWS zet9cZ0u*&<#8u(;flTi$5&-|B6jzjpwJA{qg)l8 z?;-NKFP5WSFY_HzUD)WRGPK?1M)uT+u$2!I0_4@Gqlpyn?LP%^;Oz!%=1 z8cBK<9b*D-cWBcE6EO*VLRT5NqaT3r?^Fd0As@?pU*YceL^HvO#?TZe^sRtFcSr~L zmAu7fVhcOIVhQ&KBV*Ja=Z}JC*uPnHU@|fxJOtB?8@<#xMUjEn_>3F$;UybI(_k^H zvz_wf+o$Wk5(AOm#=cH#Li_#ST~0g~OiXASlUyo)iTbn{f#tg&xcXy!=DWfE@f#05 zsKbi5x;-0?1hsow1p%72RbaaXOmMeXOcn&a-~Xr%5csbt+3dzG8DZtBsKP;+ID*X| z#bnKoyyB{8b421lPyGwjXEJR7(0>gO90~u&W+A3=;i-){s9|b2Q*x-{SBsQk$IIbvzZYAw{6?bHKDQxI{0x?|6=Vg`S^Bn?M)|+A92i zH+e3Au0KI%(U(+!xz4e@3V+EBN49{u*0H_jpxu_N2=wsAKd*rR{;^!l$Q3M9BMwXg z2~|eMO8`$vKVqSoz(Ni>5i=s< zeDt&vOG6S0<7Xbw#d71$o5Y9OerDydMDw~wKO1z#4hFydn5PvlNY?7ozTCq5!+JlC zD+2@INEiY(qg|wOmsjXp&Lw=35gT-^BOYg-`9id7t6cbbS@Lf-?c2Lo$+_IZ%A9k3 zsf9iUxQ2v$BBfK+U$y;Q%3}{9z2fdaGPT~9-}$`i$-Y&LiLyCcjw>>}QMF{%pw-D{ zAV!SCkt=G*;F4C(K?2kPplNVe)(9-AA)kE*@j9oI>3u}>e$Jrr!R<3 zIlSx>HG8jIAS{?*8@Th5k? zV9t4;M?J)nz@62;GIFJ;S8Q&D0Y-+6%K+-ZeQM5-%uG_n7AF?K%pCd%N=gq8&*KJH z1;L3P${6akF;*3P2XHx;-WIZV$D&}`r1%8PR?%2 z-ST;9beg;0w4Uazs=IYPcz@I4UjZPY0JF!z90Xo|^JZ-!Sb0_`S)a+m5?`z4T~1D( z9PyWnr1sk;T2anWdHZz(XX`SpG#9AB<5`2(~V7hhy~Z*-hDVapU=CQt(*RS zRsIs9;g|rxT8mFEt$yg86eRO%VfFP>Yc=m(wBf8!Jf5I1o47e48LPTX1_Gf(bO6eo z2B@5P=P+53Jx#19ZOXV2RIxmN_Ro9)80&YPh+uOZNLd{hvp%|FkJ9ymcl@y=ob z=+A2Wua>($*?(_8zF7S*&aFMlTG%7gLsUH>UZpousYFUE*2ltXm7a6fy(2GNlz#Vi z;B#r)#ni$&-+7CX4t<^b>nKtGAzH;4MfT^5>@SMfI1R+5dvNwEo5N1UI_52}cpA#8 z^}Vl!wJi4*d8LVMZ$^GK(~PTT2GOCBpoq|%I{+dOYd;d`KJ)MH7ar@3izKDhVlyS? zbIFY*U*I8`cU=C|B=g$T_Uu!#uTW({gZrhcx9^iYouQXA+cU)wNv{@@!DHW2nuPPY zS`9LnprM^dg18H9{h4qVd8q;ai_*;dElPNDjfG!Y`N~GHCR?dy&1l(mn}X?V9LaoF z%FNJtZ-1p-vsbnV@|$x^pV;R=MHYSeoYy{IC1VW-Twtz5bUqUxM5ikRi4Oq^13|o5 zb^x^85bA4Xi#*w8ftU{&er}~2!vT03sUMs?1pzqZ+yMM%;4Zc_*dhEXa_AFfs(OuS zZO(fxs1n>jRPwUiQG0n=LTC945tnHhu1wv)^>yF|GZO+J|hmnR# z;B%?%H#mjIVnYe_bumLfYCkM#9kLp{S_Q%Q*ck-Q1|HnTSKGtBk=X>TbDrwj*w4<& zRq6W8p8otwFKCD+oOD^mSU)t>yQ3xtC^y&O1_CODr^WHNNBq5hJ;MH0kMBz~?Y7K2 z+5TRY8N#&$4M$?B$V%z(JB6Op^38WmOf-4F-`<{n)Ks1dnI9)?YPoi3U;8NV0R%(8 z+A9+&8>9yQ(T09ngHPT4b*H6nt zIA38ixR|=5Th2tWLz?yOsUBB9q-=4op;o8x`FMDX#F@{?dB^<8V*38_t@qb-#nk23 zAM3OZ4X;kj-tDzSis}BmJ&sbl^E@|9AH8u5+ai&Pft}vX)l}XMg4;e+NhGR(1WWn&4Uw8C1YRqe9-7Jv7W~hCF9fWV#bZz zL)#a_Ts(+SC;`g&Cm0~+o)j5CS>G%M@iNh{h&^`->Cg3zuRrnmi5uZ)@UX6h(Uw0| zm_DERbHjZLvF+4}eaKlcm0V+{t?H@ntkGhRh#((f^b*;ZNOm@}jk1X{gamOjMe!0I%rgyjC z`TD^#o4zsb>6(yC9P))vP0o*}oTAs-H;bGgluJUejo;D;Zy4LyLC`*~^p2rh)1~=r zWO;K=|F^`5ApJruaYjDh@SK+}V@v*Q9pk*l1)R&`-`wjkXTNowX56{m?6X-2vZ#xF;KO&kbxew82LMh;>AN6|3;F==!a60cR}?!^rOs(4`kU6_5tnqNtXH&Tyh#4pAC`TSF|7gItUgn26+ED>FfG)bu?c; zB%yVtFgjD^P;6j0nbS7@NMLh{wcpO`+1&+J@4Rm+Rr4tU|NSPB?U1D@Jc8Ql@SAQ( zR$X!uY+o*!O_hw?VZQXE5C4X{&8u$+#q|b zD|lRK9M_t6BL2X%bd^#K1pObC--iI*&t538dGmZ(8h^1kq^9l_AuX7PrtH%8SS!4+ z^w_kdmU!zWOE6zgG~)13Y1aL#1>|0Jx6mBFd*k&v7@mKyLLZ(!+`Ql^5-M>e^pF6b zx?xi29ko-x&Nso8m9F`W812cMv`A2${gPouWDs+^-0QCd*Y(Mh#6Z@Lc;`mx_gf2U zJF%jh&hq+;HA3q7o0YJZPGnif~b~e5^CJH-UCR|qDb94#I zbOVpW>egO*?AeHv?MGZZsXJsn%us3Z=rxw!w;!dG^htaoT07ieR%%OAR|3#%JNkU`_ETqs031*(cHD zX(Dz5;aAChPt=QNfsc-sOx<*kQs6Eta26~UZU4bduVV4inN-z1_dXGIh z07oQ)3wjV+t>CHc{{77|2X8+{+gCZ}9k0@gh@IuO=NSDdDfT&6?;Dzb>q|H6En5ev ziTGbndeUa^L{C(MU@+cl;tFz?=1%xz{p+|*d~7W2Nr(ThXt z@PvK$E&w*!@ll+)Ke6mXWd4NFiOt$<<$&DtR_4J`YtOwQ#Y{Jv?Sbb{1(D|18%()x zC;W*kIT3RBji{7NXS_%hTyqEy@Gl+WvEFK#7ltMa<#M z0_x?nTVrR^CDYF3XQ%o270W3_n0WaI-tSbPFtpU&$$&~KxQZ$yR|GIOw|U}c{SY7a zBv3pnm00iA-SdGfW&;!Bh9Bb(6C}+f24tn8^?yRM(^ybjp+GD>n@qiFjArqgI%bdK zV_h%83J5EvGVXc>2Rg(mci|lxW4526C+&&V7kJb2Q&pMvr}UMSJ?&zj_0ir^upbSe zpr6&oUGkuWAa*3Jl*nN%int$26OF4!YyTtlQm#Ads4c2Z$TP(H%l2}TC-Z=+y^CZt z%w)wNl9o-!=QQ&J`GmSbfRlcCh~y{^Fj_R$MQau+gL1d`b+Qu%j+z{~>K&!xvH3`d zZL93V`x74GI7E-hO-xs+RW9^Ttd^eUwQzQHibYTzJNNsr;o6Xx?ya_`7rNj$-wnPp zO}!VxKs?r>Sunj3ig=yjH53Lya)*JWeAlYPO|bLEX)%N(H=k{J@L7&0zPD^jM|tfc zl7mPBA1uYaCPJ!zh^%LQs+{Rx>ruCY1^N^Ep|<}h*&c;*{bf+u!@Kae+-$W%=yIZ< z1j98Ji&f7|(5PCL<1zp`G=kZ~vkXR6Z&Upr1O4w zB`n-7{AmRLo4@tOIpGS`x^Hs(Uq0j%_7hCLTsEnQhrreDd$uhqJRSMZ26yp+0EdN| zb7R3Vx-7K$DtL66S>(U2@I(ZjJC*#UWQzY=PC8Te-X-bp?3v3?Hjw0v3GEOs zvSXpMx=6L6G43|}PnuRJu6l&<@;t!d>D$x1uYBOxpTvZ`Zla2Nfl7P>VCW1}j%kKS^ zrj(u|N%ykMk*u@K5&55J@|=}=5rIj&uC~AmhesIJi2ih9%;uIkK7_X6Xm6%~vcG-w zB#-f9-~p_4-6&B;-9hhn6g)bvu5Pc$4Lr&EcGzA zx}jZ$%+{(0u>k{`+`U64==eMLzZHXYTx5xF15^i{#5NGWsd(Bi>mF`?`}A>)$g%k( zE^V*KRFc!Ga%A$s!I=%^mNLqqHr5RLEkBuoMt~pLxA%`*NXLT8VYX>zTpV-|YQ52W)x^7BixI z{T6veYCqy2kra_`Te}oh6Gnxh-urON6XQM+Fw%pmHYR`X(Hzk*My-4GM}M0qx=%V~ zUnf2{Yw~U(`5bYi+rHTTiN>DMO|~J}v!A$6v#O8Mu49pM$c`>?-a1=jRsDKtF7sZ3x*EC%$c-oFdj#OLzXB`=0EXB)aq< z!cx)sk51?*Lua2Nych%LuF>A($_=Mviyv{;)i4ZDj)!1hUHq@_c=>2j<()~#;J}z9 zb3)m(--7#_l|tVoH2ze*ueR>%7uD{W4kCM0Sc$XWmtlcu5jeb}RLGk#HhQkI$*0Qw zJ2LBr)YVtD_!H_KeO@#by$>=M9~1Yy^#~38oDI)jawUK7->2HjFL5Z6%#b&5pK{LW zzCFQQ_N|uK#1jZUQb6)%EE(YdP7&j6R9OAW^tnPnU?>)Xfcmri5Y+)l`3RPNbwV{j=^bvkn&4I#Ep&dx|X3`5lW`UgRmt->? zbfklXEy@)3lJTG;seWf9o_0g)2~|BN&PzZ;XBbX^r>(q_pYMz@)|5L#a+(q~^7)v| zV+aB^8vN2A9ZsyKdt|b8$0>T+)e8Qf48wnd0v-v~A|-z^O%S3ol(i|VaK)8b#A z-$noO%)cx?`F(-eyD>sW%c^PP7S7-4##-}^;;B<#+C%x+j{b~ung+NX=T{lkj|Z@C z>vSvAp^LCc97l{9dIuS{a`H;JMYS_^v(%>YGjU_)3KKPaP-X?fUk-yW|DY9=RnSPpcquFDe&RiTz$!&2nt0)cg5qIVtWc74S})s9@DcCp5LUw4c)dq` zGCSip*Yns+okw=a{Q^wvyn50Jze(+|rhd0iKi|nRuRp!-D zWM@0Ai@4$6>Zj6=yW1npTNHfP7fm~<&Y+F^Pkj)b($V>#$7X-Y^sf;qBnf}%Fd<)J zF@@2bg(TP18Ha)8)$`eJBTfZ$JQ`njKhM;f?nG7SM7$Z+w3|AqS?cU`w=LzefHowN zT-hh}K|n@LF+q%ZBu1qBpUod*Cr<+aL6OzXsQ>G-}PfG zlinv7#;oXoh(t@=h#y9Cr9bZkk)%_yyo~d16%v+h?-lMNJOpI-&Qe7HIE2F+j|Uc6 zU5oeTLuVHq#)8T6+{f&o$A2AaAo2h#2;oBsyc7eRGq}oaB@3)^4zCo*mA}6})qP`c zHlk$D?G-V)p22aV+N~lq362Xr(%o2LaN8p|yzCeL%Hd5=---Uar@YgbTuQ1(Bhz`{ z1qJ^#*Aw$z5DIG7j9W|SiG}5{gl}ScTsL9LZZR;Z@hYCQGpXvc=daW7Z7fzA^^lIA zti9jb7;{>Jc6`Z&9_X012H(>MV$EMt!J`GnXJA%HZA?VynJSca{`AGL`+h05mmH>i z2|7@+rGQI9R_>=nNZ`f2Tp!Po47`seF?K8}o_T-jwIu;0w}AAGf}3Z0%mU>U3xSuysnbXTe0-uqSY^Te zpI4+`Kmet8)aWvO#pSdCjUTXb9H2==AYRQn_|_)D{z8wvZ3LJVZj(v23u$ zQIdkMRV7okQGcYW^?hYC`ZKFZ@KFql*A6(sXAp3G%l7Mf4OA zpPO&vQo|>x>v!4lCYy7|&FAg?X>D}%JpIfwP=uZ|qPV8_@w06)o*+Lw3ZBipYLp*h z4&ae(xO2k=bz`7RCOSG5W+R6*WZGb({QWpCft$a-FTaTh#lXa`GMG}?)~?MSx2Ql* zHlwAp_~jLVio^#%3-W|W+`C%7BY4ld+zJDhj4?z?>&KrrlHFFQF5AoBaw+Bf@S)tx z4{KVzrVI1(@AD5r^>XZEotkPQmOL3I`&FN$7p@byFsK#yUq=Ts)Po-SYhxZSG(yLP zDBxj4z)$F`z@HY+M1Xu)`PcPn`3SR=pB5TI{i#V1d*A8%r0HtsuyA=#0DM{ zCL06YB`uoHukIg&5^z&OWMUt@S~obgw!=WkZcN{_CE=xGAwto``bmkEFfBP-F~nmk zOcyB4m&aN4Ec~w}Bq|dXT&9GR1-GF}Ool;Y=HG1AiLNebJ-pzNRINn}7$6i-6_06& zWkaB-sw z04+70WZ)s^EheuG#Ku}$z}SI4Ke(_5l&(10E05v8%5D&V%9wtD1u&*V5fqX-TyJQA zHcOF?Cn^1v{MAGJzFAkDtG7agc0Y@&cmx#B*0xXHOH&ALt3y0hAA_K<(I#`Dqr_H2b`pk(clSi6Tmr>uL=SlJevk&QD!Dd zrCFUB-|Oox#a3*Yy>F?aTBQwn%a1Amc!ebaz(C*oR|GFxx@!3wi*N>R0FLfN{lF4h`3g#aYJF6IeozS#sU`x=N zpl*kfh!x2!?3(s?PYf`u6Az~c0pgz zAqsWO82!24*^LReQzlwjrP6tG!W@+K)IKFZ@-z^PU4Uo1YQjvU;asQ(yGyvH^o(`9Hj)H z`;kyUGZ~67#YYuT0Kv!6ZE@yy)BxD7CjA`bU~H&f5^}nky-YzXc3gg=iubq`2U9|K z-ZM_mRR{^D0_Lh-R9~ylk)bNTXtNmEDBq4i+#3_y; zMFj~Dr`%O|{s-f?WeeC@*qL<&{>%IkF$Bn zgNJ~8*o9~X1AzxvM7YVBkQ+RcgpPSV9JPxt-JVtYi(84dpi9wO=m@aK6EOF{2PAR1 zTsj!j`}9%-yF*N*YSQP^B>h~f0J;Od)Wd5D+^W0^W8?aY%gpD6G82}Ja7>rJ>zssN z;I3<_fat~Uw@yu%H?Fh*2Y0{=7ktDEly;MYS+{iE#`k5}!pmz%cJ^c6apKyy3M zm{=!^*DV{ivw2d&*Q?^hh}E2x)5v_R&j-V3ypx;iIL<%ok_3GgEpO0g-T@(|0Jb3` z0JnUWdDn+C#wq#*>A8}&I7dU@qKlLm2^RPHEX=q#(`wfTEhk&EUmg}VrVCi`8wxF!#I|LuW-$#RQ^7`HJl6!#{V z5I`O7g5mNCd5J^haeYNaLf?Mlqb&I(_t70LG>S&wawssdX{|_0ZvF}YN2x|;hBoQZ zNMario?LA>BmUh0Lh$=qxnmsF?%U#VQ?Gdi!^W5vwSFEJB5sQD^( zs2}_h#;pWDdv}aRH-ltorh;lFTTN{0`HpFZNA-a{hdl2>1q3eobt>AfW`Xua7p+~v zdZVOm%Wa+JakPj7t>>!#pVJxc5~d$>->yXXsL8C*val8cmVj^~dO3U`+X*C_zxH+= zw}lIa1XcK$L_)_m+M8pq_k2x94s=jRO{RAOC!bt94$?visaHUYFIi$JRv>>;1?6Xt zhpUy4JrWIdI-Km*ji4Ei5o4>#Qi9+bbe?)^!fo>U_tJ^X#^_EZegJG$k!M`DR zxjx8>O8bCCVb;a*g@7>_^;QM_#r2bwjGI&%ew$|lLu)-c!lde$L?3R_{HzRNPB~^M)^V~Hv_o15EZg)pAR(->oS@E+86`Tf?NYzdUzu`&l&04hiL((vy!}Z9e7=z)if4DQ3Qfq01;Dq zV0H&O(p`R2{8=WY+TVD%W4I}~C2V>011*cNk6*9=%BdKva1cE2jXCmUuLw%c6sqCM z2DEMDV0ClQqB{0J@|gMh0{D4?wMeGB}k*D}Fo zls@Wa%g|Tfep%%B&!4t@ffKLi11WBIU-c>~pLF_BkWoMZ8Vr@;k&yg?mx%1cTO(>b z7JLYeU!w{m|F>MF$8GZ_r!4kJ^vC1H4q1`p(qFPpj1sG#~gytn6o}cET!$b3$H4_Da(jm$r$dVsQ1>f97b09%PYDV0F7CQNX{n1F$_>%k9FUluIij zeAZW#s?U?^$f{gF)yi;;6P=-bBpSDe5P5On6c2{iUiRBPvYace(wtuPPu1JGzhE+d zBup1&GC*r}cs}PdV~V+E-v;5Wkx9W~?*sGv^vkR_tz1LJ^>iI{hd*WL$DXAa{@Lvn zAfqMsQ&pG($mR&U83&R9cJt!kR{WWqz17TEiDj&S00BB%tbqmwBw<&`Yt3Wo^r8R9 z)prL{_5c5$J6x`Lt!$2+%w*4NgtDSCk`-xK*_%s*tQ(>zBn=@eWJ}4F?Ch11z4!Jz zs`uyne*exNMV;4p?&s@uUa!aVT&V^CNO1t{ha;Mk;ggYoL{jg&xIs5k&#L-zE5`yR z=XD-Y_zVzwY3hp@qlBELBcI`JC*SvuMYjup?cQw!7I^ZckrM_2=>0T5IadDb`U@lH z;v1C!oUM|O*9bgo|^c01BS7|(X9Zo z^H#tYCWx88W1*Bz>)lcPG&^nO_HTmpIJtMK#(DxFe6`SDL zCaCZoI4cFu%_Un zKmoG0eCkVu%hqr8T-to?tq=WWzN<85A8#A;lAd?sq{2MBy`;>}&IW)_GK^8#k+Ucq z2@ERn0bVavPakx<;`=iyB*{x?h7LM0a>h)`NSraF^?m!TpM#!@l%d|<5&y(V2>IlC z)BzQcWon96<$>WbFZ##&+P#Av>^ChPPt{|I4!Bo>K+%|QdJW&@wgN)jvP5gN6ep5E zmsjGsmtVO|@1tb!^6;YezWe;)Q}kqc)L%nd>~+4%GVCVS#A-pg&fCBt}^fhZv2EcVGG-@@vPfwT%sXEp*_j!i1Pm#&GHPz|xHrREsV z%`jbfB@T-1yPK}9_sNrC2B&bBwcc14#A#+qDN^tlx8|pxQ}N%Kp#;=N zZ3qzdg-I^b=uSPdI_NBo$%Wkk`YP4?$I~YB#h-Lf=FkK=bzWfs~E55-CC)v<~ zQpEx@R)#>x6`rk$pZ(>tZG`>H13G9SB*taVVDbZIOW8kVY!(%)ANc*i( ze%yn_<#CS}Q)&5R?t8b#o3z}lU9;^s&rdlv3a|rAtQFfb#58sd-|q0X6)*4JDqnV> zS$TF^ti&j#r2WC6+V+j%+M2f+-C;AF#EWxJX?f4g3sRg(phsX|$6|w0B;TkNi2+6N z_5Ox{p$MZ$%#dYay<#}E+(37QX(3}RQ-FDvoA(7~uVW+TAJMf_u*bG61~h3e$Qmz5 zp;Y>&B;{8SKJNS2y!KNoQ3dJ0R>61 z_UW2OFX5`QZnO$Y;`8}*IFcw|03Uy8KTD4o*wwQJZ2cpjW)oB4b*?V-XQz0^g7?om z=_rPcUawY4);;58c04s7U%e}bO|ts<-c3a+r{CXh=ooV7OV+qAF#IFPecgiN=sp3n zpV^PCNBqe+U)gLm-X+Ltd%q z)s>9Cj`7i!{9BcnbxD{lrM^31jqoc)2C+~UheBM@izaU9lxf#!w|}~seO~q z{mE5B@;aHbPqRajMofE+JHb}sTE^_CNx5`G>tYroKqtzbJz9nK<0fd=cf`(SO6RoK zUmolsZd0YspG?9Rd5S`QyS>x>CAp04MmoxQ3Y<0Yp zIE8&1*y#)Trs&Gx^g$xQt)rjlR_!vY8K)nV3Khit3vsRTymZbvc)Pa%!GNz}zi^$N z+Fjr9tG!c}N#fKGm zVC9+YsO%#q8QV||E(;YpnK8Ps*7LAtFXqoK3qGG$(mbs5WG(s*PS3vqMlMxpegN3t z52vl0TJ}86>nXZRnT?Dj z2(^A{n>!1jG`BJll2a7QJz1Mw?@s0TjHb)9b|+taEPm#;6(_?OBf!=1ggxG1OM+!B z7pAMwuWPB2BIwELugvxM(?dI*AF{&1i`YQg_u1p_u2-anta;|EtXZ9DxtijCu}%&V zzQH}S7<6qA7IDTRk9^bdQJ+7=D80!YNw2n@zp;R_aHJ{sJ+Gzbt{M`x}*4r9H>d%w7B)RvqomA03r$9LpPPs%=5==wkQAF(tn9xd^G&Bc3R=Q5t^>1>(Z7tMF;T35aE%nvxq2xX{7m4h zFrD_{e-dVq{ot$|JSr0*!uYI>e1VKquwv|Vd*+>suasY?lhs*Y+8eZ$WPO`&e6HT? zH1fkwMiDv(x;xn})nOs{aobvP6|uvqTS|@g!-Ap_Y&NwQNuHqPHUdmAF@vL@j6>RN z-m{H#*}TyRx0(E)wurr)(88;fE}Y8KQ2t=ntC`qZsHyF)QMsbjcJ*NCnjcS^jHVTN z^dkMk+^Abx38z%LrQa9(oLe~;=}4Gn_cKwljzwsDcZbYbbCT}fy`<3n;?wmGeG{`* z^bBkUKBJNhPQ!q^{-RQ&nJ=e~YHdX5Lcg=2!$oia-S)A6`{8ps(rPq+SV&MS&mF^3 z&82Mqdbwvzt)^~mz2})()`~2S?dKc)t|i75bIBR~EVUIk^zgjkP)z|8`8k4Gb}dC> zZ`Q*}-Rk=|d??Z;u5cV4M)In@;ePO9Yv=@J3`%<@j{D?CG1>3LqQlh-R6*NNx-(Dl z!m27(rw`q%!>|JTmkcuLpN66MuGl`{ka(%D0%~hrdX!y0AH+>YyPyWrJPK1s8_<-$ zFD`bwWn_FyZ#k~=)~3bONcn`r()TTe6*2jsrKjg^8Esc@%eL)D^gfKmED=WCW!%?7 z5s#5D+jiAT*#`sPInH@+6e!zev0W)xq`ek5?tNY&BPqmMSj-F6IQFh!d%wSzg}MwK zJM(jb%7?9-l`lmhLK`vd{6xB^!)ddPGDpC&sk96ygufeM@T&ao@?DPn+e05XDizKd(UXk zPICJ7<2~v6ZCi@Ik0tqyKIDO3q0{$l@7e3EP+V1Qr@j~)R_i5wPD)bdP~y2UAb(dXGZfBK8@UejaIh#Tk7V859a?=9SqWgvKh4}tVu zRinhH-~lcY-B1&(SHB*k-jjrJ?&RXYFOvZng_hPcLzI0rQHt`c3=8CRydcNTa|qpzgfSFxDn>5KhOi%d zF0^MZQuBk)bSU~74#|{RZ!JZxTQ@QYlcS_+m)Cl3oN?w)-=(m>GfY>`=w$PRaPNCZ zY19@;xpA7?GbMXewAdDOT~k1OI5>hEje=o z)CzGdp}7e)4c06o>d8mF#*ezjM~~0oDt|q(5&0Bc9V;oyrZ~FlP{d=GDq0uBnd%c3|P+<^}kN` z#nm1km`iWroAKUf`=QOb+#fdm)oXBE?eK<{w-xvLUARRvL`#g-e^( z=0=K6>DymlnLRbd>a~2u+*rwNcFdh>5Z-Or0{Z)IIljr zTCDIOo;Lq* z_FDtkQ#0@CWZ8aL{`@%CDxhD%Zat-KTb~b{hR)f$21eYNm&LyR$_8$df_WSvX~Qt_ zvkfq~^BP<$h8)jyl@(lc#hpk&g;DoP2#&0qZvJZ*bnbhZL^Y1kZ3SdMngxVe8lD*86zj= z42F`x@KS?QI&;9~g3V84!GtTNp|dLoe)W;rrVu5mdMLy>IZB3!a+5fDYBzqQ*RXRx1H)!0Cm%j+SLF1&ueMg0nM#ih9hJ|!~y z&ux3fWOEoPPyZ)V5}p38T~y(LNlwE*f+Bh3n+sGSqyCiq*e4{FcN-tc(E?($;f z>_ap z`ANnhCj>Ou*}P&M>t;*vzFz;tBTSdST;Lv5eht5hMQIJe41X~)?vrok-{;8bQJBA$ z@U`*wfuHlUU(D+|ht*9=={t;@`3cu7BB7HCbt%s~;r10&Dsi&dIVu%r2wXnY&N-Nf zzn+;1Ot8L)B5Xh;^#7xGRFoLsnJvZQ)8v*x4mI;;6(*3!#UNGS5vL#aCb__DH(h(} zKg}tPTF?B505Uyj&Ko%B!Y1E;=bV{^`nwyJA zzMLrbZAaMThGlFIyn1~}td*zz8ax6L5C~JJYdA}by&ZghXXmMGm-#ZHc&I0zczoctsTdP;Hnyah6z&n!5qk^8r16&U? z`#LG{8<>p<1Wz83kuQnwV0UPS8w&&Wt1ek?E)#fxbLM}XV&ZxHsgs`dO6>jrQ9!SH z=KgtOfm6}JIf?LT5%V9%FsO8d@C*=121>GlF0iaXVy(d)H(cFMSk?5K^o##w}zw7PBl~- z5DRc#h^NDL0^+u?wLUYPPBD?z6Jcz#`~CiZd>>37$oR)d*t7)(1;t`7}>~ZKwX=06;gHPpveOU^?w{4&hejRz-WmRb*= zRH6c{4@vf%M*t=YQ{1F9c8&}`iO%g+)VFf{3v%!m8DJ8+l@1Y0JOrSfA3%gjKU7u@ zNmC5Isu&Vz1?!Xvq5L=XZbbM!T9YOUd;$YF)(y3(+;RCzM2Lbg1O7FcKwDTR9Rujq z>xZna0m^kxfn&C}Ae2+UbkP)7)u7xAKbZpnU7Uts6-dE-XPm#gGG_< zPzj^qgW3A8YPS1vl-@&D?{jt%5!8wRQ~7^Q$8ur#(?wMSIt}Z47;`R+YX)elj-XF3 zjT9YF*!~&9>R7qT&_khu) zJNkXJ1e%ONs#+voL^ec87q0aSMd+b5`HkuDSC#_G!6n*hb#n}0b3FxqHYU9;<=_>6 z!5WcPAj0+(pEP!454ZvQkGkZ*39tQ;inTEDJT{elVtfxZtBU?9aF=?cVHVD#98xp7 z{9mL732AH%RqbX?3Xv8K)+jckQCa4I#Fqm*z&#UH54WYYjOU*D_nfkYuxs2iEpQ$m z`1}Tm?-S9JUssu(SrSKPA)NB`qUPeN~fs?kc#E7cvcmvd|$Y|cn^_QvM?5<6kM`} zJkj<4>ELgZD!P3NEOvm=*pcDyMQgSXZffo@TDTx=12>R8Yd_DJ;vfJDG}H=0%J|FG zaz?Baq)|$^DvNT!N6rhuqjL&;42YN818CwAz^A+b@G1MRowUSeOq1b#0W?RWA0mq# zTd{I`Z|yn>xIRg;H|_G*s&=fG1FzALyp$omA4MRgq1n6t1j8w?d2@K@yjky112)E| z`uimT1!77fr>vy#{iAgxxq=#{&w!Gd$_Een<2{aCX=Tt+7CbYb(U_3&Q&2LiR z3#tL1zOw&;av(ABCrBsWur)+bgb34u|20ymMO|pPp1;ap7TAk~E4ax#$dzD?K4f3^N)Egr(9)&IH zjRQCjhe|EPC5ZmA!MuMvY~}vSvd5vBr=#mZ^V8Hwv_L2?b?55MfLaZF0BxSe!5-@bUNYOk2iY;8NfJ=_HAN(@h9$?0HB{;C7nUD-7-1@@h{$Hxx(V( zGK{6L@zfh)?GfXf zTc|heAnT0!S(>RUlC|4+_56rh?2 zcB+MlAW;dRi^=dSbdc@M$K7LPFNBE?dc)^mua~+#g%s~EO3gpfi4mI?e`0$=u~mTV zXbI$Z8BT0(uN$D@V*wwN;d2lSpf!(R|ZP67$0Dzkwo06ES1|YTrkY(Jr^ugpGAZW z(5$YJTMV>w^TL*87H!zFuxEa3@w~cpZInv+>4T7v(1rmBq3Xo;wcY@>Z)i>A9dOab z$F1nxCGHspPkY=K?ipr?FeD_Yzwh-@Z$N+@8PpqV6!?lmY6)zS@i>Ywh0ih+z&^W$KIEfmEPb9vFU_FY^ z4P7AkOd{9L2{Z+{N}kvl5M^VN^*+!nB%DghE;qtTnJUcMHMew`V7C5;!n8k`pkXa45pq-Gk>i;jZuN0^&_a zzi3Tf);Qo6=q0e36!<%(5b%(m)g2sA2}$I&C`avUeGa8*u`E(7be#|YNU+G0BuAs& zj2Y}e5wdO~c;s6>(b%E@4wX0-aFt~5lO2Kwvb45oI3^>^>nc!mJ?+)6`QnY0B`!tt zDy^JuIcPFifa@fIW35AJZJI6jK!#(7RAk03D}`7PgODX5xM%9psj!ejc2y5jb&gM( zUd!tha0^`W_!lLeKqO?X6!;yaQ7JoCltZPhr(X?&+kkA>2Vu+XfJ>CX#!6ywMZo0I zbIsYNiRn8fJ^x|_aXZkzh3v7$;1Z>y+35=ds>Z?_9;;5)qB|WJ&&lZ|lYgeJjQ2Ib=^Aiom7N1(^0j z@d$)k{Uyp5GF<5JG(RAF9gQu`n}3KRXfyu~zf;l(yqyVxXB5bG#PRSKY&D<=ng^%; zJ4NaAx`A}r;1cEn7>ypv38xT!2Qhh8KKSankda|PK;Mc9imCq^4n+i3>sf8~0Z$)n zD+EhIfyJ~IrKJ?|{=c-4vz<_W45?jJA#4rOlzN{Y2$>j5DFtOtzg_b0WFF502xzn? z0F!whgB9iNfNAI(3j6}HCx!xVmk85Zy(Os8u21zy3Tu&oBD^02T%gE^gJ{PB_0C&M zZ%QJ?9@fhsuSJ|j4xA_JRE`q4JNw2XL3GTJAro_H<=m63h8SV#2f z?yK$l{j|1we)YlU@^C1x#_l2T>4z}FosU!K+?6~0kS8pmzE`&ls8DJYpc(O4Ytd);Cf0H0To4fgmU8~m6EOt|-%zd%E+ALxH~8)wS`R$7mu zw4{NK|H?~BAtcQirvr(t-sPhnKtmY-DIsnW5>F+hN7Ng$?q~kn;2Q;gt9GQhmIZtR zu?n`~q1oPi((l<2N(ZGslTkkbFxw?CgS#ZYHL!Rn$4IxOz>A@=5DA2Df zg}uuR-eLx^=D^xi_n_U@(Zn(;f)o-44*1gno(0TFtCQ1#;|EZLoiWHr_5fSM=nO9? zeAAjVoS5t-4&3$DT8U+gwiK#j{g##()c>`=gFK8w5e%qtxvp?QA!re0EP>TfbHq7x zr`Nr6#{G!RkPjyM;WCT@*LRB|sfGrfl?S$?rslgn5Rgb=5hpzDB=PM8`Ym5UxiJO) z9*%p)hb+q>2r|v9(%3CI7-7BVbI*h=V)8lwzk&qQlUs%t187AUk{top?%#Ux+wu8d zff1sXP+Izc>!p6+DWpklD6J>yb>9&9j-dZptloil6Ukm76i)&XlOjs4W(-keC%XBU z9S}L`QrL&ICWukMR2g6je?Hd?ZPwU|GN~xfqCjS_?jcM|0$Vdmh7BzAA{L}jgDQ7& zUg9jq5m9HIQh)gH$bs+BpfN?>Pl50&>;uihK*1fbIGQxvjp~16_;AAr8zKixjfI=Y zo)@et`OM({10YKuj=vWL(+Y&!-$d9dGxbp5`B}iaFa(C;#3lXV)S4$Vcp0EM{`GYn zX+(o#<%cTJ;yEd>^;;;d?PQo%*?U;LGw#E0(Y?8gm=sJS0{bpy6#SujKY zh+NnjUIJ^;jEXo}ULql~|D*;4e_&0K16LJhuV)o@6`dSfyu!fWQfV zv48Tb-|M=`Z%{gfB8U~kXtu^u0G^>e2$l|Lg8Xq31wM&-V|`cX|4emK)NguyK%MTq zHOX5#X`;%R%q!|y88gbMLF(59BIN0Rgx$zXE&ZW)*)hiPhMD07xwdjb-HH~~_NuBl zVf&M{-9XcUcY+?@vk^ax>f7!!%|y1iXpI+xZvjqZbrK1-jY1_(5SxM`;hX^&L5Lqf zyDDN5jzDsTVpLBXf9>w(ArHT=fXLFy13EZoiKynMlr=*Ri^Tr$XLSV1kGU z4++5P6`VpQ90?#!xC%^J;jUah`QbL~h!p?hl!;duY&;Jz-8(*m)q$4mMJYuE0q}{2!Ew-iI_QDl#QAriB4!s36rx2m$5v)!HqJcewJbmRzf&!D zZu&2Hxr;KNH`T&nH8&*{PDLYS*AD&j&}T_;NG7AHN}a-W_FOe4k1OL=o4 z583I#f984)F*#a1wj$)+EiwqO_=hm{!6iW3?O;-}%Kq9Rn zc+MdcH~?h7$s|ge^$dX(ol$M)kf6Z)Pn2L53%E}_mKDUj*H~LWHP!nKkcCvml<0=# zduWSuxzV6+ShT*iX0|TJHy{*4dac2~?6JSHpu%9}bVJP#&nTj2UWJ5t!LOHu?O(;I zS*NUSk(IX{tO~h~*2*@5NyT5>zDf?{ePFm5MDn;>?sfa3XSHxaPb%k(0i=ze0aF@O zM0N}+!YTN%DXi#5iXp5>0}3i9aRmUr$1W}ox6cPqr7Jl+U}&=lE6X1ZOFs;>#cB0d zln8`iR7p5Pr{2%`9Elp#^3l4NHGHdH@c*h>sV*Pcg) zglgn{v-<8JHb6vu6MxGByep|c&G|r&xLUT0>83_d(9Stg8SZtNZ$BFXECHM>F<2ew zyEkbn36w7#vw|1mtMp)6>+~kYUO4xn_3ObUA9!b0ky_V7oS+Rt9K@rH7UZAMi6kh) z2*X>npbL8M>Kripg%<4hhV#q-K5r3!Ud5i|2~8l7os`iCBOKlVTw9TZYp;;iEJWZr zJzTDkD+FH)xAn!WA_*;4@JSU9_!m;4|8t2vZ60ecX>i~Dh>S{4;cVq~`LSy^75z+} z(3|w5U|Rep!QGA++z=%nRw}pdU#WM|Drv4}jFD9XOlzCQ$SP0hA~E4^GbO%c;RAx_ zTJX)kl>C_V&(Eu% zeJ3dKP8giKoq$T4UUB$&VHHb9Sy<62cbvpipkM573M^(16eU|MZ+BK6oxLDZec1W( zW#HT<<>lp{ahvm-`*UUU+qJR^XVQE788ZrCNio<4kP~%jg3O%lYb!z$q5od8reHaS`D*e6c^tlyA|#|*A zz{-C4OIyO)==+7+VtVOHfqL>cKUS6mWp{WF}qD-dHGSEh4Op} zGXLyOg>1T?|N91b4ga{?L*Z-B)N+bRM#vh5f-G-D{jBzoRZi}!pN<|~c)qNC*?_T8 z;n?2HI=R%qykS{5?xqa2!EX1((Yf(o|50I z#;qdQ+)_~9L0T=c90$E3d`@|9%Ul#%i1B;SZu9}GyjWM-FP3n@p0`PL71X@gDn;yT zGL+UZWvLeK2~0fhe_@6}8tYlQU2iZg<4zeHGAmZ|y^Ksw=uEBd+XU^QQN`E$&c04Z zva^S?Z}(-{dtIVMv!*7L?b6nBrZJYUm-D9!$ID4+rd3tq{I>Jmc&bfF>iOvZZx@4uOl;Rs2xI>g@7_!3@v#$I6rA?{pv!Ejj?sfAbjf zz4XjE^Dlbmi2z*Ti&0UBslipp7v6_)I|69nYuwKE+N)Q*=dii?o>$-yB(&3cH2xYI zk;O%h={n5}Rv?XTz_UE{;8}W97yvpp3q6blFjvo0CqG#YQQ#ZxaNi$`W8L9ju3SY$ zG(7^IGQNh1Ke`0h-Z;?)s8~V&TVg`M;8y_lN6CP2*xFe=9P$Xke9}cU1!kW@Q6Hzy zTVQu=0M8Ne#mQ(}Jw4zp(8wUxGK6ROTEMez9Ht*nGmFT`o+ zxz2`wl&*Ock#&O^x=A>z+ulVBR-ok|^!Gn={)mGW?Q`3v4~#8FX_)wJ2Sb1m&|@qO zqhSHh#Uiyls!}rc{cu+xIvqcIn)V1Lx%z;3zKVqD>~ z7^PZWQhP%16c`pSMJ#)Vkbc@56v?15zC?FrsDbUukjp0umro(%u`Zt--+5T3`ChhQ ze6S+Ukx9Ag^{H9MZYtGzMQCWK?awj-NrFxDL?*Qk0u&fUjhj?1;&5&L2hiI87Sf17 z1g4<~#QKQIbKC`gc3u?3f!*+v%>O5SOx+$$7l}|1K;!#>+QfPMCb3pMw->IeYjpwG zO+Z1LC{Rj>OQyn#h=>TWQVy=J79KXQxkLZP;RTf&Al4%E0v$d&Kql?7cKaa(=9naR zl#2x{6oRTgEki-{_XdY|2(*!PG~%B1;>D-VuCBb?-0wAkhj-P~)I9zC?DciGsRAjE zC87D`TePDHjWfJ6HPj}`Lp1LCJJjB2Uv~tLIAD#I`!kmvGVB>aK}T!rPwK+>A3v^` znVO!R{`s@6w6t_#Z*PEAadc#)ba>cYURhbXV**-7v$3-ew6@01`eb!=UEbeX9P`pR zC~a=mhQ5p!6&Ih23WOm1w{^FbWM$7Xd>a}b?jIRRn;r3`JlP8wHw|Imr^Ms=fmKN? z&3G|voJxg;{bUoX8o^@)v6SM3Mo1I%8E`UJuU;+v@WD1V1r)(Bv9p)1t+{q}Ow+lZ zK6smxQ#>$mO;ALnw5CQWVQI-pP(Yv%icEq+LLX96nBBNbrlzNL^JgobJ!4HxOOrBa zk55j%wX`3fkl^U!(?3+Lt*xz_KYv7eDXXNU`&~|s?lx3_^h&#`JT!O#a#$HYANLmE zxrgBSNs=q=G77lxV*#3n*F)IL5tDx01-Ji^#4aiVjv_*{u(0$D4%*)hol%rj5I=WL zmjct&+FDv(E^B6KSq7CVb#tU3!Z;-+g^+8eKYjjOvP6N-_oGo{jkK_E%a4P;p&^Md z_Pg#8OQW5gH!5o1yQoCl2kGeQni?29D)*ZkXlOVO?L3HSSOt{9#*;GqJaI_2;LXeA z6!?e*&OkWkc__$T5F(8|&~8UVVmh32-lveHti z`Q>HlMPepKMltg@n$^;Ba_@NOL;#&1d6`^r6+b46` zYodhCd!{&Z+nq{MNrF^cPEKxvBf#F-xhyS>z4_ZWLqdHlH0;U%0uMmQt@7CGBx@1W zCcf;w+y#NLcX7yJ*qRa-uzPr{Tv`TO3p>%|le}mh3DVQkmsV8V&0M`|Zf?%UeEF4? zdJIJvJt^mh9JQeuOm#jg^7Pv$Po9Wr=EWBlp6%LXHhrbY9y`D`cCU}lbw;j4edulO z>(_j4F;vw`;^H@;8lA6Qu8}HU2Qy!ezT!heqX<%Bk6d99x6pgxj4a>_6HnX>(mdon z?Nfs)Ed3?V)~{s+7xLa^nr6hrLk zdzZi$pz4bUw^@yxoZioRl$`sqaH-%$02>n%(`$|JLBUL^h$Y!`=WIx^>dQH@Vsv{T0;B-#@Q9Q z3)}0xu?N3Us$AEJ!TamYJfr}QX2X@J$E_9_AO{n&g3is{XMjx>?TsH1GaYlFAt{S_|lY%7&uVi zPOQa-^LK&~?xXSM`N(RBP^k7p>Qy4pjSuSzP0Si7a;60@wyT^_m`--W!8V8|L_J5+ z##X-^-ss@Si^IEf>%K9aFrD7SoD2)Kn!W*_%%L|qvA5r>nV~ls)yS)Rhrl}p)0?E0 zxZ@OB7J&X=bZnq#93S=?darHcA^<hB*?^zJK62@;VhB;OUE&u#vwNEJ;vV|}Y9YJG6~5C)X+VUwD9XF5o8vjtT|!#GMV zwl_nS0Dvr4bOrkFa4;Z46`)DXfa+${)0?OOG*B6qR9P5JIJlTX3$Fj7#Gj!B|Ct*M zu*&6~@wyLWbt1Jk=}laAIzCY1w@9GRd{;u0e!yHCNOP^=e}#TR&b>u?lkJBz8ySeK zCDL3^4DP#xFmR_ADvO|lyCSH>XN%@<#R`9IIHHn>gGKaUDfKXd_+xqeBfb)b0Lw=dN#ctP7LUqrMB;B;? z%<5Wjh?##-(fYc(uWyQ;USO6}nU~9m?yXz5r1t`CO_O}9E#@p(4+E8nzS85aSO(MU zExpmjb<*ktEt~|HS z)Oo{+;p6$t%QFFcS{>RnFRQq{Lk2e*LCQF32_1W&Wn}j4qElMX%@YfTlo72#D=`1iO)W~ zCE)hTk0;LHduq%*JvU`4wWYjfYJ`19Z%48EXu7SLc63yN-f*t`p`ugh>5&HI9d=ua zn@p9|F+R@A6!Yc2!sVqim7^0cf;*NwHdOp(oP&;m^~cxuO?&wmmzG&^C0SCW3jy1G zN5R#{7g@Ge#?+MeOf;M98x*T1)<4U&Hpn#d@mjvo|3IJm-jh#jmO)hcv)|p99582) z@8idpzsi;;@rV8+xWl_0xBwF|t6B>MD-K)A!1M~+_9GXK+U_#)SDhsv4{te-RQWW2 z>$$?{N#~v>I~}6+(tP3Q{$pbY@C?sY*yPU_c7hf~Ll}hurhtGr@*0s^t4K*U83{eO z))t+K4YW@$(io~6EcuBWn@MNF3FiSp67Vm}VX$%rERPrtDi=ODyQPQlU0fQjgm!lI z_fXYJb~krh|Ixm07mX$^N>L64oHt!dq@Yu`jLhvKL zc%*(y&!Up?_6TW>?xCDtY4hCtw#hU9uc=!!=yY&>u3Mr_Qt&9Xw79e_G3N5CTFF`Veg#d=z#CQ#i2^y^`yK~ zYnu`_C#CU8OG{Em?b4JI+?(OEMZH7uYq3qi)TJRAno;Y-cia~FSKyZF-jhc zWvh%SgbKTTyz~9@V?o6Vef1CQioOaZiB>6ohC7MI4n?J1Yqqm1g@|#Cu zpB6J*vo{Op-EWayXE?Qc>pioK`%c8-K(%OKTp1TU)FXURm-OqlU;fDwgI4C;0VC_uTwn4rU5# z@Syfl1}<8dM?VTORf`W-}5Aei&z5jvTyOeL4YFBxPaor0#@!BtDF%@^7&ee7` zO~1@?R5mg(*^)Jn|7+0Jvt9i6j%yihQKuLpt>TbW18m2Bivt&_^(rh{u^R}a?4oVn zXpLKAMP=>HpxE0~cdGfPCnCu1`EkzE`X$d_uN`5jO|l5;?(^M8G1We!j{WdxGq%NQ zS&Y)dqcT1-5y|pgIo>a8q$jqu_`xMaMTLmT$oP%>RauMEqW(6<;&9kRrPWxk$Xzz5 zR-)fd+Ji&XBcJJ3bA+Oz@#0H?bKqr8Sr5_lvWZfAV>SQQPL}xq;)UeewAUmcgHuiw zl{Pu}QTEN0#f+e^ll^XhwMF6Ku3yk{TSOE}$|1M#6>rWcGb~g#d$hc9d#ob*$<;gG z=LItYG#p9NJQUVvl%*a^u3jVY?>FwR-mFQt9lgncnX52I!cwK2JznGl{Mf%xPZhx6 zda7f3n92K~KECm1Lb5Uk)hkcSJWH-}x-gX=0;L3Q#iQH6>P-6!yTP*jNOu#Z-swgK zRE6k%^~(tz1vu}+*F+IJ`&-ft%gN1LGZ$c!{4`ja^X>GowOfT;GYLg#@MSc#7>^Xj z*~S4rUUbwT^p57!d#T&1)EhYHXgczrr|O6VqxH>Z3HF>PKH>o$fOiaay8gKE*|F4b zd*rkuvbQdw$f;4Js%H4*$1oBqYFYIp{P6%f{1kVmZB)9bzM0`=s3e%X{t@?*K%Tn_ zgUEIF{O{|Y1J#c?>32tyZIVZm+nk1tZebG2VeCDl@@Eb0F2r-3g-#x^rapJCw_&|; z-(5DkvBj*694oGdv|PKLytg-8YCB7sGi*U65HI(r`H<6-QS*`DP&f%P(>Ma!iHu;M zdT`b#edXSi+hFNpK}yOZ>H^P-yv_G{Kjtl_!~3kr4ST;~J@s=-k7?`aLi|meE}|Jm z^1IY03)t^yP7a&R=2x?ZGiX>wKIk{9yuYQ{%Q@|5)AcFYKHoRBq@<)+ycZaM{?bWbvmIdU6P>R!#t58YZZq*;u06{y?%Lm zp}#mTf@$jUs=;v=9lb^D`lru)V#eQJ8ZJ;%*B=xF$(iFahHnk;rx2(ko%sF9^=M|f z_gyMz{W3Pwu9>w}1aQV9Fk=nZ^h5Todp&m^A=UZ!vGpRJ?~3jg8`xv(UN4OXfxCzxAuK2?%+H&IBIv=U+bpZm=|g#MTvYp?468Tl&*a~W;5WJ z(bLQPh}*dcP)*(Ze&)=X21=`K48}XQK(vT7R2>CM3{?cA+FKjbNxpW&ka;_sJhE8k zZBS~ZEs8k0;BtBE%krM`57-1==*gFq6`kHg#Qb;tuB5;?FGOeR8 z^X#VOv=%-jRXfB}YbgJH_AA};(;-SJbSBF2fH?FQD~+R@Pe7Fqp zvwfyq*dxBII?{hT#JU|chzBqMm?FFn=7KjhH#|ZDyMt3`h@#1)6~7ij#6_HSCW{s+ zHko5MF4QXez>4!~xSws(HJ@FS7E~Rp>Mf@iczg9n7;7wHakS+LqJs=g`83#AM4i`h zT|#7$tHdy0k#qdi82pA#C~1g(;3q?MCg;y=W`(XXV^66l}IBvgCU^wiYl zE|fpmg$^hj(wPJ*S3TQQ#1)z+8k6`eZC6>5G0>0qN6Y*iWf18Xip#|95S2NPo+a1? za!q|tO{WqF7pq@>*5)s+Ng^|p;Ns%EliaI`tN(mzO_<>ZoC~&yxT+_lW;-6%_QYPX z(+LRP^sq+TCznjwT%wC!qNLX{T=c}tdrxs*KXwmcIEu8jih~SJ5?jGvziY?cx@;4B{@#US*Xd*ji zCWt_HuOG{H6z7caZ)B;leYKdPhf-Mb^9RTUuc>(m;5F;nCp|IC2$qGC)8<3B(%U4r z$c=ejA4>KtmY#=S@P%tJsAtuf6+5qdw`*&r#Fz))BPc}p+v)Mr+$jFY7na!1&3>o- z{_}@l%gT38-?;q_P7*<8QJY>;7bxrV?zyX(AjYT2%AoKKx0za~=9PU!;e8T(edaF_ zq$lIsk!#a_wudZ&I4}^7-c9M^;rS?Si}cz;WxrHUT34`9m{nds(-AWuAMqG7NMd(g z&5uex#H4X(-Jxnq%D_z**<{3F)}uWCutd1BIi>GsKGY_i=j9$y!tKrH<{T;|%LTqI zD5K7VEql19F`CqIi?*PSGGU6 z<(P2n;D6(I5{lt(ZrAOh=yYYbBwYFe=fqsZ-Y5)iF!j?cxJ*AiO9Do&n-D83Cxj#| zdA*-kkP>H?+}ks>y2${g@#X>rouVP^=W(aq`LrqU98?UjOs<*t7DTZBrh2lcu%Iod zAIXec`Fx*MHKG?h1of!J)zwGVZioAjtu4NzeXx<0D*t9d7naVnM%^XO-AdE~`2`Aia394uU;MmcpNhtN3JW)mTg*pWcNWWDgdtSaD;W29 zWnk0O&%Pgw;4fJBP`ywakeCu94p6%?FV@4geMU&+RVivVi_zu_vgdUs?rjOIUoUm1 zYP<3)W)?V9RiLgZ?~4KBX;;a|$W~SDr6|AByDG#!muCT0{vTU!9o1I!Z3~A0C3u26 z!M%8K2rk9lT}pxCZo%E%DTN{h3N7x%p)FdZP+W_<%S(Uv-Z$R+-nYgX`Rn9lCs}*# zwdbC5t;av*s>;N2{zwfrB}FoC@H>$Vm^7qU&}sBZd9TzgG-6UhW167Kliq{KYR(GH zOiz9rXoLnlzy=mjcvg>AW06Ths3?v`0x~@c?XlCi-tx*hufT5ZRZP8r)K7h zf6>A8@oB%ydSqqkwQ_xpXC^w@x?dCblpv_YS5w)h9U=@To2A`P1_8&uy*v?ifQSqh ze$N5)Zt31W-T&@Z^Wu3fT)w&z@NZ`;$d_<(?;aH>L_Iis`24zqaReO&H%V2<#uaIE zfSeWnridmpB}mo3;8d?lTvk$1l%6MihXBE~g4*aB186+)V0>E!1BU&zC&~!6$-VWR zvJ6JQlMD_qM_db$*UGgd%eaLgSvcM-*D;M7-sHf7$zNQmk4QhLySSG8DXA|O=E z+KJ2d7w_wy9cMc-VD!=VCwUaochode>&9G@vBl2=Z|GoxgS2oLWeOyEMC=PDO#+ZA zLN5N3di-y^KZN_vUER~ zgAR(J0Qj~+T#{68_XHt;ev+*_T$+26Y!yvYdI*SrZaY&d;nc^BN3AT=Oe$3;z_HAk zDvtRjr5<`hcS+ofbQl3Er}pvU6(}_bYY11iPGDg`KRo!`YFn*S{$V=NSkfB)pf($c zl>7*yr==nMD`Wk_boGE!)4Ecnn({Jl7@d|b+El~rq5%9Y!Jk|20Gr8cUnuD@rdb4q zwS*=VS%aYgQcpt+fi7Q%fq0_PpWMGrc~#bQ43fY)Xr6$ zc(4tw2c`5~f4mDVUfSI6q9|DjuC-DQtZDqcaE3kaN$jf>(Ai*snCAMH&MknmzP_j* zXqQHo8wG!prt*EwHbNQJxyM!e(GSq=v2I0aKheT23~HlPz73v;c$%>W6jgSm9dObD zt@1lw2(I0W6@CFPMn39N;#|r$wIhTuM-jU*Dq7uji!mSs3AM{qx_T#v|8d%29y{jt zp&N#x%}A+xM>|ZHvTU0Nnx9QCZ*YN~bkH}vr_U2Yt$47YTn6A~XNnA5 z0pOcQ2Ycd+pxqq-B`W|(RUj8&Bs?$}B^mxdcFGcpW3Ln*W~$c)mH|u|r(9LdcgiTv zrJh%mH*_QPwrMiJ|d~&3@2JcfHkWlb2 zoR8KN1Qm?;1Yj;KCg}7T9p8o!ILQZ+R8{z@O+Kmu=}bKIFa{*7U_^-Y;un_W>e|<4 zOR5JS5#FQLNCo*}k8p$#>L+gDVkzz7p$0aYf3&hJ8Tuaa1}=mH)<&0IiY;3+@yfS= zDaI4yXv!364eXXX4D81qG=r9D$PUOM|IAq+4S1%r!Cu}do|91f1>BG#6ISSA??I-t z2!E6M3l&_G$4K0--Q)Wd3ZxSwfDu5;3SfRvLT5Rw0nETWOxJlb(57Y)-K>#=gMU7S zst&+noN;BkE5bTR^oC>-JSAe!1WpIbUiyX$$X3A;=}KVHY3rQtoV7U4MBT4|(tMWH z!I$6oWP#?vCY#Lsvl5r?AC>dAApQ|gPeL-3Ol{{Ra|!^1o!;R*jM<3US512UVnWNM z`5QSU<5p=9H$|JlY-r)h537JVpI^A2UkAv@*gQ*C;On4)h3h`&V-hGNgU6HgHth<>3p4M>4j410M|+9m>Op}H#)nhIa4|W=>+|9@R`l|Q z0c^B?JV+wTkf(AMQ0YwirMqC(`T4=OyOXzdQ?I`*Y|s##C!1A zbL`N(RBuM=1*HN*^-FOIQwdfQ@tb{&&n395U-aWw7HAT~zy$P9;1MZu)Dm;(`-%i9 z|5LZ_DR-Siohr7s{DP;NmD+~MN*8ft*p=m!p+CX|ZEFEeJ)iX92bn(Lvae^|G;%cC zVB`~XMw_u82Ity(sJ*zFWaC~_`P?|PUVm}jCCTU%#Fvbmln7<+0z?np<1mqZMAV*E zH-@LlCwA7?w+6{VZ`S>%#F(b+@qrjJB&EXrwDgS2t5wv=w9%WZcL#)n5uL!+!SVPV zFG2`!wcXyARqSeE6!3fShiZ;N3Lqtq0A8&i;66c2Mu~iu_|ZyY(pe@QpUJSXs6rO0 zQmFyg{q;TA7*B)nZw!Wvh&rw$OxtE0pCQs^;67R!ME#38Szlh{`M!CYCZ}S=j(M>S;iR69=Ggsy2A&d2Wx&5(_Jy&Cu| z5!~lfP79}>+uz)Ymb#$2zxc}O)U((_^}JN>p0G$``24-Q>v*6+qVbzD*~iMF zAFrmYLiTcn@7+w1SPG1*+ukkZbe=QL0%&XqQt(C^X=%cCBKO*%2VaxA{AE!u1E-6(BvpwPw zrX1F?V?4V<{m@3I5>hr-ClrtCuk?A^3<;8R4WXG<4)$F7AiOZ{YuI(JR&)6y8G_XN zp{e-o#2M?0nhy@qPl=Vl5a zGFc7FuREOVP`9YYY(!T~2_1xwL!iO@gP>&Zl}Os%6hMg;0dTlf269pHVpu`boPiGZ z|3xo0C++q1s^55H$W$ zuD|kN11MDCJDn7zRP-=v#~F=t#&bS!?=7Z%3-p+VbYxMr6Fa&i9m45@BZ=htX>RLp zf*unZeQeqZ@m~q5%jA99UU0gMk2-jHh!-NN2jH!Y-BZ26HTeeXHvtPn>o%B{so9x>^e7 z?PDn`Yn|Q3q1=VEbxS~5)MLmS*dmmw9v_5umK~YTIHUdRB`tY{(0Tl;j}$euM#J{|-H;(Te=6Pm|Seqk| z-z_sU{nk`GQDGN#V(zVppndm1lkHusORERzx}n~n97R2gmfZre*~=yaccR~D)T;6a zihtat!Y*l3$RtT1M`f$G!3PCDW9fCkau(oHuSOSszICp+5QCeAT01a#AfO25%4wN| zX`(Ex)ud@d)dozh;~j2zx6B&nzN(q=+^6yi`Xp(tX?9V^OK>ym=OUgb?FDW=y&H*VkYx^GwodPe{pAUbI}BRsn2WL$7((Jb-j zv7Wk-?q1+8W&_f>Sa2Lv#^tjwBlL(S=!D(uE25Wg)(&6|l(RD5T!W^-0q;np-xWer z_ypEZmjbNaZ-JoNO*(iNn@But=xxC0XvBpuK14hCXX&JRMyz2W>&f&ByI<=}rP-1QLT)kN$}IPWaR zh3RyaFRvY=s|P24UAyIP9>)JRX*-IQNz72@4-z4e zy;uuvJrJz6r;B{VkLqd3@L3AwEwvCSi~ja46~pazM3TsX87fQF|Oz73P>@ z*+FLxnj?$pyQR*ZFbt3C(-+^HZpFU#^;ISB%NYvl9Oq9P>Mc^NP^JBI;Gc^6JZyJ) z^f-4>P+1@8t(fcoHif5eJE+&~S-khKIRA5Z{*0A<4F%L$8o-iT94tPKY%Ris2C}gS zv5%rg^pvn)14e{kvGlv2F8~k?00dzvi9iJ>kUp8PRc-y3d0h&lgT)Yo%bJ9uz`f3! zhD)Pv2vsDPX~(5I>9PGGvce(sY4EN?Z0_D5MOevkA7+Q(@UFe(_TS|8zSx9H;I;~aBhNiI zvIDx$ueZkM^##ODwd}=A<6Hxtf)=>Z{SJ}7*dhi$unk!I3WmLUomTvT@ux~?E!zJ~ zm<9+;MwNh^uVG{+6iKr-QE6gy-H8UCUZ@;CO*=Fu*r4zFNF?Wz=xX}J`3TKoD^?9H zls2ECf^w#z4cqaeB&*;el?H>Vuc)8`+yC>UKv2O#A~Qyt7AMo{>~m86YjZB_v{{PJ zVEy07;a_S{lk<^FaYAOa0KStfD6>sx02V3pPDLSD*Jk_wp2^Jc;i}zB8rm;!-gyM2 zzqmjTx!leH>kF{_Ck7y}Q-DRQ1E`va3MzztH;-)14$nq0kwKFAX9Tc+ucc)O_C}8| zH`;LI6clB)kwJ2t3hIgHAqM;J8~$_mmqz!M9pT(n8Q}>r^gCh}biXa6FNdp0Zj(Z= zSLJ?i0wLIPF0#!3@#M`FQBiSr*K0 z^Zmcs;`WPQn7ehUY#Lzn)Z4e`xSqL z(Y>-gFwGFB2?c#Q<-z<>q)BQ{u%qB8`(?pN&VcWvmV}3MN~$s0#LU4$Ad+s}v3KoF{<#|)*}fy+I}6`b1jD57wK)R_cK5XfMfZ+z*9&#{-OMhM z+e8Jx9?@iFiVZ-P|L7j+aCbdo{h8sKr+YnD6iXrO_uR^QRd_WdTXu(``np4 zZPe4<+ob@W%bUpuSJLlA=^rLrZq+zZ08J|R7n08yVE#ZriI*2@bSKJe;WkDxy~;nj z+bx}V8^Xww-H(c><&f`z?zQ(P7G?_kjmUu3eXsU@g5T|*3MY~!h_FUzss_yj?cdTS_%@k3B>8vGHNNXMy`pGiY|UD@#`k}? zxaOS+D(u?13NG@NX#RYwyBzhfJpC}FcD`&q-u!r{Z+OqxF1{}bp6#n+-PqW01-Ok? zAj&!Gz*~@_ol&E6LomS4jJs9%aQb(ls;Hp<(!l~s5p1F|SziH>a!CbiMCjvP4Y00n zVSbJI{Y%S9{nlPf*}A3&)izoEBgf3lRBx)N?_C1~j)jFqqB2o{0k%TO^Z|eWV1Q>p zuqOvp5Q5c$xDe*pgr=Z4y3+N1ypg|h_HA@@Hl)u`r*|*2a>MyvNbUf<|JLcSTv=JU zg%CQFfRVfnu;!9QRWQrUExzveLxDc3;$M8Ef}#V#<-l;pU4%>hdusAK^y&<^)>AY$ za3tc9G;9`iI`8gVWe=eHlKL}XdPM*afqREUQvuH z2Af4rj(z$XAB^{JU9%l&+e1h>#8_chHx~fc%x`B$NF|GhT`0PrN#XNius;~dfe9l` zY%o;_93g!EHxd9L^j~UHk&84OBM9KmEk0J$N19qGp@J@v&r`iNuk=DyxTAu)0;K-; zPYs6u`z%WlJ@^f0NLiB;E;x`cvuE%1B!W`s=A6p78$2(PSNJNCD^agP>}DHTbCFp} zA%m6g9vQwm@kdL^XeRPkWHdd@$NsgI0Ru~&5hm}{1 z>kWqY(~`imUz=arBdYlv{J(FB)CYd=0EQ07*jO4DTY#OCS3NtDdR-u^}i zJ&))RG^PJ?f`8Pse^MsUPlmb$6ll^ydXL|md1QJ8^lIF|Y5*zO1r?MU6$=)5NeJ}= zgsMy+{o}Izvm;%=x)S<--iziSaSb3vZ$VRt$2J7Ao#hqZ8zY?w>B9djC?ReRCx`E@ z$(w+_yydUbK2G8_TxF*rErP3OuUY4-MaE z-RG#OJpP5+8iWjXN0c?mRGCm=gROtlh06rvChI5Z!sDATVRdN#Sb_fr1%L@6MZe)w zP*R-9RT+xFD=^-_jC=OK4Lo}EQZQ=2KNd6B3ATHNFK?cCcm(YE0%_2bMh;hK*E%gy^$CPu-km^ z(AuE+Y>xK5O+8KFXQfQSBmag5cR6|fm&nwdx=Zct9?$H-Ry7iHt`wuzJQo-3<>|(+ zPaa%&^(uTf?lWxs>RU%v%2(Wdh#Oe7YkUlKZ_cA;=MuRYulvu>-7kw?7mD6yc62*? z+c@qbvl6`a&}7$Y)#T3Tv&=hE0a!AJ*vunuh7{rHo74hGW8a~(y94k9(4ed~WZcz& zTRg@|eRuhk*nDL= z`JI?kQOUmR<j zzPKA?5T|yztgNhtFJGk0B!ZN!tgQHigcR}d@kdWjU2_Wyx4-D{iHLmndvyLa_wnP$ z-K7Cklc!ta&+J<69c=!3z)yVudMaD=YUX#LwVwf`w%Gpgcrsmhh04Uv_BJB0{b!j+ zIK)LIN+w&G;Uf*_CagC}H}|ItaZ#A;|f9?%?PlEXIbHRcTuHSq%q5VEBYOiNj1R2$}t%bPN@&TlS1@uXatm| z;pv!^-lNO?aoNr11i`Lln*e@j|IL@XhBzr90{LI5-|lwTF2RmcqujgDXI zc2BP$HL#+(HmY{t`-rp}Md8$! z7WOt=D@|Osk`7hjWx6_`4JlnGo3HT2sB><#J}6gaOKIKJGDb!j)MBhkA?lOd=V;R5 zQ@>S;Zz9id+ZsKxl4ip8IcD@Yvu*n*V`y&;dE#|#NQ#S@rT@sHvMD{fu7TD1d5y4W zSM;SQu})lZ$yB%mbl-5+Rv~8f4jZ}5hOyW0Ab;j#*5{o0{Iax~>T3qhS#DX(!Q!p! zvusA^Ec3Pkb({lPZFB=io@ohne6b zHlH1aFXa$)PNaFH=*+l(!eVbtW@d5j2w&swg74Qi4P6X*dvs&|nLjURPM7;%J(mj8 zcOR?m^IDFcH+LU1tTco9u|YB!&|mqFAa)bbFw$@nl> z4}SGW!EIv>k=MihmomW}wVgq=UteR!8V~J^1;)h3V_DnUTFzAIlyK2}u^hnAjRjXb zgl5pGmLqhq=_^!7XT{p^2U00>20gg?t&s-&Peuixb%}nr3D_Trod>A5=!?WAf8{t| z=Nbh9{}t^F+l*SF?oV90^?ABPS5PDkUl87*^ovvgBDo>qWQ9@YVJ{oDgf$L-m%viN zG#}V`fjC=0?e>5D-VV!R$JAt*jfRq#Bgnm}z8*vXPV#?=9!n--_q$Yjs^mBzmk!MAQYS2)+u=t*vy3b}7QlbO3YZEwFyrdAxMMFx^$Y ze*6p$l2DGAL-Tp#EEvRtYsw%8|223OCj$&G$kb*Zw~<<(N}j0@~kFRO>{GOkA*^@<#UA+vBgzSG8-f`|8_LLcBblcWIv^T+Sz7jXtv0{X1 zQE9vU{bE6*?U?$Z3}tw#>~+os^h}zF5e5wTj0c57VI5`+u&O65Lg+OkGb}Z-M@b6) zFvALKp{IczRRH@LVF>R-2mi+j|Kp7-#=w3qERgk1zT})KZ%Sqtghhfnb}#o%4sr{(X<{l=CNt(8HO zkVunMy@~!bxyQbFuAw5^ze9NGQQg0vDk+?dsX9clxs_oXz%KP3L}mX8>J$=*X2drC zC`*E(2&d;DZ;EIYYvv5al;w8Y61=ovP;WZ^=x~H9DPUL&fJ7%3B%EnxV|(gGIXPnW zR*?uaz1GGZ+NY-#4dOfU#A(X03AmwHDUZZE#=qKly7+?E;^!d~ejo?l`0YPe{(n1W@U(uh1 z-&^y%hBE2d8JTrMyhYF5MV}%=Gxl%Dy3B zu69y!T7QXM!MD@aw$+k;9^{phdEz3-tb??KH^wo?RevFv|9|q2LsC%jUp1O@g~FI)X=DzrD5_)md)&pUhZLfd$p%V(aGCxsS@o-A*=xaN z^a}H+mNC%K@tWQ|NAHKS)mG>a6SYRZWBIVqQDfdW%T?X4oF3cr>o=L4s``8KFJp{? zhN|%VG!)SDeIW)uv=p@VY^(4`AfO@9wBr(JGw?B>#(Nfq>-9?&)q!MD0%go6pYaqqKfL1p{qwP`^1E|Cc9FXp>J6Bu1#MQQLj7OYD zEL>~XyBZzb@vB(R{=veAdtAuYbHt53yMIRq3%yv@=v$>!*qG=h{?$QezDowg-08_G zd_m2^ZJhK72(gJP6Wg$;5~aQjFP}5wJ938o&O-%?ypeAAPEIfl-&w*r33`=V&^{&k zX?wfpa?0ui=Me33d##n(dhNb@u6 z_W?@g`H+A+#-GoRnV(M+sgWYI=^+4}3;_*IH{`7?8sp`WO&+KmXY=H`e!c%?{jQ4ts%EA3L@9Oi>r?Z}g~$%9Q;FSZn;j z>j-mg0UKEtxcR;bqr09uZ%o&S7v*%MD*Y?5a@%rTlvz!0emp?cqIi1mHn8*J-&ZNY#`4{3d=j|8{urHMS_440XS;_^ApC=X- zT|pdA6nbh!{h?!&T+drO+~@UZu5VX}!Rl`kY<}iMY;~>-El56c-x{$n&v#{vV1z_g zDOHp6V(?Nwv22Sz^I8nkg-rbhUjp{c*c= zp8edu!_|E0?0WcvMM2y6W&hs$u)2zAa{WJLbT27?KKkL&TNYPp7)pPI4C@2XSJGWU zPKzXq$GaW-IrpoiXEcYrysJT{Stp#zb|o58Vwq^;bx5gzn5cyFxK8^$pWOWqYaJq} z7>7x2X1u!sw;$C?18eaAbo--pMY#KlIcS@i8d{oQdMK}q5F<0sH-v33e0Xn*p1jWX zV)+U7?IecG4@)!VLQma=N7uV@zW=_DU-T|E6z7;_R~RPyIVBgwHe@j`r#yXfo<-O| z2Q1xDC*+)7_TFkk525t;ydbHt92UfWzV^oW^kX#k7$J|#E`P!W_Y!Hp;eh6-YmR7*wP zRKp3moRfhE+)E%1^K_7=rs#KHAzAiCs=(*#{wIIE*~Wv$AWmOCr>A^)v&sQP34RBp z#|zFA;C!a{qHYO|U|V{#!~ic}0YMS%Dnz~{N@@VPR8GYFaracl*j+<0m;^fE@1>)@ zv{`-6{FyD{{SsyL`*-d)6Hu>Im0Uh_guX}6bsYttKKG-WKX53Kupu50lkLh6lUBmG za2POq40^;s>Ch4nYd`isU@mXI5n|VjM)1^EYn>{}-M?Krm{0I8{Kc;(gKhzf=DI|& z->~)$L~vEH(Lhf9e^(v_>~^O}i?JPrM?oU@8+AANiXx-O!zQ}K9z-8r@qZHt)I7MY zHH|d&3roV@>m#0>xcggvdeYb3i?1dcGDICrp(cJy&~;hk{Gsjy&ywr+t#{=xROI2_ zMcYs?)=q@wCj^RqOKizdDwli)mwGkr+WA9flnz64=gsaF%_5!Y9yx7Gz`&czv#{Xi zPcxjWW{vqP%zEeUx87fXQLBHi#q-C-df#Fm_O{;mfE36PMQm*CUM7g(lLOb{>Kz*0 z?FPvA9QBT~CE(Cyg&pB77o5fM$J67=q$r4|$X4F|pKk9dK_3ZHluxt+d9Mt!nzuFF&VO#BZ4hGqvU;0Pxgy-gjB)_-X?FmtMe_XTJU|}S7(u3TxU;CVZP+##0 zDO-85b~yIzTlojp0823uD4W+t05#oUWj41Oa>#jv{_*3R>{wSV?SPZ|P!5sa7#g45 zqWH%b01DqMm-&Zrn8d1J3*xw)n9?f`@em)bp&j6+~}|v}DB&(M2@N z>D>F7T;{Yf%c6|0J%Y#>#h*X~NtoiA2__`XMjYkfZSI5oEF3Kzm%TVK5|ugKlRs&tF24-d zTSYw<}?YupCQ9>f1BYWM2@pB-1>O+%wXnmRv z7G*i!?V!8XFIQI$a?($IyZkW8Ny0EfS{{j?J9(DY@2=kK2c@iZ)k2*L2kBofG7udl z+}C=Kc3yni-zvZ*tk%CLyhKY21;%AMkZ@@d?*Gyaet3o=_9+yK6Zq)KnLB_K`e6YH zl-a`_Ks_rg=to!q0xT~6PsqWC{@XDBSLEr+L5YTcvts~3r|hM-VaQ; zF0I2i?Y$hGJ{6_uVkxTEGU*kmz?DL~I_Io%|Hb8M&C%G1!x#;k5|61rD%(h;jO6st zsB=il04Nqdh;C`18rF8>!|{I0{pOb|BX_!qQBH@tmoxE74i?@C z)}B1hLV(*j2MqrVSj?Y0wr(vC%o`_wUdin$A;cHgy0z%upimHP}qyfJVw{|G)t3f_Iv8^+#)7ESSo;5vR}@ZwGgWYt7Z? zr;_o=cUh!MvHY$brU-|B?A?C0x`J-5FCl?gCNusvl?u&sMl-@gjm*K-#X zGTXC$W2Yu1g^w~!Egt!|ffZ)#(mj{6mpHWW*0K2Znd&n`NKa-$!{7pp4)t~T;A^Ql z?O)#;&3`xVq1sp2$M{Fta3V*T^PcQ`oi_HYUEg8p3JJA^XP0YD@hj-N!#62rxDT{+ zwhyAC%18AH2a~y3k3)cF6ve*tdNz%OA=34PX1o>I9nL`AOEjOZrxVhM3@tY?l0lBk z;ox9n$gQ&D<&YUJlA8qnzrD=Lk`(H&iJ}`kAWh2LRZ$iGCkQ9m-!K_@Gw46y*MGo= z|IQ%-&Ou;@m&xP|8Orcqg6l%CBNC)k;daQi*#5Wv-=>=ceCtXEVidK)Zi&<(L->G@ zw0A2@aw*O|ZYia*3_`^1-p3&|M$J-E%n~0}3s`$C>o+zKlC~D#bH^V`Z3(6?{dG|6t;p6$yQDNwg z%P^eN(*x~zGU1Fm56v%R{Y#&j@+A~Q?99z{!3uccpSeAK?mVo3(o&plu+cEH`e}_+ zhNEj?n)FUYzU)c|p6}u>%RRS-i|-<HO=!wt(&ynglqezS7}xET@A)E7F{(`zFO}V*)omPc(VufOD01Z&;O7Ay z7xYoBnm7kx?Rwt*Fwe5N7$3hE5WO&dNihk`h%a}nNU7p!(jOErW3Q*xEW>sB;qCtZ z%&k!yYZ(up?5R|WhP$r@8$U63cxWX1I({mlZ6ao&+vC7Fn4dRr(qR4dY6aW%9T3?4 z{^@9lb;l}ZCj&~Jl!+1@@napV|6HsfUyH&tBHIPT2bx2elhUE`klx7 z$95zv5(rH93cIw-Y$(o|EIYFnQHne)fAgbyjsh@c&gkk3mSaA*N@UzRZSf1_Vbgl7 zji=Lg66sRd)mfQa(po;vqM}gAouX@MD~0<)vveJc{P3Ncyp?L!m|&L;{?%APf;3y! zM!=PLj#-!vBRP{wKhv-6ixtu6IC&gNC_N~-tJ5`L(H6A(7DPUj@GYe#?{@iiX<3T< zQ5Q*C%b@j()jMI7L_CZ7J6!4YdkrE8bkVL%vLsZS@w@oZ_-K0T;o_NhNZS3i#e)gU zut7ZmS{9-&TfD4blV=*eL-qcsq0ezDD<4x0uijABZFY}!O%#Eu-v~d>vAjRkr}2)W z1X|!G0sXIy+focttm*y8@Zl6hWxkic9_YXmpFXWV)iFigr`=|TiZu0J?(w=jnPAjJ zY{B%y@NhPiPHhVB8;Dv62no+}lhJFo3J319AU3E`JsF=~Y;|i0He)5(gd|?SsHocp z=14o3PdRd^YG>P4gB({roOh&Su>F4L7a55@&0q1Bo@%TrPz_Zl(dbY~VL-cI>I#Rf zk|%_jP?M)9Q9H|nDI;IP{F8(uqPIm<&-z)GGCY7S2DmBGEC~m_`b%w;in65pZ&UGq zuJBJ@pybpqZy8~4_w&6sNvm-VcVgV{R4?b@&;Z z4km?a+h^(_7^t%PY&fp`zGv1r?y{>bCt4qsLu#WWpVi{dcgEj;{Fn<$wl7h6{gjfH zE#%IqJpHB;7@k2@JNB8j!4p|%r!c}mi_m+X|A{#w0~nL+tbx`9M&fZo>}&9FzF!%9 zTOBvXh%6hM?q-TAPATrXHT-blCmPapeyo*U3OPxjjsOS=*@zS-El2qYq6Lv}Y^c!>JJ0`ao0f+Q3@eNl@$f`v(muF_7>PLkFG+tlw|G(C+{E&b?dQoI(R@ueGn zPP`Jgvs#zvo$SbPz)o`(D_C^H5=A+!N^lbBrdlD7+jqMw7VU>e0L`0aV1{AcZ1W(| zrmedlrK+b{4)F$nA4Fw zF8>Xdo1(HIeGnq`(no?IZ%iqA-%Md#N>`e;Z_GAJ$RSw{{@l|;+L)s zvb*sO*N&#Y%U8Y&7XM(ru8cjP=czzJ547S>A;NRxtY6c5ye+GkR;c8kD|nqH~C`fTAmnELT8GKKn!*YeM{@E8n%-7Tl;EOv*n=JykXoUq(e-<1+wj6G5c` z8y!@5wpPfMJAVD{M1N&Iw%m8caaFqD!R9uRcncrT(6{p#DlLMWGSfBC+3P0!DLltW>;diF&L3jzx=$vjVz z1ss^S$%b0n*7kJxp2JoJLj13f67KGV5yg6vs1jWCH#(qpWBHOgI%R@(u0C*W8bT6L zA1)kf@%}1E--J;*COwR%Zf}@oCr=bd7f4s#M)LK?(W%Q_#8S6@f&rQA=cbE?zf_Pu*GS$Ck|M!A>Qsy@NNd- zCfryx@g`WVlx4Oni()tA(qV%>zWucbiVaT6HhLn_@6O%W7$<)ZRbBCb>ew)O>|ehI z4=iO$c4y7NltGRwgpqKM-GX=qhV9My#jm{q#=0q@-@ML%G8tge(*D!Lr!W$cv2)0< zaj&m1D4#@}K2_~|08LFW>XyDZ=%CuuGXTA-fyMISM#a-+<;cg<6Q?YrGb_o&xdZTA z(prE2CQ+#9L2rz*cQm&=rZ4pU(mnw|78 z!SNxxN?l+$<)GsS%_hkDD8;_f-mE3bL%@N$>TOwQB`^O`lpBeQh@O?IsjrD;3O$KP zycThIN}x=Xj6o~f;c{i~XhKlB?p*KZ87SDRhtjd9j7_%1=bMtKoY1Lo#O`|O9Uie; zk~u}fUtijUs(wSvC|~9AqvZ&EZPAxZJLB08C*zQl78#X&GW_!@(cjd@hv;io{3ODqaP=qWT^apX{%9*Dl7jeZL|{ zShH`{{*^0sp^`BpsVDKbefHVrhl=-}rgaWXa~VT!o^=>D2Hnf9i_QhFQ1@BnV_;S` zsGmeeKbwYx1+DZRnJ`o69{kRL%Me0P=b{P3VRN&_?Ng#__UM&Fe>!l+ zqPm7qXd%R+oc1+b2Kz@#lzt>Boj+ z#6$?K^{QFN0B@(u7ltO;6rAF%(A0 zna_z+UUw9)s@En?xuq$B6g`X?q)xiUD_75dTIkCA=7AD_iU^@a4=44xKiqr#9Q9ng z3FN<|=uLTT@;tZv1tx4RPhZ=}~RZR{ae1$^%$G1_S)kn?Vcyz!24Q z*DgW;+^@Ap5Ht~(4x>AKo~G{q=LC^Y1;p1DkS%J(As5&N!X$F)ui(Z^&h0{fg1gDP zg@7m|f+%(r_%)VR;nR9?$r{Mr+pwd_KR!6gY%*{xviGkT3byR*WQTJ39ai0hXe80! zS9V%e)Yc9binZrV43CVg#GjWVpl-lMl&28%p2Q@=AoRUy7Q7;cZgDC>+98?&n*XP=N%if;K=30 zo8Scs9`gOQJpQo3P61-g-zO~~l$g?qmxa!n#wa=T7y?4M3*-qDL1xdE-m zfY@j_`^heXZ(a8ssrV)WaD`S~W=lTS6Jd9~Pzp6=Mo(t6^G3nbh@;cSeBlzGPIw-? zf<`{2x#mDCqUP?*=e9UD!IBVu&oP}8e&?6A8sbR?rTzLMwghkOSHPf~4t;?j_ROFYs#of% z7Y%b}vKCJo3J4yZZd7U46)Vy8k*ue0a*K>oVh2awJC@z6;{jJ%b(BAeWR4`)EVk3f z3Qp&uUa6W4=D(>;w7VHRg||I}^OT4kX>?*gwQ1r(e^yEeI-{|O3$k>Fr+UjI2P^aN zD6Uo5u4^!Ok}>hE)JG^vla8wVJCXdkgYJTRFyxS^t=BO=@)!$(JgNG>r$-iIN^IBD zYgq}-bAJTCb2v^7H?_%#+4{tnGV07!VOx0YmYo^eRtz`}l7t+_{3#>vDx%}!xa3{b4-|7Adok$3eC z<#NcoNLznWX2l7(`B?xZlO7f{s|>29HgbpmF$GmGs)ZH~Yy6o6>jxvmJi4gS8G!n< z;>CZ-_;XUH!)?k2^M)=xP8XEgjY~*B1&qeFK3aeojG&oBBZHCa6|u661y`Xo1B~-{ z=+P)FNCV09^#X(ap9KYd=I*mE{pK7*f(~l0xkY#v#XbjVUnk|N)w-TKsg?b`tiC>d ztS)N%)KxpAt&??l=Q+a!2B82$V9|d)VAB0*{@8X)J$tA;Hc?=2?MH`Q5WSxalFzbO3bP1@+75MVDYu=9st&F&7OH=87*W&*P(E($;g@nZev2$|$)b}nfN@!_(CJ&vQ&Ufm3CuAVPH^6I)hsePO zPn@U<_wrFRGmr!R=NE8zK6|U3aji@J$HVGDTF?h-P$>~?VZZvUfpEH z{Y@v4vfNny$GTXcgUKNH8*P+Jrf{*(lmbWpVH@-FvRE%G8~5vWjA|HVj$! zj&G8Pn5$x+|*k)Kuolle@4ycD;q<;Q9iXq^?ix^;WN#p1W13 z!lUl~0Z@a%J@B=yDWh{5HrRk_9w=0j&KeE%g&~;HJP1KR6t6I~JvH@FM~@s>A`vM> zAS}oLq@c+N0+pRCAq3}~Y6?1vBaoUT7dK|KHP#2zAIy(`oi^wM2nw#9j;npfc;D%k z%qZl4~H-I<7+n7 zj4gjW;ro7dd{(~bdBeQEyr{6f&`4}Xo&Xz0`dD97FtA8d?)1{qL@aPnocFYq*v3MBAssB%-d@_PA7hO zi#lm$z#xPaa`HyV!3dIOFcA_hM~}S4cp}nfFi`Dx&_|95%xLvjK0tF4N_0|1Bs-6P*KaZ8fWaKm9^D1qa2dlsfu~7^xUI$f2`11y}1SXkV|Hm$7uZ>KJY1qbcOYF$)SiRmS8! zE3f>_Uf!46oX=SRZCiViuEm`KOd>@$-SPaLTABBZeA1W5M;Q~sM@@EA0dJs|t=h34 zvEbe@HI?|Q8!CnpQEtBgH8wZ5&b(5KhwRu$og zmH&kL`)$~{D(q$+J&i8)e2ueFipLj-4{7m*nP0HvFuVe{q-}>bbjIHcIp5$pCyy?D zB8%X$<>+N@$GZ4$kVcJrKkLKm=+KbapHnkLWR0s^1Fxq!MW4>f8X@oH5!o7#tPgUp zxKry3|3TkZfpeI#k;2UCg7o#zryY;h|_8r>844LIE$#kvJl@v$KU>ka}S6XRLDJb8`XM z4mZTaHe?7?g5WEdr}-^$;666MtqmGgCG&yXEufPWA_DNQ{RhpV54n zFgvee(RWAU@-S5!Ya{AnGwjZx=lC_3MNJa(C8CIWMm^f{=8`X4-hcJ+IQ@6{yB$G5-udhe z_)Qb&{&`bwfz5Y0DAYi}KlTp_{sV}_+ntkLKw}X%dvC-Ey9(guS!{{TsKSm z?3xaBV_m3gk9878Emf#(0PApsgBG;Sd}F)xq^=C^)E>ci)ZW%Alo|W6XFajcPgSt7 z9MQFBLk3C1Ya-G$xR*SBNkbk`VPXel$Pp%Bp&QcFeS?Vfp9lZn57(Mu%2^eT(!3sG zz5VX|usBUUEtb()+Wx#`(5ra-#Pxx>b1xKvo3DnqU+*K|Ss|BPeFafuZk)c}Ah>*; z#m{hv^N49p2WP|Q?n&j4r-51eG;t04Xs*UJT|@nJ8jeQHsD$U@|JcpCzmLu0kx?BM zS#SG--Zha`0}R5;kX5+QRPFarA6%<2n%ef7pG?8C_xn9Ybwq>=dNq9R zSS!L1A00c~LtQZNbo%oqIj!SN>RgX(RC2p{!_HRx!=sils|Mf1>gx9Mdm^OOd2*_s z&YW0Ym5hv73STAI`tIyPw-aG8l37B}Ib*-eyfbS@)#>W3;{Z`ySLQNq*quoEVo_u| zG@GH0V_qhY8uw*H&Rukb3~q^qNCZw!+dM;I8sKFo;_W6MV~kFmCF}m*6nYr zb6-qt`F~v3Bvnrlx43+dvc=6-;`U~dz|DFrQS#rrWa9d1Z@%Gk84Sw?jQShe#k=Qo=&9}AJ^XOlhnw$%|NH%(CRFt^YR+26#PZz=fmHnW;U@UJwb>b% z6QA&*q#@Q4cs-DgNBA>}3g|7STI!<>g^F6yI5O_J`t zy||8SP<{B(1_gF)arjEk?Yzek$#=f%A3dqy^Bc6phOg5naKX3iuERw6U7mYK?H~RM zf6a98uZguWapHP2WSlc&cQi}bIr=!G{sZ&loM`WZA5o<>Aj$u#;PJKj((UR5z60W6`c%X2H-Ra!dUa_*C1z3F z;Y_^Ds)KT)BKT@f_XdeqdM6%N0y8epoXGH}lI4;*^eOa&r-AsXBs3^KKrk4_91p%r5r!`0PwQ#*spK0HnZjF4i2q+{k^5@U{H8D== zFWNWdlZw2bp7tx=n%#2=ELpBIn0$9C!k>`n6O#7b;hPh;d~Q7a4jbQ1dZnh^5C*>x z@vmqmcfOvRz@K|r-TGP4ol>*xNPXISs~hc75r~;qwp?JoemcN6v0>S#bG95+J8i3^ z{D~m$U8Cg0cbPSRqrK{)6)Di`$W4;Nz@$_u&o8}RG_fDrh`bBQjzO znXw@xPpSJ&9L({HUA^;RoOM&;dq}`*9m-`mHK1A#+!=@uu?GVic>kLU;CJmV7xa-` zff(p&Ar}B531E=27=ymZC1P+{K%(uE+($}$bnrnj{xY+kbbP*T9ZTF>=y35JG4Z)_ z_%InfM^HW%;k$g1ZNO!xVg=cPM`i?@#Z~2SmQx%v$Ww-I^r}oVioS`1*Q(NcSRO{y zsH^77KYO=5BKZpG&eV3|j*`ogecZQ3P4p<3pEg2heGjp$qR&Qukh2x4t_jQCLl@l# z$E_Vo9?kP6f4mdFew(@FS7Uk|d&n_b-)?@PMdziBm)0_>!&!;Fn2T(CG^7DFg?Yb& zg57SD^7|wjLkLb$AobklmxjEQ5lq7A34d(?s`<2T`oPtY)*uS+(5YxUi|8B`@Hk)usU_8 zFo8JSeD3MvafPsLFv&i3jvwl7H^|>-D|{>+>Nmswcxw!zYpyk;hC|hDojjEK%5Gh8 zwGJK6w>uN+mPD7^&vjGvf;i_QWiWkfNgXFE9+2XR`;rujFQ4kr^H$wFWzptsfUH$v zdE0m%L7q1=%Fn!51dKFOmN<$ws%>up{vy1>S#rNlRxmQV>Khw zVYn&hP4FjIFnq|3QwI{;6`$9>zb!V7+{vEh-vZRoI!8u2I(RO)eFhnhWxe*}(u-6A zf#u(}Q)wFLXR!^xQ)7&7W=~J8`u=9|F}8bYSJTVYlJ4Tn5L4> zU?8i5-fWw0zFfX6(o80mm^tLRII|e`|2C;(TbEZ@%+BhU2lic5#l3lHdbSRm_kKQu zbt33g{0|sE%z|B`a#_=ltbvilBzI!;p~&X_+*EWyxPFe4W*7|mfd7Y&Pz#M78x%nGUpF5moJ`8e)aue)n3P)D6;!wEZ5HG>N&;pa*gU9=8wEo?y zlYoHp8i$#L)>qPR222?(l9gA#OFbCRAO(7aFXH5PH?~C z$Rl23A&!ShA?M&y#E?&BEQdkPXpJ2qc9mvj*7I0a1n;%j&dIi9a?*;}8D&*f?QG6( z5?5@L@k4OzHj(9!dv0OIM~jzJFf4A)@~`-{&oe$jkLOn^K(z$8b1Dx&D(KB5ytn;< zkW?93iW1q)3q&4Z0Y@j7_}2md<9UM-a0w)=VbAbn0{E`KTR)GXv>#{7e`}e{$*eM! zH8}TAVE;0=ZaghZT>idWEMTuBncj_mzhcvPX+gHD9NHGmu%xg|bTn0R@!er*+kKv; z(;MLv}gII|oM(WIopO-|f_7ZC@M2G;Ru zH3|`b@=qn5yyr#haUm`R?dJCnFL)Hrg;C-XUl`(v1NypaTiH;Zd}R-#%1{X{{Lkyk zB2n(WM)VQxza*fb;NwNw3(2pVH^15%gtQf5*wR!7-qDo0V@jyGSPsk=#NRG4p##wz zqe*q=rA}vj zgA#KdM+Ym29e%Y~~$Y{k5!!rzFw<9;nM5JQc6@{hT6EgyjghM0QDw)A0os|!; z-92zB0>ldB!`)9cu)WoJORx=jj_9XaGdn(x*Ukk8`!C{&P|46651BnbA>j#HxXpUv zC)#MCeipIzIghU_yvQR<$k$DJsAp92!H%Qe5svkzGeQdQ9)!CQQ;(Vlmhx@=2R@J(PYr!du+a?3hDzgx`U*xdQcQ9u3HTH5=5B>S?$KqN1Lu#JU`^T-LY zfXy_x2tTD$8)^D{OK{fglj#cnt^_X8mvgDTVyIEvydXCDEH+lU1Gy)2kz*SUQ(KCwj? zq38Q%-A!MYxh*2IaQyB5Lp<>h+~_AAF!q8A}FbZ&s|zz zz#Atz#Hl;hD7Xp_6#%s3!zFcaa;^5kmY{$x`8g(dOR<{XqVe+&SFBaCpcLvr&3KDu5C<1@5dgRRM5 zgoha+zWUI3TSX0+)DxqV zsT}apEI-mBVTQ%GkQS)k@8e}%|J^74X^WJM+&c-4-G29byZd*Y>s`p{rAQfh zmg$hB5ArRxR;6OUj#JB3EDANVg%gePpoPLMUYIt^B13i@&&4;GTo)C8FG-C8KgUqq z)|^Cen@{3{o7Ojf)&!LyHN`za=WJ9Qhr*|+rVjx%+dY04gdEioBSVr65=ub%d@IEx zPA5CQz8@pHL(Ry3zI0dQ*EF2z+`t^ZC*ognXT|x+K4?&O?W8k@C}(==ctt}XT}hGc z&P>N1ZlvbdD`Ce;CcQ1s>s10UkD|LL^y%f_eYa`>Iq6M?Yf@yw?E{9J8v>&Vht_|8 zg;M8vKz#qjAL{?wl07HTL02uc>UQOJ0Ff^K7 zfjvTKP?6F{B6>$!?w-q8wWbM7RAjB!?!G5>`#dAKVjcngc^+$aGXpS2hDnPrxm9a4 z;A4PeSc+uLG>Y?krDgaLlkfOR#awsGL8pr@IzeL#nF+mImQiL~?*RAt6yvLYFh}kk zgmR{1HLIk=uz(CE4gbi39-~)JfjDL2mM%ORO`+aLBC1$EuY^;d8|Qh!tZ%}BHW};z zsH7u`wmG>h(C#f zlE%-aHEa|_XyBV&f`7L00>2DdzEI#?VrD@ZcSV6+Q~NW|W>M7SHcn}jz2s<=n2nMY z5OjT4Cw}4Eo(Z3Gtlgle77@uC>6^eo4!g`L)qVffQzIXTqaCiW)~q9V+86gr6vbHa z{RD`Y$fbm*G)3V{PDXx8u}HvnQE%U1drv^&QumplBV(F^8ouhr`$mPNLl=`{S|`^H zKC$;0KrzdTZUcwjQ?b$b)9-oo^GA>DlO5%=pl6)8H@{!fI6;_)_oqpB@H?2@MvSWC zXj>iD1BlI;%1V`E2vET?+4G3*acCI2$g?h4vL`ujr(r)X2p!$?A%&y8Pa>U2=A21* z?Le75!@(kj^Fu*j2+x2VF7C2eOYH4mv`vr_7P+G|sMIAF21a^XZ$X)wRf0*Efw4%>`uBnm z#cv!6R@CS{7cPN-RwQ5${vRBHp!oOr@GqRm1-yCi00Ok9Qpm9T&0K27?G2~`@(xFO zKIK6rp;X(&)}m%^YA~jKYoY3y?u{ourE@~uQCh|poS78_L@i@;&F3;jB?SR6`#;W+ z7Z9{qteV9otwdO2kcn%G9Rv81RoBEnM=UVA->9Sp_5DboC)8Ig=fu;qfyPIg7xSTg zW!`$GZwNqP!!1jMe7}RO`o{AQ3#^HeD3gmS_az6>uXrNV_y^Gn?HmMVZ=5{kcde+@ zltxhpOwHv!EK47G!F<2y#9kfU87{)&2RBB(AI35d2Knv*lVI97NGPAT2Iv??{K9{H z@Jt|lc?bYt;%3&OoTH$T!bk-q^a93FNsC@uLn%T7D5MmcV8lYNIcB0aHDhxmF9Yru zMWyt+VS^omTstUYuwZK%E0s>BZ38BHrUO>mx)6_(7F(&{ExHg7vuhGrfr}KnFv6^d z;~Cq+nPyg?cq|$ZPdcbO3FYUOr@lU8=T_T|$rVt;XFr5H+mon6$Z4*%>MNNUNT0bp z>>CrzsEvry9f>(vR)z7n93AN@l#8aty*g>R*H<*`5T)p_vafKCB)QGQk#>ZC*AhP} z!ds&^8Y4QkL)A*^_kSL&xKIAp;I?KE?b6@by*B%5mA zNNijFQTA|1BFfW+^DSW~J7C1Mj581b$KF z4KP4#ESIb}m`AMs;lUby(_pIw6M{8zoCDK+JscC`Y+}F_YdSdw9Pa0e-4Y{g5UQ&@ zZ*~&`DO@ru5LFO-P?s3vN4nqdpFny(IRm)m9ou;*K|O{o;c#pkHsI!9zlH~bU`x})D3MQ$@+NPQ~ zw8=y2WZf_MsY|%4`ac>CspvsdWN_GTob%IxNZCY)Bn0^3^Bftp*-bZgTyVnIrY50v zx;VY2pO1@dCx}<>)v`iyII9^>HeYK8%2{c57vbb`%#4C3x2pu_?t0KYtbUnYNZ)o` z#VZC#W%?T)OlD$H0_

      K?&98U^G&pcT~+|xCBesN^X$U4er0^mw!SA|M)x=-~%{d zcwGQIU#5a5xo{eY-NJd8huxv`;sf=I$L)*r)T2A6Pf zb4K8>ylwMgZ+5|H&^_IEHq?Cf;fm`FJD-L@`3nXvSVS_N8&aC^n><7a4?gmIX^L7c7D{1_D<4v;gbaH%=rY5+Mki8R~CG%WyPR37gHz zS`d3%f_t1bBQJ=ZK|Xte`gqf0Cj9P9`haQG$FDRzVo+*+m^B9BYcDgTht;P_cPApW z>~i|?s6}>^@WXMv;#M^_C*;o%d50(jAvry3QJqvxhSIBY3TUd5bMxZgaCs=o`6OZE zeP17TKs~RxU5*L}!yUJJ{XnSHKVeI{w>oAQ4jAfK3|kM{7D~nX#Oe~~8f9lU)FY-W9>1Hx4uCZ>H#0a!xf7JL zSST0t!mdK(&Q!Hq1MOe>9Bt8!W2YCS8|bO3^=k)3gvm|^2psq<7gdWl5wiByGa|8x zegpRfk`I)_pHcYL*P*}NVueLOOwGWRuX6NG`pp;BERG>z1lp3E4h`???}&C~?BC6w%3jM! z`{t5$7q95FYP$K;OOW_gB%Rg~;sd$IJ;6$Eb$XixG{a4!>X?8iSZqYzHg|Zx=76X@ zT&avrI<)zdJFRCtNATO}V(*+XQfTO;9-V>x*jB*j9&hk+{Dkt z_g|t&XnCQ0E^S1(zx!oTpsw2S1rlB9!lE{l-Bo1_3hh3^#UwQub|qk?hL+^hzh60R z6$DEVVPP3VC{wI-GtA{Ny)^r4h>X^4xpSA_KEb8G=hyWPC;dI6JN&Vi4qv5FdK$YM zHWtqfwZL%z*47OHpO9|~TbXZQ0$XV_1CCA!n5P5SbMXK`EO-zYK>Y&^|NB^x0rs4D z1A5o3Oei;BUAMBk>ZFjtxCx+8B=bxU(=yMyE`oTOB^<7*-*Hs!3Z&(4S++IR){V4f z?YssfR7MPHR$we{=Og$kDtBfz2KDTS_qwAu1at(UT+y0)LH|fTFWFzHTC0jFioq2b zagz<;p5`c42jN6ptt$hl@Oja1!oH4XJC>M; z{=^zT6nD&$h%#N@Yc&w#zt7S|8&%(|a$p;ii3Je8(lKu437bjaLG0D>$(Pgr;&;w_ z!bm#ohF`HQ5PHop4QopuTSU0YNEf?Y!`5Y!l8UHUqiT{i-Q)C)GmRqSf#6OXL9ZwXi4_4M#ru^AjVB(=NzpKpzlz7yNz=p%aA;qej4@ zhyeI2x}F9<4u4UY4BRR&hX{coYS8j!FS3~&v`YI18FY&1|HlS(Mm`95P^d*+60#3P zVX(C|(<;g`BPI6Ur{vc1T~#e2gy^8C+8DNlDi>4T&LzV^T;lHpYxa2pP?()AaikmQ&^c#$2rzP>e-8mUh>bY@|68|7b?2Z(j+YMIO)B)Q~QSl0}0N(w)<~wCM2B z{{DBFvOC32;ed63E_(mrSXk7fmms)`0bCmal_6rG@J;F^huQr~qqTMfK zYjH9izI!+?6q!37Ws*@)Sc_K2GwV%QqRVg)5PNyN6d|Oj{z=ia@|dE$5_+``(dWuW zz=f2+^V0=I7~k~MoZ_B#E@9&`D7C@Pr=+m>U}GECm2Y)0q5<3#HI4gDy0iknYR$Wl zAQz^11|24RXpKq?UUyMJT?h9boM97WKxcnvd8kp2ZvelK;;`Nqqojg#5(qklAmaZP ziOdgx2=Sk=cNl)!Y?$dgW@Ci%oAlw;g1q#7(~^t?(Vp zC3to08jL@};h?gnh{|3|`GAe5;wRj~#!S$mfRpJy|1-62CO`5*pzl=(>~$1;Uk({{ z94<8MOmb5CK=?{yqF5ODb`!coSLB-YNR)$i9m^AIlobU{JoxeVyo`YDJ+V*-4Q6+*t^!hiw zAeS|IPhe#{6?=h&nlFDR1>DzU?mXY6?qnMp_3AolkqD#&u(8(fPE(IgClqi)fH{i7 zRjIIv*PjW$@_ve8;h~Z?F2;0Vs*iK~GP)`mgXq7z*bQ`QYus|)`FBX73KWhFD`HRmOe$slAjJWEL;8w`gIEv?ZP-&3Xh~BZy zrZcmDA{NEEKHXzi{p1hP3M=m+U9v>4Hj`IZCsZWDqD%-L*#bdqNJTlyGcKLpJ?z+s4XWmEsRcF zV!=f-I=R`Kv4rI8pGX6tgvc8pdkfGEj-4 zT>jc5g_7PBmg{DSjL{nAhiqE4=H(Js9`f#|CCRjz%)btsYzjfHhAF|zZBm1RavQng z#e1Z)H48Eg5%Ih(@Dg{{xf0m(=C`z zfkvjVjXqCmMz~f4)=+!&eS*TC6K3^>YODtn?sus1r*!-?u)N%Q^?RX}^J+5nR#4Jnc^A1kltIpK7NOxef(h-U6Rta1Jz~@ZQ)3s zDn;JjT8fk2(Xv7HOdYfAO3Gi+#Ba&0zkc@{)q$dZlymkJhmkZUtyNeytqTb`465o| z%0qn=Z$DG=2XlOJ+4N1`C}I`Xu@+gCd7f!e!X~UYMPE<9ey7x@7#S*u!(NC%?dD$I=6{k?K7}EQKE#6bWC}!nyk4ZG|z# zOVc=|u30zT=TleLU=h5gxJ@qiG#5rafzPM=!ecO6XT`?eey>g#+{r)FBD%u%UG*^8 z+5Q?YU^B~8BhThMKKQG${f0$E7lVje3~m{S7&OfDQxyO`hG4?}i$g`TzW?Ad4;7#O zRb{lbv}ToR6YIOw4WCT^=$|&LZ22UEmkHCCbf8w4@&0qdB2I(D>S zf6=Cz0JGxeiF3B0!ns$yS85j8&=4FMj@_>uD z>WT|_qE>#M~irlO^|fl~JqNbW#CtH?&CwpKoO#ZiB{uen`S4$fT^M)PS|IssA6U$5YRlo=$|m z1{QLVhUQvi$X;Ht#_Txf_ihGtJA7lM=l{riT>-sE~@WD9omNs{wpDD zop0q1T+o$C4~Jz&2FGYsF>D2jAQmv|)pqoM34VJHzcW)-ZTrY+>Tgd>Rjp-C3TH%%eyC3seL(lU!i2rD9xa zGTVlIrGs470a62m;Mq7iN3NueUbWC4zWe)KeDD6wW&u(8v-6uK9GSI^*@TMX4}>Nd zozwyMV?2sr|u-m zil`$o5yFnJ{xe&mzpN9}9a{9jBf@R3&!fa9%VOSpnmT9k^>xOZa=EYDIdJy-e!%PQ zOyK9{@Xfd{GtuLOb;My`euvpiwFkr=d0Ov_S1e^M1;pOTUyz9Zt^Djh9_b<=?Gfx* zBvt^>jcp&)Z8m{T3BZK^$Nrrf&@8cIdX8mTaUt8g$m&qcmGiV9*GBn97`T@xF@|A(e%boV5j*sYsP3Uyk-l3HNk0h@;rq z>jOKf)_^0=CW=22TnRLZB7%GgNXx5Y1E&}FA-N4$>cQs|yFEUMJ=seS^AwMvCH?sC z5jRBlriiYqx1UK{kW8%0ch46DG=~QA@Av(wa=pwu6)j4iaaYs5-_&i_{uBwVt!uBq zNWmo_K#dMeaS8V{Um&7N4am>7Rc_&t-k@v7fcs zMkmRllmG0Hk2KHL47q+f=1gfVi%@*3Z0@Gcm<2!1_2%x9@3MX;(*#Gu!0Pxj#%-@j z%pvuIy?Wg-F=-5#6*Ht5NZwr`pmGn76g3g7?GCiwhRp-Mffp(LYyVkf5PS7WBlRq0c7~9?oUA#)!8>?|{ay)|1-Oix)3xcV{aYyk_r@V)i(;JOEN>7sM?B z1n5q|CfHCwh;a#PfUrmTzhDTwz8+e0-30Q??8Z*Rc4LCGDOEhfjI0ssf&)VkvZPZ* z>Ms^{4XVGziONE%UG;>@smf+3oy`|eAvgro=5;m(DQX~?mTPvwgskCMb^+c0H_8%n z745G!{Wh?_cR@5UnuI#rO=e2IX0*&4*jix&^BGyo-}nn*&z)Ok^v>Eo=aj4?Wv~Go zQf`#~sGJhmD1GjJjxlG?4N!x(IK-4)N6C*g$)5Asg?@RNn zs0)fY>wVACNBzXmbpy~1JCtMGHU>Uu@sk7rrBjpo)L5)vmM_Bf3m98_cm zeFOuCtJhBNweE(I^7%4~lb%$?_WyyQt^%k>XfhO;h=8inlHmD@=ppBtXo`jY%qzT~ z=;%v*lT?Gvf|4LV>0|N;NC46ol>|6#vCuWLiSm{zvZ+$f@NmoBaluGSg`5o2;`vb* zZgm~IC<+1fb#=e|!6_2XrQ<_qHj4v+UC=6BFlEQb!69&i+M=pMzobxE6zp}YH3X#{ zLA!@1);@{fe`WsM-}%xq==2Fj1n}XZsq*IISOV}F`SC8fB@>P^Y15rLyV?P~gd~Y} z03k21%nr1#2$1mFZVe;?bYbvtSsE{xXjaaabqd7u(v?@QdtP9&CT+LB#)Pkeo4$g5 zjv|6D-zI14q!4WA$MM}Ao57hdjtG6qPoUwKH=OV|*Ih~e5z?Kt=*gZ1e!zmoK8h+7YBc10+1sz0~;y24%I z?>OoFR^J}gZ`=3u+tskT$rB&rI`QzBP(iE0`B%&pvlM;OeRM*tO zy|{9u_qJ<;x)9yd2SP_;kZOLMfM)%fKgr994N$ECAy%mLkNpP`prlp>l_uqq1=tj^ zD#_S9Q^wUrh|RsCSS5M)OkT&R5RT&I%zplsS8=kOyw5BboZf}?MR=HSd=M*@r4eF= z?-=^S@&w%}s1+c%$rbX%5AJ+oAyn#9PU3qLT>Q5(`Pb%-=b}Z%%{#f;kE-$XTt4Zc zL9|KYI>tO7m;Bp0&3g`N3tjr)6ozNfPOxcs#s_iS!CV|0IC`Di#}XrrxBm?b~ZN?k?+-p6!HDZU|zI0bR*#R_U=ow{%R;QijbXqGyV|MeLXOk%P@ogG}93=;=4qTn%{9~ zXH@Ac3N2X8cT-Z&CTMiT$3?}?Z+=wEC&X?a;eR!)8^iV4F1{|12c~tA-v~&Wo$W4N zQ>zpGp@+!0sG!lh%wPKjU?}F7UhJ z4}LSk9*LMZ4QDn2hMHBO&69Le{h;1Ir0IVG5@WEIg%K)>eunKl9Lg zBii^bK>xU4v_AyT>{gQIHT)7<4@0j5xbJpz^H@mb375lpuP)!JAK}~ItFeiAgW3mi zyHNg+pqUq~-Bn8!ucDrfash?7oF>kNM1w;^`b-fb%k zL#?Rr{No3pXl2=L0rT?T971_D`82uY4XFAxeILo>DQIyMli6uuJS--EQ-p>V69_+0Obh zJbL-FB;_?{Q-l>2;eqTCy4&;Z5@z@~o{75$hPei3-TYV}{`Cjc0*Vs22*zE*71(pU zOj_^GH6#__>2Ri-4cz&GvbLHF9u*Q&GywPid?5C833<_K^j9f|81mChKdkc7_p4GZ zAKm2AylYV|(swxJ9jm%9|2}2caD!b!V;g> z{|iU<_)QBUp_j&f5%F?gs?oqb68TuNCDO*iDbib&>f1$; z#oYaNyeeMFG2xO;5g_B`l28=KAb##GfQ1c5kt88rRi}TRB{TQCiK5#m_fsElh2dgB z-xy;=O8MMcis2wqpx=YZY=X3VFMu#Z#&LN{dNhQt({o_7lUoG2!FE!$c|U7nS8=N3%LC z!~sxJd+|p(OZ6VgD%R6g2v!6Iw#D>Ak;_SVFY(H&feE!6cpsokR+=B51%T$cAvS*{&s)u4MA z6yT+&dJ!08UQGV6?98`vx-^r9jXUw6p(h0XDN@bw$kA8=^shXeN|Vb!j3}KKn|a%h z(~a2sjJR&5%BxLVhD$)HeQ3(oym@n^wDT%n&)2!RQGcMJ-cXdXJL|w#)V^_%l|5-1 zSu?gx6L%KnHDTIZ?M+&VrMHR^c&6W2gfHuys#f#vPudumrF!s{jQOlkwLn*mo!#I- z(N@t+iQ_1r?dD#`d1Ry@95J_80Wodm-W933UA$D0l*&CkV^)36oH> zwnjV6=>=d^B3_|h(Iwd^L7dzZ&+X2Q>y)HlP4vS9mnSYN+D2zW73R{x3oG8z06?X(rzqSHe((xDTnk{uDkX$@>PY= zV8Fps;q!r;{^@%F=?k$sl=Ji;9lz5dG1t)BX_gu$TH2^tp@@`5h>~$8KtKr=sc@)l zp8%JX?Mbv+vSv+Jzn{x8?cE5l>5=2-H@ebxsP`-Vo#gn=R|)}ir5Q|JceF9;2Q6JO z5m-BuGd{2DGF2HoG@`V8_|M}>*sYHHw-8a5_U4KgA{`>cquAT9r79HWx;6<*;P^rJ% z6K+`IKjmh7Fb`|?SR~@CW-YVf+ydY%2Dd34@D^|W=0L_VY1&s@G{|6(`W3k#8i&9S zbtvXX_XMYSI<+%^rQ$_|?|$O^VNu+AH!?|0AYHi}C%K6GUu1oCP+i}WHC)`??c%N> zxVyUrcY?da#XYzOcMI+WcS&%EKyY{GA|Jmu^QLCL*H!1=Q)ln$)7^V_ueIdqpP}+C zol8h%D7Z6~THq9GLd-VnhAjLX^JHX@PrNSS1IDI2XcU{fu3WR zn1b(zT1mPwv9=4}%ai4yqOszY!8Vk3--W%ze$%Z`y8`Hp`D_*dye~(E+8Vzo=DO#a z=R0-1fK0c&L>SJEf24eef+2vPBYnN}|JG;$*L|jCz;tH2jg^46v5zGpz!ncoXk%U3 zOvzlPTwty#IMezIZrH8id*Q0k@8`J^y!OW=&mfv~KOshPw#J;+&UT8U&}1H_@3c~w z4xpp1YskviHiWzuXAW}jTS@KZ^F>QwgH)4+8Er0wP74Ym7x@ru{BMJFnMAW^A!Vi9 z>NOWkdKAS*J4MnQbTuXOWz=DaLGY~RQ&EYM0J~9=ixk(S7a8D3HtwngLToh$R}~-! z6|~>XM0}H^jA~H)AdL+I>>wcoAtnUda7TjgRUyj_>BnJ5&WmH=VWpzrIW@7y}%B1vJ*8mz0RS?W>#qwN%x zYTeB08T(Y~DVNCRFtodFS84ab`8naRfh#W{(_EH$?M=&@1QRwgrX=3)4(|LU^o3F} z<%jM?Xwp%?(V4VEosKReF{|9hG`H!Kk2WmO+wh$rCTg!%sh*Wa4HA<|d&8<=9p_+@ z*7rE5m&cFF|LkPm^-sdrNhp&#+yl7pp3=ABAojExanz-~@*B9URM&cwrXHAw6Y5L)t zb1>T!X_?OANtmph;aV2y+;BBZ^03S*oF*?7Qp>5E1$E>%RhjF}V2PI{BU{t)`yf%PN@ZpvfHa1c!g$O=v3Zcr(r5?5HCH~?G(vQSp`9}Lpp^?eMimPWK z?c>&&o6Ov@FyIZ}gXS}DlK7<;P_z_*=oE^k3#w$LsXt`wwTi4sgzlNTtc?a@v*Ni< zQVemL0cG=3u`KN#?NZ1ISZLo8L8ihzt6o|}=$7~gwDD~B_yBGXNg%k%$G?S)N~F9d zcw6p4(v-S|SjpacZLHLu;nHvQ`Zy2w26uh|Knghf$t@wpi)3ct@iWTY z8SJm8pc4*b-!i^DN;sZkbmWz;Ziin<_w}h#4&=38}Bxh`3D`!lAj}I8^ z{kNe555!>#V>{&&@ZWW-U}nu>WaF1#R@8JZMCsd()IN%MrSt~5%-j)AJ4xP>I4Y5b z%zU`oHR*U6=e&dB%f+hVHgP0ObluNEN$O03VG%3RBF@1)q=nI9v@b~K9gB?4l0(vc zBug?Y{k)iP^=d6HQ9AssK0*Xc&YC(8keGD!cv5xWwA&xf#XWs&aMBVP9u1%wGR92p z*XU-pLUhEC1d|}>+pg3qwfdbtsLq0Y-w{(~m_FCIlyeZutStWS=Oy7*GyP;ZD@2v8 z9@}7nR3Orhcr}S*tDcM9Y(Ly!Ob>{9#a-+)$lh@*IpE`oh~(!hXC2qA#zpbUHWsRM zVu=i;oPq2r#-@s(F*jw6Q?76$9^{tWX2eCJNDcwtj~9r;z3%+&gA&N-G&SWudN*Bj zhx+^`2s5fEqtxFM934L=%fP1u8g~_H^(d0R3#MVY{n;@;iGr5k1WzMz)Tg==)wCVb zb6W!_+%xA$_&WcXHXdY=^4(KSv^gxmG2ZGJq?vsj;ie~0-v5Y@R896C^LjYTrI4?F z#L;)3RKk>_US=H)@ieYZq(fx@agqM0z(B^6K?B=O4-Gl1Hdeob;2#USEZp@wiNMwV zOYGp)4@p!U){9Q*DVUXxIg7lx{gnoasS@phI#qfAw8Z!;3X=%}lkps?_V<=nH&boe z#dfW?+EZTAj7c;NP77F_dwK#HSnh%BAcdJ?j0Jv`92E=>X#XCBPv@;p$oMtoeE3|t z))o+{Fv_i}8j;ZBeu?Ohdd%|Q-J7V;pvT}7h&0KdAzfB!MV8S-Bq!S{fFd+5*?bN( zXBXbHVyO9Q(D42wge{O5o=G=~&Ev_;%r!V7!IpL`@Chp|Jr|cOsET$xv*l1DUc=ql zt;>l*19rnlCLcqZ*w}K><@XqqJyJBTj|FD-l@a~W5F#+D;M{0)Q5EJblUK|1l7S|? zsGVzNkX|C=Ht|Gh4jtCQVv>-!x-T@01How4!n)$PWk$=6Ia8p>QJ;$?(9k-uA0IP}J}iKB4D}N(|ML!Dh73=CnBm8#Xuq zGZ&%MD!tlShRy~ss5JEJ+E-hTYI}C~JGlsmjudEub!$gmH#rRbI&h~GE9z}baMno-#(BZ3e+fbmlQ^AT3_uJH_h+GbCXUf9nm?|wS#23O9dd!{1 z7T_{TS#~7madntGYv9CAp=Bz9sawZ-HjZKtp*?vb#R0mL0wD{3k04bVT-=F^0pG79 zd4O7C#=I5%s}E}J7(~LDp})D(IvC2`S)-!1iD1cpYwq=Rm~!y{0C+9CB~c$;>n=$&J;)3My#z@=We*XPksy1_oY$2EN-^NUXS;K za+v`mXS6Ls2XOMtqtMu1dX174A>70J(LlMUm?4EnQYG-NO=f~f(ji? zUNdO$YNU7fM025BrSF|}p_}e>O1}5{PV*R>XjGdz#^O&eUgX`>{(ryMXoIbwaGa|F+Y7wMGxvoWo73;H!TQ$jTR<;ZO`b z6^|SvJxHwc8MSv#f6sw(k)8=8zf)gutqDH;D3# z$d_N+KGqf^)SkMxA_!@gKaYiO!QXq}J}L*VpOOG_Xd$ww=^d#NNO!!^Bwl)$QP_yh zC{nz8gjdrPIj}<~&yXc=73-|!;|rQ^5_PXr%@~`3RJ=uv2fGwGFGf2jD#cuhZjp)a z-s?}1o#*B(eL6!<$bRRES(voNp7hGuia5XSY zYd@y|f}DNcv3y$>21j0ec=^^$mgcUT6MFQa90CCgs2#32-AE_G!iz?8i05}f3S3c` zo+<$hdi`_X_kZ(jA9M~P6gv8M4TwZYs4LQ(L;-Du`Si(Lnk$2~qgPc9pA0Ld$w9te z+xw_iYCdm)dF=hX~|XWk&H5;_z~G<3MJb0g^{!VreImy|LXh=ma~Ow`45gG(}A*o&kqKjEi6 zD>Wz8&>eb$d7|Pz*aX_LF3%Oqm1t@@1NR=fL88r+ktaHbE2?B3mBPzT^Lg|rM^I+z zw#5Wqy+Lw%s8ZqFGI!;es3)NYCSF1iPFkn$>-hX!ElQAm`>itCvk!mM8{na@9@|6Sg{VT-+e;kD)+P~y((Xm(}F!^{vXaxSvrkQ`v#G=m&{OpZ7 zE=C&=yKryu5NNzI^J8C7a|wZnLJC9Kt(o?T(B4QNQ~9fu-@F|6{q$J6nJ2Hr zHT#5~Z?!>RfSn_|4+Yq~^KG$`7XbU&Z?@Tao*RO5Ua!jt0`C(%a4;>1oa zH{xbjLFrKap^Mg8$MmNVA#BDj=QsNEbpGIvyDb8I#m3mqbP{j0{Tt3d`>U2TA{$b_ zmV)da|BAN^B-v>9HN8x*&JE)FNj=8A-{Bt!Pg@F{U&vRYfFOfyC&l#Q3f~>CozZl< z;!b+IzIBNhC20l~ds%1ZK5(R^n<{^k)$u^?Ce)w|TOf-mX!yF!qAwQ}@Z3$rEof73 zzGMOtUl*owzO+}tXyS{nSCs^Knf>*?5RKl|-)WJ{CCaa3eRWQPC*+9+ab-uaD%TtM zq^tuLCUgB+`z=>k29<(K1X1I4GTEmr$>`iu83c#B=osr3FZcd#x;{Tq*QH}kO*e+ zi4Y&GK!2VI1$D0lB;oo?fu#XDD&;^&8G`b;%AA#S4SPrinx`?RNsR9V!=B3HmZHp0 zU{TQRmKOgAWCqUs`LeLv@Oj8Dzi$y8=V(gz(Q*$}u=B^+V znlbM{UIB`(O4K+$YZoRD%a36TaJ%Kxp>spL3g`bY&Q|?}_RR14BM-zxjWvvTfX>c) zn6+eLI>~#uAv(@h`q=Wj(6Ed`q86n~Q4RxbAAe^RDA7+1iIu|>SDBi``)THauHM4| zD=<{i?i@Ku=aM6cZ%+`iNgHXb-~*J8bT{003N3T*ze~;a#pwMeWy=WxK9m>9?pY67 zUVRI1hbf)YGWc2+24DOnRG?;!!}ObJ14cf=^Xnbcm-a=`BMRy{%eC&H&!{xJ+;$%3 z8)8|X-|y~fWuyl8K2teB8rY0*vp9rO-8`nB=5tW#7lz9&)hFYlb>XS)FH#{Ne{SvE zWkX18mf_Lk8u`Vm)6`#pHu86dDc4?R zRYf6$krdHGHSAxKVV4g>cCmXsM82ukV*?p=bSv@Z;csx4b;PAawCUfCN(aYBhR^R{a)@fL`1a~V(SkV~`nHCBbzZw6)+boIQnLCbW>vM(Q zgf%sxZ@{{+4ld8GL_h~oq1Np)<%Az}368R}N-^2jw+?@Z3-BFzBQlg)Que*;lMS&$ zZFnkDK57|=dfci2WwBEgeOSP#ni|SKWUBXq0^4~;Vbda@f}{t)BtH#6z8&TpgoBY6 zVdHVrgoOd=p^C1KMsf9`8IKk}9$#m6%<~J=qa$AY;u66mhMen5PcVB8Zp{N6Rz!8( zOY`}O?YYXN&qTTrNnhOSStCr09R6%2Aw$#4huq-i)Gw8KOFeP@dc#?}7mU8|SSM01 zU0dg;9HGO^MqPCKMU_RBat6IL{c*+)gOFtushKha#6XYkiGDNyv-00FKI(Lh6-=E> z93YiQ4d;J$3BgpN@YRSj@I;3E9+scZe~oTKCSjvA5yWk+9Yod9JM7=DIH1RkV{3%l z26inIp09#S^YVv<2R>-TJIH*%~{0$J6;9`Qzj_82H(ks%rxw$uKoCm6VFj zP&+r%BdvK7q9up9=GO^&94q{LuK7l?7*72CWr7OX%E6&~xn!wGmkGV_QEe)@#*jj` z5`bo)`xmion=*GMuVJkDS5_?-BNs9r2QS52pWHQnStlV5P(bSSLI&4VfwZDm&UnaX zlf%dSv1~c2D8WxA+v=^nWONet8JdbL(jsz^?lMdrO$Jo}BN3zvLcFVE@Z`>jWiY8$ z;0s=S6WpjpDqYZB`bR*xJ(@%LClJGb^g#aG!~?T`76~LOMW@p~d5Y!P{^gTN`Xv!9 zR4m|@b7tXZ2xWiWo-YkwYn=kNH$R1v9)9r3xw>h;yvZE-F`|QUOzC$BerxpO6%Y<; ziF6ZqbL~t6vAj4)VNwuFdpn(bLGN=3#3>wD`I}2gQb%T;KEx9%%UwV+yeO1BS3)z8 zDL?A&O-&X4nf{q6n``$PR_i|^G+=K|oj2)n&Y(kxNOS(&nPi(ISdi;aoSGML`6;WV zgGw~eZm0HTW3*el;a*&$`+~_fqxlchlm^Hse68l?ZoKE_&(7tPET7Pl(GjMNRb$JR zZ8!uk8nn#$%7J+1?MD&0dcv|R1{-kIdO}cK?W#_3`v10!laP` z%S?gh{qZM+LU<=6BzTI!dpljUA8hzOcAS4d^=epY^o3s+bMhbf?mB7cTidm`3f>=i zTlPhQ77L_u#*3`@rM;m@@fGRT!&Icz@jS$iL9CbV#|^T1=%0Ybo?`>nxmWfjvwC#F z?|G1Bf>lFS1Tn^;-_Fq<(m4Tx?t;5}(uv7JUB=RUeb0Y;>P0^rv*6YGqgR+#b+>2RHfN*>kmlAB&scj)?JX}Dn!NGQs z9o`enX}r(}`TanHtta*Z?RM!OfM6Uby#ByixO>&}+BTiqiK+oK)vceH_3prhc%4Fo5wXJ^$gI z1nA!b{Rae{_7BZ)=*RQlT&$236fOjan^<+g-zHz$=n6MvF)xnw7`f+XsHqo3hp*uq zw4@V~==28nAgO}6@pv+_Oc#GETac_ZJ?#c8P0%S-$7(Gl!P%b1EVsxy9wq1Qb3M0i zY;Zb!7iMZ{k>km`Q6rx0vN1dLOcbV}WhY&K|5-($^M)GxN9A6$v40G`>@_ z*E>(URM4?byQbp0e@5+hp}ajwN-mP56bQWuiFpdobVCAs^@fB0P{wY*Bmr)6oIzj! zB!KAuJpZ+4(2wA=($E z0!OJ20YT{hCPxR5i%3l3Or6ZVr<8EL@@j#uxqBG@>>Y7~E1_3^(xka`vX5&!4}_Y&1-e1b;P>f_LNbCq-XjEHr1uQW@C?*XmudO`-PomO6yQfTwL|TW^8#Xq z6ap`=v=6-DM!9(_4qBni^Z)-fB~jayNm!-BE$untD%R#w^?90QtT|`aEP;0qW;I!& z;|8Iy@D!OzukVNITs^VDF{Vxw`bzJBr-`XyOEk#{vq&j$-H8PFex&q5W@cydjWfEl zA0Lyh_M6#?4IajlIOR}E;$GoX@yOk_b6VgCgtI|F&mU=IZ>HOGBbBnHw%Mw(*{3zS z988C$Dx(0sJm!|#g}cF&hgId&m2||Zof0( z$sgOL-k5e^IbZjSm+r4szf;ioc4K7ZDFi|%ltd4-;3Emp2*nE;cf#UhyKgFEWCODg zFm!~I{}BlI-~N+C`8H%|yh;owJ+Td3X2C|aT$`Wt>r9y?0B3VD2T!@021R9CmGL}o z{AHu*+%@i98pz1P6&*xr%J@CShCw4vhHBOuh_1UP@SAMH0i(raKIxb@=$CUc_-r-X)%N~Ks1VBETL%3f64*^(7L z+*$UNx8B>&@M)##uVQh$KLA;9>RHuj7$iuCeX$%KpKj3`-{AlB$iLT7am<4)cjMar zV^5;FfrL)Uz){Pq%WV&gR0kU7^l}L8$$Viyh=8$#N1&j%rlu5;Nk=a(Dft4AK7opk z1ZlbkIZK9sp4Q7Rq7#e-OrxypX7v2v!4~@;67CPL*O;9?-BOXw#(UlTa&mnh(h=@e z3-elu<-ChG>{Q1y%rEH|Ge~37b>c%;6-n6&9FBRcag-jam?PEI6`cR@?(b$Q&eTsRC1SyEJCbl1?)`^+3vzoX#%^mzcGgn-2nAN$BlW?4 z8YJ6XUARL(S9NC=R+E-vdqE57>4}*nB8c~z#e zmH6=J>)ebTRlMrYv?^_T>V|E#LMoBycgp+(-Irx&*ds>TT7dZNtp*k1&+fTW_;(v6 z(6P5RCA_oia?cqdEzf*zEx8hVeXr3XDtA0qDU{KIgWe@C9OOmlHo`fPIj&@$ly5JW zUYa;~1(|jZzxAV=B@Qn?WJL3;Ytrm~{@D@VL~+k~mq4FqH5Ia>U?cvijG#ulSBt}d<>6)jM^8+1Ryzqr_Z$6vQuQ=F- zo~<3ab3&Y9*IEg-@290KQEVm&BKP}r;R4vhjp~&6e5-vq@qFbK;9!{#rI_$~R=&qS zP$s+BI`GI7uaFL>Ov!xw_seUH{eNYwi9KKFznxaI`yFtbP<(ykhMZM!2fe_->3K*b zidf(z;s~Sd^qQPw-APcz=AHiCa7GP}b-ql;Bj!O}v*6f$t4DPxTh1#G(06r(KjCV# zvjRJO zb$Bf}Hb9S%<^tCcX)_MNHOb6BV%jn6^qMgVl!d}SC(}~w)b6N=OGJp_U?3n#BM+qE zWXceM@HX16r0EKVP8+fXb-boj41wB6rxPQBQNhYwSDtfMa-HCQi67ZKK@;388S#gB zG0UCHxk4_`T&0~+DQf|-O(x>g8s5l=VPsZj=l+y`p;(KjNc@PnI^P&Lq&}vaHy;sE z9X1gG$rLNDmZt1OJU6W&3A`Sh4Y?r1*i@VkVF<18p?HDFq4@)V?&*|a3Sw_bJ+uP} zL4W@(JR;h#*F&t(d9(@xtqaSEKi)$;f|;~Kuu8?i53-F=rsz+JOYI>Js&D9+&sye+ z-viP1rv_F76o%|5EV+L9=D1hiHOr8FB8++CL9P&Y9Es47X1?~!wv$?%r_TsjW7he6 z#QTf%(cdorg<3_vcxZb|JPP6~^pqe4+$=rb)?C>m7(0>N*3diitaMYDn2|;xmW2Yu z7scdtFoi~b*O!>VeQjtSOBV4^DiH5+%oud%YH2nkpZxTPT#VA}MSVHD9T}RYqGgU) zHej3G{Pm2$Jn8q~l@8+FuKM%n)??%_$IZ%BhN$!Yi!bF#w5NYu%FhVnr;HJ{fa%}M zcYQt!-=dmh8_SYGY;TR6BC0BrM#gYJy(YXtbJ zu9X5B-7K@8rG1C3PZap8KUJ5>k(8*%)#LlIrrBxv#4xO5T6A3kt21M+XF* znp2XKGa<-}amn-sipc=P*aDe!J+A-kfs?F254@Y;E9WV})=aN?)y;?-{!RajpBoPw z0oOtTJ<{UhSU|#m+jod3s=A79o`3>*lIxpGLF+_>_5tu2S!mH< zkhO<5%!y=uZ_5Fz8g-xZIHNs}PHSIbWkEN4X#PwrUIa9|Ph}tP!gqGvn5B$<=sgL(;%1F2fBXIdb(c z_Kp5)TWn~92h>@e7r@qOm*a9%1li4yi-;odC-RL!5$k{_IlNanbKy|^2A~S~*Hf@) zd)g}!;i+^X9rf=)h@%s9^7bK(Gbh&Fr>YM7cNg5}gAf(0Il}1?du6Nf zY|OJ^pUT*E&dD6@O@5jcntF+k%ZWCa|AqKL%${uq@+yz5{C51JPiHqaHk|BIYwgO* zlEW|WKGvR0CZ!3*AB~uJxjfKtF@6Kc20swf#+#3KwBk~16&O{9I5IHkT6E2U-=N7_ zNdNW)EOS-3$dIuk%NzRTMx07-ti=>?D7h+9gBRzCGI$0C&E81{Z+U4dZS0@N-P~`o zc71h|Y@9EQ@NGtg^x(huO4IUP+7gucEy%fjfvrSBV&g;4=Li~1KGp6w5FTpE+mH&I zSeYv;FHHFCl!pa!t`&&zvL7XlO9K52yLDEn=fJ@NKr-kk$@C<;bV=QBivC1L!zy8_ zL`&0q;53=tgf*7H#`B)rMt^TyGe3_nZ-~;&(NEco#-W!X;0m?Lh$&n|kleW0sMbqx z+B6X132nSaEgL14-pg{DZtG65MVCZe;Dr%Oqk>;Cb63k0e@{p+5mJy}%KfAy=^63TV;zB`jWs-maY=%4ssuHm61(HtB8 zo(f%N(U|pENR$y3Roq zqwN-X*&MY{p3xiylO7e~fr~l(Y&7U11K}LR{L7{1>RpMf6{(i@Co$pue)IeL`JCjr zyS>t95i7eY14;+IITGPSRkX^z&n1pG9r~z?>JiAW3n*nuF5i-hB{;Eh@}=gXke-Eu zaae`X!m4?{=rBbiE0e(`aoHvS{Y@`&umR?)iks1uB&%5-X7@YsLk#kvDLiqH{1+mJ zHph%fpXVIm|JG&LGp0lXsH|SvbmEa2979ER4Bsw;fU9w#B*FyrMl{ZMef4an&ew;k z3Qv|0R+7I9_A~Elxp)3<2r}iRH>t!(4mHG7X3%AD*mjpw+%IT+kg0A<>Im8+)@qNL zfZEX^5G@MdM$siBL(oE*WIIk!v*QyaBdBnev!%(zbRtva#k_t!j`R$RuHY@zh!qqR z;~!zs_I7QSQOC}of&=1`3p1?KQ!J99g6I%he8$axwH2XxjPYBen=%Bv#h%<`le@uw1(;NyRCOG=7 z(j0cabqb2SC`|hnLCpN)yfh-5|6`EX?{p}*18hHK0_pmJ!-tuO(YM4gN9BOc6Nxun zQifStD#5A#V+wf_jnOuCmW^b8m z!JW$xpTgJE6}@O1`G8=B^-?+KR$3J-=w><(6?)QSU+E-cy37@@pnJ&J@Gb%$c4GG} z&%wC-v?M|3R*`^a$*h!cG_n4ETu^qeK{+;J=irnX`4N77~BY+CE`>AEPbbk3`3z z(ywfsooTCqZuaKo+!P|OL=OA?g`6)#vgncxDzYl5X zi=;|56ldG4&0+H{_YijpUnIggCp`37Z8o^TG?WdCicm{hNUbjL$)ct5nlMdB>!AV* zrWBWod*#|%^TY#H{ILS&Hn&1gd*m$KQ9Al>wZ^_>{TMC-LHv2ml&q0gXKTwJ5SodV%s{0apdgdTq`oa zo9f(3B*nH){P{8g6_nfZvjnI8r{1tq%A8+aYGjb$&PYrmM98mPcl%D#9q2LG(A5MU!RNpzZ(b`wJTSM6nn6W&g z`OJIeVG-rdMukEPF0blQUue+LYoq1TmZBZSk55AW!lVLh7YEP`sA&sn=8U5&sANT( zMb%V)AHBn?3k6lgy+zh@j9^@$L3Y+t^UGrZ$J@U5ApVr=LP$9B2TQ!lqjGTpuVx}L zqGh*2Gkm9Bo~E3_pwSB7fC&DMqOTpZUyn<65Ap`m=FLf$hNdox(G=dTP|Wvrsh&(z zvC?bYicGT^>51J?dd~<5A_}e7dMAiIg^2X(tki>^m)FywLE9 zLk9v*tXwfhF~P+GJDrHlVh&X5vZ90Myy{NWFWaQ%iue(pjUEA**F#HQh9_}u(puz{$Mrtl{InvgD80f?)BoDocxpXb_^Is>#2_eeycA z)r}Tt;}Ro}8-aQi?zA+%#E0T1vZrF<^nT1swd(5&N6gx@s8X2c9=(grp`)wMX0O=& zx^7=ole-Y%B+ehK;`+cqEK@`!HBopdUKJ~bDyW}?s;TKQN$rhAq0+YYpBIQLe~coA zHGIf~MiAZZsNA7eO3<@Ctt}N;pICP4X~z^6OPpfON}BkOa}>XrnoGDI zN5ZGragaBX+zSfX*{0^uKc|P0k@sg-XIJHg5F3rqde+p(4TxF3oBz1H)h_auCgCcn zG45%kU3K2#7<}JB+*lF+oapO_^QHV;6*7qly!yx@A?ezGrM1=P7lSTYB^5h3iP+^o4z3mvhyCo2sMK*OSm zvnxbipjcwiY>&QHzy7z=dX9uV=bHx=rp;;5qnkM6KgDsgO#v~^knQ3{h? zDyXS$6QFZYl)6=+b%6jS@xB-5er}TS--Sfj5AmV|ZMy>5c|_FcFk~<5wjc{@+;BwM zhK^pfW3=zyR_0kc8FoP5<|u{sIAzY|B{Rbs^$Jdx8^v9m3>m}m-d`)Qb0Uy-;$(5R z3RvzaTws9Bx5JK#=h0F23Z{MM11Qllr z+g!Hay%Us~rE(>mF2Pi)1?U{L@f;a^wu(_jr^)Fj=*-nb6i(V!iB=22w@k>PUg3Zdm@kU`T$W|4HAzv7nWw)iVYpnBoB z4)`9EFolsrT;x3xmVnlEo5y^-z;mXPmlL4<)pj+uG+NOqnZZivtMpqomEEsjB16Z- zyHi;cA7jO%TLBh^EU|5UEz+t68Ztu=7}n~V2~%A4C-t#Fo0ymcKK&G!Pgc|LId?V= z6mo|{AX+ucI^vkQ!cy7JcLzHRYH6)?Dr^Mj;&1Dzvqgre7s|=_e+%*nL#U#>8hDOT zeFB=;?QumLtmDz8CnAt>O>Gd4qnF@S)u6&Cx54!XEn%;wetC==#1^J4Af5hoJn31@-pY2@i?mz!A13oad{w2RBQ??8*ca5>0S% zfL!GvxTaS-;C=DAV=OTPTiRq!1X*W^M12#dNX6;yE|;-ogFiKuLVVqR-J%wBUjI72 zAx&#|a)kJEI3ZsdSy1<{GU05IB#4*vqZgxKA!fx{qTZ@Eb6u7@*ELcvM7Lq)wS;j> zq=)*Yro$nx>#khg*4>}7+qI$ExBB$pC+Vd_s1em;rLTVsPh&oIY8)Qwpr_QtFO|+<}0xs(M|R-(Txv{qTk_k0YU;Py@*c|U}6et zH>MK8>A~4D&UrGM_bKF% zI9c}BU=#u`-%JMn4kot>BoswV{%OogK&p#Ghfk4x8J`KmcNiim*pYG9nQk<;xelho;54o)n$k{;(2ptQD zXg@;}ZKV@AkKIRi`&X_1f0oNl@yGb^y({cf)6VH4m8hR#ycXHv$7}fha6rqPM&xf! zlGm9ELk)hwC6oV}+x|zH=7N>X_cN#xJvCp5xuTEeDi30RFCqcyzPr|X4bdx#LbaQHP+O`gD%Y(8<*m3va^PKxa z*DFH8uqtuzo4Ou=>REjHqN7^On0*Bch#cS^YZbUYAltNY!9Ahfvzx+X3m{F% zi$svzxVmaQ`+zgtM|E|e{>!k_ng8lMlFk9GN79hbB=l5!9Z#j^hHmNg;z34hQ^|9i zR76R$a)kM&)v3~4R;gUfg5}RoYNz{mmb?*;2Ts~X%i#zN6-N$aH`?Grq3Igz?YYi@ZOFCLUCika-5H=>3@aj z>Ho5iL*Mz}(+DxFzq`;Oglksd66Kekx!S-lq}3=v;iI-OW@`Waub)b@3S)yl08bfe#xGsD($TN1~ykqT)dZ#vvy7W{VrId=UEM0YZ=X5YQP!h{cTm zlui9d@^NsY5XA_s1)|+mrR5h)4s|X(MF!@1^EZS}Aqq%07RQzZPEA+^U+!mzGCFhE z(0)t19$0L*;IHg%x8?uk{}Wip!wRLnr|1b~$$b0Q3)Q~&#e$Sr=oqQhyM8p@z_)9; zUjWK)WSWmWt4bEXu%K^M7Cz} z4LtWH?~GXR9E%8Q=3A=S*tn%pUHCIY?e6z--ZmQ$s*ErgRp!g|J}23k`kqh#)JUtr zu=oCY>XY-B?xewSUxj`gQq0n*Pt2d}wYrXxjTJ3T&9GPSgUMP;^>UXl9*Yr6tP=;| z?#_Mrrzfk&sm#!aWO+Y$VaJ)0AB=xeQfw#gaDL>J*}u|gRrkSjNX(l=ZMzjDa(cXU|K(I2G4zbB~CE%xss45MwxOb4e4Er;i<_S#?_kf` z0-e}p#(!V?Wk@KvoUSAE<+SJ$|4!vH19p;RGPJ4z0Lb!Sw!ugPGx;ulY2QOzNltD- z^VO~nTr!iYDf^vm*fq&PN<^J$;V(8-#h%UMEbw@~<-6Y-#F@dNM1hET`SRp??I5=W zu4rn4mf-Y--m(Ry6Z36jaZotLMD#|#BBNIUc0G`SaKHq>Y)-KF^c}%}{OrHwP{`qu zG85yXrJTPy5iJ_cz5VIzI1oyMS-SP=JqQX`CXU`e*GL%}Dsb52(4^OA#r(V@UBm|x zJB+GRr^|i;@g)o*%m%i#`S>ND!k~B749xC1z#q09-PA-$>k)cgsAD<5TNvL;aOYgO zm8Zj9>ia^~-m_iVa6?h{I1Ol$8Lu3>lMV_R8;{ChG4m04l~)A4^fOM@;26n2u_7bm zn{0bBBNGdpBJp-Zc{TP#wR9=E5g5<5giQ#l=6GK{X>gx|R(tD|6$Bm&gC=L=C?Nd0 zVHFhIcJgxBrZ4=l6!}8Wws>+t1->sSXwGN^hfi@)!mXd{j0w)jzp!7LaqEsh@}nlq z=iQtB;+!PQ(e;nW^xD>h`U9JJD6}l08R;amaXb_-n(da(wTVx6N6NJvfiA738TUDn z=a@Iczo4p#$hzuV`a`a@S$^{JywUJ6VsktF!UW%+hzzfaXvt*%kF0l$ zjx74teq(jV>7b*EZQHhOcWm3}q++LHb;q{VVaMv&wko*!pZC6Z+;h$zV}GeHdyHLc z?KS5!=X`!&v|yHsiQYDLUjfPDxM7_)4I7emD|FLC{|pkG3CxyP>`BC+l(n1fD&~I< zz!S&yilGXGEmr9jl^>~Qyy6P@u#fvbUW7lKuNCCy2U%ohMtb!qfdr3cOW0~W&sPye z%z4HQ{jMeGjfmcTonFIVU+zzJE^|F2t{S{=58TXYM+)a^y0{$VEpzh(eDiJQO377I z$eKv_1HfGs585Tar(J8ZwI5R98#&=hVo&Dan*V%nQAv2>tV-+-sB$GnH;K=A0eh@s zT12-u>TrpEBwSp@@%hNUch}}|fsvicts@+dI7WQxI-A_}eJuAN zw2y8))c&Jsmn(p2c?9Owib_GB)!eSYROY7G>y>WPaywurz&^daKP^X4+vfp4n$E?E zCow`vAQ_bD(#y-Z4fK$zs+R_t|21MNq6f;E6~Zf>PK}+{`@ZUR&caf zMYq~)PuAUN8q~`B)w~#4HNQK-%j!dfc;|gZcx)fd#Pv&9Z@Ui6D8nb8@?C7kj6~QC zf&PE$p&jzbB#}AbQ4{t1bEwTW{kExMQt^Vm!{855NHHCjOXmTc3A&MjwIHn={f*?6 zE1UzmLy`qTB#t7 zua+uy@(T)uC8biM(8xP+1{+r#Ueys`jg*_5`>8A#&(_Cz@?&=O^FS8WFL1B#7SKhM z^#=O1CZOe}gz25scsL?QlJl?t3O)UuvLb<~e>Q>--gV15c-!d#v*Q1h^-m(T=|E@D zr%3|&1Fr~cea}#V%0vD22_qTt_Ozsh?pn~GpBy5Q@840^Xb@;qxtcmpj!){qbRjXm_M_)T9v$HUUOq^NS-udJ0ac+zn4a!7n=2&`P%EAJ+hDtG~ zxBm6D6EG$+(y?ZL^PcOuG1h7G-RowIipBeeT#(Q8;OnBs4;11Ll=Fdb4fPZ@*lm}E zou(z--M7ch4pH;vWGa!_2!FdzHpa7Imk$e*qWVD>5fiBj)oB(LO!kOx6LPjWO5lAC z$^Jx9b0Jb{I%B^6!B#PM0G+6r@-%)E2fgP~8!+7;s|_CYiYN*~*4!cCa^>f2=dH4` zd+c=XkhjW+KDR%ToZvfxlqigdh75YLPjh=CE=S=+w79)Do(sy^$R~1z!d8qzSprWn zI?HOkL23IJOOXmGQjQ!+7Cx|a!nd&@ey(Q8JV{oS$CC&tII?5Bsb^JD z$*92s)Gz&DId~Q#vmfB4{+-K;XM{o|zMlYChF{~OJV~to0;}1ta7MS6m+FmrVS7Op zzH@8EGrS(>)>_%x(l485x}xTN^QJ=y=5gubCer#DM<(_TH`^8{n$KF=-Wuim)R# z3l5_&!kO4lxx`V4l0Z3^&e<{YzQB?Mz0ZD>0+QMsMBv&r+8r@mvgUs(D*r9Z+Vq9m zTSia$xDHV7SwrO@?hcJfCyM0Tg&2q0*{k%s)p$a>&3rVX7q(bS-^Mv49^ao!Wrj?3 zbeBAzu#trn9Z5xU)DS2}J?YjV?4I^X-7o*ni>C2!6-nfV*vC@E|$N4tlc(I%*0^O*Hux3w}Bs~>sDL2OAMgp`Q}yuT^Ib^ntGGkZs5 zqr8XlIApi?M*Vg8`Z2M0A1^=-7h*v!v-55YsCE`Ws_`ghD~V;@Ga}+3KtxN$n!k4x zhpp!o=cdQj7?&eNHoTNE`>uG>&5YrDw8+!bB9X zg0MvRQWt%V=#a)>uy4}UN1V0Drdhrk1#a=lnYfQ6(2pnaJkm!s4MoFeYUEPK%WZ}h z?_zN!0*lX*K13^xuq6DXVZGoxP4w@V(vT~54ah|^R$@PV1w8%+-RIfZz~p+6+g@N4 z%83>v&iq)JG%sg|lquUp@=k4B4lP;{(O(I`S%1`9IXL3+6T1zE-mICMIhl0-;CmxduQMWiYI%-TD zp^|WNLTe~=)m!6qFo73zb<=}mf%;`kq-pwS%mG6sv0!lH$kudBmJ3S}$@yvt{N3bv z6g^|396nsGL{njH#=kDM;g6dO=0s=famzU0J1*&y8@Qcp4vFDX zbLyO=p6fc)jRaVKpRI97|ErbHTD+LJJto!j>XVF#DF;sgDJR8bcz;`wjQ`_Faw)V}%TEU2amQ~IAxka-yQ zHV$$C{+E}oaE&6tAuAD8Q%O-Tl%$u3{uuPndc72molF*{$DR>(zuEQGBXftV)I?I7 z5%nKDiSK86%`gqTjYBvJppn<$x7u1OErOL!7I|&+KRHaPZ3>AG2gpQGg=pK_w0qO^ zD{Rp+hp7wPgIAh@%d5@5KcK%Uv{!;Qs(Re=>jshYncVu5m@{m$9ENd|6U-Yk=(1DcRRS|I z0GG`qS7G)jP6?yFX_xPjMl7|dn|QK3FtpD*?{feh;&+sG_iunl9W1~j?FqO1;w5Ror z6=n=v`M7>D>4^Jof$SnJ_)(wLG35r+=hY-S0xq z+2!L1@v|sGdogl9%DuDejS+ZkX}Ye?_41Xif-#8ORX+LNiL*EkcuSF?w6WLMa9&JU z1UcQp#cUhQ9hLQclwUF_IR4q2uFHC9oV=o*bH%p_iBz~_Z|-|uShJyo%hhkxzGW{i z!dVInNcJR_!Rh<0YfH%|{di$xGs!W-j}4?5Y(duGR7?59XBML$p%m4n4vY>>O^K^qh7(^iB& zwbTyfWhk9H|IaXoo55eu)Yz{OK6i76ZJA|ye5G%39L#V~0p(}6 z_Uc#`LiCLr9rVhl71S$5)3^i$+M_h=X<{77HJNz=Pz;Vz!Shx>`6lKn6Mg%ZXLb%1 z$gPYr%wpEvyIf}$dKki-GcjNB*(#|)Ct(*Bn8^?ZJzzDN%NO~aOr^ACB?QJxrI1T! z6d6xrxE`Y-HhVbJ`6D9DDi(#7%_b5Q67pIbQY4d%gWF@YfJsGlTER&=VB~&sXIWdl zEC5Hy=doAQ`xu*?8~=}hOS9^p)lb`ZrNtF{X8ZdJ(>Em{pIKnrwHOH<2W(9YA=SgV z#Z$Qj$Uh`3{=EM(X-+5dujC(!LG)Byis!>)>a<&qa)jkJ%Wu+vXjh-|z0*qCa?z)q z#9?hAfkgky_aDd$kX8+>&u6P+m~}^UO8u7!`^5f1-^hb|js7ZmZBJ`I4_QA6IPi{z zn*%-QbPSU`iCi~MqUT|6w>-1UX_&tJVoZx-^E23Ccl!NH%jAzO!@%Wla_1u|j}wT7 z(yYqV=>TUYPDJz~Anl$wUmc6s!HUyD{?)vUmwpq$rEnXl*`Z36k6J?FN&Y9RPO{9j zKzQz~RdI;L1c+#8wc>h$Sav1Gvn2ORfzcxqf#BBx3L}bLx-R8jpi-n7XT#Z*Nt4ec=Z)=9pe*A?;1jryWmj0+C%D;$&97JVI2= zjvO@|eZCK6-7S6&nWI19H-<}?5sI*|AoEdhQVq(v1RmEIdZyMz_$%fJ%k^_vdFvIf zJAb4E&z{!%y;?E7E}FW&lRaw~0ZARL*(sepF)P(P=U zC+JjzGR&fax*e*||9K)=o3Y@pxv?F%o}UgTO0~GQ%Mr8GRI^7=J)7DtgNG3GaqUSi z5SR7i;>{d!O#(w+x<5V%X9#J{0PrK@c|Z!{YS#s});v6#@lC-kF#E?BbI@JlyvCnw z4qMILNv_Q;u<`ZI&=13BylWy8!&LW+_2_M|sBw9><)l%t+=GLG05I=ZVn_c1{p)v! zq~FyQKgoH6Hbj#Ym0WH&7+ev2?nr7ceu_Yn()P5&ftasqiK6exFfU+ zK;B^fvFARHkId&<{6Ae}@9AB(!PS+#bHA&Pb$2JS7Myv{EB(iH8`+xDPRjkQ3H68x zV^(Et>q69R7m!FvsB6%G!Wg1nu;Ic0a>#)JAXg29sUcv1jyy;bw}4tS96++S;Y!^0 z2)Yb7eNT6t=FLMaiJ!fgZd#h;0iQKIu2_LWPd}y}1L6Mf6#?-~{S9E%^Z2c_*t8dl zMml9Ligajv1^yxt4NCtvUw}IA#e3e}GE_8+_LFL}t6vNs^AVO|UD9|pv7P$Z5sLyZEaCuw_4EsFtL1HiN)ElV2mMd* zfRt~si-9tn2uYv1rga%j;rlbEkN}x<90WcmTm@-HE^!KurM3%aY5kELD@B3%@+xkc z1rz*!-F5(65`ir8l6#5S+inNBesL#fM)^3@GYbnFz>E#*m9*u}I&36|_x%07%ArLJ z`Pv-_M`7){6dHg*O>Ocb2*esD=3tLakZ?iivgq>)@JA3?53mF+T6k{ z%X~(?2vseiJt}$M^19PX(9yw8@nxhH&iG-w#VnVGl^nH$bGDW>;PPdZfL$0lJu+L*l)oT{Y)+K1|r<+OuByy5+!yZQ2oT$0Y| zjK>PC`@|}y8sIJ^QU*ugAn*aFsF zsm*jPmcUjJx$^LiZhTV{(j^xHXe@9k^0+34h{R$gv)<`QtRA1Hi}w@aQC-*Nj-Oa> zubNZzrSHsv18DseO3~p@v~%ZafM%(xJfX_xp4lw%wio#avabs`pkL6(!=nL z1e_cZA&EvjzP*2qJ8#2NDeU?bTb>|IEmM~U0x^9NW)Cc)KT%PZ%!lbflMZ7Br0cozL$hJYQ|lU@owubRd?3! zFJ8*iEf&c+_-y?@Axx0yHzU5+L7pT)ep(@t##DFeAIHEyc>to?ZFVJB>MhvDe?7Ig zG&gf@Pog17NGq1_h<#{^?oAFLEc#7R>FwIo&$ENKsouWsV5PcDu$mD`N7&$~@%Pz= z9&GL!*0xSU+1Vo0{hLI16>IA4U7%ehX+EI{(K&?uMJ82^+OZ9DD*u5*N*Z+je#j1l=7Uk`=|a7BwIzS&B*(qLwUKO$lpzFRxlwYlTv#n@64wgiaca+2Qh zySu~X_`CCblMc&qkB$8IpK5oCMj;B^Il)>4+96))BfDv!P=L~g;FPZ@htlBZztpY) zI~%|~!L;3w-zXDY_qJLIfF6awBC^^GHhLw18Cox9!NO*=Kx1KZ<$Yx5;&KMRJ}V;M zvGjTkAal*Mh+SWFkgM&<8NC!XHZ`$2`J7e>rTqDWWIv+L4v;@07H!S8AJ8+$MxKOJ z07>j4sv2DLBi+M8Ac{hj6cvT8ou5b621rOM9VH>+L6*X;weiJ0nk&r`oX4O?aXla7 zkmwVOo{0dw`f4L9kfOG!N9XX~dT1`mqT~yq{{Y*RG2M1w?tl4TjIastVc-44B+D)P zAcvLiaI38d-XO^2dQ6|YX1bZ)Y1u+mlEzoq3pZL$56+(fD`zHCd{d8&YFu_6 z5;nCCd@y$6x==vx1bAqs*#;RNBAPj-?#!#OlNoXFDCnY*!{OpicYXG0eN7#JoIfw8 zFM}VXff*&c_B^megR*5Uy&{a!P~1daUmAR}%?}!rl&w0$uL->|j)YJTgdo>XBf;GW z1J`gPBtO9R5YmKJy75=%MpXIfO`cBdww&&}+IVfEnb1fOF%9JTv{ z;|4jOZRL@G%ggc_ZwvYNm^`J_F>S4(B2bCZXLlv`Y!Pxwi{1m}KOAa{@{^3mEkK1> zWz}7`QIZZo9LCiX#nx>&&<|gb860MI{3?9#;R8I2tqIL@%IMKU`cjN_TL2T)-SZ`X zbtRJBc0oE_^NU4-pb*7zvb5#-rm7U_Z`hM8GX`+J@`>@AuQK9f_ip4J&R>o~a}BiH zzv^|GhCW`*8sx~ov`mp}8UF@iA{6dpj?h6uQ6y2^Ix{`mX{T#rD%fhuzN;x+U6Ofm z;_%8!nUSY5eU`i#C~l1^gzb0CS~{l^wGKEmzL|_YX3GP7zWpT zw{DGM+oP`bdc!qw>VQhbk~^0_!jPGWgVq~Bc%7n+QydPrFN%5n;d4aljV27jV}rVJ zi!s`W0sC9?R(H2NOFuB9c}IkO{W*1?(QwEuSqjyVOscGQwakY5NrUJAnZG;{gm&$$ zFxHGl-{2N-r^^k$;>r?8_ByNRh-Sr0zpXU^9r==c@kO<=cAAm6Wq*T2UakagItv=~ zxYx#BdbQ0Nh1;x_WGfNJ{L*YBK<`FG7*5k)?(~c}Ybg+Vx?Im7K1;jp=<+~688SCZ z=>ihSFjP|;2-;0-RT>OK#55lTl0-B0YtHbvT&`S?_T_cK%OD9cQD#aSf5m44e6qF3ZiZK^sla?FPxx!FZPi+#3x_-J~D^xglL7 zHBc+D>dM$eWlK06K;k|uK#DsN?m<8&vp+_&4I>Kky*ea6E{4$(8LmMawGjla9&sV- zHku5aikTxVHAE?eF3d;5ODbKX?qPhf3!~xaZE~Y2694D7s4xDqvMcf zF{>UdRM;iA=Fn2755Re+Kk0EMw2ocrbuIoI4H=8)sf07sp6sxepcsXu-`CD+=xh6@ z#2_~s^mw7I^j9emP@tw7lmCJ>u#RHseUM5lQcqo{ua|cvLlAAhK@fZJ0#yWnf^XCJ zF{}y&6O(5&D@-(V=crz2e)q<|fa@^Bt_*Rx%^c@$lp{QQZT0Y$(+Rul6kaNrjjz@$ z{B}b*TH|Ava4NPBcR6zVh%M356G?NKk7b%QLZU6_yS8(g zk*pqgH2{@;I8UVtxl;zUH_a*XAzJedKppr-d6W)_W~M zgYlO)$q(yUt<5jQbm?plQ4S=Rf`AL^OoW>!WH>QtQ48yUGuKTAp4;P$OX(^%t*U*V zX&id2>jU7imk zlq9E7@fjNpZy@Dysxlt)Xu^kNnT|UC{7_t5&#_#_j~0^D`Ab!Xib~|+lXAmW%)Wb6 z#+M{x0?3?>*oyKq$YOL%`iD#-tdwt8N25d9Cd*SVt^m~wsO>}!J_ri91pv83W7o72 zM(BCVrDZluq6(p!)cV$;R~}Ts?V1%mg}-`qU-Q3r>!g_7BWIX)hX*3}fW zbeOimHvil=L~sMX<*8SeM}6KN+KE?uxU$#RfE*+OpK|uWn&cn3?*V&VsIr1%XvA}d z1@Xt#2mA2Fh`~G*H4n`<>ntURZ*;28MvIO}ECP#JvK@bhG{XCvfGym;w%dZFq%obH z-d}0^H$wvmd3e~Kh8jO#-rK`kML#v2Z}^D)X19P0GOOKkt+sGd#Ic0LxH@5oYpQHd zz?*S=w+xa0oeG}ds|^R>fcs$5tcTptF4!lh2qAz(ZAOVr&2k$ThR0Uo8k?WAHesKz zoSA(q+Lg^>ajUPVlmz^fYh!etOSGOc$!$`3P#L))CxE%m&CE-&`-n^jOAO%;#ZYjm zpfm8BMc z5E04Oh8K#oKycY5v_b8kL+G+QF<(Iz{e|qxVb%NZMwccPUp>0<@*mkx}N8d*JVA`U#QeDMha|Ez|lIygR`9OcVxQOcg zi6F~>OVSTKp>BhE#|{Y;lb`hdjHydiHiPjYxN8YKlYu+Vnb&h2#ps6uUriMbkFcUL zMx3Wrm3d|EqF;KA4IR@{ndH+#m8a7ISC4Q_15bP>SWn-Q@Qcj9MzznqWw2^nj z3x898Izylh|9w#nqp}op7(k=?+v5F6iU1XnE_zrsD{xYWyuIuDtGZfIG7fjj^KV7#4lRZZ=M;Rfq-nc}REDo*4;FCVZM>k-ybVfW zrc2G(KaBE7s~c+XMq%cknlT>iXRPzzFcmk6Y0~`4ZyOyuYmJJ29I3OJxsaH578oMR zGU$Q<@>A0whQq`Cn1w4^nJ-nSXa6V;)Az>1Iery)w2MxO4gKx%XcC7`dvi6Z`)&l? zm&nxZzOal!5tTR<=hmjI3$YYw^&(}`zP+_fH24*8XfGP zO?4}dTV;FVnH|de<`|w#PqwrM>BG>3- znEX4URA+uiE@x>%q`Rt}o^nBlD!!mS0gh-#t65_cPG45C_MuOa79IM#yo{^nlK(p% zb{07MgCry(TO4u|wX`>jo#y8V)DJhs{^I)jq=N(L@FD&;!fOEC>}-B@$VrmLI8w!6 zEj%?UA@Aq|1A`x2WBlNsy|Ls1PCO;j;_mJ|qiQ-dZE`&5qzI$1wQnfIeokpN9jdCT z(tmpCgim>Tq$x()>dDZen3s71Doa9*gVg`Ru>u@Njco>R4dbwQe*(xuy1zWkOT88n zR)pHwfC{4!GO^6(Ar;s?|Sup9(jB?j*{e7P@TV$(Z>F_RV}eGQfXHmyP{*aiIxvF z;vWt|nVYS@97Ii3RosbQ1+lVN8NO@tP$m>C#(?hN<5Er0?OLM2Av~|$aw%zV2Naq3 zZ#I~F2xmJm{Cuse^rcU_6{_0+9n{ui;DAK5k{2vEXNhjK? z4Vf!vO4pQFBHsWT&08yWy|1aEPpgJ{Vr=e&j%){>sL~XK(5a~E6$FX8aXoIc;ySRH z4{zLXBMlb>c`C&Psv60LLJGH@CJw?m#`@DqcWU>MFU{(GIOPrtvK1r#)rP9QVE7R6 zXugLgD1V~WjR}^DlXsxn+<^68>#sx70Rw&6;-3uF66f++*@-&Y=^CugYza?;p35l+|#AM<#-M7}NcD?k|e}sr$*R7s-zGDM2!rQ?LDLy%qZ|vGd|z4aj}!I%!bT z8ek-l&%X$IyxnU}Q$zS;}lPf*Sh(e&+)j&Y_9m?*aVjqGOKLvk7Z)poeT ze^CjBi6~jKqj~}h;~Y@h-3~mcfyha47fU+}>AAg5HLl*ot&_R$?VC6)?>tiJf`&QM z{+-pAJdq&`zel`k63b8BeY*J0*V6SGnQC}uIQ9aV2v29j0W-ckEFYr8sZ;TDcd~y2 zn66jcE^fbH?$SRXM!M#92tX5^`^;T#eubR%#k?C=3LbKyDDFM! zf{*He+8eJM$(wsguc@EwzBNnR+%@rj-sBJx-OkK8iOlbA2xa4%a_&z~mpB zZ||;L3LB)JJj7l?<@a9@No`|eqTx4i9)tcdAps-(xI`|+kbXPr6!*4Aa*7-t8gaue zKKf)row8^IQDez|-v0+-p90b5San%ZBkz-#SN!<$S)>2nd79otve@E%SK3wJf9{y- z`ARW2C$br(rKY9^wWkP!aN5lp78$9B21r8!UVc8|Bo`{oJ)^{+07rsDha9dxIdk z?@_e9JxsCh;1&2;P+3Cv?HwD7D=G%bzalG`py_qbR)hMwo2BBZ?Wgv8U(}Jy<6zWR z4F%QiFG%Hr4;3)+Sy>o>$6m^#M2;V zpb&fypcd}7mkF9t{~yHrJwt%d1q>WJ!$$w*JFk)Imh3U?pu*QAvv+&mRbBL(yIovD zv>^PZ1pxiXj?m&RUy}1(EFm*Be@5__-LLaSWZazPI<|fsVw993yN9J3o@hzvwz}oJH>1x`rKXMK*FpUMjXBjNG*6MDmnpTBp$Sfj0 zSWaC#q!^YI=lL8>SMsfx!(DO5E_FZ>p+|r9SK7J{-V`7nejCNsCy)FU7YzqC9m5md z5|)v0h3Vf=rM$jv*#G&pXP^kfzZUP2jSuHtVPvZHL_6NJZjDJL-llV1niYt``3`>c|oM>4yK7|rWg;RHOM)RE>g?bKiWE{ihFY`325Cl$B@@0b}0 z_(WmlesPtbK`p=&96}Na#c<}C34_MG7;gf;Ga7|`^jx-_R2NZGeW9R=AL!$-bh_1L zaM0A+=B=Um9E}$Hb{X!(EkMoaJaBR4Mv)qZfF2sCThb1PN-OR0RMw89VpRM$1 z%1~J|koh~*bfJVImllO*WMBArY?pOui5tH3a_v@?=0{f2?#R)I{<5x~)2R=`Nvj9U zhR63`)%hw1l7K@jm-txJ!dD01DshR!!nEX=@L8jT~fbvDBUD3=n zA&zVk(bqRdkOqf?eg)^r_lki@JtF@5Q;)Ni%dp>a@7Nl(pjI2T+Or{}9a;^g)K00F zz7e4%VJM|VUw5780u7)r6nVg~6p*J>X&|C248dA+$6O} z=%?*v#&5^#ggKJi0jtPqFcEa|uUE$m9|(V!QWmcmGHejY#jL;z^t zDu{x6Q%tu2UB{4s7DP0&&CdUvN{^pE1w!qStfCGcFMhI%3jgPteP_PK_NIYO0--$f za8BpMx1v&+UH3ZX2Z=a|hTNhD;zkq3ilL!Dq11DY4D2Es8q)HHa*#;@JYKcM-{0-Y z;R31cn_0H%e2~lil?MMy#it8$h+7n@O4&$+HV{@@;S2!`nywO zSji8>^nHZ;VNk<;MR4V3LlfLVK8w}g4A*X#>^I)0>k*yk2-d!RpxqG~Gdqh5;Uf4wscEU<t4r_e55oMEkRA2=ZAFL( zg{z)~t0&7be9^QW$)O{k+DlnLeqViE1T)_<~slFd+H9?{wVwW=h-#tJ0G0P zt)R&Iyv%a5Q}*x@@}K4gc6!V> zbt0E0jEB!*T!gxO(H)Jo7EuHo7+*kvD9*bhCgY7`xnWcLg$)S4*RWG#)V~8PsGGy- zVb;&fdmz8QD9{}+){(I-MW4FoIlOJmo`?h#eEG$-%n}wbJ(>u?1m7dfap*ilrs?Kx2A@MIgc+g8PeUs9c6J{CfZB90XJ zg)W9H^44O^8DVc$19qc|Ht(&WH4n$5o7rbHjYb&QC{|*w7fM>^ z2f8M-*5=$_`WX*Qz;c?K^NENK@+;lEHT8Pf$vFpY`HdNp7wWEdcyMsKFwB4qDN^tO zvu1_N(PmCQOP+*F(JJP4hz2p=nBGun%YXb)T%{$K-3WeD9RVkwB2{$X)K1z}PXp4j z9oeOc`(C@}zn8A@ zJf#nHQ#q2{m0t~gPQvcc*(^v+E#10yvM)p#Q!T?uZw#DMRTEE47q9IYq< z;^LI|38GyVKO}rldxFB>C<4r=5~cTSm~mvt`mODr$B!00KP--IXmR+TLltpuB&_Xg zYTH*A27V0z?KHBqlyKm1cGhKydvX46)BqG^nTE{cpI<$y5hQ3sM~0Omq)Osx?OC)23P3PYCWj%A$szBEWK120Zvz_3)8270NpV&y9f`oQ59 zb2LS06*-hl0MZ!NJJ{1HOpr_33XI=%>m5P9KuenywC0M*;Y}*M{0zo>{Hy+ZTacox zfi;{Tebl`zgSv;zggfP`?KRJ@-$l~SF8$un^&d2?)8O>3)#_8W9cNkKOz7BuedWzj zfmhv*A@2$8h`jKd<5=3z^s2_6hFd~MeMEo+>i;i+`k3BW7*TfznbZq4bLga5HXLhq zaL7G;Te8$^s5)(?*D0OjDE(z`Z?H66>~Nmuu7Fc^de8!h3NZpmYlw>o!eTLM75Gs@ zAw?-eLZ(*sDqFn?Kern)UJ`AtKYCrPZ0~JQv&=rq7`8p;xCS12Zrt*{Uke`k6aCkA zfn?1i1lR+)V&3-IUQ64t*bvL5w1mlHMu7u6*7OVo4GJUB#YNv$jQ>4P!#2LknWWU& zA@-Os27I05SfH=s@VkY>sp$$JEw*$d>RZqJQVJY2QMI^y(S}+kHlgW8eU6TX?EKpe zMgFC@ZsK5?K66iYm2}8uAQW(8B~*$ceP28gn9v~&LFthe@Zk$^ZmuVm@>d}NM9y6K@!aU)H1b7>o4N4!iU?8`qEXtI%xAqH zv`m#81 ztL0w1y0BUGk5aDg@B_ZB|3kk%ODIRRT{wHIgSzF}{L7dt#{I!4YhoI_-1s_g!z7nb zFc;e4sG7L@1vtQ~?H>Cc?~r}9Y(goOrRa6+14{IyR5&QuwLDcc-1TbCs7+&|I2&-{-F(y!%w3m8|48+>iislts{pqEC5t_NV%r+#0L=E52pcx@){}pXpA%7;9XFe%f>y+YNu_23=D}uO}=q@E+79BA$M4&RC@E|m~HsWt* zW)aX4AwU!JZib?^@qemLUXe>ml#ODuwAc}QR~HBXys4&UCwOTgX@qR9yEY&lxBu_F z(%t3Q!>OeFss{v55idB0B*ZhO#Bi>~>}{r5LxZ6W%yFu~;OL->|q$}Uf8S2D_0gV7cvZO6}D2mwJVa|3_&=9@7{nC(?l^H zCaxNT{fpe@A`Y{7u!$}$CZN8wcuq{Yg=;zu0#T|3sdxgxn3e83Oq6%-{nkbe6y9P2 z3Ry3pz7XV}g>u6SNXybir74dwkQt@<>l+I`)?z}PUHiZ-gldVL+@JJ@9}Di>*kKF@ zO@A+LJL@~Ke^B~ls6&vneVvZ$ZMU4{VO(xZ?C{QC8n!haIK!cVH-n_##tsD|v4-|IK9B3s zBU3G-h*Dxcrj98BwX=oWpZLW*5zr{5{8}}`qUXn;yc@8Jsd1Q{4Zb)BP%1)ig*Ij< z7-n%vs~vuwO)58;x&++Vxp7p$f0{#L07x(aQ-pv%Sz{jWApTZD0D=_M-UXj)YSTYlpZ!C;yea8ljH2Y+O3JbYIE3v+Ow%!9C ztM~sOKlkFc_g=>c*(2H9NGOq#$c|9<-W;=xxFb?B(@;Y8p5eAv8QCKgviJJmKHtyx z`+4{I{qF~l$KgKL>pItUz1BI`^Z7c8-+RnxwVb=H4$`H>>?gzEc|M*c*`Ma^Hek`| z;z>jGr_6V%V?K~AzEE}JlVc4En`+ZOlPV+I@`O7?l8aJdNsWmn*aJ-O$Qretavx35 za(<1ZovW+}PLjVPu;p$j3UGKz}T4L$o(m6Rd#W|4D@HaDki%3g;p^vK;7VuF z=+|p9y_j;{Y31IZ%T+;NQV$QKF7uG~weM1GxWHn`k#7do0C&GXB@Z2TH+Q``M@wu5 zUBF+~Tp0X&N46xrKwp+kW7U&WCqa+4LfN3}ro!HUdRFnzS7%k!QztB|V(n&)FCqh# zm<2n0(pqZ|saxtdm^;f?r|O;#SQe6N$tHVtetjj}+mjtXz53;6cja>$I?I%Ae03)p zygZNkpC!^1CpXn^Nrf`RQwqM$Xs&Q}imk-Wues5lN_`5FQMaxFEtBBzhxEaJ)Y2vC zd)|ln^rVVq_$ct9z>5*q?Phd6IrHK^DbH=JZyshxczh{-+T%fW;R1!>gBGl_6lS>Z zCYKucAr{8LlvGeE=lo-5U0jT2`0WqQ%b4a{d=!KxoPo5er4?J;+NTz`*kZ* z()Vkm%uAg`e_n|kWUrA5;umbjc0774G+>tU;JsQMA4g;-!%QO#XMEghy!t>)PZX1N zM66w2V6xQWb0Ab4VO4=q-6wI2=uYTWYvm)D;Fm%j?FVqY`(w?-%T!L);x0{GkTep^ zsQ0`mth{|}u{p*0!opZcXmM!@JQ$hotn>96FHeo$BTr&?!Ep!z1$m)G%&D6dR~?y zFj;=<&T+e+P%B6`p3Gy`qS7@^cRE+k_*Pe2N6NeLBI#=vhawrxI}cUJQz$#08mY-* zY`#uHZwP>MA=3FGz^p3WQsZ979`Q1gXV$6St+av8Hzb?xPNy*b z{(6jLaG8p;QY6vxVej?2{gd`7`{mdugyrjM8&fNR!o^|zVz~`gS>a3jL1y4G+CmhR zN95QxDqTCm|JoclV!Z{FJ25E3+`l9#cYY}{1%sHbPRlrKac~$;Uq!O=)p46*8?S{k zv`lv^UCh7Ny3-!eJ!jaq(Dcc(nlTw65nL^6q}mF%R!aWTy~R1mxSuw!xygMbyqLIF zB&tsxqh?*u%Bt2X-P<<8dmz3hZT{XdD9=}V=&A*|w(sIxXovh-Vqxct!STGdSYO@! zS8F0`v$tn1Mdn#mOWpU@U2(TE@^{OdD1K;KJi90PL?`z3691!*{4}`|OtxK8^32~} zdHU$Eo^miG^bO@OG$}%2`zsK-7;s$%^6)i70&0KwN~F@1&>ME{Gg~NvQw# zZT=iWarBMsR#d-&S!MNbT&H}B;%EPJMet?r}- zF&qZOjvJ9&NuIr2Hu1*)mrq6ukN?Vv(j0(b2@?M66J?{Nt`Y5SO_^nwA zHc%B(aJsBQaRYuGN8wMDN7#vE3to#t(yOAelotxq2gv{HiG@JhTPl-N{i{ns;m*(J zLj3ElCWYf`<)r{f^zH}N(`oT>F3@;aKvk(Eh?*V=IFU`Ui zVE@Dd==LP0Ww9%Dq-O-uUw^uz*hJ?7rEyr<(4eKZ{BM5^Y;CZ)!BOwO9%Ei-lY+zeA}3D8-gMkcx^OfI;hSLqPOSu5 z%#Ya27cd@nmEImgtUeQFQ<`1HTnf^zsai)Gd}LP1pa82^>h2>?`2Xt7`V>C@a~VEg z$px)M0|O37MKqY2E{$=D<}1u5!G`e_0x%@L6F6EcAqObJ5#VxXiSqa%(kX?IBxVO_ zn+_97wf*=ZkXr%BKArnpcuoc2dsG34ht{p5{f?1ClnNnIWZ+RW)%F{_KoBpM5~G>G zgThY3c^FmV(;MztB5S8eus+DzQz9V-{OI8Lb70{-TDO2)Vo>;M-%&99(nT4@`*u9Y7Dy|6UdwA}|m?s_Ssg2gtw^L%zbMd8ENl z6t0X(C0Miukkx@}ivG1C^Lv2AH*?5iCW}c$G^63w*Z6tlP;G2xoA-GqJkW|L8Z54o#NFc-d zlY`4m1h~sgDr*jZ$+YgL+Wv{q^ofUAOD&RM@ryo5B!mHA000512|O2}E@n)XAOd&j zY7TwV=#zev1k9rTQpi(EjLv&rD2K05=@kQb!~;3d2g9iAofSissssqIFC_U2z3}%p z$dlW675j&ANN_JX0$Lh<&5|%{Q&MoFTcgjJ8N;h|fd%|dW9SIThMVFilmQboQf);S zkp+^z!HOio%5PGBk(wQJN@SP_a+a%{7Hbl++hyH1Yq+*w$s`5=fCcc3M@s@KnPmX? zz5;H<1lR%YrA9!)VUa-d7(PEsV`zaNT?4?Sm0%5Atc1B;4}c3YW8Rfo08ANVU|eQ- zvp^IJINS!aHljzM88HAL2H~}r2~))YDzDa0mUAz)X!Om&tclGaYXa;j04KnYiWI~f zH34=VrRjoH^hV@tq7Qe?p_(A%$$bEZz?(e*rB(tDLbDOL<$(;0$!K71g7E|+1Fr?a zmupU!oFM4j{t!>_egihY7N7Yzqv0b5CQ>&LCP9F}_59UIc_7Sf#S98~K!`m%CCZyf z)U{wc)U{y3G~mqyf?Y}AX$Nk}LEq|uhjf8(`;i}H*wRxJuKh0|2{3CNRuyGJgysVJ zkdX|`*n{WL;iqB?Zau}OqReXsnQ;7LbcYYt0#xTd%*xb-3+!g<|A-Oi5tb^uamJ7S zV({?IoxIPV&mMiw{$67CD2gHG?UU%YXnKnKgu&b?COrC{M|h( zHi;_>Q$48}&XcXb#L{YNoa`?5^%B-;C#3nltO=YK%Q&g!;0&i!r36ReIm5N^oICF? zd`C|BlH?f%$vA{aouy``&aIR;L?=*!-7i4Q&@C7oI@ejeb48ywM8oH^!w*aO2gb&h zg)l;j82V~7)-N@aPclOgvjYEGOXNpF2LkAGbp$XFrG#iUoG9$0@yA5o?E2)J;@)4= zZ<-$dxCPs~iWlYP81nscwQ!+!ekHuDLBeRM4`Kb~Es>v~A_kxY&qY80XHI`^>P;r9 zrsHS7<~3@=uNHEuqE(0v+>p1*Vm~i2L+F0jP`yg&9ZdL1_DRFp-vMvnWWwv`ajeN; zFguZ|1WNPfdh8|1<>g7^mgT;-o`u}fZ&}6H3O;|Ioha6+*^!PO&KpivDlZHSiw!y| z)%@_U%lrK()am{d{L|m&)1ITZg^PL{; zsg>8$^Tn%t75D2ys^W-e-P5Q)=8Au0cvUF)`07el6{TK##&GLE?x!q&#;NP9<*xd_ z(+Ax3pUx^Mx7*KMoeimEAbe=y8^1DKeHWq)WD3~H^kGTXvYevnKa}`>)y!C@CMim4 z=#`{fcktDMPw%}ngI=Bn`RcR=9hz}9eGAB06grTuE+9(mk}^0uZdp^QQ94joqXgaW z!HR~mi2PzwftP_a9x=efSE9xirg!dAQ0@_9-#Ub#{$na+bRfsJR-F{zX}<8RW1TvI z|L(P)#kx5GhgOLlzi#vXyv=95KVdbi+;?$u!oK_9)M}4OT;g=jyR`q-9q@}au0f$B zLy!5x{%Z$SqEA;p7;<><-LB3MlhQu+e|@ESJ3QAlZ_k=V^0e|KsO$JgYSdWUhqO1L zE6c)r(?S^X9nCsL+xf@kt`W~CWrUJMb*>)_CiYiJv^_hWlh_{!+8Fw^<>io|x+l_Z z{vxsQh5r>Yik6crkF?tb=|-jyYN|1MC}i5B+^Kn zZc)s7m&Tmo7Veee*c@;9ZI$l7nh)DaSvq>gIVgGM*BgC49^RwdM;mLgQ6FhKnzOH| zOD1c_zK>|sj=!0}b)ia$S(l?Np@6SVi&vN^+x|v;Oy*L|HR;F~V(zShmXuGKF4SF? zQrXm>LbB|}LA&Q2Ch_IQad%HHs~aDzt-Ow2ebBjT zrEXOvWu+TM5omfT*oOUqo5BI{m=6^a_uwOt8~aqN0B^HpqnA|TRcSmNp9mRSRHCuu zNHhRPo?5MSy?OJYNNloW=}9M)xpEyHgMSdBVx$Iz3#+JUVXgcj^+`&5!v`*Pku42<5zxu{+?MQ z$KLSN$rY|=nmp7|NC=1Bs0OfeuWq}v-zc%Yqc{D|zP-b)O9X3DMBvFgHNJII!7Gf0 zep=OIS)TS@Z76)$w2^bz{SNu04ehxgb6lJ}kr|GYM?d$Cyr5M(I)APKy5Q5aX9S2rlry~lSlBqH-d+D+!upSovu z_`tf31X1);7%v-YqjvV9!&1&qEFAHU+0BK<{(Zarhco`A7|JIk`y6mF7ki$7A^%Gh z6ckCE&lXhd%G`f55-We{A+vCqo|Wn;t@_;?{>MoB=Twk--OKky)zf&$e4bT2&)Q5t zk0pBzd*I@YViBil=x+8~{mmtTB8@#hXUS9TRw~liSHGtB>ppky$s}%G#J{3P#7g6( zs}J%|g%M$B`NFeF42<}7OjlCS=kLrjeidtF?2(ELw@1s(hxya3Ub2zEc6Xn6iP$t{AYK;_3Lg9-a2oOCo9j?i2;OK;NX0C%q$Z5^flfpo#XI zLmFFfB26VQSGZu{|CsCfk%aZP40=OhejLjE!@|MU#tYI2O>o%qCIj)fUs?#oyLCld zg6OW@jj(n5AZKbYGLo~|KT%NxzsWY(J+XibxI5}?o~T%eQnJm!zTM)Ce2101{CGu) zRL@Vkaqo>w@Q24-qDsXvBs{GasI1jFjk&GU>pfYsB<~OyAC^tK<_wmBr>`$s?VPaX zLn{6<1}4HUx(bf38%z~6UeOUPqT6rR(&#s4m=)Kp`QsQN+f;f#|IHZ`)3OXBoj&TY z8pf#>F|`8GIqRC6pvmNnn2Vq@B*(zSe1|hJEGvG7T1MULexM}NlE;Nl?==c;=y>Nv znPMID8=dG%THGcm)Sf!yE_N*JQ91N3lJhtlL)iU*BAf_ozDi@4)=J4ie?VQFaG_Y+ z`XI~PO|FiuC`%oJn}+i3(pJ=APs$8AmKlo+2o7n@FWv6-ALm!xvsSpvJd(qaJyt~4 z*&rLDKD;vUDo=toXZDlm9sl^P*Dr75f=})MbR%I_g%nk_sgIhaK8l*z+D5?~D(+6e z$<7R1L@Q6)MVLcuVPfwP@thOBJ$%zs$={orMN;ox6lq63;{@i<*h0jC4cSG3PWk9QukhU$*HdcBy-NpH* zIPHEdp^rXz*@U6df6byCXHcPLH!?nCHEUJ=aP51#_H#QC`)elj;=WP=p;&~e=mDuY^Ruu)Y6RilzMyD~=PRqE;U%Lb}zP{{!bBJpnLe0y=>#xW#Fm^EK z6Jdty;*0%)3eBm`mo)@x)mElH&Wz&g!a9Ah!H(NgSiZFKve}>ho~Lq>8#;JCiJ_mXyGLiPRFLbs zO4RA+J}x1Vk}ZL{1&K}e>|H3M`&eb(ab`xUH!P9+_^Y3c(n?L;v9{+oe_1HwOOr#z z0~0I-Na!!-N~&z$%-Hi5{^UwUsgcjzJpm7R ztNdGa>qXn9#>N)ksl9Y7AzJ!hsnRj+y8(>5IFRUKS#iz#^Q+n6Sn_gIeMC9Nwb&TOhpi}aZsRx*e- zcLSST7&(c_-M*np1 za$e;cDFOM(kNar{Xf$#?a|V@3)~oedIBtf_UK=NSUG_nrSN9lC-R0cYD64xG7YWe| zK|g!|<;Cp{7w~1_S+qnCn{UWUp3d<&sm;w6|GxL)V2r$ZtM@`XVCoXhvsH6BuSGH< zFh`)|w?N%?z>WhVCzEWfnc~A<4qY-S4BR1vN=AC|zUtJP31s|kY*9+}{~OE6iD~B_ zm0xu-7a`^7R-dx50n6VIx?S{`3F@+NYbAfbew*cHir0w*dmNfJ<&LGy90#jJ5Xtv< zOQ|dO?dC(ShorHR(k(o@n7(>U_6JdICsVC)=t335A9T`-@}zx9=5TPp7ag>%q&^i) z7#8!ZS`PCA=CEW>woJsQ;d$pUa9)1z5&@4X%xYu;=KVyxHsF-VXjSiK+jyF|5qdOV zomBGjvptaFp5ex8;EI5kgS2o)EW-M?A%<&9Q3mD@N3GSGBFItjDj!N*Ey=iH2YG7b zBd3FXc5=7H(tWBPa_NdF32nXnmrK>oFdjz8ZE9lS@V63IuaZjX#TutlrFfO_q*!>J ze8B~AKw?c{)2mTwden_KL$i*=2J5{0QsJFDZ<~=%_qDyR!+B7Bfulm=0o<;I%x@6w9}}zkavURYXSq}AJ;fkJZ{{X^&lUEjO0%tVvLNgJT$D zp%6XgA|-QhGQ&K5U-^eIr=h8>1|tA>c{bUQ^q5LABFJ+hVJH4;quMh!%FOAto_Kzv zTGgq+yoYw44|bfoMB<*|XlFv}+ypJU?TH&FRp*l2e-mL$S{?1v^DCuX((<{V z?hlLeMUIEz62kF&_MoFS`f#$m0e-BRhcY;!P;o94y=P(hjSR|(Li~3aZ#}gSNs4(* zYCFJ48x_OQ)!Z=k!aTf-M3Ah0V7Mn%FOaf=ZFIY)GFc$*NK~HVCF}0U%*Pw__s9-x zba)>>c3z+*wQbFve=S9Xa;9z7?NUkoM~cV2FoY-|vX7LL z-C?iE0}_|zc#jpAH0&zBD@P66F#?p$bc2^WWJJFyKJdaE33`W^e4KD^kY=tOls32#cI}`c(9lohINm9 zgUa8d^$M~Z@zwe*_H0uYVs353$^a^6gz~Xi>Cnt|eRflEfT~7gUGIT=EYp?7U=i`G z<@{wP8NCkKOO15b?+8j%Xkj}O=qV)D4y4n5N%(>3iOhg?V?g+GtI3E_mxn2eeIQA% ztHs6+x^ zN+6*XZlGx`SLJ%LkQO7f!imUv$OYt(b1v;Qgao8&ocejKri!DNNRs_Yax5t3>&RHo%jPLbPIGi46-s zt9Y=?m70l-T680MLGZ}&tT}?R<}u~|Eg8FY_5}w3SM{BD-UNYt@YO9NEZMy77cRNM z!Ue&ADjH}%qa|eDrgmjt!o(q$| zg{mKi@}rGKjeI%cf9e-Kk~L8!jRx$2#tti|eaqe4fHvLv`px@Ar#*Wf&)Wj0s#?B9 z*nLJlrrx~$V~8BnSND5gg;iS#?(e+Y0AQc=P|Ko4C>Q`36w=wg-1vI>(ni_X)}hg7 z*RRvZbol!oBy=2vzyCdR#)nMu1Co-4Cc6|2f##rMcxHJb>Hp(scL*SDoZ1IT3HjYj zoV#wqcUC8&NJ=$)Ivr`@O5YF_eCo>#(UQ;Y`MG}Czih1?&SCyI`I?PFS>&~$d{zF- z3}2r~>pk?J&>{TbFy?LNOK0dIRgJ#-=EKu$w?oU1GGr;x(b`z}{fxks4nQ10Re zBU{$UCr+aar;J8rEsi~m9#&l!NE^vn!#3d}2^}6--YhJ1-hH)|Z9P(boffzbVIix1Z-Ny_tK#U*JSrdW* zqG*iG0Rn3_3ZPj*yJq^Tp$NIbXn?FU&HGrl{zYvu<~{o=Za?nqk2LxA=utN6W|7i~ zwB}NtXcU&OnB7$y5xqmRXvEgS3T z<=+;|7b30R>(no&J$~;v>^-7N+}GOka*viUTDT_OqZqWYnAqZr84O=W7w_p)$7cg=wY+lL#64eQ)zfXy^}7{LylB$ zg%)*MWjMF^R%;*d&T&bfGE>hnDQsP^=uIZ2)cU~QLPVp#m>coD{D z-_nDcYVmdur!MR*?R0Ob4t%~wqU0-z;f(<0Xdw@J;Gvx+0<04*Bpzf1)sT>NWaeHi zDLK~3lsUAAN`yGw64UIK%u_Gw%M^m1vT4|o+nUl&?vsjvS6FprNd-qD*ho4=+r z6=azt7_(25WmsCpjvye1Ctlr6uzhez1Kn_0{n^7eeM(DrWI4EMK8&6+8gr>L=vrCU z*o@g6D241Ac6su%b@%=*?PR=`&KvoJhE}ZR*oJ26pkf%N3N%r!MO3u0m8a|vb-zOa zgbmQL{nJP$w>V$TOi!Op^k8_|EiCPKt9S>1vEADZ)4F@<%MBJ30j9=m)9^x5h2H$x zq2VNr6P4U8>xs{o5%aR#OyF&2VgTb(uXow|3V@c7=&2BHIF!kdwm74xvmA&ZrCAY9 z?`^tO#uXz{AG1z;zmxy9y;@J@mDTd*=95-9m$u#q`H|!~ zi2zJUz-_uDLR_l|MfN8E%ZnMMSebvm6%l2kBKr{*OB*74iMcSjQuDu1W{EufkKYARO z?+q#FGGM-S*MFF}(;pPV{3t3Crt~g*=bN@Fc75cJU5MwmF*wdfN;5=J!aE_Vi^=v8 z>|WnhG-_QLamB$cvw2_?fT{Ban6k4GO7oF+-R?qJ8&_TzS}1grDbAIJ?ky*PnpLb>_PIgIweo; zX}^c7jvu5R8O&XgUNR<=C+Bws;4XnSc<0|c{?*LhO<)ZS}MYPN+No~mLfg9oEfzi zsyvp$qo$d{4;Myl+iiQ2jd6b{fm?)lxJ=|;nqvnLG_CN65CV_`7px`}q>X@0X;HKL zWrR~vQk`s!hS5S;Q@SoPqsQtU?UqC@dJMS?JXetUl9p!u0Xb$#tS&syw;+r+%znEgNwE)rmyH@ zQ!lJ(Dm#8saqMBp9Rf%^tDe@Ye@L@P>^?xoe@HC?c=VZ4tMqg95Zc@Zl|v%-)*BS& z4Qhn;wyQu!pIVDogG#w2j6I3eGE57ZE@U5EZNJ<`n@c3_MJXO<9(&ayQyK1+w@5Fo zdgm(OXpu|l!nGjL_P zhKQ~|3);B>s}Z==@7&W+$}ruVGPd16>gETOZ?`r1Y; zfs1+NyHOg$}=T6b&n9I&zJqc${ivBQ}1GB-x;R9{1p9Ki>#E(!t?8u?u z)SlM@O7-GM#Q@um1+cn#a_uL{kNlRh6Da>e{zdUKMp$L^%g!esA>wAC zKL+@1vAZG0BlPH7N5vDo5}wFlK@M^<_D=Eej9uyVU%#=l_2K4{BdI!1a9zePTY$m_ z_m49Bk`uHzUkgrV&S?o}S18k`7ut?Om1W+j(5rpKDaoaZlJTzSifSM*;$gC9Ko7jO z9`W?(XH#JRL){c{lOr}DR(t94hX8@ImiO<6VV)~QMEMf&#~JnyID+BD(z+%3r+J>af#R7HprR4jTezIwgY zPax>KBD{7GlBItA($|yeYKeF9$~2-UWop2cxR6)9HEmMvaVH{%lBQza?5T)Vz`4XrXuAKO3kRhG_0 zht+b=wx&M78Mreaa8j;;&-!}Yp>K0%JLzQXp-Qvas(s>@kZj?&_o$(1kaLL`qc4C0 z|0gn@AIW)`xm$}x3_~qMq5f$>FB(Tnt1~Wdyf2f)?^|;AX|4o5 zQ~B)}CATJpgv6FDWw&I|9N;7k>R}H|mIAFX^#K2LypK9xf-6Jp&$lDnyid>p`v!-z z+WMhYO0Pj=Su;^{?DH=>=fC139_tG+<}8#u7xvr(}T1nf!!+?M9i^-jME^FSXYw1L*zbzr)?lR~^Xwtoe9qn{!?f*(V{Q<= zl70Ju-=@+!Q*^*oH+}uVyx7{d_v?nXt+>t_+Vc$9?Er>m11lplgXxVeTs~CCUiLzR{@ zf`tCEml7lj8XgfR*M&Z{=MGKkwXkx`S_4Nq1h}55cf}3Qs7B6ky?9y8G~RWpw0|?o z{<7M@zH1K*4+=FILsNe|wU3%z`{Xn;z2DmOB~a;ZX>5Tb%cI1zaa}mB&FB5xaxOpzV1o-9e$Zh47gO6l1IHCmtTn%A=jn33 zFAQch;3*TZ!zDCXONVdo0LwYu&znNx%-oT+XT*7o$`XQwI^U_biz8@2hCw216X4c{ z{6D;AWz!|xrng;QoB~Y(s~(W6Y+y`?9nJGV4JC!#wQ&60Nt`Dc$cxEVc{WF zs%`ZNGH)03&fGg`l{fW>MOYDv{OqVSK9gaK0B6OlB5Fng?r<-8(;=3W*)Y+2z6c)W z5IQ)nA1wz$_zU|t@|wO9@co2`KYv4Ecd521F4g=WxU$}2B7H|;{(IwC% z2Lpcq7f(;fu=l;2(TDgtPV)hkCg;dv*#7}+wM8&Wt--Z>hg93|-%)MraW7eM66;!! zNpUazJvtjap7gRQG*7kdluPBIYe9s+xO4E@{{W}kVb%*M%}xTGK}Lf>4=HF`0Wh6Z z0i*Bv3jYi7J3+O*jvTrNvo8Nmf)z1^E-8iVaQ#Qi@z`|hQWC7C8?49~4Q>$SfL#PMib92UsyWQY_$82GFz$ILLs_AJP~S{*9cj7lF3PVAhg&)GWSN zyMy(8qyeLfvVlT~C-wixnog{hH`D^-n)u17vtmHIP*OeV&tKnr&c!TL{UV^^Hp}mM za^r-Y)q0%@zicZ11A~u4;1`Q&$raIxWK&>)2V9_ zG3bhiA*10M95?W{CKJeplnU1XM&ID) zjd>vLt74&MKY)i#gQA$Bt9`J4PyrKh-?{RGkbdjU`3;A zdw;8_91FPi1$GNhN!Vdlah3|5q|e5q+G{r9SAa%Be{bv$kT$~d`46qPiKMJK;JdlL z{2{WtWF8jlZa=?cHF`sw=c$8gDE;xk$P33PV* z22h{DZfz21cJmd!ask>i8ssJpPY^jVIu^bNBq<00j2JwsniQo^0SxyLSdW ze4~sh;wvnh1jPTsUKc83lnjC)k5Od|-U_8k@!}j`H^>#}S{(c(tp$OT+9J@L;Q$>y z;LE{e=aw@07sC2I3q}Wp(3FbL6h-kBE=bI;CwR~AgGIR1H$GsNl& z|Ky9O4v6}n0!Ba1(1*S!=qlxZ&eSHB#_&aM-86D&+<1boaMKwoc`1zv)#xL1{@)qc zZk}W-<|S2krF~5LmOO$qbg7RZM~&#DE~sBlx=y7d%p|{6fFhWXe6*PT&ru?t9w0<= zPK@};y>tUlWO+}5H4TK#{!JjbM2ShChg;Jjv2}()hOC%S5^Vq9%5MY5ZTJv_i&Wdw zM0qFkVh0<1(8@=ks0Z&Onn|#Kvhcp+7=1W~|CNOtLV?X+fA=87p(1L)0D9u7*?oMU zfLmOeLCD&GIoNg^A$In<4I+maJUJlBI{-GF{!J74Usi`Nd|94Rh2taDHZ|td{hSnI zir`+#CByEtPs6RnLdpLbm{J{}*eEhAKeRncwJigcD2LWn-A4xc&!BKVGOT|)b$u34 z`2m7QG1N>1laIf=Iwch#N~6yf|MbKywGyEE%Znz|pMQt1Td+@*=XYjxfX7bDr64mH1e>RW? z!@p5DfhxdgA35~mJg3-yutt85nIIG(R@0@Y@?+X&qetJe6MmwsY@`_1pLd6`<6 z1Px}l5vkcvhP6WtnWC_jbcTQX3js9fIR!)^G$jl}k^)Q$;h)%6H(9_&;=J33dVil9 zM2Oum-Sp=-4=LqX<1l~#Z*NWs3gLl(_TsM67#EYp)Afo&`@-g6fL<4}^CmJv{I2{-zfLXuL=D^zv zemVl+^Vk1gGHpB?>^5+)j6M`60oUFXym_nz{K8N6I~UZ@E_-~YGMzT0Ku7~}82pFj zGf&~~oi~7?4cB8V!#?SzzZffY_5Rz0z3!MF)q@cvOkU$sJ~Q$zn)Mecyn_QAmoQ!Ggbie^EP8-WEQ#zyHJl-loP}W>dkZ z+kK7b!)!8aU`kqp#NYOD<1(g>-T}g=v_i3&e6SpRXlXN#&E)tfiV=Ac^Pgn)oC#)w zn6I7y+BN#(iwE&MF_&Rqz(_eX-2r07pZ&KfS>wYw)%Gj_E~N$-b(9O8JR`~rK$`wN zee`%T4Qzk_`3~1i=MYPLM-B+>nBKTEi=w_`i8s)}FwD_GOGtHvvAf z^GpF+x)$FNxIRaq(i8q)%RGU=eWAr1P66!*&6L*-#2H02h8z7q7{FBmO*i;5Yw+`b z&C`1Gs~qKFT{8iI20-PU3G)MmvV>yW-q=cG7J^BB78gsFA`K)F^O^jibkVG>gWp5477_&=a-M!qaLLh~UjXr-C}S7rlw7`%oJ&=F{g(jp8P zK^-zYv{tt9|GHX~!Z@w{*<7(q{`6_>U{Oq6G6g&r%F@M3^se}EfOth$;@DV#a;-By z4iEYru5m53ks;>iOf=kU1xc|%&tSLcRn{WDQX5X3<)i(?DFqPoPjSEj{vQD2za$j~ zA$U$dxhTAxkNGV@pac3hM_#=XFaeZ2SLS5X>y0Df+kLv1G&W`ZHJx?s)~t!DK=O`B?(*R3f$PYCx$GntuX<`v z?G^LtbV)_>M{%(u*MpAy>e76q|G3_-`{r}7b$`3JlJDJ}@lX2NOD93fPsO+Dk79#$ zU%ljTBEu%4?4fPrN6>aG*OC_*wlAMnWlbpyeP}F=m_I&dMIZtE5B_8D0J5V&{)>`! zV!3we_ln?+OkCT9u-Oud(*nyP8p~5>STy`Diue)F?Dqx~qxWZ}>(76TCZ>CkODj#y zcV;|I-YhW%m3w6O9?2g+v4zIRCx;Rz)%sHDzyr>umNQTE;TunK6$%?@#a0l5#JjNb ze!~#w9Al>nSCpm#Qc)bi!yKw)_MLM3^TQB2GL^ND02SWVof{JRoS6HP95YLd^#T$K z048T^l%_Zn6dOj2U7*}f`+!Pj`nOE@xk%nFGL_(d#?aG%r^1C-$NJ!c`9OPlgWmITL^zD=A2*JjxU6v z=T4xh0l1A6!+DeuIrBsZfOScuBxaU#2~KJ89fnIf9})&|V}NR?{>8>UzgiH`DsT8v zfuDj*l);887ht3hmDoU6)cVXxFwhlX(-eg#T|&UT2>zxWj;9v8RU@zmHB~Qrm)ore z%27j>_UJ>iBGix!8WTMxc|J+j@AY7tLg_GSLQt6snr^&(=gtPcwfE*x{J1)>xl?oE zxf=gs_XYT)E`YVxnf>~gMWq+)&dwac1wXAGj{1_eLFd zHg=oaSv7_$yI+T8Ei+6Re=^TtAO6-6SKoH{b=djU{t-nz``p%Z--+m5j{2S!dtZ*l z|BtNqfNHAi)<#1OohS+-C7~#y6ahtgLPtSSQRz)Ur1wtf%@-s=nn(#q6GeLOAP{@Y?ltQw^O;b+(9PO*mkzsY^JwGx&zRFCtkv6_ zf8gPWn=3enErYFd>8mPCJDjTlFzG=P!l?rvAW(b{fdQ$s^x{-_`+i?zDf*4O1#;=*Yx0>MVswZHFJPBqaR z%c=)#Wk6O|v`i#x~GS@DQnOj`<<;McidoFKdShH zc;)<^#OC~fJn?^qmYUBu(-oe3ynQ~Yx0ewB>HAQ=u8ec^_Vk?B63wHZZw_2AK|PM| zR{4)dnuXe0$fOss!ZN1GyPod?YGqL^br)O^1a2R|{#nhh>ekWG+Tft}46)nY)zyF_ zFfC0|DQa|mb#Qdu*?+bn06xVDZZj!`16(MZ5u!P){Fxo3?oQ_P zHy+HDTGqThLSPPVb$%;$N}TKb=l53Wx<$B{k<-e|*xiMN;lr5^{$t__lB|>J>PcQg z|E8?+>~lHUt<2TOuXjWzI|4Oq$yRrE$-4;Bl<63NJ|8_~Cqj^c6*k2VsUfAG8dxT`LC{>kgI?aQV1Q#j}T~u zi~tu|YkpFc@G%#f%Q{7c;L5W_Cem&_L>8u%;tuQ*@h7(%3;=U-$`N-)1!QXmnLNa9 z|F^e=ftJZEfSHqlhsr}<=0F;KKrk01!Vn<#B{I|SaO@KSm#gc9{b4u`dRlpRkCvD&i)fv&(k?80^Q6_Y`ZTfl6@cByzCy~ z(+OSMuPYpV%eqO2)35R>__eal%pS@COo%&ce>W66!+EOSNwGr3MgCIYp!x4VBYED> zEonLjI_a=pd%qd106yt+i!xq+D$S4ll< z$ydEI9O2Dg*xK*AY{kZYCdER(4!DOKht{vTHADoM;WO!nZuX7$UJk_$fHV1!g29*v zC2z0ov|=gbZ+%3RJ?DQiU_Hg8L+PLr?AxkWQrPzZXGM@r)iJbyw;vUtq@`yGpdwvl z++1-L!PE!$T3V>F!IH!4MlY$*L%tT|*pK2cu z%`jYk-%Dxa_47joc>_wL`gE)kpbXycO+L zAy>gx$Bwv6ZDsihbyk@(`^ z0)7IV%=EiGSc8$he_gkMK~bKx31Uy>3KN33uq=CSlxwcikU>MdD(arw;btz1fxur> zNO_WYS6cwPSoHz56Usx~6gtaqikG&lpfS5vIcKenq(joy_7mVvf&MK z4<{R%mn zH{2i3Mi>P)>^s+_r--guEm`b{syC5xE2WH*`WhwNBn82s_{jFn25ui|RC(lf!Wfr5 zF-x+h$vOk4ebT^?5-KLj##TEQ*-j&AB7W8GhK%yz7u}Bj8;eswLB(Y-+0g+qtG>OR zHVRDK)e#M{FrRJq?tu-s)nMnsPDbF7DPJj{D*1 z+EMgV+@5a2uG3cb@JD9PpxvrnBo_ouT8&=|BFWp_Uv0Bi>yk^(5Cu9`Sd{}AiLgU@ zNY(dBJ<{~3RC1-t#zGLk- zzI&PJb5UAG!si#&LbEq+z!N6#h%-+J#KvJIX1(At3V@EIHg7Ven`C6|cgcOWmB9uDwr?w$Z>kDAj7thb_xykG7iPL1%witGl-LZZQ~toGSxb1 zVgAg}xms+-ak?8O#=2-wdqMh@QF1iKN?CRvQ+{#PK0?&P=n4@L_2;`B%QZM5>1NFL zXv{tE+JaloA%lJY%KdfB%4Q&Q-=Ng`o;2m~1g2=*% zBCB2r8CV(c9=OcIS^6@0;*3A|nrey7#in*1K_#4V^-HtlSke?(YTfn2>`5pKwO$ZE ze+i)V>*aNJ2v#(X%r&x?0hAB8c*dY(7W}{<2w+W3<4gxC;Z>sUN3=c*a;L6+!>Kg*}K<4JvgLhHVM)0VxVrlIUo*3=5FeCCpGPFI+k4T6|H z)(ZBxDH^h`K(V?`!w#vQA$?pG=@|sEs{oW*wtuHmrPz+q_7=36RJik`>UCRHdd1@_ z3Ny>mb#Ix3Z~F>=7`nsXs75h%ln!;*X>Tp56SE8g zq~fD|>4cn9ZRmui1kkr3%zwpU?`Ei?d`HPh-{q~Q_EFP_w?kmpY`MxYa&gffB!F@H zt0n}KR1C6&soh#x!B3r2CMG25C|j^pTMteh#KgXS<-%TBm7crU_vrbhzk#J$uN6E1 zn(whClWno`#^9ae1)5$^v>Ev#L*}zx30jSdF_tIeSgK^YZY;KQK2if$7uaGV`Wkm_ zx&+)@G44S7KN#%H_&>;5;$iKwi4m*>I6vQw2*bQ}%qknW zfAr!4BJ*-k!L!?A5OFdzUl)4vZcWX%_)rHEEDQ;r()}pjoS4fIj=$4ZSBa5-?7ENKt-E-L72_K$$wqf=+1hK7|TB z@+}kD5r8s^kHYftZsHxj@7Ezhba{IBhDw0sma^^C^s$XNrjeFK5 z)e6dY;~%CSdW+(0a4fsd{oC@o~#Sd<&SU*arLo7ACI)*GIDrX&!C&}T*iRp zFnswIsgiaeSyuB$mc7g(k;q$hTnUOCo4{DI_A!UWntcSpCUf%@Udde^kF^m$|&N@;_`|h zhn<7gFV?s%Tui@YYd^=?#5yUk{_(M>ckC6#xTRbWKCN9mKC=d5g@|sYxbq_|9-7G> ziEx}$?_uL@KfirqbxhWR7(sNe$#HiO;<%E6wIDhGhdB{<0)*h7PiwvPQDk`3pUTg; zyZ3SxKJPyzFu_HStt)Ep2bZNHUYQv3+?mWB=?yO)_7Jq&49DyKu*!T+57MAW0>3pD z*iuhv&hhGbqT{&ZGM&%g6Z=j6(K1(V(EZ4*3RWeyO{GoV{{FCvbF-9(Bv^2ofzYkR zTp^YOs}pHsT|{-nIVW0GULk*2?2jA0yVwa2dR8YnMhjFK_zKs}bM68P=iaW|Ldqd_|+nw!hS?Pl9QukID%UEZ%XLd8vmT8%YSoBFBe*ER9%dzF5XT47||Fqw%$aqs4Bhtl&eQfiGWa2M%`B5ruEb!_h80OwLTDVi7&KjYKI8 zT?bC7_-7jtGUxc+6V6IzkJmGc(ze@nS(YCA8ahmjKfRH>NP)`6(=oAGRcT?LG~*F* zXI774uh^NaZLpl%*OA+?nP55jL~cY8#=-JheBnSfV|w-<#*`E9Go9_*I$P}*-!#dy z%T_4&e$HvHagE!eF!YxHY@;7qNph|ET3_DY(!MBG3fh!R6AB@L=u~Qwl_|OWBDtMn zSqT^^I56fSZx@7W*#)V9Ak`}6)EZ$7$jH+hdWVOH+O1Pd{cpe~u;CzPPU_=5c8K5E zT^%oNQE_1i#|=VX%OZr5T%3ftwc6Z?0pH4j<8(IlOvrM%2Zn6kMCDG)M6Doig6{kz zs92`J><^~-Q`BQ$JI=dkun6<$f&5F9^?Qb2U9Os;u&4C3NL>Xykrsyc^&G}n?O zg?~FBZ*TjG$Ndedo4x9qx>Y5YsQ1c6aE)8`1y{Q9vx@UA=jm%>9Vf;}MWlp~I~`qg zE$U|C_)o37W$&FiU8%7z|7XZ!$Dl#Su<7MfS5R8a?ix(hQGY*vC0}2A$U?t4cO&+< zvLwymn^CBw2IEi8ysD$iyEXxmS{>HCo3wY-s5>Ll*l!~_g?Iy!k2&vTXnluQ3JUS` zOh1sO&;H){E#T`Ry>IpjSC8#Lt}dNP{-ox-iaqOX?X@PDHWF~ zK)pVyoBe?(YhivyoPvjAMtIkBnzhZ~mgTb_^NP9Yi3#4eY=reqi3VXu(G|Nn{c?nf zT$4$6ioLI-6Bm8v*5adHgmrAAhEtM5rt-60eC{UrWF^Mb1#f2NTj1ACPC5Bm%smuP zJ9#^_c}9|IVo!v!>ocoqwClAK(ZFF=Mc@;$b<(t&Bq3Nm^3?!q>L^yoMC4>5KruZl z%RK3}3K#5hWK&ZB2_c_?6*M;|FC^~j zdK~wO%)F)4`hzvns%-?q$>dh+@JW_O#W_~u9&(LbFf@SIkfIDC&zDNoHFYk<$n1A+ zWT8V3KOc^CH|Yo>CDB-VFUrJy0Hy?AUEJ)rW3>q`rV`I?SJrW(r)NM|Q}WV?Qvbvj(JoYkgvjA@8?i2o7oCgpy|7-D=Gv({TZRg0(MY~O=TMTH6^foTiaJ`O5wRf z!)bDKqG1a%u%xOqk;>rr9Pu>P$@XIl`EA-ENky(?l2YQ zLD>lDY69qwj=r(I+FHK)lDjhSAjvoOON5p;fFtsinyE6th2ddpg1aviZ1}Yv#?GjJ zVt*yWdS5`+&U?G?UE*ICmwjIC;?unt^#b&$CO76D{nxZ4|0E`fR()R)q7@A-D`Y2n zK2yH3dy{$E{MDBQ1C3CYKhMhKo{p#IzXX=4CDOifz_R-`E#6F$qA#Z(8(C0;cHyNf z87oH7$KVI0Bkj1AcozS;9lEP$e^~f#yt8^Bt3Bj33eI*MFE)eJvdTu~o(0&(fZ=k8u37RG6B)81DPe*T4(BHcap`dmkR}l?qav7Z%EK$sA2lo7>j9TD? zg3QcI{j|l!74;l%uqMLZLEJ(lG<$j;B%Vw4jOsp?e5|Yo<20+gXPI3BTl5xUdDCFR z3W*BuqbC`N`uxapH5u7@Z>Y5N+YU<-R;lY5dTL54hoai>^=qcAkR9vVKXynxJ2(Rq zlR4K7OUEAy%s-Cg?!#GQ+gxxs=(kOxu}tL@#lzo9m$A|A@K@-v6go>f}5KK>4# zaDV?dA)$g2Rm^#-QoE561d2{SVyG@y6T@#=~#bjy#n4drBYxh2_g@~pc^e(X%c}T^#ae<)mKO9LNZ#t% zfW~3rRTfWZ`4iMp1H{c2k7WGa+|`pSilj)BPKWirTDN2;f1-jL!=H!$x1A@1IE8`O z>(qQd;{57u>>FZc2U5Hb$Qp;?$ZxXP@-DH*kNZ9Dv#f{!f$D}sKi54T$(Xc>O@%}S zVG`v&kEhG-=PJV^&6(Hqch40Gryw>da!XYm;l#T=?w70VT7ezIyz+kL0Qvt_Br}l zXwkgjc}$&95dQsS;}}#D2A1aefU?8+i5h7#Ke~#0*Hjmg^jIYSV$eVGQj?;>lX%y+ zZcUn1_JuSDJlDd#w@S9aFK6$K&zF+gB#`fV{+sz;heJ;dFG zLV1IXe$Yb{$aBtb=;;ki2$tjk$Q#bd*1KpxpjALhbSxt!GJF#cA-5Du5H#X95;D4{ z5+p@N$=k}%(l3;9Lo-N5!<(B1;&VVwqcHaC%*BF77nt`|N!*==^6P6l9W9<_8kLar zdXoqmGBR?jhg>&!Wu=sIYJI@!CU5SOFneIZ_voX5U%x~!T*c0J+;5C-kE*{W*0@L@ zO}%xcj@W^^Q+u)*U~~G95Xja#0LIKaGx#y z$mBr)iVY+Ba`$So*zc9>ZCdQ9z!~R#{?k+?Uv|QroZ!=Q`4<6!A#y8G{2W_@DYFwZ zqlAP_0;PMZR-E6%@fUTCC#CJRw=8bx-;GJ3#|4V)QT$fW0MqB1E_}yo_vjf<2u@%+ z&;eVxXkrrm_0Bgo7AM3*@vLS#d$uZ5yi>K&9$TQ(P9WPuUv@>M#;^q+*p?(AkNIx*x$9y}ikXX{zx1cgfQu4wq!)ES)zGj_-i zJ-zku-F|<@yUUB%`j0hoN~1cXAX`XLNtBz{3W3x3XsIA@G^6Tntcs6QX1WY@>}wnh zNU9uG-g4MAe|loH6D?(Jy<+<4C3j9PqgS@Dz3z@KB|U_^T|4-+Ux)aAM%g#bzX|z5DIWzOGXcEfgRxSQqCXKT5ST3FAYCiw zYj>txCQ}%tXb?=UMH~Sj=V|$cJVzpOE$_3y(l&#QI5f`pCQv!!m532@0TnabUlDt< zHkt%U6gGtK{zTDC*hfYcGnk5^{FH@QR(|#5+R(WyuO{d;n13tkW$=$6S1I5?zRP8w zO@jIfbza7M^K2t_^cx)^$HHQqM6_V!yf4Q_Ox*$5Uj1Hk*~gK&QB6c)zzxk+HpO|S zYU2%+7{~qk4HQw}`qymkDwm>zgH8pW9sdUHyjcjB_v=SFI3XlDijb1MZo!%-5< zKUnxA9HaaHnah9erb5S}EKk@!Wh}S2oprR*vFAP&)yEz*WT3~O=S#gxdMyg9eEZWE zc9#w-${N?1vdFLTe--&BJid;QYGXBeI|2R3u&XR;S%z*CBu@sh0R~N_&S-Z6(q=L{X8NHkn&3<$oY!dfli1gpf8Vq^E&B3 zRn|8?*Px(dD@qao5i&YKu!NP4j3hQ5l?cG!8kZGe6MzddMJA^=8Re)684WXt`VsOT z7dg#Q@Hyh-)k9U*Fj^W`ki?5Lxux&ICW?mV=gh&BkWh`GL^~T}Bt6QmH90%o%-IcCr3yM(plH8l84;d4qH7?d;u7 z<8~;l#MW-AT$_r}D9sI!RRKeDSt&VH$}&ZIly^y|8C=3~*}12nX?6W5_AX+aYVf00 zCf9&WM*DKisbTe>yLl5zCp375!I}TpGydm>LWzo=iAy;h#0c6V%Ti8S;rz39NJmM= z%ECQc9#S;p`+%^tmgt_%!ibv0C)}~&uGBG7SIR94end zZTG2{%r&z*TosWQ3m2iiba+ zYZp{D_&kmlv(oj7f72SXq8E)t11@0xM$5Yat!_3yA`_zJdh# zQ-zUh#PV;V26=+~srzinRPHJQc}ak&2*6Vi%%2Y3YebFGZ#-gJABrV!B7w~{S zz(sR8*OW~&i1`e3cY9mX;_}XFPfLY%nof3cvne?b8Tee9Zh1Vf5hMi?yjG6zpkaub zfYk~encwhixcy16Mv5&$`<8;7IGrhynKFcS`%i4e29`qWRrp7yin#PqB#YAY+(m`r zOGV?1{h!$@_b6#s=V0&(TJOd=u0I#q(6Xj5*MI!EL2^heMHBBAsy3R~Y@q?*T4SJI zWFYAM5R-qXwiFY1n0mLBsV7_XC995GY4NP%?l&?{U@)u=XSvV|hfUu=dmBz!&6M>I zp`GPR9_(sBVS4Jk1V;Z)GwW7;UXVeZ%lo*-XDC(w@w4vZf{7$4k+bl%RTmr0>F&wq zINWoPba9mM9QBZW7w*N`tCwnf(7y}c;o+G@zL;*D$>ohwea_ANj@0hL(m9v{Dol_ihF z4c_6wC$3l9IHm8{Uq2p9zx3x!w&2iby4Unca!l-6@^HqrJxowZ;YehgsrF4%-jz>N zzU>01O>qj{;*c}$3CuO2JKtkAEf7Na6>Fbj>l3^JMf`eX?_m8vT>+DU@h1wy+u`?c zyn|T{`{QU!>5Si-<#CrB*LQ$$`**+hJe6zG%*tE{0YD^%sq=%G{ax>JFbv$N-pXpK}V+}+-N zv2bo_gr;%a@9T`5YvE_Lbmn{XGhfwq`uACV^D#6kw-&gQ;rYZUQS|U#ppo=>gv>`a z9Qyv9sm=ghr>Tp-k?iWAkmM=D3{f#*T_6TWFdl?$b1U$8vMvn#ZUuubNKK0 z8YS|yf>`;agn2o5B7)7JjbqTEyclwW$N#(g`Ikg4EP3>g!JfQXwko#kNo2#9G1WTV zc=}i$Q@C-nh=0P~VvRk8N8@MP0QLy;TmP-y_~6<`dpBOkU5=H$M1L(!3z|e|1+$8w6{5rwXVYQxBpf z?^@OZ)JBkYW)B+x%Z@K$J_k=uG!1Wm?D$hD=P+76*ceriK6|ucc6nFpL3lwKvWC;) zd%!C*;HO?Nu6N}mOw%@?qMYSDAewir53Pb{*_>!(cf1c}9Hk{}l zibWQe9*r<}0LPo=pB&*&taE(9ss`PrUPB z)XFpCTq2CSUZyT^+E2k#ZclmyXV_ePB6)PdJc4rJnoB-8{(>GYR+ib?(5-MF;Qx4h znh(g>$m#MkE&tt|d>xNn<3k_ezBf;~v9f0H`+xa(>ZO>=pw z31(?O`!!jVaImkeKOP|j_5lj6$k^ys{W=$lx+qwXbq(xsDh<%yvLIQU!c+PojH(qr zXE%A1@al8JN+3b+(p%}vk;0$^^)varnXwtsORunfyURvoF^UiSG+4}v+wdQP>!HHv z%uw~6%kqLtltP}+3&D;g1<9v7vIH#o$FtJkpHCCS;>uzgHux|rdPKoMzPrR1_s&>4 zL3Pl}#vi6mLZ^20*U>g#z9_`@1vanU!hUl2D{3=n*Ow6xFv3j87*4*NdQRlh^g-M? z`DBuRgCKc(Ke~a#ve|{p2HK=OJ<*)Ly|yZLrWy!!X#q4nahfVw`rxmLesX%Byvr&W zAZ|)3^}$Suq<=)#9u4-Tj1ma~)Lxn1fCX`rUDpg@$^q~m1sQR!k`>TWA~h|@X~yms zt}MUp)c-dgzwwf-Rs^|0;d38J5td9QAJBcmOH_5XU`1=QB&J9H4}~Tv_YHGu2>Ks3 z*iV%pqkTSDh+xUOwC%qSfH!3P^5m=K#qpW0B3w;$?SL^ghcK@ST2pca@y|%P$_?-+$87Z0rnZ zWV0+3?+@Q11~i}Ja}ewEve-V{K-vO(f6U4lF9H+E6~D^4XWE*SQ3%+2dKV@$PPPes zWoTA#6B1Meu(4!;WcIK?&O(PyDQR9Bng!>P@NkLaSYy|yIEC7eJOp*&bBrYo`qJ=N67{3ZC^zo2((l(K}n-qL)fR@_l>SM z^-zRXvQ5kb0tY-EnT^Yi$tUue58-X6YCh0TN>Lx242sW%B=0FZWQZ^o>)?oDei>8n0QeF1 zwcd20P1%gJ6doF%#l*Hb86`JPTS#2#4(ukc|Hs$yMRltrdCch`VUO7Qc;f2oBycj) z8$95_?3cPmWVuHU`rD*3QypiRn(T^73OANbHK#|7hh#!M`~rk7eJ> zMly0$xlfI)P-?WE>2A>>naqF70JtjJ$HAFqxCb7j+>#knD!TQ%wgFT$A79UymEMHx z&<&7nJsTv8TVSo>;^Kmv`d_TcOZRg}eu5_Sgg>CEVR9t9G#1X@e~$SW1^pD-U>D%1 z9sh!4+j1W2@1a+Q27TtecVeo+e$y3TrzdgZdlRokDjAV-NV}{4 z@|qMwNuhUF*WM+c$*kE_C($RbdGySLbNQvNA5P;>>(B6O2#)D~%ua7I8_}fqEH24u za)_9MzVe5{f0yQuzAWl=39-LmR;qMnJ)~k-+uO;|-X*UptkPUWAxyJ-DV2 zSH3xHFmOHgxuof2)mn1zRHv{AdZg!gu-OeK;Rm(_>mFO}Eig`w3%OogbTjMJ*DfWD z|M^WoJ|&7($ZMu-Y}Jqw*zqKox4Y~45({UoI|+%hfzZH)m$y0}&zuje`CLp*M>jfk zUpNh}?Gl>{9gG)_UAu@Mrev!mk;Q)wkJbnGe5z*Fgb2m~f$`9QGS>;qDaz->^!}=7 zGrmBYRB8K-osI}@`)$>YK)hBuF^d`IB(M>9a1(;ZBQ6)n=}X*TbX6?|x(~_91hqm= z+&w%T9PRDf?Z=N%{+C-&Zhzd~>|9C;vC9@2`MMSnhHmNWW0>{jhZ0Uvrn8g27d)|- zztNY2(6%$DvE#Rcd+43+W{iQ5*I;us3x4V)=G-K7?1lc+Cs5_^h(yR&2A{B=*nKT`#RhHs{#`5;#!eSkzO!iy!dNV8 zFZa`dv3cj1BpTCu2ck4jzOU^~S^8Y=9T_E63ThHqpl?ka<74Q- zm%86^jQXV;FE)`QyH)mho9V2H>qxC}dYjpG#CrVG(I^UI8X)&*GobUTcb<57SyJWX zM{xGOIH)ja0y9l&_Z_;;X~a7{(c_2T5fJ)vB{bI|M}4~&YKkq}K;@5L?Xiz&PbXcT z3Bx^NIQTv7?iLd^ny%JUYXhO)4}qz*QvG6_K;vb$ z$X(c2j=C$?b~GcyB(*1D{qMn^|Y7wX`+ z`r@1~YY8}M&ZCg{{ZK9Zw*FK7MU8pZ#ZdMMkkJ^%cfq9h&2Q8#}@*S=SLash_E z+X(zYi(JJsuh4-cX7nZ{Ss?Blg#(rxg(zT^r$=9w!opHaA4r}oAh1yLNbGQ!?}i`At!^hgK<-qd(ddPw9WOP~g^Nv1U40>O2YV+2tJc}609dJEo^)PI zXO0YC3_+|HM@B-gk2ONDkoo*U9kw(!k(d~~gH+AC3-9Kxqa_*HfPQAftF~~}_(((H zi{a}>X0)q5-;US#-o`xZE;LOR9MqE9iKYLMZN%i>n zA+DeurnlqrMqZgmr^T`ilR^87b!hCGV(h-yZk=*U=^qc~Nv>JPB~SWl!FM2YT{z%DZ0#TjD$kH$;f#vmJUr0R|+(PJiN!L%Wx;{-lC;D7utpMzqPb) zYbx$Hm2X=KaNnT5ei`1>QflU>aNS$*C2iGqXsajTeThXg$bP1op=#f_^{kO^s!fOE zqM@I&>e%vBU0V*vN79{fu+;z&aCQs@m=dnNiU+?<0hEHnn9db99fCb?{4}5{``6&n zD&6sjq?_Tqe^N_I3UFAca+o>hkhGsF_1v3Ix0@*ZduP|A(f5?wyx2beG^C{Y_wT(R z=a*7r)6)jmnCKfbb92`|E`A+ie)rqpF@)hR>3abE{rv(I`PW|vG^ClZ4Coanm&-X{ z_$F-#mEzfxi=SRdRPq+1balALel|2wucp@_v89u1@ZBP2pT)Y!-pQZ)03$EwxmL8v zB$v^=2M}Dp^E5+ww~6#d@~K#s2y!%w;W4a48A}yQ9ZQ*dYMw=I=viU|4*G1kJBJHv zY~!A42{$hJ^hc73L)w0=Bn3SVw#EGtsU*DBBV-K_X?{Ul-lK@GqDg1UyP0v6G#{@S ze4a7$pvrhUNd74v(sq`Ym&Y}7&y%hh8Bu0$tob4GVa@xFe^!FCT0XTr?I;Kvr8e>WFLqv`=l_;exlp~jq4Z3U|M~Q- z*$NwH1v(pBhCEjXbd?Y~$+F-zkvRCt$%i?j_t*;jzS3Zen#sVy71A2(dF1$^^Oi-7 z7^#z4YNksHraE+b&;4~NMmp_@_VpEaZg{lBw);EzXV#O-X;x6@l!2;2mx=U&25s(v z7N8V8I^{eRT(7vikC40CHV!@1^?OfLcK~*c_ED4YuxPRXIlc_69zi((%1tr73I+m& zN3j31J^9EjdjEv!z*sOl{B$jDSeNfMoa$)v!NYEgVsS>aiSY8{QiftPvN4Y!LdQ=9 z9{9^G(aBZO`qLC&RKejzomJp)TyshD}ErJoUY zD;7Td`>?@Esvu@c*exLLE=rh2sGHAGJf?mS(^mH?yJX~6;i&rr{L4TS!sf<=xy%FN z4bQ-YI%oiM@1Q1Gm-eUR?>N42a0g)3rsE1BLIG-|ly3|WAP1R*F-cKgq@c|@04hSt zM7>RNX$BlLmh>mlPxMTR*G)Mnc{ro`jvf!fds}I!_}!YEJShVEiPnyR*7$Hj2JWgs zva>SO4u~s~-_X&vTjGi@{A(JB6wU`^j@Pr@)!^d~@hyL` zVv*pVxKOm|oiiW&P0$>8F_Iw?EPp#V7i~s1O!fuo2lHl_FtK4^6;;+XhVW2I-w%U? zo-n#bfWqn(U1?rl3p;py(g$~W>f1EYN7f8HF_{%Gm9T5Y^kcv$BgMqy!CmO~;GR<= z^w+@}9Cxa)|964abY(hg@~W>gl0@z&_rd>MQ&;G#C!6dd(~G%`{7wc@f^k4Hr^G*kZcW!JWw-m65x5LemQL@=vH&Xz|H9wty|EPvI1!2R*Q8C-aL7g@IKT zl3c4YL8Sn%=!X>dXoQ$lWN2Y0;_i(!jf!ktzuLr4Ce7JpFyua>tlvi!kZn?h53g%d z^2pt$cfR$dmap^9xu|NxU=(gwd)EoYyj#7)Vtl!BzuGUbtgN^>)&jS4O89HH&_o(r z4pYB}D^26vMO?eMg~qeJ`m>Ve`F{oY_ZYVYoz%x2I2 zCI{_bdH1grt6+f|OObRi_w&-Hq@W)KK628-ht8^Jy&ZyBIJ za4WjoS5tNm|K*5F7Q`S%Ad zY9w~TgE;*;6Wb6&gu_=cP1oz8L3GfQ^9Lm6R?`n%pnpaWsRFLc!dfICn}F9)aq!Rb_xpf<#`nBF40M{vU` zC})g{_bm7kogyF{k_!n_w+MFIXNb$9>B96boG7Ask{G;M@1@Sa~ z(5shzP}lQoY^dXXX4n$YdteSMclAsN3cL|;A_N%bf@B7;%XkHc0m9VH8=rGNVo&GdvGAq;^ShY-KR1U=2c%zT^;XA;Pv#A84eiQB zzBlkfetKxbUScGe?GFB+b>nk6bUyD)mj`g+I6G0`T*2RrMKo$~=baxH_6e*T9>R-LGB)hw?p?Wwn!Y=4 zuQ>LlM)}ZQJ@lc?fF}~ONjr#4#(4Vq&_)(+OfYtFmK+m={dzR}-SdOpmIiVTO0ti7Wzrat@!WQRC?Sja$|6*aNZx;=fK3f(jv&07laY#3{GT3qV& z@ZOv95BP28A28aZnT}t-dBAZ_*tm0k=tGMEFhfJIUsJqV{1)XG51HJKn7o<22ZW`n z&t())OTHyb&&(rree@Q2<{}oe-@rAJU#DQjXrQ)<;1PWqXv8?UIcyv8#E>iU0xUlc zR+puRmAP^hMu6I<&7R%?6huHwXpa77P;P!nQ*NFN6XX?Sjp>waS&=_rD(>;qU|yP?fadM^nc4~e zF06d3@5GNfTv8s8KSw?rkF;Du`v~Ka&(6(52elhc-=-1bB2k)qe+C;l#`OYa+7PiI z{;IYwFB)zpje$bOekpD%MpdJa9$G%8QFafst2?%%e|mp1?^(&0i@HS#(dX@h#04n= z_S}*DswgpeacRj5UGCM^Y=Vgk6gglb?l575cH0loio^Y|!%!7hA0UEhSd=*VSOX`0PjxThB9#KP}4DOr;=4(EX z+UqJ?6SdXtKi`IW+X>MtRfquVM2?d5D{ZgUS3jvY#@XRhpk4!$hZi$q-Zr`o1*z4Q z>B*NDGlJ(Q7rsr!2e@9l@JJ`Z9FQ5Bgl&=SL(57n)O#(FhVI~aFy}F78={8!Q++~){vHEcq)f(B4LnC`x6M~t+<&$*hIi8NB=`FI0Tn8j2YM>x7JlLy6 zHl|~P&^8#F3-S~a+P$}v8_8X{s9d)A=a+&)QV(;tbwJJmAAyUalTVy45F?S|HWJ?;pV+7%ehl=GfT z9}avldEgHf-IK*&*vbVCuc?250XY}1KLOK5*3 zq!HB@Wl#ZkNP{+yM&s=q?y#|+N?L(zKJ`M~ZE?Kx&;Hp}fHqHG3#@!#@=Yv|ikTTo z*Sxt#V8@#r(0h|qVxEFKK!~KtEwXs@JbRTIqspr{m#+>&mFm@I=GyAUiA4If;85pV zB3vUmPkrfc925r5oxQX*JNN10dWZYAKy6oYb7I5ffzX?fgeG1}K^{u;#~M%?b338U={Dp` zo}-a>cRdO@1zix8vMy_K4Q`WBT?Oio38IW9^-!2jS04HbPcyktU$Fhhd34KS1Wa zg;mX!kHh%6mgJ|7zco8*AFas!r8ul^kB=YppXtT?6Brlhc6Arpw~(}Y%H#`d4E+yX zSmdPNru=+7c6ZW`GY%NZ%wg0ED>yBzF+xj3#B0>^JR7Ok! zV!;__EcgTo5CY=_ETCec6NFI_5qK&kg;2$Q0XwLXL1h#$C{-YYfCW^fD1@3&C76aG zh4k;nZ++`q>;3W0ZD*ab_SxsR_g&|nd(Pg^+(r9k=`}~RMbrQ2oCgJPGh1b0fz#qB zGOEo3D(NaUn>mzaao)~iXTQs3)v_#h@o9!y64`iQ*M_M95QcrbHarH2U>qKY6~#1i zS9o3hRXjGZbpiY^akI3Ig+H0{uYUPSR}H}^e<*we`Dj5@DzwG+k+wMAnRw#jo6VD$ zmR#CD7Gqt~nlR86$BNweDM$gSDW|^XW(%pFAM!x4e3XtK8>-g4o7f#ZwOdl>H0!vD z8sbh*VXlJQ^HMs)4D5<+nMvYY-xg_qx?a3(_iqdqLk;Cy4 zzkq=0xdJRFTO6d^Flzx2X<4(8>7$X;Cfz@0 zOy0E(-xcw@_so#@PH1q{zqTOKJ)JXN!_pVY_twD{z=he&vSu3l>(jLDczN0+i&wPrkxfR$FIi_iZL{p4e>&sW@ShgXuT)Ha{XR$4cSyd> z)AR|^sG$4r>RrO~(W9)>SEx5`hhL!H`@kkfHEnxu==w9DT7dl9GSBJKIAcEI(KCx_ z!8|ZSOiHwPW^HEEh}WjA19uM1Lxs;hd-49LWOt^l7iEG-z22B~B&g!2Nyp%$FMe9H z(C$8NrkYdvOIGXW9Zsey+CO~YyWKcIgrtDs zaYl<{uxO67YiVE4m)A9iPsJ_sgdYUw59Z=c(Q8f7m$T3l#%&|Vf(cV`Dkg$F-0OnK zu=upF9q0YbJledd?PBlhqLWcAD04JXP_!Y`Us5W$u36w(wO!1w45v*xwfhB6ZBVkm zKNyh^bM_JeA5h#&4M>yZ@A*h6EJuo3T8B6`TK|PwquEC)Q`pTqWFJ0aH}BDlF9!!r zJBLb#RhM=m>{*a7s+c~kJNanY;plV(=xV1h2;4wm8sTmJ$3uwuTJQCjB7EuqioUuB zGq+xu@IZa_d&zHeGnK#UZ!;W2Vr|a1@LaY#WSKUwI@HXWHu!$$6X;j{SIfVe!txob zf&x~COYKJJuTt5}8SJ}~Qo6X3svcww7K=W=kXIyD$ekaEEB(2Htza5!F!C%7HKy7U zV4Zl-3-AR1b@DMffH`rNGoW0O0r<|dMkAYx>GSV5?ETI3sn|4nvuSkXCMXU-Y}*|d zskpQ8{OYJh#y&P%rq4Z5Kw4t1T&0b2r5JHeF>_Eq+^_$_W>YulZ;?Ni>dME1F#!!# zTa@nVa->uyQz*bkXl<9GA#NknBQ7@C*utglrq;FjUM8Ts1{bLuwqdxF{iS0Iay6IP z>U1Mh+a0D6nP&x1AADqWg893sH-s!>9|DWK=uFzfwez7#RBAU|M*(M^&1ScR3pc62 zU@|{SIte){BnTtGtB6jI6OPqq>-zZ1`(UYx#yfs(%g6-IozK32StdXpK4h;@8)eT% z&KhMkcpN@&OFaNRVCh+BpM`@KJ~k0qM1PFF4IP8jEJ?ianzTokycclin#d(|yaYF} zo}?#h3%GArNa?{!>m;=jFCF>^n+89kXZH?Hs3|mUAFL162XiNZe3v6boGKE#(4~nE z5*8nJW^kl?v70&T-ArC6`s&F}0Fk;Gn(}LW)e$$NKqTP_tlmca7nOJm{x`ty)<&PDi3i?KQz#T|gvLjotE-|jslx8( zvRZ0lFh~%jXlMXPTRl=v)AkTgf9+{l(Q?fyd2$5xsuM4g?T<^=ZJ!kZL}OFvUc*=oRi^Sb`dheMQjRQh z(@m=dUuxxDwTTsp@gttxbBnckF*%ky<_hA4cX4=nQOb!^s6@)a41m}=cV}sCdRW}D zZ+6}y%NASH#--=&MsHmE*m5uTjLrX}GI{Po%-g&EgCndilg1Jh+Rp;JwU~ig*&+OjGO%^3pw?d6CQo`V-6~MN5Xt}C@;Bi#w+)47_NtK+tDL@Q0xtiTA=QiKQrO2z?jjb zX2fnkvgXJkSf+GS?u1xm8vew6ljr{$f#~r zDEeSjQ6CJ9XM(e4gRPXyR9PQPMdLv@6U3Jv?0;)zy(7=(bv`ad{nfSvINpFeYW;E# zWVQMg6Q}Z6gPyjLwAs{k)3_!L#!QTq$UuQg%m*6_uaH~Igs6WvOt1RJ5Y#E$kmQYO zt>Ve>kXWIir|wBidwp(;`a~IPUsP4(8XC1Ll+NbMR1nqeiMWz5L)`FkATq+}%ssS@ z#_+jS?6KyGiP39tbjmpnVsiQPSsM$lXROUp8@ajPou3!SFy5>+baAu4l+>ihGl?tKP~S8DIk$Vc}m;dWC@i`-d)rNlj909Oz!Pe*W2o zuQfEkpHl@L>qQgU)%MR7=u|;(^$NQ{+6(d-gV98zW*9Nm z-Og;=WnjE`bklai zHtE3bmlYZZ*LAgfUS0HY!-hj!pI)~~J0q^`ZjcusjqZ^`)g35e+SV5m=bnk5WA_D+ zzo26w3HeRc9)ZCXt`*`r z0LLVYnzA{9_~B|Nrp`3>YNx7>_tPWEoTq_#qtS@LhZP!U|1|p z)&7Le;qi$eyv;r(bLZgO2`xwCYh;x4S*E(n5f~9bx$Hn0#Z~JpRlSNvZCz>MDkWO@ zcAQ`Gc-Lu9>cysIioMii^g_yK{(5!tNot;6oOM*T?P%h{Wx9bowK(R zc#0V$Ikt>{kj_3rE$k)vNoz8N583=!$Pg}$)OGF&8zXSO*h38I>#zJg$S7RbzSxYQ z8O{k~;=)fs@&!!A5Q;d&lH2;wg3I_w(8_W`Pl*BVQ@0fyj6s(9vG5@;18PJ{Q1uua z8K9jn>jGp=f#W6jD@l5_K_W0+@(MSDY=j3Zwr2?m7#?1YrmRXNnA0}BUK8GslDExP zhFb5DU*#sPG4aVS8OB`iQG@?^Eq-+Nf4embS;jxCm*(o}Hvfywe-?kTU~{0~^|h0M QTMRiqJAMCn?n%h_A0L!DR{#J2 literal 0 HcmV?d00001 diff --git a/docs/api-ref.md b/docs/api-ref.md index 4b95a1277..19840915e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -5,21 +5,21 @@ layout: docs

      Important: More coming soon! This section is under active construction and might not reflect all the available functionality of the TSC library. - -
      - - + + + + The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. -The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. +The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. -|:--- | +|:--- | | **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| - -* TOC + +* TOC {:toc }
      @@ -29,29 +29,29 @@ The TSC API reference is organized by resource. The TSC library is modeled after ## Authentication -You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. +You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API.
      -
      +
      ### TableauAuth class ```py TableauAuth(username, password, site_id='', user_id_to_impersonate=None) ``` -The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. +The `TableauAuth` class defines the information you can set in a sign-in request. The class members correspond to the attributes of a server request or response payload. To use this class, create a new instance, supplying user name, password, and site information if necessary, and pass the request object to the [Auth.sign_in](#auth.sign-in) method. + - - **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). + **Note:** In the future, there might be support for additional forms of authorization and authentication (for example, OAuth). -**Attributes** +**Attributes** -Name | Description -:--- | :--- -`username` | The name of the user whose credentials will be used to sign in. -`password` | The password of the user. -`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. -`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. +Name | Description +:--- | :--- +`username` | The name of the user whose credentials will be used to sign in. +`password` | The password of the user. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. Source file: models/tableau_auth.py @@ -59,25 +59,55 @@ Source file: models/tableau_auth.py ```py import tableauserverclient as TSC -# create a new instance of a TableauAuth object for authentication tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') - -# create a server instance -# pass the "tableau_auth" object to the server.auth.sign_in() method +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.auth.sign_in(tableau_auth) ```
      -
      +
      + +### PersonalAccessTokenAuth class + +```py +PersonalAccessTokenAuth(token_name, personal_access_token, site_id='') +``` +The `PersonalAccessTokenAuth` class serves the same purpose and is used in the same way as `TableauAuth`, but using Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) instead of username and password. + +**Attributes** + +Name | Description +:--- | :--- +`token_name` | The personal access token name. +`personal_access_token` | The personal access token value. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. + +Source file: models/personal_access_token_auth.py + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.PersonalAccessToken('TOKEN-NAME', 'TOKEN-VALUE', site_id='CONTENTURL') +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.auth.sign_in(tableau_auth) +``` + +
      +
      ### Auth methods The Tableau Server Client provides two methods for interacting with authentication resources. These methods correspond to the sign in and sign out endpoints in the Tableau Server REST API. - Source file: server/endpoint/auth_endpoint.py +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +

      -
      #### auth.sign_in @@ -94,7 +124,7 @@ REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/res **Parameters** -`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. +`auth_req` : The `TableauAuth` object that holds the sign-in credentials for the site. **Example** @@ -110,14 +140,8 @@ server = TSC.Server('https://SERVER_URL') # call the sign-in method with the auth object server.auth.sign_in(tableau_auth) - ``` - -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) -

      @@ -136,18 +160,36 @@ REST API: [Sign Out](https://help.tableau.com/current/api/rest_api/en-us/REST/re **Example** ```py - server.auth.sign_out() +``` + +
      +
      +#### auth.switch_site +```py +auth.switch_site(site_id) ``` +Switch to a different site on the current Tableau Server. +Switching avoids the need for reauthenticating to the same server. (Note: This method is not available in Tableau Online.) +REST API: [Switch Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#switch_site) -**See Also** -[Sign in and Out](sign-in-out) -[Server](#server) +**Parameters** + +`site_item` | The site that you want to switch to. This should be a `SiteItem` retrieved from `sites.get()`, `sites.get_by_id()` or `sites.get_by_name{}`. + + +**Example** + +```py +# find and then switch auth to another site on the same server +site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') +server.auth.switch_site(site) +```

      @@ -157,7 +199,7 @@ server.auth.sign_out() ## Connections -The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. +The connections for Tableau Server data sources and workbooks are represented by a `ConnectionItem` class. You can call data source and workbook methods to query or update the connection information. The `ConnectionCredentials` class represents the connection information you can update. ### ConnectionItem class @@ -167,23 +209,23 @@ ConnectionItem() The `ConnectionItem` class corresponds to workbook and data source connections. -In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. +In the Tableau Server REST API, there are separate endpoints to query and update workbook and data source connections. -**Attributes** +**Attributes** -Name | Description - :--- | : --- -`datasource_id` | The identifier of the data source. +Name | Description + :--- | : --- +`datasource_id` | The identifier of the data source. `datasource_name` | The name of the data source. `id` | The identifier of the connection. -`connection_type` | The type of connection. -`username` | The username for the connection. -`password` | The password used for the connection. -`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). -`server_address` | The server address for the connection. -`server_port` | The port used for the connection. +`connection_type` | The type of connection. +`username` | The username for the connection. +`password` | The password used for the connection. +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`server_address` | The server address for the connection. +`server_port` | The port used for the connection. -Source file: models/connection_item.py +Source file: models/connection_item.py

      @@ -197,7 +239,7 @@ ConnectionCredentials(name, password, embed=True, oauth=False) ``` -The `ConnectionCredentials` class is used for workbook and data source publish requests. +The `ConnectionCredentials` class is used for workbook and data source publish requests. @@ -206,10 +248,10 @@ The `ConnectionCredentials` class is used for workbook and data source publish r Attribute | Description :--- | :--- `name` | The username for the connection. -`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). -`password` | The password used for the connection. -`server_address` | The server address for the connection. -`server_port` | The port used by the server. +`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). +`password` | The password used for the connection. +`server_address` | The server address for the connection. +`server_port` | The port used by the server. `ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). @@ -222,8 +264,8 @@ Source file: models/connection_credentials.py ## Data sources -Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. -The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class. +Using the TSC library, you can get all the data sources on a site, or get the data sources for a specific project. +The data source resources for Tableau Server are defined in the `DatasourceItem` class. The class corresponds to the data source resources you can access using the Tableau Server REST API. For example, you can gather information about the name of the data source, its type, its connections, and the project it is associated with. The data source methods are based upon the endpoints for data sources in the REST API and operate on the `DatasourceItem` class.
      @@ -235,23 +277,23 @@ DatasourceItem(project_id, name=None) The `DatasourceItem` represents the data source resources on Tableau Server. This is the information that can be sent or returned in the response to an REST API request for data sources. When you create a new `DatasourceItem` instance, you must specify the `project_id` that the data source is associated with. -**Attributes** +**Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. +`content_url` | The name of the data source as it would appear in a URL. `created_at` | The date and time when the data source was created. `certified` | A Boolean value that indicates whether the data source is certified. -`certification_note` | The optional note that describes the certified data source. -`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. -`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. -`name` | The name of the data source. If not specified, the name of the published data source file is used. +`certification_note` | The optional note that describes the certified data source. +`datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. +`id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. +`name` | The name of the data source. If not specified, the name of the published data source file is used. `owner_id` | The identifier of the owner of the data source. `project_id` | The identifier of the project associated with the data source. You must provide this identifier when you create an instance of a `DatasourceItem`. -`project_name` | The name of the project associated with the data source. -`tags` | The tags (list of strings) that have been added to the data source. -`updated_at` | The date and time when the data source was last updated. +`project_name` | The name of the project associated with the data source. +`tags` | The tags (list of strings) that have been added to the data source. +`updated_at` | The date and time when the data source was last updated. **Example** @@ -267,44 +309,44 @@ Name | Description Source file: models/datasource_item.py -
      +

      ### Datasources methods -The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. +The Tableau Server Client provides several methods for interacting with data source resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. Source file: server/endpoint/datasources_endpoint.py -
      +

      -#### datasources.delete +#### datasources.delete ```py datasources.delete(datasource_id) ``` -Removes the specified data source from Tableau Server. +Removes the specified data source from Tableau Server. -**Parameters** +**Parameters** -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to delete from the server. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. REST API: [Delete Datasource](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref.htm#delete_data_source) -
      +

      @@ -320,23 +362,23 @@ REST API: [Download Datasource](https://help.tableau.com/current/api/rest_api/en **Parameters** -Name | Description -:--- | :--- -`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. -`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. +Name | Description +:--- | :--- +`datasource_id` | The identifier (`id`) for the `DatasourceItem` that you want to download from the server. +`filepath` | (Optional) Downloads the file to the location you specify. If no location is specified (the default is `Filepath=None`), the file is downloaded to the current working directory. `include_extract` | (Optional) Specifies whether to download the file with the extract. The default is to include the extract, if present (`include_extract=True`). When the data source has an extract, if you set the parameter `include_extract=False`, the extract is not included. You can use this parameter to improve performance if you are downloading data sources that have large extracts. Available starting with Tableau Server REST API version 2.5. -`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. +`no_extract` | (**Deprecated**) Use `include_extract` instead. The default value is to ignore this parameter (`no_extract=None`). If you set the parameter to `no_extract=True`, the download will not include an extract (if there is one). If set to `no_extract=False`, the download will include the extract (if there is one). Available starting with Tableau Server REST API version 2.5. **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. -**Returns** +**Returns** -The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. +The file path to the downloaded data source. The data source is downloaded in `.tdsx` or `.hyper` format. **Example** @@ -347,7 +389,7 @@ The file path to the downloaded data source. The data source is downloaded in `. ``` - +

      @@ -357,7 +399,7 @@ The file path to the downloaded data source. The data source is downloaded in `. datasources.get(req_options=None) ``` -Returns all the data sources for the site. +Returns all the data sources for the site. To get the connection information for each data source, you must first populate the `DatasourceItem` with connection information using the [populate_connections(*datasource_item*)](#populate-connections-datasource) method. For more information, see [Populate Connections and Views](populate-connections-views#populate-connections-for-data-sources) @@ -365,9 +407,9 @@ REST API: [Query Datasources](https://help.tableau.com/current/api/rest_api/en-u **Parameters** -Name | Description -:--- | :--- -`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. +Name | Description +:--- | :--- +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific data source, you could specify the name of the project or its id. **Returns** @@ -402,22 +444,22 @@ with server.auth.sign_in(tableau_auth): datasources.get_by_id(datasource_id) ``` -Returns the specified data source item. +Returns the specified data source item. REST API: [Query Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source) **Parameters** -Name | Description -:--- | :--- -`datasource_id` | The `datasource_id` specifies the data source to query. +Name | Description +:--- | :--- +`datasource_id` | The `datasource_id` specifies the data source to query. **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Datasource ID undefined` | Raises an exception if a valid `datasource_id` is not provided. @@ -436,8 +478,8 @@ print(datasource.name) ``` -
      -
      +
      +
       @@ -449,14 +491,14 @@ datasources.populate_connections(datasource_item) Populates the connections for the specified data source. -This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. +This method retrieves the connection information for the specified data source. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the connection information is not included. Use this method to retrieve the connections. The method adds the list of data connections to the data source item (`datasource_item.connections`). This is a list of `ConnectionItem` objects. REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `datasource_item` | The `datasource_item` specifies the data source to populate with connection information. @@ -464,14 +506,14 @@ Name | Description **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. **Returns** -None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). +None. A list of `ConnectionItem` objects are added to the data source (`datasource_item.connections`). **Example** @@ -480,14 +522,14 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# - ... +# + ... # get the data source datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') -# get the connection information +# get the connection information server.datasources.populate_connections(datasource) # print the information about the first connection item @@ -500,8 +542,8 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour ``` -
      -
      +
      +
      #### datasources.publish @@ -509,35 +551,35 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour datasources.publish(datasource_item, file_path, mode, connection_credentials=None) ``` -Publishes a data source to a server, or appends data to an existing data source. +Publishes a data source to a server, or appends data to an existing data source. -This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. +This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). -`file_path` | The path and name of the data source to publish. +`file_path` | The path and name of the data source to publish. `mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). - +`connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). + **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Only .tds, tdsx, .tde, or .hyper files can be published as datasources.` | Raises an error if the type of file specified is not supported. **Returns** -The `DatasourceItem` for the data source that was added or appended to. +The `DatasourceItem` for the data source that was added or appended to. **Example** @@ -546,12 +588,12 @@ The `DatasourceItem` for the data source that was added or appended to. import tableauserverclient as TSC server = TSC.Server('https://SERVERURL') - + ... project_id = '3a8b6148-493c-11e6-a621-6f3499394a39' file_path = r'C:\temp\WorldIndicators.tde' - + # Use the project id to create new datsource_item new_datasource = TSC.DatasourceItem(project_id) @@ -563,8 +605,8 @@ The `DatasourceItem` for the data source that was added or appended to. ... ``` -
      -
      +
      +
      #### datasources.refresh @@ -572,22 +614,22 @@ The `DatasourceItem` for the data source that was added or appended to. datasource.refresh(datasource_item) ``` -Refreshes the data of the specified extract. +Refreshes the data of the specified extract. REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) **Parameters** -Name | Description - :--- | : --- +Name | Description + :--- | : --- `datasource_item` | The `datasource_item` specifies the data source to update. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. @@ -598,14 +640,14 @@ A refreshed `DatasourceItem`. **Example** -```py +```py # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# sign in ... - +# sign in ... + # get the data source item to update datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - + # call the refresh method with the data source item refreshed_datasource = server.datasources.refresh(datasource) @@ -625,16 +667,16 @@ REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-u **Parameters** -Name | Description - :--- | : --- +Name | Description + :--- | : --- `datasource_item` | The `datasource_item` specifies the data source to update. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `Datasource item missing ID. Datasource must be retrieved from server first.` | Raises an error if the datasource_item is unspecified. Use the `Datasources.get()` method to retrieve that identifies for the data sources on the server. @@ -645,15 +687,15 @@ An updated `DatasourceItem`. **Example** -```py +```py # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# sign in ... - +# sign in ... + # get the data source item to update datasource = server.datasources.get_by_id('1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b') - -# do some updating + +# do some updating datasource.owner_id = 'New Owner ID' # call the update method with the data source item @@ -678,10 +720,10 @@ REST API: [Update Datasource Connection](https://help.tableau.com/current/api/re **Parameters** -Name | Description - :--- | : --- -`datasource_item` | The `datasource_item` specifies the data source to update. -`connection_item` | The `connection_item` that has the information you want to update. +Name | Description + :--- | : --- +`datasource_item` | The `datasource_item` specifies the data source to update. +`connection_item` | The `connection_item` that has the information you want to update. **Returns** @@ -693,12 +735,12 @@ An updated `ConnectionItem` for the data source. See the `update_connection.py` sample in the Samples directory. -
      -
      +
      +
      ## Filters -The TSC library provides a `Filter` class that you can use to filter results returned from the server. +The TSC library provides a `Filter` class that you can use to filter results returned from the server. You can use the `Filter` and `RequestOptions` classes to filter and sort the following endpoints: @@ -707,23 +749,23 @@ You can use the `Filter` and `RequestOptions` classes to filter and sort the fol - Workbooks - Views -For more information, see [Filter and Sort](filter-sort). +For more information, see [Filter and Sort](filter-sort). ### Filter class -```py +```py Filter(field, operator, value) ``` -The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. +The `Filter` class corresponds to the *filter expressions* in the Tableau REST API. **Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `Field` | Defined in the `RequestOptions.Field` class. `Operator` | Defined in the `RequestOptions.Operator` class `Value` | The value to compare with the specified field and operator. @@ -732,8 +774,8 @@ Name | Description -
      -
      +
      +
      --- @@ -743,8 +785,8 @@ Using the TSC library, you can get information about all the groups on a site, y The group resources for Tableau Server are defined in the `GroupItem` class. The class corresponds to the group resources you can access using the Tableau Server REST API. The group methods are based upon the endpoints for groups in the REST API and operate on the `GroupItem` class. -
      -
      +
      +
      ### GroupItem class @@ -758,11 +800,11 @@ Source file: models/group_item.py **Attributes** -Name | Description -:--- | :--- -`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). -`id` | The id of the group. -`users` | The list of users (`UserItem`). +Name | Description +:--- | :--- +`domain_name` | The name of the Active Directory domain (`local` if local authentication is used). +`id` | The id of the group. +`users` | The list of users (`UserItem`). `name` | The name of the group. The `name` is required when you create an instance of a group. @@ -778,8 +820,8 @@ Name | Description -
      -
      +
      +
      ### Groups methods @@ -789,8 +831,8 @@ The Tableau Server Client provides several methods for interacting with group re Source file: server/endpoint/groups_endpoint.py -
      -
      +
      +
      #### groups.add_user @@ -798,24 +840,24 @@ Source file: server/endpoint/groups_endpoint.py groups.add_user(group_item, user_id): ``` -Adds a user to the specified group. +Adds a user to the specified group. REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `group_item` | The `group_item` specifies the group to update. -`user_id` | The id of the user. +`user_id` | The id of the user. **Returns** -None. +None. **Example** @@ -836,7 +878,7 @@ None. ``` -
      +

      #### groups.create @@ -845,7 +887,7 @@ None. create(group_item) ``` -Creates a new group in Tableau Server. +Creates a new group in Tableau Server. REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) @@ -853,15 +895,15 @@ REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/RES **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. **Returns** -Adds new `GroupItem`. +Adds new `GroupItem`. **Example** @@ -887,8 +929,8 @@ Adds new `GroupItem`. print(group.name, group.id) ``` -
      -
      +
      +
      #### groups.delete @@ -896,22 +938,22 @@ Adds new `GroupItem`. groups.delete(group_id) ``` -Deletes the group on the site. +Deletes the group on the site. REST API: [Delete Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) -**Parameters** +**Parameters** -Name | Description -:--- | :--- -`group_id` | The identifier (`id`) for the group that you want to remove from the server. +Name | Description +:--- | :--- +`group_id` | The identifier (`id`) for the group that you want to remove from the server. **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Group ID undefined` | Raises an exception if a valid `group_id` is not provided. @@ -928,7 +970,7 @@ Error | Description server.groups.delete('1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d') ``` -
      +

      #### groups.get @@ -937,24 +979,24 @@ Error | Description groups.get(req_options=None) ``` -Returns information about the groups on the site. +Returns information about the groups on the site. -To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. +To get information about the users in a group, you must first populate the `GroupItem` with user information using the [groups.populate_users](api-ref#groupspopulate_users) method. REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) **Parameters** -Name | Description -:--- | :--- -`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. +Name | Description +:--- | :--- +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific group, you could specify the name of the group or the group id. **Returns** -Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. +Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these values to iterate through the results. **Example** @@ -976,8 +1018,8 @@ Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these ``` -
      -
      +
      +
      #### groups.populate_users @@ -985,17 +1027,17 @@ Returns a list of `GroupItem` objects and a `PaginationItem` object. Use these groups.populate_users(group_item, req_options=None) ``` -Populates the `group_item` with the list of users. +Populates the `group_item` with the list of users. REST API: [Get Users in Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_in_group) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `group_item` | The `group_item` specifies the group to populate with user information. -`req_options` | (Optional) Additional request options to send to the endpoint. +`req_options` | (Optional) Additional request options to send to the endpoint. @@ -1006,7 +1048,7 @@ Name | Description **Returns** -None. A list of `UserItem` objects are added to the group (`group_item.users`). +None. A list of `UserItem` objects are added to the group (`group_item.users`). **Example** @@ -1015,28 +1057,28 @@ None. A list of `UserItem` objects are added to the group (`group_item.users`). # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# - ... +# + ... # get the group all_groups, pagination_item = server.groups.get() mygroup = all_groups[1] -# get the user information +# get the user information pagination_item = server.groups.populate_users(mygroup) # print the names of the users for user in mygroup.users : - print(user.name) - + print(user.name) + ``` -
      -
      +
      +
      #### groups.remove_user @@ -1054,23 +1096,23 @@ REST API: [Remove User from Group](https://help.tableau.com/current/api/rest_api **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `group_item` | The `group_item` specifies the group to remove the user from. -`user_id` | The id for the user. +`user_id` | The id for the user. **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Group must be populated with users first.` | Raises an error if the `group_item` is unpopulated. **Returns** -None. The user is removed from the group. +None. The user is removed from the group. **Example** @@ -1092,7 +1134,7 @@ None. The user is removed from the group. ``` -
      +

      --- @@ -1117,16 +1159,16 @@ The `JobItem` class contains information about the specified job running on Tabl Source file: models/job_item.py -**Attributes** +**Attributes** Name | Description -:--- | :--- -`id` | The `id` of the job. -`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. +:--- | :--- +`id` | The `id` of the job. +`type` | The type of task. The types correspond to the job type categories listed for the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) REST API. `created_at` | The time the job was created. -`started_at` | The time the job started. -`completed_at` | The time the job finished. -`finish_code` | The return code from job. +`started_at` | The time the job started. +`completed_at` | The time the job finished. +`finish_code` | The return code from job. ### Jobs methods @@ -1138,7 +1180,7 @@ The Jobs methods are based upon the endpoints for jobs in the REST API and opera Source files: server/endpoint/jobs_endpoint.py
      -
      +
      #### jobs.get @@ -1149,15 +1191,15 @@ jobs.get(job_id) ``` -Gets information about the specified job. +Gets information about the specified job. REST API: [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `job_id` | The `job_id` specifies the id of the job that is returned from an asynchronous task, such as extract refresh, or an import or update to groups using Active Directory @@ -1165,8 +1207,8 @@ Name | Description **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `404018 Resource Not Found` | Raises an error if the `job_id` is not found. @@ -1187,7 +1229,7 @@ Returns the `JobItem` requested. with server.auth.sign_in(tableau_auth): # get the id of the job from response to extract refresh task, - # or another asynchronous REST API call. + # or another asynchronous REST API call. # in this case, "576b616d-341a-4539-b32c-1ed0eb9db548" @@ -1196,10 +1238,10 @@ Returns the `JobItem` requested. print(jobinfo) - # - + # + + - ``` @@ -1219,44 +1261,44 @@ The project resources for Tableau are defined in the `ProjectItem` class. The cl -
      +
      -### ProjectItem class +### ProjectItem class ```py ProjectItem(name, description=None, content_permissions=None, parent_id=None) ``` -The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. +The project resources for Tableau are defined in the `ProjectItem` class. The class corresponds to the project resources you can access using the Tableau Server REST API. -**Attributes** +**Attributes** Name | Description -:--- | :--- +:--- | :--- `content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. `name` | Name of the project. -`description` | The description of the project. +`description` | The description of the project. `id` | The project id. `parent_id` | The id of the parent project. Use this option to create project hierarchies. For information about managing projects, project hierarchies, and permissions, see [Use Projects to Manage Content Access](https://help.tableau.com/current/server/en-us/projects.htm). -Source file: models/project_item.py +Source file: models/project_item.py #### ProjectItem.ContentPermissions The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). -Name | Description -:--- | :--- -`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. -`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. +Name | Description +:--- | :--- +`ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. +`ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. **Example** -```py +```py # import tableauserverclient as TSC # server = TSC.Server('https://MY-SERVER') @@ -1272,7 +1314,7 @@ print(by_owner) # prints 'ManagedByOwner' -# pass the content_permissions to new instance of the project item. +# pass the content_permissions to new instance of the project item. new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, description='Project example') ``` @@ -1280,7 +1322,7 @@ new_project = TSC.ProjectItem(name='My Project', content_permissions=by_owner, d

      -### Project methods +### Project methods The project methods are based upon the endpoints for projects in the REST API and operate on the `ProjectItem` class. @@ -1295,12 +1337,12 @@ Source files: server/endpoint/projects_endpoint.py ```py projects.create(project_item) -``` +``` Creates a project on the specified site. -To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). +To create a project, you first create a new instance of a `ProjectItem` and pass it to the create method. To specify the site to create the new project, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project) @@ -1308,12 +1350,12 @@ REST API: [Create Project](https://help.tableau.com/current/api/rest_api/en-us/R **Parameters** Name | Description -:--- | :--- -`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. +:--- | :--- +`project_item` | Specifies the properties for the project. The `project_item` is the request package. To create the request package, create a new instance of `ProjectItem`. **Returns** -Returns the new project item. +Returns the new project item. @@ -1324,51 +1366,51 @@ import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') server = TSC.Server('https://SERVER') -with server.auth.sign_in(tableau_auth): +with server.auth.sign_in(tableau_auth): # create project item new_project = TSC.ProjectItem(name='Example Project', content_permissions='LockedToProject', description='Project created for testing') - # create the project + # create the project new_project = server.projects.create(new_project) ```
      -
      +
      #### projects.get ```py -projects.get() +projects.get() ``` -Return a list of project items for a site. +Return a list of project items for a site. -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). REST API: [Query Projects](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_projects) -**Parameters** +**Parameters** None. -**Returns** +**Returns** Returns a list of all `ProjectItem` objects and a `PaginationItem`. Use these values to iterate through the results. - - **Example** -```py -import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') -server = TSC.Server('https://SERVER') + **Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') -with server.auth.sign_in(tableau_auth): +with server.auth.sign_in(tableau_auth): # get all projects on site all_project_items, pagination_item = server.projects.get() print([proj.name for proj in all_project_items]) @@ -1376,7 +1418,7 @@ with server.auth.sign_in(tableau_auth): ```
      -
      +
      #### projects.update @@ -1385,33 +1427,33 @@ with server.auth.sign_in(tableau_auth): projects.update(project_item) ``` -Modify the project settings. +Modify the project settings. -You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). +You can use this method to update the project name, the project description, or the project permissions. To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). REST API: [Update Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_project) **Parameters** -Name | Description -:--- | :--- -`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. +Name | Description +:--- | :--- +`project_item` | The project item object must include the project ID. The values in the project item override the current project settings. -**Exceptions** +**Exceptions** -Error | Description - :--- | : --- -`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. +Error | Description + :--- | : --- +`Project item missing ID.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. **Returns** -Returns the updated project information. +Returns the updated project information. See [ProjectItem class](#projectitem-class) -**Example** +**Example** ```py # import tableauserverclient as TSC @@ -1421,23 +1463,23 @@ See [ProjectItem class](#projectitem-class) ... # get list of projects all_project_items, pagination_item = server.projects.get() - + # update project item #7 with new name, etc. my_project = all_projects[7] my_project.name ='New name' - my_project.description = 'New description' - - # call method to update project + my_project.description = 'New description' + + # call method to update project updated_project = server.projects.update(my_project) - - + + ```
      -
      - +
      + #### projects.delete @@ -1448,7 +1490,7 @@ projects.delete(project_id) Deletes a project by ID. -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_project) @@ -1456,40 +1498,40 @@ REST API: [Delete Project](https://help.tableau.com/current/api/rest_api/en-us/R **Parameters** -Name | Description -:--- | :--- -`project_id` | The ID of the project to delete. +Name | Description +:--- | :--- +`project_id` | The ID of the project to delete. - -**Exceptions** -Error | Description -:--- | :--- -`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. +**Exceptions** +Error | Description +:--- | :--- +`Project ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. + + +**Example** -**Example** - ```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, etc. +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. server.projects.delete('1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') -``` +```
      -
      +
      --- ## Requests -The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. +The TSC library provides a `RequestOptions` class that you can use to filter results returned from the server. You can use the `Sort` and `RequestOptions` classes to filter and sort the following endpoints: @@ -1497,21 +1539,21 @@ You can use the `Sort` and `RequestOptions` classes to filter and sort the follo - Datasources - Groups - Workbooks -- Views +- Views + +You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. -You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files. +For more information about filtering and sorting, see [Filter and Sort](filter-sort). -For more information about filtering and sorting, see [Filter and Sort](filter-sort). - -
      +
      ### RequestOptions class -```py +```py RequestOptions(pagenumber=1, pagesize=100) ``` @@ -1520,12 +1562,12 @@ RequestOptions(pagenumber=1, pagesize=100) **Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `pagenumber` | The page number of the returned results. The default value is 1. `pagesize` | The number of items to return with each page (the default value is 100). -`sort()` | Returns a iterable set of `Sort` objects. -`filter()` | Returns an iterable set of `Filter` objects. +`sort()` | Returns a iterable set of `Sort` objects. +`filter()` | Returns an iterable set of `Filter` objects.

      @@ -1536,12 +1578,12 @@ Name | Description The `RequestOptions.Field` class corresponds to the fields used in filter expressions in the Tableau REST API. For more information, see [Filtering and Sorting](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) in the Tableau REST API. -**Attributes** +**Attributes** -**Attributes** +**Attributes** Field | Description -:--- | :--- +:--- | :--- `CreatedAt` | Same as 'createdAt' in the REST API. TSC. `RequestOptions.Field.CreatedAt` `LastLogin` | Same as 'lastLogin' in the REST API. `RequestOptions.Field.LastLogin` `Name` | Same as 'name' in the REST API. `RequestOptions.Field.Name` @@ -1561,10 +1603,10 @@ Field | Description Specifies the operators you can use to filter requests. -**Attributes** +**Attributes** Operator | Description -:--- | :--- +:--- | :--- `Equals` | Sets the operator to equals (same as `eq` in the REST API). `TSC.RequestOptions.Operator.Equals` `GreaterThan` | Sets the operator to greater than (same as `gt` in the REST API). `TSC.RequestOptions.Operator.GreaterThan` `GreaterThanOrEqual` | Sets the operator to greater than or equal (same as `gte` in the REST API). `TSC.RequestOptions.Operator.GreaterThanOrEqual` @@ -1573,7 +1615,7 @@ Operator | Description `In` | Sets the operator to in (same as `in` in the REST API). `TSC.RequestOptions.Operator.In`
      -
      +
      @@ -1582,12 +1624,12 @@ Operator | Description Specifies the direction to sort the returned fields. -**Attributes** +**Attributes** Name | Description -:--- | :--- +:--- | :--- `Asc` | Sets the sort direction to ascending (`TSC.RequestOptions.Direction.Asc`) -`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`). +`Desc` | Sets the sort direction to descending (`TSC.RequestOptions.Direction.Desc`).

      @@ -1601,8 +1643,8 @@ Use this class to specify view filters to be applied when the CSV data is genera **Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `maxage` | Optional. The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. **Example** @@ -1623,15 +1665,15 @@ server.views.populate_csv(view_item, csv_req_option) ### ImageRequestOptions class -```py +```py ImageRequestOptions(imageresolution=None, maxage=-1) ``` Use this class to specify the resolution of the view and, optionally, the maximum age of the image cached on the server. You can also use this class to specify view filters to be applied when the image is generated. See `views.populate_image`. **Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. `maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. @@ -1642,11 +1684,11 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. **Example** ```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. -# set the image request option +# set the image request option image_req_option = TSC.ImageRequestOptions(imageresolution=TSC.ImageRequestOptions.Resolution.High, maxage=1) # (optional) set a view filter @@ -1659,15 +1701,15 @@ server.views.populate_image(view_item, image_req_option) ### PDFRequestOptions class -```py +```py PDFRequestOptions(page_type=None, orientation=None, maxage=-1) ``` -Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. +Use this class to specify the format of the PDF that is returned for the view. Optionally, you can specify the maximum age of the rendered PDF that is cached on the server by providing a `maxage` value. See `views.populate_pdf`. **Attributes** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` `orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` `maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. @@ -1678,9 +1720,9 @@ You can use the `vf('filter_name', 'filter_value')` method to add view filters. **Example** ```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# sign in, get a specific view, etc. +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. # set the PDF request options pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, @@ -1697,13 +1739,13 @@ server.views.populate_pdf(view_item, pdf_req_option)
      -
      +
      --- -## Schedules +## Schedules -Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. +Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. @@ -1721,33 +1763,33 @@ The `ScheduleItem` class contains information about the specified schedule runni Source file: models/schedule_item.py -**Attributes** +**Attributes** Name | Description -:--- | :--- -`name` | The `name` of the schedule. -`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. -`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. -`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. -`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. - +:--- | :--- +`name` | The `name` of the schedule. +`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. +`schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. +`execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. +`interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. + #### IntervalItem class -This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. +This class sets the frequency and start time of the scheduled item. This class contains the classes for the hourly, daily, weekly, and monthly intervals. This class mirrors the options you can set using the REST API and the Tableau Server interface. -**Attributes** +**Attributes** Name | Description -:--- | :--- +:--- | :--- `HourlyInterval` | Runs scheduled item hourly. To set the hourly interval, you create an instance of the `HourlyInterval` class and assign the following values: `start_time`, `end_time`, and `interval_value`. To set the `start_time` and `end_time`, assign the time value using this syntax: `start_time=time(`*hour*`,` *minute*`)` and `end_time=time(`*hour*`,` *minute*`)`. The *hour* is specified in 24 hour time. The `interval_value` specifies how often the to run the task within the start and end time. The options are expressed in hours. For example, `interval_value=.25` is every 15 minutes. The values are `.25`, `.5`, `1`, `2`, `4`, `6`, `8`, `12`. Hourly schedules that run more frequently than every 60 minutes must have start and end times that are on the hour. -`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. -`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. -`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The +`DailyInterval` | Runs the scheduled item daily. To set the daily interval, you create an instance of the `DailyInterval` and assign the `start_time`. The start time uses the syntax `start_time=time(`*hour*`,` *minute*`)`. +`WeeklyInterval` | Runs the scheduled item once a week. To set the weekly interval, you create an instance of the `WeeklyInterval` and assign the start time and multiple instances for the `interval_value` (days of week and start time). The start time uses the syntax `time(`*hour*`,` *minute*`)`. The `interval_value` is the day of the week, expressed as a `IntervalItem`. For example `TSC.IntervalItem.Day.Monday` for Monday. +`MonthlyInterval` | Runs the scheduled item once a month. To set the monthly interval, you create an instance of the `MonthlyInterval` and assign the start time and day. The -### Schedule methods +### Schedule methods The schedule methods are based upon the endpoints for schedules in the REST API and operate on the `ScheduleItem` class. @@ -1759,136 +1801,136 @@ Source files: server/endpoint/schedules_endpoint.py ```py schedule.create(schedule_item) ``` -Creates a new schedule for an extract refresh or a subscription. +Creates a new schedule for an extract refresh or a subscription. REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_schedule) -**Parameters** - -Name | Description -:--- | :--- -`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. +**Parameters** + +Name | Description +:--- | :--- +`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. -**Returns** +**Returns** Returns a new instance of `schedule_item`. **Exceptions** -Error | Description -:--- | :--- -`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. +Error | Description +:--- | :--- +`Interval item must be defined.` | Raises an exception if the `schedule_item.interval_item` is not specified. The interval item specifies whether the interval is hourly, daily, weekly, or monthly. **Example** ```py import tableauserverclient as TSC -# sign in, etc. +# sign in, etc. # Create an interval to run every 2 hours between 2:30AM and 11:00PM hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), end_time=time(23, 0), interval_value=2) # Create schedule item hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) ```
      -
      +
      #### schedule.delete ```py schedule.delete(schedule_id) -``` +``` -Deletes an existing schedule for an extract refresh or a subscription. +Deletes an existing schedule for an extract refresh or a subscription. REST API: [Delete Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_schedule) -**Parameters** - -Name | Description -:--- | :--- -`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. +**Parameters** + +Name | Description +:--- | :--- +`schedule_id` | The identifier (`schedule_item.id`) of the schedule to delete. Use the `schedule.get()` method to get the identifiers of the schedules on the server. -**Returns** +**Returns** None. **Exceptions** -Error | Description -:--- | :--- -`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. +Error | Description +:--- | :--- +`Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. #### schedule.get ```py schedule.get([req_options=None]) -``` +``` -Returns all schedule items from the server. +Returns all schedule items from the server. REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) -**Parameters** - -Name | Description -:--- | :--- +**Parameters** + +Name | Description +:--- | :--- `req_options` | (Optional) Additional request options to send to the endpoint. #### schedule.update
      -
      +
      **Hourly schedule example** ```py import tableauserverclient as TSC -# sign in, etc. +# sign in, etc. # Create an interval to run every 2 hours between 2:30AM and 11:00PM hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), end_time=time(23, 0), interval_value=2) # Create schedule item hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) + # Create schedule + hourly_schedule = server.schedules.create(hourly_schedule) ``` **Daily schedule example** ```py import tableauserverclient as TSC -# sign in, etc. +# sign in, etc. # Create a daily interval to run every day at 12:30AM Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) # Create schedule item using daily interval daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) - # Create daily schedule + # Create daily schedule daily_schedule = server.schedules.create(daily_schedule) - + ``` **Weekly schedule example** ```py import tableauserverclient as TSC -# sign in, etc. +# sign in, etc. # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM weekly_interval = TSC.WeeklyInterval(time(19, 15), TSC.IntervalItem.Day.Monday, @@ -1896,9 +1938,9 @@ import tableauserverclient as TSC TSC.IntervalItem.Day.Friday) # Create schedule item using weekly interval weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, - TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) - # Create weekly schedule + # Create weekly schedule weekly_schedule = server.schedules.create(weekly_schedule) ``` @@ -1906,7 +1948,7 @@ import tableauserverclient as TSC **Monthly schedule example** ```py import tableauserverclient as TSC -# sign in, etc. +# sign in, etc. # Create a monthly interval to run on the 15th of every month at 11:30PM monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), interval_value=15) @@ -1921,19 +1963,19 @@ import tableauserverclient as TSC
      -
      +
      --- ## Server -In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) -The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources. +In the Tableau REST API, the server (`https://MY-SERVER/`) is the base or core of the URI that makes up the various endpoints or methods for accessing resources on the server (views, workbooks, sites, users, data sources, etc.) +The TSC library provides a `Server` class that represents the server. You create a server instance to sign in to the server and to call the various methods for accessing resources.
      -
      +
      ### Server class @@ -1941,13 +1983,13 @@ The TSC library provides a `Server` class that represents the server. You create ```py Server(server_address) ``` -The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. +The `Server` class contains the attributes that represent the server on Tableau Server. After you create an instance of the `Server` class, you can sign in to the server and call methods to access all of the resources on the server. **Attributes** Attribute | Description :--- | :--- -`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). @@ -1958,7 +2000,7 @@ Attribute | Description import tableauserverclient as TSC -# create a instance of server +# create a instance of server server = TSC.Server('https://MY-SERVER') # sign in, etc. @@ -1966,48 +2008,48 @@ server = TSC.Server('https://MY-SERVER') # change the REST API version to match the server server.use_server_version() -# or change the REST API version to match a specific version +# or change the REST API version to match a specific version # for example, 2.8 -# server.version = '2.8' +# server.version = '2.8' ``` -#### Server.*Resources* +#### Server.*Resources* -When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` +When you create an instance of the `Server` class, you have access to the resources on the server after you sign in. You can select these resources and their methods as members of the class, for example: `server.views.get()` -Resource | Description - :--- | : --- +Resource | Description + :--- | : --- *server*.auth | Sets authentication for sign in and sign out. See [Auth](#authentication) | -*server*.views | Access the server views and methods. See [Views](#views) -*server*.users | Access the user resources and methods. See [Users](#users) -*server*.sites | Access the sites. See [Sites](#sites) -*server*.groups | Access the groups resources and methods. See [Groups](#groups) -*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) +*server*.views | Access the server views and methods. See [Views](#views) +*server*.users | Access the user resources and methods. See [Users](#users) +*server*.sites | Access the sites. See [Sites](#sites) +*server*.groups | Access the groups resources and methods. See [Groups](#groups) +*server*.jobs | Access the jobs resources and methods. See [Jobs](#jobs) *server*.workbooks | Access the resources and methods for workbooks. See [Workbooks](#workbooks) *server*.datasources | Access the resources and methods for data sources. See [Data Sources](#data-sources) *server*.projects | Access the resources and methods for projects. See [Projects](#projects) *server*.schedules | Access the resources and methods for schedules. See [Schedules](#schedules) *server*.subscriptions | Access the resources and methods for subscriptions. See [Subscriptions](#subscriptions) -*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class) +*server*.server_info | Access the resources and methods for server information. See [ServerInfo class](#serverinfoitem-class)

      #### Server.PublishMode -The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. +The `Server` class has `PublishMode` class that enumerates the options that specify what happens when you publish a workbook or data source. The options are `Overwrite`, `Append`, or `CreateNew`. -**Properties** +**Properties** -Resource | Description - :--- | : --- -`PublishMode.Overwrite` | Overwrites the workbook or data source. +Resource | Description + :--- | : --- +`PublishMode.Overwrite` | Overwrites the workbook or data source. `PublishMode.Append` | Appends to the workbook or data source. -`PublishMode.CreateNew` | Creates a new workbook or data source. +`PublishMode.CreateNew` | Creates a new workbook or data source. **Example** @@ -2018,7 +2060,7 @@ Resource | Description print(TSC.Server.PublishMode.Overwrite) # prints 'Overwrite' - + overwrite_true = TSC.Server.PublishMode.Overwrite ... @@ -2039,15 +2081,15 @@ Resource | Description ```py ServerInfoItem(product_version, build_number, rest_api_version) ``` -The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. +The `ServerInfoItem` class contains the build and version information for Tableau Server. The server information is accessed with the `server_info.get()` method, which returns an instance of the `ServerInfo` class. -**Attributes** +**Attributes** -Name | Description -:--- | :--- -`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). +Name | Description +:--- | :--- +`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). `build_number` | Shows the specific build number (for example, 10200.17.0329.1446). -`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. +`rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number.
      @@ -2056,40 +2098,40 @@ Name | Description ### ServerInfo methods -The TSC library provides a method to access the build and version information from Tableau Server. +The TSC library provides a method to access the build and version information from Tableau Server. -
      +
      #### server_info.get ```py server_info.get() - + ``` -Retrieve the build and version information for the server. +Retrieve the build and version information for the server. -This method makes an unauthenticated call, so no sign in or authentication token is required. +This method makes an unauthenticated call, so no sign in or authentication token is required. REST API: [Server Info](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#server_info) - -**Parameters** - None - + +**Parameters** + None + **Exceptions** -Error | Description -:--- | :--- -`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. +Error | Description +:--- | :--- +`404003 UNKNOWN_RESOURCE` | Raises an exception if the server info endpoint is not found. **Example** ```py import tableauserverclient as TSC -# create a instance of server +# create a instance of server server = TSC.Server('https://MY-SERVER') -# set the version number > 2.3 +# set the version number > 2.3 # the server_info.get() method works in 2.4 and later server.version = '2.5' @@ -2099,13 +2141,13 @@ print("\tProduct version: {0}".format(s_info.product_version)) print("\tREST API version: {0}".format(s_info.rest_api_version)) print("\tBuild number: {0}".format(s_info.build_number)) -``` +```

      ---- +--- ## Sites @@ -2113,8 +2155,8 @@ Using the TSC library, you can query a site or sites on a server, or create or d The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. -
      -
      +
      +
      ### SiteItem class @@ -2129,16 +2171,16 @@ The `SiteItem` class contains the members or attributes for the site resources o Attribute | Description :--- | :--- -`name` | The name of the site. The name of the default site is "". -`content_url` | The path to the site. +`name` | The name of the site. The name of the default site is "". +`content_url` | The path to the site. `admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) `user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. `storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. -`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. -`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. -`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. -`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. -`state` | Shows the current state of the site (`Active` or `Suspended`). +`disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. +`subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. +`revision_history_enabled` | (Optional) Specify `true` to enable revision history for content resources (workbooks and datasources). The default is `false`. +`revision_limit` | (Optional) Specifies the number of revisions of a content source (workbook or data source) to allow. On Tableau Server, the default is 25. +`state` | Shows the current state of the site (`Active` or `Suspended`). **Example** @@ -2151,21 +2193,21 @@ new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode='Conte ``` -Source file: models/site_item.py +Source file: models/site_item.py
      -
      +
      ### Site methods -The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. +The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. -Source file: server/endpoint/sites_endpoint.py +Source file: server/endpoint/sites_endpoint.py
      -
      +
      #### sites.create @@ -2173,23 +2215,23 @@ Source file: server/endpoint/sites_endpoint.py sites.create(site_item) ``` -Creates a new site on the server for the specified site item object. +Creates a new site on the server for the specified site item object. -Tableau Server only. +Tableau Server only. REST API: [Create Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site) -**Parameters** - -Name | Description -:--- | :--- +**Parameters** + +Name | Description +:--- | :--- `site_item` | The settings for the site that you want to create. You need to create an instance of `SiteItem` and pass it to the `create` method. -**Returns** +**Returns** Returns a new instance of `SiteItem`. @@ -2199,7 +2241,7 @@ Returns a new instance of `SiteItem`. ```py import tableauserverclient as TSC -# create an instance of server +# create an instance of server server = TSC.Server('https://MY-SERVER') # create shortcut for admin mode @@ -2212,7 +2254,7 @@ new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=conten new_site = server.sites.create(new_site) ```
      -
      +
      #### sites.get @@ -2220,7 +2262,7 @@ new_site = server.sites.create(new_site) sites.get() ``` -Queries all the sites on the server. +Queries all the sites on the server. REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites) @@ -2230,9 +2272,9 @@ REST API: [Query Sites](https://help.tableau.com/current/api/rest_api/en-us/REST None. -**Returns** - -Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. +**Returns** + +Returns a list of all `SiteItem` objects and a `PaginationItem`. Use these values to iterate through the results. **Example** @@ -2268,26 +2310,26 @@ Queries the site with the given ID. REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) -**Parameters** +**Parameters** -Name | Description -:--- | :--- -`site_id` | The id for the site you want to query. +Name | Description +:--- | :--- +`site_id` | The id for the site you want to query. -**Exceptions** +**Exceptions** -Error | Description - :--- | : --- -`Site ID undefined.` | Raises an error if an id is not specified. +Error | Description + :--- | : --- +`Site ID undefined.` | Raises an error if an id is not specified. -**Returns** +**Returns** + +Returns the `SiteItem`. -Returns the `SiteItem`. - -**Example** +**Example** ```py @@ -2296,7 +2338,7 @@ Returns the `SiteItem`. # sign in, etc. a_site = server.sites.get_by_id('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d') - print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) + print("\nThe site with id '9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d' is: {0}".format(a_site.name)) ``` @@ -2314,26 +2356,26 @@ Queries the site with the specified name. REST API: [Query Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site) -**Parameters** +**Parameters** + +Name | Description +:--- | :--- +`site_name` | The name of the site you want to query. -Name | Description -:--- | :--- -`site_name` | The name of the site you want to query. +**Exceptions** -**Exceptions** +Error | Description + :--- | : --- +`Site Name undefined.` | Raises an error if an name is not specified. -Error | Description - :--- | : --- -`Site Name undefined.` | Raises an error if an name is not specified. +**Returns** -**Returns** +Returns the `SiteItem`. -Returns the `SiteItem`. - -**Example** +**Example** ```py @@ -2357,7 +2399,7 @@ Returns the `SiteItem`. sites.update(site_item) ``` -Modifies the settings for site. +Modifies the settings for site. The site item object must include the site ID and overrides all other settings. @@ -2366,27 +2408,27 @@ The site item object must include the site ID and overrides all other settings. REST API: [Update Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site) -**Parameters** +**Parameters** -Name | Description -:--- | :--- -`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. +Name | Description +:--- | :--- +`site_item` | The site item that you want to update. The settings specified in the site item override the current site settings. **Exceptions** Error | Description -:--- | :--- -`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. +:--- | :--- +`Site item missing ID.` | The site id must be present and must match the id of the site you are updating. `You cannot set admin_mode to ContentOnly and also set a user quota` | To set the `user_quota`, the `AdminMode` must be set to `ContentAndUsers` -**Returns** +**Returns** -Returns the updated `site_item`. +Returns the updated `site_item`. -**Example** +**Example** ```py ... @@ -2420,22 +2462,22 @@ REST API: [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST **Parameters** - -Name | Description - :--- | : --- -`site_id` | The id of the site that you want to delete. - +Name | Description + :--- | : --- +`site_id` | The id of the site that you want to delete. + + **Exceptions** -Error | Description -:--- | :--- -`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. +Error | Description +:--- | :--- +`Site ID Undefined.` | The site id must be present and must match the id of the site you are deleting. - -**Example** + +**Example** ```py @@ -2450,38 +2492,38 @@ server.sites.delete('9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d')

      ---- +--- ## Sort -The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. +The `Sort` class is used with request options (`RequestOptions`) where you can filter and sort on the results returned from the server. You can use the sort and request options to filter and sort the following endpoints: - Users - Datasources - Workbooks -- Views +- Views ### Sort class ```py sort(field, direction) -``` +``` -**Attributes** +**Attributes** Name | Description -:--- | :--- -`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. +:--- | :--- +`field` | Sets the field to sort on. The fields are defined in the `RequestOption` class. `direction` | The direction to sort, either ascending (`Asc`) or descending (`Desc`). The options are defined in the `RequestOptions.Direction` class. -**Example** +**Example** -```py +```py # create a new instance of a request option object req_option = TSC.RequestOptions() @@ -2495,10 +2537,10 @@ for wb in matching_workbooks: print(wb.name) ``` -For information about using the `Sort` class, see [Filter and Sort](filter-sort). +For information about using the `Sort` class, see [Filter and Sort](filter-sort).
      -
      +
      --- @@ -2517,11 +2559,11 @@ SubscriptionItem(subject, schedule_id, user_id, target) **Attributes** -Name | Description -:--- | :--- -`id` | The id of the subscription on the site. -`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. -`schedule_id` | The identifier associated with the specific subscription. +Name | Description +:--- | :--- +`id` | The id of the subscription on the site. +`subject`| The subject of the subscription. This is the description that you provide to identify the subscription. +`schedule_id` | The identifier associated with the specific subscription. `user_id` | The identifier of the user (person) who receives the subscription. `target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. @@ -2557,14 +2599,14 @@ REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en **Parameters** -Name | Description - :--- | : --- -`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. +Name | Description + :--- | : --- +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. **Returns** -Returns the new `SubscriptionItem` object. +Returns the new `SubscriptionItem` object. @@ -2578,7 +2620,7 @@ Returns the new `SubscriptionItem` object. # login, etc. -# create the target (content) of the subscription +# create the target (content) of the subscription # in this case, id of the workbook and the target type "workbook" target = TSC.Target('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') @@ -2594,7 +2636,7 @@ Returns the new `SubscriptionItem` object. newSub = server.subscriptions.create(newSub) print(newSub.subject) -``` +```
      @@ -2605,27 +2647,27 @@ Returns the new `SubscriptionItem` object. #### subscriptions.delete ```py -subscriptions.delete(subscription_id) +subscriptions.delete(subscription_id) ``` -Deletes the specified subscription from the site. +Deletes the specified subscription from the site. REST API: [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_subscription) **Parameters** -Name | Description - :--- | : --- -`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. +Name | Description + :--- | : --- +`subscription_id` | The identifier (`id`) for the subscription that you want to remove from the site. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `Subscription ID undefined` | Raises an exception if a valid `subscription_id` is not provided. @@ -2643,7 +2685,7 @@ Error | Description server.subscriptions.delete('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') ``` -
      +


      @@ -2661,13 +2703,13 @@ REST API: [Query Subscriptions](https://help.tableau.com/current/api/rest_api/en **Parameters** -Name | Description - :--- | : --- -`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. +Name | Description + :--- | : --- +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific subscription, you could specify the subject of the subscription or the id of the subscription. **Returns** -Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results. +Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use these values to iterate through the results.
      @@ -2680,23 +2722,23 @@ Returns a list of `SubscriptionItem` objects and a `PaginationItem` object. Use subscription.get_by_id(subscription_id) ``` -Returns information about the specified subscription. +Returns information about the specified subscription. REST API: [Query Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_subscription) **Parameters** -Name | Description - :--- | : --- -`subscription_id` | The `subscription_id` specifies the subscription to query. +Name | Description + :--- | : --- +`subscription_id` | The `subscription_id` specifies the subscription to query. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `No Subscription ID provided.` | Raises an exception if a valid `subscription_id` is not provided. @@ -2726,7 +2768,7 @@ The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) Using the TSC library, you can get information about all the users on a site, and you can add or remove users, or update user information. -The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. +The user resources for Tableau Server are defined in the `UserItem` class. The class corresponds to the user resources you can access using the Tableau Server REST API. The user methods are based upon the endpoints for users in the REST API and operate on the `UserItem` class. ### UserItem class @@ -2735,22 +2777,22 @@ The user resources for Tableau Server are defined in the `UserItem` class. The c UserItem(name, site_role, auth_setting=None) ``` -The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. +The `UserItem` class contains the members or attributes for the view resources on Tableau Server. The `UserItem` class defines the information you can request or query from Tableau Server. The class members correspond to the attributes of a server request or response payload. **Attributes** -Name | Description -:--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. -`domain_name` | The name of the site. -`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. -`id` | The id of the user on the site. -`last_login` | The date and time the user last logged in. -`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. -`email` | The email address of the user. -`fullname` | The full name of the user. -`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. +Name | Description +:--- | :--- +`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`domain_name` | The name of the site. +`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. +`id` | The id of the user on the site. +`last_login` | The date and time the user last logged in. +`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. +`email` | The email address of the user. +`fullname` | The full name of the user. +`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. +`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. **Example** @@ -2761,14 +2803,14 @@ Name | Description # create a new UserItem object. newU = TSC.UserItem('Monty', 'Publisher') - + print(newU.name, newU.site_role) ``` Source file: models/user_item.py -
      +

      @@ -2777,7 +2819,7 @@ Source file: models/user_item.py The Tableau Server Client provides several methods for interacting with user resources, or endpoints. These methods correspond to endpoints in the Tableau Server REST API. Source file: server/endpoint/users_endpoint.py -
      +

      #### users.add @@ -2786,7 +2828,7 @@ Source file: server/endpoint/users_endpoint.py users.add(user_item) ``` -Adds the user to the site. +Adds the user to the site. To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. @@ -2794,14 +2836,14 @@ REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us **Parameters** -Name | Description - :--- | : --- -`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. +Name | Description + :--- | : --- +`user_item` | You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. **Returns** -Returns the new `UserItem` object. +Returns the new `UserItem` object. @@ -2830,21 +2872,21 @@ users.get(req_options=None) Returns information about the users on the specified site. -To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. +To get information about the workbooks a user owns or has view permission for, you must first populate the `UserItem` with workbook information using the [populate_workbooks(*user_item*)](#populate-workbooks-user) method. REST API: [Get Users on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_users_on_site) **Parameters** -Name | Description - :--- | : --- -`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. +Name | Description + :--- | : --- +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific user, you could specify the name of the user or the user's id. **Returns** -Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. +Returns a list of `UserItem` objects and a `PaginationItem` object. Use these values to iterate through the results. **Example** @@ -2871,22 +2913,22 @@ with server.auth.sign_in(tableau_auth): users.get_by_id(user_id) ``` -Returns information about the specified user. +Returns information about the specified user. REST API: [Query User On Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_user_on_site) **Parameters** -Name | Description - :--- | : --- -`user_id` | The `user_id` specifies the user to query. +Name | Description + :--- | : --- +`user_id` | The `user_id` specifies the user to query. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `User ID undefined.` | Raises an exception if a valid `user_id` is not provided. @@ -2903,12 +2945,12 @@ The `UserItem`. See [UserItem class](#useritem-class) ``` -
      -
      +
      +
      #### users.populate_favorites - + ```py users.populate_favorites(user_item) ``` @@ -2917,8 +2959,8 @@ Returns the list of favorites (views, workbooks, and data sources) for a user. *Not currently implemented* -
      -
      +
      +
      #### users.populate_workbooks @@ -2927,17 +2969,17 @@ Returns the list of favorites (views, workbooks, and data sources) for a user. users.populate_workbooks(user_item, req_options=None): ``` -Returns information about the workbooks that the specified user owns and has Read (view) permissions for. +Returns information about the workbooks that the specified user owns and has Read (view) permissions for. -This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). +This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) **Parameters** -Name | Description - :--- | : --- +Name | Description + :--- | : --- `user_item` | The `user_item` specifies the user to populate with workbook information. @@ -2945,16 +2987,16 @@ Name | Description **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `User item missing ID.` | Raises an error if the `user_item` is unspecified. **Returns** -A list of `WorkbookItem` +A list of `WorkbookItem` -A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) +A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#useritem-class) **Example** @@ -2976,33 +3018,33 @@ A `PaginationItem` that points (`user_item.workbooks`). See [UserItem class](#us -
      +

      #### users.remove ```py -users.remove(user_id) +users.remove(user_id) ``` -Removes the specified user from the site. +Removes the specified user from the site. REST API: [Remove User from Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_from_site) **Parameters** -Name | Description - :--- | : --- -`user_id` | The identifier (`id`) for the user that you want to remove from the server. +Name | Description + :--- | : --- +`user_id` | The identifier (`id`) for the user that you want to remove from the server. **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `User ID undefined` | Raises an exception if a valid `user_id` is not provided. @@ -3019,19 +3061,19 @@ Error | Description server.users.remove('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') ``` -
      +

      -#### users.update +#### users.update ```py users.update(user_item, password=None) ``` -Updates information about the specified user. +Updates information about the specified user. The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). @@ -3041,18 +3083,18 @@ REST API: [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST **Parameters** -Name | Description - :--- | : --- +Name | Description + :--- | : --- `user_item` | The `user_item` specifies the user to update. -`password` | (Optional) The new password for the user. +`password` | (Optional) The new password for the user. **Exceptions** -Error | Description - :--- | : --- -`User item missing ID.` | Raises an error if the `user_item` is unspecified. +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. **Returns** @@ -3069,10 +3111,10 @@ An updated `UserItem`. See [UserItem class](#useritem-class) # server = TSC.Server('https://SERVERURL') with server.auth.sign_in(tableau_auth): - + # create a new user_item user1 = TSC.UserItem('temp', 'Viewer') - + # add new user user1 = server.users.add(user1) print(user1.name, user1.site_role, user1.id) @@ -3081,7 +3123,7 @@ An updated `UserItem`. See [UserItem class](#useritem-class) user1.name = 'Laura' user1.fullname = 'Laura Rodriguez' user1.email = 'laura@example.com' - + # update user user1 = server.users.update(user1) print("\Updated user info:") @@ -3092,8 +3134,8 @@ An updated `UserItem`. See [UserItem class](#useritem-class) -
      -
      +
      +
      --- @@ -3119,10 +3161,10 @@ Source file: models/view_item.py **Attributes** Name | Description -:--- | :--- +:--- | :--- `content_url` | The name of the view as it would appear in a URL. `csv` | The CSV data of the view. You must first call the `views.populate_csv` method to access the CSV data. -`id` | The identifier of the view item. +`id` | The identifier of the view item. `image` | The image of the view. You must first call the `views.populate_image`method to access the image. `name` | The name of the view. `owner_id` | The ID for the owner of the view. @@ -3133,7 +3175,7 @@ Name | Description `workbook_id` | The ID of the workbook associated with the view. -
      +

      @@ -3143,7 +3185,7 @@ The Tableau Server Client provides methods for interacting with view resources, Source file: server/endpoint/views_endpoint.py -
      +

      #### views.get @@ -3162,10 +3204,10 @@ This endpoint is available with REST API version 2.0 and up. **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific view, you could specify the name of the view or its ID. -`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. +`usage` | (Optional) If true (`usage=True`) returns the usage statistics for the views. The default is `usage=False`. @@ -3196,7 +3238,7 @@ for view in TSC.Pager(server.views): See [ViewItem class](#viewitem-class) -
      +

      #### views.populate_preview_image @@ -3217,15 +3259,15 @@ This endpoint is available with REST API version 2.0 and up. **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `view_item` | Specifies the view to populate. **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `View item missing ID or workbook ID` | Raises an error if the ID of the view or workbook is missing. @@ -3245,7 +3287,7 @@ with open('./view_preview_image.png', 'wb') as f: See [ViewItem class](#viewitem-class) -
      +

      #### views.populate_image @@ -3406,34 +3448,34 @@ The project resources for Tableau are defined in the `WorkbookItem` class. The c
      -
      +
      + +### WorkbookItem class -### WorkbookItem class +```py -```py - WorkbookItem(project_id, name=None, show_tabs=False) - + ``` The workbook resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. Some workbook methods take an instance of the `WorkbookItem` class as arguments. The workbook item specifies the project -**Attributes** +**Attributes** Name | Description -:--- | :--- +:--- | :--- `connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). -`content_url` | The name of the data source as it would appear in a URL. -`created_at` | The date and time when the data source was created. -`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. -`name` | The name of the workbook. +`content_url` | The name of the data source as it would appear in a URL. +`created_at` | The date and time when the data source was created. +`id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. +`name` | The name of the workbook. `owner_id` | The ID of the owner. -`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. +`preview_image` | The thumbnail image for the view. You must first call the [workbooks.populate_preview_image](#workbooks.populate_preview_image) method to access this data. `project_id` | The project id. `project_name` | The name of the project. -`size` | The size of the workbook (in megabytes). +`size` | The size of the workbook (in megabytes). `show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. -`tags` | The tags that have been added to the workbook. +`tags` | The tags that have been added to the workbook. `updated_at` | The date and time when the workbook was last updated. `views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). `webpage_url` | The full URL of the workbook. @@ -3444,9 +3486,9 @@ Name | Description **Example** -```py +```py # creating a new instance of a WorkbookItem -# +# import tableauserverclient as TSC # Create new workbook_item with project id '3a8b6148-493c-11e6-a621-6f3499394a39' @@ -3456,15 +3498,15 @@ import tableauserverclient as TSC ```` -Source file: models/workbook_item.py +Source file: models/workbook_item.py
      -
      +
      ### Workbook methods -The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. -The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. +The Tableau Server Client (TSC) library provides methods for interacting with workbooks. These methods correspond to endpoints in the Tableau Server REST API. For example, you can use the library to publish, update, download, or delete workbooks on the site. +The methods operate on a workbook object (`WorkbookItem`) that represents the workbook resources. @@ -3473,13 +3515,13 @@ Source files: server/endpoint/workbooks_endpoint.py

      -#### workbooks.get +#### workbooks.get ```py workbooks.get(req_options=None) ``` -Queries the server and returns information about the workbooks the site. +Queries the server and returns information about the workbooks the site. @@ -3490,8 +3532,8 @@ REST API: [Query Workbooks for Site](https://help.tableau.com/current/api/rest_a **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. For example, if you were searching for a specific workbook, you could specify the name of the workbook or the name of the owner. See [Filter and Sort](filter-sort) @@ -3502,7 +3544,7 @@ Returns a list of all `WorkbookItem` objects and a `PaginationItem`. Use these v **Example** -```py +```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') @@ -3518,7 +3560,7 @@ with server.auth.sign_in(tableau_auth): ```
      -
      +
      @@ -3535,15 +3577,15 @@ REST API: [Query Workbook](https://help.tableau.com/current/api/rest_api/en-us/R **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_id` | The `workbook_id` specifies the workbook to query. The ID is a LUID (64-bit hexadecimal string). **Exceptions** -Error | Description - :--- | : --- +Error | Description + :--- | : --- `Workbook ID undefined` | Raises an exception if a `workbook_id` is not provided. @@ -3562,24 +3604,24 @@ print(workbook.name) ``` -
      -
      +
      +
      #### workbooks.publish ```py -workbooks.publish(workbook_item, file_path, publish_mode) +workbooks.publish(workbook_item, file_path, publish_mode) ``` -Publish a workbook to the specified site. +Publish a workbook to the specified site. **Note:** The REST API cannot automatically include extracts or other resources that the workbook uses. Therefore, a .twb file that uses data from an Excel or csv file on a local computer cannot be published, -unless you package the data and workbook in a .twbx file, or publish the data source separately. +unless you package the data and workbook in a .twbx file, or publish the data source separately. -For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. +For workbooks that are larger than 64 MB, the publish method automatically takes care of chunking the file in parts for uploading. Using this method is considerably more convenient than calling the publish REST APIs directly. REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook), [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload) @@ -3587,30 +3629,30 @@ REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). -`file_path` | The path and name of the workbook to publish. +`file_path` | The path and name of the workbook to publish. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). - +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). + **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `File path does not lead to an existing file.` | Raises an error of the file path is incorrect or if the file is missing. -`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. -`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. -`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. +`Invalid mode defined.` | Raises an error if the publish mode is not one of the defined options. +`Workbooks cannot be appended.` | The `mode` must be set to `Overwrite` or `CreateNew`. +`Only .twb or twbx files can be published as workbooks.` | Raises an error if the type of file specified is not supported. See the REST API [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_workbook) for additional error codes. **Returns** -The `WorkbookItem` for the workbook that was published. - +The `WorkbookItem` for the workbook that was published. + **Example** @@ -3628,7 +3670,7 @@ with server.auth.sign_in(tableau_auth): ```
      -
      +
      #### workbooks.refresh @@ -3637,24 +3679,24 @@ workbooks.refresh(workbook_item) ``` -Refreshes the extract of an existing workbook. +Refreshes the extract of an existing workbook. REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the settings for the workbook you are refreshing. **Exceptions** -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. -```py +```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') @@ -3674,7 +3716,7 @@ with server.auth.sign_in(tableau_auth):
      -
      +
      #### workbooks.update @@ -3689,19 +3731,19 @@ REST API: [Update Workbooks](https://help.tableau.com/current/api/rest_api/en-us **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the settings for the workbook you are updating. You can change the `owner_id`, `project_id`, and the `show_tabs` values. See [WorkbookItem](#workbookitem-class). **Exceptions** -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. Use the `workbooks.get()` or `workbooks.get_by_id()` methods to retrieve the workbook item from the server. -```py +```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') @@ -3726,7 +3768,7 @@ with server.auth.sign_in(tableau_auth):
      -
      +
      @@ -3740,7 +3782,7 @@ Deletes a workbook with the specified ID. -To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_workbook1) @@ -3748,34 +3790,34 @@ REST API: [Delete Workbook](https://help.tableau.com/current/api/rest_api/en-us/ **Parameters** -Name | Description -:--- | :--- -`workbook_id` | The ID of the workbook to delete. +Name | Description +:--- | :--- +`workbook_id` | The ID of the workbook to delete. -**Exceptions** +**Exceptions** + +Error | Description +:--- | :--- +`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. -Error | Description -:--- | :--- -`Workbook ID undefined.` | Raises an exception if the project item does not have an ID. The project ID is sent to the server as part of the URI. +**Example** -**Example** - ```py -# import tableauserverclient as TSC -# server = TSC.Server('https://MY-SERVER') -# tableau_auth sign in, etc. +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# tableau_auth sign in, etc. server.workbooks.delete('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') -``` +```
      -
      +
      #### workbooks.download @@ -3792,9 +3834,9 @@ REST API: [Download Workbook](https://help.tableau.com/current/api/rest_api/en-u **Parameters** -Name | Description -:--- | :--- -`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. +Name | Description +:--- | :--- +`workbook_id` | The ID for the `WorkbookItem` that you want to download from the server. `filepath` | (Optional) Downloads the file to the location you specify. If no location is specified, the file is downloaded to the current working directory. The default is `Filepath=None`. `no_extract` | (Optional) Specifies whether to download the file without the extract. When the workbook has an extract, if you set the parameter `no_extract=True`, the extract is not included. You can use this parameter to improve performance if you are downloading workbooks that have large extracts. The default is to include the extract, if present (`no_extract=False`). Available starting with Tableau Server REST API version 2.5. @@ -3802,14 +3844,14 @@ Name | Description **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Workbook ID undefined` | Raises an exception if a valid `datasource_id` is not provided. -**Returns** +**Returns** -The file path to the downloaded workbook. +The file path to the downloaded workbook. **Example** @@ -3823,7 +3865,7 @@ The file path to the downloaded workbook.
      -
      +
      #### workbooks.populate_views @@ -3832,18 +3874,18 @@ The file path to the downloaded workbook. workbooks.populate_views(workbook_item) ``` -Populates (or gets) a list of views for a workbook. +Populates (or gets) a list of views for a workbook. You must first call this method to populate views before you can iterate through the views. -This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. +This method retrieves the view information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query for all the data sources, the view information is not included. Use this method to retrieve the views. The method adds the list of views to the workbook item (`workbook_item.views`). This is a list of `ViewItem`. REST API: [Query Views for Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_views_for_workbook) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the workbook to populate with views information. See [WorkbookItem class](#workbookitem-class). @@ -3851,14 +3893,14 @@ Name | Description **Exceptions** -Error | Description -:--- | :--- -`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. +Error | Description +:--- | :--- +`Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. You can retrieve the workbook items using the `workbooks.get()` and `workbooks.get_by_id()` methods. **Returns** -None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). +None. A list of `ViewItem` objects are added to the workbook (`workbook_item.views`). **Example** @@ -3867,14 +3909,14 @@ None. A list of `ViewItem` objects are added to the workbook (`workbook_item.vie # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# - ... +# + ... # get the workbook item workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') -# get the view information +# get the view information server.workbooks.populate_views(workbook) # print information about the views for the work item @@ -3886,27 +3928,27 @@ None. A list of `ViewItem` objects are added to the workbook (`workbook_item.vie ```
      -
      +
      #### workbooks.populate_connections -```py +```py workbooks.populate_connections(workbook_item) -``` +``` -Populates a list of data source connections for the specified workbook. +Populates a list of data source connections for the specified workbook. You must populate connections before you can iterate through the connections. -This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. +This method retrieves the data source connection information for the specified workbook. The REST API is designed to return only the information you ask for explicitly. When you query all the workbooks, the data source connection information is not included. Use this method to retrieve the connection information for any data sources used by the workbook. The method adds the list of data connections to the workbook item (`workbook_item.connections`). This is a list of `ConnectionItem`. REST API: [Query Workbook Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_connections) **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. @@ -3914,14 +3956,14 @@ Name | Description **Exceptions** -Error | Description -:--- | :--- +Error | Description +:--- | :--- `Workbook item missing ID. Workbook must be retrieved from server first.` | Raises an error if the `workbook_item` is unspecified. **Returns** -None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). +None. A list of `ConnectionItem` objects are added to the data source (`workbook_item.connections`). **Example** @@ -3930,14 +3972,14 @@ None. A list of `ConnectionItem` objects are added to the data source (`workbook # import tableauserverclient as TSC # server = TSC.Server('https://SERVERURL') -# - ... +# + ... # get the workbook item workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') -# get the connection information +# get the connection information server.workbooks.populate_connections(workbook) # print information about the data connections for the workbook item @@ -3950,7 +3992,7 @@ None. A list of `ConnectionItem` objects are added to the data source (`workbook ```
      -
      +
      #### workbooks.populate_preview_image @@ -3959,31 +4001,31 @@ None. A list of `ConnectionItem` objects are added to the data source (`workbook workbooks.populate_preview_image(workbook_item) ``` -This method gets the preview image (thumbnail) for the specified workbook item. +This method gets the preview image (thumbnail) for the specified workbook item. -The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. +The method uses the `view.id` and `workbook.id` to identify the preview image. The method populates the `workbook_item.preview_image`. REST API: [Query View Preview Image](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_workbook_preview_image) -**Parameters** +**Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `view_item` | The view item specifies the `view.id` and `workbook.id` that identifies the preview image. - -**Exceptions** -Error | Description -:--- | :--- -`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. +**Exceptions** + +Error | Description +:--- | :--- +`View item missing ID or workbook ID` | Raises an error if the ID for the view item or workbook is missing. + - **Returns** -None. The preview image is added to the view. +None. The preview image is added to the view. @@ -3995,7 +4037,7 @@ None. The preview image is added to the view. # server = TSC.Server('https://SERVERURL') - ... + ... # get the workbook item workbook = server.workbooks.get_by_id('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') @@ -4004,18 +4046,18 @@ None. The preview image is added to the view. server.workbooks.populate_preview_image(workbook) -``` +```
      -
      +
      #### workbooks.update_connection ```py workbooks.update_conn(workbook_item, connection_item) -``` +``` -Updates a workbook connection information (server address, server port, user name, and password). +Updates a workbook connection information (server address, server port, user name, and password). The workbook connections must be populated before the strings can be updated. See [workbooks.populate_connections](#workbooks.populate_connections) @@ -4023,23 +4065,23 @@ REST API: [Update Workbook Connection](https://help.tableau.com/current/api/res **Parameters** -Name | Description -:--- | :--- +Name | Description +:--- | :--- `workbook_item` | The `workbook_item` specifies the workbook to populate with data connection information. -`connection_item` | The `connection_item` that has the information you want to update. +`connection_item` | The `connection_item` that has the information you want to update. **Returns** -None. The connection information is updated with the information in the `ConnectionItem`. +None. The connection information is updated with the information in the `ConnectionItem`. **Example** -```py +```py # query for workbook connections server.workbooks.populate_connections(workbook) @@ -4054,7 +4096,7 @@ server.workbooks.update_conn(workbook, connection) ```
      -
      +
      #### workbooks.populate_pdf ``` diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 46c560d7b..ea68a523d 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -32,7 +32,7 @@ add your contributions to the **development** branch. git clone git@github.com:/server-client-python.git ``` -1. Run the tests to make sure everything is peachy: +1. Run the tests to make sure everything is passing: ```shell python setup.py test @@ -95,6 +95,9 @@ Here's a quick checklist to follow when coding to ensure a good pull request 1. Add a sample to show users how to use the new feature. +1. Add documentation (most likely in api-ref.md) in a separate pull request + (see more below). + ### Add tests All of our tests live under the `test/` folder in the repository. We use @@ -153,15 +156,15 @@ go together. To preview and run the documentation locally, these are the steps: -1. Install [Ruby](https://www.ruby-lang.org/en/downloads/) (v2.5.0 or higher) +1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (v2.5.0 or higher). -1. Install [Bundler](https://bundler.io/) +1. Install [Bundler](https://bundler.io/). -1. Install [Jekyll](https://jekyllrb.com/docs/installation/) +1. Install the project dependencies (which includes Jekyll) by running `bundle install`. (In the future you can run `bundle update` to catch any new dependencies.) -1. Run the Jekyll site locally with `bundle exec jekyll serve` +1. Run the Jekyll site locally with `bundle exec jekyll serve`. -1. In your browser, connect to +1. In your browser, connect to to preview the changes. As long as the Jekyll serve process is running, it will rebuild any new file changes automatically. -For more details on the steps, see the GitHub Pages topic on +For more details, see the GitHub Pages topic on [testing locally](https://docs.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll). diff --git a/docs/index.md b/docs/index.md index 4687be3be..81728594f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,10 +19,9 @@ This section describes how to: Before you install TSC, confirm that you have the following dependencies installed: -* Python. You can use TSC with Python 3.5 or later. +* Python. You can use TSC with Python 3.5 or later. * Git. Optional, but recommended to download the samples or install from the source code. - ## Install TSC You can install TSC with pip or from the source code. @@ -31,7 +30,7 @@ You can install TSC with pip or from the source code. Run the following command to install the latest stable version of TSC: -``` +```shell pip install tableauserverclient ``` @@ -40,7 +39,7 @@ pip install tableauserverclient You can install from the development branch for a preview of upcoming features. Run the following command to install from the development branch: -``` +```shell pip install git+https://github.com/tableau/server-client-python.git@development ``` @@ -49,13 +48,15 @@ development version are subject to change at any time before the next stable rel ### Install on an offline machine -To install TSC onto a machine without internet connection, use the following steps: +To install TSC onto a machine without an internet connection, use the following steps: + +1) Ensure that Python 3.5 or higher is installed. -1) Download and manually install the **requests** python library (and its dependencies). +2) Download and manually install the `requests` Python library (and its dependencies). -2) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}. +3) Download the [setup package](https://pypi.org/project/tableauserverclient/#files){:target="_blank"}. -3) Run `pip install ./downloads/tableauserverclient-x.x.tar.gz` +4) Run `pip install ./tableauserverclient-x.y.tar.gz` ## Get the samples diff --git a/docs/samples.md b/docs/samples.md index b9e9aae3d..ed6533e18 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -21,7 +21,7 @@ the arguments required by a particular sample, run the sample with the `-h` flag For example, if you run the following command: -``` +```shell python samples/publish_workbook.py -h ``` diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index d1bdc197f..8fd1c1b26 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -3,46 +3,117 @@ title: Sign In and Out layout: docs --- -To sign in and out of Tableau Server, call the server's `.auth.signin` method in a `with` block. +The first step to using the TSC library is to sign in to your Tableau Server (or Tableau Online). This page explains how to sign in, sign out, and switch sites, with examples for both Tableau Server and Tableau Online. + +* TOC +{:toc} + +## Sign In + +Signing in can be done two different ways: + +* Personal Access Tokens - In most cases this is the preferred method because it improves security by avoiding the need to use or store passwords directly. Access tokens also expire by default if not used after 15 consecutive days. This option is available for Tableau Server 2019.4 and newer. Refer to [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) for more details. +* Username and Password - Direct sign in with account username and password. + +Examples showing both of these cases are included below. + +**Note:** When you sign in, the TSC library manages the authenticated session for you. However, the validity of the underlying credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default). + +### Sign in with Personal Access Token + +To sign in to Tableau Server or Tableau Online with a personal access token, you'll need the following values: + +Name | Description +:--- | :--- +TOKEN_NAME | The personal access token name (from the My Account settings page) +TOKEN_VALUE | The personal access token value (from the My Account settings page) +**Tableau Server** | +SITENAME | The Tableau Server site you are authenticating with; for example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam; in the REST API documentation this field is also referred to as contentUrl; this value can be omitted to connect with the Default site on the server +SERVER_URL | The Tableau Server you are authenticating with; if your server has SSL enabled, this should be an HTTPS link +**Tableau Online** | +SITENAME | The Tableau Online site you are authenticating with; for example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664; in the REST API documentation this field is also referred to as contentUrl; this value is always required when connecting to Tableau Online +SERVER_URL | The Tableau Online instance you are authenticating with; in the example above the server URL would be https://10ay.online.tableau.com; this will always be an an HTTPS link + +This example illustrates using the above values to sign in with a personal access token, do some operations, and then sign out: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.auth.sign_in(tableau_auth) + +# Do awesome things here! + +server.auth.sign_out() +``` + +### Sign in with Username and Password + +To sign in to Tableau Server or Tableau Online with a username and password, you'll need the following values: + +Name | Description +:--- | :--- +USERNAME | The user name +PASSWORD | The user password +SITENAME | The same as described in the previous section +SERVER_URL | The same as described in the previous section + +This example illustrates using the above values to sign in with a username and password, do some operations, and then sign out: ```py import tableauserverclient as TSC tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME') -# or for a personal access token -# tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') -server = TSC.Server('https://SERVER_URL') +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.auth.sign_in(tableau_auth) -with server.auth.sign_in(tableau_auth): - # Do awesome things here! +# Do awesome things here! + +server.auth.sign_out() ``` -`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. +## Sign Out -`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of an on-premise Tableau server. +Signing out cleans up the current session and invalidates the authentication token being held by the TSC library. -`TOKEN_NAME` and `TOKEN_VALUE` are your [Personal Access Token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) values, generated in your Account Settings. +As shown in the examples above, the sign out call is simply: -Optionally, you can override the version of Tableau API you are authorizing against by adding `server.version = ''` before the `auth.signin` call. +```py +server.auth.sign_out() +``` -The TSC library signs you out of Tableau Server when you exit out of the `with` block. +## Simplify by using Python with block -
      - **Note:** When you sign in, the TSC library manages the authenticated session for you, however the validity of the underlying - credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default). -
      +The sign in/out flow can be simplified (and handled in a more Python way) by using the built-in support for the `with` block. After the block execution completes, the sign out is called automatically. -An alternative to using a `with` block is to call the `Auth.sign_in` and `Auth.sign_out` functions explicitly: +For example: ```py import tableauserverclient as TSC -tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') # with no site name, this will use the Default site -server = TSC.Server('http://SERVER_URL') +tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') +server = TSC.Server('https://SERVER_URL') + +with server.auth.sign_in(tableau_auth): + all_wb, pagination_item = server.workbooks.get() + print("\nThere are {} workbooks on site: ".format(pagination_item.total_available)) + for wb in all_wb: + print(wb.id, wb.name) +``` -server.auth.sign_in(tableau_auth) +All of the samples provided in TSC library use this technique. -# Do awesome things here! +## Switch Site -server.auth.sign_out() +Tableau Server has a feature which enables switching to another site without having to authenticate again. (The user must have access permissions for the new site as well.) + +**Note:** This method is not available on Tableau Online. + +The following example will switch the authenticated user to the NEW_SITENAME site on the same server: + +```py +# assume we already have an authenticated server object + +server.auth.switch_site('NEW_SITENAME') ``` diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 000000000..16ae51a11 --- /dev/null +++ b/docs/troubleshooting.md @@ -0,0 +1,54 @@ +--- +title: Troubleshooting +layout: docs +--- + +This page covers some common troubleshooting tips for using the TSC library. + +
      + Warning: Do not post any debug logs or REST API request/response contents anywhere on GitHub. The contents may include sensitive data or authentication secrets. Instead you can post just edited snippets of relevant content after sanitizing (removing any sensitive values). +
      + +* TOC +{:toc} + +## Logging REST API communication with Tableau Server + +There may be cases where it's helpful to inspect the REST API calls the TSC library is making and the responses coming back from Tableau Server. Some examples might be: + +* The TSC library is throwing an error or the results are not coming through as expected +* The TSC library or the REST backend may have a bug which needs to be tracked down + +To enable logging, add the following to your Python script ahead of making any TSC calls: + +```py +import logging +logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', + filename="tsc.log", level="DEBUG") +``` + +Now when your script executes, you'll see a set of debug messages in the `tsc.log` file. Each API call to the REST API will be included along with the XML responses. Depending on the problem being investigated, you can compare these requests/responses to the [REST API documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api.htm) to track down the issue. + +## Capture REST API communication with local proxy + +Another approach for inspecting REST API traffic is to use a local debugging proxy server like [Fiddler Everywhere](https://www.telerik.com/fiddler). Fiddler Everywhere is free for basic use and has versions for Mac, Windows and Linux. + +These are the steps to send the API traffic through to a local proxy like Fiddler: + +1. Install Fiddler Everywhere and create a free account if needed +2. Launch the Fiddler app and click the settings (gear) icon to enable Capture HTTPS traffic. (Do not click Trust root certificate.) +3. Before running your script, set the following environment variables (on Windows, use SET commands instead): +```shell +export HTTP_PROXY=127.0.0.1:8866 +export HTTPS_PROXY=127.0.0.1:8866 +export CURL_CA_BUNDLE="" +export PYTHONWARNINGS="ignore:Unverified HTTPS request" +``` +4. Run your script +5. Check Fiddler Everywhere for the results + +The sample screenshot below shows the results of running a simple sign in/out sequence. The Capture pane includes one row for each HTTP request. Select the request to see the details on the right side: Request and Response. + +![Fiddler Everywhere Screenshot](../assets/fiddler.png) + +Proxy server applications other than Fiddler can be used as well. Just adjust the HTTP_PROXY and HTTPS_PROXY environment variables to use the proper IP address and port number. diff --git a/docs/versions.md b/docs/versions.md index 70076aa6e..b8f824f6e 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -6,6 +6,8 @@ layout: docs Because the TSC library is a client for the Tableau Server REST API, you need to confirm that the version of the TSC library that you use is compatible with the version of the REST API used by your installation of Tableau Server. +For reference, the [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) page has more details about versions. + * TOC {:toc} @@ -21,11 +23,11 @@ server = TSC.Server('http://SERVER_URL') print(server.version) ``` -For example, the code might display version `2.3`. +For example, the code might display version `2.3`. ## Use the REST API version supported by the server -There are two options for always using the the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to. +There are two options for always using the the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to. This could be necessary in cases where you're using an API feature that is only supported in a newer REST API version. The first method is to specify `use_server_version=True` as one of the arguments, for example: @@ -52,7 +54,7 @@ To use a specific version of the REST API, set the version like so: import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL') -server.version = '2.6' +server.version = '3.6' ``` @@ -62,6 +64,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.9|2020.3| |3.8|2020.2| |3.7|2020.1| |3.6|2019.4| From 7232d6b7e16b7bc7c39ab28d2d44b5161e896cd7 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Mon, 26 Oct 2020 09:59:06 -0700 Subject: [PATCH 070/158] Adds new datasource fields to docs (#707) --- docs/api-ref.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index b0463ca2e..2ed695c1d 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -281,12 +281,16 @@ The `DatasourceItem` represents the data source resources on Tableau Server. Thi Name | Description :--- | :--- +`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specifed, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement. `connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). `content_url` | The name of the data source as it would appear in a URL. `created_at` | The date and time when the data source was created. `certified` | A Boolean value that indicates whether the data source is certified. `certification_note` | The optional note that describes the certified data source. `datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. +`description` | The description for the data source. +`encrypt_extracts` | A Boolean value to determine if a datasource should be encrypted or not. See [Extract and Encryption Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_encryption.htm) for more information. +`has_extracts` | A Boolean value that indicates whether the datasource has extracts. `id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. `name` | The name of the data source. If not specified, the name of the published data source file is used. `owner_id` | The identifier of the owner of the data source. @@ -294,6 +298,8 @@ Name | Description `project_name` | The name of the project associated with the data source. `tags` | The tags (list of strings) that have been added to the data source. `updated_at` | The date and time when the data source was last updated. +`use_remote_query_agent` | A Boolean value that indicates whether to allow or disallow your Tableau Online site to use Tableau Bridge clients. Bridge allows you to maintain data sources with live connections to supported on-premises data sources. See [Configure and Manage the Bridge Client Pool](https://help.tableau.com/current/online/en-us/to_enable_bridge_live_connections.htm) for more information. +`webpage_url` | The url of the datasource as displayed in browsers. **Example** From f54a94ae9437cb21e6d95c79c2f159214edaa5ae Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Fri, 13 Nov 2020 08:14:01 -0800 Subject: [PATCH 071/158] Simplify explanation of image request options --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2ed695c1d..179da322f 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1681,7 +1681,7 @@ Use this class to specify the resolution of the view and, optionally, the maximu Name | Description :--- | :--- -`imageresolution` | The resolution of the view returned as an image. You set this option with the `Resolution` class. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. +`imageresolution` | The resolution of the view returned as an image. If unspecified, the `views.populate_image` method returns an image with standard resolution (the width of the returned image is 784 pixels). If you set this parameter value to high (`Resolution.High`), the width of the returned image is 1568 pixels. For both resolutions, the height varies to preserve the aspect ratio of the view. `maxage` | Optional. The maximum number of minutes the image will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. **View Filters** @@ -3318,7 +3318,7 @@ This endpoint is available with REST API version 2.5 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the image resolution and the maximum age of the view image cached on the server. By default, the image will be in low resolution. The maximum image cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache images for the time configured in server settings. You can also specify view filters to be applied when the image is generated. See [ImageRequestOptions class](#imagerequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the image resolution (`imageresolution`) and the maximum age of the view image cached on the server (`maxage`). See [ImageRequestOptions class](#imagerequestoptions-class) for more details. **Exceptions** From 87736dea037357900b80a9b4d1a409794dc4ff44 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 19 Nov 2020 15:58:35 -0800 Subject: [PATCH 072/158] Clarify example of HTTP proxy environment variables I could not find a definitive source, but comments in Stack Overflow suggest that starting in Python 3.7 these environment variables need a protocol prefix to work properly. Prior to 3.7 I think they were optional. --- docs/troubleshooting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 16ae51a11..d94877511 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -39,8 +39,8 @@ These are the steps to send the API traffic through to a local proxy like Fiddle 2. Launch the Fiddler app and click the settings (gear) icon to enable Capture HTTPS traffic. (Do not click Trust root certificate.) 3. Before running your script, set the following environment variables (on Windows, use SET commands instead): ```shell -export HTTP_PROXY=127.0.0.1:8866 -export HTTPS_PROXY=127.0.0.1:8866 +export HTTP_PROXY=http://127.0.0.1:8866 +export HTTPS_PROXY=http://127.0.0.1:8866 export CURL_CA_BUNDLE="" export PYTHONWARNINGS="ignore:Unverified HTTPS request" ``` From 200efc448a51f5160d925a018a36aee002d6a6d1 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 1 Dec 2020 16:52:48 -0800 Subject: [PATCH 073/158] Add simple README file to explain this is the doc branch --- README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..f19315c5d --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Tableau Server Client - Documentation + +This is the documentation branch. + +Refer to the [Developer Guide](docs/dev-guide.md) for information on making changes or view the [published docs](https://tableau.github.io/server-client-python/) to see the final output. From 24e914976d033efbed4c9b5477555aaee32655d5 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 2 Dec 2020 14:42:29 -0800 Subject: [PATCH 074/158] Add Getting Help page with info on using GitHub Issues --- _includes/docs_menu.html | 3 +++ docs/getting-help.md | 39 +++++++++++++++++++++++++++++++++++++++ docs/index.md | 10 +++++++--- 3 files changed, 49 insertions(+), 3 deletions(-) create mode 100644 docs/getting-help.md diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index e627e8f44..0d405a9ae 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -4,6 +4,9 @@
    • Get Started
      • +
    • + Getting Help +
    • Sign In and Out
      • diff --git a/docs/getting-help.md b/docs/getting-help.md new file mode 100644 index 000000000..aeae3c3fb --- /dev/null +++ b/docs/getting-help.md @@ -0,0 +1,39 @@ +--- +title: Getting Help +layout: docs +--- + +This project is using [GitHub issues](https://github.com/tableau/server-client-python/issues) for tracking help requests, bugs, and feature requests. + +## Filing an issue + +As a first step, please search existing issues to see if your problem or bug is already reported. + +If not, go ahead and create a new issue and include the following: + +* Tableau Server version (or indicate if using Tableau Online) +* TSC library version +* Python version +* Environment (Mac, Win, Linux) +* Code snippet +* Expected vs actual results + +If troubleshooting a problem could be helped by capturing the REST API requests and responses, see the [Troubleshooting](troubleshooting.md) page for more info. + +
      + Important: do not include in a GitHub issue anything private such as usernames, passwords, or access tokens. Also be careful when posting any API responses to sanitize and remove any sensitive content. +
      + +Some labels might be applied to help organize the open issues after some investigation: + +* Bug: A bug in TSC itself (not working as expected) +* Docs: Documentation which is either missing or needs to be clarified +* Enhancement: An enhancement request (a new capability in TSC) +* Server-side enhancement: An enhancement which requires changes to the backend Tableau Server REST APIs +* Help wanted: A troubleshooting request asking for community help + +## Contributing a pull request + +Pull requests are also welcome! See the [Developer Guide](dev-guide) for more details on the process. + +You can also start a conversation as an issue first and then create a pull request if the idea looks do-able. diff --git a/docs/index.md b/docs/index.md index 81728594f..d9f0178fc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,9 @@ the TSC library you can do almost everything that you can do with the REST API, * Create users and groups. * Query projects, sites, and more. -This section describes how to: +If you need help or to report issues, refer to the [Getting Help](getting-help) page. + +This page describes how to: * TOC {:toc} @@ -85,6 +87,8 @@ with server.auth.sign_in(tableau_auth): print([datasource.name for datasource in all_datasources]) ``` -> `SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. +`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. + +`SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. -> `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. +See [Sign In and Out](sign-in-out) for more details about the sign in & out options. From 6f85676b467e73c23130a0764131cbb3b64f0361 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 3 Dec 2020 16:20:52 -0800 Subject: [PATCH 075/158] Remove redundant text around request options for populate_csv and populate_pdf methods --- docs/api-ref.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 179da322f..8a7035b30 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3365,7 +3365,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. The maximum CSV cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache CSV files for the time configured in server settings. You can also specify view filters to be applied when the data is generated. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the maximum age of the CSV cached on the server. See [CSVRequestOptions class](#csvrequestoptions-class) for more details. **Exceptions** @@ -3381,9 +3381,9 @@ None. The CSV data is added to the `view_item` and can be accessed by its `csv` ```py # Sign in, get view, etc. -# Populate and save the CSV data as 'view_csv.csv' +# Populate and save the CSV data in a file server.views.populate_csv(view_item) -with open('./view_csv.csv', 'wb') as f: +with open('./view_data.csv', 'wb') as f: # Perform byte join on the CSV data f.write(b''.join(view_item.csv)) ``` @@ -3413,7 +3413,7 @@ This endpoint is available with REST API version 2.7 and up. Name | description :--- | :--- `view_item` | Specifies the view to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. You can also specify view filters to be applied when the PDF is generated. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. **Exceptions** @@ -4125,7 +4125,7 @@ This endpoint is available with REST API version 3.4 and up. Name | description :--- | :--- `workbook_item` | Specifies the workbook to populate. -`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. If not specified, PDF content will have default page type and orientation. The maximum PDF cache time is the value of `maxage` in minutes, and must be an integer between 1 and 240. A value of zero will cause the minimum cache time of 1 minute. A value of -1 will cache PDF files for the time configured in server settings. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. +`req_options` | (Optional) You can pass in request options to specify the page type and orientation of the PDF content, as well as the maximum age of the PDF rendered on the server. See [PDFRequestOptions class](#pdfrequestoptions-class) for more details. **Exceptions** From f37f33b4a5aaf3cb1fe391511c2e356b924d1f9a Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 8 Dec 2020 09:54:02 -0800 Subject: [PATCH 076/158] Use better link to Dev Guide --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f19315c5d..1353e7d92 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ This is the documentation branch. -Refer to the [Developer Guide](docs/dev-guide.md) for information on making changes or view the [published docs](https://tableau.github.io/server-client-python/) to see the final output. +Refer to the [Developer Guide](https://tableau.github.io/server-client-python/docs/dev-guide) for information on making changes or view the [published docs](https://tableau.github.io/server-client-python/) to see the final output. From f6b7d38076e0764b2f878178ee5c3224ecc13080 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 9 Dec 2020 10:32:38 -0800 Subject: [PATCH 077/158] Add explanation for handling 405 error when signing in to server without using HTTPS URL Fixes #325 --- docs/sign-in-out.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 8fd1c1b26..675f01f8d 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -73,6 +73,26 @@ server.auth.sign_in(tableau_auth) server.auth.sign_out() ``` +### 405000 Method Not Allowed Response + +In some cases, you may find that sign in fails with a 405 message: +``` +405000: Method Not Allowed + The HTTP method 'GET' is not supported for the given resource +``` + +The most likely cause of this is signing in to a Tableau Server using the HTTP address which the server redirects to a secure HTTPS address. However, during the redirect the POST request turns into a GET request which is then considered an invalid method for the login entrypoint. (For security reasons, the server is following the standards correctly in this case). + +The solution is to avoid the redirect by using the HTTPS URL for the site. For example, instead of: +```py +server = TSC.Server('http://SERVER_URL') +``` + +Switch to the HTTPS (SSL) URL instead: +```py +server = TSC.Server('https://SERVER_URL') +``` + ## Sign Out Signing out cleans up the current session and invalidates the authentication token being held by the TSC library. From 87afa33961fffb54c4469b6622b2c7ee4b011e57 Mon Sep 17 00:00:00 2001 From: varchar66 Date: Mon, 21 Dec 2020 13:53:29 +0100 Subject: [PATCH 078/158] Update api-ref.md Fixed token authentication example mistype. PersonalAccessToken -> PersonalAccessTokenAuth --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 8a7035b30..f4edeb6ba 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -90,7 +90,7 @@ Source file: models/personal_access_token_auth.py ```py import tableauserverclient as TSC -tableau_auth = TSC.PersonalAccessToken('TOKEN-NAME', 'TOKEN-VALUE', site_id='CONTENTURL') +tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN-NAME', 'TOKEN-VALUE', site_id='CONTENTURL') server = TSC.Server('https://SERVER_URL', use_server_version=True) server.auth.sign_in(tableau_auth) ``` From 407ba6db7dc5114d1056ed404ffa07036d25002d Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 29 Dec 2020 11:04:42 -0800 Subject: [PATCH 079/158] Add example of using pre-commit hook to check code style --- docs/dev-guide.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index ea68a523d..bd3266f06 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -72,6 +72,40 @@ Here's a quick checklist to follow when coding to ensure a good pull request issues before submitting your pull request. - Keep commit messages clean and descriptive. +### Use git pre-commit hook + +Setting up a git pre-commit hook can be helpful to ensure your code changes follow +the project style conventions before pushing and creating a pull request. + +To configure the pre-commit hook, navigate to your local clone/fork of the +`server-client-python` project and change into the `.git/hooks` directory. +Create a file `pre-commit` with the contents below and mark it as executable +(`chmod +x pre-commit`). + +To test that the hook is working correctly, make a style-inconsistent change (for +example, changing some indentation to not be a multiple of 4), then try to commit +locally. You should get a failure with an explanation from pycodestyle with the +issue. + +```shell +#!/bin/sh + +# only check if on a code branch (i.e. skip if on a docs branch) +if [ -e tableauserverclient/__init__.py ]; +then + # check for style conventions in all code dirs + echo Running pycodestyle + pycodestyle tableauserverclient test samples +fi +``` + +Windows users: The first line of the sample script above will need to be adjusted +depending on how and where git is installed on your system, for example: + +```shell +#!C:/Program\ Files/Git/usr/bin/sh.exe +``` + ### Adding features 1. Create an endpoint class for the new feature, following the structure of the From 54e69dddd634c00b672d0f620dffe028c37e24f8 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Thu, 11 Feb 2021 15:31:43 -0800 Subject: [PATCH 080/158] Updates documentation for subscriptions, goes with #794 --- docs/api-ref.md | 106 +++++++++++++++++++++++++++++++++++++----------- 1 file changed, 83 insertions(+), 23 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f4edeb6ba..a6984474e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2569,15 +2569,32 @@ SubscriptionItem(subject, schedule_id, user_id, target) Name | Description :--- | :--- `id` | The id of the subscription on the site. +`attach_image` | Setting this `True` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. By default, this value is set to `True`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attach_image` to `False` will cause an error. +`attach_pdf` | Setting this `True` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. By default, this value is set to `False`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attach_pdf` to `True` will cause an error. +`message` | The text body of the subscription email message. +`page_orientation` | The orientation of the pages produced when `attach_pdf` is `True`. If this parameter is not present the page orientation will default to `Portrait`. See chart below for a full list of values. +`page_size_option` | The type of page produced, which determines the page dimensions when `attach_pdf` is `True`. If this parameter is not present the page type will default to `Letter`. See chart below for a full list of values. +`schedule_id` | The id of the schedule associated with the specific subscription. +`schedule_name` | The name of the schedule associated with the specific subscription. +`send_if_view_empty` | Applies to views only (see `target` attribute). If `True`, an image is sent even if the view specified in a subscription is empty. If `False`, nothing is sent if the view is empty. The default value is `True`. `subject`| The subject of the subscription. This is the description that you provide to identify the subscription. -`schedule_id` | The identifier associated with the specific subscription. +`suspended` | Setting this value to `True` stops email delivery for the specified subscription. Setting it to `False` will resume email delivery for the subscription. +`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. The `send_if_view_empty` attribute can only be set to `True` if the `target.type` is set to `View`. `user_id` | The identifier of the user (person) who receives the subscription. -`target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. +`user_name` | The name of the user (person) who receives the subscription. +
      +**Valid PDF options (applies only if `attach_pdf` is set to `True`)** +Attribute | Valid options +:--- | :--- +`page_orientation` | `TSC.PDFRequestOptions.Orientation.Landscape`
      `TSC.PDFRequestOptions.Orientation.Portrait` +`page_size_option` | `TSC.PDFRequestOptions.PageType.A3`
      `TSC.PDFRequestOptions.PageType.A4`
      `TSC.PDFRequestOptions.PageType.A5`
      `TSC.PDFRequestOptions.PageType.B5`
      `TSC.PDFRequestOptions.PageType.Executive`
      `TSC.PDFRequestOptions.PageType.Folio`
      `TSC.PDFRequestOptions.PageType.Ledger`
      `TSC.PDFRequestOptions.PageType.Legal`
      `TSC.PDFRequestOptions.PageType.Letter`
      `TSC.PDFRequestOptions.PageType.Note`
      `TSC.PDFRequestOptions.PageType.Quarto`
      `TSC.PDFRequestOptions.PageType.Tabloid` -Source files: server/endpoints/subscription_item.py +Source files: +server/endpoints/subscription_item.py +server/request_options.py ### Subscription methods @@ -2596,7 +2613,7 @@ Source files: server/endpoints/subscriptions_endpoint.py ```py subscription.create(subscription_item) ``` -Creates a subscription to a view or workbook for a specific user. +Creates a subscription to a view or workbook for a specific user on a specific schedule. When a user is subscribed to the content, Tableau Server sends the content to the user in email on the schedule that's defined on Tableau Server and specified in the `subscription_item`. To create a new subscription you need to first create a new `subscription_item` (from `SubscriptionItem` class). @@ -2608,7 +2625,7 @@ REST API: [Create Subscription](https://help.tableau.com/current/api/rest_api/en Name | Description :--- | : --- -`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and the subject, or description for the subscription. +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and other metadata for the subscription. **Returns** @@ -2621,28 +2638,29 @@ Returns the new `SubscriptionItem` object. **Example** ```py -# import tableauserverclient as TSC -# server = TSC.Server('server') -# create auth, specify site -# login, etc. - - -# create the target (content) of the subscription -# in this case, id of the workbook and the target type "workbook" - - target = TSC.Target('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') +# Create the target (content) of the subscription with its ID and type. +# ID can be obtained by calling workbooks.get() or views.get(). +target = TSC.Target('c7a9327e-1cda-4504-b026-ddb43b976d1d', 'workbook') -# the ids for the schedule and user - schedule_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' - user_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' +# Store the schedule ID and user ID. +# IDs can be obtained by calling schedules.get() and users.get(). +schedule_id = 'b60b4efd-a6f7-4599-beb3-cb677e7abac1' +user_id = '28ce5884-ed38-49a9-aa10-8f5fbd59bbf6' -# create a new SubscriptionItem object. - newSub = TSC.SubscriptionItem('My Subscription', schedule_id, user_id, target) +# Create the new SubscriptionItem object with variables from above. +new_sub = TSC.SubscriptionItem('My Subscription', schedule_id, user_id, target) -# create the new subscription to the site - newSub = server.subscriptions.create(newSub) - print(newSub.subject) +# (Optional) Set other fields. Any of these can be added or removed. +new_sub.attach_image = False +new_sub.attach_pdf = True +new_sub.message = "You have an alert!" +new_sub.page_orientation = TSC.PDFRequestOptions.Orientation.Landscape +new_sub.page_size_option = TSC.PDFRequestOptions.PageType.B4 +new_sub.send_if_view_empty = True +# Create the new subscription on the site you are logged in. +new_sub = server.subscriptions.create(new_sub) +print(new_sub.subject) ``` @@ -2762,10 +2780,52 @@ The `SubscriptionItem`. See [SubscriptionItem class](#subscriptionitem-class) ``` +
      +
      + +#### subscription.update + +```py +subscription.update(subscription_item) +``` +Updates a specific subscription. To update a subscription, you must first query it from server using the `subscriptions.get()` or `subscriptions.get_by_id()` method. + +REST API: [Update Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_subscription) +**Parameters** + +Name | Description + :--- | : --- +`subscription_item` | Specifies the user to subscribe, the content to subscribe to, the schedule to associate the subscription with, and other metadata for the subscription. + + +**Returns** + +Returns the updated `SubscriptionItem` object. +**Example** + +```py +# Fetch an existing subscription from server. You can also use the subscriptions.get() method +sub = server.subscriptions.get_by_id('59cec1ec-15a0-4eb3-bc9d-056b87aa0a18') + +# Set update-able fields. Any of these can be added or removed. +sub.subject = "Updated subject" +sub.attach_image = True +sub.attach_pdf = True +sub.page_orientation = TSC.PDFRequestOptions.Orientation.Landscape +sub.page_size_option = TSC.PDFRequestOptions.PageType.Folio +sub.suspended = True +sub.schedule_id = 'cf2f4465-9c4b-4536-b7cc-59994e9b7dde' +sub.send_if_view_empty = True + +# Create the new subscription on the site you are logged in. +sub = server.subscriptions.update(sub) +print(new_sub.subject) +``` +

      From 30055ea3b0a5e799c7320ddd75057c3717723635 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Fri, 19 Feb 2021 09:29:04 -0800 Subject: [PATCH 081/158] Add explanation of method views.get_by_id() (#752) --- docs/api-ref.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f4edeb6ba..dbc2b0c93 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3245,6 +3245,50 @@ for view in TSC.Pager(server.views): See [ViewItem class](#viewitem-class) +
      +
      + +#### views.get_by_id +``` +views.get_by_id(view_id) +``` + +Returns the details of a specific view. + + +REST API: [Get View](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_view) + +**Version** + +This endpoint is available REST API version 3.1 and up. + +**Parameters** + +Name | Description +:--- | :--- +`view_id` | The ID of the view to retrieve. + + + +**Returns** + +Returns a single `ViewItem` object. + +**Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('username', 'password') +server = TSC.Server('https://servername') + +with server.auth.sign_in(tableau_auth): + view = server.view.get_by_id('d79634e1-6063-4ec9-95ff-50acbf609ff5') + print(view.name) +``` + +See [ViewItem class](#viewitem-class) + +

      @@ -3347,7 +3391,7 @@ See [ViewItem class](#viewitem-class) #### views.populate_csv ``` -views.populate_csv(view_item) +views.populate_csv(view_item, req_options=None) ``` Populates the CSV data of the specified view. From f3bb202138f07a81b6a635ed5a843314f36bd897 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 19 Feb 2021 09:29:25 -0800 Subject: [PATCH 082/158] Adds documentation for groups.create_AD_group (#771) --- docs/api-ref.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 57 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index dbc2b0c93..e79530bfc 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -812,7 +812,8 @@ Name | Description `id` | The id of the group. `users` | The list of users (`UserItem`). `name` | The name of the group. The `name` is required when you create an instance of a group. - +`minimum_site_role` | The role to grant users that are added to the group. +`license_mode` | The mode defining when to apply licenses for group members. When the mode is `onLogin`, a license is granted for each group member when they login to a site. When the mode is `onSync`, a license is granted for group members each time the domain is synced. **Example** @@ -893,7 +894,7 @@ None. create(group_item) ``` -Creates a new group in Tableau Server. +Creates a new local group in Tableau Server. REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) @@ -925,6 +926,7 @@ Adds new `GroupItem`. # create a new instance with the group name newgroup = TSC.GroupItem('My Group') + newgroup.minimum_site_role = TSC.UserItem.Roles.ExplorerCanPublish # call the create method newgroup = server.groups.create(newgroup) @@ -938,6 +940,59 @@ Adds new `GroupItem`.

      +#### groups.create_AD_group + +```py +create_AD_group(group_item, asJob=False) +``` + +Creates an active directory group in Tableau Server. + + +REST API: [Create Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_group) + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to add. You first create a new instance of a `GroupItem` and pass that to this method. +`asJob` | Boolean flag used to specify an asynchronous operation. If set to `True`, the return value will be a JobItem containing the status of the queued job. See [JobItem class](#jobitem-class). + + + + +**Returns** +Returns the created `GroupItem` or a `JobItem` if asJob flag was set to True. + + +**Example** + +```py + +# Create a new group + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + +# create a new instance with the group name + newgroup = TSC.GroupItem('AD_Group_Name', 'AD_Domain_Name') + newgroup.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer + newgroup.license_mode = TSC.GroupItem.LicenseMode.onSync + +# call the create method + newgroup = server.groups.create_AD_group(newgroup) + +# call the create method asynchronously + newgroup_job = server.groups.create_AD_group(newgroup, asJob=True) + +``` + +
      +
      + #### groups.delete ```py From edc11f2d5326e7805dfeef7a7af1515718438832 Mon Sep 17 00:00:00 2001 From: Lee Boynton Date: Fri, 19 Feb 2021 17:29:50 +0000 Subject: [PATCH 083/158] Add documentation for getting user groups (#800) --- docs/api-ref.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index e79530bfc..e46370e1d 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2855,6 +2855,7 @@ Name | Description `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. `site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. +`groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`. **Example** @@ -3024,6 +3025,58 @@ Returns the list of favorites (views, workbooks, and data sources) for a user.

      +#### users.populate_groups + +```py +users.populate_groups(user_item, req_options=None): +``` + +Returns the groups that the user belongs to. + +**Parameters** + +Name | Description + :--- | : --- +`user_item` | The `user_item` specifies the user to populate with group membership. + + + + +**Exceptions** + +Error | Description + :--- | : --- +`User item missing ID.` | Raises an error if the `user_item` is unspecified. + + +**Returns** + +A list of `GroupItem` + +A `PaginationItem` that points (`user_item.groups`). See [UserItem class](#useritem-class) + + +**Example** + +```py +# first get all users, call server.users.get() +# get groups for user[0] + ... + + page_n = server.users.populate_groups(all_users[0]) + print("\nUser {0} is a member of {1} groups".format(all_users[0].name, page_n.total_available)) + print("\nThe groups are:") + for group in all_users[0].groups : + print(group.name) + + ... +``` + + + + +
      +
      #### users.populate_workbooks From 6ace9340578e35d36a6f8d0129dbf48f7961f218 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Wed, 24 Feb 2021 12:56:28 -0800 Subject: [PATCH 084/158] Adds docs for groups.update (#797) --- docs/api-ref.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index e46370e1d..b4ec5f43f 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1199,6 +1199,65 @@ None. The user is removed from the group.

      + +#### groups.update + +```py +groups.update(group_item, as_job=False) +``` + +Updates a group in Tableau Server. + +REST API: [Update Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_usersgroups.htm#update_group) + + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`as_job` | (Optional) If this value is set to `True`, the update operation will be asynchronous and return a JobItem. This is only supported for Active Directory groups. By default, this value is set to `False`. + + +**Exceptions** + +Error | Description +:--- | :--- +`Group item missing ID.` | Raises an error if the `group_item` is missing the `id` attribute. +`Local groups cannot be updated asynchronously.` | The `as_job` attribute was set to `True` for a local group. + + +**Returns** + +The updated `GroupItem` object. If `as_job` was set to `True`, a `JobItem` will be returned instead. + + +**Example** + +```py +# Fetch an existing group from server. +groups, pagination = server.groups.get() +group = groups[0] + +# Set update-able fields. Any of these can be added or removed. +## Local group +group.name = "new group name" +group.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer + +## Active Directory group +group.minimum_site_role = TSC.UserItem.Roles.SiteAdministratorExplorer +group.license_mode = TSC.GroupItem.LicenseMode.onLogin + +# Update group - synchronous +group = server.groups.update(group) + +# Update group - asynchronous (only for Active Directory groups) +job = server.groups.update(group, as_job=True) +``` + +
      +
      + --- ## Jobs From 64c3f1cae673907490194475b963dd37d604f822 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 5 Apr 2021 11:57:31 -0700 Subject: [PATCH 085/158] Tasks documentation - minor edits - Some minor changes from my code review of #525 which added Tasks documentation - add Tasks to left-side nav --- _includes/docs_menu.html | 3 +++ docs/api-ref.md | 24 +++++++++++------------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index 0d405a9ae..012ad2cd5 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -73,6 +73,9 @@
    • Subscriptions
      • +
    • + Tasks +
    • Users
      • diff --git a/docs/api-ref.md b/docs/api-ref.md index 4e6779e94..9c0cc38f6 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2901,12 +2901,12 @@ TaskItem(id, task_type, priority, consecutive_failed_count=0, schedule_id=None, Name | Description :--- | :--- -`consecutive_failed_count` | The number of failed consecutive executions. -`id` | The id of the task on the site. +`id` | The id of the task on the site. +`task_type` | Type of extract task - full or incremental refresh. `priority` | The priority of the task on the server. -`schedule_id` | The id of the schedule on the site. -`target` | An object, `datasource` or `workbook` which is associated to the task. Source file: models/target.py -`task_type` | Type of extract task - full or incremental refresh. +`consecutive_failed_count` | The number of failed consecutive executions. +`schedule_id` | The id of the schedule on the site. +`target` | An object, `datasource` or `workbook`, which is associated to the task. Source file: models/target.py **Example** @@ -2942,14 +2942,14 @@ tasks.get(req_options=None) Returns information about the tasks on the specified site. -REST API: [Get Extract Refresh Tasks on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_extract_refresh_tasks){:target="_blank"} +REST API: [Get Extract Refresh Tasks on Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_extract_refresh_tasks) **Parameters** Name | Description :--- | : --- -`req_option` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. +`req_options` | (Optional) You can pass the method a request object that contains additional parameters to filter the request. **Returns** @@ -3008,9 +3008,8 @@ The `TaskItem`. See [TaskItem class](#taskitem-class) **Example** ```py - task1 = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - print(task1.task_type) - +task1 = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') +print(task1.task_type) ```
      @@ -3048,9 +3047,8 @@ Returns the REST API response. # server = TSC.Server('server') # login, etc. - task = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') - server.tasks.run(task) - +task = server.tasks.get_by_id('9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d') +server.tasks.run(task) ```
      From 6179a1d8f7b54c7e2136578a4463a08239b0b471 Mon Sep 17 00:00:00 2001 From: jorwoods Date: Fri, 23 Apr 2021 16:45:00 -0500 Subject: [PATCH 086/158] Update documentation with switch site and Django style filters (#715) Add docs for Django-style filters --- docs/api-ref.md | 9 ++++- docs/filter-sort.md | 83 +++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 88 insertions(+), 4 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 9c0cc38f6..825964bdb 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -194,6 +194,14 @@ server.auth.switch_site(site)

      + +**See Also** +[Sign in and Out](sign-in-out) +[Server](#server) + +
      +
      + --- @@ -631,7 +639,6 @@ Name | Description `datasource_item` | The `datasource_item` specifies the data source to update. - **Exceptions** Error | Description diff --git a/docs/filter-sort.md b/docs/filter-sort.md index a7a0d458d..ef70a060f 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -45,13 +45,15 @@ The operator can be any of the following: * GreaterThan * GreaterThanOrEqual * LessThan +* LessThanOrEqual * In +* Has ### Value criteria The value that you want to filter on. This can be any valid string. -### Filtering example +### Filtering example - RequestOptions The following code displays only the workbooks where the name equals Superstore: @@ -69,11 +71,11 @@ print(matching_workbooks[0].owner_id) To sort on a field, you need to specify the field name and the direction criteria for the sort order. -### Direction criteria +### Direction criteria - RequestOptions This can be either `Asc` for ascending or `Desc` for descending. -### Sorting example +### Sorting example - RequestOptions The following code sorts the workbooks in ascending order: @@ -86,3 +88,78 @@ matching_workbooks, pagination_item = server.workbooks.get(req_option) for wb in matching_workbooks: print(wb.name) ``` + + +## Django style filters and sorts + +### Filtering examples - Django style + +The following code displays only workbooks where the name equals Superstore: + +```py +all_workbooks = server.workbooks.filter(name='Superstore') +for workbook in all_workbooks: + print(workbook.owner_id) +``` + +### Direction criteria - Django style + +The field name cane be input as normal for ascending or prefixed with `-` for descending. + +### Sorting example - Django style + +The following code sorts the workbooks in ascending order: + +```py +matching_workbooks = server.workbooks.sort('name') + +for wb in matching_workbooks: + print(wb.name) +``` + +Sort can take multiple args, with desc direction added as a (-) prefix + +```py +workbooks = workbooks.sort("project_name", "-created_at") +``` + +### More detailed examples + +```py +# Return queryset with no filters +workbooks = server.workbooks.all() + +# filters can be appended in new lines +workbooks = workbooks.filter(project_name=project_name) + +# sort can take multiple args, with desc direction added as a (-) prefix +workbooks = workbooks.sort("project_name", "-created_at") + +# pagination take these two keywords +workbooks = workbooks.paginate(page_size=10, page_number=2) + +# query is executed at time of access +for workbook in workbooks: + print(workbook) + +# pagination item is still accessible +print(workbooks.total_available, workbooks.page_size, workbooks.page_number) + +# methods can be chained +all_workbooks = server.workbooks.filter(project_name=project_name).sort("-project_name") + +# operators are implemented using dunderscore +all_workbooks = server.workbooks.filter(project_name__in=["Project A", "Project B"]) +``` + +### Operators available + +| Operator | Implementation | +| --- | --- | +| Equals | eq | +| GreaterThan | gt | +| GreaterThanOrEqual | gte | +| LessThan | lt | +| LessThanOrEqual | lte | +| In | in | +| Has | has | \ No newline at end of file From a0618d6b19676f8b1b9b8eaf885387d29ec0ab32 Mon Sep 17 00:00:00 2001 From: jorwoods Date: Fri, 30 Apr 2021 10:56:35 -0500 Subject: [PATCH 087/158] Correct sort to order_by (#839) Co-authored-by: Jordan Woods --- docs/filter-sort.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index ef70a060f..5425f5923 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -111,7 +111,7 @@ The field name cane be input as normal for ascending or prefixed with `-` for de The following code sorts the workbooks in ascending order: ```py -matching_workbooks = server.workbooks.sort('name') +matching_workbooks = server.workbooks.order_by('name') for wb in matching_workbooks: print(wb.name) @@ -120,7 +120,7 @@ for wb in matching_workbooks: Sort can take multiple args, with desc direction added as a (-) prefix ```py -workbooks = workbooks.sort("project_name", "-created_at") +workbooks = workbooks.order_by("project_name", "-created_at") ``` ### More detailed examples @@ -133,7 +133,7 @@ workbooks = server.workbooks.all() workbooks = workbooks.filter(project_name=project_name) # sort can take multiple args, with desc direction added as a (-) prefix -workbooks = workbooks.sort("project_name", "-created_at") +workbooks = workbooks.order_by("project_name", "-created_at") # pagination take these two keywords workbooks = workbooks.paginate(page_size=10, page_number=2) @@ -146,7 +146,7 @@ for workbook in workbooks: print(workbooks.total_available, workbooks.page_size, workbooks.page_number) # methods can be chained -all_workbooks = server.workbooks.filter(project_name=project_name).sort("-project_name") +all_workbooks = server.workbooks.filter(project_name=project_name).order_by("-project_name") # operators are implemented using dunderscore all_workbooks = server.workbooks.filter(project_name__in=["Project A", "Project B"]) From efd9190fe8bd10206989241380f1f4b4939dec9e Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 12 May 2021 13:31:36 -0700 Subject: [PATCH 088/158] [Docs] General updates 2012-03 (#818) * Add REST API 3.10 for 2020.4 and 3.11 for 2021.1 * Spelling cleanup * Rearrange and simplify user roles list --- docs/api-ref.md | 32 +++++++++++++++++++++++--------- docs/versions.md | 4 ++++ 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 825964bdb..a35e58d54 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -256,7 +256,7 @@ The `ConnectionCredentials` class is used for workbook and data source publish r Attribute | Description :--- | :--- `name` | The username for the connection. -`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`). +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). `password` | The password used for the connection. `server_address` | The server address for the connection. `server_port` | The port used by the server. @@ -289,7 +289,7 @@ The `DatasourceItem` represents the data source resources on Tableau Server. Thi Name | Description :--- | :--- -`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specifed, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement. +`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specified, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement. `connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). `content_url` | The name of the data source as it would appear in a URL. `created_at` | The date and time when the data source was created. @@ -567,7 +567,7 @@ datasources.publish(datasource_item, file_path, mode, connection_credentials=Non Publishes a data source to a server, or appends data to an existing data source. -This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation. +This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one operation. REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source) @@ -1271,7 +1271,7 @@ job = server.groups.update(group, as_job=True) Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method. -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. +If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job. The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. @@ -1875,7 +1875,7 @@ server.views.populate_pdf(view_item, pdf_req_option) Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks. -If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job. +If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job. The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class. @@ -3127,9 +3127,23 @@ Name | Description `email` | The email address of the user. `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. -`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`. +`site_role` | The role the user has on the site. This attribute is required if you are creating a `UserItem` instance. See *User Roles* below for details. `groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`. +**User Roles** + +The possible user roles for the `site_role` attribute are the following: + +* `Creator` +* `Explorer` +* `ExplorerCanPublish` +* `ServerAdministrator` +* `SiteAdministratorExplorer` +* `SiteAdministratorCreator` +* `Unlicensed` +* `ReadOnly` +* `Viewer` + **Example** @@ -3928,7 +3942,7 @@ import tableauserverclient as TSC new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39') -```` +``` Source file: models/workbook_item.py @@ -4066,7 +4080,7 @@ Name | Description `workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). `file_path` | The path and name of the workbook to publish. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used). +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). @@ -4293,7 +4307,7 @@ The file path to the downloaded workbook. file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d') print("\nDownloaded the file to {0}.".format(file_path)) -```` +```
      diff --git a/docs/versions.md b/docs/versions.md index b8f824f6e..2ed8a8b3e 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -64,6 +64,8 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.11|2021.1| +|3.10|2020.4| |3.9|2020.3| |3.8|2020.2| |3.7|2020.1| @@ -80,3 +82,5 @@ The current version of TSC only supports the following REST API and Tableau Serv |2.5|10.2| |2.4|10.1| |2.3|10.0| + +Note that Tableau provides support and security updates for each version of the product for thirty (30) months after release. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details. From 138b3d85393de87defe70f1223cd834b851a42e3 Mon Sep 17 00:00:00 2001 From: Chris Shin Date: Fri, 14 May 2021 10:59:53 -0400 Subject: [PATCH 089/158] Addressing PR feedback --- docs/api-ref.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index a6984474e..0496a9a74 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2569,19 +2569,17 @@ SubscriptionItem(subject, schedule_id, user_id, target) Name | Description :--- | :--- `id` | The id of the subscription on the site. -`attach_image` | Setting this `True` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. By default, this value is set to `True`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attach_image` to `False` will cause an error. -`attach_pdf` | Setting this `True` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. By default, this value is set to `False`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attach_pdf` to `True` will cause an error. +`attach_image` | Setting this to `True` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. By default, this value is set to `True`. If `attach_pdf` is set to `False`, then this value cannot be set to `False`. +`attach_pdf` | Setting this to `True` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. By default, this value is set to `False`. `message` | The text body of the subscription email message. `page_orientation` | The orientation of the pages produced when `attach_pdf` is `True`. If this parameter is not present the page orientation will default to `Portrait`. See chart below for a full list of values. `page_size_option` | The type of page produced, which determines the page dimensions when `attach_pdf` is `True`. If this parameter is not present the page type will default to `Letter`. See chart below for a full list of values. `schedule_id` | The id of the schedule associated with the specific subscription. -`schedule_name` | The name of the schedule associated with the specific subscription. `send_if_view_empty` | Applies to views only (see `target` attribute). If `True`, an image is sent even if the view specified in a subscription is empty. If `False`, nothing is sent if the view is empty. The default value is `True`. `subject`| The subject of the subscription. This is the description that you provide to identify the subscription. `suspended` | Setting this value to `True` stops email delivery for the specified subscription. Setting it to `False` will resume email delivery for the subscription. `target` | The target of the subscription, that is, the content that is subscribed to (view, workbook). The target is an instance of the `target` class. The `target` has two properties, the `id` of the workbook or view (`target.id`), and the `type` (`target.type`), which can either `view` or `workbook`. The `send_if_view_empty` attribute can only be set to `True` if the `target.type` is set to `View`. `user_id` | The identifier of the user (person) who receives the subscription. -`user_name` | The name of the user (person) who receives the subscription.
      **Valid PDF options (applies only if `attach_pdf` is set to `True`)** From 60cab471cb61c7731d9f0952d16a2ec0da8b8d35 Mon Sep 17 00:00:00 2001 From: annematronic <73560907+annematronic@users.noreply.github.com> Date: Tue, 25 May 2021 06:38:14 -0700 Subject: [PATCH 090/158] Revise datasources.update in api-ref.md (#842) * Update api-ref.md Future release of Tableau Server will allow rename of datasource. I believe its best to let the official REST API documentation (https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm) be the official source of what the REST API can and can't do (correct me if I'm wrong). The REST API docs will be updated prior to the server release. * Update "Datasource" to "Data Source" In response to dzucker feedback --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index a35e58d54..3731478ee 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -674,9 +674,9 @@ A refreshed `DatasourceItem`. datasource.update(datasource_item) ``` -Updates the owner or project of the specified data source. Data source name cannot be updated. +Updates the specified data source. -REST API: [Update Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) +REST API: [Update Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_source) **Parameters** From 3270c20d8deb6d224f2527b52d7e1fd48bdad667 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 1 Jul 2021 16:11:40 -0700 Subject: [PATCH 091/158] Be more clear that always using the latest REST API version is recommended --- docs/api-ref.md | 1 + docs/versions.md | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 98941cd96..dbbd33ebe 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3202,6 +3202,7 @@ The possible user roles for the `site_role` attribute are the following: * `ReadOnly` * `Viewer` +Note: If any operations related to a user's `site_role` cause a 400 error response (for example: `Invalid site role: 'Explorer' is malformed or is not a supported user role in this version of Tableau`), ensure you are [using the latest REST API version for your server](versions#use-the-rest-api-version-supported-by-the-server). **Example** diff --git a/docs/versions.md b/docs/versions.md index 2ed8a8b3e..5fc0d2d7e 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -23,11 +23,13 @@ server = TSC.Server('http://SERVER_URL') print(server.version) ``` -For example, the code might display version `2.3`. +For example, the code might display version `3.10`. ## Use the REST API version supported by the server -There are two options for always using the the latest version of the REST API that is supported by the instance of Tableau Server you are connecting to. This could be necessary in cases where you're using an API feature that is only supported in a newer REST API version. +It's recommended to always use the latest REST API version supported by the server. This helps ensure you'll get the latest behaviors as documented here and in the Tableau REST API documentation. + +There are two options for always using the the latest version supported by the instance of Tableau Server you are connecting to: The first method is to specify `use_server_version=True` as one of the arguments, for example: From 751815477091329b5d07a08240ea092aa2a58871 Mon Sep 17 00:00:00 2001 From: Ovini Nanayakkara <44311587+ovinis@users.noreply.github.com> Date: Fri, 23 Jul 2021 12:51:51 -0400 Subject: [PATCH 092/158] Fixed jobs.get_by_id(job_id) example (#867) --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 98941cd96..60f4f3adc 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1315,7 +1315,7 @@ Source files: server/endpoint/jobs_endpoint.py ```py -jobs.get(job_id) +jobs.get_by_id(job_id) ``` @@ -1362,7 +1362,7 @@ Returns the `JobItem` requested. myJobId = '576b616d-341a-4539-b32c-1ed0eb9db548' - jobinfo = server.jobs.get(myJobID) + jobinfo = server.jobs.get_by_id(myJobId) print(jobinfo) From 66057378ac56622012709be352239d1c294e960f Mon Sep 17 00:00:00 2001 From: Ovini Nanayakkara <44311587+ovinis@users.noreply.github.com> Date: Fri, 23 Jul 2021 18:03:12 -0400 Subject: [PATCH 093/158] Updated jobs.get_by_id title (#868) --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 60f4f3adc..f1893d4fa 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1311,7 +1311,7 @@ Source files: server/endpoint/jobs_endpoint.py
      -#### jobs.get +#### jobs.get_by_id ```py From a73a8518ddf0a30e1fd54172b61f60724d8897a2 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 24 Aug 2021 08:36:19 -0700 Subject: [PATCH 094/158] Add 2021.2 REST API version now that it is being released --- docs/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions.md b/docs/versions.md index 5fc0d2d7e..8351820fe 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -66,6 +66,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.12|2021.2| |3.11|2021.1| |3.10|2020.4| |3.9|2020.3| From 13f08510b31d20559699bcc9aa21a185fdcfd19e Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 1 Sep 2021 14:09:56 -0700 Subject: [PATCH 095/158] Update links to Data Source Methods page in REST API docs --- docs/api-ref.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 59cd3a946..a4e77db76 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -289,7 +289,7 @@ The `DatasourceItem` represents the data source resources on Tableau Server. Thi Name | Description :--- | :--- -`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specified, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement. +`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specified, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#publish_data_source) for more information about ask_data_enablement. `connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class). `content_url` | The name of the data source as it would appear in a URL. `created_at` | The date and time when the data source was created. @@ -630,7 +630,7 @@ datasource.refresh(datasource_item) Refreshes the data of the specified extract. -REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#update_data_source_now) +REST API: [Update Data Source Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source_now) **Parameters** From 51459670af4dea4667d85228b3971f2f06e05f7c Mon Sep 17 00:00:00 2001 From: Adrian Vogelsgesang Date: Sat, 18 Sep 2021 17:26:36 +0200 Subject: [PATCH 096/158] Update docs to reflect the arguments accepted by the sample scripts Change the docs to be in sync with PR #889 --- docs/dev-guide.md | 4 +++- docs/samples.md | 20 ++++++++++++-------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index bd3266f06..0a16b112d 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -127,7 +127,9 @@ depending on how and where git is installed on your system, for example: 1. Add testing by getting real xml responses from the server, and asserting that all properties are parsed and set correctly. -1. Add a sample to show users how to use the new feature. +1. Add a sample to show users how to use the new feature. Try to keep the command + line arguments of your sample consistent with the [Samples documentation page](samples) + and with other samples. 1. Add documentation (most likely in api-ref.md) in a separate pull request (see more below). diff --git a/docs/samples.md b/docs/samples.md index ed6533e18..7e2020798 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -10,14 +10,19 @@ The TSC samples are included in the `samples` directory of the TSC repository [o ## Run the samples -Each of the samples requires the following arguments: +Each of the samples accepts the following arguments: -* `--server`. The URL for the Tableau Server that you want to connect to. -* `--username`. The user name of the Tableau Server account that you want to use. When you run the samples, you are - prompted for a password for the user account that you enter. +* `--server` (required): The URL for the Tableau Server that you want to connect to. +* `--site` (optional): The site on the Server that you want to connect to. +* `--token-name` (required): The name of the personal access token used to sign into the server. +* `--token-value` (required): The value of the personal access token used to sign into the server. +* `--logging-level` (optional; `debug`, `info` or `error`): The desired log level. -Additionally, some of the samples require that you enter other arguments when you run them. For more information about -the arguments required by a particular sample, run the sample with the `-h` flag to see the help output. +To get a `token-name` and `token-value`, you will have to create personal access token first. +You can follow [Tableau's documentation](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm#create-tokens) to do so. + +Some of the samples also require additional arguments. For more information about the arguments +required by a particular sample, run the sample with the `-h` flag. For example, if you run the following command: @@ -25,8 +30,7 @@ For example, if you run the following command: python samples/publish_workbook.py -h ``` -You might see that you need to enter a server address, a user name, and a file path for the workbook that you want to -publish. +You will see that you need to enter a file path for the workbook that you want to publish. ## Samples list From 0d8befd79c201fffc49e396253974a6aff66b598 Mon Sep 17 00:00:00 2001 From: Adrian Vogelsgesang Date: Sat, 18 Sep 2021 17:36:48 +0200 Subject: [PATCH 097/158] Document the `metadata.query` method --- docs/api-ref.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/samples.md | 1 + 2 files changed, 50 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index a4e77db76..874449da7 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1374,6 +1374,55 @@ Returns the `JobItem` requested. ``` +
      +
      + +--- + +## Metadata + +Using the `metadata` endpoint, one can use GraphQL to query metadata on, e.g., workbooks, datasources, the fields contained within them, and the relationships between them. + +### Metadata methods + + +The Metadata methods call the [Metadata API](https://help.tableau.com/current/api/metadata_api/en-us/index.html) which is a GraphQL interface allowing to query metadata about objects on the server (workbooks, datasources, ...) and the relationships between them. + + +Source files: server/endpoint/metadata_endpoint.py + +
      +
      + + +#### metadata.query + + +```py +metadata.query(query, variables=None, abort_on_error=False) +``` + +Executes a metadata query and returns the result. + + +**Parameters** + +Name | Description +:--- | :--- +`query` | The GraphQL query +`variables` | Variables for the GraphQL query +`abort_on_error` | Whether to throw an exception on error + + +**Returns** + +The method returns the query results as a stucture of `list`s and `dict`s as returned by the `json` package. + + +**Example** + +See the `metadata_query.py` sample in the Samples directory. +

      diff --git a/docs/samples.md b/docs/samples.md index ed6533e18..ab0ce6ef7 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -48,6 +48,7 @@ The following list describes the samples available in the repository: * `kill_all_jobs.py` Kills all running jobs. * `list.py` Lists all datasources or workbooks of a site. * `login.py` Demonstrates logging in to the server with either username/password or personal access token. +* `metadata_query.py` Uses the metadata API to query information on a published data source. * `move_workbook_projects.py` Moves a workbook from one project to another. * `move_workbook_sites.py` Downloads a workbook, stores it in-memory, and uploads it to another site. * `pagination_sample.py` Uses the Pager generator to iterate over all the items on the server. From 7b93954e8e8854e146cb29a142c44726be4734b4 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 29 Sep 2021 09:05:32 -0700 Subject: [PATCH 098/158] Add 2021.3 REST API version 3.13 --- docs/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions.md b/docs/versions.md index 8351820fe..a1b46402b 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -66,6 +66,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.13|2021.3| |3.12|2021.2| |3.11|2021.1| |3.10|2020.4| From 7892b424e3af21612b65b27f964502c6e720a24a Mon Sep 17 00:00:00 2001 From: Adrian Vogelsgesang Date: Thu, 21 Oct 2021 19:55:09 +0200 Subject: [PATCH 099/158] Document the `datasources.update_hyper_data` method (#893) --- docs/api-ref.md | 38 ++++++++++++++++++++++++++++++++++++++ docs/samples.md | 1 + 2 files changed, 39 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index 874449da7..4157c3f2b 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -748,6 +748,44 @@ An updated `ConnectionItem` for the data source. See the `update_connection.py` sample in the Samples directory. +
      +
      + +#### datasource.update_hyper_data + +```py +datasource.update_hyper_data(datasource_or_connection_item, *, request_id, actions, payload=None) +``` + +Updates the data contained within a published live-to-Hyper datasource. + +REST API: [Update Data in Hyper Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_data_in_hyper_data_source) + +**Version** + +This endpoint is available with REST API version 3.13 and up. + +**Parameters** + +Name | Description + :--- | : --- +`datasource_or_connection_item` | Either a `DataSourceItem` or a `ConnectionItem`. If the datasource only contains a single connection, the `DataSourceItem` is sufficient to identify which data should be updated. Otherwise, for datasources with multiple connections, a `ConnectionItem` must be provided. +`request_id` | User supplied arbitrary string to identify the request. A request identified with the same key will only be executed once, even if additional requests using the key are made, for instance, due to retries when facing network issues. +`actions` | a list of actions (insert, update, delete, ...) specifying how to modify the data within the published datasource +`payload` | an (optional) Hyper file containing tuples to be inserted/deleted or other payload data used by the `actions`. + +For more information on the `actions`, see the [REST API docs on "Action batch description"](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm#action-batch-descriptions). +To create a `payload` Hyper file, you can use [Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/index.html) or [pantab](https://github.com/innobi/pantab). + +**Returns** + +A `JobItem` for the update job on the server. Upon completion of this job, the data was updated. + +**Example** + +See the `update_datasource_data.py` sample in the Samples directory. + +

      diff --git a/docs/samples.md b/docs/samples.md index 78c896a5a..ef3b262ae 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -64,5 +64,6 @@ The following list describes the samples available in the repository: * `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks. * `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource. * `update_connection.py` Updates and embeds connection credentials of a datasource. +* `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource. **Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Online. From 328a6728af93ddb68cbb8b5d57433d9eba7ceed7 Mon Sep 17 00:00:00 2001 From: Adrian Vogelsgesang Date: Thu, 21 Oct 2021 19:55:28 +0200 Subject: [PATCH 100/158] Document `jobs.wait_for_job` (#909) This commit adds the corresponding documentation for PR #903 --- docs/api-ref.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 4157c3f2b..89ae9ebe3 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1354,7 +1354,6 @@ Source files: server/endpoint/jobs_endpoint.py ```py jobs.get_by_id(job_id) - ``` Gets information about the specified job. @@ -1412,6 +1411,40 @@ Returns the `JobItem` requested. ``` +
      +
      + +#### jobs.wait_for_job + + +```py +jobs.wait_for_job(job_id, *, timeout=None) +``` + +Waits until a given job succesfully finishes. +Repeatedly polls the server using `jobs.get_by_id` until the job completed. +It uses an exponentially increasing sleep time between polls to guarantee a snappy response time for fast-running jobs while not putting overly large load on the server for long-running jobs. + +In case the job fails or is cancelled, `wait_for_job` will raise an exception. + +**Parameters** + +Name | Description +:--- | :--- +`job_id` | The `job_id` specifies the id of the job that we want to wait for +`timeout` | Optional timeout interval in seconds. `wait_for_job` will raise a `TimeoutError` if the job is not finished after waiting for `timeout` seconds. + + +**Returns** + +Returns the final `JobItem`. + +Usually, you can just discard the return value without checking the job status. In case the job wasn't succesful, `wait_for_job` would have already raised an exception. For advanced scenarios, he returned `JobItem` might still be interesting to access e.g. start and end time or `notes`. + +**Example** + +See the `update_datasource_data.py` or `refresh.py` sample in the Samples directory. +

      From af2a1f8c05ed4b81d25b6425b22ccced3f0b2e00 Mon Sep 17 00:00:00 2001 From: Akira Kuroda Date: Wed, 27 Oct 2021 04:37:58 +0900 Subject: [PATCH 101/158] add documentation for attributes of JobItem (#926) --- docs/api-ref.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 89ae9ebe3..b8759e0ce 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1335,7 +1335,9 @@ Name | Description `started_at` | The time the job started. `completed_at` | The time the job finished. `finish_code` | The return code from job. - +`progress` | The progress of the job. +`notes` | The notes of the job. +`mode` | The mode of the job. ### Jobs methods From 01076247594522cd77d8a42a35f1ff9d9869ef71 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 1 Nov 2021 13:03:33 -0700 Subject: [PATCH 102/158] Add 2021.4 version, coming soon --- docs/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions.md b/docs/versions.md index a1b46402b..0cf8c3513 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -66,6 +66,7 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.14|2021.4| |3.13|2021.3| |3.12|2021.2| |3.11|2021.1| From 42ad30e44bdde35b34ec7ca0710d28afd4495681 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 1 Nov 2021 13:03:52 -0700 Subject: [PATCH 103/158] Add troubleshooting for Bad Request --- docs/troubleshooting.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index d94877511..063d30894 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -12,6 +12,20 @@ This page covers some common troubleshooting tips for using the TSC library. * TOC {:toc} +## 400000 Bad Request + +It's not uncommon to receive a response error similar to the following: + + 400000: Bad Request + Payload is either malformed or incomplete + +This type of response can be caused by several different problems communicating with the backend REST API. Try these steps to resolve the issue: + +1. Update to the latest release of the TSC library +2. Adjust your code to always [use the latest REST API version supported by the server](versions#use-the-rest-api-version-supported-by-the-server) + +If the problem still persists, you can post an Issue with details to see if others can help. It might also be helpful to capture the REST API requests and responses as described next. + ## Logging REST API communication with Tableau Server There may be cases where it's helpful to inspect the REST API calls the TSC library is making and the responses coming back from Tableau Server. Some examples might be: From ab1753b3acb67c7c21efff9691426034ab7bdf49 Mon Sep 17 00:00:00 2001 From: Ramindu Deshapriya Date: Sun, 7 Nov 2021 06:50:25 -0500 Subject: [PATCH 104/158] Added missing params from workbooks.publish() documentation (#928) * Added skip_connection_check and as_job params * Added hidden_views * Added connections param * Added deprecation note to connection_credentials param * Added connections, skip_connection_check, as_job and hidden_views params to function signature description --- docs/api-ref.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index b8759e0ce..e2e402e7d 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4238,7 +4238,7 @@ print(workbook.name) #### workbooks.publish ```py -workbooks.publish(workbook_item, file_path, publish_mode) +workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job, hidden_views) ``` Publish a workbook to the specified site. @@ -4261,7 +4261,11 @@ Name | Description `workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). `file_path` | The path and name of the workbook to publish. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). +`connections` | List of `ConnectionCredentials` objects for the connections created within the workbook. +`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). **Deprecated since API server version 2.3.** +`skip_connection_check` | (Optional) Set to `True` to skip connection check at time of upload. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. Defaults to `False`. +`as_job` | (Optional) Set to `True` to run the upload as a job (asynchronous upload). If set to `True` a job will start to perform the publishing process and a `Job` object is returned. Defaults to `False`. +`hidden_views` | (Optional) List of string names of views that need to be hidden when the workbook is published. From bb26d523a3d023fc8a2755e84dd2de59cef95e41 Mon Sep 17 00:00:00 2001 From: Martin Peters Date: Tue, 9 Nov 2021 04:25:57 +0000 Subject: [PATCH 105/158] added project permission docs + default permission docs (#528) Co-authored-by: Martin Peters Co-authored-by: Jac --- docs/api-ref.md | 424 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 419 insertions(+), 5 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index e2e402e7d..50c800dc8 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1723,9 +1723,6 @@ See [ProjectItem class](#projectitem-class) # call method to update project updated_project = server.projects.update(my_project) - - - ```

      @@ -1753,8 +1750,6 @@ Name | Description `project_id` | The ID of the project to delete. - - **Exceptions** Error | Description @@ -1774,6 +1769,425 @@ Error | Description ``` +#### projects.populate_permissions +```py +projects.populate_permissions(item) +``` + +Queries the project permissions, parses and stores the returned the permissions. + +REST API: [Query Project Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_project_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. + + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + server.projects.populate_permissions(project_item) +``` + + +#### projects.update_permission +```py +projects.update_permission(item, rules) +``` + +Add or update project permissions. + +REST API: [Add Project Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#add_project_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + project_capabilities = { + TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow + } + + project_rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=project_capabilities + ) + + server.projects.update_permission(project_item, [project_rules]) +``` + + +#### projects.delete_permission +```py +projects.delete_permission(item, rules) +``` + +Delete project permissions. + +REST API: [Delete Project Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_project_permission){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects or a single PermissionsRule object. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + project_capabilities = { + TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow + } + + project_rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=project_capabilities + ) + + server.projects.delete_permission(project_item) +``` + + +#### projects.populate_workbook_default_permissions +```py +projects.populate_workbook_default_permissions(item) +``` + +Queries the default workbook permissions, parses and stores the returned the permissions. + +REST API: [Query Default Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + server.projects.populate_workbook_default_permissions(project_item) +``` + +#### projects.populate_datasource_default_permissions +```py +projects.populate_datasource_default_permissions(item) +``` + +Queries the default datasource permissions, parses and stores the returned the permissions. + +REST API: [Query Default Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + server.projects.populate_datasource_default_permissions(project_item) +``` + + +#### projects.populate_flow_default_permissions +```py +projects.populate_flow_default_permissions(item) +``` + +Queries the default flow permissions, parses and stores the returned the permissions. + +REST API: [Query Default Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions){:target="_blank"} + + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + server.projects.populate_flow_default_permissions(project_item) +``` + +#### projects.update_workbook_default_permissions +```py +projects.update_workbook_default_permissions(item, rules) +``` + +Add or update default workbook permissions. + +REST API: [Add Default Workbook Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#add_default_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.update_workbook_default_permissions(project_item, [rules]) +``` + +#### projects.update_datasource_default_permissions +```py +projects.update_datasource_default_permissions(item, rules) +``` + +Add or update default datasource permissions. + +REST API: [Add Default Datasource Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#add_default_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.update_datasource_default_permissions(project_item, [rules]) +``` + + +#### projects.update_flow_default_permissions +```py +projects.update_flow_default_permissions(item, rules) +``` + +Add or update default flow permissions. + +REST API: [Add Default Flow Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#add_default_permissions){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.update_flow_default_permissions(project_item, [rules]) +``` + +#### projects.delete_workbook_default_permissions +```py +projects.delete_workbook_default_permissions(item, rules) +``` + +Delete default workbook permissions. + +REST API: [Delete Default Workbook Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.delete_workbook_default_permissions(project_item, [rules]) +``` + +#### projects.delete_datasource_default_permissions +```py +projects.delete_datasource_default_permissions(item, rules) +``` + +Delete default datasource permissions. + +REST API: [Delete Default Datasource Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.delete_datasource_default_permissions(project_item, [rules]) +``` + +#### projects.delete_flow_default_permissions +```py +projects.delete_flow_default_permissions(item, rules) +``` + +Delete default flow permissions. + +REST API: [Delete Default Flow Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission){:target="_blank"} + +**Parameters** + +Name | Description +:--- | :--- +`item` | A project object. +`rules` | A list of PermissionsRule objects. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc. + + all_project_items, pagination_item = server.projects.get() + project_item = all_project_items[0] + + capabilities = { + TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow + } + + rules = TSC.PermissionsRule( + grantee=project_item, + capabilities=capabilities + ) + + server.projects.delete_flow_default_permissions(project_item, [rules]) +``` +

      From 19d1293773ea3ae1896c597417349d28e839a37f Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 10 Nov 2021 13:55:38 -0800 Subject: [PATCH 106/158] Fix one REST API doc reference and add a missing one --- docs/api-ref.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index b8759e0ce..d88cde715 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -3501,6 +3501,8 @@ users.populate_groups(user_item, req_options=None): Returns the groups that the user belongs to. +REST API: [Get Groups for a User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#get_groups_for_a_user) + **Parameters** Name | Description @@ -3554,10 +3556,9 @@ users.populate_workbooks(user_item, req_options=None): Returns information about the workbooks that the specified user owns and has Read (view) permissions for. - This method retrieves the workbook information for the specified user. The REST API is designed to return only the information you ask for explicitly. When you query for all the users, the workbook information for each user is not included. Use this method to retrieve information about the workbooks that the user owns or has Read (view) permissions. The method adds the list of workbooks to the user item object (`user_item.workbooks`). -REST API: [Query Datasource Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_data_source_connections) +REST API: [Query Workbooks for User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#query_workbooks_for_user) **Parameters** From 2edc87a1c705f88b1e655b69e0df4da191ee2acb Mon Sep 17 00:00:00 2001 From: Julian Steger Date: Wed, 5 Jan 2022 16:02:34 +0100 Subject: [PATCH 107/158] Update api-ref.md fix typo --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 6b833c16a..7f812f617 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -625,7 +625,7 @@ The `DatasourceItem` for the data source that was added or appended to. #### datasources.refresh ```py -datasource.refresh(datasource_item) +datasources.refresh(datasource_item) ``` Refreshes the data of the specified extract. From 47bd52f350c6999915b878384f20ecf01007003c Mon Sep 17 00:00:00 2001 From: dzucker-tab <49076749+dzucker-tab@users.noreply.github.com> Date: Thu, 13 Jan 2022 09:18:49 -0800 Subject: [PATCH 108/158] Update filter-sort.md typo fix --- docs/filter-sort.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 5425f5923..81d102c0e 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -104,7 +104,7 @@ for workbook in all_workbooks: ### Direction criteria - Django style -The field name cane be input as normal for ascending or prefixed with `-` for descending. +The field name can be input as normal for ascending or prefixed with `-` for descending. ### Sorting example - Django style @@ -162,4 +162,4 @@ all_workbooks = server.workbooks.filter(project_name__in=["Project A", "Project | LessThan | lt | | LessThanOrEqual | lte | | In | in | -| Has | has | \ No newline at end of file +| Has | has | From d4a3cc29a433b60c2afb3c85d7ca48ad7f142a54 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 25 Jan 2022 18:38:38 -0800 Subject: [PATCH 109/158] Add section about handling SSL certificates for Tableau Server Also including some minor grammer edits --- docs/sign-in-out.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 675f01f8d..a48fa166e 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -28,11 +28,11 @@ Name | Description TOKEN_NAME | The personal access token name (from the My Account settings page) TOKEN_VALUE | The personal access token value (from the My Account settings page) **Tableau Server** | -SITENAME | The Tableau Server site you are authenticating with; for example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam; in the REST API documentation this field is also referred to as contentUrl; this value can be omitted to connect with the Default site on the server -SERVER_URL | The Tableau Server you are authenticating with; if your server has SSL enabled, this should be an HTTPS link +SITENAME | The Tableau Server site you are authenticating with. For example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam. In the REST API documentation, this field is also referred to as contentUrl. This value can be omitted to connect with the Default site on the server. +SERVER_URL | The Tableau Server you are authenticating with. If your server has SSL enabled, this should be an HTTPS link. **Tableau Online** | -SITENAME | The Tableau Online site you are authenticating with; for example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664; in the REST API documentation this field is also referred to as contentUrl; this value is always required when connecting to Tableau Online -SERVER_URL | The Tableau Online instance you are authenticating with; in the example above the server URL would be https://10ay.online.tableau.com; this will always be an an HTTPS link +SITENAME | The Tableau Online site you are authenticating with. For example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664. In the REST API documentation, this field is also referred to as contentUrl. This value is always required when connecting to Tableau Online. +SERVER_URL | The Tableau Online instance you are authenticating with. In the example above the server URL would be https://10ay.online.tableau.com. This will always be an an HTTPS link. This example illustrates using the above values to sign in with a personal access token, do some operations, and then sign out: @@ -73,6 +73,29 @@ server.auth.sign_in(tableau_auth) server.auth.sign_out() ``` +### Handling SSL certificates for Tableau Server + +If you're connecting to a Tableau Server instance that uses self-signed or non-public SSL certificates, you may need to provide those as part of the sign in process. An example of this could be an on-premise Tableau Server that is using internally-generated SSL certificates. You may see an error like `SSL: CERTIFICATE_VERIFY_FAILED` if you connect with a Tableau Server but don't have the SSL certificates configured correctly. + +The solution here is to call `server.add_http_options()` and include the local path containing the SSL certificate file: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITENAME') +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.add_http_options({'verify': '/path/to/certfile.pem'}) +server.auth.sign_in(tableau_auth) + +# Do awesome things here! + +server.auth.sign_out() +``` + +The TSC library uses the Python Requests library under the hood, so you can learn more about the `verify` option on the [Python Requests advanced usage](https://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification) documentation. + +You can also set `verify` to `False` to disable the SSL certificate verification step, but this is only useful for development and _should not be used for real production work_. + ### 405000 Method Not Allowed Response In some cases, you may find that sign in fails with a 405 message: From 5e6edaf4531d4a374f7e5303469303845ad94a02 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 1 Feb 2022 08:18:16 -0800 Subject: [PATCH 110/158] Update dev guide to reflect switch from pycodestyle to black (#983) Follow-on to code and CI pipeline changes in #935 Fixes #933 --- docs/dev-guide.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 0a16b112d..27d781ff9 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -67,9 +67,10 @@ Here's a quick checklist to follow when coding to ensure a good pull request goal. - Ensure all indentation is done as 4-spaces and your editor is set to unix line endings. -- The code matches PEP8 style guides. Make sure to run - `pycodestyle tableauserverclient test samples` to catch and fix any style - issues before submitting your pull request. +- The code matches PEP8 style guides, enforced by the black formatter. Make sure to run + `black --line-length 120 tableauserverclient samples test` to catch and fix any style + issues before submitting your pull request. (Run black with the `--check` option if + you want to check whether formatting is valid without changing any files.) - Keep commit messages clean and descriptive. ### Use git pre-commit hook @@ -84,7 +85,7 @@ Create a file `pre-commit` with the contents below and mark it as executable To test that the hook is working correctly, make a style-inconsistent change (for example, changing some indentation to not be a multiple of 4), then try to commit -locally. You should get a failure with an explanation from pycodestyle with the +locally. You should get a failure with an explanation from black with the issue. ```shell @@ -94,8 +95,8 @@ issue. if [ -e tableauserverclient/__init__.py ]; then # check for style conventions in all code dirs - echo Running pycodestyle - pycodestyle tableauserverclient test samples + echo Running black format check + black --check --line-length 120 tableauserverclient samples test fi ``` From 01d9f52db20e9912381d05a9344629ad96f8bd3f Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 26 Apr 2022 17:31:48 -0700 Subject: [PATCH 111/158] Update versions to add 2022.1 and 2022.2 (#1029) --- docs/versions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/versions.md b/docs/versions.md index 0cf8c3513..e6cced389 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -66,6 +66,8 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.16|2022.2| +|3.15|2022.1| |3.14|2021.4| |3.13|2021.3| |3.12|2021.2| From f84c894d72cd1f03bcea43b6a76dc78c3f17506e Mon Sep 17 00:00:00 2001 From: jorwoods Date: Wed, 4 May 2022 02:21:12 -0500 Subject: [PATCH 112/158] Add metric details to docs (#1016) * Add typing info to contributing guide * Add docs for metrics --- docs/api-ref.md | 225 +++++++++++++++++++++++++++++++++++++++++++++- docs/dev-guide.md | 9 +- 2 files changed, 231 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 7f812f617..9832ac0ec 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1499,6 +1499,229 @@ See the `metadata_query.py` sample in the Samples directory.

      +--- + +## Metrics + +Using the TSC library, you can get information about all metrics on a site, update, or delete metrics. + +
      + +### MetricItem class + +```py +MetricItem(name: Optional[str]=None) +``` +The metrics resources for Tableau are defined in the `MetricItem` class. The class corresponds to the metric resource you can access using the Tableau Server REST API. + +**Attributes** +Name | Description +:--- | :--- +`name` | Name of the metric +`id` | The REST API id for the metric +`description` | The description of the metric +`webpage_url` | The URL for the metric +`created_at` | The datetime object for when the metric was created +`updated_at` | The datetime object for when the metric was updated +`suspended` | Boolean for if the metric is in a suspended state +`project_id` | REST API id for the project containing the metric +`project_name` | The name of the project containing the metric +`owner_id` | REST API id for the user who owns the metric +`view_id` | REST API id for the view from which the metric was created + + + +Source file: models/metric_item.py + +
      +
      + +### Metric methods + +The metric methods are based upon the endpoints for metrics in the REST API and operate on the `MetricItem` class. The metrics endpoint also supports the django style filtering. +See [Filter and Sort](filter-sort) for more information. + +Source files: server/endpoint/metrics_endpoint.py + +
      +
      + +#### metrics.delete + +```py +metrics.delete(metric_id) + +``` + +Deletes a metric item from a site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Delete Metric](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_metric) + + +**Parameters** + +Name | Description +:--- | :--- +`metric_id` | The id of the metric to delete + + + +**Returns** + +None + + + + **Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + +server.metrics.delete("6561daa3-20e8-407f-ba09-709b178c0b4a") + +``` + +
      +
      + +#### metrics.get + +```py +metrics.get() + +``` + +Return a list of metrics items for a site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [List Metrics for Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#list_metrics_for_site) + + +**Parameters** + +None. + +**Returns** + +Returns a Tuple containing a list of all `MetricItem` objects and a `PaginationItem`. Use these values to iterate through the results. + + + + **Example** + +```py +import tableauserverclient as TSC +tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD', site_id='CONTENTURL') +server = TSC.Server('https://SERVER') + +with server.auth.sign_in(tableau_auth): + # get all metrics on site + all_metric_items, pagination_item = server.metrics.get() + print([metric.name for metric in all_metric_items]) + +``` + +
      +
      + +#### metrics.get_by_id + +```py +metrics.get_by_id(metric_id) + +``` + +Return a specific metric item from the site. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Get Metric](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get_metric) + + +**Parameters** + + +Name | Description +:--- | :--- +`metric_id` | The id of the desired metric + + + +**Returns** + +Returns a `MetricItem` object corresponding to the ID requested. + + + + **Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + +server.metrics.get_by_id("6561daa3-20e8-407f-ba09-709b178c0b4a") + +``` + +
      +
      + +#### metrics.update + +```py +metrics.update(item) + +``` + +Updates a metric item on the Tableau Server. + + +To specify the site, create a `TableauAuth` instance using the content URL for the site (`site_id`), and sign in to that site. See the [TableauAuth class](#tableauauth-class). + +REST API: [Update Metric](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_metric) + + +**Parameters** + + +Name | Description +:--- | :--- +`metric_item` | The altered `MetricItem` to be updated on the Tableau Server + + +**Returns** + +Returns a `MetricItem` object reflecting the changes applied to Tableau Server. + + + + **Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, etc + +metric = server.metrics.get_by_id("6561daa3-20e8-407f-ba09-709b178c0b4a") +metric.owner_id = "1bbbc2b9-847d-443c-9a1f-dbcf112b8814" +server.metrics.update(metric) +``` + +
      +
      + + + + --- ## Projects @@ -2838,7 +3061,7 @@ Attribute | Description `name` | The name of the site. The name of the default site is "". `content_url` | The path to the site. `admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) -`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. +`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. Mutually exclusive with tiered license level settings. `storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. `disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. `subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 27d781ff9..04133449a 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -97,6 +97,8 @@ then # check for style conventions in all code dirs echo Running black format check black --check --line-length 120 tableauserverclient samples test + echo Running mypy type checking + mypy --show-error-codes --disable-error-code misc --disable-error-code import tableauserverclient test fi ``` @@ -128,11 +130,14 @@ depending on how and where git is installed on your system, for example: 1. Add testing by getting real xml responses from the server, and asserting that all properties are parsed and set correctly. -1. Add a sample to show users how to use the new feature. Try to keep the command +1. Add type hints to all new classes and functions added. Including type hinting + on unit tests. + +2. Add a sample to show users how to use the new feature. Try to keep the command line arguments of your sample consistent with the [Samples documentation page](samples) and with other samples. -1. Add documentation (most likely in api-ref.md) in a separate pull request +3. Add documentation (most likely in api-ref.md) in a separate pull request (see more below). ### Add tests From decc309e1ad928900ffa8ae847d6e221b5aa1880 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 28 Jul 2022 14:26:27 -0700 Subject: [PATCH 113/158] Update help links (#1080) * Update some links to Tableau REST API docs * Fix link to Python Requests library --- docs/api-ref.md | 10 +++++----- docs/sign-in-out.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 9832ac0ec..142df74eb 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -297,7 +297,7 @@ Name | Description `certification_note` | The optional note that describes the certified data source. `datasource_type` | The type of data source, for example, `sqlserver` or `excel-direct`. `description` | The description for the data source. -`encrypt_extracts` | A Boolean value to determine if a datasource should be encrypted or not. See [Extract and Encryption Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_encryption.htm) for more information. +`encrypt_extracts` | A Boolean value to determine if a datasource should be encrypted or not. See [Extract and Encryption Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm) for more information. `has_extracts` | A Boolean value that indicates whether the datasource has extracts. `id` | The identifier for the data source. You need this value to query a specific data source or to delete a data source with the `get_by_id` and `delete` methods. `name` | The name of the data source. If not specified, the name of the published data source file is used. @@ -1253,7 +1253,7 @@ groups.update(group_item, as_job=False) Updates a group in Tableau Server. -REST API: [Update Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_usersgroups.htm#update_group) +REST API: [Update Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#update_group) **Parameters** @@ -3887,7 +3887,7 @@ tasks.delete(task_id) Deletes an extract refresh task. -REST API: [Run Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobstasksschedules.htm#delete_workbook){:target="_blank"} +REST API: [Delete Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#delete_extract_refresh_task){:target="_blank"} **Parameters** @@ -4950,7 +4950,7 @@ workbooks.refresh(workbook_item) Refreshes the extract of an existing workbook. -REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#update_workbook_now) +REST API: [Update Workbook Now](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_workbook_now) **Parameters** @@ -5376,7 +5376,7 @@ Populates the PDF content of the specified workbook. This method populates a PDF with image(s) of the workbook view(s) you specify. -REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooksviews.htm#download_workbook_pdf) +REST API: [Download Workbook PDF](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#download_workbook_pdf) **Version** diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index a48fa166e..46c09dae7 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -92,7 +92,7 @@ server.auth.sign_in(tableau_auth) server.auth.sign_out() ``` -The TSC library uses the Python Requests library under the hood, so you can learn more about the `verify` option on the [Python Requests advanced usage](https://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification) documentation. +The TSC library uses the Python Requests library under the hood, so you can learn more about the `verify` option on the [Python Requests advanced usage](https://requests.readthedocs.io/en/latest/user/advanced/#ssl-cert-verification) documentation. You can also set `verify` to `False` to disable the SSL certificate verification step, but this is only useful for development and _should not be used for real production work_. From 69737eee2095efce298857f1bdb3045c56d8f96d Mon Sep 17 00:00:00 2001 From: Karthika <72409920+kramantab@users.noreply.github.com> Date: Fri, 5 Aug 2022 14:22:36 -0700 Subject: [PATCH 114/158] Adding Webhooks documentation (#1084) * First Draft for adding webhooks Issue ID #739 TFS ID 1438037 * Adding to TOC, making formatting changes, and updated sample code post testing * Delete Gemfile * Update api-ref.md * Update api-ref.md Removing --- from code blocks per Brain's review * Update api-ref.md Adding a space between "=" and adding a line before print statements * adding spaces before print statement, lower case for webhook (consistency) and recommendation for using short event name * Restore original Gemfile Co-authored-by: Brian Cantoni --- Gemfile | 1 - _includes/docs_menu.html | 2 + docs/api-ref.md | 209 ++++++++++++++++++++++++++++++++++++++- 3 files changed, 207 insertions(+), 5 deletions(-) diff --git a/Gemfile b/Gemfile index 775d954bf..37f5eaa42 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,2 @@ source 'https://rubygems.org' gem 'github-pages', group: :jekyll_plugins - diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index 012ad2cd5..b8026fc6f 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -81,6 +81,8 @@
    • Views +
    • + Webhooks
    • Workbooks diff --git a/docs/api-ref.md b/docs/api-ref.md index 142df74eb..2a55f498b 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4700,21 +4700,222 @@ See [ViewItem class](#viewitem-class) --- +## Webhooks +
      +
      +Using the Tableau Server Client (TSC), you can create a new webhook, get a list of all the webhooks, get details about a specific webhook, or delete a webhook. +
      +The webhook resource for Tableau Server and Tableau Cloud are defined in the `WebhookItem` class. The class corresponds to the webhook resources you can access using the Tableau REST API. For example, using REST API, you can gather information about a workbook, like the name of the Webbook, the event it is associated with, and the destination URL, and you can get the same information using TSC as well. +
      -## Workbooks +Tableau webhook REST API endpoints are available in **REST API version 3.16** and later. +
      +
      -Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. +### WebhookItem class +The `WebhookItem` represents the webhook resources on Tableau Server or Tableau Cloud. This is the information that can be sent or returned in response to a REST API request for webhooks. -The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. +**Attributes** +Name | Description +:--- | :--- +`id` | The identifier (*luid*) for the webhook. You need this value to query a specific webhook with the `get_by_id` method or to delete a webhook with the `delete` method. +`name` | The name of the webhook. You must specify this when you create an instance of the `WebhookItem`. +`url` | The destination URL for the webhook. The webhook destination URL must be https and have a valid certificate. You must specify this when you create an instance of the `WebhookItem`. +`event` | The name of the Tableau event that triggers your webhook.This is either `api-event-name` or `webhook-source-api-event-name`: one of these is required to create an instance of the `WebhookItem`. We recommend using the `api-event-name`.
      The event name must be one of the supported events listed in the [Trigger Events](https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html) table. +`owner_id` | The identifier of the owner of the webhook. +**Example** +```py +import tableauserverclient as TSC +# Create new Webhook_item + +new_webhook = TSC.WebhookItem() +``` +Source file: models/webhook_item.py + +
      +
      + +### Webhook methods +The Tableau Server Client provides several methods for interacting with webhook resources, or endpoints. These methods correspond to endpoints in the Tableau REST API. + +Source file: server/endpoint/webhooks_endpoint.py

      +#### webhook.create +```py +webhooks.create(webhook_item) + +``` +Creates a new webhook on a specified site. + +To create a webhook, you must first create a new instance of a `WebhookItem` and pass it to the create method. + +To specify the site to create the new webhook in, create a `TableauAuth` instance using the content URL for the site `(site_id)` and sign in to that site. For more information on how to specify a site, see the [TableauAuth class](#tableauauth-class). + +REST API: [Create Webhook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm#create_webhook) + +##### **Parmeters** + +Name | Description +:--- | :--- +webhook_item | Specifies the properties for the webhook. The webhook_item is the request package. To create a request package, create a new instance of `WebhokItem`. The `WebhookItem` includes the `name`, destination `url`, and the `event` or `source`. The `event` or `source` specifies the Tableau event that should be associated with the webhook. + +**Returns** +Returns the new webhook item. + +**Example** +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVER') +# sign in . For authentication examples, see https://github.com/tableau/server-client-python/blob/master/samples/login.py + + # create a webhook item + with server.auth.sign_in(tableau_auth): + new_webhook = TSC.WebhookItem() + new_webhook.name = 'testWebhook' + new_webhook.event = "workbook-refresh-failed" # alternately, you can also use new_webhook.source="webhook-source-event-workbook-refresh-failed" + new_webhook.url = "https://webhook.site/6e4c957d-dd40-422c-8fc6-7151afe7fc0b" + # create the webhook + new_webhook = server.webhooks.create(new_webhook) + + print("Webhook created. ID: {}".format(new_webhook.id)) + +``` +
      +
      + +### webhook.delete +```py +webhooks.delete(webhook_id) +``` + +Deletes a webhook by ID. + +To specify the site, create a `TableauAuth` instance using the content URL for the site `(site_id)` and sign in to the site. For more information on how to specify a site, see the [TableauAuth class](#tableauauth-class). + +REST API: [Delete Webhook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm#delete_webhook) + +**Parameters** + +Name|Description +:---|:--- +`webhook_id`| The ID of the webhook to delete. + +**Exceptions** + +Error|Description +:---|:--- +`Webhook ID undefined`| Raises an exception if a `webhook_id` is not provided. + +**Example** +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVER') +# sign in . For authentication examples, see https://github.com/tableau/server-client-python/blob/master/samples/login.py + +# Delete the webhook +with server.auth.sign_in(tableau_auth): + server.webhooks.delete('7d60d364-b9f5-4a9c-8aa5-4bdaa38c5dd3') +``` +
      +
      + +#### webhook.get() +```py +webhooks.get() +``` +Returns a list of all the webhooks for a site. +To specify the site, create a `TableauAuth` instance using the content URL for the site `(site_id)`, and sign in to that site. For more information on how to specify a site, see the [TableauAuth class](#tableauauth-class). + +REST API: [List Webhooks](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm#list_webhooks_for_site) + + +**Parameters** + +Name |Description +:---|:--- +`req_option`| (Optional) You can pass themthod oa request object that contains additional parameters to filter the request. For example, you could specify the name of the webhook or the name of the owner. For more information, see [Filter and Sort](filter-sort). + +**Returns** + +Returns a list of all `ProjectItem` objects and a `PagainationItem`. Use these values to iterate through the results. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVER') +# sign in . For authentication examples, see https://github.com/tableau/server-client-python/blob/master/samples/login.py + +# get a list of all the webhooks on a site +with server.auth.sign_in(tableau_auth): + all_webhooks, pagination_item = server.webhooks.get() + +print("\nThere are {} webhooks on site: ".format(pagination_item.total_available)) +print(["Webhook Name:"+ webhook.name+ ";" + "ID:" + webhook.id for webhook in all_webhooks]) + +``` + +#### webhook.get_by_id + +```py +webhooks.get_by_ide(webhook_id) +``` + +Returns information about the specified workbook for a site. + +To specify the site, create a `TableauAuth` instance using the content URL for the site `(site_id)`, and sign in to that site. For more information on how to specify a site, see the [TableauAuth class](#tableauauth-class). + +**Parameters** + +Name|Description +:---|:--- +`webhook_id`| The ID of the webhook. The ID is a *luid*. + +**Exceptions** + +Error|Description +:---|:--- +`Webhook ID undefined`| Raises an exception if a `webhook_id` is not provided. + + +**Example** +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://SERVER') +# sign in . For authentication examples, see https://github.com/tableau/server-client-python/blob/master/samples/login.py + +with server.auth.sign_in(tableau_auth): + webhook = server.webhooks.get_by_id ('7d60d364-b9f5-4a9c-8aa5-4bdaa38c5dd3') + +print (webhook.name, webhook.url) + + +``` +
      +
      + +### Additional Resources +- [REST API Endpoints](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_notifications.htm) +- [Webhooks Documentation](https://help.tableau.com/current/developer/webhooks/en-us/) +- [TSC webhooks samples](https://github.com/tableau/server-client-python/blob/master/samples/explore_webhooks.py) + +--- +## Workbooks + +Using the TSC library, you can get information about a specific workbook or all the workbooks on a site, and you can publish, update, or delete workbooks. + +The project resources for Tableau are defined in the `WorkbookItem` class. The class corresponds to the workbook resources you can access using the Tableau REST API. The workbook methods are based upon the endpoints for projects in the REST API and operate on the `WorkbookItem` class. + +
      + ### WorkbookItem class ```py @@ -4816,7 +5017,7 @@ tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): - all_workbooks_items, pagination_item = server.workbooks.get() + all_workbooks_items, pagination_item = server.workbooks.get() # print names of first 100 workbooks print([workbook.name for workbook in all_workbooks_items]) From 9ae7d3c47b3b8f60ba1916938324f0890b946797 Mon Sep 17 00:00:00 2001 From: Tim <50115603+bossenti@users.noreply.github.com> Date: Sat, 6 Aug 2022 17:59:36 +0200 Subject: [PATCH 115/158] Update & Extend documentation (#1078) * update/fix some documentation aspects * provide documentation for `schedules.add_to_schedule()` --- docs/api-ref.md | 76 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 62 insertions(+), 14 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2a55f498b..fa222170e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -256,10 +256,8 @@ The `ConnectionCredentials` class is used for workbook and data source publish r Attribute | Description :--- | :--- `name` | The username for the connection. -`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`embed` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). `password` | The password used for the connection. -`server_address` | The server address for the connection. -`server_port` | The port used by the server. `ouath` | (Boolean) Specifies whether OAuth is used for the data source of workbook connection. For more information, see [OAuth Connections](https://help.tableau.com/current/server/en-us/protected_auth.htm). @@ -562,7 +560,7 @@ None. A list of `ConnectionItem` objects are added to the data source (`datasour #### datasources.publish ```py -datasources.publish(datasource_item, file_path, mode, connection_credentials=None) +datasources.publish(datasource_item, file, mode, connection_credentials=None, as_job=False) ``` Publishes a data source to a server, or appends data to an existing data source. @@ -576,9 +574,10 @@ REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en- Name | Description :--- | :--- `datasource_item` | The `datasource_item` specifies the new data source you are adding, or the data source you are appending to. If you are adding a new data source, you need to create a new `datasource_item` with a `project_id` of an existing project. The name of the data source will be the name of the file, unless you also specify a name for the new data source when you create the instance. See [DatasourceItem](#datasourceitem-class). -`file_path` | The path and name of the data source to publish. +`file` | The file path or file object of the data source to publish. `mode` | Specifies whether you are publishing a new data source (`CreateNew`), overwriting an existing data source (`Overwrite`), or appending data to a data source (`Append`). If you are appending to a data source, the data source on the server and the data source you are publishing must be be extracts (.tde files) and they must share the same schema. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. `connection_credentials` | (Optional) The credentials required to connect to the data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). +`as_job` | (Optional) If this value is set to `True`, the publish operation will be asynchronous and return a JobItem. @@ -2655,7 +2654,7 @@ Source file: models/schedule_item.py Name | Description :--- | :--- `name` | The `name` of the schedule. -`id` | The identifier for the schedule. Use the `schedules.get()` method to get the identifiers of the schedules on the server. +`priority` | The priority of the schedule (integer). Lower values represent higher priorities, with `0` indicating the highest priority. `schedule_type` | The type of task. The types are either an `Extract` for an extract refresh task or a `Subscription` for a scheduled subscription. `execution_order` | Specifies how the scheduled task should run. The choices are `Parallel`which uses all available background processes for this scheduled task, or `Serial`, which limits this schedule to one background process. `interval_item` | Specifies the frequency that the scheduled task should run. The `interval_item` is an instance of the `IntervalItem` class. The `interval_item` has properties for frequency (hourly, daily, weekly, monthly), and what time and date the scheduled item runs. You set this value by declaring an `IntervalItem` object that is one of the following: `HourlyInterval`, `DailyInterval`, `WeeklyInterval`, or `MonthlyInterval`. @@ -2683,10 +2682,59 @@ The schedule methods are based upon the endpoints for schedules in the REST API Source files: server/endpoint/schedules_endpoint.py -#### schedule.create +#### schedules.add_to_schedule + +```py +schedules.add_to_schedule(schedule_id, workbook=None, datasource=None, flow=None, task_type=None) +``` + +Adds a `DatasourceItem`, `FlowItem`, or `WorkbookItem` to a schedule. + + +REST API: [Add Data Source to Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#add_data_source_to_schedule) + + + +**Parameters** + +Name | Description +:--- | :--- +`schedule_id` | The identifier (id) of the schedule to add the data source or workbook to. Can be retrieved from a `ScheduleItem`, e.g., by performing `schedules.get()`. +`workbook` | (Optional) A `WorkbookItem` that should be added to the schedule. Only provide either `workbook` or `datasource`, passing multiple items will be deprecated. +`datasource` | (Optional) A `DatasourceItem` that should be added to the schedule. Only provide either `workbook` or `datasource`, passing multiple items will be deprecated. +`flow` | (Optional) A `FlowItem` that should be added to the schedule. Only applicable if `workbook = None` and `datasource = None`. +`task_type` | (Optional) Determines the type of task. One of `TaskItem.Type`: `ExtractRefresh`, `DataAcceleration`, `RunFlow`. + + +**Returns** +Returns a List of `AddResponses`. + + +**Example** + +```py +import tableauserverclient as TSC +# sign in, etc. +# get a datasource item that should be added to a schedule +datasource_item = server.datasources.get("d14dd951-01c1-4879-8bc2-e96d7dec9f0") + +# retrieve the id of the target schedule +schedule_id = schedule_item.id # can be a freshly created schedule or one queried via `schedules.get()` + +# Add the data source to the schedule +server.schedules.add_to_schedule( + schedule_id=schedule_id, + datasource=datasource_item, +) +``` +
      +
      + + +#### schedules.create ```py -schedule.create(schedule_item) +schedules.create(schedule_item) ``` Creates a new schedule for an extract refresh or a subscription. @@ -2731,10 +2779,10 @@ import tableauserverclient as TSC
      -#### schedule.delete +#### schedules.delete ```py -schedule.delete(schedule_id) +schedules.delete(schedule_id) ``` Deletes an existing schedule for an extract refresh or a subscription. @@ -2762,10 +2810,10 @@ Error | Description `Schedule ID undefined` | The identifier is not a valid identifier for a schedule on the server. -#### schedule.get +#### schedules.get ```py -schedule.get([req_options=None]) +schedules.get([req_options=None]) ``` Returns all schedule items from the server. @@ -2781,7 +2829,7 @@ Name | Description :--- | :--- `req_options` | (Optional) Additional request options to send to the endpoint. -#### schedule.update +#### schedules.update

      @@ -5100,7 +5148,7 @@ Name | Description `workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). `file_path` | The path and name of the workbook to publish. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. -`connections` | List of `ConnectionCredentials` objects for the connections created within the workbook. +`connections` | List of `ConnectionItems` objects for the connections created within the workbook. `connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). **Deprecated since API server version 2.3.** `skip_connection_check` | (Optional) Set to `True` to skip connection check at time of upload. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. Defaults to `False`. `as_job` | (Optional) Set to `True` to run the upload as a job (asynchronous upload). If set to `True` a job will start to perform the publishing process and a `Job` object is returned. Defaults to `False`. From 55d59f98e973815d284fa5c94c57632275654844 Mon Sep 17 00:00:00 2001 From: Karthika Raman Date: Thu, 17 Nov 2022 10:01:44 -0800 Subject: [PATCH 116/158] Changing Tableau Online to Tableau Cloud (branding) --- docs/api-ref.md | 34 +++++++++++++++++----------------- docs/getting-help.md | 2 +- docs/index.md | 2 +- docs/samples.md | 2 +- docs/sign-in-out.md | 14 +++++++------- 5 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index fa222170e..76f5807b1 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -10,12 +10,12 @@ layout: docs -The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Online resources programmatically. You can use this library to create your own custom applications. +The Tableau Server Client (TSC) is a Python library for the Tableau Server REST API. Using the TSC library, you can manage and change many of the Tableau Server and Tableau Cloud resources programmatically. You can use this library to create your own custom applications. The TSC API reference is organized by resource. The TSC library is modeled after the REST API. The methods, for example, `workbooks.get()`, correspond to the endpoints for resources, such as [workbooks](#workbooks), [users](#users), [views](#views), and [data sources](#data-sources). The model classes (for example, the [WorkbookItem class](#workbookitem-class) have attributes that represent the fields (`name`, `id`, `owner_id`) that are in the REST API request and response packages, or payloads. |:--- | -| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Online. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| +| **Note:** Some methods and features provided in the REST API might not be currently available in the TSC library (and in some cases, the opposite is true). In addition, the same limitations apply to the TSC library that apply to the REST API with respect to resources on Tableau Server and Tableau Clous. For more information, see the [Tableau Server REST API Reference](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm).| @@ -29,7 +29,7 @@ The TSC API reference is organized by resource. The TSC library is modeled after ## Authentication -You can use the TSC library to sign in and sign out of Tableau Server and Tableau Online. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API. +You can use the TSC library to sign in and sign out of Tableau Server and Tableau Cloud. The credentials for signing in are defined in the `TableauAuth` class and they correspond to the attributes you specify when you sign in using the Tableau Server REST API.

      @@ -50,7 +50,7 @@ Name | Description :--- | :--- `username` | The name of the user whose credentials will be used to sign in. `password` | The password of the user. -`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Cloud, you must provide a value for the `site_id`. `user_id_to_impersonate` | Specifies the id (not the name) of the user to sign in as. Source file: models/tableau_auth.py @@ -81,7 +81,7 @@ Name | Description :--- | :--- `token_name` | The personal access token name. `personal_access_token` | The personal access token value. -`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Online, you must provide a value for the `site_id`. +`site_id` | This corresponds to the `contentUrl` attribute in the Tableau REST API. The `site_id` is the portion of the URL that follows the `/site/` in the URL. For example, "MarketingTeam" is the `site_id` in the following URL *MyServer*/#/site/**MarketingTeam**/projects. To specify the default site on Tableau Server, you can use an empty string `''` (single quotes, no space). For Tableau Cloud, you must provide a value for the `site_id`. Source file: models/personal_access_token_auth.py @@ -118,7 +118,7 @@ auth.sign_in(auth_req) Signs you in to Tableau Server. -The method signs into Tableau Server or Tableau Online and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). +The method signs into Tableau Server or Tableau Cloud and manages the authentication token. You call this method from the server object you create. For information about the server object, see [Server](#server). The authentication token keeps you signed in for 240 minutes, or until you call the `auth.sign_out` method. Before you use this method, you first need to create the sign-in request (`auth_req`) object by creating an instance of the `TableauAuth`. To call this method, create a server object for your server. For more information, see [Sign in and Out](sign-in-out). REST API: [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#sign_in) @@ -174,7 +174,7 @@ auth.switch_site(site_id) Switch to a different site on the current Tableau Server. -Switching avoids the need for reauthenticating to the same server. (Note: This method is not available in Tableau Online.) +Switching avoids the need for reauthenticating to the same server. (Note: This method is not available in Tableau Cloud.) REST API: [Switch Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#switch_site) @@ -304,7 +304,7 @@ Name | Description `project_name` | The name of the project associated with the data source. `tags` | The tags (list of strings) that have been added to the data source. `updated_at` | The date and time when the data source was last updated. -`use_remote_query_agent` | A Boolean value that indicates whether to allow or disallow your Tableau Online site to use Tableau Bridge clients. Bridge allows you to maintain data sources with live connections to supported on-premises data sources. See [Configure and Manage the Bridge Client Pool](https://help.tableau.com/current/online/en-us/to_enable_bridge_live_connections.htm) for more information. +`use_remote_query_agent` | A Boolean value that indicates whether to allow or disallow your Tableau Cloud site to use Tableau Bridge clients. Bridge allows you to maintain data sources with live connections to supported on-premises data sources. See [Configure and Manage the Bridge Client Pool](https://help.tableau.com/current/online/en-us/to_enable_bridge_live_connections.htm) for more information. `webpage_url` | The url of the datasource as displayed in browsers. @@ -2924,7 +2924,7 @@ The `Server` class contains the attributes that represent the server on Tableau Attribute | Description :--- | :--- -`server_address` | Specifies the address of the Tableau Server or Tableau Online (for example, `https://MY-SERVER/`). +`server_address` | Specifies the address of the Tableau Server or Tableau Cloud (for example, `https://MY-SERVER/`). `version` | Specifies the version of the REST API to use (for example, `'2.5'`). When you use the TSC library to call methods that access Tableau Server, the `version` is passed to the endpoint as part of the URI (`https://MY-SERVER/api/2.5/`). Each release of Tableau Server supports specific versions of the REST API. New versions of the REST API are released with Tableau Server. By default, the value of `version` is set to `'2.3'`, which corresponds to Tableau Server 10.0. You can view or set this value. You might need to set this to a different value, for example, if you want to access features that are supported by the server and a later version of the REST API. For more information, see [REST API Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). @@ -3022,7 +3022,7 @@ The `ServerInfoItem` class contains the build and version information for Tablea Name | Description :--- | :--- -`product_version` | Shows the version of the Tableau Server or Tableau Online (for example, 10.2.0). +`product_version` | Shows the version of the Tableau Server or Tableau Cloud (for example, 10.2.0). `build_number` | Shows the specific build number (for example, 10200.17.0329.1446). `rest_api_version` | Shows the supported REST API version number. Note that this might be different from the default value specified for the server, with the `Server.version` attribute. To take advantage of new features, you should query the server and set the `Server.version` to match the supported REST API version number. @@ -3088,7 +3088,7 @@ print("\tBuild number: {0}".format(s_info.build_number)) Using the TSC library, you can query a site or sites on a server, or create or delete a site on the server. -The site resources for Tableau Server and Tableau Online are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class. +The site resources for Tableau Server and Tableau Cloud are defined in the `SiteItem` class. The class corresponds to the site resources you can access using the Tableau Server REST API. The site methods are based upon the endpoints for sites in the REST API and operate on the `SiteItem` class.

      @@ -3100,7 +3100,7 @@ SiteItem(name, content_url, admin_mode=None, user_quota=None, storage_quota=None disable_subscriptions=False, subscribe_others_enabled=True, revision_history_enabled=False) ``` -The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Online. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Online. The class members correspond to the attributes of a server request or response payload. +The `SiteItem` class contains the members or attributes for the site resources on Tableau Server or Tableau Cloud. The `SiteItem` class defines the information you can request or query from Tableau Server or Tableau Cloud. The class members correspond to the attributes of a server request or response payload. **Attributes** @@ -3136,7 +3136,7 @@ Source file: models/site_item.py ### Site methods -The TSC library provides methods that operate on sites for Tableau Server and Tableau Online. These methods correspond to endpoints or methods for sites in the Tableau REST API. +The TSC library provides methods that operate on sites for Tableau Server and Tableau Cloud. These methods correspond to endpoints or methods for sites in the Tableau REST API. Source file: server/endpoint/sites_endpoint.py @@ -3983,9 +3983,9 @@ The `UserItem` class contains the members or attributes for the view resources o Name | Description :--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Online. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Online -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Cloud -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. `domain_name` | The name of the site. -`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Online. For other server configurations, this field contains null. +`external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Cloud. For other server configurations, this field contains null. `id` | The id of the user on the site. `last_login` | The date and time the user last logged in. `workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. @@ -4046,7 +4046,7 @@ users.add(user_item) Adds the user to the site. -To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Online, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Online, the name of the user must be the email address that is used to sign in to Tableau Online. After you add a user, Tableau Online sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. +To add a new user to the site you need to first create a new `user_item` (from `UserItem` class). When you create a new user, you specify the name of the user and their site role. For Tableau Cloud, you also specify the `auth_setting` attribute in your request. When you add user to Tableau Cloud, the name of the user must be the email address that is used to sign in to Tableau Cloud. After you add a user, Tableau Cloud sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. REST API: [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_site) @@ -4344,7 +4344,7 @@ users.update(user_item, password=None) Updates information about the specified user. -The information you can modify depends upon whether you are using Tableau Server or Tableau Online, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). +The information you can modify depends upon whether you are using Tableau Server or Tableau Cloud, and whether you have configured Tableau Server to use local authentication or Active Directory. For more information, see [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_user). diff --git a/docs/getting-help.md b/docs/getting-help.md index aeae3c3fb..622d112e5 100644 --- a/docs/getting-help.md +++ b/docs/getting-help.md @@ -11,7 +11,7 @@ As a first step, please search existing issues to see if your problem or bug is If not, go ahead and create a new issue and include the following: -* Tableau Server version (or indicate if using Tableau Online) +* Tableau Server version (or indicate if using Tableau Cloud) * TSC library version * Python version * Environment (Mac, Win, Linux) diff --git a/docs/index.md b/docs/index.md index d9f0178fc..8e8fbffd2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -87,7 +87,7 @@ with server.auth.sign_in(tableau_auth): print([datasource.name for datasource in all_datasources]) ``` -`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Online, an example would be: `https://10ax.online.tableau.com/`. +`SERVER_URL` is the URL of your Tableau server without subpaths. For local Tableau servers, an example would be: `https://www.MY_SERVER.com`. For Tableau Cloud, an example would be: `https://10ax.online.tableau.com/`. `SITENAME` is the subpath of your full site URL (also called `contentURL` in the REST API). `MYSITE` would be the site name of `https://10ax.online.tableau.com/MYSITE`. This parameter can be omitted when signing in to the Default site of a on premise Tableau server. diff --git a/docs/samples.md b/docs/samples.md index ef3b262ae..377f8b3bf 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -66,4 +66,4 @@ The following list describes the samples available in the repository: * `update_connection.py` Updates and embeds connection credentials of a datasource. * `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource. -**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Online. +**Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Cloud. diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 46c09dae7..79814051e 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -3,7 +3,7 @@ title: Sign In and Out layout: docs --- -The first step to using the TSC library is to sign in to your Tableau Server (or Tableau Online). This page explains how to sign in, sign out, and switch sites, with examples for both Tableau Server and Tableau Online. +The first step to using the TSC library is to sign in to your Tableau Server (or Tableau Cloud). This page explains how to sign in, sign out, and switch sites, with examples for both Tableau Server and Tableau Cloud. * TOC {:toc} @@ -21,7 +21,7 @@ Examples showing both of these cases are included below. ### Sign in with Personal Access Token -To sign in to Tableau Server or Tableau Online with a personal access token, you'll need the following values: +To sign in to Tableau Server or Tableau Cloud with a personal access token, you'll need the following values: Name | Description :--- | :--- @@ -30,9 +30,9 @@ TOKEN_VALUE | The personal access token value (from the My Account settings page **Tableau Server** | SITENAME | The Tableau Server site you are authenticating with. For example in the site URL http://MyServer/#/site/MarketingTeam/projects, the site name is MarketingTeam. In the REST API documentation, this field is also referred to as contentUrl. This value can be omitted to connect with the Default site on the server. SERVER_URL | The Tableau Server you are authenticating with. If your server has SSL enabled, this should be an HTTPS link. -**Tableau Online** | -SITENAME | The Tableau Online site you are authenticating with. For example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664. In the REST API documentation, this field is also referred to as contentUrl. This value is always required when connecting to Tableau Online. -SERVER_URL | The Tableau Online instance you are authenticating with. In the example above the server URL would be https://10ay.online.tableau.com. This will always be an an HTTPS link. +**Tableau Cloud** | +SITENAME | The Tableau Cloud site you are authenticating with. For example in the site URL https://10ay.online.tableau.com/#/site/umbrellacorp816664/workbooks, the site name is umbrellacorp816664. In the REST API documentation, this field is also referred to as contentUrl. This value is always required when connecting to Tableau Cloud. +SERVER_URL | The Tableau Cloud instance you are authenticating with. In the example above the server URL would be https://10ay.online.tableau.com. This will always be an an HTTPS link. This example illustrates using the above values to sign in with a personal access token, do some operations, and then sign out: @@ -50,7 +50,7 @@ server.auth.sign_out() ### Sign in with Username and Password -To sign in to Tableau Server or Tableau Online with a username and password, you'll need the following values: +To sign in to Tableau Server or Tableau Cloud with a username and password, you'll need the following values: Name | Description :--- | :--- @@ -151,7 +151,7 @@ All of the samples provided in TSC library use this technique. Tableau Server has a feature which enables switching to another site without having to authenticate again. (The user must have access permissions for the new site as well.) -**Note:** This method is not available on Tableau Online. +**Note:** This method is not available on Tableau Cloud. The following example will switch the authenticated user to the NEW_SITENAME site on the same server: From d87cdb19eaec1eb55ad35049e6f766a98a6b7107 Mon Sep 17 00:00:00 2001 From: Karthika Raman Date: Tue, 20 Dec 2022 11:35:16 -0800 Subject: [PATCH 117/158] fixing project permissions --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 76f5807b1..e6b6a2d8e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2025,7 +2025,7 @@ Name | Description projects.update_permission(item, rules) ``` -Add or update project permissions. +Add project permissions for a user or group. REST API: [Add Project Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#add_project_permissions){:target="_blank"} From 750c0d06e3b625a5bbed879355bf630abda3ec50 Mon Sep 17 00:00:00 2001 From: Karthika Raman Date: Tue, 20 Dec 2022 11:57:02 -0800 Subject: [PATCH 118/158] fixing issue 970 --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index e6b6a2d8e..2b021db8c 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -647,7 +647,7 @@ Error | Description **Returns** -A refreshed `DatasourceItem`. +A refreshed `JobItem`. **Example** From 856697c1542c8ea50cffe05d7e3b21ea2646faf5 Mon Sep 17 00:00:00 2001 From: Karthika Raman Date: Tue, 20 Dec 2022 12:07:48 -0800 Subject: [PATCH 119/158] Fixing issue 691 --- docs/filter-sort.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 81d102c0e..1ac391ab1 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -35,6 +35,8 @@ API help](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_conc To filter on a field, you need to specify the field name, an operator criteria and a value criteria. +**Note**: Ampersands and commas in filters are not supported by the rest api as they are used as delimiters. + ### Operator criteria The operator that you want to use for that field. For example, you can use the Equals operator to get everything from the endpoint that matches exactly. From 7954b5c641ee4fb2a75a47b7a2ffe20eda37d8d1 Mon Sep 17 00:00:00 2001 From: Karthika Raman Date: Thu, 22 Dec 2022 08:44:15 -0800 Subject: [PATCH 120/158] fixing capitalization issue --- docs/filter-sort.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 1ac391ab1..8c94285f2 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -35,7 +35,7 @@ API help](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_conc To filter on a field, you need to specify the field name, an operator criteria and a value criteria. -**Note**: Ampersands and commas in filters are not supported by the rest api as they are used as delimiters. +**Note**: Ampersands and commas in filters are not supported by the REST API as they are used as delimiters. ### Operator criteria From 0cda22048746e4e5d9adcf1195c38d9f8aeebb1b Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 22 Dec 2022 16:33:49 -0800 Subject: [PATCH 121/158] Improve docs and short examples around Schedules support (#1161) Fixes #1152 We also have #755 to review and potentially add more around Schedules --- docs/api-ref.md | 139 +++++++++++++++++++++++++++++++++--------------- 1 file changed, 95 insertions(+), 44 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2b021db8c..2b701f80a 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2747,7 +2747,7 @@ REST API: [Create Schedule](https://help.tableau.com/current/api/rest_api/en-us/ Name | Description :--- | :--- -`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `schedule_item` and pass it to the `create` method. The `schedule_item` includes the `interval_item` which specifies the frequency, or interval, that the schedule should run. See `ScheduleItem` and `IntervalItem`. +`schedule_item` | The settings for the schedule that you want to create. You need to create an instance of `ScheduleItem` and pass it to the `create` method. The `ScheduleItem` includes the `IntervalItem` which specifies the frequency, or interval, that the schedule should run. **Returns** @@ -2765,15 +2765,21 @@ Error | Description ```py import tableauserverclient as TSC +from datetime import time + # sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) +# Create an interval to run every 2 hours between 2:30AM and 11:00PM +hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) +# Create schedule item +hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", + 50, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Parallel, + hourly_interval) +# Create schedule +hourly_schedule = server.schedules.create(hourly_schedule) ```

      @@ -2813,7 +2819,7 @@ Error | Description #### schedules.get ```py -schedules.get([req_options=None]) +schedules.get() ``` Returns all schedule items from the server. @@ -2822,6 +2828,18 @@ Returns all schedule items from the server. REST API: [Query Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_schedules) +#### schedules.get_by_id + +```py +schedules.get_by_id(schedule_id) +``` + +Returns the specified schedule. + + +REST API: [Get Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#get-schedule) + + **Parameters** @@ -2831,6 +2849,19 @@ Name | Description #### schedules.update +```py +schedules.update(schedule_item) +``` + +**Parameters** + +Name | Description +:--- | :--- +`schedule_item` | The settings for the schedule that you want to update. You need to fetch an existing instance of `ScheduleItem` from the `get` method, make your changes, and then pass it to the `update` method to update the schedule on the server. The `ScheduleItem` includes the `IntervalItem` which specifies the frequency, or interval, that the schedule should run. + + +REST API: [Update Schedules](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_schedule) +

      @@ -2838,61 +2869,81 @@ Name | Description **Hourly schedule example** ```py import tableauserverclient as TSC +from datetime import time # sign in, etc. - # Create an interval to run every 2 hours between 2:30AM and 11:00PM - hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), - end_time=time(23, 0), - interval_value=2) - # Create schedule item - hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", 50, TSC.ScheduleItem.Type.Extract, TSC.ScheduleItem.ExecutionOrder.Parallel, hourly_interval) - # Create schedule - hourly_schedule = server.schedules.create(hourly_schedule) + +# Create an interval to run every 2 hours between 2:30AM and 11:00PM +hourly_interval = TSC.HourlyInterval(start_time=time(2, 30), + end_time=time(23, 0), + interval_value=2) + +# Create schedule item +hourly_schedule = TSC.ScheduleItem("Hourly-Schedule", + 50, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Parallel, + hourly_interval) + +# Create schedule +hourly_schedule = server.schedules.create(hourly_schedule) ``` **Daily schedule example** ```py import tableauserverclient as TSC +from datetime import time # sign in, etc. - # Create a daily interval to run every day at 12:30AM - Daily_interval = TSC.DailyInterval(start_time=time(0, 30)) - # Create schedule item using daily interval - daily_schedule = TSC.ScheduleItem("Daily-Schedule", 60, TSC.ScheduleItem.Type.Subscription, TSC.ScheduleItem.ExecutionOrder.Serial, daily_interval) - # Create daily schedule - daily_schedule = server.schedules.create(daily_schedule) +# Create a daily interval to run every day at 12:30AM +daily_interval = TSC.DailyInterval(start_time=time(0, 30)) + +# Create schedule item using daily interval +daily_schedule = TSC.ScheduleItem("Daily-Schedule", + 60, + TSC.ScheduleItem.Type.Subscription, + TSC.ScheduleItem.ExecutionOrder.Serial, + daily_interval) + +# Create daily schedule +daily_schedule = server.schedules.create(daily_schedule) ``` **Weekly schedule example** ```py import tableauserverclient as TSC +from datetime import time # sign in, etc. - # Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM - weekly_interval = TSC.WeeklyInterval(time(19, 15), - TSC.IntervalItem.Day.Monday, - TSC.IntervalItem.Day.Wednesday, - TSC.IntervalItem.Day.Friday) - # Create schedule item using weekly interval - weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, - TSC.ScheduleItem.Type.Extract, - TSC.ScheduleItem.ExecutionOrder.Serial, weekly_interval) - # Create weekly schedule - weekly_schedule = server.schedules.create(weekly_schedule) +# Create a weekly interval to run every Monday, Wednesday, and Friday at 7:15PM +weekly_interval = TSC.WeeklyInterval(time(19, 15), + TSC.IntervalItem.Day.Monday, + TSC.IntervalItem.Day.Wednesday, + TSC.IntervalItem.Day.Friday) +# Create schedule item using weekly interval +weekly_schedule = TSC.ScheduleItem("Weekly-Schedule", 70, + TSC.ScheduleItem.Type.Extract, + TSC.ScheduleItem.ExecutionOrder.Serial, + weekly_interval) +# Create weekly schedule +weekly_schedule = server.schedules.create(weekly_schedule) ``` **Monthly schedule example** ```py import tableauserverclient as TSC +from datetime import time # sign in, etc. - # Create a monthly interval to run on the 15th of every month at 11:30PM - monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), - interval_value=15) - # Create schedule item using monthly interval - monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", 80, - TSC.ScheduleItem.Type.Subscription - TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) - # Create monthly schedule - monthly_schedule = server.schedules.create(monthly_schedule) + +# Create a monthly interval to run on the 15th of every month at 11:30PM +monthly_interval = TSC.MonthlyInterval(start_time=time(23, 30), + interval_value=15) +# Create schedule item using monthly interval +monthly_schedule = TSC.ScheduleItem("Monthly-Schedule", + 80, + TSC.ScheduleItem.Type.Subscription + TSC.ScheduleItem.ExecutionOrder.Parallel, monthly_interval) +# Create monthly schedule +monthly_schedule = server.schedules.create(monthly_schedule) ``` From ce18d2468e8f592af1fca866ce2464e532435d23 Mon Sep 17 00:00:00 2001 From: Karthika <72409920+kramantab@users.noreply.github.com> Date: Fri, 6 Jan 2023 15:39:36 -0800 Subject: [PATCH 122/158] Issue 1128, add excel request option to the requests category (#1164) --- docs/api-ref.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2b701f80a..92aeec3c9 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2548,6 +2548,34 @@ csv_req_option.vf('Category', 'Furniture') # retrieve the csv data for the view server.views.populate_csv(view_item, csv_req_option) ``` +### ExcelRequestOptions class + +```py +ExcelRequestOptions(maxage=-1) +``` +Use this class to specify view filters to be applied when data is generated in an Excel file format. Optionally, you can specify the maximum age of the Excel data cached on the server by providing a `maxage` value. See `views.populate_csv`. + +**Attributes** + +Name | Description +:--- | :--- +`maxage` | Optional. The maximum number of minutes the Excel data will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. + +**Example** + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +excel_req_option = TSC.ExcelRequestOptions(maxage=5) +excel_req_option.vf('Region', 'South') +excel_req_option.vf('Category', 'Furniture') + +# retrieve the excel data for the view +server.views.populate_excel(view_item, excel_req_option) +``` ### ImageRequestOptions class From 94e2b0c23536b8270063571e9a95364b4e914ef1 Mon Sep 17 00:00:00 2001 From: Jac Date: Tue, 14 Feb 2023 14:22:49 -0800 Subject: [PATCH 123/158] [docs] Add connection-credentials element to connection (#1177) Add connection-credentials element to connection Addressing part of https://github.com/tableau/server-client-python/issues/1139#issuecomment-1379162364 --- docs/api-ref.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 92aeec3c9..e98bc742b 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -227,11 +227,12 @@ Name | Description `datasource_name` | The name of the data source. `id` | The identifier of the connection. `connection_type` | The type of connection. -`username` | The username for the connection. -`password` | The password used for the connection. -`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). +`username` | The username for the connection. (see ConnectionCredentials) +`password` | The password used for the connection. (see ConnectionCredentials) +`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`). (see ConnectionCredentials) `server_address` | The server address for the connection. `server_port` | The port used for the connection. +`connection_credentials` | The Connection Credentials object containing authentication details for the connection. Replaces username/password/embed_password when publishing a flow, document or workbook file in the request body. Source file: models/connection_item.py From 3730f7c2371e534cefcc8b315b0802bc18697539 Mon Sep 17 00:00:00 2001 From: Karthika <72409920+kramantab@users.noreply.github.com> Date: Tue, 14 Feb 2023 20:17:41 -0800 Subject: [PATCH 124/158] [docs] Updates to API reference content (#1188) * Multiple updates --- docs/api-ref.md | 46 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index e98bc742b..bb92f6a21 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1416,6 +1416,45 @@ Returns the `JobItem` requested.

      +#### jobs.cancel + +```py +jobs.cancel(job_id) +``` + +Cancels the currently running job. Can be used to cancel currently running jobs like extract refreshes. + +**Parameters** + +Name | Description +:----|:---- +`job_id` | The `job_id` specifies the id of the job that we want to cancel. It is the id of the job that is retunred from an asynchronous taks, such as extract refresh, run a flow, or import or update to groups using Active Directory. + +**Exceptions** + +Error | Description +:----|:---- +404 Resource Not Found | Raises an error if the `job_id` is not found. + +**Returns** Returns the details of the canceled job including the URL of the site where the job was created. + +**Example** +```py +# Query a Job + +# import tableauserverclient as TSC +# tableau_auth = TSC.TableauAuth('USERNAME', 'PASSWORD') +# server = TSC.Server('https://SERVERURL') + + with server.auth.sign_in(tableau_auth): + + # get the id of the job from response from the query job method. + # in this example, "576b781d-331c-4539-b61d-1ed0eb9db548" + cancelJobId = '576b781d-331c-4539-b61d-1ed0eb9db548' + jobs.cancel (cancelJobId) + +``` + #### jobs.wait_for_job @@ -3189,7 +3228,8 @@ Attribute | Description `name` | The name of the site. The name of the default site is "". `content_url` | The path to the site. `admin_mode` | (Optional) For Tableau Server only. Specify `ContentAndUsers` to allow site administrators to use the server interface and **tabcmd** commands to add and remove users. (Specifying this option does not give site administrators permissions to manage users using the REST API.) Specify `ContentOnly` to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) -`user_quota`| (Optional) Specifies the maximum number of users for the site. If you do not specify this value, the limit depends on the type of licensing configured for the server. For user-based license, the maximum number of users is set by the license. For core-based licensing, there is no limit to the number of users. If you specify a maximum value, only licensed users are counted and server administrators are excluded. Mutually exclusive with tiered license level settings. +`user_quota`| (Optional) Specifies the total number of users for the site. The number can't exceed the number of licenses activated for the site; and if tiered capacity attributes are set, then `user_quota` will equal the sum of the tiered capacity values, and attempting to set `user_quota` will cause an error. +Tiered capacity attributes: `tier_explorer_capacity` `tier_creator_capacity` `tier_viewer_capacity`| (Optional) The maximum number of licenses for users with the Creator, Explorer, or Viewer role, respectively, allowed on a site. `storage_quota` | (Optional) Specifies the maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again. `disable_subscriptions` | (Optional) Specify `true` to prevent users from being able to subscribe to workbooks on the specified site. The default is `false`. `subscribe_others_enabled` | (Optional) Specify `false` to prevent server administrators, site administrators, and project or content owners from being able to subscribe other users to workbooks on the specified site. The default is `true`. @@ -4242,7 +4282,6 @@ The `UserItem`. See [UserItem class](#useritem-class) ```
      -
      #### users.populate_favorites @@ -5069,6 +5108,7 @@ Name | Description `project_name` | The name of the project. `size` | The size of the workbook (in megabytes). `show_tabs` | (Boolean) Determines whether the workbook shows tabs for the view. +`hidden_views` | (Optional) List of string names of views that need to be hidden when the workbook is published. `tags` | The tags that have been added to the workbook. `updated_at` | The date and time when the workbook was last updated. `views` | The list of views (`ViewItem`) for the workbook. You must first call the [workbooks.populate_views](#workbooks.populate_views) method to access this data. See the [ViewItem class](#viewitem-class). @@ -5226,7 +5266,7 @@ REST API: [Publish Workbook](https://help.tableau.com/current/api/rest_api/en-us Name | Description :--- | :--- `workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class). -`file_path` | The path and name of the workbook to publish. +`file` | The file path or file object of the workbook to publish. When providing a file object, you must also specifiy the name of the workbook in your instance of the `workbook_item``workbook_item` , as the name cannot be derived from the file name. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. `connections` | List of `ConnectionItems` objects for the connections created within the workbook. `connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). **Deprecated since API server version 2.3.** From 1372534cb797e12f887c59ee3bbcea0e2c41d84a Mon Sep 17 00:00:00 2001 From: Oleksii Levchyk Date: Wed, 12 Apr 2023 10:58:50 +0200 Subject: [PATCH 125/158] =?UTF-8?q?gh-pages-update-doc=20workbooks=20attri?= =?UTF-8?q?bute=20mention=20about=20read=20workbooks=20=E2=80=A6=20(#1208)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit gh-pages-update-doc workbooks attribute mention about read workbooks too. --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index bb92f6a21..2a02bbae3 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4108,7 +4108,7 @@ Name | Description `external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Cloud. For other server configurations, this field contains null. `id` | The id of the user on the site. `last_login` | The date and time the user last logged in. -`workbooks` | The workbooks the user owns. You must run the populate_workbooks method to add the workbooks to the `UserItem`. +`workbooks` | The workbooks the user owns or has Read (view) permissions. You must run the populate_workbooks method to add the workbooks to the `UserItem`. `email` | The email address of the user. `fullname` | The full name of the user. `name` | The name of the user. This attribute is required when you are creating a `UserItem` instance. From 3193055eba7a38d1658d9f9762f6f16462ec09f0 Mon Sep 17 00:00:00 2001 From: Jac Date: Fri, 9 Jun 2023 09:06:09 -0700 Subject: [PATCH 126/158] Update api-ref.md (#1218) --- docs/api-ref.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2a02bbae3..2bc3be969 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4103,7 +4103,7 @@ The `UserItem` class contains the members or attributes for the view resources o Name | Description :--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user. You can assign the following values for this attribute: `SAML` (the user signs in using SAML) or `ServerDefault` (the user signs in using the authentication method that's set for the server). These values appear in the **Authentication** tab on the **Settings** page in Tableau Cloud -- the `SAML` attribute value corresponds to **Single sign-on**, and the `ServerDefault` value corresponds to **TableauID**. +`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user - see **User Auth** below for values. `domain_name` | The name of the site. `external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Cloud. For other server configurations, this field contains null. `id` | The id of the user on the site. @@ -4115,6 +4115,15 @@ Name | Description `site_role` | The role the user has on the site. This attribute is required if you are creating a `UserItem` instance. See *User Roles* below for details. `groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`. +**User Auth** + + You can assign the following values for this attribute: +* `OpenID` +* `SAML` (the user signs in using **Single sign-on**) +* `ServerDefault` (the user signs in using the default authentication method for the server - in Tableau Cloud this is **TableauID**) +* `TableauIDWithMFA` + These options appear in the **Authentication** tab on the **Settings** page in Tableau Cloud. + **User Roles** The possible user roles for the `site_role` attribute are the following: From babf3809a6e8169401e71ea43228467b7d5844d7 Mon Sep 17 00:00:00 2001 From: Yasuhisa Yoshida Date: Mon, 24 Jul 2023 15:11:18 +0900 Subject: [PATCH 127/158] Add docs for LockedToProjectWithoutNested (#1245) --- docs/api-ref.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 2bc3be969..bdd9a9351 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1788,7 +1788,7 @@ The project resources for Tableau are defined in the `ProjectItem` class. The cl Name | Description :--- | :--- -`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject` or `ManagedByOwner`. +`content_permissions` | Sets or shows the permissions for the content in the project. The options are either `LockedToProject`, `ManagedByOwner` or `LockedToProjectWithoutNested`. `name` | Name of the project. `description` | The description of the project. `id` | The project id. @@ -1801,12 +1801,13 @@ Source file: models/project_item.py #### ProjectItem.ContentPermissions -The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject` and `ManagedByOwner`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). +The `ProjectItem` class has a sub-class that defines the permissions for the project (`ProjectItem.ContentPermissions`). The options are `LockedToProject`, `ManagedByOwner` and `LockedToProjectWithoutNested`. For information on these content permissions, see [Lock Content Permissions to the Project](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_project). Name | Description :--- | :--- `ProjectItem.ContentPermissions.LockedToProject` | Locks all content permissions to the project. `ProjectItem.ContentPermissions.ManagedByOwner` | Users can manage permissions for content that they own. This is the default. +`ProjectItem.ContentPermissions.LockedToProjectWithoutNested` | Lock the permissions of a parent project, but not those of its child projects. **Example** From 80934fbcc5d9097ede3433a6c6437e5eb3fa9c72 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Mon, 31 Jul 2023 13:51:11 -0700 Subject: [PATCH 128/158] Catch up versions table through 2023.2 --- docs/versions.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/versions.md b/docs/versions.md index e6cced389..096b13cfc 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -23,7 +23,7 @@ server = TSC.Server('http://SERVER_URL') print(server.version) ``` -For example, the code might display version `3.10`. +For example, the code might display version `3.17`. ## Use the REST API version supported by the server @@ -56,7 +56,7 @@ To use a specific version of the REST API, set the version like so: import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL') -server.version = '3.6' +server.version = '3.17' ``` @@ -66,6 +66,10 @@ The current version of TSC only supports the following REST API and Tableau Serv |REST API version|Tableau Server version| |---|---| +|3.20|2023.2| +|3.19|2023.1| +|3.18|2022.4| +|3.17|2022.3| |3.16|2022.2| |3.15|2022.1| |3.14|2021.4| @@ -90,4 +94,4 @@ The current version of TSC only supports the following REST API and Tableau Serv |2.4|10.1| |2.3|10.0| -Note that Tableau provides support and security updates for each version of the product for thirty (30) months after release. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details. +Note that Tableau provides support and security updates for each version of the product for a specific period of time. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details. From 7ba0b2141933cd31a69cd0cd237749f5001cc262 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 3 Aug 2023 15:14:56 -0700 Subject: [PATCH 129/158] Update samples to make it clear that TSC needs to be installed Should help with issues like #1268 --- docs/samples.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/samples.md b/docs/samples.md index 377f8b3bf..85d306216 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -8,6 +8,10 @@ The TSC samples are included in the `samples` directory of the TSC repository [o * TOC {:toc} +## Prerequisites + +Before running any of the sample scripts, install the TSC library in your Python environment following the [Get Started](https://tableau.github.io/server-client-python/docs/) instructions. + ## Run the samples Each of the samples accepts the following arguments: From ad6bcac00fefb94e9769be0c12060c266d73583f Mon Sep 17 00:00:00 2001 From: Jac Fitzgerald Date: Wed, 4 Oct 2023 00:31:59 -0700 Subject: [PATCH 130/158] Add docs for JWT and impersonation --- docs/sign-in-out.md | 56 ++++++++++++++++++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 8 deletions(-) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index 79814051e..d2aa04bc5 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -10,17 +10,16 @@ The first step to using the TSC library is to sign in to your Tableau Server (or ## Sign In -Signing in can be done two different ways: +Signing in through tsc and the REST API can be done several different ways - in most cases only some of these options will be available, depending on your server configuration. You can see details of all the underlying APIs for authentication in the [REST API documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm). -* Personal Access Tokens - In most cases this is the preferred method because it improves security by avoiding the need to use or store passwords directly. Access tokens also expire by default if not used after 15 consecutive days. This option is available for Tableau Server 2019.4 and newer. Refer to [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) for more details. -* Username and Password - Direct sign in with account username and password. - -Examples showing both of these cases are included below. +Examples for all supported methods are included below. **Note:** When you sign in, the TSC library manages the authenticated session for you. However, the validity of the underlying credentials token is limited by the maximum session length set on your Tableau Server (2 hours by default). ### Sign in with Personal Access Token +In most cases this is the preferred method because it improves security by avoiding the need to use or store passwords directly. Access tokens also expire by default if not used after 15 consecutive days. This option is available for Tableau Server 2019.4 and newer. Refer to [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) for more details. + To sign in to Tableau Server or Tableau Cloud with a personal access token, you'll need the following values: Name | Description @@ -50,7 +49,10 @@ server.auth.sign_out() ### Sign in with Username and Password -To sign in to Tableau Server or Tableau Cloud with a username and password, you'll need the following values: + +Direct sign in with account username and password. (This is no longer allowed for Tableau Cloud) + +To sign in to Tableau Server with a username and password, you'll need the following values: Name | Description :--- | :--- @@ -73,7 +75,45 @@ server.auth.sign_in(tableau_auth) server.auth.sign_out() ``` -### Handling SSL certificates for Tableau Server +### Sign in with JSON Web Token (JWT) + +If you have Connected Apps enabled, you can create JSON Web Tokens and use them to authenticate over the REST API. To learn about Connected Apps, read the docs on [Tableau Connected Apps](https://help.tableau.com/current/server/en-us/security_auth.htm#connected-apps) + +To sign in to Tableau Server or Tableau Cloud with a JWT, you'll need to have created a Connected App and generated the token locally (see [instructions to generate a JWT for your Connected App](https://help.tableau.com/current/server/en-us/connected_apps.htm#step-3-configure-the-jwt)): + +class JWTAuth(Credentials): + def __init__(self, jwt=None, site_id=None, user_id_to_impersonate=None): +Name | Description +:--- | :--- +JWT | The generated token value +SITENAME | The same as described for personal access tokens +SERVER_URL | The same as described for personal access tokens + +This example illustrates using the above values to sign in with a JWT, do some operations, and then sign out: + +```py +import tableauserverclient as TSC + +tableau_auth = TSC.JWTAuth('JWT', 'SITENAME') +server = TSC.Server('https://SERVER_URL', use_server_version=True) +server.auth.sign_in(tableau_auth) + +# Do awesome things here! + +server.auth.sign_out() +``` + + +## Impersonation (Tableau Server only) +On Tableau Server, users with a Server Administrator role can sign in through the REST API and 'impersonate' another user - this may be to validate server permissions, to investigate user problems, or to perform actions on behalf of the user. This can be done in tsc with any type of authentication by adding an extra parameter (`user_id_to_impersonate`) to the TableauAuth object creation + +e.g +tableau_auth = TSC.PersonalAccessTokenAuth('TOKEN_NAME', 'TOKEN_VALUE', 'SITE_NAME', 'OTHER_USER_ID') +tableau_auth = TSC.JWTAuth('JWT_VALUE', 'SITE_NAME', 'OTHER_USER_ID') +tableau_auth = TSC.TSC.TableauAuth('USERNAME', 'PASSWORD', 'SITENAME') + + +## Handling SSL certificates for Tableau Server If you're connecting to a Tableau Server instance that uses self-signed or non-public SSL certificates, you may need to provide those as part of the sign in process. An example of this could be an on-premise Tableau Server that is using internally-generated SSL certificates. You may see an error like `SSL: CERTIFICATE_VERIFY_FAILED` if you connect with a Tableau Server but don't have the SSL certificates configured correctly. @@ -126,7 +166,7 @@ As shown in the examples above, the sign out call is simply: server.auth.sign_out() ``` -## Simplify by using Python with block +## Simplify by using Python `with` block The sign in/out flow can be simplified (and handled in a more Python way) by using the built-in support for the `with` block. After the block execution completes, the sign out is called automatically. From 97322485ed24949726cc6b230e91acc958e336e3 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Tue, 10 Oct 2023 12:23:00 -0700 Subject: [PATCH 131/158] Simplify the Versions page by just referring to the rest API versions table which is updated regularly --- docs/versions.md | 36 +++--------------------------------- 1 file changed, 3 insertions(+), 33 deletions(-) diff --git a/docs/versions.md b/docs/versions.md index 096b13cfc..f8e54e211 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -23,7 +23,7 @@ server = TSC.Server('http://SERVER_URL') print(server.version) ``` -For example, the code might display version `3.17`. +For example, the code might display version `3.20`. ## Use the REST API version supported by the server @@ -56,42 +56,12 @@ To use a specific version of the REST API, set the version like so: import tableauserverclient as TSC server = TSC.Server('http://SERVER_URL') -server.version = '3.17' +server.version = '3.20' ``` ## Supported versions -The current version of TSC only supports the following REST API and Tableau Server versions: - -|REST API version|Tableau Server version| -|---|---| -|3.20|2023.2| -|3.19|2023.1| -|3.18|2022.4| -|3.17|2022.3| -|3.16|2022.2| -|3.15|2022.1| -|3.14|2021.4| -|3.13|2021.3| -|3.12|2021.2| -|3.11|2021.1| -|3.10|2020.4| -|3.9|2020.3| -|3.8|2020.2| -|3.7|2020.1| -|3.6|2019.4| -|3.5|2019.3| -|3.4|2019.2| -|3.3|2019.1| -|3.2|2018.3| -|3.1|2018.2| -|3.0|2018.1| -|2.8|10.5| -|2.7|10.4| -|2.6|10.3| -|2.5|10.2| -|2.4|10.1| -|2.3|10.0| +The TSC library uses the same REST API versions as used in Tableau Server and Tableau Cloud. Refer to the [Tableau Server versions and REST API versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm#version_and_rest) table for an up-to-date mapping. Note that Tableau provides support and security updates for each version of the product for a specific period of time. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details. From 0d8a2322db204a329a62c8982107783246e595db Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Fri, 13 Oct 2023 17:26:03 -0700 Subject: [PATCH 132/158] Update dev guide to be more clear about installing dependencies and how to run tests --- docs/dev-guide.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 04133449a..2943e987b 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -30,12 +30,15 @@ add your contributions to the **development** branch. ```shell git clone git@github.com:/server-client-python.git + cd server-client-python ``` -1. Run the tests to make sure everything is passing: +1. Install dependencies and run the tests to make sure everything is passing: ```shell - python setup.py test + python -m pip install --upgrade pip + pip install -e .[test] build + pytest test ``` 1. Configure a remote that points to the source (upstream) repository: From bafccd4170b98e4561879f83a3efd03040999cfa Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Sun, 22 Oct 2023 12:06:49 -0700 Subject: [PATCH 133/158] Add Mypy on the checklist for creating a PR --- docs/dev-guide.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index 2943e987b..ffb2c6175 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -64,7 +64,7 @@ For documentation changes, see the documentation section below. ### Code and commit Here's a quick checklist to follow when coding to ensure a good pull request -(PR): +(PR) that will pass the PR checks: - Only touch the fewest number of files possible while still accomplishing the goal. @@ -74,6 +74,8 @@ Here's a quick checklist to follow when coding to ensure a good pull request `black --line-length 120 tableauserverclient samples test` to catch and fix any style issues before submitting your pull request. (Run black with the `--check` option if you want to check whether formatting is valid without changing any files.) +- Ensure the Mypy static type checker is still passing by running + `mypy --show-error-codes --disable-error-code misc --disable-error-code import tableauserverclient test`. - Keep commit messages clean and descriptive. ### Use git pre-commit hook From 4c1e4dfa644efd4297f989d7a797b121314f9d30 Mon Sep 17 00:00:00 2001 From: albertoCCz <61499152+albertoCCz@users.noreply.github.com> Date: Tue, 7 Nov 2023 19:39:16 +0100 Subject: [PATCH 134/158] Add missing '[' in external link. --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index bdd9a9351..0706c54d0 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -73,7 +73,7 @@ server.auth.sign_in(tableau_auth) ```py PersonalAccessTokenAuth(token_name, personal_access_token, site_id='') ``` -The `PersonalAccessTokenAuth` class serves the same purpose and is used in the same way as `TableauAuth`, but using Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) instead of username and password. +The `PersonalAccessTokenAuth` class serves the same purpose and is used in the same way as `TableauAuth`, but using [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) instead of username and password. **Attributes** From 58ae83f6abdf58eca6f57bebc83ba8537506dc7e Mon Sep 17 00:00:00 2001 From: Jac Date: Wed, 3 Jan 2024 21:09:02 -0800 Subject: [PATCH 135/158] Clarify that Tableau Support is available for this library users may work through github OR through Tableau Support with questions. --- index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/index.md b/index.md index c19b7f087..2a4a67c47 100644 --- a/index.md +++ b/index.md @@ -6,6 +6,7 @@ indexed_by_search: false

      Tableau Server Client (Python)

      The Tableau Server Client is a Python library for the Tableau Server REST API.

      +

      This library is fully supported by Tableau Support. Issues can be raised here on github for possibly quicker responses, and the ability to get help from other users - customers with access to Tableau Support can also choose to create a support case for assistance in troubleshooting the library and identifying bugs or gaps in the functionality for more guaranteed response times.


      Get Started   Download From f28de9c8e807a4a3c6f3833c21f93cb880f595bd Mon Sep 17 00:00:00 2001 From: Jac Date: Wed, 3 Jan 2024 21:13:04 -0800 Subject: [PATCH 136/158] Update getting-help.md --- docs/getting-help.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/getting-help.md b/docs/getting-help.md index 622d112e5..58258e757 100644 --- a/docs/getting-help.md +++ b/docs/getting-help.md @@ -3,7 +3,11 @@ title: Getting Help layout: docs --- -This project is using [GitHub issues](https://github.com/tableau/server-client-python/issues) for tracking help requests, bugs, and feature requests. +This project is using [GitHub issues](https://github.com/tableau/server-client-python/issues) for tracking help requests, bugs, and feature requests. This enables other users to help troubleshooting and sometimes to contribute fixes. + +It is also fully supported by Tableau Support. Customers with access to Tableau Support can choose to create a support case for assistance in troubleshooting the library and identifying bugs or gaps in the functionality for more guaranteed response times, and these will route internally through the company to the developers on the repo. If you have uncovered a bug blocking your work, it is recommended that you go through Tableau Support for increased visibility of your request. + + ## Filing an issue From e4005dbfcca5ca4db391709a1b517b148f2b29d8 Mon Sep 17 00:00:00 2001 From: Jac Date: Wed, 3 Jan 2024 21:14:24 -0800 Subject: [PATCH 137/158] Update index.md revert support description - wrong place --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index 2a4a67c47..53c3028fb 100644 --- a/index.md +++ b/index.md @@ -6,7 +6,7 @@ indexed_by_search: false

      Tableau Server Client (Python)

      The Tableau Server Client is a Python library for the Tableau Server REST API.

      -

      This library is fully supported by Tableau Support. Issues can be raised here on github for possibly quicker responses, and the ability to get help from other users - customers with access to Tableau Support can also choose to create a support case for assistance in troubleshooting the library and identifying bugs or gaps in the functionality for more guaranteed response times.

      +
      Get Started   Download From 62d5c22b469c889e1d8f3a6e1757eeae655747f7 Mon Sep 17 00:00:00 2001 From: smarvin Date: Thu, 22 Feb 2024 11:53:59 -0800 Subject: [PATCH 138/158] w-14026658: Updates for auth-setting auth_setting is now required for Tableau Cloud. ServerDefault is no longer a valid value. --- docs/api-ref.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 0706c54d0..a749f648e 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4104,7 +4104,7 @@ The `UserItem` class contains the members or attributes for the view resources o Name | Description :--- | :--- -`auth_setting` | (Optional) This attribute is only for Tableau Cloud. The new authentication type for the user - see **User Auth** below for values. +`auth_setting` | This is a required attribute and is only for Tableau Cloud. The new authentication type for the user - see **User Auth** below for values. `domain_name` | The name of the site. `external_auth_user_id` | Represents ID stored in Tableau's single sign-on (SSO) system. The `externalAuthUserId` value is returned for Tableau Cloud. For other server configurations, this field contains null. `id` | The id of the user on the site. @@ -4120,8 +4120,7 @@ Name | Description You can assign the following values for this attribute: * `OpenID` -* `SAML` (the user signs in using **Single sign-on**) -* `ServerDefault` (the user signs in using the default authentication method for the server - in Tableau Cloud this is **TableauID**) +* `SAML` (the user signs in using **Single sign-on**) * `TableauIDWithMFA` These options appear in the **Authentication** tab on the **Settings** page in Tableau Cloud. From 5c524a828069081217a83907d492700fc2e16d04 Mon Sep 17 00:00:00 2001 From: cam-sesco <99909925+cam-sesco@users.noreply.github.com> Date: Thu, 7 Mar 2024 08:09:01 -0500 Subject: [PATCH 139/158] fix typo in server.views.get_by_id example running current example gives: AttributeError: 'Server' object has no attribute 'view' --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index a749f648e..1fc23421b 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -4672,7 +4672,7 @@ tableau_auth = TSC.TableauAuth('username', 'password') server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): - view = server.view.get_by_id('d79634e1-6063-4ec9-95ff-50acbf609ff5') + view = server.views.get_by_id('d79634e1-6063-4ec9-95ff-50acbf609ff5') print(view.name) ``` From 0217d399e5e0c0c790f59e967b9c82e15e390b27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=A9=AC=E7=89=B9=E6=B5=A9=E5=80=AA?= Date: Wed, 27 Mar 2024 12:09:20 +0800 Subject: [PATCH 140/158] Fix some formatting error --- docs/sign-in-out.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sign-in-out.md b/docs/sign-in-out.md index d2aa04bc5..1a08f7bc1 100644 --- a/docs/sign-in-out.md +++ b/docs/sign-in-out.md @@ -81,8 +81,11 @@ If you have Connected Apps enabled, you can create JSON Web Tokens and use them To sign in to Tableau Server or Tableau Cloud with a JWT, you'll need to have created a Connected App and generated the token locally (see [instructions to generate a JWT for your Connected App](https://help.tableau.com/current/server/en-us/connected_apps.htm#step-3-configure-the-jwt)): +```py class JWTAuth(Credentials): def __init__(self, jwt=None, site_id=None, user_id_to_impersonate=None): +``` + Name | Description :--- | :--- JWT | The generated token value From 9e66936d8eedc2c06e37d6e94754a245e510ffc8 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Fri, 29 Mar 2024 16:19:57 -0700 Subject: [PATCH 141/158] Clarify that Python 3.7 is the minimum supported version Also include a pointer to the official Python releases page to provide a hint to customers that they should really be on a higher version. This change also matches our PyPI page which lists 3.7 as the minimum: https://pypi.org/project/tableauserverclient/ --- docs/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 8e8fbffd2..a46d8fa60 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,7 +21,7 @@ This page describes how to: Before you install TSC, confirm that you have the following dependencies installed: -* Python. You can use TSC with Python 3.5 or later. +* Python. You can use TSC with Python 3.7 or later. Ideally, use a Python version that hasn't reached end-of-life yet. (Refer to the [Status of Python versions](https://devguide.python.org/versions/)). * Git. Optional, but recommended to download the samples or install from the source code. ## Install TSC @@ -33,6 +33,7 @@ You can install TSC with pip or from the source code. Run the following command to install the latest stable version of TSC: ```shell +pip install --upgrade pip pip install tableauserverclient ``` @@ -52,7 +53,7 @@ development version are subject to change at any time before the next stable rel To install TSC onto a machine without an internet connection, use the following steps: -1) Ensure that Python 3.5 or higher is installed. +1) Ensure that Python is installed. 2) Download and manually install the `requests` Python library (and its dependencies). From 0e321236ca1cd8ff2bc21393184953d6ef5c83b4 Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Fri, 24 May 2024 12:34:25 -0500 Subject: [PATCH 142/158] docs: document parameters and pdf opts --- docs/api-ref.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index 1fc23421b..444f39b29 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2589,6 +2589,22 @@ csv_req_option.vf('Category', 'Furniture') # retrieve the csv data for the view server.views.populate_csv(view_item, csv_req_option) ``` + +If you set a parameter in the workbook, you can also pass the parameter value as part of the `CSVRequestOptions` object. For example, if you have a parameter named `Region` in the workbook, you can set the parameter value to `South` as follows: + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +csv_req_option = TSC.CSVRequestOptions(maxage=5) +csv_req_option.parameter('Region', 'South') + +# retrieve the csv data for the view +server.views.populate_csv(view_item, csv_req_option) +``` + ### ExcelRequestOptions class ```py @@ -2618,6 +2634,21 @@ excel_req_option.vf('Category', 'Furniture') server.views.populate_excel(view_item, excel_req_option) ``` +If you set a parameter in the workbook, you can also pass the parameter value as part of the `ExcelRequestOptions` object. For example, if you have a parameter named `Region` in the workbook, you can set the parameter value to `South` as follows: + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +excel_req_option = TSC.ExcelRequestOptions(maxage=5) +excel_req_option.parameter('Region', 'South') + +# retrieve the excel data for the view +server.views.populate_excel(view_item, excel_req_option) +``` + ### ImageRequestOptions class ```py @@ -2654,6 +2685,22 @@ server.views.populate_image(view_item, image_req_option) ``` + +If you set a parameter in the workbook, you can also pass the parameter value as part of the `ImageRequestOptions` object. For example, if you have a parameter named `Region` in the workbook, you can set the parameter value to `South` as follows: + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +image_req_option = TSC.ImageRequestOptions(maxage=5) +image_req_option.parameter('Region', 'South') + +# retrieve the image data for the view +server.views.populate_image(view_item, image_req_option) +``` + ### PDFRequestOptions class ```py @@ -2668,6 +2715,8 @@ Name | Description `page_type` | The type of page returned in PDF format for the view. The page_type is set using the `PageType` class:
      `PageType.A3`
      `PageType.A4`
      `PageType.A5`
      `PageType.B5`
      `PageType.Executive`
      `PageType.Folio`
      `PageType.Ledger`
      `PageType.Legal`
      `PageType.Letter`
      `PageType.Note`
      `PageType.Quarto`
      `PageType.Tabloid` `orientation` | The orientation of the page. The options are portrait and landscape. The options are set using the `Orientation` class:
      `Orientation.Portrait`
      `Orientation.Landscape` `maxage` | Optional. The maximum number of minutes the rendered PDF will be cached on the server before being refreshed. The value must be an integer between `1` and `240` minutes. `0` will be interpreted as 1 minute on server, as that is the shortest interval allowed. By default, `maxage` is set to `-1`, indicating the default behavior configured in server settings. +`viz_height` | Optional. The height of the output PDF in pixels. If specified, viz_width must also be specified. +`viz_width` | Optional. The width of the output PDF in pixels. If specified, viz_height must also be specified. **View Filters** You can use the `vf('filter_name', 'filter_value')` method to add view filters. When the PDF is generated, the specified filters will be applied to the view. @@ -2693,6 +2742,39 @@ server.views.populate_pdf(view_item, pdf_req_option) ``` +You can also specify height and width for the visualization to be rendered in the PDF. If you specify the height and width, you must specify both values. The height and width are set in pixels. + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set the PDF request options +pdf_req_option = TSC.PDFRequestOptions(page_type=TSC.PDFRequestOptions.PageType.A4, + orientation=TSC.PDFRequestOptions.Orientation.Landscape, + maxage=1, + viz_height=800, + viz_width=1200) + +server.views.populate_pdf(view_item, pdf_req_option) + +``` + +If you set a parameter in the workbook, you can also pass the parameter value as part of the `PDFRequestOptions` object. For example, if you have a parameter named `Region` in the workbook, you can set the parameter value to `South` as follows: + +```py +# import tableauserverclient as TSC +# server = TSC.Server('https://MY-SERVER') +# sign in, get a specific view, etc. + +# set view filters +pdf_req_option = TSC.PDFRequestOptions(maxage=5) +pdf_req_option.parameter('Region', 'South') + +# retrieve the pdf data for the view +server.views.populate_pdf(view_item, pdf_req_option) +``` +

      From 46441261d182a646db04605aee5fcd4da77bd060 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 5 Jun 2024 18:01:46 -0700 Subject: [PATCH 143/158] Developer guide updates - Clarified and cleaned up some existing instructions - Added a new section explaining how maintainers do a release on PyPI --- docs/dev-guide.md | 60 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 46 insertions(+), 14 deletions(-) diff --git a/docs/dev-guide.md b/docs/dev-guide.md index ffb2c6175..3b3c6b862 100644 --- a/docs/dev-guide.md +++ b/docs/dev-guide.md @@ -20,9 +20,6 @@ add your contributions to the **development** branch. ### Get the source code and set up your branch -1. Make sure you have - [signed the CLA](https://tableau.github.io/contributing.html). - 1. Fork the repository. We follow the "Fork and Pull" model as described [here](https://help.github.com/articles/about-collaborative-development-models/). @@ -170,15 +167,20 @@ section below for details. [here](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) against the **development** branch for code changes. +1. In your first pull request, the Salesforce Contributor License Agreement bot + (`salesforce-cla`) will add a comment with instructions to follow. + 1. Wait for a review and address any feedback. While we try and stay on top of - all issues and PRs it might take a few days for someone to respond. Politely - pinging the PR after a few days with no response is OK, we'll try and respond + all issues and PRs it might take a while for someone to respond. Politely + pinging the PR after a few days with no response is OK; we'll try and respond with a timeline as soon as we are able. 1. That's it! When the PR has received ![](https://github.githubassets.com/images/icons/emoji/unicode/1f680.png){:height="5%" width="5%"} (:rocket:'s) from members of the core team they will merge the - PR. + PR. **Maintainers:** Make sure to choose a Squash Merge when merging a PR into + the `development` branch; that will keep the timeline clean with just the + final result from each PR. ## Updating documentation @@ -190,14 +192,10 @@ All of the documentation source files can be found in `/docs` folder in the **gh-pages** branch. The docs are hosted on the following URL: . -If you are just making documentation updates (adding new docs, fixing typos, -improving wording) the easiest method is to use the built-in `Edit this file` -feature (the pencil icon) or the `Edit this page` link. - -To make more significant changes or additions, please create a pull request -against the **gh-pages** branch. When submitted along with a code pull request -(as described above), you can include a link in the PR text so it's clear they -go together. +To make changes or additions to the documentation, please create a pull request +against the **gh-pages** branch. Because the docs are in a separate branch, you +would need to create a separate PR for your code versus docs changes. It's helpful +to link them to each other in comments so it's clear they go together. ### Running docs locally @@ -215,3 +213,37 @@ To preview and run the documentation locally, these are the steps: For more details, see the GitHub Pages topic on [testing locally](https://docs.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll). + +## Release process (maintainers) + +To do a release and publish a new version to [PyPI](https://pypi.org/project/tableauserverclient/), +follow these steps: + +1. Do a `development` to `master` branch merge. This should be a regular merge + (not a squash) to ensure all individual commits are visible. + +1. (Optional) Do a test publish to PyPI without creating the next version tag. + This will create a pre-release package with a version like `0.30.post0.dev`. + +1. On a local clone of the repo, create and push the tag for the *next* version + (in this example it's "v0.31"): + + ```shell + git fetch + git fetch --tags + git checkout master + git pull + git log # confirm most recent commit on master is the new release commit + git tag -a v0.31 -m 'Release v0.31' + git push origin tag v0.31 + ``` + +1. Publish the updated release to PyPI by running the [Publish](https://github.com/tableau/server-client-python/actions/workflows/publish-pypi.yml) + job and choosing the `master` branch. + +1. The job should just take a few minutes to complete, then check the updated + package exists on [PyPI](https://pypi.org/project/tableauserverclient/). + +1. Create a release in GitHub with the title like "v0.31" and release notes + with changes from the last release. You can try the automatic generation + of notes, or just create a list of merged PR titles with reference PR numbers. From 6240a45ed100c3d861a3020ab2a12686bc5b4229 Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Fri, 31 May 2024 06:16:07 -0500 Subject: [PATCH 144/158] docs: reflect deprecated removals and updates --- docs/api-ref.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 444f39b29..a80c07d21 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2061,9 +2061,9 @@ Name | Description ``` -#### projects.update_permission +#### projects.update_permissions ```py -projects.update_permission(item, rules) +projects.update_permissions(item, rules) ``` Add project permissions for a user or group. @@ -2096,7 +2096,7 @@ Name | Description capabilities=project_capabilities ) - server.projects.update_permission(project_item, [project_rules]) + server.projects.update_permissions(project_item, [project_rules]) ``` @@ -5336,7 +5336,7 @@ print(workbook.name) #### workbooks.publish ```py -workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job, hidden_views) +workbooks.publish(workbook_item, file_path, publish_mode, connections, skip_connection_check, as_job) ``` Publish a workbook to the specified site. @@ -5360,10 +5360,8 @@ Name | Description `file` | The file path or file object of the workbook to publish. When providing a file object, you must also specifiy the name of the workbook in your instance of the `workbook_item``workbook_item` , as the name cannot be derived from the file name. `mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`. `connections` | List of `ConnectionItems` objects for the connections created within the workbook. -`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used). **Deprecated since API server version 2.3.** `skip_connection_check` | (Optional) Set to `True` to skip connection check at time of upload. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. Defaults to `False`. `as_job` | (Optional) Set to `True` to run the upload as a job (asynchronous upload). If set to `True` a job will start to perform the publishing process and a `Job` object is returned. Defaults to `False`. -`hidden_views` | (Optional) List of string names of views that need to be hidden when the workbook is published. @@ -5783,7 +5781,7 @@ None. The preview image is added to the view. #### workbooks.update_connection ```py -workbooks.update_conn(workbook_item, connection_item) +workbooks.update_connection(workbook_item, connection_item) ``` Updates a workbook connection information (server address, server port, user name, and password). @@ -5821,7 +5819,7 @@ connection.username = 'USERNAME' connection.password = 'PASSWORD' # call the update method -server.workbooks.update_conn(workbook, connection) +server.workbooks.update_connection(workbook, connection) ```
      From 8b3a1d4ba5baac6958a519c8089a7b1d42b57184 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Wed, 19 Jun 2024 15:33:15 -0700 Subject: [PATCH 145/158] Update public-facing company name to Salesforce --- _includes/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/footer.html b/_includes/footer.html index b73489dc7..f3c168ed2 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -3,7 +3,7 @@

      This site is open source. Suggestions and pull requests are welcome on our GitHub page.

      -

      LEGAL PRIVACY © 2003– TABLEAU SOFTWARE LLC. ALL RIGHTS RESERVED

      +

      LEGAL PRIVACY © Salesforce, Inc.

      Documentation last generated on: {{ site.time }}
      From 8d1d0d313e95cfb7a250f693e698ad5118ac0e3a Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Thu, 1 Aug 2024 06:36:50 -0500 Subject: [PATCH 146/158] docs: workbook publish hidden views --- docs/api-ref.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index a80c07d21..19211449f 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -5390,10 +5390,12 @@ tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') server = TSC.Server('https://servername') with server.auth.sign_in(tableau_auth): - # create a workbook item - wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') - # call the publish method with the workbook item - wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') + # create a workbook item + wb_item = TSC.WorkbookItem(name='Sample', project_id='1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e') + # set hidden views + wb_item.hidden_views = ['Sheet1', 'Sheet2'] + # call the publish method with the workbook item + wb_item = server.workbooks.publish(wb_item, 'SampleWB.twbx', 'Overwrite') ```
      From 18622433abb148d57b7aa592f046018a234742af Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Sat, 17 Aug 2024 07:04:20 -0500 Subject: [PATCH 147/158] docs: django page_size --- docs/filter-sort.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 8c94285f2..1d8a947ac 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -104,6 +104,19 @@ for workbook in all_workbooks: print(workbook.owner_id) ``` +### Setting page size + +Starting with version 0.32, you can set the page size for the request by using +the `page_size` keyword argument. The default page size is 100 if not provided. + +```py +superstore_workbooks = server.workbooks.filter(name='Superstore', page_size=10) +# or +all_workbooks = server.workbooks.all(page_size=1000) +``` + + + ### Direction criteria - Django style The field name can be input as normal for ascending or prefixed with `-` for descending. From 746a9973e705ceda6ea6c9f3bba350edb8a6c62c Mon Sep 17 00:00:00 2001 From: Sai Ram Pendyala <89296568+sai-ram-pendyala@users.noreply.github.com> Date: Tue, 20 Aug 2024 16:26:33 +0530 Subject: [PATCH 148/158] Update api-ref.md --- docs/api-ref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index 19211449f..d370aec3d 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -1480,7 +1480,7 @@ Name | Description Returns the final `JobItem`. -Usually, you can just discard the return value without checking the job status. In case the job wasn't succesful, `wait_for_job` would have already raised an exception. For advanced scenarios, he returned `JobItem` might still be interesting to access e.g. start and end time or `notes`. +Usually, you can just discard the return value without checking the job status. In case the job wasn't succesful, `wait_for_job` would have already raised an exception. For advanced scenarios, the returned `JobItem` might still be interesting to access e.g. start and end time or `notes`. **Example** From b6cde489eadb186386aaefc6a6ba94b0176065ad Mon Sep 17 00:00:00 2001 From: jorwoods Date: Wed, 21 Aug 2024 11:13:16 -0500 Subject: [PATCH 149/158] docs: bulk add/remove users (#1441) Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com> --- docs/api-ref.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index d370aec3d..c78a592af 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -933,6 +933,56 @@ None.

      +#### groups.add_users + +```py +groups.add_users(group_item, user_id): +``` + +Adds multiple users to the specified group. + + +REST API [Add User to Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#add_user_to_group) + +**Version** + +This endpoint is available with REST API version 3.21 and up. Method added in +version v0.33 + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`users` | An Iterable of UserItems, or user ids. + + + + +**Returns** + +list[UserItem] + + +**Example** + +```py +# Adding a user to a group +# +# get the group item + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# Add Viewers to the group + added_users = server.groups.add_users( + mygroup, + server.users.filter(site_role=TSC.UserItem.Roles.Viewer) + ) +``` + +
      +
      + #### groups.create ```py @@ -1244,6 +1294,56 @@ None. The user is removed from the group.

      +#### groups.remove_users + +```py +groups.remove_users(group_item, user_id): +``` + +Removes multiple users from the specified group. + + +REST API [Remove User from Group](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#remove_user_to_group) + +**Version** + +This endpoint is available with REST API version 3.21 and up. Method added in +version v0.33 + +**Parameters** + +Name | Description +:--- | :--- +`group_item` | The `group_item` specifies the group to update. +`users` | An Iterable of UserItems, or user ids. + + + + +**Returns** + +None + + +**Example** + +```py +# Removing a user from a group +# +# get the group item + all_groups, pagination_item = server.groups.get() + mygroup = all_groups[1] + +# Remove Viewers from the group + server.groups.remove_users( + mygroup, + server.users.filter(site_role=TSC.UserItem.Roles.Viewer) + ) +``` + +
      +
      + #### groups.update From 8410b677dbcf34fb15d608d026da28e83a73ef4f Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Thu, 29 Aug 2024 20:57:30 -0500 Subject: [PATCH 150/158] docs: clarify django style filters Add notes about supported endpoints and being able to use multiple filters at a time. --- docs/filter-sort.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 1d8a947ac..8da06eef7 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -138,6 +138,21 @@ Sort can take multiple args, with desc direction added as a (-) prefix workbooks = workbooks.order_by("project_name", "-created_at") ``` +### Supported endpoints + +The following endpoints support the Django style filters and sorts: + +* Datasources +* Flow Runs +* Flows +* Groups +* Groupsets +* Jobs +* Projects +* Users +* Views +* Workbooks + ### More detailed examples ```py @@ -147,6 +162,12 @@ workbooks = server.workbooks.all() # filters can be appended in new lines workbooks = workbooks.filter(project_name=project_name) +# multiple filters can be added in a single line +workbooks = workbooks.filter(project_name=project_name, owner_name=owner_name, size__gte=1000) + +# Find all views in a project, with a specific tag +views = server.views.filter(project_name=project_name, tags="stale") + # sort can take multiple args, with desc direction added as a (-) prefix workbooks = workbooks.order_by("project_name", "-created_at") From b5b89da86729320c29116f8a568d931cdad18958 Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Fri, 30 Aug 2024 06:53:37 -0500 Subject: [PATCH 151/158] docs: environment variables supported by v0.33 --- docs/environment-variables.md | 44 +++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/environment-variables.md diff --git a/docs/environment-variables.md b/docs/environment-variables.md new file mode 100644 index 000000000..a31625fe0 --- /dev/null +++ b/docs/environment-variables.md @@ -0,0 +1,44 @@ +--- +title: Environment Variables +layout: docs +--- + +Tableau Server Client (TSC) can use environment variables to pull configuration +settings. This is a convenient way to manage the setting in one place and have +it used across all of the related calls. + +## Supported environment variables + +The following environment variables are supported by TSC: + +Name | Description | Version | Default | Limit +:--- | :--- | :--- | :--- | :--- +`TSC_CHUNK_SIZE_MB` | The size of chunks when uploading files. Limit is 64 MB. | 0.33 | 50 | 64 +`TSC_PAGE_SIZE` | The number of items to return in a single page of results. | 0.33 | 100 | 1000 + +## Setting environment variables + +To set an environment variable, you can use the `os` module in Python. Here is +an example of setting the environment variables for the chunk size and page size: + +```py +import os + +import tableauserverclient as TSC + +os.environ['TSC_CHUNK_SIZE_MB'] = '64' +os.environ['TSC_PAGE_SIZE'] = '1000' + +# Continue with your TSC code +``` + +You can set these environment variables in your Python script, shell, IDE, bash +or PowerShell profile, CI/CD pipeline, .env file, or any other place where you +can set environment variables. + +## Using environment variables + +The TSC library will automatically pick up the environment variables when they +are set. If you set the environment variables in your Python script, they will +be used for the duration of the script. If you set them in your shell or IDE, +they will be used for all scripts that run in that environment. From bd1b86c9de3b30162501899cf9428623be2d33d6 Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Sun, 1 Sep 2024 12:38:33 -0500 Subject: [PATCH 152/158] docs: chaining filters --- docs/filter-sort.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index 8da06eef7..ddd2cbbee 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -165,6 +165,9 @@ workbooks = workbooks.filter(project_name=project_name) # multiple filters can be added in a single line workbooks = workbooks.filter(project_name=project_name, owner_name=owner_name, size__gte=1000) +# Multiple filters can be added through chaining. +workbooks = workbooks.filter(project_name=project_name).filter(owner_name=owner_name).filter(size__gte=1000) + # Find all views in a project, with a specific tag views = server.views.filter(project_name=project_name, tags="stale") From 3ae9fdf0988536fbe36d4c23b35ba5ff515efab4 Mon Sep 17 00:00:00 2001 From: Jordan Woods <13803242+jorwoods@users.noreply.github.com> Date: Mon, 2 Sep 2024 06:59:39 -0500 Subject: [PATCH 153/158] docs: detail indexing, slicing, and length checking --- docs/filter-sort.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/filter-sort.md b/docs/filter-sort.md index ddd2cbbee..feaf12102 100644 --- a/docs/filter-sort.md +++ b/docs/filter-sort.md @@ -138,6 +138,21 @@ Sort can take multiple args, with desc direction added as a (-) prefix workbooks = workbooks.order_by("project_name", "-created_at") ``` +### Indexing and slicing + +Querysets can be indexed and sliced like a list. The query is executed at when +the queryset is indexed or sliced. +```py +# Get the first item in the queryset +flow = server.flows.filter(owner_name="admin")[0] + +# Get the last item in the queryset +flow = server.flows.filter(owner_name="admin")[-1] + +# Get the most recent 10 runs from a flow +runs = server.flow_runs.filter(flow_id=flow.id, page_size=10).order_by("-created_at")[:10] +``` + ### Supported endpoints The following endpoints support the Django style filters and sorts: @@ -174,10 +189,7 @@ views = server.views.filter(project_name=project_name, tags="stale") # sort can take multiple args, with desc direction added as a (-) prefix workbooks = workbooks.order_by("project_name", "-created_at") -# pagination take these two keywords -workbooks = workbooks.paginate(page_size=10, page_number=2) - -# query is executed at time of access +# query is executed at time of iteration for workbook in workbooks: print(workbook) @@ -189,6 +201,11 @@ all_workbooks = server.workbooks.filter(project_name=project_name).order_by("-pr # operators are implemented using dunderscore all_workbooks = server.workbooks.filter(project_name__in=["Project A", "Project B"]) + +# How many items are in the queryset? +flows = server.flows.filter(owner_name="admin") +print(len(flows)) + ``` ### Operators available From 0a7428b2100dad2d1540121f74293cf5d9d8bca1 Mon Sep 17 00:00:00 2001 From: Jordan Woods Date: Fri, 20 Sep 2024 02:35:10 -0500 Subject: [PATCH 154/158] docs: add environment variables to sidebar links (#1467) Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com> --- _includes/docs_menu.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_includes/docs_menu.html b/_includes/docs_menu.html index b8026fc6f..8f1db8880 100644 --- a/_includes/docs_menu.html +++ b/_includes/docs_menu.html @@ -22,6 +22,9 @@
    • Filter and Sort
      • +
    • + Environment Variables +
    • Samples
      • From ee0d36626054848f0956cf38f96d4d05dd8bfa7d Mon Sep 17 00:00:00 2001 From: Jac Date: Sat, 28 Sep 2024 11:28:44 -0700 Subject: [PATCH 155/158] #548 Add 'description' to workbook docs (#1476) Add 'description' to workbook https://github.com/tableau/server-client-python/issues/548 --- docs/api-ref.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api-ref.md b/docs/api-ref.md index c78a592af..f4daf6c9a 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -5291,6 +5291,7 @@ Name | Description `connections` | The list of data connections (`ConnectionItem`) for the data sources used by the workbook. You must first call the [workbooks.populate_connections](#workbooks.populate_connections) method to access this data. See the [ConnectionItem class](#connectionitem-class). `content_url` | The name of the data source as it would appear in a URL. `created_at` | The date and time when the data source was created. +`description` | The user-defined description of the workbook `id` | The identifier for the workbook. You need this value to query a specific workbook or to delete a workbook with the `get_by_id` and `delete` methods. `name` | The name of the workbook. `owner_id` | The ID of the owner. From 85e968214f0677db72c008d121216322320c8d61 Mon Sep 17 00:00:00 2001 From: Brian Cantoni Date: Thu, 10 Oct 2024 12:37:31 -0700 Subject: [PATCH 156/158] Update samples list to match current file set (#1480) * Update samples list to match current file set * Remove workbook data acceleration; feature was removed in 2022 --- .gitignore | 2 +- docs/samples.md | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index e7dc31618..379adaad7 100644 --- a/.gitignore +++ b/.gitignore @@ -91,7 +91,7 @@ ENV/ # Rope project settings .ropeproject - +.vscode/ # macOS.gitignore from https://github.com/github/gitignore *.DS_Store diff --git a/docs/samples.md b/docs/samples.md index 85d306216..907185c03 100644 --- a/docs/samples.md +++ b/docs/samples.md @@ -41,15 +41,17 @@ You will see that you need to enter a file path for the workbook that you want t The following list describes the samples available in the repository: * `add_default_permission.py` Adds workbook default permissions for a given project. +* `create_extract_task.py` Creates extract tasks. * `create_group.py` Creates a user group. * `create_project.py` Creates a project in a site. * `create_schedules.py` Creates schedules for extract refreshes and subscriptions. -* `download_view_image.py` Downloads an image of a specified view. * `explore_datasource.py` Queries datasources, selects a datasource, populates connections for the datasource, then updates the datasource. +* `explore_favorites.py` Queries favorites and optionally add or delete favorites. +* `explore_site.py` Interacts with sites (create, delete, and so on). * `explore_webhooks.py` Explores webhook functions supported by the Server API. * `explore_workbook.py` Queries workbooks, selects a workbook, populates the connections and views for a workbook, then updates the workbook. * `export.py` Exports a view as an image, PDF, or CSV. -* `export_wb.py` Exports a PDF containing all views in a workbook. +* `extracts.py` Interacts with extracts, including querying, deleting or creating. * `filter_sort_groups.py` Demonstrates filtering and sorting user groups. * `filter_sort_projects.py` Demonstrates filtering and sorting projects. * `initialize_server.py` Sets up an existing server instance with site, workbooks and datasources. @@ -65,9 +67,10 @@ The following list describes the samples available in the repository: * `query_permissions.py` Queries permissions of a given resource. * `refresh.py` Refreshes a datasource or workbook. * `refresh_tasks.py` Lists and runs configured tasks on a server. -* `set_http_options.py` Demonstrates HTTP options for the server and specifically for downloading workbooks. * `set_refresh_schedule.py` Sets the schedule to refresh a workbook or datasource. +* `smoke_test.py` Verifies that TSC is installed correctly and is able to run. * `update_connection.py` Updates and embeds connection credentials of a datasource. * `update_datasource_data.py` Updates the data within a published live-to-Hyper datasource. +* `update_workbook_data_freshness_policy.py` Updates workbook data freshness policy settings. **Note**: For all of the samples, ensure that your Tableau Server user account has permission to access the resources. Also keep in mind that some example operations (like create group) are not allowed on Tableau Cloud. From 8bdaa6706ab75fc43022a28ff7f27caf49418597 Mon Sep 17 00:00:00 2001 From: Jordan Woods Date: Fri, 11 Oct 2024 15:49:35 -0500 Subject: [PATCH 157/158] docs: correct delete_obj_default_permissions sig (#1483) Closes #1241 The docs were incorrect as to what arguments delete_*_default_permissions accepted. This corrects the docs to show that the methods accept an object and not an iterable of objects. Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com> --- docs/api-ref.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api-ref.md b/docs/api-ref.md index f4daf6c9a..62039ae2a 100644 --- a/docs/api-ref.md +++ b/docs/api-ref.md @@ -2429,17 +2429,17 @@ Name | Description TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow } - rules = TSC.PermissionsRule( + rule = TSC.PermissionsRule( grantee=project_item, capabilities=capabilities ) - server.projects.update_flow_default_permissions(project_item, [rules]) + server.projects.update_flow_default_permissions(project_item, [rule]) ``` #### projects.delete_workbook_default_permissions ```py -projects.delete_workbook_default_permissions(item, rules) +projects.delete_workbook_default_permissions(item, rule) ``` Delete default workbook permissions. @@ -2451,7 +2451,7 @@ REST API: [Delete Default Workbook Permissions](https://help.tableau.com/current Name | Description :--- | :--- `item` | A project object. -`rules` | A list of PermissionsRule objects. +`rule` | A PermissionsRule object. **Example** @@ -2467,17 +2467,17 @@ Name | Description TSC.Permission.Capability.ViewComments: TSC.Permission.Mode.Allow } - rules = TSC.PermissionsRule( + rule = TSC.PermissionsRule( grantee=project_item, capabilities=capabilities ) - server.projects.delete_workbook_default_permissions(project_item, [rules]) + server.projects.delete_workbook_default_permissions(project_item, rule) ``` #### projects.delete_datasource_default_permissions ```py -projects.delete_datasource_default_permissions(item, rules) +projects.delete_datasource_default_permissions(item, rule) ``` Delete default datasource permissions. @@ -2489,7 +2489,7 @@ REST API: [Delete Default Datasource Permissions](https://help.tableau.com/curre Name | Description :--- | :--- `item` | A project object. -`rules` | A list of PermissionsRule objects. +`rule` | A PermissionsRule object. **Example** @@ -2505,17 +2505,17 @@ Name | Description TSC.Permission.Capability.ExportXml: TSC.Permission.Mode.Allow } - rules = TSC.PermissionsRule( + rule = TSC.PermissionsRule( grantee=project_item, capabilities=capabilities ) - server.projects.delete_datasource_default_permissions(project_item, [rules]) + server.projects.delete_datasource_default_permissions(project_item, rule) ``` #### projects.delete_flow_default_permissions ```py -projects.delete_flow_default_permissions(item, rules) +projects.delete_flow_default_permissions(item, rule) ``` Delete default flow permissions. @@ -2527,7 +2527,7 @@ REST API: [Delete Default Flow Permissions](https://help.tableau.com/current/api Name | Description :--- | :--- `item` | A project object. -`rules` | A list of PermissionsRule objects. +`rule` | A PermissionsRule object. **Example** @@ -2543,12 +2543,12 @@ Name | Description TSC.Permission.Capability.Read: TSC.Permission.Mode.Allow } - rules = TSC.PermissionsRule( + rule = TSC.PermissionsRule( grantee=project_item, capabilities=capabilities ) - server.projects.delete_flow_default_permissions(project_item, [rules]) + server.projects.delete_flow_default_permissions(project_item, rule) ```
      From 508a981fdc8d3bd230ad5f3344fc3e4886fef956 Mon Sep 17 00:00:00 2001 From: Jordan Woods Date: Mon, 14 Oct 2024 11:53:44 -0500 Subject: [PATCH 158/158] docs: file size limit environment variable (#1491) Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com> --- docs/environment-variables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/environment-variables.md b/docs/environment-variables.md index a31625fe0..c2b453fe8 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -15,6 +15,7 @@ Name | Description | Version | Default | Limit :--- | :--- | :--- | :--- | :--- `TSC_CHUNK_SIZE_MB` | The size of chunks when uploading files. Limit is 64 MB. | 0.33 | 50 | 64 `TSC_PAGE_SIZE` | The number of items to return in a single page of results. | 0.33 | 100 | 1000 +`TSC_FILESIZE_LIMIT_MB` | The maximum file size that can be uploaded. | 0.34 | 64 | 64 ## Setting environment variables