Tableau Migration SDK 5.1.1
  • Articles
  • Code Samples
  • Python API Reference
  • C# API Reference
Show / Hide Table of Contents
  • SDK Terminology
  • Configuration
  • Plan Validation
  • Logging
  • Hooks
    • Custom Hooks
    • Example Hook Use Cases
    • Python Hook Update from v3 to v4+
  • User Authentication
  • Custom View File
  • Dependency Injection
  • Troubleshooting

SDK Terminology

Content Type

Content types are the various types of content that reside on Tableau Server or Tableau Cloud. For details about which content types the Migration SDK supports, see Supported Content Types. For unsupported content types, see Data not supported by the Migration SDK.

Content Item

Item of a certain content type.

Content Migration Action or Content Action

The action that migrates Content Items of a certain Content Type.

Migration Plan

A migration plan describes how a migration should be done and what customizations must be done inflight. The IMigrationPlan interface defines the Migration Plan structure. See Basic Configuration for more guidance on the Migration Plan and how to use it.

Plan Builder

This is the best way to build a migration plan. Calling the Build() method on the IMigrationPlanBuilder gives you a MigrationPlan.

Manifest

The migration manifest describes the various Tableau data items found to migrate and their migration results. See IMigrationManifest for details.

Manifest Serializer

The Migration SDK ships with a helpful serializer in both C# and Python. It serializes and deserializes migration manifests in JSON format.

Migration Status

This is simply the status of the migration. See MigrationCompletionStatus for a list of statuses.

Migration Result

This is the result generated after the migration has finished. It has two properties

  1. Manifest
  2. Migration Status

Hook

A hook is a means of modifying the standard functionality of the Migration SDK. These modifications include filtering, mapping, transforming migration content and reacting to other SDK events.

  • Edit this page
In this article