Processing & Scheduling

Rapid BI Catalog allows you to generate documentation or export Tableau metadata through both a web interface and a command-line interface (CLI). Choose the method that fits your workflow and environment.

Using the UI

Step 1: Choose a Workbook Source

a. Rapid BI Catalog (Server Files)

Process workbooks stored on the server where Rapid BI Catalog is installed.

1. Select the Rapid BI Catalog tab.
2. Click Select a file or a folder.
3. Choose your output type (File or Database).
4. Optionally enable Schedule for later.
5. Click Execute now.

b. Tableau Server / Tableau Cloud

Process workbooks directly from your connected Tableau Server or Cloud environment.

1. Select the BI Server tab.
2. Choose an Environment, Site, and one or more Projects.
3. Choose workbook selection:
   • All Workbooks — process every file in the selected projects
   • Select Workbook(s) — choose specific files

4. Choose output type, then run or schedule.

c. Local Files (Upload)

Upload Tableau workbooks from your local machine for ad-hoc processing.

1. Select the Local Files tab.
2. Click Choose Files to upload .twb or .twbx files.
3. Choose output type.
4. Click Execute now.

Step 2: Choose Output Type

File(s)

Generates documentation files in one or more formats:

Database(s)

Exports metadata to a configured database for querying, governance dashboards, or analytics:

• MySQL
• MS SQL Server
• PostgreSQL

Keep Latest Option

When reprocessing workbooks that have already been processed before, you can control how existing records are handled with the Keep Latest toggle:

Real-Time Logs

A logs terminal at the bottom of the page automatically expands when processing starts. It shows real-time progress including which workbooks are being processed, extraction stages, and any errors.

Step 3: Schedule for Later (Optional)

Enable the Schedule for later toggle and configure:

How Scheduled Jobs Authenticate

Scheduled jobs run unattended, so they cannot use your personal sign-in. Tableau Server and Tableau Cloud jobs instead authenticate with the site's Service Account — a dedicated Tableau token — so a Service Account must be configured for a site before you can schedule Tableau jobs against it. Jobs that process files already stored on the Rapid BI Catalog server do not need one.

Using the CLI

The bicatalog command-line interface processes Tableau files available on the server's file system — workbooks you have downloaded or placed in a folder there. Process Tableau Server and Tableau Cloud content from the web UI, which manages Connected App authentication for you; direct command-line processing of Tableau Server / Cloud sources is not available currently.

Generate Documentation

The following must be available for the CLI command:

1. The source file storage directory
2. The desired output format
3. The destination folder for output files

Command

$ bicatalog start -s <sourcefolder> -f <outputformat> -o <outputfolder>

Example

$ bicatalog start -s /home/source -f pdf -o /home/output

Export Metadata to Database

Command

$ bicatalog start -s <sourcefolder> -f db -k <keeplatest> -o <outputfolder>

Example

$ bicatalog start -s /home/source -f db -k true

Output Folder Naming

If two Tableau workbooks have the same name but different file extensions (e.g., Superstore.twb and Superstore.twbx), the output folder names are automatically qualified to avoid conflicts:

Next Steps

• Set up the token scheduled jobs use: Service Accounts
• Manage recurring jobs: Scheduled Jobs
• Map your Tableau users: User Discovery
• Download generated outputs: Download & Upload Files
• View execution history: Logs