Extending the beqom Rapide Data Model

The beqom Rapide template comes prepackaged with a standard data model designed to fit most of the needs of the companies who use the beqom Total Compensation Management solution. However, in certain cases, additional fields or tables might be required if the standard data model does not cover all the HR information in a system. In this event, it is possible to customize the data model. This customization, known as data model extension, can be performed three different ways:

Via custom referential tables
Via computed columns
Via extended payee fields

This is an note/information message.

Data model extension scenarios can affect each other. For instance, consider the case where a custom reference table is created, then a custom formula is added for a computed column within the custom reference table and then a payee field is created and referenced to the custom reference table, thus creating a dependency between the objects. All the changes performed to the model are reflected in the data load settings and file mapping. The unsynchronization of one of those objects could be problematic because of the dependencies. To mitigate this risk, the beqom Rapide template is equipped with a number of validation mechanisms to keep the data model internally consistent with the ETL solution.

Among those mechanisms are error messages designed to guide the user thought the steps to take in order to perform the synchronization/unsynchronization of custom objects.

In addition, the synchronization history helps users locate the source of any errors and correct them.

This is an attention message.

beqom recommends that you configure the Rapide task scheduler before making any customization of the Rapide data model. The task scheduler is the mechanism that is responsible for automatically running the stored procedure that synchronizes/unsynchronizes custom objects in the Rapide data model.

For more information about the configuration of the task scheduler, refer to Setting up the Task Scheduler for the Rapide Data Model.

The following diagram summarizes the data model extension principle:

The following diagram illustrates the relationship between the custom objects that can be used to extend the data model:

Adding a Custom Referential Table to the Rapide Data Model

Aside from payee tables, referential tables are at the core of the beqom Rapide data model. The model is build in with a relationship between the payee tables and the referential tables that prevents the extension of payee tables with data that do not exist in the referential tables. In order to bypass this mechanism, it is possible to add custom referential tables, in addition to the core referential tables, using an application tool. This tool must be used to extend the standard data model.

When extending the standard data model, custom referential tables are used to ensure that specific data is entered in custom fields through the definition of a relationship between the custom field and the new table. This operation is performed by first configuring the referential table and then running the Task Launcher tool to synchronize the table.

To create and configure the new referential table in the Rapide data model, proceed as follow:

Open the Web App interface of the beqom TCM solution, and then navigate to the (Undefined variable: CompoVariables_WA.Data).
In the object tree on the left, open Custom Referential Tables grid, located under Data Management > Data Model > Configuration - Referential.
Click Add a Row in the lower-left corner of the grid panel. A new row is added to the grid.
Enter the information related to the new table in the respective fields of the grid.
Click Save in the lower-right corner of the application window. Rapide creates the table and adds it to the proper structure in the object tree of the (Undefined variable: CompoVariables_WA.Data).

Validation Checks for Custom Referential Tables

The following table outlines the validation checks performed by the system upon saving a newly created custom referential table in the Custom Referential Tables grid.

Validation Check	Validation Rule	Error Message
Table Name	The name of the table must be unique.	Table Name is already used. Please provide unique "Table Name".
	The name of the table must start with the "ref_" prefix	Table Name for referential tables should always starts with "ref_" prefix!
	The name of the table cannot exceed 50 characters	Table Name should have no more than 50 characters!
	The name of the table can only contain alphanumeric characters	Table Name should not contain space, special characters or numeric!
To be Unsynchronized	The "To Be Unsynchronized" flag cannot be checked if the table has not yet been synchronized	When adding a row: "To be unsynchronized check box can not be ticked while adding a new table!" When editing a row: "To be unsynchronized check box can not be ticked, while the custom referential table has not been synchronized yet!"

Validation checks in the Custom Referential Tables grid

Adding a Computed Column to the Rapide Data Model

The beqom Rapide data model enables you to load data in most of the columns in the data model, but that might be insufficient in certain cases. In order to expand the standard data model of the Rapide template, you can create computed columns. Whereas a custom referential table will enable you to load data for a certain dimension, computed columns use an expression to calculate the values in the column. Computed columns can be created in all referential tables and are named according to the following convention: display_label_xxx, where "xxx" corresponds to the name of the referential table (without the "ref_" prefix).

By default, computed columns are built by concatenating the code_xxx column and the short_name_xxx column. The beqom Rapide template however offers a tool that enables you to change the default formula for computed columns. This way, you can decide which values are displayed in the referenced fields in the target payee grids (under Loaded Data > Loaded Data Payee) and in the Payee Situation grid.

