Effectblog963

Note: The content in this topic only applies to Tableau Prep Builder.

You can run your flow from the command line to refresh your flow output instead of running the flow from Tableau Prep Builder. You can run one flow at a time using this method. This option is available on both Windows and Mac machines where Tableau Prep Builder is installed.

Note: If you use Single Sign-On authentication, running flows from the command line isn't available. You can run the flows from Tableau Prep Builder instead.

Connector limitations:

• JDBC or ODBC connectors: Flows that include these connectors can be run from the command line starting in version 2019.2.3.
• Cloud connectors: Flows that include cloud connectors, such as Google BigQuery, can't be run from the command line. Instead run the flow manually or run the flow on a schedule in Tableau Server or Tableau Online using Tableau Prep Conductor. For more information, see Keep Flow Data Fresh.

For Windows machines, you can also schedule this process using Windows Task Scheduler. For more information, see Task Scheduler(Link opens in a new window) in the Microsoft online help.

When you run flows from the command line, Tableau Prep Builder refreshes all outputs for the flow using the settings for the output steps specified in Tableau Prep Builder. For information about how to specify your output locations, see Create data extract files and published data sources(Link opens in a new window). For information about setting your write options (version 2020.2.1 and later), see Configure write options.

For MySQL 8.0 on Windows, the default installation directory is C: Program Files MySQL MySQL Server 8.0 for installations performed with MySQL Installer. If you use the ZIP archive method to install MySQL, you may prefer to install in C: mysql. However, the layout of the subdirectories remains the same. This may be achieved using command line switches (see 'Configuration') or automatically using the mysqlconfig binary which comes with most MySQL distributions. If your MySQL distribution contains mysqlconfig the easiest method is to ensure this binary is on your path.

1. The most common methods are to provide options in an option file or on the command line. However, in most cases it is desirable to make sure that the server uses the same options each time it runs. The best way to ensure this is to list them in an option file. See Section 4.2.2.2, “Using Option Files”. That section also describes option.
2. $ sudo port install postgresql93-server $ sudo port install geos $ sudo port install proj $ sudo port install postgis $ sudo port install gdal +geos $ sudo port install libgeoip Note You will also have to modify the PATH in your.profile so that the MacPorts programs are accessible from the command-line.

Before running the flow

To run the flow from the command line, you'll need administrator privileges on the machine where you are running the flow and you'll need the following information:

• The path where Tableau Prep Builder is installed.

• If connecting to databases and publishing output files to a server or a database (version 2020.3.1 and later) - create a credentials .json file that includes all required credentials.

• The path where the Tableau Flow (.tfl) file is located.

Credentials .json file requirements

Note: Credentials .json files are not required if the flow connects to and outputs to local files, files stored on a network share or input files that use Windows Authentication (SSPI). For more information about Windows Authentication, see SSPI Model(Link opens in a new window) in the Microsoft online help.

Tableau Prep Builder uses information from the flow file and from the credentials .json file to run the flow when you have remote connections. For example, the database name for your remote connections and the project name for your output files come from the flow, and the server name and the sign in credentials come from the credentials .json file.

• If you plan to reuse the file, place it in a folder where it won't be overwritten by the Tableau Prep Builder install process.
• If you are running a flow that includes any of the following, you must include a.json file that includes the credentials that are required to connect.
  • Connects to database files or published data sources.
  • The output is published to a server or to a database (version 2020.3.1 and later).
  • The flow includes script steps for Rserve or TabPy. The .json file must include the credentials that are required to connect to these services. For more information, refer to the array requirements for your version below.
• The credentials specified in your flow and the credentials included in your .json file must match, otherwise the flow will fail to run.
• When you run the process, the hostname, port, and username are used to find the matching connection in the Tableau flow file (.tfl) and updated before running the process. Port ID and Site ID are optional if your connections don't require this information.

• If connecting to a published data source, include hostname, contentUrl, and port (80 for http and 443 for https) in the input connections. The hostname is required to find the matching connection in the Tableau flow file (.tfl), and the contentUrl and port are used to establish the connection to the server.

