Home

DISCLAIMER

The mention of commercial products, their sources, or their use in connection with material reported herein is not to be construed as either an actual or implied endorsement of such products by the Department of Health and Human Services. This presentation reflects the views of the authors and should not be construed to represent the views or policies of the Food and Drug Administration.

---

Welcome to the GSRS Knowledge Center Wiki!

The GSRS Knowledge Center is your go-to hub for comprehensive documentation on GSRS. Here, you will discover resources designed to empower you with in-depth insights, tutorials, FAQs, and guides. Whether you are a newcomer seeking a step-by-step setup or a seasoned user looking to explore advanced features, our Knowledge Center is your compass to navigate the intricacies of our application efficiently. Dive in, explore, and unlock the full potential of our platform with confidence.

NOTE: Please find the most recent release information and public data set here: 🔗Global Substance Registration System

General

• GSRS User Manual
• GSRS REST API
  • Overview of REST API for Users: This section offers an overview of the application, its purpose, and the benefits it provides.
  • GSRS REST API Inventory
• FAQs: Compilation of frequently asked questions (FAQs) with detailed answers to address common user queries.

Administration

• Architecture Overview
• Server setup guide

• 📁Create GSRS Data Manager/Admin Level Users

Data input/output

• 📁Data Import Users Guide
• How to run scheduled jobs using curl
• How to run an export with Curl

Deployment/Installation

• Basic Installation and deployment manual
• How configuration works guide
• 📁Configuration file changes from 2.x to 3.x.docx
• Authentication and Authorization (SSO) guide
• GSRS 3 docker installation
• GSRS FrontEnd configuration guide
• Frontend microservice auto-build and options

Registration

• 📁How to do substance registration tasks in the GSRS REST API

Development

• Architecture Overview
• 📁Testing Documentation
• Authentication and Authorization (SSO) guide
• Installation of Additional Entity services guide
• GSRS Extensions
  • GSRS Extensions List
  • How To Write an Entity Processor
  • How To Write an Index Value Maker
• Guide for building the front end
• Front-end configuration settings guide
• GSRS REST API Inventory
• 📁 Guide to creating custom exporters
• 📁 Registration Tasks in the GSRS API
• Profiles in microservice pom.xml files and JDBC dependencies
• How To Access an H2 Database in Console

Miscellaneous

• GSRS Backend Login: How to Login on the Command Line
• Bulk Indexing: Create bulk indexes of text using Lucene Java libraries
• GSRS Drawing Tool: a javascript-based tool called JSDraw used for browser-based chemical drawing
• Definitional Hashes: Each substance has a definitional hash that provides a concise, machine-readable definition of the factors that make each substance unique.

---

Tip

When you open a link to a Word document within GitHub, GitHub will initially show you an empty page. Click on 'View Raw' to download the document

Tip

You can check this folder to find all the GSRS files GSRS doc folder.

Tip

Everyone on the project team is welcome to create a new page! At the top of the page, within square brackets. Also, be sure to link the page in the designated Topic and Sidebar.

The icons designate the location of the document, if outside the GitHub Wiki.

• 🔗 - For external links,
• 📁 - For GitHub documents,
• ⬇️ - For download