It is possible to see in this grid the values coming from computed columns because of the association between payee IDs and referential IDs.

The addition of computed columns to the beqom Rapide standard data model is done first by configuring the column, and then by synchronizing the new object.

To configure a new computed column, proceed as follows:

Open the (Undefined variable: CompoVariables_WA.Data) of beqom Web App, and then navigate to Data Management > Data Model > Configuration Referential > Computed Column.
Click Add a Row in the lower-left corner of the grid panel. A new row is added to the grid.
In the Table Name column, select the table to which you want to add the computed field in the drop-down list.
In the Computed Field Name column, select the name of the computed column.

This is an note/information message.

Each referential table in the beqom Rapide data model, including custom referential tables, comes with a computed column called display_label_xxx ("xxx" being the name of the table). As of the redaction of this document, each table can only contain one computed column.

This is a tip message.

The Computed Field Name column is a cascading field whose content depends on the selection made in the Table Name column. Your selection in the Table Name column will filter out the contents of the Computed Field Name list to only the choices corresponding to the selected table. Since each table can only contain one computed column, the drop-down list in the Computed Field Name column can only contain one value.

In the Computed Formula column, enter the formula to be used to calculate the value of the computed column. By default, the system concatenates "code" and "short name"; you can however change that formula to your needs, using a SELECT SQL statement.
Check the box in the To be Synchronized column if you want to immediately mark the computed column for synchronization. You can however leave the box empty and flag the new item for synchronization at a later date.
Click Save in the lower-right corner of the application window.

Validation Checks for Computed Columns

The following table outlines the validation checks performed by the system upon saving a newly created computed column in the Computed Column grid.

Validation Check	Validation Rule	Error Message
Unique table name and field name pair	You cannot provide two records with the same table name and field name pair. This is to avoid a situation where two different formulas could be defined for the same computed field.	Combination of "Table Name" & "Computed Field Name" should be unique for each row!
"To be Unsynchronized" flag check	The "To be Unsynchronized" column cannot be checked when the row is added to the grid, because the new computed column has not been synchronized yet.	When adding a row: "To be unsynchronized check box can not be ticked while adding a new Computed Formula!" When editing a row: "To be unsynchronized check box can not be ticked as Computed Formula has not been synchronized yet!"
SQL syntax check	The syntax of the formula for the computed column needs to be correct. It is part of the code used for the creation of referential tables and has to be written in accordance with the SQL syntax rules.	The error message displayed in the event of a syntax error depends on the type of error. The syntax is analyzed and the application will return an error message with the specific syntax issue.

Validation checks in the Computed Column grid

Adding an Extended Payee Field to the Rapide Data Model

Payee tables are at the core of the beqom Rapide data model, aside from referential tables. In case a payee field is entirely missing from the data model, is then possible to add the required fields to the core payee tables using an application tool.

The addition of extended payee fields is done first by configuring the extended payee field, and then by running the synchronized tool.

To add a new extended payee field to the Rapide data model, proceed as follows:

To configure a new computed column, proceed as follows:
Open the (Undefined variable: CompoVariables_WA.Data) of beqom Web App, and then navigate to Data Management > Data Model > Configuration Extending Model > Extend Core Payee.
In the grid, locate the row corresponding to the core payee table to which you want to add a payee field. A child grid called Data is opened.
Click Add a Row in the lower-left corner of the child grid panel. A new row is added to the grid.
Enter all the information regarding the new payee field.

This is an attention message.

When you're creating an extended payee field, make sure that you carefully consider the type of data that you want to load into the new column. The data type you choose will determine the success of failure of the data load. For more information about data types, refer to the table below.

Check the box in the To be Synchronized column if you want to immediately mark the computed column for synchronization. You can however leave the box empty and flag the new item for synchronization at a later date.
Click Save in the lower-right corner of the application window.

The following table describes the data types available to you when adding an extended core payee field and the situations in which they should be used:

Data Type	Field Type
Text	char nchar varchar nvarchar
Integer	smallint int bigint
Numeric	Decimal Numeric
Bit	Bit

Extended payee field data types

Validation Checks for Extended Payee Fields

The following table outlines the validation checks performed by the system upon saving a newly created extended payee field in the Extend Core Payee grid.