• If you connect to Tableau Online, include the port (80 or 443) in the input connections for the pod that you are connecting to. For more information about Tableau Online, see Tableau Bridge connections to Tableau Online(Link opens in a new window) in the Tableau Online help.

Depending on your Tableau Prep Builder version, your credential information may be formatted differently. Click on the tab below to view the credential format for your Tableau Prep Builder version.

Depending on your connections, include your server or database credentials or both. When your flow connects to and outputs to the same server or database, you only need to include a single block in the .json file. If you connect to a server or database that uses different credentials, use a comma delimited array.

Note: ContentUrl is always required in the .json file for sever connections. If connecting to a default site, for example 'https://my.server/#/site/', set ContentUrl to blank. For example 'contentUrl': '

Examples

This section shows different examples of credentials files that you can create using the credentials .json requirements.

Connecting to a server connection

This example shows a .json credentials file that connects to and outputs to a server connection that uses the same credentials:

Connecting to a server connection and output to a database connection

This example shows a .json credentials file that connects to a server connection and outputs to a database connection:

Flow includes Rserve and TabPy script connections and outputs to a database connection

This example shows a .json credentials file that includes Rserve and Tabpy credentials and outputs to a database connection:

Connecting to and outputting to different database connections

This example shows a .json credentials file that connects to and outputs to different database connections:

Enter an array for your input and output connections.

Note: If using Tableau Prep Builder version 2018.2.2 through 2018.3.1, always include the 'inputConnections' and 'outputConnections' arrays even if the flow doesn't have remote connections for inputs or outputs. Just leave those arrays blank. If you are using Tableau Prep Builder version 2018.3.2 and later you don't need to include the blank arrays.

Examples

This section shows two different examples of credentials files that you can create using the credentials .json requirements.

Connecting to a published data source

This example shows a .json credentials file that connects to a published data source and outputs data to a server that includes a Site ID

Note: If the inputConnection or outputConnection uses the Default site, for example 'https://my.server/#/site/', set ContentUrl to blank. For example 'contentUrl': '

Connecting to two databases

This example shows a .json credentials file that connects to MySQL and Oracle and outputs data to a server that includes a Site ID.

Flow includes script steps for Rserve and TabPy and connects to a database

This example shows a .json credentials file that includes the password for Rserve and TabPy services and connects to MySQL.

Mysql Command Line Download

Tips for creating your credentials file

To avoid errors when running the flow, make sure your credentials file follows these guidelines:

• If using Tableau Prep Builder version 2018.2.2 through 2018.3.1, always include the 'inputConnections' and 'outputConnections' arrays even if the flow doesn't have remote connections for inputs or outputs. Just leave those arrays blank.

  If you are using Tableau Prep Builder version 2018.3.2 and later you don't need to include the blank array.

  • No remote input connection? Include this syntax at the top of the .json file

  • No remote output connection? Include this syntax at the bottom of the .json file

• No port ID for your input connection or the port is specified as part of the server name.

  If there is no port ID for your connection, don't include the 'port':xxxx, reference in the .json file, not even 'port': '. If the port ID is included in the server name, include the port ID in the host name. For example 'hostname': 'mssql.example.lan,1234'

• When referencing the 'serverUrl': don't include a '/' at the end of the address. For example, use this 'serverUrl': 'http://server' not this 'serverUrl': 'http://server/'.

• If you have multiple input or output connections include the credentials for each one in the file.

• If connecting to published data sources, make sure to include the hostname and contentUrl in the input connections.

Run the flow

Important: The examples below include the name change for 'Tableau Prep' version 2019.1.2 to 'Tableau Prep Builder'. If you are using an earlier version of the product use 'Tableau Prep' instead.

1. Open the command prompt or terminal command prompt (MacOS) as an Administrator.

