Add Legacy Platform ID to Organization

Overview

A Legacy Platform ID is required to create a new Organization in DOC. Any Organization created
prior to July 2020 may be missing a Legacy Platform ID, and the benefits it provides. Organization
administrators can update the Legacy Platform ID via the Organization Settings page.

Legacy Platform ID Importance

An Organization’s Legacy Platform ID provides crucial benefits:

  • Billing

    • The Legacy Platform ID associates crawl runs initiated in DOC with a specific user in Lightning
      (SaaS application), including a user’s plan and billing information. This information allows
      for more accurate tracking of Extractor use across all systems.

  • Authenticated Extractors

    • Authenticated Extractors cannot be started from DOC unless any associated Organization
      has a Legacy Platform ID
      .

    • Credentials for Authenticated Extractors are verified and stored using the Legacy Platform ID
      such that any Organization lacking this information cannot start crawl runs for Authenticated Extractors.

  • CLI Extractors

    • Extractors built with the CLI tool cannot be deployed to a specific Source unless its associated
      Organization has a Legacy Platform ID.

    • The development process for an Extractor is simplified when an Organization has a
      Legacy Platform ID, as it allows multiple users to deploy changes while ensuring all crawl runs
      (and their extractors) belong to the same user (Organization).

Add Legacy Platform ID to Existing Organization

Required insight when adding Legacy Platform ID to an Organization:

  • Sources with an Extractor that has an owner not matching the Legacy Platform ID will display
    a warning on the Source’s home page. If the owner of a Source’s extractor is different
    than the Legacy Platform ID for the Organization, crawl runs will still be started
    using the Legacy Platform ID account.
    Users with the SUPER_ADMIN role can change the owner
    of an Extractor via the Source home page as depicted below. All DOC users will encounter
    the warning if the owners do not match.

change extractor owner
  • Any new Extractors added to an Organization will have to be associated with the Legacy Platform ID.
    Deploying a CLI Extractor will require use of the Source commands for deployment, unless deployed
    by a privileged user.

  • Credentials for any Authenticated Extractors will need to be tied to the Legacy Platform ID.
    Authenticated Extractors cannot be started from DOC unless a Legacy Platform ID is set for the Organization.

  • The Legacy Platform ID can be found in Lightning (SaaS application) on the Account Settings page
    for the appropriate user.

  • Any Redshift logs will continue to reflect an Extractor’s owner ID until ownership is transferred
    to the Legacy Platform ID account.

  • To ensure that adding a Legacy Platform ID is a smooth and uneventful process, it is important
    to verify that the billing, plan, feature flags, and any other account settings for the
    Legacy Platform ID are appropriate to continuously extract and deliver data.