Validation Check	Rule	Error Message
Unique field name	The name of the field must be unique (i.e. there must not exist any other field with the same name in the database), with the exception to fields referenced to a referential table. In that specific case, the referenced field and the referencing field can have the same name.	Field Name is already used. Please provide unique "Field Name".
Field name prefix	Field name of referencing fields must start with the "id_" prefix.	Field Name for referenced custom fields should always start with "id_" prefix!
Field name limitation	The name of the field cannot contain spaces, special characters or numbers.	Field Name should not contain space, special characters or numeric!
"To be Unsynchronized" flag check	The "To be Unsynchronized" column cannot be checked when the row is added to the grid, because the new computed column has not been synchronized yet.	When adding a row: "To be unsynchronized check box can not be ticked while adding a new field!" When editing a row: "To be unsynchronized check box can not be ticked while the custom field has not been synchronized yet!"
Fields other than "text" fields	The "Number of Characters" column cannot be filled for all data types other than "text".	Number of characters should not contain any value, once selected data type is not a text!
Fields other than "text" fields	The "Allow Max Characters" column cannot be filled for all data types other than "text".	The "Number of Characters" columns cannot be filled for all data types other than "text".
Fields other than "numeric" fields	The "Numeric Scale" column cannot be filled for all data types other than "numeric".	Numeric Scale should not contain any value, once selected data type is not numeric!
Fields other than "numeric" fields	The "Numeric Precision" column cannot be filled for all data types other than "numeric".	Numeric Precision should not contain any value, once selected data type is not numeric!
Numeric field limitation	The value in the "Numeric Scale" column must be lower than or equal to the value of the "Numeric Prevision" column.	Numeric Scale should be less or equal to a Numeric Precision!
Numeric field limitation	The "Numeric Scale" column is mandatory for "numeric" fields.	data type numeric. Numeric Scale can not be empty, once selected data type is a numeric!
Numeric field limitation	The "Numeric Prevision" column is mandatory for "numeric" fields".	Numeric Precision can not be empty, once selected data type is a numeric!
Numeric field limitation	The value in the "Numeric Precision" column must be within the range defined in the application configuration.	Numeric Precision should be a number between <min value> and <max value>!
Text field limitation	If the maximum length allowed by the field is not used, then a value must be provided in the "Number of Characters" column.	Number of characters can not be empty, once "Allow Max characters" is not ticked!
Text field limitation	The "Number of Characters" column must not be filled if the maximum length of the field is used.	Number of characters should not contain any value, once "Allow Max characters" is ticked!
Text field limitation	The value in the "Number of Characters" column must be withing the range defined in the application configuration.	Number of characters should should be a number between <min value> and <max value>.
Text field limitation (char/nchar)	The "Allow Max Characters" box cannot be checked for this type of field.	Field "Allow Max Characters" cannot be completed, if data type “char” or 'nchar” was selected.
Referenced field limitation	Fields referenced to a payee table can only be "int" fields.	Is Payee Referenced Field? should not be ticked, once selected data type is not "int"!
Referenced field limitation	Fields referenced to a dimension referential table can only be "int" fields.	Is Dimension Referenced Field? should not be ticked, once selected data type is not "int"!
Referenced field limitation	No referential table must be selected for fields that are not supposed to be referenced to a dimension referential table.	Referential Table should not contain any value, once "Is Dimension Referenced Field?" checkbox is not ticked!
Referenced field limitation	A referential table must be selected if the field is supposed to be referenced to a dimension referential table.	Referential Table can not be empty, once "Is Dimension Referenced Field?" checkbox is ticked!
Reference limitation	Only payee tables or dimension referential tables can be referenced.	Only one check box : Is Dimension Referenced Field? or Is Payee Referenced Field? can be selected at the same time.
Referential table limitation	The "Referential Table" field must be empty if the field type is any other than "int".	Referential Table should not be selected, once selected data type is not "int"!

Synchronizing Custom Objects in the Rapide Data Model

Once a new custom object, be it a custom referential table, a computed column or an extended payee field, has been configured and flagged for synchronization, it needs to be synchronized in the system. This operation is performed in the "Task Launcher - Synchronization" grid, available under Data Management > Data Model.

To synchronize a custom object in the Rapide data model, proceed as follows:

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.
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.
In the drop-down list above the child grid, select the Action child grid, as illustrated in the following figure:

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 Synchronization.

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.

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 synchronization, the Rapide system runs a number of validation steps, such as verifying that the tables don't already exist or that any formula for computed columns are valid. 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 theAudit 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 a tip 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 transitioned to Completed, you can then check the results of the action in the parent grid.