2. Run one of the following commands using the syntax shown below.

   • The flow connects to local files or files stored on a network share and publishes to local files, files stored on a network share or uses Windows authentication:

     Note: If connecting to or outputting to files stored on a network share, use the UNC format for the path: serverpathfile name. It can't be password protected.

     Windows

     Mac

   • The flow connects to databases or publishes to a server:

     Windows

     Mac

   • The flow file or credentials file is stored on a network share (use the UNC format for the path: serverpathfile name):

     Windows

     Mac: Map the network share to /Volumes in Finder so that it is persistent, then use /Volumes/.../[your file] to specify the path:

For common errors and resolutions see Common errors when using the command line to run flows.

Run the flow with incremental refresh enabled (version 2020.2.1 and later)

If you don't have Tableau Prep Conductor enabled on your server to schedule your flow runs, you can run your flow using incremental refresh from the command line. Simply include the parameter --incrementalRefresh in your command line as shown in the example below.

Windows

Mac

If the input steps in your flow have incremental refresh enabled and the incremental refresh parameters are properly configured, Tableau Prep Builder will do the following:

• All inputs in the flow that have incremental refresh enabled will run all corresponding outputs using incremental refresh.
• If no input in the flow has incremental refresh enabled, all outputs will be run using full refresh. A message will show the refresh method details.
• If some inputs in the flow have incremental refresh enabled, the corresponding outputs will run using incremental refresh. The other outputs will be run using full refresh and a message will show the refresh method details.

For more information about configuring flows to use incremental refresh, see Refresh Flow Data Using Incremental Refresh

Command options

If you want to view the help options, include -h in the command line.

Syntax examples

The command lines below show four different examples for running a flow using the following criteria:

• Tableau Prep Builder version: 2020.3.1

  Important: The examples below include the name change for Tableau Prep version 2019.1.2 to Tableau Prep Builder. If you are using an earlier version of the product use 'Tableau Prep' instead.

• Flow name: Flow1.tfl

• Flow location: C:UsersjsmithDocumentsMy Tableau Prep Builder RepositoryFlows

• Credentials file name: Flow 1.json

• Credentials file location: C:UsersjsmithDesktopFlow credentials

• Credentials file location stored on a network share: tsi.lanfilesFlow credentials

The flow connects to and publishes to local files

Windows

Mac

The flow connects to and publishes to local files and uses the short form for incremental refresh

Windows

Mac

The flow connects to databases and publishes to a server

Windows

Mac

The flow publishes to a server and the credentials file is stored on a network share

Windows

Mac

Since macOS is based on Unix there are a number of ways to compress files and folders within the filing system using Unix based application code, below are a few options using the Terminal or command line interface (cli). The default command line application interface in macOS is the Terminal and is stored in /Applications/Utilities.

File and folder compression saves on file size and ensures the contents are captured and delivered or stored as one monolithic file. A compressed file which contains files and folders is generally referred to as an archive. Here are some built-in compression applications you can use including zip, tar, gz, bz2, gz and dmg.

ZIP – Cross Platform

First up is ZIP one of the most commonly used compression techniques used across all platforms

To compress

To extract

If you want to make a zip without those invisible Mac resource files such as “_MACOSX” or “._Filename” and .ds store files, use the “-X” option in the command so:

TAR.GZ – Cross Platform

Mysql Command Line Linux

Second up is TAR, an old favorite on Unix/Linux – you add the GZ for the compression – compresses tighter than zip

To compress

To extract

TAR.BZ2 – Cross Platform

A variation on TAR GZ but with better compression than both tar.gz and zip.

To compress

To extract

GZ

Without the tar

To extract

DMG – macOS Only

This one is macOSnative only – for a GUI interface use /Applications/Utilities/Disk Utility – for command line use:

To create

To mount

To view

To Eject

You can also use a number of different formats for creating a .dmg

• UDZO – Compressed image (default)
• UDRO – Read-only image
• UDBZ – Better compressed image
• UDRW – Read/Write image
• UDTO – DVD disk image

That’s the low down, the more common compression packages available will typically be covered in one of the above.