Custom Field – Element Type Advanced
Activity
View
Activity element is a complex field that is used to create comments and worklog.
Field Configuration
Column Type: Don’t create DB column
If we go to “Extra” tab after selecting the element type, we find the following fields:
Field | Description | Note |
Default Grid | Here we can select the default grid that we want to display as the worklog grid. | If we leave it blank, as default, this field will show only worklogs that are related to this model instance |
Allowed Types | Models that are allowed to be displayed |
|
Address type
View
Address type is a complex field that is used to store physical addresses of entities in sales and inventory module.
The rendering in the form will look like the following image where you can see the addresses related to current model instance and add a new one. You can create a new one by clicking “Add Address”.
When you click Add Address the following window will appear where you can fill the required fields to set a new address related to this entity.
Field Configuration
Column Type: Don’t create DB column
You can choose the type of the entity related to this address field: Sales or Inventory.
Approvalgrid
View
Approvalgrid is a complex field displayed as grid inside the form of the current model. This type is used to display the approvals related to this entity.
Field Configuration
When we choose this element type the ‘extra’ tab will change to the following fields.
Field | Description | Note |
Default Grid | Grid that will be displayed | Here you need to choose only the grids that are DeepApproval model |
Sort Column | the column that the sort will be based on |
|
Sort Direction | Identify if the sorting will be ascending or descending |
|
Disable Row Click | doesn’t allow redirect to the selected entity on element click |
|
Placeholder |
|
|
Url Parameters | is used to pass other parameters | The form is: name of the field on the first input and the value you want in the second input |
Cronexpression
View
Cronexpression is used to generate chronological expressions.
The render for this type is:
Below the field you have a select field where you can select values of never, 5 minutes, 2 hours, minute, hour, day, week, month, year.
Field Configuration
Column Type: Text
These types of elements are found inside models that have automatism because it can be used to trigger the automatism on chronological basis.
Deeppassword
View
Deeppassword is a complex field that is related to DeepPassword module. Here you can create and store passwords. The rendering of this element is:
If you click the “+” button it will prompt, you with a window where you can create a new password. To create a password, you first need to set the passphrase in System > Configuration > Password > System Passphrase.
If you click inside the input field, you will see a list of currently existing passwords.
Field Configuration
Column Type: Don’t create DB column
Emailaddress
View
Emailaddress is used to store email addresses.
This is rendered on the form as an input type and when you insert an email and press spacebar or enter it will create a label of that email.
Field Configuration
Column Type: Text or Text Area
When we select this type, we will have a new switch available inside ‘Extra’ tab.
Field | Description | Note |
Enable Ajax | when this is on, and we click the field inside the form a dropdown with all users with email address will be available. | If we start typing this list will be filtered by the text we write
|
Emailgrid
View
Email grid is used to display all emails related with this entity. This field will be displayed as a grid will all the emails available.
Field Configuration
Column Type: Don’t create DB column
Emailwriter
View
Emailwriter is an element rendered as a button:
When we click the button, a popup will open where you can write a new email related to this entity. If we write an email here the email will be available inside the emailgrid we explained above.
This is the popup that will be shown when you click the button. You can edit this form to your needs.
Field Configuration
Column Type: Don’t create DB column
Grid
View
Grid element type is used to render a grid inside the form.
Field Configuration
Column Type: Don’t create DB column
The fields available inside extra tab are:
Field | Description | Note |
Route | is used to determine the route of the grid | In the example we see “*/admin_user/grid/” where * stands form hostname +/admin. After that we see the module name _ entity name /grid/ |
Default grid | select a grid that will be displayed | You need to choose a grid that is the same entity and module as the one defined in the route field |
Sort column | the column based on which we will sort the element |
|
Sort direction | Ascendent or descendent |
|
Disable row click |
| if we set it to no when we click a row inside the grid it will redirect us to the element we clicked. |
Placeholder |
|
|
Url parameters |
| is used to further filter the elements we want to display on this grid. Inside the first input we write the column name on which we can filter, and the next field holds the value of the filter. |
Inventoryitemgrid
View
Inventoryitemgrid is only to display grids related to inventory item module. The render is the same we see inside the inventory item.
You can add new item to this grid by clicking “Add Item”.
Field Configuration
Column Type: Don’t create DB column
In the ‘Extra’ tab this grid has the same fields as the default one.
The only thing that differs is that the field ‘Default Grid’ should be populated with a grid of type DeepInventory – Item. If not, the default grid inside this inventory item will be displayed.
The route field is missing because it is predefined to be only for the inventory item.
Inventorymovementgrid
View
Inventorymovementgrid is only to display grids related to inventory movement module. The render is the same we see inside the inventory movement.
You can add new movement to this grid by clicking “Add Movement”.
Field Configuration
Column Type: Don’t create DB column
In the ‘Extra’ tab this grid has the same fields as the default one.
The only thing that differs is that the field ‘Default Grid’ should be populated with a grid of type DeepInventory – Movement. If not, the default grid inside this inventory movement will be displayed.
The “Route” field is missing because it is predefined to be only for the inventory movement.
Invoicegrid
View
Invoicegrid is used to display invoices related to this entity. You can add new invoices by clicking “Add Invoice” button.
Field Configuration
Column Type: Don’t create DB column
The ‘Extra’ tab has the same fields as default grid type.
The “Route” field is missing because it is predefined to be only for the invoice. You need to set the field “Default Grid” to a DeepSales – Invoice.
Invoicerelatedmodelgrid
View
Invoicerelatedmodelgrid is used to display entities related to other entities that are different to the current model. This element type has a ‘Don’t create a DB column’ column type.
For example, this field is used in DeepSalesInvoice to display activities related to the operation that you want to invoice.
If you click the button “Add Activity”, you can insert activities that you want invoice.
Field Configuration
Column Type: Don’t create DB column
The ‘Extra’ tab on the configure field has the same fields as the default grid type, the only thing that differs is the field “Related Model Alias”.
Field | Description | Note |
Related Model Alias |
| is the model related to other model different to the current model |
Multiselect
View
Multiselect is a field where you can select multiple elements of a predefined array
Field Configuration
Column Type: text or integer.
The elements are written inside the advanced tab in “Values” where you should return an array with key => value as shown below.
This type of element requires the configuration of a custom event to work.
Progressbar
View
This element is shown inside the form as a progressbar.
Field Configuration
Column Type: decimal
We can alter the element by percentage inside the extra tab. We have the level field where the first input is key which holds the level from 0 to 100 and the second input holds the CSS class assigned to the element if the current value is less than or equal to the corresponding percentage.
This type of element requires the configuration of a custom event or a flow to work.
Qrcode
View
Qrcode element is used to display a QR code that corresponds to the value assigned.
This element just displays data as a QR code and is not stored in Data Base as a image.
Field Configuration
Column Type: text or text area (depending on the size of data that will be stored).
Inside extra tab we find these fields that are used to style this element.
Field | Description | Note |
Style width | width of the image rendered |
|
Style height | height of the image rendered |
|
Style top | number of pixel from the top |
|
Style left | number of pixel from left |
|
Style position | position of the image | CSS position types applied |
Relationgrid
View
Relationgrid displays the relation between 2 entities as a grid.
When we select this element type, another field called ‘relation’ will become visible, containing the relation to which we are referring.
You can add new entities to this relation by clicking “Add” button or you can change the display columns by clicking “Edit” button.
Field Configuration
Column Type: don’t create a DB column
Inside the ‘Extra’ tab we have a new field.
Field | Description | Note |
Opposite | If this field is ‘yes’, then the relation is the opposite version |
|
Select
View
Select type is a selection field.
Field Configuration
Column Type: integer or text
When we select this type, the extra tab is filled with the following elements:
Field | Description | Note |
AJAX Url | the model of the entities that we will show inside the options. |
|
AJAX Disable Cache | disable the cache so every time we click on the select field a request is made. |
|
Ajax Value Field | the value attribute of each option |
|
AJAX Selection Field | the data we want to display inside the option during the selection process. |
|
AJAX Result Field | the data we want to display inside the option after we select one and how it will be displayed. |
|
Use Model Grid | if set to yes on the right side of the select field will be a button that will open a modal with all filtered elements displayed as grid. |
|
AJAX Additional URL Parameters | these are used to add filters to the displayed options | The format of the filters is as follows: filter[id_of_filter][attribute] – is the column name on which this filter is based on. filter[id_of_filter][operator] – is the value on which this column will be filtered.
Since we can add more than one filter we identify the pairs by the id_of_filter value starting from 0. Most used operators are eq, neq, in.
|
Task
View
Task is a field that is used to keep track of tasks assigned for this entity.
Field Configuration
Column Type: don’t create a DB column
When we select this element, new fields will be displayed inside the ‘Extra’ tab.
Field | Description | Note |
View | what display mode this field will have | categorised into TO DO and DONE or list all elements. |
Order By | if we want to order these elements. |
|
Order Direction | what direction the order will be |
|
Use Form Template | if we want to use the default form or change the form template.
|
|
Allowed Types | what types will be displayed inside this field |
|
Default Grid | the default grid that will be displayed |
|
Userassociation
View
By selecting the Userassociation type, the element, once added to the form, will allow multiple selection of users.
Field Configuration
Column Type: don’t create a DB column
It is necessary to complete the ‘User Association Type’ field with the value ‘Watch’ (image below).
