Table Of Contents

Module - jobs.job_vizql_export

JobVizqlExport

Configuration for job_vizql_export.py

type

object

properties

  • credentials

Tableau server credentials.

Credentials

anyOf

type

string

allOf

TableauCredentials

  • server

Tableau server configuration.

Server

allOf

TableauServer

  • export

Defines the Tableau export to perform.

Export

anyOf

allOf

CSVExport

allOf

PDFExport

allOf

XLSXExport

  • destination_dir

Destination Dir

Directory in which the exported report will be saved.

type

string

default

/home/khe/mitto-2.8.x/data

format

directory-path

additionalProperties

False

definitions

  • TableauCredentials

TableauCredentials

Tableau server credentials.

type

object

properties

  • username

Username

Tableau username.

type

string

examples

steve

  • password

Password

Tableau password.

type

string

examples

steve-password

additionalProperties

False

  • TableauServer

TableauServer

Tableau server configuration.

type

object

properties

  • server

Server

Tableau server to use.

type

string

examples

https://tableau.zuar.com

  • site

Site

Tableau site to use. Note: to use the "Default" site, provide a empty string value (i.e., a value of "").

type

string

examples

  • user_id_to_impersonate

User Id To Impersonate

Tableau username to impersonate when authenticating. If not provided, no impersonation is performed.

type

string

examples

3908c4ce-b171-46f3-b12b-d8827c162199

additionalProperties

False

  • CSVExport

CSVExport

Complete definition of the Tableau REST CSV export

type

object

properties

  • name

Name

Name that the export will be saved under. Do not include the extension; it will be determined automatically.

type

string

default

tableau-export

  • workbook

Workbook

_content_url of the workbook

type

string

  • view

View

_content_url of the view

type

string

  • view_filters

View Filters

View filters to apply to data.

type

object

examples

OrderedDict([(‘State’, [‘Louisiana’, ‘Texas’]), (‘Category’, [‘Office Supplies’])])

OrderedDict([(‘region’, [‘LATAM’, ‘NA’]), (‘sub_region’, []), (‘plant_name’, []), (‘global_start_datetime’, ‘2020-06-12 00:00:00.000’), (‘global_end_datetime’, ‘2020-06-12 23:59:59.999’)])

default

OrderedDict()

  • full

Full

Process all views in workbook, not just the view specified by view.

type

boolean

examples

true

false

null

  • timeout

Timeout

Maximum number of seconds to allow before killing request.

type

integer

default

300

  • retries

Retries

Maximum number of times to retry a failed request.

type

integer

default

5

  • maxage

Maxage

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.

type

integer

maximum

240

minimum

-1

default

-1

  • type

Type

Type of export being performed.

type

string

examples

csv

default

csv

additionalProperties

False

  • PDFLayoutOptions

PDFLayoutOptions

Defines all available Vizql page layout options

type

object

properties

  • imageHeight

Imageheight

type

string

examples

1440

1024

pattern

^d+$

default

0

  • imageWidth

Imagewidth

type

string

examples

3440

1280

pattern

^d+$

default

0

  • pageFitHorizontal

Pagefithorizontal

type

string

examples

1

2

pattern

^[12]$

default

1

  • pageFitVertical

Pagefitvertical

type

string

examples

1

2

pattern

^[12]$

default

1

  • pageOrientationOption

Pageorientationoption

type

string

examples

landscape

portrait

default

landscape

  • pageScaleMode

Pagescalemode

type

string

examples

auto

fit-pages

percent

default

auto

  • pageScalePercent

Pagescalepercent

type

string

examples

25

50

60

75

80

90

100

200

400

default

100

  • pageSizeOption

Pagesizeoption

type

string

examples

a3

a4

a5

b4

b5

executive

folio

ledger

legal

letter

note

quarto

statement

tabloid

unspecified

default

letter

additionalProperties

False

  • PDFModifications

PDFModifications

Modification to make to a Vizql PDF Export request.

type

object

properties

  • request

Request

The request to modify.

type

string

examples

auth

embed

bootstrap

export_options

export_server

  • action

Action

The type of modification to perform to the request.

replace – Replace the contents of the request with items.

update – Update the contents of the request with items. Contents not matching items remain in the request unchanged.

