Dodeca GitHub Connector
Overview
The Dodeca GitHub connector provides support for reading information from GitHub using REST API. This allows for integration with GitHub data including Issues, Miliestones and more.
The Dodeca GitHub Connector is implemented as a native connector and is imported as with any other module into a given Dodeca tenant/application.
Getting Started
Using the Dodeca GitHub Connector requires importing the connector module, setting up a connection, and building a view that uses a GitHub data set.
GitHub Connection Object
The GitHub connection object has several properties, including:
- BaseUrl
-
the base URL to your GitHub application
- ApiKey
-
the API key created in GitHub that provides programmatic access to the REST API
Creating a DataSet
-
Select GitHubConnector from the ConnectorObjectTypeID drop down menu.
-
Select the DataSet you wish to configure. (Issues, Milestones, Labels, etc.)
-
Select the GitHub connection from the ConnectionID.
-
Select the parameters. (Owner and Repository Values are required)
-
Select the columns for the DataSet in the Columns Editor.
-
Test the DataSet.
Getting Started with Example Data
The example data available from Applied OLAP has a view that lists Issues. To configure it, follow these steps:
-
Import the GitHub connection module if it’s not already imported (you may need to restart your Dodeca application).
-
Import github-example.zip.
-
Configure and test the GitHub connection with your credentials and test the connection.
-
Select the GitHub Example view from Views Metadata Editor.