Removing a Custom Object from the beqom Rapide Data Model

Custom objects added to the beqom Rapide template data model using any of the procedures described in Extending the beqom Rapide Data Model can be removed from the Rapide template if they are no longer used. This process, known as unsynchronization, moves the custom object to the "trash" database schema, which essentially equates to deleting the object.

This article details the procedure to be followed to remove each of the custom object types.

This is an attention message.

Please keep in mind that if you do remove a custom object, any uploaded data in relation with the object will be lost. Make sure that you have the proper backups before performing this operation.

Configuring a Custom Referential Table for Removal (Unsynchronization)

To be able to unsynchronize a custom referential table, you must first configure the referential table, and then run the synchronization tool.

To configure a custom referential table for unsychronization, it must be flagged as "to be unsychronized". To do so, proceed as follows:

1. Open the (Undefined variable: CompoVariables_WA.Data), and then navigate to Data Management > Data Model > Configuration Referential > Custom Referential Tables.

2. Locate, in the grid, the row corresponding to the custom referential table that you want to unsynchronize.

3. In the grid, scroll to locate the column To Be Unsynchronized and check the box corresponding to the custom referential table row.

4. Click Save in the lower-right corner of the application window. The table is flagged as to be unsynchronized and the synchronization tool can now be run.

Validation Checks for Custom Referential Table Unsynchronization

The following table lists the validation checks performed by the system upon flagging a custom referential table for unsynchronization:

Issue	Rule	Error Message
Dependency on a computed column	The table to be unsynchronized cannot contain a synchronized computed column.	To unsynchronize referential table, please unsynchronize column <column name> in grid Computed Column first.
Dependency on an extended core payee table	The table to be unsynchronized cannot be referenced to a synchronized custom field.	To unsynchronize referential table, please unsynchronize and delete record in grid Extend Core Payee for table <table name> / column <column name>.
Dependency on an extended core payee table	The table to be unsynchronized cannot be referenced to a unsynchronized custom field.	To unsynchronize referential table, please delete record in grid Extend Core Payee for table <table name> / column <column name>.
Dependency on a table field setting	No ETL load settings can be specified for the table to be unsynchronized.	The custom referential table cannot be unsynchronized, because it is used as referential table in grid Table Field Settings for table <table name> / column <column name>.
Global Setting	A setting is blocking the unsychronization.	The custom referential table cannot be unsynchronized, cause of the Global Setting set up for Data Model Extension. In order to be able to unsynchronize the table, please first change those settings (set Value Bit for "Allow custom referential rollback" as 1 in the grid: "Global Setting Parameter Dictionary Synchronization").

Validation checks in the Custom Referential Tables grid

This is an note/information message.

To make the unsynchronization possible, you can change the global settings, the computed column configuration and the custom field configuration. However, you cannot change the columns "Referential Table Name" and "Referential Field Name" in the "Table Field Setting" grid.

In the event in which any field is referenced to the custom referential table to be unsynchronized in the grid "Table Field Setting", then the unsynchronization is not possible.

Configuring a Computed Column for Removal (Unsynchronization)

To be able to remove a computed column from the Rapide data model, you must first configure the computed column and then run the synchronization tool.

To mark the computed column as "to be unsychronized", proceed as follows:

1. Open the (Undefined variable: CompoVariables_WA.Data), and then navigate to Data Management > Data Model > Configuration Referential > Computed Column.

2. Locate, in the grid, the row corresponding to the custom referential table that you want to unsynchronize.

3. In the grid, scroll to locate the column To Be Unsynchronized and check the box corresponding to the custom referential table row.

4. Click Save in the lower-right corner of the application window. The computed column is flagged as to be unsynchronized and the synchronization tool can now be run.

Validation Checks for Computed Column Unsynchronization

The following table lists the validation checks performed by the system upon flagging a computed column for unsynchronization:

Issue	Rule	Error Message
Global Setting	A setting is blocking the unsychronization.	The computed formula cannot be unsynchronized, cause of the Global Setting set up for Data Model Extension. In order to be able to unsynchronize a formula, please first change those settings (set Value Bit for "Allow computed formula rollback" as 1 in the grid: "Global Setting Parameter Dictionary Synchronization").

Validation checks in the Computed Column grid

Configuring an Extended Payee Field for Removal (Unsynchronization)

To be able to remove an extended payee field from the Rapide data model, you must first configure the field and then run the synchronization tool.

To mark the extended payee field as "to be unsychronized", proceed as follows:

1. Open the (Undefined variable: CompoVariables_WA.Data), and then navigate to Data Management > Data Model > Configuration Extending Model > Extend Core Payee.

2. Locate, in the grid, the row corresponding to the custom referential table that you want to unsynchronize.

3. In the grid, scroll to locate the column To Be Unsynchronized and check the box corresponding to the custom referential table row.

4. Click Save in the lower-right corner of the application window. The computed column is flagged as to be unsynchronized and the synchronization tool can now be run.

Validation Checks for Extended Payee Field Unsynchronization

