Skip to main content

Integration guideSeal API and Scripts

Tableau

Report on selected Seal records in Tableau.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

Seal to TableauSeal API and Scripts

Seal sends
Selected Seal records
Source of truth
Seal
Set up
Scoped with your team
Neil › Operational report
draft

Bring our quality data into an operational report.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
Selected Seal records
Returns
  • Defined measures and the records behind them
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with Tableau: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Make selected Seal records available to Tableau for business-intelligence reporting through a connection set up with Seal’s API. Define each measure and its refresh schedule, and keep every figure traceable to its records.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

2Publish Seal records as a Tableau data source.

Route

Tableau’s Hyper API writes a .hyper extract file, which is then published to Tableau Cloud or Tableau Server through the REST API.⁠¹ The REST API’s Publish Data Source method publishes a new data source or appends data to an existing one.⁠² Tableau has deprecated the Web Data Connector 3.0 framework in favour of its REST API Connector, which builds extracts only and needs a JDBC driver installed.⁠³

Record identity

A publish names its data source. With overwrite set, it replaces the data source of that name; without it, the publish fails if the name exists.⁠² An upsert into a published live-to-Hyper data source matches rows on a condition you supply, so put the Seal record identifier in that condition.⁠⁴

Revisions and refresh

Each republish saves a version in the data source’s revision history on Tableau Server and Tableau Cloud, and an earlier version can be restored.⁠⁵ Tableau Cloud refreshes extracts hourly, daily, weekly or monthly, and cancels a single refresh that runs longer than 7,200 seconds.⁠⁶

When it fails

A refresh schedule stops running
After five consecutive failures, Tableau Cloud suspends a scheduled refresh until an admin or the data source owner acts. On Tableau Server, five is a default the administrator can change.⁠⁷⁸ Turn on failure emails to the data source owner, and treat the report as out of date until the schedule runs again.
Part of an update is missing
Each batch of actions in a Hyper update is atomic: one failing action discards the whole batch. A RequestID header makes the request idempotent for 24 hours, so a resend with the same ID is not applied twice.⁠⁴ Fix the failing action and resend the batch with its original RequestID.

Check one record

Publish the measures for one batch to a test data source. Check the row count and record identifiers against the Seal records in scope. Then change one record in Seal, send the update and confirm the matching row changed rather than a second row appearing.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1Tableau: Hyper API.
  2. 2Tableau REST API: publishing methods.
  3. 3Tableau: Web Data Connector.
  4. 4Tableau REST API: updating data in a published data source.
  5. 5Tableau: revision history.
  6. 6Tableau Cloud: schedule refreshes.
  7. 7Tableau Cloud: refresh failure emails.
  8. 8Tableau Server: extract refresh alerts.