Synchronization Results - Custom Referential Tables

Once the synchronization operation is complete, the system will have created four new referential tables and three grids for each new custom referential table in the (Undefined variable: CompoVariables_WA.Data):

Actual custom referential table, which contains the referential data, and corresponding grid
Staging table, used for ETL purposes, and corresponding grid
Error table. No corresponding grid is created for this table. It is however possible to review any errors that occurred during the data load in the under Data Integration > Data Load Summary, in the Error child grid, which contains information about errors related to all the referential tables.
Archive table used for ETL purposes, and corresponding grid

The Rapide template creates each of these tables and grids according to a predefined pattern, with predefined fields, as detailed in the following table ("XXX" corresponds to the custom referential table name that was declared when creating each custom referential table):

	Schema Name (Table)	Table Name	Table Category	Table Field Count	Grid Location (Folder)	Grid Naming Convention	Grid Field Count
Referential (target)	custom_core	ref_xxx	Referential	14	Loaded Data > Loaded Data Ref	Ref XXX	11
Staging	custom_core_staging	ref_xxx	Referential	12	Data Integration > Staging > Staging Ref	Staging ref XXX	9
Error	custom_core_error	ref_xxx	Referential	14	-	-	-
Archive	custom_core_archive	ref_xxx	Referential	14	Data Integration > Archive > Archive Ref	Archive ref XXX	14

Custom referential table pattern

The following tables detail the fields available in the tables and grids related tothe new custom referential table:

custom_core Table Fields	Referential (Target) Grid Fields
id_xxx
id_data_load
insert_time
insert_type	Insert type
code_xxx	Code XXX
short_name_xxx	Short name XXX
long_name_xxx	Long name XXX
description_xxx	Description XXX
id_parent_xxx	ID parent XXX
code_parent_xxx	Code parent XXX
group1_xxx	Group1 XXX
group2_xxx	Group2 XXX
group3_xxx	Group3 XXX
display_label_xxx	Display label XXX

Custom ref table fields

custom_core_staging	Staging Grid Fields
id_xxx_staging
id_data_load
insert_time
insert_type	Insert type
code_xxx	Code XXX
short_name_xxx	Short name XXX
long_name_xxx	Long name XXX
description_xxx	Description XXX
code_parent_xxx	Code parent XXX
group1_xxx	Group1 XXX
group2_xxx	Group2 XXX
group3_xxx	Group3 XXX

Staging table/grid fields

custom_core_error
id_xxx_error
id_data_load
insert_time
insert_type
id_xxx_staging
error_message
code_xxx
short_name_xxx
long_name_xxx
description_xxx
code_parent_xxx
group1_xxx
group2_xxx
group3_xxx

Error table fields

custom_core_archive	Archive Grid Fields
id_xxx_archive	ID XXX archive
id_xxx	ID XXX
id_data_load	ID data load
insert_time	Insert time
insert_type	Insert type
code_xxx	Code XXX
short_name_xxx	Short name XXX
long_name_xxx	Long name XXX
description_xxx	Description XXX
code_parent_xxx	Code parent XXX
group1_xxx	Group1 XXX
group2_xxx	Group2 XXX
group3_xxx	Group3 XXX
display_label_xxx	Display label XXX

Archive table/grid fieldS

This is an note/information message.

Note that there exist field mappings, i.e. equivalents, between the four tables. For instance, the "code_xxx" field exists in the "custom_core", "custom_core_staging", "custom_core_error" and "custom_core_archive" tables.

Synchronization Results - Computed Columns

Once the synchronization operation is complete, the following results are observable for computed columns.

Dictionary Fields Grid

The formula provided by the user is now available in the Computed Field Formula Custom and Computed Field Formula of the Dictionary Fields grid for the referential grid indicated during the configuration step.

Referential Grid

Values in the display_label_xxx column are created according to the formula provided in the configuration grid.

Payee Grid

Values in the payee columns referenced to the referential tables are created according to the formula provided in the configuration grid

Please consider the following example using the "ref_country" table as an example:

Code country	Short name country	Long name country	Display label country - default formula	Display label country - default	Display label country - custom formula	Display label country - custom
UK	United Kingdom	United Kingdom of Great Britain and Northern Ireland	concat([code_country],' - ',[short_name_country]))	UK - United Kingdom	(concat([code_country],' - ',[long_name_country]))	UK - United Kingdom of Great Britain and Northern Ireland

