Purpose

Introduction

The Credential Engine’s Credential Finder website (https://credentialfinder.org/) uses a batch process to import data from the Credential Registry. The source code for the import is maintained on github. The daily import uses an internal process for queuing the resources to be downloaded. The process loops through any resources in the queue, downloads the records from the Registry and imports the data into the Credential Finder database.

The project on github is set up to enable a user to search for and download data from the registry based on filters on the last modified dates (other filters are available as well) of the registry envelope. Once a resource has been downloaded, the process to import the data is the same for both work streams. Sample project to import resources from the credential registry, including:

• Identifying the steps and customization necessary to implement a local version of the credential registry import to a SQL server database.
• The primary focus is the import not to maintain an application to display the data like the Credential Finder.

2021 Note We are no longer maintaining the old version of the credential finder website in this repo.

Following is a short description of the various download options.

Import Options

There are options available for downloading registry data:

1. Download all data to a zip file - from the Credential Engine Account site organization dashboard. Requires an approved account.
2. Download the registry resources and store the JSON-LD
   1. The project may be configured to just store the registry envelopes to the file system.
   2. Or the envelope (JSON-LD payload) may be stored in a Sql Server database with simple metadata (CTID, name, description, etc. ) for each row.
3. Download the github project source code.
   1. Get the latest version of the source code.
   2. Get latest version of the database plus alter statements with any database. changes since the last release.
   3. Enables option to clone and customize for organization database(s)
4. Download the latest (compiled) release of the import project.
   1. If there are no plans to customize the import database, then the best option may be to just download the latest compiled release. Steps:
      • Get the latest release.
      • Get the latest version of the database plus alter statements with any database changes since the last release.
      • Customize the application configuration file.
      • Run the application.

Requirements

• The code base is written in Microsoft C#.net.
• The community edition of Visual Studio 2019+ is adequate to build and run the projects (import, finder, testing)
• IIS 7+ is needed to run the web project
• The project uses SQL Server as the data store. Backups are typically created using SQL server 2016+

Code Base

The code base for the import and finder can be found in GitHub: https://github.com/CredentialEngine/Import_From_Registry

Database Documentation

Jan. 17, 2023 The database documentation is now being maintained in an external google document. The latter document is currently under construction.

Next Import Configuration