id
stringlengths 14
14
| text
stringlengths 4
2.78k
| source
stringlengths 62
143
|
|---|---|---|
7c07339d0956-0 | Controls | https://brixxbox.gitbook.io/brixxbox-documentation/controls/README |
2176d138c48c-0 | TextBox
Text Box
A text box just lets the user enter a text and saves it. You can use various validators to check the input. For example, "nonEmpty" validator will display error that this field should not be left empty.
Documentation
Brixxbox app configurations allows you to add different controls in your app. Text box is one of the simplest and commonly used control. Its general properties are described below
General Properties
These properties defines how control behaves in Brixxbox.
Control Type
For using Text Box control, "text input" control type should be selected from drop down list.
Control Id
For each Brixxbox app, this id should be unique. For Example: "_abcdef". Brixxbox allows you to change its value only once. You can change this id to any value but it should be meaningful. Recommended way is to start with mandatory prefix(set in app). It can contain numbers, underscores, uppercase and lowercase letters.
Label
It is the display value for control.
Data
This property specifies from where this control gets data. To set it, specify the controlId of data source. By default "Not in Database" option is selected.
Include in global search
If checked, this allows this control to be included in global search scope of this application.
Select all on focus
This property when checked allows to select all the text in the text box, whenever this text box comes in focus.
Input Mask RegEx
This property allows you to set regular expression for input of text box. For example, ^[0-9a-zA-Z]*$. This regex allows digits from 0 to 9, small and big alphabets to be part of the input.
Refers to Config
You need to set this option if this is a field, that other fields refer to, to get data from another config.
Unit
The property allows you to specify a unit character here. For example we can specify $ for US Dollar, 芒聜卢 for Euro etc.
Load record on load
If this checkbox is selected then Brixxbox will load the record using value of this text box as a key.
Default value
This value is set when an application is opened or a new record is created.
Tutorial | https://brixxbox.gitbook.io/brixxbox-documentation/controls/textbox |
2176d138c48c-1 | Default value
This value is set when an application is opened or a new record is created.
Tutorial
This tutorial assumes that a user has an existing app and they want to add a new control of type "Text Input". First of all, select "Text Input" from list of controls. After that you need to give a id to your textbox and create column in database if you want to store the input in database. Here we named it "tbdText". Also, add a public label for Textbox. I labelled it "Street Name". You can any text in it. For example, add name of street. When you save this record. It will be saved in database. This is the first usage. We can also use text box to display the results from other controls. Lets use address combobox here. It is the same combobox we used in combobox tutorial.
Now when we select the value of combobox, we also want to set the value of "tbdText". The value of "tbdText" will correspond to name of street of the address selected in combobox. For this purpose, we need to add "onchange" event on combobox and add a custom code for it. In this code, first of all, we get the id of address chosen in combobox then we load the complete record using Brixxbox "loadConfigRecordById". In the end we will set the value of "tbdText" by using "setFieldValue" function. In this function, the first parameter takes the controlId of control whose value we want to set and second parameter takes actual value.
Now save the app config and test it by selecting any value of address combobox. It will also set the street name text box with corresponding street name. | https://brixxbox.gitbook.io/brixxbox-documentation/controls/textbox |
af0fbc053a4e-0 | NumBox
A numeric Text box lets the user to enter a number. It can be used for saving numerical input and also for displaying numerical data. You can use various control validators to check validity of input like "nonEmpty", "digits", "lessThan", and "zipCode" etc. For example, if you want to store a zip code for addresses, you can use a num box for input and then use a control validator "zipCode" on it. "zipCode" validator allows users to set two properties: custom message, country code. User can set any message according to application needs and specify the country name. Brixxbox will display error if zip code entered by user is not valid with respect to country code provided in settings.
Documentation
Brixxbox app configurations allows you to add different controls in your app. Num box is the simplest control. Its general properties are described below
General Properties
These properties defines how control behaves in Brixxbox.
Control Type
For using num box control, "Numeric input" control type should be selected from drop down list.
Control Id
For each Brixxbox app, this id should be unique. For Example: "_abcdef". Brixxbox allows you to change its value only once. You can change this id to any value but it should be meaningful. Recommended way is to start with mandatory prefix(set in app). It can contain numbers, underscores, uppercase and lowercase letters.
Label
It is the display value for control.
Data
This property specifies from where this control gets data. To set it, specify the controlId of data source. By default "Not in Database" option is selected.
Select all on focus
This property when checked allows to select all the data in the num box, whenever this num box comes in focus.
Refers to Config
You need to set this option if this is a field, that other fields refer to, to get data from another config.
Decimal Digits
This option allows you to set whole numbers or real numbers up to 10 decimal precision as a valid input for your num box.
No Up/Down arrows
If you check this option then no up/down arrows will be provided next to number. The default functionality of up/down arrows is to provide increment by 1 or decrement by 1 when upper arrow or down arrow is clicked respectively.
Unit | https://brixxbox.gitbook.io/brixxbox-documentation/controls/numbox |
af0fbc053a4e-1 | Unit
The property allows you to specify a unit character here. For example we can specify $ for US Dollar, 芒聜卢 for Euro etc.
Load record on load
If this checkbox is selected then Brixxbox will load the record using value of this text box as a key.
Default value
This value is set when an application is opened or a new record is created.
Tutorial
This tutorial assumes that a user has an existing app and they want to add a new control of type "Numeric Input". First of all, select "Numeric Input" from list of controls. After that you need to give an id to your num box and create column in database if you want to store the input in database.
Here we will consider two possible scenarios: getting a value from user for our num box and saving it, and on the basis of other control displaying some value in our num box.
Let start with the first case. For our Tutorial, select a "Numeric input" control type. Assign a meaningful controlId to it. We name it "nbZipCode". Here we add "ZipCode" name with mandatory prefix of the app "nb". Add it to database because we want to store zip codes. We have also assigned "Zip Code" label to it. Now save it.
With above settings, any numeric values can be accepted as a valid input but we want to change this behavior of num box. We want to save zip codes of Germany in our num box. The question arises, How can we alter the settings of num box so that it only accepts valid zip code? A valid German zip code consists of only 5 positive digits. To achieve it, we add a control validator "zipCode" to our num box. In its settings, for country code we choose "DE" for Germany and save it.
Now our num box only allow 5 digits positive numbers. Otherwise it will give an error.
Now we will take a look into second case. Let take the address comboBox which we used in the combo box tutorial. Now when we set an address in our combobox, we want to display its corresponding zipcode in our num box. We have to write a custom code on "onChange" event of combobox. This event will be triggered when combo box value change. The code looks like this | https://brixxbox.gitbook.io/brixxbox-documentation/controls/numbox |
af0fbc053a4e-2 | In first line of code we are getting the "key field value" of our selected combobox value. To get full record from data we are using "loadConfigRecordById" function in line 2. In line 3 we are setting the value of zip code num box with the value of zip code of loaded record. We also do not want our users to change this value. We need to set "Enabled" styling property of our num box to "No". Now when we select an address from combobox, it sets the num box value with the zip code of record set in combo box. | https://brixxbox.gitbook.io/brixxbox-documentation/controls/numbox |
67f356317115-0 | Grid
Grid
A grid displays a list of records, specified by the sub data source of that control.
Documentation
In Brixxbox, app configuration allows you to add different controls in your app. It also provides four types of properties which manages how control should behave or look in app. Those four property types are:
General Properties
Size
Style
Translation
General Properties
These are the main properties of any control. These properties define how control behaves in Brixxbox App.
Control Type
For using grid control, click on "Add Control" and select "Grid" control type from drop down.
Control Id
For each Brixxbox app, this id should be unique. For Example: "_abcdef". Brixxbox allows you to change its value only once. You can change this id to any value but it should be meaningful. Recommended way is to start with mandatory prefix(set in app). It can contain numbers, underscores, uppercase and lowercase letters.
Label
It is the display value for control.
Refers to Config
You need to set this option if this is a field, that other fields refer to, to get data from another config.
Hide Select Checkbox Column
By default, grid also display's a checkbox with each row. This checkbox is used to select a specific row. If it is enabled then user can select multiple rows at a time and perform different operations on them like deletion. If user does not want to display this checkbox then this property should be checked.
Hide Edit Button Column
This property is by default unchecked. It allows grid to display an edit button with each displayed row. If user does not want to display Edit button then this property should be checked.
Cascade Delete
This is a checkbox. If it is set and a delete operation is performed on a record, in an app containing this Grid control then all the lines of a record will get deleted. For example: User wants to delete an order with all of its item's lines.
Cascade Copy
If it is set and a copy operation is performed on a record, in an app containing this Grid control then all the lines of a record will get copied. For example: User wants to copy an order with all of its item's lines.
Server Side Paging
Use this property for big data tables. If checked, grid will only be able to data from server side only instead of getting all the data from data source. | https://brixxbox.gitbook.io/brixxbox-documentation/controls/grid |
67f356317115-1 | Smooth Scroll
If checked, this property allows the users to scroll through list of items of grid instead of scrolling up and down via paging buttons.
No automatic refresh
Use this property when fetching expensive Grid data. If set, it will block unnecessary calls for data. Brixxbox allows an app to refresh data of all of its controls using "app.refresh()" function. Settings this property will exclude this grid from data refresh calls. However, you can refresh grid data by specifying the grids name in refresh function. For Example: app.refresh("myGrid").
Tutorial
Gird control can be used in two possible scenarios: displaying all data of sub data source. For example: listing all customer orders, and displaying some values. For example: listing order lines of a specific customer order only.
This tutorial assumes that a user has an existing customer order app which records customer's order data. They want to list all customer orders in a new app and update grid to display all order lines of a specific customer order in customer order app.
For first scenario, create a customer order list app, select "Grid" from list of controls. After that you need to give an id to your grid. As grid is usually used to display data from a sub data source, so there is no need to create column in database for Grid control.
Let start with the first case. Select a new app, name it "customerOrderList". Select a "Grid" control type from the list, assign a unique id and meaningful label:
As you can see from the above picture, we have added a grid control but nothing appears in app editor on right side. This is not an error but expected behavior because grid control is used to display a list of records but first we need to specify "sub data source" in grid properties. For this click on "edit sub data source" and select "config" as a data source type. Now select "CustomerOrder" app to display all customer orders and save app settings.
Now you can see that our grid list all customer orders. In its menu, grid allows multiple options like adding new data row, deleting data row, refresh grid, copy data, search filter and drop down list for specifying number of entries for display. Grid provides each data row with plus, select, and edit button. Depending on screen size grid displays only few data columns and plus button is used to see remaining columns as shown below: | https://brixxbox.gitbook.io/brixxbox-documentation/controls/grid |
67f356317115-2 | Grid allows us to enable or disable select and edit buttons(see General Properties). We have successfully listed all customer orders, now we move towards second scenario. We have two relations between customer order and order lines which are: customer order can have multiple order lines, and one order line can only belong to one customer order. In this part, we want to cover second relation. Now we want to display order lines which belong to only one customer order in customer order app grid. Our customer order app looks like this:
There are a lot of details in this app which are not important here. Our concern is order lines gird which will display only those order lines which belong to one specific order. To allow this behavior, we need to edit "sub data source" settings of our order lines grid and set "target field binding" with the customer order line id.
Now we will see only those order lines in our grid which belong to same customer order. Lets add a new order for our customer John and add a new order line for this order.
Now order lines which belong to John's order are being displayed in our order lines grid. In our case we only added one order line. | https://brixxbox.gitbook.io/brixxbox-documentation/controls/grid |
929e8a619c17-0 | Badge
Badge
A badge control is designed to be added as a child to button controls. It is used to show notifications over buttons. For example, total number of orders can be shown over an order button via badge.
Documentation
In Brixxbox, app configuration allows you to add different controls in your app. It also provides four types of properties which manages how control should behave or look in app. Those four property types are:
General Properties
Size
Style
Translation
General Properties
These are the main properties of any control. These properties define how control behaves in Brixxbox App.
Control Type
For using grid control, click on "Add Control" and select "Badge" control type from drop down list.
Control Id
For each Brixxbox app, this id should be unique. For Example: "_abcdef". Brixxbox allows you to change its value only once. You can change this id to any value but it should be meaningful. Recommended way is to start with mandatory prefix(set in app). It can contain numbers, underscores, uppercase and lowercase letters.
Label
It is the display value for control.
Data
This property specifies from where this control gets data. To set it, specify the controlId of data source. By default "Not in Database" option is selected.
Refers to Config
You need to set this option if this is a field, that other fields refer to, to get data from another config.
Default Value
Normally this is the value which is assigned to a control when the app is opened or a new record is created, the brixxApi calls setFieldValue on this control and set the control's value with the default value. In badge, this can be the only value to get assigned to it. As it not interactable, we do not need to change its value.
Tutorial
In this tutorial, we will be using "customerOrderList" app. It is a simple app which consists of a grid and a button with a badge. The grid lists all available customer orders. The button "Number of Orders" has a badge over it which displays all the customer orders present in our system. Our app looks like this | https://brixxbox.gitbook.io/brixxbox-documentation/controls/badge |
929e8a619c17-1 | Here we can see there are only three customer orders are available. These customer orders are uniquely identified by "internal Id". For very less number of customer orders, it is easy to count them but if we have a huge amount of orders and we want their count. This count can daily, monthly, yearly or all time based. This is one scenario where we can use badge over a button. It acts like a notification over button. To add a badge we need to select a badge from top down list of controls in our app.
Another important point to note here is that we have placed badge as a child of the button control. You can do this by dragging the badge control towards right under button control. Our control hierarchy is shown in above figure. We care still not able to see the badge. The reason is we still need to provide data source for our badge. Lets add a data source. Click on "edit data source" button. Select "Sql" as a data source type because we want to count the total number of orders. Now we need to add a sql query which will count the number of total orders present in our system. We will use this query "SELECT count(id) from customerOrder". We are counting on the basis of "internal ids" because they are unique. Data source selection window should look like this
We see now a badge showing over our button and it is showing the count of total customer orders. For now we have only three customer orders in our app. | https://brixxbox.gitbook.io/brixxbox-documentation/controls/badge |
8331af3dc900-0 | Custom Grid Column Date Format
{% embed url="https://scribehow.com/shared/Custom_Grid_Column_Date_Format__-gCoRKIhSp6CgvPorDUgHg" %} | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/custom-grid-column-date-format |
4445b014ea2a-0 | Brixxbox Welcome Tour
{% embed url="https://scribehow.com/shared/ERP-Cockpit__2aJnoQ5HSgmWzNK8AqaOtg" %} | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/brixxbox-welcome-tour |
00baf1b19d5f-0 | description: How to use brixxbox custom functions in telerik
Telerik Page Footer Sum
BrixxPageFooterSum
Sums elements in a table up to this footer
{% hint style="info" %}
Each page sum function can only be used once in a report. Using it multiple times will result in wrong calculated values!
{% endhint %}
Demo
javascript
//This function belongs in a PageFooterSection of a telerik report
=PageExec("textBoxValue", //put in a textbox from your table row. Typically your value textbox, but whatever is in your row will work. This triggers the accumulation of the values
BrixxPageFooterSum(
Fields.yourValue, //put in the Value Field you want to sum up
ReportDefinition)) //this is fix (it will tell the sum to reset for each new report) | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/telerik-page-footer-sum |
634ed60d485b-0 | description: Example of a HTTP Request to the brixxbox
Create Report REST
Create Report REST
You can create a report from 3rd party systems by using a http POST call to the brixxbox.
We created a postman solution to demonstrate the call because you have to login first. Run in Postman
3 Environment Variables have to be set in Postman: "UserEmail" and "UserPassword" for the login call an "Workspace" for the url part of the CreatePdf call
You can specify if the report should be archived or not in the post parameters:
```json
// POST call to https://app.brixxbox.net/w/{{Workspace}}/c/default/reporting/CreatePdf
{
"reportName": "addresslist",
//optional parameters
"archive": false, //optional, false is default
"configName": "address", //optional, only if you want to archive
"documentTypeId": 1, //optional, only valid if configName and parameter 'id' is set and archive is true
"culture": "de-DE", //optional, report has its defaults
"parameters": { //optional
"id": 1
}
}
``` | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/create-report-rest |
a999056a0fe3-0 | Printing in LAN
How to print on a local Printer in your LAN
{% embed url="https://youtu.be/x4U6f5cEe4o" %} | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/printing-in-lan |
bc176747f6a9-0 | How Tos | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/README |
34ffcf26ca4d-0 | description: >-
Sums elements in a table up to this header (carry over from previous footer
sum)
Telerik Page Header Sum
{% hint style="info" %}
Each page sum function can only be used once in a report. Using it multiple times will result in wrong calculated values!
{% endhint %}
javascript
//This function belongs in a PageHeaderSection of a telerik report
=PageExec("textBoxValue", //put in a textbox from your table row. Typically your value textbox, but whatever is in your row will work. This triggers the accumulation of the values
BrixxPageHeaderSum(
Fields.yourValue, //put in the Value Field you want to sum up
PageNumber, //this is fix (the PageNumber variable from your report. this will tell the function when to take a sum)
ReportDefinition)) //this is fix (it will tell the sum to reset for each new report) | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/telerik-extension-functions/telerik-page-header-sum |
4669be681ae6-0 | Telerik Extension Functions | https://brixxbox.gitbook.io/brixxbox-documentation/how-tos/telerik-extension-functions/README |