Synchronization Results - Extended Payee Fields

Once new extended core payee fields have been synchronized in the Rapide data model, a new field is created in 5 grids (corresponding to the core payee table you originally decided to expand) for each new extended payee field:

Target
Staging
Error
Archive
Payee situation

Synchronization results vary depending on the configuration applied to the new field, as outlined in the following sections.

Unreferenced Field - All Tables Except payee_compensation

This is the most simple case when it comes to extended payee fields. In this case, any grid fields created are given the name you provided at the time you added the field, with the difference that underscores are replaced with spaces in grid field names.

Since these fields are not referenced, any value can be provided for them during the data load.

Consider the following example:

Payee table name: "payee_job_assignment"
Field name: "location_factor"

In that case, new fields are created as follows:

Grid	Grid Field
Payee Job Assignment	Location Factor
Staging Payee Job Assignment	Location Factor
Error Payee Job Assignment	Location Factor
Archive Payee Job Assignment	Location Factor
Payee Situation	Location Factor

Synchronization results for unreferenced fields

In addition, a record is added in the Table Field Setting child grid, located under(Undefined variable: CompoVariables_WA_Alternate."Data") > Data Integration > Data Integration Settings > Table Field Setting > <PayeeTableName, with the following data:

Column Name	Description
Table Name	Payee table name
Field Name	Name given to the extended payee field in the configuration grid (see Adding an Extended Payee Field to the Rapide Data Model)
Is Mandatory?	Unchecked Editable
Is Business Key?	Unchecked Editable
Is Start Date Field?	Unchecked Editable
Is End Date Field?	Unchecked Editable
Is Referenced?	Value: False Non editable
Referential Table Name	Empty Non editable
Referential Field Name	Empty Non editable

Table Field Setting grid record details

Finally, a record is added to the Field Table Field Mapping child grid, located under (Undefined variable: CompoVariables_WA_Alternate."Data") > Data Integration > Adf Config > Field Table Field Mapping > <PayeeTableName>, with the following data:

