Data grid support in the environment manager

This document describes the scope and limitations for the migration of data grids from one environment to another using the Environment Manager tool.

This is an note/information message.

For information about how to use the Environment Manager tool, refer to the online help.

Prerequisites

Unique Identifiers

The following list details the prerequisites that need to be met to be able to use the Environment Manager to migrate data grids:

• The grids must have a UID

• The UID must be identical for the grids across all environments (i.e. Grid 1 must have the same UID in Environment A and Environment B)

The UID of the grid can be found in the k_referential_grids table of the environment database, in the uid_object column.

This is an attention message.

Objects stored in the environment database must be synchronized before they can be used in the Environment Manager. To synchronize them, use the following API method:

Service	Action	Endpoint
Gateway	POST	POST /api​/Data​/SynchronizeGrids

To make sure that items are ready to be used in the Environment Manager, make sure that you follow the steps below:

1. Align UIDs for items in the database of the environments configured in the pipeline

2. Synchronize object UIDs in the catalog database on all the environments configured in the pipeline the API method outlined above.

SQL Objects

The SQL objects related to the grids, such as tables, views, stored procedures, functions, etc., must exist in the target environment. If those SQL objects don't exist in the target environment, the Environment Manager might seem to be operating properly, but moved grids will not be functional in the target environment because of those missing SQL objects.

Grid Feature Support

The following table describes the various features related to grids in the beqom application and their level of support for the migration from an environment to another using the Environment Manager tool.

Feature	Associated Tables	Support Level	Prerequisites/Limitations
Grid properties
Grid creation	k_referential_grids k_referential_grids_fields k_referential_tables_views k_referential_tables_views_fields	Supported, with prerequisite	The source table of the grid must be created in the target environment the synchronization of the SQL objects in the environment database is performed by the Environment Manager for the table or view used by the grid The synchronization of the UID in the catalog database is performed by the Environment Manager
Grid name	k_referential_grids	Supported
Page size	k_referential_grids	Supported
Hierarchical layout	k_referential_grids	Supported
Grid width	k_referential_grids	Supported	Admin Portal only
Enable simulation	k_referential_grids Table/view of the grid New columns idSim, idOrg and typeModification added to the table of the grid	Not supported	More details will be provided by beqom at a later date about the method to use to migrate grids with simulation.
Allow user to delete/add new row	k_referential_grids	Supported
Allow user to export/import to excel	k_referential_grids	Supported
Allow user to export a template to excel	k_referential_grids	Supported
Allow auto resizing for grid fields	k_referential_grids	Supported	Admin Portal only
Allow grid to fit screen	k_referential_grids	Supported	Admin Portal only
Allow track changes	k_referential_grids xhisto table of the source table of the grid	Supported	History tables are created/updated in the target environment by the Environment Manager.
Use staging area for all imports	k_referential_grids Staging table of the grid source table	Supported	Staging tables are created/updated in the target environment by the Environment Manager.
Enable column header tooltip	k_referential_grids	Supported
Wrap column header	k_referential_grids	Supported	Admin Portal only
Folder
Grid folder	k_referential_grids k_referential_grid_folders	Supported	The full folder hierarchy is created in the target environment Grid updated with the new folder(s) when migrating
Column Configuration
Column configurations	k_referential_grids_fields	Supported
Column visibility	k_referential_grids_fields	Supported
Column associations	k_referential_grids_fields k_referential_tables_views_fields Source tables of the associations	Supported	The source tables of the associations must be created in the target environment.
Column filter field	k_referential_grids_fields	Supported
Bulk apply on grid column	k_referential_grids_fields	Supported
Add new column in an existing grid	k_referential_grids_fields	Supported
Download document from the grid	k_referential_grids_fields	Supported, with prerequisite	Configuration is migrated Uploaded files must be manually migrated
Attached objects
Parent/child grids	k_referential_grid_tab k_referential_grid_tab_field_mapping	Supported, with prerequisite	The source table of the parent and child grids must be created in the target environment When the parent grid is migrated, all of the child grids are automatically migrated as well
Forms (Admin Portal)		Not supported	Admin Portal only
Security
Grid module permissions	k_modules k_modules_rights k_profiles_modules_rights	Partially supported	Supported: The module of the grid is created The rights assigned to the module are migrated (k_modules/k_modules_rights) Not supported: The mapping between profile and module rights is not migrated (k_profiles_modules_rights)
Object security		Not supported	Object security must be manually configured Object security is not overwritten by the Environment Manager The security view must be created in the target environment
Advanced features
Conditional validation	k_referential_grid_field_validation k_referential_grid_field_validation_formula_items	Not supported
Custom stored procedures	k_referential_grids Custom stored procedures	Supported, with prerequisite	Custom stored procedures must be created in the target environment.
Grid deep link		Not supported	This feature is not supported because the grid ID is different in the source environment and in the target environment.
SQL Objects
Modifications of the source table of the grid (such as the addition of a new column in the table)	k_referential_tables_views k_referential_tables_views_fields k_referential_grids k_referential_grids_fields	Supported, with prerequisite	The source table must be manually updated in the target environment (for instance, a new column must be manually added to the table) The synchronization is done manually The xhisto table is updated by the Environment Manager
Data
User configurations, such as grid filters, grid sorting, quick filters, custom views, etc.		Not supported

This is an attention message.

beqom does not recommend that you attempt to migrate grids that use unsupported features with specific instructions from beqom. Specifically:

• Grids in which simulation is enabled

• Grids with conditional validation