The following table lists the validation checks performed by the system upon flagging an extended payee field for unsynchronization:

Issue	Rule	Error Message
Global Setting	A setting is blocking the unsychronization.	The custom field cannot be unsynchronized, cause of the Global Setting set up for Data Model Extension. In order to be able to unsynchronize the custom field, please first change those settings (set Value Bit for "Allow core payee extension rollback" as 1 in the grid: "Global Setting Parameter Dictionary Synchronization").
Dependency on the hierarchy manager	The extended core payee field cannot be used in a hierarchy definition	The column <column name> cannot be unsynchronized, as it is being used in the following hierarchy(ies): <hierarchy name>

Validation checks in the Extend Core Payee grid

Unsynchronizing Objects Using the Task Launcher

Once a custom object has been marked for unsynchronization, you need to run the Task Launcher tool to actually perform the unsynchronization action and remove the object(s) from the Rapide data model.

To perform the unsynchronization of the custom object(s), proceed as follows:

1. In the object tree of the (Undefined variable: CompoVariables_WA.Data), navigate to Data Management > Data Model and then open the Task Launcher - Synchronization grid.

2. Click the Synchronize Data Model Extension row in grid. The child grid panel is opened on the Preview child grid. If the configuration of the custom objects has been properly performed in the respective grid, then the new objects, and the associated details, should be visible in this grid.

3. In the drop-down list above the child grid, select the Action child grid, as illustrated in the following figure:

4. In the Action column, select the action that you want to perform:

   • Synchronization

   • Unsynchronization

   • ALL

If you select ALL, all pending synchronization and unsynchronization operations requested for the data model will be executed. For the purpose of this procedure, select Unsynchronization.

5. In the Synchronization Type column, select the type of data model extension operation that you want to perform:

   • Core Payee Extended Column

   • Custom Referential Table

   • Referential Computed Formula

   • ALL

If you select ALL, all extensions to the data model marked as to be synchronized will be executed.

6. Click Save in the lower-right corner of the application window. Your request is saved and the action is started.

This is an note/information message.

During the unsynchronization, the Rapide system runs a number of validation steps, such as verifying that the tables don't already exist. Should any of the validation steps fail, then the next synchronization steps are not performed and the status of the task is then "Not started" in the history logs. For more information about history logs, refer to the Audit History/Logs section.

In addition, any error during the execution of any task step causes the failure of the whole synchronization process. The field "Detail Error Message" enables you to quickly identify the source of the error.

This is an note/information message.

You can refresh the grid to check the status of the action. There are three possible statuses:

• Requested

• Started

• Completed

Once the status has moved to "Completed", you can then check the results of the action in the parent grid.

Unsynchronization Results - Custom Referential Tables

The outcome of the unsynchronization action, all the tables related to any custom referential table created during the synchronization process are deleted. In addition, all information regarding the custom referential tables and their fields is removed from the Dictionary Field grid, located under Loaded Data.

Unsynchronization Results - Computed Columns

The following outcome is expected when unsycnhronizing computed columns:

• In the Dictionary Field grid, the record corresponding to the referential table and the field associated with the removed computed column was located is edited. Namely, the Computed Field Formula Custom column is now empty and the default formula is reinserted in the Computed Field Formula column.

• In the grid built based on the referential table specified in the configuration grid, values in the display_label_xxx are built according to the default formula.

• In the grid built based on the payee table, values in the column referenced to referential table specified in the configuration grid are built according to the default formula.

Unsynchronization Results - Extended Payee Fields

The following outcome is expected when unsynchronizing extended payee fields:

• The fields created in the five target grids during the synchronization process are deleted.

• The record created during the synchronization in the Table Field Setting child grid, located under Data Integration > Data Integration Settings > Table Field Setting, is deleted.

• The record created during the synchronization in the File Table Field Mapping child grid, located under Data Integration > ADF Config > File Table Field Mapping is deleted.

Audit History/Logs

"History" Grid

This is an note/information message.

Applicable to all object types.

The history of synchronization tasks is available under Data Management > Data Model > Task Launcher - Synchronization, in the History child grid of the task launcher parent grid.

The following table details all the fields available in the "History" grid:

Field Name	Field Description
Synchronization	Name of the user who started the action and date of execution.
Type	Type of data model extension: Custom Referential Table Referential Computed Formula Core Payee Extended Column
Status	Status of the action: NOT STARTED STARTED COMPLETED
Result	Result of the execution: EXECUTED WITH NO ERROR EXECUTED WITH ERROR
Start Date	Unsynchronization start date
End Date	Unsynchronization end date
Task Name	Name of the task executed during the synchronization: Validation Rules Check/Unsynchronize Custom Referential Table Validation Rules Check/Unsynchronize Computed Field Formula Referential Validation Rules Check /Unsynchronize Additional Column Payee Table/ Updated Associated Objects
Task Object	Name of the object on which the task is executed (custom referential table, computed column or extended payee field)
Task Status	Status of the current task NOT STARTED STARTED COMPLETED
Task Result	Result of the task EXECUTED WITH NO ERROR EXECUTED WITH ERROR
Detail Name	Details related to the steps of the task. See individual details for each object type in the sections below.
Detail Object	Name of the object on which the task step is performed.
Detail Status	Status of the step: NOT STARTED STARTED COMPLETED
Details Result	Execution result of the task step: EXECUTED WITH NO ERROR EXECUTED WITH ERROR
Detail Is Error	Flag applied in case an error occurred during the execution of the task step.
Detail Error Message	Custom error message related to any error encountered during the execution of the task step. Please note that there is no static list of error messages. The messages are dynamically generated using a function that checks the SQL syntax and then indicates the specific error.