Column Name	Description
File Name	File name from the parent grid
File Field	Name given to the extended payee field in the configuration grid (see Adding an Extended Payee Field to the Rapide Data Model
Table Field	As provided in the configuration grid
Description File Field	As provided in the configuration grid
Field Order	Position of the field in the payee grid. By default, the last position is assigned
Is Used	Unchecked Editable

File Table Field Mapping grid record details

Unreferenced Field - payee_compensation Table

The "payee_compensation" table is different from the other core payee tables because of the approach to payee situation in this table. While most fields of the other payee tables are directly included in the Payee Situation grid, the compensation component fields of the "payee_compensation" table are pivoted. As a result, columns that describe compensation components are duplicated as many times as there are compensation components (base salary, bonus, LTI, cash, merit, etc.) specified in the configuration. Columns are not created for all the components that exist in the grid "Ref compensation component grid or in the "payee_compensation" table; they are only created for the components present in the in the Payee Situation Compensation Component grid, for the components for which the Is used in Payee Situation flag is checked.

The columns added to the Payee Situation grid are named according to the following pattern: CONCAT(“Compensation”, ' ', component code, ' ' ,extended field name).

Consider the following example:

Payee table name: payee_compensation
Field name: monthly_amount
Compensation components used in the Payee Situation grid
- Base Salary (BS)
- Bonus (BON)
- LTI (LTI)

For this example, the following fields are created:

Grid	Grid Field
Payee Compensation	Monthly amount
Staging Payee Compensation	Monthly amount
Error Payee Compensation	Monthly amount
Archive Payee Compensation	Monthly amount
Payee Situation	Compensation BS monthly amount
Payee Situation	Compensation BON monthly amount
Payee Situation	Compensation LTI monthly amount

Synchronization results for fields referenced to payee_compensation

In addition, new records are added to the Table Field Setting and File Table Field Mapping, as described in Table 10 and Table 11 of this document. For more information, refer to the Unreferenced Field - All Tables Except payee_compensation section of this document.

Fields Referenced to a Dimension - All Tables Except payee_compensation

If a new extended core payee field is referenced to a dimension table, a difference is then visible in the name of the fields added to the various grids. In most grids, the prefix "id_" (applied when creating the field) is omitted because the field is completed by its code (an not its ID) in the staging table. Consequently, the code is also stored in the archive and error tables. The code is translated into an ID when the data is loaded into the target table. in the Payee Situation grid, the display label of the field is visible; in this case, it is a computed field based on the fields of the referential grids, according to the following convention: concat([code xxx],' - ',[short name xxx]), where "xxx" corresponds to the name of the referential grid, without the prefix "ref_".

Consider the following example:

Payee table name: payee_org_assignment
Field name: id_business_subarea
Referential table name: core.ref_business_area
Referential field name: id_business_area

In that case, new fields are created as follows:

Grid	Grid Field
Payee Org Assignment	Business subarea
Staging Payee Org Assignment	Business subarea
Error Payee Org Assignment	Business subarea
Archive Payee Org Assignment	Business subarea
Payee Situation	Display label business subarea

Synchronization results for fields referenced to a Dimension (except payee_compensation)

Column Name	Description
Table Name	Payee table name
Field Name	Name given to the extended payee field in the configuration grid (see Adding an Extended Payee Field to the Rapide Data Model)
Is Mandatory?	Unchecked Editable
Is Business Key?	Unchecked Editable
Is Start Date Field?	Unchecked Editable
Is End Date Field?	Unchecked Editable
Is Referenced?	Value: True Non editable
Referential Table Name	As selected in the configuration
Referential Field Name	"code_" + name of the referential table selected in the configuration grid, without the "ref_" prefix

Table Field Setting grid record details

Column Name	Description
File Name	File name from the parent grid
File Field	Name given to the extended payee field in the configuration grid, without the "id_" prefix (see Adding an Extended Payee Field to the Rapide Data Model
Table Field	As provided in the configuration grid, without the "id_" prefix
Description File Field	As provided in the configuration grid
Field Order	Position of the field in the payee grid. By default, the last position is assigned
Is Used	Unchecked Editable

File Table Field Mapping grid record details

Fields Referenced to a Dimension - payee_compensation Table

When an extended payee field is referenced to a dimension from the payee_compensation table, then the Display Label field is not created in the Payee Situation grid. Instead, the same fields as those described in Table 12 are created (i.e. fields related to the compensation components from the Payee Situation Compensation Component grid).

Consider the following example:

Payee table name: payee_compensation
Field name: id_company_currency
Referential table name: core.ref_currency
Referential field name: id_currency
Compensation components used in the Payee Situation grid:
- Base Salary (code BS)
- Bonus (code BON)
- LTI (code LTI)

In that case, new fields are created as follows:

Grid	Grid Field
Payee Org Assignment	Company currency
Staging Payee Org Assignment	Company currency
Error Payee Org Assignment	Company currency
Archive Payee Org Assignment	Company currency
Payee Situation	Compensation BS id company currency
Payee Situation	Compensation BON id company currency
Payee Situation	Compensation LTI id company currency

Synchronization results for fields with a dimension reference from payee_compensation

In addition, new records are added to the Table Field Setting and File Table Field Mapping, as described in Table 14 and Table 15 of this document. For more information, refer to the Fields Referenced to a Dimension - All Tables Except payee_compensation section of this document.

Fields Referenced to a Payee - All Tables Except payee_compensation

If a new extended core payee field is referenced to a payee table other than the payee_compensation table, a difference is then visible in the name of the fields added to the various grids. In most grids, the prefix "id_" (applied when creating the field) is omitted because the field is completed by its code (an not its ID) in the staging table. Consequently, the code is also stored in the archive and error tables. The code is translated into an ID when the data is loaded into the target table.

When a new extended core payee field is referenced to a payee table, then three fields are created in the Payee Situation grid. The values displayed in the grid come from the Payee Personal Data grid, as detailed in the following table (where "xxx" corresponds to the name of the new extended core payee field):

Field in "Payee Situation"

Payee Personal Data

xxx code

Based on the configuration set in the "Global Setting" grid for the display label of id_payee.

Example: CONCAT(code_payee_primary, '_', code_payee_secondary)

xxx firstname

First name

xxx lastname

Last name

Payee Personal Data fields

Consider the following example:

Payee table name: payee_org_assignment
Field name: id_technical_manager
Referential table name (static): dbo.py_payee
Referential field name (static): idPayee

For this example, the following fields are created:

Grid	Grid Field
Payee Org Assignment	Technical manager
Staging Payee Org Assignment	Technical manager
Error Payee Org Assignment	Technical manager
Archive Payee Org Assignment	Technical manager
Payee Situation	Technical manager code
Payee Situation	Technical manager firstname
Payee Situation	Technical manager lastname

Synchronization results for fields with a payee reference from payee_compensation

Column Name	Description
Table Name	Payee table name
Field Name	Name given to the extended payee field in the configuration grid (see Adding an Extended Payee Field to the Rapide Data Model)
Is Mandatory?	Unchecked Editable
Is Business Key?	Unchecked Editable
Is Start Date Field?	Unchecked Editable
Is End Date Field?	Unchecked Editable
Is Referenced?	True Non editable
Referential Table Name	py_payee
Referential Field Name	codePayee

Table Field Setting grid record details

Column Name	Description
File Name	File name from the parent grid
File Field	Name given to the extended payee field in the configuration grid, without the "id_" prefix (see Adding an Extended Payee Field to the Rapide Data Model
Table Field	As provided in the configuration grid, without the "id_" prefix
Description File Field	As provided in the configuration grid
Field Order	Position of the field in the payee grid. By default, the last position is assigned
Is Used	Unchecked Editable

File Table Field Mapping grid record details

Fields Referenced to a Payee - payee_compensation Table

This situation is similar to the case described above, except that the fields created for the Payee Situation in table 18 are not created when an extended payee field is referenced to the payee_compensation table. Instead, the same fields as those created when the extended payee field is not referenced to the payee_compensation table are created (related to components from the Payee Situation Compensation Component grid.).

Consider the following example:

Payee table name: payee_compesation
Field name: id_finance_manager
Referential table name (static): dbo.py_payee
Referential field name (static): iPayee
Compensation components used in the Payee Situation grid
- Base Salary (code = BS)
- Bonus (code = BON)
- LTI (code = LTI)

For this example, the following fields are created:

Grid Name	Grid Field
Payee Compensation	Finance Manager
Staging Payee Org Assignment	Finance Manager
Error Payee Org Assignment	Finance Manager
Archive Payee Org Assignment	Finance Manager
Payee Situation	Compensation_BD_id_finance_manager
Payee Situation	Compensation_BON_id_finance_manager
Payee Situation	Compensation_LTI_id_finance_manager

Synchronization results for fields referenced to a payee from the payee_compensation table

In addition, new records are added to the Table Field Setting and File Table Field Mapping, as described in Table 19 and Table 20 of this document. For more information, refer to theFields Referenced to a Payee - All Tables Except payee_compensation section of this document.

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	Synchronization start date
End Date	Synchronization end date
Task Name	Name of the task executed during the synchronization: Validation Rules Check/Synchronize Custom Referential Table Validation Rules Check / Synchronize Computed Field Formula Referential Validation Rules Check /Synchronize 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 new custom referential table is added to the Rapide data model and synchronized, the system runs a series of tasks that are detailed in the synchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Synchronize Custom Referential Table	CREATE TABLE on custom_core
	CREATE TABLE on custom_core_staging
	CREATE TABLE on custom_core_error
	CREATE TABLE on custom_core_archive
	Update Dictionary
	Update Config Referential Table

Custom referential table task details

Computed Column History

When a new computed column is added to the Rapide data model and synchronized, the system runs a series of tasks that are detailed in the synchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Synchronize 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 Details

When a new extended payee field is added to the Rapide data model and synchronized, the system runs a series of tasks that are detailed in the synchronization history, as listed in the following table:

Task Name	Task Detail
Validation Rules Check	Validation Rules Check
Synchronize Additional Column Payee Table	ADD COLUMN core_extended
	ADD COLUMN core_staging
	ADD COLUMN core_error
	ADD COLUMN core_archive
	ADD COLUMN core_shared.payee_situation
	Update Dictionary
	Update Additional Column Payee Table
Updated Associated Objects	Updated Associated Shared View
Updated Associated Objects	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, located under (Undefined variable: CompoVariables_WA.Data) > Data Management > Data Model, offers collective information related to the synchronization process, specifically:

Synchronization start time
Synchronization end time
Synchronization execution status
Synchronization 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, located under (Undefined variable: CompoVariables_WA.Data) > Data Management > Data Model > Configuration Referential, offers the following historical information:

Record insertion date and time
First name and last name of the user who inserted the record
Date and time of the last update of the record
First name and last name of the user who last updated the record
Date and time of the last synchronization
Status of the last synchronization (success/failure)

This is an note/information message.

If the synchronization was successful, then the "Is Synchronized" column is checked and the "To Be Synchronized" column is unchecked.

In the event of a synchronization failure, the "Is Synchronized" column is not checked and the "To Be Synchronized" column remains 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 insertion time
Record update time
First name and last name of the user who last updated the record
Date of the last synchronization
Synchronization status (success/failure)

This is an note/information message.

If the synchronization was successful, then the "Is Synchronized" column is checked and the "To Be Synchronized" column is unchecked.

In the event of a synchronization failure, the "Is Synchronized" column is not checked and the "To Be Synchronized" column remains checked.

Limitations After Synchronization

Limitations Related to Custom Referential Tables

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

Action	Rule	Error Message
Renaming the table	Synchronized tables cannot be renamed.	Table Name cannot be changed as the custom referential table has been synchronized already. To change the table name, please first unsynchronize the table and then synchronize it again!
Changing the state of the "To Be Synchronized" column	The "To Be Synchronized" column cannot be checked if the table has already been synchronized.	The custom referential table cannot be synchronized once again, as it is already synchronized. To change it, please first unsynchronize the table and then synchronize it again!
Deleting the row	Rows corresponding to a synchronized table cannot be deleted.	The custom referential table cannot be removed as the table has been synchronized already!

Custom referential table limitations after synchronization

Limitations Related to Computed Columns

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

Action	Rule	Error Message
Edition of the computed formula	The computed formula cannot be changed if the column is synchronized.	The computed formula cannot be changed as the formula has been synchronized already. To change a formula, please first unsynchronize the computed formula and then synchronize it again.
Modification of the state of the "To be Synchronized" flag	The "To be Synchronized" flag cannot be checked if the column is synchronized	The computed formula cannot be synchronized once again, as it is already synchronized. To change a formula, please first unsynchronize it and then synchronize it again.
Deletion of the row	Rows containing a synchronized computed column cannot be deleted.	The computed formula cannot be removed as the formula has been synchronized already!

Computed column limitations after synchronization

Limitations Related to Extended Payee Fields

Once the extended payee field has been synchronized, some actions are no longer allowed in the Extend Core Payee grid > Data child grid as outlined in the following table:

Action	Rule	Error Message
Field name change	Once the field has been synchronized, it cannot be renamed.	Field Name cannot be changed as the custom field has been synchronized already. To change a field name, please first unsynchronize the custom field and then synchronize it again!
"To Be Synchronized" flag status change	The "To Be Sychronized" flag cannot be checked when the field is synchronized.	The custom field cannot be synchronized once again, as it is already synchronized. To change it, please first unsynchronize the custom field and then synchronize it again!
Row deletion	Rows containing a synchronized field cannot be deleted.	The custom field cannot be removed as it has been synchronized already!
Data type change	The data type cannot be changed once the field is synchronized.	Field Data Type cannot be changed as the custom field has been synchronized already. To change a field data type, please first unsynchronize the custom field and then synchronize it again!
"Allow Max characters" change	The column "Allow Max characters" cannot be changed once the field is synchronized.	Allow Max characters check box cannot be changed as the custom field has been synchronized already. To change it, please first unsynchronize the custom field and then synchronize it again!
“Is Dimension Referenced Field?“ change	The column "Is Dimension Referenced Field?" cannot be changed once the field is synchronized.	Is Dimension Referenced Field? check box cannot be changed as the custom field has been synchronized already. To change it, please first unsynchronize the custom field and then synchronize it again!
“Is Payee Referenced Field?” change	The column "Is Payee Referenced Field" cannot be changed once the field is synchronized.	Is Payee Referenced Field? check box cannot be changed as the custom field has been synchronized already. To change it, please first unsynchronize the custom field and then synchronize it again!
“Number of characters” change	The column "Numbers of characters" cannot be changed once the field is synchronized.	Number of characters cannot be changed as the custom field has been synchronized already. To change a number of characters, please first unsynchronize the custom field and then synchronize it again!
"Numeric Precision" change	The column "Numeric Precision" cannot be changed once the field is synchronized.	Numeric Precision cannot be changed as the custom field has been synchronized already. To change a numeric precision, please first unsynchronize the custom field and then synchronize it again!
"Numeric Scale" change	The column "Numeric Scale" cannot be changed once the field is synchronized.	Numeric Scale cannot be changed as the custom field has been synchronized already. To change a numeric scale, please first unsynchronize the custom field and then synchronize it again!

Extended payee field limitations after synchronization

Attachments

zd_v10-help.4.log-567539263.zip
10 KB Download