pop – Any keys in the request matching keys in items are removed from the request. Values associated with keys in items are ignored.

type

string

examples

update

replace

pop

default

update

  • destination

Destination

The argument to modify in the requests operation that will be performed.

type

string

examples

data

cookies

files

headers

params

  • items

Items

Keys and values to use in modifying the request.

type

object

examples

OrderedDict([(‘clientDimension’, “{‘w’: 1280, ‘h’: 1024}”), (‘dashboardPortSize’, “{‘w’: 1280, ‘h’: 1024}”), (‘worksheetPortSize’, “{‘w’: 1280, ‘h’: 1024}”)])

additionalProperties

type

string

additionalProperties

False

  • PDFExport

PDFExport

Complete definition of the Tableau Vizql PDF export

type

object

properties

  • name

Name

Name that the export will be saved under. Do not include the extension; it will be determined automatically.

type

string

default

tableau-export

  • workbook

Workbook

_content_url of the workbook

type

string

  • view

View

_content_url of the view

type

string

  • view_filters

View Filters

View filters to apply to data.

type

object

examples

OrderedDict([(‘State’, [‘Louisiana’, ‘Texas’]), (‘Category’, [‘Office Supplies’])])

OrderedDict([(‘region’, [‘LATAM’, ‘NA’]), (‘sub_region’, []), (‘plant_name’, []), (‘global_start_datetime’, ‘2020-06-12 00:00:00.000’), (‘global_end_datetime’, ‘2020-06-12 23:59:59.999’)])

default

OrderedDict()

  • full

Full

Process all views in workbook, not just the view specified by view.

type

boolean

examples

true

false

null

  • timeout

Timeout

Maximum number of seconds to allow before killing request.

type

integer

default

300

  • retries

Retries

Maximum number of times to retry a failed request.

type

integer

default

5

  • maxage

Maxage

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.

type

integer

maximum

240

minimum

-1

default

-1

  • type

Type

Type of export being performed.

type

string

examples

pdf

default

pdf

  • options

Options

default

OrderedDict([(‘imageHeight’, ‘0’), (‘imageWidth’, ‘0’), (‘pageFitHorizontal’, ‘1’), (‘pageFitVertical’, ‘1’), (‘pageOrientationOption’, ‘landscape’), (‘pageScaleMode’, ‘auto’), (‘pageScalePercent’, ‘100’), (‘pageSizeOption’, ‘letter’)])

allOf

PDFLayoutOptions

  • modifications

Modifications

type

array

default

[]

items

PDFModifications

  • log_requests

Log Requests

Log the content of each request.

type

boolean

examples

true

false

default

False

  • log_responses

Log Responses

Log the content of each response received from the server. Helpful for determining what data is available for use in requests.

type

boolean

examples

true

false

default

False

  • save_responses

Save Responses

Save the content of each response received from the server in /tmp. Helpful for determining what data is available for use in requests.

type

boolean

examples

true

false

default

False

additionalProperties

False

  • XLSXExport

XLSXExport

Complete definition of the Tableau REST XLSX export

type

object

properties

  • name

Name

Name that the export will be saved under. Do not include the extension; it will be determined automatically.

type

string

default

tableau-export

  • workbook

Workbook

_content_url of the workbook

type

string

  • view

View

_content_url of the view

type

string

  • view_filters

View Filters

View filters to apply to data.

type

object

examples

OrderedDict([(‘State’, [‘Louisiana’, ‘Texas’]), (‘Category’, [‘Office Supplies’])])

OrderedDict([(‘region’, [‘LATAM’, ‘NA’]), (‘sub_region’, []), (‘plant_name’, []), (‘global_start_datetime’, ‘2020-06-12 00:00:00.000’), (‘global_end_datetime’, ‘2020-06-12 23:59:59.999’)])

default

OrderedDict()

  • full

Full

Process all views in workbook, not just the view specified by view.

type

boolean

examples

true

false

null

  • timeout

Timeout

Maximum number of seconds to allow before killing request.

type

integer

default

300

  • retries

Retries

Maximum number of times to retry a failed request.

type

integer

default

5

  • maxage

Maxage

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.

type

integer

maximum

240

minimum

-1

default

-1

  • type

Type

Type of export being performed.

type

string

examples

xlsx

default

xlsx

additionalProperties

False