G-Delta is an automated platform, which allows scheduled monitoring of a database’s schema changes so that a given Project Version stays in sync with its database.
G-Delta prepares an Audit Report of any changes it finds in the database schema against the state of the Project Version. The user who created the G-Delta can review the Audit Report and execute the refactoring process, which will put the Project Version in sync with the database.
G-Delta and G-Repository work together to check and detect changes within the base Database Schema. By default, G-Delta checks for changes every 24 hours. This time interval can be changed to a minimum of 12 hours.
In This Article
- What Projects have access to G-Delta?
- When should G-Delta be used?
- Prerequisite Steps for using G-Delta
- How to set up and use G-Delta
- Step 1: Access the G-Delta Management Dashboard
- Step 2: Create a New G-Delta for a Project Version
- Step 3: Wait for an Audit Report to be Available (or Request an Audit Report)
- Step 4: Access the G-Delta Management Dashboard Again
- Step 5: Modify, Accept or Reject Items within the Audit Report
- Step 6: Accept or Reject the Audit Report
What Projects have access to G-Delta?
- Any Project that has Domains imported through the XTS Import Wizard will have the icon for accessing G-Delta.
When should G-Delta be used?
- Any time a user wants changes to be automatically detected within the base Database Schema and automatically refactored into a Project Version of a given Project.
Prerequisite Steps for using G-Delta
The following prerequisite steps will need to be completed before a G-Delta can be added to a Project:
Step 1: Create and Run a G-Repository Server
A G-Repository Server must be created and running for G-Delta to check the base Database Schema for changes.
Important: Users can only create and run a G-Repository Server on machines using the Linux or Mac operating system at this time.
Create a folder for G-Repository. This folder can have any name and be placed anywhere on the user's local machine.
Create a G-Repository Server. In a Terminal window, change the directory to match the location of the G-Repository folder. Then use the following command:
Note: For step-by-step instructions on creating a G-Repository Server, click here.
Run the G-Repository Server. Within the Terminal window, enter the following command with the path to the G-Repository folder.
genrocket -grsrvr <path to folder>
Step 2: Create Project with a default Project Version
A Project will need to be created with a default Project Version. If the Project and Project Version are already available in the web platform, this step can be skipped. To learn more about creating a Project with a default Project Version, click here.
Step 3: Create an XTS file using the base Database Schema
An XTS file will need to be created for the base Database Schema. This file will be used to import the base Database Schema into the default Project Version or another selected Project Version within a given Project. For more information on how to create an XTS file, click here.
Step 4: Import the base Database Schema using the XTS file
The generated XTS file will need to be imported into a Project Version of a given Project. Once imported, a G-Delta can be set up within the web platform for that Project and Project Version. For more information on how to import an XTS file, click here.
How to set up and use G-Delta
- Access the G-Delta Management Dashboard
- Create a G-Delta within the Project
- Wait for an Audit Report to be Available (or Request an Audit Report)
- Access the G-Delta Management Dashboard Again
- Modify, Accept, or Reject Items within the Audit Report
- Accept or Reject the Audit Report
Step 1: Access the G-Delta Management Dashboard
In the Project Dashboard, locate the Project within the Projects Pane and click on the G-Delta icon for the Project.
Step 2: Create a New G-Delta for a Project Version
Click on the Create New G-Delta button within the G-Delta Management Dashboard to create a new G-Delta. A Project Version can only have one G-Delta.
Next, select a Project Version. Only one G-Delta can be created for each Project Version of a given Project.
(Optional) Change the Time Interval (hrs). The default is 24 hours.
Select a G-Repository Server Server Name. This is the Server Name entered when the G-Repository Server was created. If more than one G-Repository Server is in use within the Organization, multiple selections will be available.
Select a Resource Path. This is the path where the config.properties file is stored.
(Optional) enter a Resource Subdirectory. A config.properties file can be placed in a subdirectory within the resource path.
Make any changes to the Configuration File Name. The default is config.properties.
Click the Save button.
Once a G-Delta has been created, the icons within the Actions Column can be used to manage a G-Delta. These icons can be used to enable/disable, edit, copy, lock, and delete a G-Delta.
Step 3: Wait for an Audit Report to be Available (or Request an Audit Report)
G-Delta checks for changes to the base Database Schema at the time interval specified within the G-Delta configuration. Audit Reports appear in the Audit Summary Table, as shown below:
An Audit Report can be requested immediately by using the Request Audit button. This process will take a few minutes to complete.
Note: To view step-by-step instructions for requesting an Audit Report, click here.
Step 4: Access the G-Delta Management Dashboard Again
When an Audit Report is available, the user will receive an email notification with a link. They can click on the link to access the G-Delta and review the Audit Report.
The user can also click on the G-Delta Icon for the Project within the Project Dashboard.
Make sure the appropriate G-Delta and Audit Report have been selected within the G-Delta Management Dashboard. Selected items are highlighted in blue.
Step 5: Modify, Accept or Reject Items within the Audit Report
Each detected change will be a line item within the G-Delta Audit Summary Details Pane. Each item within the Audit Report will have a suggested Action.
Users can perform one of three actions for each item within the Actions Column:
- Modify (Wrench Icon)- Modify the action for the Audit Report item(e.g., Add Domain, Delete Parent, etc.)
- Accept (Thumbs Up Icon)- Accept the recommended action for the Audit Report item.
- Reject (Thumbs Down Icon) - Reject the recommended action for the Audit Report item.
The G-Delta Summary Audit Detail Pane will appear as shown below once finished:
Note: To learn more about reviewing an Audit Report, click here.
Step 6: Accept or Reject the Audit Report
Within the G-Delta Summary Pane, the user will need to Accept (Refactor) or Reject the Audit Report after reviewing the Audit Details.
Click on the Refactor (Thumbs Up) icon to accept the Audit Report or the Reject All (Thumbs Down) icon to reject the Audit Report.
Accepting the Audit Report will execute the refactoring process and sync the Project Version with the database. If it is rejected, the refactoring process will not be executed.