Record Extended Model

What is REM?

To answer this question, we need to provide some theory first.

Thesis 1

In SimpleOne, you can handle with data which is represented as records in tables that have a specified attribute set. Records appear in tables and they have these attribute values given.

Thesis 2

Every table has its own data model stipulated by the business-logic. The data model is represented by the column set (their amount, types, links with another system objects, and so on). This data model can be extended with child table with the same attribute set as a parent one, and an individual attributes inaccessible from the parent table, as an addition.

Attributes extension circuit diagram

Conclusion

To manage the commonalous entities (like ITSM Tasks), we can create a table with appropriate column set and extend from it for Incidents, Change Requests, Problems, and so on, creating respective tables that inherit attributes (columns) from a parent one and besides have their own attributes. For example, attribute overlap in there may be 70%, and unique attributes will be 30% of the total.

In this case, this model works fine (when we do not have many child tables, and the attribute overlap is high). But when the child table number increases, and the attribute overlap decreases, the management of this data model becomes a challenge. Data model with big and complicated table inheritance structure has some disadvantages:

• It is required to allocate more space for record storage.
• Scripts are executed slower
• It is getting harder to configure еру functionality related to the specified dictionary, such as data import, layout setting and so one.

A Request Catalog can be taken as an example of such a table (a parent table for the catalog and a record in the table for every request template with specific attributes).

To deal with this issue, another concept has been created and implemented - Record Extended Model.

REM Concept

In this concept, extension concept can be applied for a specified table record giving some featured attributes to it.

Physically, extension model are stored as records of the Models (sys_re_models) table, and they intended to collect specific attributes extending records. Attributes are stored as records of the Attributes (sys_re_attribute) table (extending the Columns (sys_db_column) table).

When a record extension model is applied to a record, it means that an auxiliary record set is created for this record containing information about specific attribute values. So the record has attributes inherited from a table, and in addition, it has attributes sourced from the extension model.

Configuring extension models

Generally, to configure your extension model, you need to:

1. Create an extension model.
2. Create attributes (and link it to the model).
3. (optional) Configure an attribute collection.
4. Configure RE client script if needed.

Creating models

To create a model, please complete the steps below:

1. Navigate to Record Extended Model → Models.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Record extended model form fields

Configuring attributes

To create an attribute, please complete the steps below:

1. Navigate to Record Extended Model → Attributes.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Attribute form fields

Configuring attribute collections

Attribute collections are implemented for using Many-to-Many Relationships so they allow reusing the same attributes in various models instead of adding them in every model where necessary.

A simplified usage concept is:

1. Create a collection record as described below
2. Fill it with previously created attributes or create new ones using the Attributes related list.
3. Relate this collection with previously created models using the Used in Models related list.

After that, all attributes contained in this collection are used by all models this collection related with.

To create a collection, please complete the steps below:

1. Navigate to Record Extended Model → Collections.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Collection form field

Configuring model client scripts

To create a record extended model client script, please complete the steps below:

1. Navigate to Record Extended Model → Model Client Scripts.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Model client script form fields

How to use record extensions

For a full record extension functionality using, some additional actions are to be fulfilled. Below, a simplified implementation procedure can be found.

1. Create an extension model as described above.
2. Create necessary attributes and bind them to the model.
   1. You can create attributes out of the your created model using the appropriate related list.
3. Create a new widget using <rem> or <remform> SimpleTags (based on the widget planned location, a record form or a portal page).
4. Add newly created widget to a record form using the Form Layout functionality (or add it to the appropriate portal page using the portal pages configuring functionality).

Example of usage

For example, you need to extend your Task table with some attributes allowing to handle some daily duties. To perform this, follow the procedure described above:

Create an extension model for this table.

Create attributes (wonder which fields could be created on this record form within this task). There should be a single attribute for every single for field.

Create a form widget as described below and save it:

<rem modelId="{data.model_id}" tableName="{data.table_name}" recordId = "{data.record_id}" />

(() => {
window.s_widget_custom = window.s_widget_custom || {};
const parameter = new URLSearchParams(window.location.search).get('model_id');
s_widget.setFieldValue('model_id', parameter);
s_widget.setFieldValue('table_name', window.s_form.getTableName());
s_widget.setFieldValue('record_id', window.s_form.getUniqueValue());
})();

Add this widget to the record form view using the Form Layout functionality:

Navigate to a record form using the URL looking like: https://instance.example.com/record/task?model_id=XXXXXXXXXXXXXXXXX

After that, a form containing fields defined by attributes bound to the model specified is displayed.