Prajwal214 90e7496e53
Docs: Fixing connector Docs for MicroStrategy (#18538)
* Docs: Fixing connector Docs for MicroStrategy

* Update index.md

---------

Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
2024-11-08 12:19:57 +05:30

3.5 KiB

title slug
Run the MicroStrategy Connector Externally /connectors/dashboard/microstrategy/yaml

{% connectorDetailsHeader name="MicroStrategy" stage="PROD" platform="OpenMetadata" availableFeatures=["Dashboards", "Charts", "Owners", "Datamodels", "Lineage"] unavailableFeatures=["Tags", "Projects"] / %}

In this section, we provide guides and references to use the MicroStrategy connector.

Configure and schedule MicroStrategy metadata and profiler workflows from the OpenMetadata UI:

{% partial file="/v1.6/connectors/external-ingestion-deployment.md" /%}

Requirements

To integrate MicroStrategy, ensure you are using OpenMetadata version 1.2.x or higher.

Python Requirements

{% partial file="/v1.6/connectors/python-requirements.md" /%}

To run the MicroStrategy ingestion, you will need to install:

pip3 install "openmetadata-ingestion[mstr]"

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to MicroStrategy.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

1. Define the YAML Config

This is a sample config for MicroStrategy:

{% codePreview %}

{% codeInfoContainer %}

Source Configuration - Service Connection

{% codeInfo srNumber=1 %}

  • Username: Username to connect to Mstr, e.g., user@organization.com. This user should have access to relevant dashboards and charts in Mstr to fetch the metadata.

{% /codeInfo %}

{% codeInfo srNumber=2 %}

  • Password: Password of the user account to connect with Mstr.

{% /codeInfo %}

{% codeInfo srNumber=3 %}

For example, you might set it to https://org.mstr.com:3000.

{% /codeInfo %}

{% codeInfo srNumber=4 %}

  • Project Name: The name of the project within Mstr that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.

{% /codeInfo %}

{% partial file="/v1.6/connectors/yaml/dashboard/source-config-def.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink-def.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config-def.md" /%}

{% /codeInfoContainer %}

{% codeBlock fileName="filename.yaml" %}

source:
  type: mstr
  serviceName: local_Mstr
  serviceConnection:
    config:
      type: Mstr
      username: username
      password: password
      hostPort: http://hostPort
      projectName: project

{% partial file="/v1.6/connectors/yaml/dashboard/source-config.md" /%}

{% partial file="/v1.6/connectors/yaml/ingestion-sink.md" /%}

{% partial file="/v1.6/connectors/yaml/workflow-config.md" /%}

{% /codeBlock %}

{% /codePreview %}

{% partial file="/v1.6/connectors/yaml/ingestion-cli.md" /%}