Package for GitHub User Load

The GitHub User Load package includes the following component:

• Integration: This integration enables the loading of GitHub users into Oomnitza. When you execute the integration, the users are imported and can be found on the People page as well as in the Users page in Software > SaaS > GitHub.
• Workflows: The workflow retrieves the GitHub user role and displays it in the Users page in Software > SaaS > GitHub. 

Contents

1. Applying the package
2. Package contents
3. Migrating the package from development to production
4. Configuring the package

Applying the package

To apply the package, complete the following steps:

1. Go to Configuration > Store
2. Locate your package and click Apply
3. Click Yes to applying the package

Result: 
Your package is added to the list in Configuration > Migrations > Packages

Package contents

The following items are in the package:

• The Integration
  • GitHub Users Load
• The Credentials
  • GitHub User Load
• The Workflow
  • GitHub SaaS Users Role

Migrating the package from development to production

If you have a development and production instance, you can migrate the package contents to your production instance by following the steps below. However, if you have a stand-alone instance or prefer to test the package in your development environment before deploying it to production, proceed to Configuring the package.

To migrate your package from development to production, complete the steps below. 

• Submit a request to Oomnitza Support to enable the migration from the development instance
• Ensure that the development and the production instances are identical
• Create an API key for the migration in your production instance
• Add the production instance and the credential name as global settings in the development instance
• Ensure that the development and production instances have the same version
• Disable configuration changes in the production  instance

Refer to Planning the migration for detailed steps.

Performing the migration

To perform the migration from development to production, complete the following steps:

1. In the development instance, click Configuration > Migrations > Migrate.
2. Click PERFORM MIGRATION.
3. As migration type, select Package.
4. Select the package.
5. Click NEXT and then click MIGRATE.

Tip
If your migration fails due to missing package contents, such as a Data model field or saved search, migrate the object as a standalone object and then attempt the migration again. 

Configuring the package

Find your package in Configuration > Migrations > Packages and click View in the Migrations page to update the following details:

Credentials 

Update the credentials that you created for GitHub by re-entering your Client ID and Secret.

For information on how to retrieve your credentials and add them to Oomnitza, refer to Adding your GitHub credentials to Oomnitza

Integration

You must update the integration details sections. 

In the Integration details section, you might want to change the value selected for Integration preferences. If this is the first time that you have run the integration, select Create & Update.  And, don't forget that you can add rules to exclude the user records that you don't want to monitor such as system users and bots. Just click Edit Integration in the Mapping details section and add your rules. 

Activate workflows

By default, the workflows in Oomnitza are switched off. To activate the workflow, complete these actions:

1. From the menu, click Configuration > Workflows and select the workflow from the list.
2. Switch the workflow to Active

Add fields to the People view

New fields that are ingested by Oomnitza may not be automatically listed on the People page.

Add new fields

1. Click People.
2. Click Add.
3. Click the Actions menu .
4. Click Screen Builder
5. Click + Add Fields.
6. Select the fields that you want to add and click ADD.
7. Click Save
8. Click List View preferences .
9. Select the fields.

Tip
If you want to add multiple new fields that are related, create a group in the screen builder and add the fields to the group. For further information see Creating Field Groups.

Related articles

For information on how to add your credentials to Oomnitza, and run the integration see GitHub.