Description

This article will show you how to set up a G-Delta Configuration for your Project Version. 

  • Only one G-Delta Configuration can exist per Project Version within a Project. 
  • Only users who have been assigned the role of Org Admin or G-Delta Admin can set up G-Delta. 

The XTS Wizard has been used to set up the Project for this example. You can use other Domain import or creation methods (DDL, JSON, XSD). A few additional project setup steps may be required, click here to learn more.


In this Article


Prerequisite Steps

If you have not performed the following steps, please do so before continuing with this article.

  1. Assign the G-Delta Admin role to necessary users in your organization.
  2. Create and run a G-Repository Server (on a Linux machine)
  3. Create a config.properties (JDBC Config) file for the database JDBC connection.
  4.  (XTS Specific) Create an XTS file and use XTS Wizard. 

How to Create a New G-Delta Configuration

  • Access G-Delta for the Project Version. 
  • In the Project Dashboard, click on the G-Delta icon for the Project.



  • Select Create New G-Delta.



  • Please refer to the image and table below to fill out the provided form.

     
    #StepAdditional Details
    1Select the Project Version that G-Delta will Audit. A G-Delta must be created for each Project Version. Only one can exist per Project Version. 
    2(Optional) Change the Time Interval (hrs.)The default time interval is 24 hours, and the lowest value allowed is 12 hours.
    3Select a G-Repository Server Name.
    		If multiple G-Repository Servers have been set up by your organization, you may see many options in this drop-down menu. Make sure the right one is selected. 
    4

    Select a Resource Path.

    		The path where the config.properties file is stored.
    5(Optional) enter a Resource Subdirectory.

    		A config.properties file can be placed in a subdirectory within the resource path.
    6Please ensure the Configuration File Name is correct.
    		The default value is config.properties. It can be named differently to make identification easier and the name needs to match. 
    7
    		Select one or more G-Delta Admins who can manage the operations of a G-Delta.
    		Only users assigned the G-Delta Admin Role will appear in the drop-down list.  

    If a user with the Org Admin role will perform G-Delta admin actions, you do not need to select that user.

    8

    Select what tables will be included or excluded using the Additional Information drop-down menu option. Users can choose to:

    • Include all tables
    • Include only specific tables
    • Exclude specific tables

    An Org or G-Delta Admin can modify the G-Delta at any time and select a different option. 


    Selecting a different option here may impact the next Audit Report and the Project Version. See examples in the next section.

    9
    		Select Save to save your changes. 


  • The G-Delta Management Dashboard will appear as shown below once a G-Delta has been created: 


Additional Information Choices

This section details each Additional Info option in the G-Delta form, except for the default selection, Include All Tables.


IMPORTANT: Specify the schema for each when there are multiple schemas. Example: schema1:company, schema2:department, schema3:user.


Include Specific Tables 

Select this option if specific database tables should be part of the G-Delta for auditing. Then, provide a comma-separated list of the tables to be included. 


IMPORTANT: If other tables are currently Domains in the Project Version, you will see delete Audits within the report for those Domains. All other items in the Audit Report will be for the included tables that are part of the database schema or the Project Version.  


Example 1: 

A User database contains four tables: organization, department, user, and address. In this example, only the user and address tables are needed.



Example 2: 

A User database contains two tables: user and address. 'account' has been entered. 



This table is not part of the base database schema. The first audit report will detect the difference and recommend deleting the User and Address Domains from the Project Version. 



Exclude Tables

Select this option if specific database tables should be excluded from the G-Delta for auditing. Then, provide a comma-separated list of table names to exclude. 


IMPORTANT: The Audit Report will only contain recommended actions if the excluded tables are part of the database schema or the Project Version.


Example: 

A User database contains four tables: organization, department, user, and address. The organization and address tables should be excluded from the audit. 



The audit report will recommend deleting the Address and Organization Domain if all Domains are currently present in the Project Version.


Exclude Tables From File

This option requires each table name to be on a separate line within a CSV file. In the G-Delta configuration, provide the file path information and file name. The subdirectory is optional. 



Example File

The database schema has six tables: organization, department, user, address, hours, and rewards. The tables below are in the CSV file and will be excluded: 



Next Steps

After setting up the G-Delta, Audit Reports will be provided for detected changes at the set time interval. Reports can also be requested ad hoc. An email notification will be sent when a new Audit Report is available. 


An Org Admin or assigned G-Delta Admin can view the report and make decisions for each detected change. Please see the following articles for more information: