BulkPro allows users to generate documentation or export metadata from Tableau workbooks. Users can select Tableau files from three different sources: RapidDox Server, Tableau Server, or Local Files. The processed data can be saved as files (PDF, DOCX, HTML, EXCEL, CSV) or stored in a database.


TABLE OF CONTENTS



Using UI

Choosing Workbooks Source 


1. RapidDox Server 

Process workbooks stored on the server where RapidDox is installed. You can either select a folder or a single file. 

  • Select the RapidDox Server tab 
  • Click Select a workbook or a folder to browse and select the input file(s). 
  • Choose an Output Type: 
    • File(s): Saves the output as a document. 
    • Database: Stores the metadata in a configured database (if available). 
  • Optionally, enable Schedule for later to execute the job at a specific time. 
  • Click Execute now to start processing. 


 

2. Tableau Server 

This option allows you to select workbooks directly from your Tableau Server. You need to choose a site and a project from the available options. You can either process all workbooks within the selected project or manually choose specific ones. 

  • Select the Tableau Server tab 
  • Choose a Site and Project from the dropdown menus. 
  • Choose a workbook selection method: 
    • All Workbooks to process every file in the project 
    • Select Workbook(s) to choose specific files 
  • Choose an Output Type: 
    • File(s): Saves the output as a document. 
    • Database: Stores the metadata in a configured database (if available). 
  • Optionally, enable Schedule for later to execute the job at a specific time. 
  • Click Execute now to start processing. 



3. Local Files 

You can select Tableau workbooks from your local system for processing. You simply have to choose the files you want to process. 

  • Select the Local Files tab 
  • Click Choose Files to upload the desired workbooks. 
  • Choose an Output Type: 
    • File(s): Saves the output as a document. 
    • Database: Stores the metadata in a configured database (if available). 
  • Click Execute now to start processing. 



Choosing Output Type 

1. File(s) 

  • HTML  
  • PDF 
  • DOCX 
  • EXCEL 
  • CSV 


2. Database(s) 

  • MySQL 
  • MSSQL 
  • PostgreSQL 


When reprocessing the same Workbooks, users have the flexibility to overwrite existing records or keep them. For this, users can use the Keep Latest option 

  • Selecting it will delete previous output records for the file and generate only the new ones. 
  • Not selecting it will mark previous records as outdated (latest = false) while new records are created with latest = true, allowing you to track historical changes. 



Scheduling Options

The scheduling feature allows you to automate the execution of processing jobs at a specified time. This is useful for recurring documentation and metadata export tasks, reducing manual effort and ensuring consistency. 


  • Job Title – Assign a name to your scheduled job for easy identification. 
  • Schedule Timing – Set the exact date and time when the job should run. 
  • Schedule Frequency – Configure how often the job should be repeated (e.g., daily, one-time or on a specific weekday). 


Note:
 
I. For the Local Files option, job scheduling is not directly possible, as the files must be available on the server at the time of execution.Therefore, if you want to schedule files from your PC, it is recommended to first upload them to the server and then create a batch job using the RapidDox Server option.

You can use the Upload Files page for uploading local Tableau workbooks.

II. The jobs will be executed based on the time zone set by the user. This can be set on the Settings page.



Using CLI

CLI command to generate documentation in PDF, MS Word, HTML, Excel, and CSV


The below information is required in order to pass parameters to BulkPro:

1. The source file storage directory

2. The desired output format

3. The destination folder for copying the output files


As simple as that.


rapiddox start -s <<sourcefolder>> -f <<outputformat>> -o <<outputfolder>>


ParameterDescription
-s <<sourcefolder>>

Full path to the source folder that contains the input Tableau files.

-f <<outputformat>>

You can generate various documentation and export metadata in various formats.

Document output options:  pdf | html | excel | csv | docx | all

-o <<outputfolder>>

The full path of the output folder into which the output files are to be created



ExampleS

 

To generate documentation in PDF format for all the twb/twbx files located in the /home/source folder and save it to the /home/output folder, you can use the following command:

 

rapiddox start -s /home/source -f pdf -o /home/output


 

To generate documentation in HTML format, you can use the same command with the following parameters:


rapiddox start -s /home/source -f html -o /home/output

 


CLI command to export metadata to a database


You must configure database connections in BulkPro before you export metadata.  Please visit the KB page on configuring databases.



Once you've configured your preferred database connections in BulkPro, you can utilize the "rapiddox start" command with the following set of parameters to process source files and export the resulting metadata to the database. Below is the syntax for the start command.


rapiddox start -s <<sourcefolder>> -f db -d <<databasetype>> -k <<keeplatest>> -o <<outputfolder>>


ParameterDescription
-s <<sourcefolder>>

Full path to the source folder that contains the input Tableau files.

-f <<outputformat>>

To export metadata to a database, you must use db as the parameter value.

-d <<databasetype>>

You must pass on the type of database in this parameter.

Options: mysql | mssql | postgres

-k <<keeplatest>>

When reprocessing previously handled source files, you have the choice to either overwrite existing records in the target database or retain them.


Selecting "true" as the option will result in the deletion of output records related to this file from previous runs, with only the output records from the current run being generated.


On the other hand, by choosing "false" as the option, the target database column named “latest” for all the output records pertaining to this file from the previous runs will be updated to false, and the output records from this run will be created with the “latest” column value as true.  This is to help you keep track of the historical changes in the source files.


 

Examples

 

Exporting to a MySQL database

rapiddox start -s /home/rapiddox/source -f db -d mysql   -k true

 

Exporting to a MS SQL database

rapiddox start -s /home/rapiddox/source -f db -d mssql   -k false


Exporting to a Postgres database

rapiddox start -s /home/rapiddox/source -f db -d postgres  -k true



Note: If two Tableau workbooks have the same name but different extensions (e.g. Superstore.twb and Superstore.twbx, the output folder names will include the extension type to differentiate them.

Normal case:
    Superstore-05022025-113105 

When both .twb and .twbx exist:
    Superstore-TWB-05022025-113105
    Superstore-TWBX-05022025-113105