<< Click to Display Table of Contents >> Navigation:  Database > Modifications > Add Custom Objects to an EQuIS Database

•Definitions –  "schema" versus the "EQuIS Schema"

 

Per the EQuIS Database Modification Compliance Requirements, database administrators can add custom database objects like the following to their EQuIS databases:

•stored procedures

•functions

•views

•tables

 

These objects can only be added within a custom schema (defined in the next section).

 

To create a customized EQuIS database object like a table. view, stored procedure, or function, follow the steps below:

1.Create a copy of the customized object within a custom schema (not within 'dbo' or 'equis'). For example, a modified copy of the standard VW_WELL view in the dbo schema (dbo.VW_WELL) could be called custom.VW_WELL_DETAILED.

2.Grant access to the appropriate users. Where custom objects are involved, consider a custom database role for these permissions, e.g., 'mycompany_readwrite' (where 'mycompany' is the name of the custom schema as well as the organization name). This separation of concern ensures that EQuIS updates will not break client customizations.

 

 

EarthSoft also recommends that additional custom fields be added to custom tables, rather than standard tables.

 

Definitions –  "schema" versus the "EQuIS Schema"

 

In this page, schema refers to the SQL Server definition of a collection that can store database objects (such as tables, views, stored procedures, and functions) and where collective permissions can be assigned.

 

Compare this definition to the "EQuIS Schema", referring to the entire structure of a standard EQuIS database. Standard schemas contained within the EQuIS Schema include the following:

•dbo (default for tables and views, deprecated stored procedures and functions)

•equis (for stored procedures and functions)

•v54 (for older EQuIS database reports)

 

The EQuIS Schema files for each module include code that updates these schema, for example, schema.Enterprise.xme in the EQuIS Professional installation's db folder. EarthSoft does not recommend modifying the standard schemas (dbo, equis, and v54) outside the terms of the EQuIS Database Modification Compliance Requirements. Such changes may affect database behavior and result in limited support.

 

Create custom database schemas for any custom database objects. A custom schema allows greater permissions for object creation without losing control over the standard dbo schema. It also lowers the risk of errors or inadvertent changes to custom tables when updating the EQuIS database to a new build. For more information, see Microsoft documentation page Create a Database Schema.