History grid fields

Custom Referential Table History

When a custom referential table is unsynchronized from the Rapide data model, the system runs a series of tasks that are detailed in the unsynchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Unsynchronize Custom Referential Table	MOVE TABLE from custom_core to trash
	MOVE TABLE from custom_core_staging to trash
	MOVE TABLE on custom_core_error to trash
	MOVE TABLE on custom_core_archive to trash
	Update Dictionary
	Update Config Referential Table

Custom referential table task details

Computed Column History

When a computed column is unsynchronized from the Rapide data model, the system runs a series of tasks that are detailed in the unsynchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Unsynchronize Custom Referential Table	DROP COLUMN computed formula
	ADD COLUMN computed formula
	Update Dictionary
	Update Config Referential Table

Computed column task details

Extended Payee Field History

When an extended payee field is unsynchronized from the Rapide data model, the system runs a series of tasks that are detailed in the unsynchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Unsynchronize Custom Referential Table	DROP COLUMN core_extended
	DROP COLUMN core_staging
	DROP COLUMN core_error
	DROP COLUMN core_archive
	DROP COLUMN core_shared.payee_situation
	Update Dictionary
	Update Config Referential Table
Updated Associated Objects	Updated Associated Shared View
	ALTER PROCEDURE Payee Situations

Extended payee field task details

Task Launcher - Synchronization Grid

This is an note/information message.

Applicable to all object types.

The Task Launcher - Synchronization grid ((Undefined variable: CompoVariables_WA.Data) > Data Management > Data Model) offers collective information related to the unsynchronization process, specifically:

• Unsynchronization start time

• Unsynchronization end time

• Unsynchronization execution status

• Unsynchronization execution result

• First name and last name of the user who requested the action

• Request date

Custom Referential Tables Grid

This is an note/information message.

Applicable only to custom referential tables and computed columns.

The Custom Referential Tables grid ((Undefined variable: CompoVariables_WA.Data) > Data Management > Data Model > Configuration Referential) offers the following historical information:

• Record update date and time

• First name and last name of the user who updated the record

• Date and time of the last synchronization

• Status of the last unsynchronization (success/failure)

This is an note/information message.

If the unsynchronization was successful, then the "Is Synchronized" column and the "To Be Synchronized" column are unchecked.

In the event of a failure of the unsynchronization, the "Is Synchronized" column and the "To Be Synchronized" column remain checked.

Extend Core Payee Grid - Data Child Grid

This is an note/information message.

Applicable only extended payee fields.

The Data child grid of the Extend Core Payee grid, located under (Undefined variable: CompoVariables_WA_Alternate."Data") > Data Management > Data Model > Configuration Extending Model, offers the following historical information:

• Record update time

• First name and last name of the user who last updated the record

• Date of the last unsynchronization

• Synchronization status (success/failure)

This is an note/information message.

If the unsynchronization was successful, then the Is Synchronized column and the To Be Synchronized column are unchecked.

In the event of a synchronization failure, the Is Synchronized column and the To Be Synchronized column remain checked.

Limitations After Unsynchronization

Limitations Related to Custom Referential Tables

Once a custom referential table has been unsynchronized, some actions can no longer be performed, as detailed in the following table:

Action	Rule	Error Message
"To be unsynchronized" flag status change	The "To be unsynchronized" flag cannot be checked if the table has not yet been synchronized.	To be unsynchronized check box can not be ticked, while the custom referential table has not been synchronized yet!!

Custom referential table limitations after unsynchronization

Limitations Related to Computed Columns

Once a computed column has been unsynchronized, some actions can no longer be performed, as detailed in the following table:

Action	Rule	Error Message
"To be unsynchronized" flag status change	The "To be unsynchronized" flag cannot be checked if the computed column has not yet been synchronized.	To be unsynchronized check box can not be ticked as Computed Formula has not been synchronized yet!

Computed column limitations after unsynchronization

Limitations Related to Extended Payee Fields

Once a computed column has been unsynchronized, some actions can no longer be performed, as detailed in the following table:

Action	Rule	Error Message
"To be unsynchronized" flag status change	The "To be unsynchronized" flag cannot be checked if the field has not yet been synchronized.	To be unsynchronized check box can not be ticked while the custom field has not been synchronized yet!

Extended payee field limitations after unsynchronization