> For the complete documentation index, see [llms.txt](https://docs.infotopics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infotopics.com/features/management-console/tableau-sync.md).

# Tableau sync

Tableau sync brings users and groups from Tableau Server or Tableau Cloud into WriteBackExtreme, so you do not have to keep two user lists in step by hand. You pick the Tableau groups you care about, and their members arrive as WriteBackExtreme users — once, on demand, or on a schedule.

You need an administrator account to open **Tableau Sync**.

The page works in three parts, which appear in order: **Connect with Tableau**, then once a connection is verified, **Sync groups and users** and **Schedule sync**.

A synchronised user gets access to the extension, nothing more. To let somebody work in the management console as well, give them roles — by hand, or through [automatic role synchronisation](https://docs.infotopics.com/features/management-console/group-management.md#automatic-role-synchronisation) on the group.

## Connect with Tableau

Click **New** under **Tableau authentication** to add a configuration. You can add more than one, so a single WriteBackExtreme can sync from several Tableau environments at once. When somebody exists in more than one of them, they stay a single WriteBackExtreme user. Groups with the same name in different sites are prefixed with their site name, as `<site> | <group>`.

{% tabs %}
{% tab title="Tableau Server" %}
Tick **Use Tableau server** and fill in **Tableau Server domain** — the domain only, without `https://` and without slashes, for example `tableau.example-company.com`.

After a successful test you get **Select the sites you want to sync.**, with a **Select All** option. To refresh that list, test the connection again.
{% endtab %}

{% tab title="Tableau Cloud" %}
Leave **Use Tableau server** unticked and pick your **Tableau Online region** from the list. All regions work for syncing, so pick the one closest to you.

Then fill in **Authenticate for the following site** with your site name only — not the full URL. If your Tableau Cloud URL is `https://dub01.online.tableau.com/#/site/infotopicsappsfortableau`, the site name is `infotopicsappsfortableau`.

{% hint style="warning" %}
Entering the full URL here makes authentication fail.
{% endhint %}
{% endtab %}
{% endtabs %}

**Tableau API version** defaults to 3.15. Leave it unless your Tableau environment is older.

### Personal access token or username and password

Then choose how WriteBackExtreme signs in to Tableau.

* **PAT (Personal Access Token)** is the default and the one to use. Fill in **Token name** and **Token secret**, taken from a Tableau Server administrator account.
* **Username & Password** fills in a Tableau account's own credentials instead.

When your Tableau Server or Tableau Cloud signs people in through an identity provider, username and password will not work. Use a personal access token.

{% hint style="info" %}
A personal access token expires after **15 consecutive days** without use. Used more often than that, it lasts a year and then has to be replaced. A sync that suddenly stops working is usually an expired token.
{% endhint %}

Tableau secrets are encrypted before they are stored and never sent back to the browser. When you edit a configuration the secret field is empty; leave it empty to keep the stored one.

### Test, then save

Click **Test authentication** first. **Save** only becomes available once the test has succeeded, so you cannot store a configuration that does not work. For Tableau Server, pick your sites between the two.

<figure><img src="https://3247237607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0gkOLIfzuEyMP2kvoT9o%2Fuploads%2Fgit-blob-fc0f0296f680e7251bb1c62a9fe13de76032c39d%2FConsole_TableauSync_Connect.png?alt=media" alt=""><figcaption><p>A new Tableau Cloud configuration, signing in with a personal access token</p></figcaption></figure>

Read [Tableau's own documentation](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) for how to create a personal access token.

## Sync groups and users

**Sync group(s) from Tableau** lists the groups in the environments you connected. Tick the groups you want in WriteBackExtreme, click **Save**, then **Sync groups**. Members of those groups arrive as users, in the groups you selected.

{% hint style="warning" %}
Save your selection before you sync. A group that is not saved as selected is not synchronised, and a newly created Tableau group has to be selected here before it is picked up.
{% endhint %}

### What a sync changes

A run creates and updates users and groups, and it also removes. Users and groups that came from Tableau but are no longer returned by it are deleted from WriteBackExtreme at the end of the run. Users and groups you created in WriteBackExtreme yourself are never touched, because they are not linked to Tableau.

A user arriving from Tableau is blocked, rather than given a licence spot, when their Tableau site role is **Unlicensed**, or when your WriteBackExtreme licence has no spots left. Unblock them by freeing a spot and editing the user.

Roles from [automatic role synchronisation](https://docs.infotopics.com/features/management-console/group-management.md#automatic-role-synchronisation) are added during the run, never removed.

## Schedule sync

**Schedule sync** runs the synchronisation for you, so you do not need a cron job or a scheduled task. Fill in:

* **Days of week** — the days the sync may run.
* **Start time** — in 24-hour notation.
* **Interval** — **Every 3 hours**, **Every 6 hours**, **Every 12 hours** or **Every 24 hours**. We recommend no more often than every 3 hours.
* **Time Zone** — the zone the start time is read in.

<figure><img src="https://3247237607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0gkOLIfzuEyMP2kvoT9o%2Fuploads%2Fgit-blob-3c2722881d4a21c35b473f091607cc3efd9cb80f%2FConsole_TableauSync_Schedule.png?alt=media" alt=""><figcaption><p>Schedule sync</p></figcaption></figure>

Then click **Save**.

{% hint style="warning" %}
The schedule is read when the application starts, so saved changes only take effect **after a server restart**. Restart WriteBackExtreme once you have saved, or your new schedule will not run.
{% endhint %}

### Running a sync from outside

If you would rather drive the sync from your own scheduler, the command still exists:

```
artisan wbe:tableau-sync
```

Add the configuration's id to sync just that environment. On Windows this goes in the **Add arguments (optional)** field of a scheduled task; you may need the full path to `php.exe`. [Running as a service on Windows](https://docs.infotopics.com/enterprise-installation/installation-guide/getting-started/windows/run-as-a-service-on-windows) covers the surrounding setup.

The same deletion rules apply however the sync is started.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.infotopics.com/features/management-console/tableau-sync.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
