Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The table structure of REM repeats the dictionary structure with tables and columns. Instead of columns, Attributes (sys_re_attribute) are used in REM. You can connect REM attributes with a table within the Model (sys_re_model). Besides, you can create attribute collections as universal sets of attributes that can be used in several models at the same time.
You can access to dictionaries related to REM through the Record Extended Model (REM) menu category.
REM concept
Every table has its own data model specified by the business-logic. The data model is represented by the column set. This data model can be extended with child table with the same attribute set as the parent one, and individual attributes inaccessible from the parent table, as an addition. For example, the diagram below shows that all attributes of the User table are inherited by the Employee table:
Attributes extension circuit diagram
Image Added
When there are not
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
Image Removed
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), this data model works fine. 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 the functionality related to the specified dictionary, such as data import, layout setting and so one, etc.
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 each request template with specific attributes).
To deal with this issue, another Record Extended Model concept has been created and implemented – Record Extended Model.
REM Concept
In this concept, extension concept . Extension concept can be applied for to a specified table record, giving some featured additional 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 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:
- Create an extension model.
- Create attributes ( and link it them to the model).
- (optional) Configure an the attribute collection.
- (optional) Configure RE model client script if needed.
Creating models
To create a model, please complete the steps below:
- Navigate to Record Extended Model → Models.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Record extended model form fields
In the diagram below, you can see the difference between models and collections. Models are created with a specific attribute set that can only be used in this model. Collections contain attributes that can be applied to different models.
Note |
---|
It is not recommended to create collections with many attributes. It is better to create one collection with one attribute. |
Image Added
Creating models
To create a model, complete the steps below:
- Navigate to Record Extended Model (REM) → Models.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Record Extended Model form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Title | Y | The model title. Can be specified in a language other than English. | ||
Table | Y | Reference to the table affected by the model.
| ||
Description | N | Type model description. | ||
After insert script | N | Specify a script that |
Reference to a table affected by the model.
Please note that you cannot specify a read-only table. To use such a table, please turn off this attribute first.
should be executed after a record is created. Develop it using JavaScript extended by the SimpleOne SimpleRecord Server-Side methods. | ||
Active | N | Select |
the checkbox to make the model active or inactive. | |
Icon | N |
Small image intended for |
model identification. | ||
Related Lists |
---|
Attributes | List of |
the attributes linked to this model. | |
Model |
Form Elements | List of the |
form element linked to this model. | |
Used Collections |
List of applied collections | ||
Model Client Scripts | List of the |
model |
client scripts linked to this model. |
Note |
---|
|
Configuring attributes
To In SimpleOne you can create an attribute, please complete the steps below:
- Navigate to Record Extended Model → Attributes.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
attribute mapping for models and collections. Data mapping is the process of connecting a data field from one table to a data field in another table. It reduces the potential for errors, helps standardize your data, and makes it easier to understand your data because it establishes direct relationships between your data across multiple tables at once.
To create an attribute, complete the steps below:
- Navigate to Record Extended Model (REM) → Attributes.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Attribute Attribute form fields
Field | Mandatory | Description |
---|---|---|
Container | Y | Reference to a previously created model. |
Attribute Type | Y | Specify |
the attribute type. | |
Title | Y |
Specify the attribute title. |
You can use Latin, Cyrillic letters, |
[0..9] numbers and the underscore symbol ( _ ) |
. |
Attribute Name | Y |
Attribute system name |
. This field is populated automatically. Latin letters, |
[0..9] numbers and the underscore symbol ( _ ) are allowed. | ||
Map to Column | N | Specify |
the target field to map the attribute value |
before the record is |
inserted (including business rules of the before type). This option allows |
you to quickly transfer attribute values to fields. |
The field is of the Reference type and has a reference qualifier, which allows for choosing columns of table defined in the model record and columns of its child tables.
|
|
|
|
|
Specify a default value that will be populated to the field when creating a new record. This field may be specified by a JavaScript scenario as well.
This field appears only when the Use Dynamic Default checkbox is selected.
Select the script from the Dynamic Default Values (sys_default_value_dynamic) dictionary, so its execution result will be automatically calculated and entered into this field; this value will be the default value for the column specified.
- The script must be preliminary created in the Dynamic Default Values (sys_default_value_dynamic) dictionary; otherwise, you will be not able to choose it.
- You can choose only active scripts (the Active checkbox is selected).
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:
- Create a collection record as described below
- Fill it with previously created attributes or create new ones using the Attributes related list.
- 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:
- Navigate to Record Extended Model → Collections.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Collection form field
Note |
---|
|
Configuring model client scripts
To create a record extended model client script, please complete the steps below:
- Navigate to Record Extended Model → Model Client Scripts.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
Model client script form fields
The script type:
- onLoad – it starts when the system displays the form for the first time before users will enter data. Generally, onLoad scripts perform manipulations on the client-side with the current form or set default record values;
- onChange – it starts when the specified field in the form is changed;
- onSubmit – this client-side script can cancel form submitting by returning false;
- onCellEdit - this client-side script starts at the moment when some cell is to edit.
- oldvalue - the old value for the cell that was edited;
- newValue - the new value for the cell that was edited;
- table - the table name of the cell being edited (for example, sys_db_table);
- sysId - the ID of the record relevant to the cell being edited;
- callback - if this variable is equated to FALSE, then subsequent scripts will not run; otherwise, they will execute.
The following message appears if there is no target column in the table:
| ||||
Comments | N | Put some comments here describing your attribute. | ||
Active | N | Select the checkbox to make the attribute active or inactive. | ||
Read Only | N | Select the checkbox to make the field added with this attribute read-only. | ||
Mandatory | N | Select the checkbox to make the field added with this attribute mandatory. | ||
Type Specification tab | ||||
---|---|---|---|---|
Dependent on Column | Y | Specify a column with reference to the Table (sys_db_table). The field appears when one of the following options is selected in the Attribute Type field:
| ||
Maximum Length | N | Specify a maximum value length for the attribute value. The value length cannot exceed the allowable length for the specified data type. The field appears when one of the following options is selected in the Attribute Type field:
| ||
Choice Table | N | Reference to a table. The field appears when the Choice option is selected in the Attribute Type field. | ||
Choice Field | Y | Reference to a particular column of the table specified in the Choice Table field. The field appears when the Choice Table field is populated. | ||
Choice Type | Y | Define whether the None option is applicable for the field. Available options:
If the Dropdown without --None-- is chosen, the Default value field becomes mandatory. The field appears when the Choice option is selected in the Attribute Type field. | ||
Extra Attributes | N | Specify additional configurations for the field. For example, enter the text below to apply radio buttons style to the choice field:
The field appears when one of the following options is selected in the Attribute Type field:
| ||
Reference | Y | Specify a table with the values you need. The field appears when the List or Reference option is selected in the Attribute Type field. | ||
On Delete | N | Select the action to take when the referenced recordis deleted. Available options:
The field appears when the Reference option is selected in the Attribute Type field. | ||
Default Value tab | ||||
Default Value | N | Specify the default value that will be populated to the field when creating a new record. This field may be specified by a JavaScript scenario as well. | ||
Use Dynamic Default | N | Select the checkbox if you want to generate the default value dynamically. | ||
Dynamic Default | Y | This field only appears when the Use Dynamic Default checkbox is selected. Select the script from the Dynamic Default Values (sys_default_value_dynamic) dictionary, so its execution result will be automatically calculated and entered into this field; this value will be the default value for the column specified.
| ||
Reference Qualifier | ||||
Reference Qualifier Type | N | Specify the type of the reference qualifier. Available options:
The field appears when the List, Reference or Field Name option is selected in the Attribute Type field. | ||
Reference Qualifier Condition | N | Configure filters using the Condition Builder. The field appears when the Simple option is selected in the Reference Qualifier Type field. | ||
Dynamic Reference Qualifier | N | Select the dynamic reference qualifier from the list. The field appears when the Dynamic option is selected in the Reference Qualifier Type field. | ||
Reference Qualifier Fixed | N | Select the checkbox to fix filters in breadcrumbs. This functionality will block using the Condition Builder functionality. The field appears when one of the following options is selected in the Attribute Type field:
|
Configuring attribute collections
Attribute collections are implemented to user Many-to-Many Relationships, so they allow you to reuse the same attributes accross models instead of adding them separately to each model where necessary.
Simplified concept of use is:
- Create a collection record as described below.
- Fill it with previously created attributes or create new ones using the Attributes related list.
- Relate this collection with previously created models using the Used in Models related list.
After that, all the attributes contained in this collection are used by all models this collection relates to.
Info |
---|
|
To create a collection, complete the steps below:
- Navigate to Record Extended Model (REM) → Collections.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Collection form fields
Field | Mandatory | Description |
---|---|---|
Title | Y | Specify the collection title. |
Active | N | Select the checkbox to make the collection active or inactive. |
Table | N | Specify the table to which the collection is related. |
Related Lists | ||
Attributes | In this related list, you can create a new attribute related to this collection or select an existing one from the dictionary. | |
Form Elements | In this related list, you can create a new form element related to this collection or select an existing one from the dictionary. | |
Used in Model | In this related list, you can create a new model related to this collection or select an existing one from the dictionary. | |
Client Scripts | In this related list, you can create a new model client script related to this collection or select an existing one from the dictionary. |
Note |
---|
|
Configuring model client scripts
To create a record extended model client script, complete the steps below:
- Navigate to Record Extended Model (REM) → Model Client Scripts.
Configure model form elements
You can arrange the fields of your RE model attributes in a particular order and position, as you can do with form layouts. Group attributes by common features and give them a title. In the screenshot below, a custom model attributes are divided into two columns:
Image Removed
Tip |
---|
If you want to define a title for a group of attributes organized in one block, use the Begin element. The title will appear on the relevant page of the Self-Service Portal. |
To change the order of displayed attributes, perform the following steps:
Arrange the attributes by changing value in the Position field.
Tip |
---|
Use inline editing: double-click on the cell in the Position field, enter the value and press Enter to save changes.
|
- Navigate to Record Extended Model → Models.
- Open the model you need.
- Scroll down to the Related Lists area and open the Model Form Elements tab. Click
- Click
- New and fill in the fields.
- Click Save or Save and Exit to add the element
- apply changes.
Model Client Script form fields
Field | Mandatory | Description |
---|---|---|
Name | Y | Define the client script name. |
Container | Y | Reference to |
the model |
or collection. | ||
Type | Y | Specify the script type |
. Available options: |
- Begin – use this element to define the beginning of block of fields. You can define the name of a group in it. When selected, the Block Title field is displayed.
- Split – use this element to divide the field into columns.
- End – use this element to define the end of block of fields.
Define the title of the group of elements. This title will be displayed above the attributes group on the relevant page of the Self-Service Portal.
Info |
---|
This field appears when the Block Element value is Begin. |
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.
- Create an extension model as described above.
- Create necessary attributes and bind them to the model.
- You can create attributes out of the your created model using the appropriate related list.
- Create a new widget using <rem> or <remform> SimpleTags (based on the widget planned location, a record form or a portal page).
- 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.
Image Removed
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.
Image Removed
Create a form widget as described below and save it:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<rem modelId="{data.model_id}" tableName="{data.table_name}" recordId = "{data.record_id}" /> |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
(() => {
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:
Image Removed
Navigate to a record form using the URL looking like: https://instance.example.com/record/task?model_id=XXXXXXXXXXXXXXXXX
Info |
---|
In this URL. you need to substitute the X's with the model ID you are using in this case. To know it, please complete the steps below:
Without using this URL addition, a non-extended form is displayed. |
| ||
Attribute | N | Reference to a previously created model attribute. This field is mandatory when the onChange script type is chosen. |
Description | N | Client script description. |
Active | N | Select the checkbox to make the script active or inactive. |
Order | N | Specify client script execution order. Scripts are executed in ascending order. |
Script | N | Specify the client script. |
Configure model form elements
You can arrange the fields of your model attributes in a particular order and position, as you can do with form layouts. Group attributes by common features and give them a title. In the screenshot below, custom model attributes are divided into two columns:
Image Added
Tip |
---|
If you want to define a title for a group of attributes organized in one block, use the Begin element. The title will appear on the relevant page of the Self-Service Portal. |
To change the order of the displayed attributes, perform the following steps:
- Navigate to Record Extended Model (REM) → Models.
- Open the model you need.
- Scroll down to the Related Lists area and open the Model Form Elements tab.
Arrange the attributes by changing the value in the Position field.
Tip Use inline editing: double-click on the cell in the Position column, enter the value and press Enter to save changes.
Image Added
To configure a model layout, perform the following steps: Anchor add split elements add split elements
- Navigate to Record Extended Model (REM) → Models.
- Open the model you need.
- Scroll down to the Related Lists area and open the Model Form Elements tab.
- Click New and fill in the fields.
- Click Save or Save and Exit to add the element.
Model Form Element form fields
Field | Mandatory | Description | ||
---|---|---|---|---|
Container | Y | Reference to a previously created model. If the element is created from the related list, the field is populated automatically. | ||
Position | Y | Define the order in which the element will be displayed on a form. | ||
Block Element | Y | Specify the type of the splitter. Available options:
| ||
Block Title | N | Define the title of the group of fields. The title will be displayed above the attributes group on the relevant page of the Self-Service Portal.
|
|
Table of Contents | ||||
---|---|---|---|---|
|