Tamr Steward

Tamr Steward: Getting Started and Best Practices

Tamr Steward helps data teams be more productive by providing tools to collaboratively identify, prioritize, investigate, and resolve data issues. Read this guide to learn how to get the most out of Steward.

Get Started    

JavaScript SDK

Overview

The Steward JavaScript Widget is an easy way to add Steward to your own web app.

With a few lines of code, users of your app will be able to view and report data issues with rich, structured metadata that make it easy for you to quickly respond, diagnose, and fix the problem.

The widget appears as a button that hovers at the bottom right of the page. When users click the button the Steward UI appears and allows users to report a new issue or review ones related to the current page. Advanced UI options are also available if you need a more customized UI experience.

Reporting a data issue in an RStudio dashboard with the Tamr Steward JavaScript Widget

Reporting a data issue in an RStudio dashboard with the Tamr Steward JavaScript Widget

Getting started

To get started, have a web developer for your app add the following to your page's head tag:

<script src="https://stewardapp.io/js/v0/steward.js"></script>

This will create a window variable named tamrSteward which must be initialized via the init() function. The init function returns a Promise object once it has been initialized. Note: an error will be thrown when trying to invoke methods before the SDK has been initialized.

You can initialize the SDK and, for example, show the issue creation trigger:

tamrSteward.init().then(tamrSteward.showTrigger);

version: 0.0.1

Version

The version of the plugin

init

Initialize the Tamr Steward SDK, returning a Promise once it is initialized

destroy

Remove the plugin artifacts

openModal

Open the issue submission modal

closeModal

Close the issue submission modal

toggleModal

Toggle the issue submission modal

hideTrigger

Hides the trigger button

showTrigger

Shows the trigger button

addSource

Add a source to be added to the next issue to be reported

Parameters

source object representing a source in the form {id, name, columns:[{name, aggregation}]}

removeSourceById

Remove a source to keep it from being reported the next time an issue is submitted

Parameters

sourceId the id of the source that should be removed from the issue currently being reported

addData

Add tabular data to be added to the next issue to be reported

Parameters

data object representing a source in the form {name, columns:[{name, datatype, index}]}

removeDataByName

Remove a tabular data object by its name to keep it from being reported the next time an issue is submitted

Parameters

dataName the name of the data object that should be removed from the issue currently being reported

refreshEnvironment

Refresh the environmental information to be reported. This includes: Browser, OS, url, title, page icon.

setWorkspaceId

Set the workspace. Note: setting the workspace to one that a given user isn't a part of will cause a warning in the issue modal specifying that they are not part of the workspace

Parameters

workspaceId Id of the workspace to switch to

resetIssue

Resets the context for the issue to be submitted. Will clear any sources, datasets, and entered text and images

JavaScript SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.