id
stringlengths
14
14
text
stringlengths
4
2.78k
source
stringlengths
62
143
c14f201f98fa-0
DevelopmentChangeHistory This App will provide an overview for the changes done in the current workspace. The default view will list the changes chronologically and show the different types of changes. Provided the necessary access rights a selection of other workspaces is shown. Marked lines within the change history can be compared against the same items in other workspaces. If the comparison differs, a view can be triggered to show the differences in detail.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/developmentchangehistory
446cd780e198-0
AuditHistory Record History The Record or audit) history allows you to monitor all the changes to records and restore previous states for single records. Demo {% embed url="https://youtu.be/mDoX_vjp2Eg" %}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/audithistory
e003e10b2fc5-0
UserDashboards User Dashboards User dashboard is a whole panel or a page dedicated to creating shortcuts for users workspace. Here Brixxbox allows users to add apps which are the most important ones. Each of the app will be shown on the dashboard page. User can access this page by clicking on the logo of their workspace. Here is an example workspace. To add different apps to this dashboard section, user should follow these steps. From left navigation panel of Brixxbox goto configuration then scroll down and select "user dashboards". Here you will find a list of all the apps that are available on dashboard panel and Brixxbox also allows system users to manage access of different dashboards for different users. An example list of dashboards for different users is given below. In this snapshot we can see that for multiple user, we are selecting same app "dashboardDemo". We can also choose different apps here. To add a new app in a dashboard for specific user group, select new on the users dashboard page. A new panel will be opened. It will look like this. Select the respective properties and click create button to add a new app to specific users dashboards in Brixxbox. In the tutorial below, user can find how to add a new app to dashboard. Demo {% embed url="https://youtu.be/ZKrE9RcVeeM" %}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-userdashboards
bbd62e20df34-0
DocumentTypes Document Types Here in the demom below we provide with all the necessary information for adding, editing, and using different document types inside our workspace. Demo {% embed url="https://youtu.be/PbOQi7cH4zc" %}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/documenttypes
af2967f856a3-0
Menu Editor Menu Editor The brixxbox menu for a workspace can be configured here. The menu is a tree like structure with folders and app endpoints in it. Demo {% embed url="https://youtu.be/K2SlHfd4WHA" %} How to edit the menu
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/menu-editor
f8ddf52b9254-0
Attachments Attachments In this app Brixxbox allow users to add any number of different file types to Brixxbox workspace from outside. It also allows all the documents generated within the workspace to be stored in this app. These documents can be used to facilitate the proper functioning of the user systems like generating reports for system user for example: report on total number of order placed and also for end user for example: it can be an invoice gernerated for a customer.All of these documents can be stored under this app. User must assign document type to each document. Tutorial We want to add an example image from our pc to brixxbox. Brixxbox allow users two ways to add a file: via drag and drop files from pc to attachments page, and via opening a file explorer then selecting a specific file. Lets now add our image. As we can see from above snapshot that added image is visible in the drag and drop area(highlighted in black). Also if you search in the list of attachments, you can find the same image. The interesting fact to consider here is that when we upload the file only file name, upload time, and user is being set. The properties document type and id are left as it is. It gives user an option to select the document type by himself. Lets do this by selecting the file and then clicking edit button. An edit panel will open, now select the "bild" type as we have selected file of type image and click on update. In this easy tutorial we learned how to add a file in Brixxbox and assign a document type to it.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-attachments
f4e6d21a8dcf-0
Reports Reports Reports are integral part of Brixxbox. They allow system user's to represent desired information to their clients. Basic example of any Point of Sale System is Order Report, it contains all the information of the user, the details of goods being purchased, and complete bill of whole order. Brixxbox allows system users to create report templates. User can create their own report templates in the form of html templates. Brixxbox keep a list of all report templates created by users and also allow their updation. How to work with reports in Brixxbox In this tutorial, we assume that user has a "customerofferreport". To start working with reports, click on report option under configuration in main side bar of your workspace. You will be prompted to report list page. Here you can add, remove, update, view, and download report templates. Select the play button of "customerofferreport", it will open the report at the bottom of the page. Scroll down to look at report. As we can see Brixxbox allows to alter different parameters like id, date, and name (shown in black box on top left). By altering thses parameters system user can search different orders provided by the company. On the backend Brixxbox uses Telerik report designer to display or modify reports. If you want to edit or create reports Brixxbox provides you with Telerik Report Designer. You can download this software from top right corner of report's page. Lets say we want to edit customerofferreport, we need to perform follwoing steps: Download "customerofferreport" from the list of reports. Open it in the Telerik report designer. As you can see, this is only generic template for this report and there are no specific values associated with the report like customer id. In order to add these details to see specific customer offers, we need to add a data source. Connect a datasource with your report. For this purpose you need to add your database connection string in Telerik. Brixxbox provides you with specific connection string. In Brixxbox main navigation panel goto Security then firewall, you can find this connection string by clicking "Show workspace DB connection string" button. In below snapshot, this button is highlighted in black. In this connection string, you can find all the important information regarding your workspace in Brixxbox like server name, password. You can also copy whole string by clicking on copy button.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/reports
f4e6d21a8dcf-1
In order to protect any workspace database, all the information is made private. User need to add its ip address to firewall exception list which is also present on the same page in order to access the data. User can add its ip address by clicking on new button and then providing its public ip. User is also allowed to add a range of ip addresses. New button is highlighted in red in above snapshot. Now, we have DB connection string as well as a white listed user ip and we can add it in DB connection wizard of Telerik. Add it in connection string textbox and click next. On next page, choose a shared connection so that connection will be saved locally and will be available for all local reports and give an alias name to it eg: custSPSTest20210201. On next page, we need to specify the sql query to get all the required data from DB regarding a valid customer offer. We can also supply a stored procedure here. On next page, we need to specify the sql statement parameters on the basis of which the query will be executed. Here we are selecting "parameter.id.Value" which is of type string. In this page, pass an example value of report id i.e 147. This can be used on next page to test whether the connection with data source is successful or not. As we can see that pressing execute button, a report data with id 147 is being returned. Now user can finish the connection wizard. We can also add a sub report to an existing report. Just click on sub report section and add a sub report to an existing report. There is only one limitation user needs to take care of which is, the sub report should be of type ".trdx".
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/reports
d0006af874dc-0
Configuration
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/README
b7623fdd371c-0
description: This app lets you create or delete api access keys. ApiKeys Installation of cloud Connector for Printing {% hint style="info" %} This is not the cloudGateway! {% endhint %} See how to use the Cloud Connector for printing. {% embed url="https://youtu.be/x4U6f5cEe4o" %} Upcoming Features Run As a Service See Connector Online Status in Api Keys Panel Edit Config in Api Keys Panel Docker Installation and Configuration Beside the Print Gateway (as ssen in the video), there is a new docker gateway. Use the Docker command column to pull and start a Docker container in your local network.\ Use the settings in the ApiKey list to configure the service endpoints for each docker installation like in the sample below. ``` { "Connections": [ { "Endpoint": "LocalFirebird", "Plugin": "Firebird", "ConnectionString": "Server=192.168.178.39;User=SYSDBA;Password=abcde" }, { "Endpoint": "LocalSql", "Plugin": "MsSql", "ConnectionString": "Server=acme.com" } ] } ```
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/apikeys
5b71efe75d41-0
StandardMessages Custom messages User can add thank you, warning, and error messages here and they can be used afterwards anywhere in your app. Brixxbox allows custom messages with placeholders that can be queried and translated by script. These test parameters are captured in Json format. Example Usages Here we will consider a thank you message. We want to display this message after successful placement of order by the customer on our plateform. To make the message more personalized we also want to show the customer name and order id in the thank you message. To generate a custom message follow the steps below: From side panel of your work space click on configuration then on "custom messages". It will open custom messages app. Click on create, a pop up window will be opened. Add the name, description of custom message. Also add test parameters in json format. Name : Thank you! Message: Hey {customerName}, your order has been placed successfully .Your order number is {orderNumber}. Thank you for shopping with us. Test parameter for the above sentence javascript { "customerName":"Sven", "orderNumber":1578 } The edit panel should look like this: Now click on save button and your custom message is stored permanently in this app.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/standardmessages
689305a5aab5-0
Cron Definitions Cron Expression Basic structure A cron expression consists of five individual parts (That is the basic version. Some cron expressions support additional values). | Part | Allowed Values | | | ------------ | --------------------------- | - | | Minutes | 0-59 | | | Hours | 0-23 | | | Day of month | 1-31 | | | Month | 1-12 | | | Day of week | 0-6 (0 = Sun, 1 = Mon, ...) | | \ In addition to the above values the following characters can be used. examples 15 1 * * * every day at 1:15 am 0 8-17 1-5 * * Monday thru Friday, once every hour between 8am and 5:59pm 0 5 1 */3 * at 5am on the first day of every third month of the year (Jan, Apr, Jul, Oct) 0 0 1 1 * start of the year */5 3-14 * * 6 every five minutes between 3am and 2:59pm only on a Saturday Cron expressions are widely used. To get more detailed information those links might be helpful https://en.wikipedia.org/wiki/Cron https://crontab.guru
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/jobs/cron-definitions
8a8f7ee431f8-0
Jobs In this app, Brixxbox allow users to add automated jobs to their workspace. If a user want to perform a task at regular intervals then user can add its task in a job schedular provided by Brixxbox. Job Job provides functionality to automate the tasks provided by user after specific time interval and on regular basis. User can create one job for each task. Brixxbox will provide book keeping of those jobs, for example logging of errors etc. A job contains following properties. Job Properties Name Each job should have a meaningful name. It will help user to identify the purpose of the job. For example, status update job etc. Cron It is one of the most important properties. It is used to schedule jobs, it specifies that the job will run on a given scheduled time. Its value is divided in to five parts(* * * * *). The first part represent minutes. The allowed values ranges from(0-59), The second one represent hours and its value ranges from(0-23). Third part is day of a month, its value ranges from (1-31) . The fourth part is month itself, its value ranges from(1-12). The last part represents day of the week(0-6). 0 is for sunday, 1 is for monday and so on. In order to learn more about CRON click here. Type App job allows user tasks to be of three types: server side function click here, sql statement click here, and sql stored procedure click here. Script Select It is the customized code for above job types. It can be stored in the Brixxbox and will be utlized here. User id Each job should have a user id attached to it. This creates ownership of the app job. Description Each job should have have a meaningful description. It is optional but it will help all the workspace users to know exactly what a job is doing. Example
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/jobs/README
8a8f7ee431f8-1
Example Lets now look at one example job. Suppose we want to prepare status emails for managers. We want to generate these emails at 03:00 every day. For this purpose we need to set the CRON value to (00 3 * * *). It means that on 00 minute of 03:00 hour, on every day of each month and on each week day execute this job. We also want to make this server side function. In next step, we will choose custom code script, as we have already written this script, we can select it from drop down list. Now we need to assign a user id to this job. In the end, we need to give description for our newly created job. In the below snapshot, we can see all the options filled. Click save button to save this job.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/jobs/README
36ab0e6db4a6-0
App Editor
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/README
ef47ef87147f-0
AppDiscussion Discussion When enabled, the toolbar button for record based discussions will be activated. You will need to activate discussions for the master table in the table editor before using this.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/appdiscussion
6d49374f6d00-0
AppIcon App Icon you can choose an app icon, that will be displayed in the single page tab headers, for example.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/appicon
dd8198da4e12-0
App Editor Properties
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties
35399ee75cce-0
AppHistory History This will activate the audit trail record history in the toolbar. You will have to create the audit history for your mastertable in the table editor first.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/apphistory
9beeeb844f7f-0
Controls
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/README
a4945eaa78d7-0
description: >- A grid displays a list of records, specified by the sub data source of that control. grid 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
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/grid
a4945eaa78d7-1
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. 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.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/grid
a4945eaa78d7-2
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: 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/configuration/app-editor/controls/grid
e19c761dd419-0
description: >- Comboboxes are often used to refer to header records (an order line record will most likely have a combobox with its order record). combobox Demo {% embed url="https://youtu.be/KhrooXGYBQ4" %} Documentation In Brixxbox app configurations you can add different controls. One of them is ComboBox. Each control has four types of settings General Properties Size Style Translation General Properties These are main behavioral properties of any control. These are responsible for control's functionality. Control Type For using combobox control, combobox control type should be selected from drop down list. Control Id For each Brixxbox app, this id should be unique. By default Brixxbox assigns a random id which starts with underscore and followed by a string. For Example: "_abcdef". Brixxbox allows you to change its value only once. You can change this id to any value. Recommended way is to start with mandatory prefix(set in app). It can contain numbers, underscores, uppercase and lowercase letters. Each control is always accessed with its Control Id. For Example, you can get and set control value by using its ControlId. If you want to store value of this control in database, use the database button to create a column. You will be able to select column datatype, max length, can be null, options. Label It is the display value for control. Data This property specifies from where this control gets data. If no option is specified then by default "Not in Database" option is chosen. If you want to set it then you have to specify the controlId of data source. 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. Combobox Key Field This is the field value from the sub data source. It also becomes the value of our combo box. When we have to get the value of our combo box using "getfieldvalue" function. It will return the corresponding id of selected combobox entry. Combobox Value Field
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/combobox
e19c761dd419-1
Combobox Value Field This option defines how each entry of your combobox will be displayed. It can be a single or multiple columns from sub data source. For single column just name the column. For Example, "adrName". If you want to choose multiple columns, then use curly brackets. You can choose any place holders between them. For example, {id} - {adrName}. "-" is a place holder while id, adrName are column names. Min Search Length This option specifies the minimum search length of string to trigger search function. If you do not want any search function then specify "-1". In case you want to specify after how many characters Brixxbox should trigger the search and get actual records from the sub data source, specify it here as positive integer. For Example, if value 3 is specified then Brixxbox will trigger actual search only after 3 characters are entered in search field. Multiselect When this option is specified, one can select multiple values as combobox entries. Select List Button By default this is hidden. It opens a list of all items of sub data source. It can be used to select an entry from combobox. Select Edit Button By default this is enabled. If a value is selected in combobox then by clicking edit button will open the complete record in corresponding application. If it is clicked without any value it will open the corresponding application with no record. It can be used to add a new record. Default Value This value is set when an application is opened or a new record is created. Tutorial This tutorial will follow the similar example used in the demo for combobox. You can find this demo at the top of this page. This tutorial assumes that a user has an existing app and they want to add a new control of type "Combo Box". First of all, select "combo box" from list of controls. After that you need to give a id to your combobox and create column in database if necessary. Here we named it "myCombo". Also, add a public label for combobox. We labelled it "Address".
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/combobox
e19c761dd419-2
Now save the control. It is time to assign a sub data source to our control. Click a sub data source button. Here you can assign different types of data sources. For this example, we will use config data source type. After that select the corresponding app config. We are selecting "address" config because we want to display all the addresses. Up till now we have defined a combobox, assigned a unique control id and also added a sub data source to it. Now we want to assign two main properties to combobox: combobox key field, combobox value field. "Combobox key" property is a column from result set that will also be the value of our combobox when the entry of combobox is set. Mostly it is the id of result set. Here we also choose id. We can use this value for comparisons. For combobox value field, we want to display values of two columns: adrNumber, adrName from result set. We have to use curly brackets when using multiple columns. Each entry of combobox will now represent the number of the address and the person's name. For example "10001 John". In this way we can define and use combobox but can we use the value of combobox to display or change some other data? the answer is yes!. For demonstration, we will add grid control (see grid documentation) "myGrid". We also assign address config as a sub data source for our grid control. Now "myGrid" control will display all the addresses present in the result set. As you can see from above picture that nothing is selected in our combobox "Address". Now we want that whenever we select a record in combobox, the grid displays the same selected record only. For this purpose, we need to modify sub data source of mygrid and add a where clause. An important thing to note here is that all controls of an app are available as sql parameters. In where clause, we need to specify a condition which displays only a record which matches combobox value. We can specify this as "id=@myCombo". Remember that we selected "combobox key field" as id of sub data source "address". In order to pass this change to grid, we have to add a control event "onChange" to our combobox control. Whenever our combobox value change, we want "myGrid" to refresh.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/combobox
e19c761dd419-3
Now save and set a combobox value and we will be able to see only selected record in "myGrid". As we can see from figure below. Combobox also allows us to select multiple records at a same time. To achieve this functionality, select "multiselect" checkbox from combobox properties. You can see from figure below that multiple values are selected in combobox but there is no record shown in grid. This is because we were using where clause for comparing one value of combobox but now our combobox has multiple values. Now if we call "getfieldvalue" function on our combobox. It will return an array with selected combobox key value's. Now we have to update our where clause logic in grid to display all selected records. We add this statement to where clause "id in (select value from OpenJson(@myCombo))". This statement says that if a value is present in result set then display it in grid.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/controls/combobox
0bc0fa7d06b7-0
AppAttachments Attachments When enabled, users can add files to the records of this app.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appattachments
28721c221295-0
GridColumnFilter GridColumnFilter You can create filter in all grid columns. You need to specify the column name and the type of filter you would like for this column. The following types are available: text: Will show a text input field for the search criteria. select: A selection for all available options is shown. multiSelect: like select-option. It is possible to select multiple entries. [ { "column":"imImei", "filterType":"text" }, { "column":"imItemId", "filterType":"select" }, { "column":"imItemGroup", "filterType":"multiSelect" } ] \ If the grid is configured for Server Side Paging additional options are available. serverSideMinInputLength: Allows to set a minimum character count for user input, before the search is triggered. serverSideSQLStatement : If the filter option is set to select/multislect a SQL statement can be used to show the available options. For config based grids this is optional (A distinct value for the column will be generated by default). For SQL based grids this setting must be provided. The setting needs to have the name of a valid SQL Statement defined in this app. The SQL statement must return a list consisting of 2 columns: id and text. The id value will be used as the search criteria. The text value will be shown to the user as option. The parameter œcolumnSerachValue will contain the current user input. Example of a valid SQL statement: DECLARE @searchLike nvarchar(100) = '%' + @columnSearchValue + '%'; SELECT * FROM ( SELECT 'id1' AS id, 'text1' AS text UNION ALL SELECT 'id2' AS id, 'text2' AS text UNION ALL SELECT 'id3' AS id, 'text3' AS text UNION ALL SELECT 'id4' AS id, 'text4' AS text UNION ALL SELECT 'id5' AS id, 'text5' AS text ) AS ResultList WHERE text LIKE @searchLike
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridcolumnfilter
28721c221295-1
For columns with date controls (datebox.md and datetimebox.md) a date range selection will be provided. The range selection enables the user to set a start and end date. Additionally the brixxApi call 'gridColumnConfig' enables setting of predefined selection ranges. Those ranges can be picked by the user without the need to use the calendar. This way commenly used selctions can be predefined for each individual grid column, if applicable.\ \ Example setup for predefined selections (Note: The the-moment.js-library.md is used to set start and end dates): ```javascript //Code should be placed as event "onAppStart" //each entry within 'range' must have an array. First element is start date for //selection and second the end date. The third array element is an optional string. //If provided it will show up as tooltip for the selection. const predefinedSelections = {'range': { 'Today': [moment(), moment()], 'Yesterday': [moment().subtract(1, 'days'), moment().subtract(1, 'days')], 'Last 10 days': [moment().subtract(9, 'days'), moment()], 'This Month': [moment().startOf('month'), moment().endOf('month')], '2 years back': [moment().subtract(2, 'years'), moment().subtract(2, 'years').add(1, 'months'), '2 years back as start and 1 year and 11 month as end of selection'] } }; brixxApi.gridColumnConfig ('gridName', 'columnName', predefinedSelections); ```
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridcolumnfilter
6b101e186b70-0
AddToAttachements This setting controls whether the captured image should be saved directly as an attachment to the current record.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/addtoattachements
cc3bd333347d-0
editAbsoloutGridHeight Here you can set a fixed height for the grid. The specification is in percent of the complete screen height.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/editabsoloutgridheight
597e35261809-0
CreateMenu Create Menu A default menu Folder and Entry will be created. This is just a more convenient way than using the menu editor. You will probably use the menu editor at some point to move things around in the menu tree.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/createmenu
de87dc1957eb-0
HiddenGridColumns Hidden Columns This is a comma separated list of control, that you want to hide in this grid control. myControl1, myControl2
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/hiddengridcolumns
4f73ad3b50bc-0
DecimalDigits DecimalDigits Set the number of decimal digits here
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/decimaldigits
d23cefbd3857-0
ComboboxMinSearchLength ComboboxMinSearchLength Minumin Characters for a comboboxy to trigger the search. -1 for no search function at all
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxminsearchlength
b0e6278c49b3-0
dateTimeUtc DateTimeBox UTC If this Checkbox is activated. You will see the Date time in you local timezone but the value behind the control is a utc (GMT) time. setFieldValue will assume you set a utc time and will add the local timezone just for the display. getFieldValue will give you the utc time as well. So users in different timezones will see different values, but in the database there is just the utc time stored.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/datetimeutc
a9d2f18204d7-0
AppMasterTable Master Table You can define the underlying table for your app, if it stores data. You can also create a new table.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appmastertable
2758931608bc-0
AppConfigToStartSourceField AppConfigToStartSourceField The field that should be submitted to the child app
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appconfigtostartsourcefield
eb630dcd26c8-0
ChartLabel ChartLabel The column from the sub data source for the Chart label
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartlabel
6aa997ce67f9-0
AppConfigToStartTargetField AppConfigToStartTargetField The field in the child app that should get the Source Field Value
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appconfigtostarttargetfield
c5b13e21ca14-0
ComboBoxListButton ComboBoxListButton This setting determines if a Combobox has a List Button next to it, to select the value from a List instead of the Combobox itself. The List provides more features for filtering and searching than a Combobox . The selected Value from the list will be set in the Combobox on selection.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxlistbutton
b4d5480d33cb-0
HelpText Help Text You can set a help text, to display below a field.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/helptext
93a3013d6315-0
chartLabelAxesY Chart Label for Y Axes This is a text, that will be used to label the chart y Axis
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartlabelaxesy
8fd107117bef-0
ComboboxValue Combobox Value This defines what will be displayed in the combobox. It can be a single column from the sub data source or a string with placeholders adrName {id} - {adrName}, {adrFirstName}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxvalue
8e65b0ab6b5b-0
AppTitle Title This title will be translated and it can contain variables from four loaded record, that will be replaced in the title, once a record is loaded. We used a @prefix in the past, that is deprecated. Order {id} {cordAddressId.adrName} This will result in: Order 1 John Doe if no '{' character is found in the title, brixxbox will add an {id} to your title to display the loaded record id. \ If no app title is specified, the app id will be displayed for your app.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/apptitle
9f74c1aee0fd-0
AutoDisableOnEdit AutoDisableOnEdit This will disable a field, if a record id is set. In other words, the field is enable in create mode but disabled in edit mode
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/autodisableonedit
4c45d1eeb1bd-0
GroupGridColumns GroupGridColumns A comma separated list of columns, that should be used for grouping. By default the grouping criteria will be the cell values for this column. The same cell values are put in one group. The column itself will be hidden from view because it will only show the group name. If a search is added to the column, the column stays visible. For datetimebox.mdthe grouping value is set to the date part only and the column stays visible in order not to lose the time information. For columns with date controls (datebox.md and datetimebox.md) an individual grouping can be tailored to the specific data. This way date ranges can be shown in groups. e.g. "today", "this week", "last month". The brixxApi call 'gridColumnConfig' enables setting of this individual grouping ranges. \ \ Example setup for date grouping (Note: the-moment.js-library.md is used to set start and end dates): ```javascript //Code should be placed as event "onAppStart" //each entry within 'grouping' must have an array. First element is start date for //the group and second the end date. If groups overlab (e.g. "today", "this week", "this month") //the first matching entry is picked. columnAddOnSettings = { //add some grouping criteria for this date column 'grouping':{ 'Future Dates': [moment().add(1, 'days'), moment('9999-12-31')], 'Today': [moment(), moment()], 'Last 7 days': [moment().subtract(6, 'days'), moment()], 'This Month': [moment().startOf('month'), moment().endOf('month')], 'This Year': [moment().startOf('year'), moment().endOf('year')], 'Last Year and Older': [moment('1970-01-01'), moment().endOf('year').subtract(1, 'year')] } }; brixxApi.gridColumnConfig ('testGrid1', 'cmpSomeDate', columnAddOnSettings); ```
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/groupgridcolumns
c499ea4c248c-0
DisableGridResponsiveness DisableGridResponsiveness This will disable the responsive layout of the grid and you will be able to scroll horizontally
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/disablegridresponsiveness
261858b9f6e7-0
Data Data specifies where this control gets its Data from. If no DataSource is set for the control, you get a List of table columns from the master table. If DataSource is set, you have to enter a Field from this DataSource (like a controlId if your DataSource is a Config)
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/data
4838f2563fa1-0
CascadeCopy CascadeCopy If this property is set, a copy Operation in the app, that contains this Grid Control, will copy all Lines in the Grid for that Record. Say you want to copy an order record with all its orderlines.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/cascadecopy
228ecca4006c-0
hideEditButtonColumn hideEditButtonColumn Set this if you want the edit button column to disappear.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/hideeditbuttoncolumn
8ebcd15b2ee1-0
AppMailHistory Email History When enabled, this app gets a new toolbar button for the email history sidebar. This sidebar will show emails regarding the actual record.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appmailhistory
a06f0d873563-0
DevMode Develop Mode If the develop mode flag is set, this Version of the app will no be delivered to endusers. They will get the latest, non dev mode version.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/devmode
dc43a05fdc4e-0
chartLabelAxesX Chart Label for X Axes This is a text, that will be used to label the chart x Axis
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartlabelaxesx
dca9bf56719c-0
AppPreviewRecordId App Preview Record Id This is just a convenient way of loading a record at design time. It is specially useful, if you need a record to be loaded when designing your app, because some fields might be invisible when no record is loaded. This has absolutely no effect outside the app designer.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/apppreviewrecordid
1f2e72c68fb2-0
Enable Enable This will enable or disable the input.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/enable
1977de60c639-0
AppColor App Color You can choose a color theme for your app. This will be used in the single page tab headers for example.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appcolor
f3a0b775842e-0
AppParameters App Parameters App Parameters are Flags, that can be set by calls from the menu. You can react oto these flags in app events to change your app behavior. javascript if(app.parameters.includes("myFlag")){ console.log("Parameter is set"); }
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appparameters
bea281c5484d-0
AppPrefix App Prefix Just like table prefixed, you could specify a prefix for all your controls in your app. Opposite to tables, this prefix is not mandatory
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appprefix
912bd8ea4996-0
ChartData ChartData The column from the sub data source for the Chart data
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartdata
197439aea3df-0
ComboboxKey ComboboxKey This is a fieldid from the sub data source that will represent the value of the combobox. In most cases this is "id"
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxkey
af67f53ef7d6-0
GridToolbarVisibility GridToolbarVisibility Set the visibility for the toolbar right above the grid
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridtoolbarvisibility
af0ae5672d16-0
CascadeDelete Cascade Delete If this property is set, a delete Operation in the app, that contains this Grid Control, will delete all Lines in the Grid for that Record. Say you want to delete an order record with all its orderlines.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/cascadedelete
c9486ed7b035-0
CssTemplateContent CssTemplateContent The css Content for the control
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/csstemplatecontent
74e04d9e6435-0
GridFooter You can create a footer for grid columns. The value for "column" specifies the target column. The following parameter can be supplied: œcolumn: name for the target column œselect: will specify the Range for data selection. Possible values are œall or œvisible. œall is the default setting and will select all available data from this column. With œvisible only data matching a selection will be processed. If no selection is active, all data will be shown. œaction: will specify what action will be taken for the given data. Possible values are œsum, œavg (average), œmin (minimum), œmax (maximum). œsum is the default. œdecimalDigits: If you are using a config based grid the decimal digit setting will be inherited from the column setting. Otherwise the default will be 0. If u want to overwrite this behavior this setting can be used. œtextLeading: Add a text in front of the value. œtextTrailing: Add a text behind the value. ``` //the following will give a sum for all data for the column "cordGrossValue" [ { "column":"cordGrossValue" } ] //the following will give an average for the visible data within a selection. If no selection is activ all data will be processed [ { "column":"cordGrossValue", "select":"visible", "action":"avg" } ] //the following will give one decimal digit for the value and add leading and trailing text. e.g. "Total: 123.4 $" [ { "column":"cordGrossValue", "decimalDigits": 1, "textLeading": "Total: ", "textTrailing": " $", } ] ```
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridfooter
8bd5e8657aa0-0
ComboBoxEditButton ComboBoxEditButton This setting determines if a Combobox has a Edit Button next to it, to jump right to the selected record.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxeditbutton
ed0a96712973-0
ChartType ChartType Choose from different chart types
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/charttype
f44cfd13a5bc-0
GridFilterVisibility GridFilterVisibility Set if the filter (search) field above a grid should be visible
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridfiltervisibility
41ef74fc0ac7-0
GridColumnOrder GridColumnOrder A comma separated list of column, that should be displayed as the left most columns.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridcolumnorder
e11e6dd5209a-0
AttaDocType Here you can select a document type for the attachment.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/attadoctype
106dd2403fe4-0
AttachementFilename User defined file name for the attachment. This can be extended with values from fields of the current application. This is achieved with @controlId at any position of the text. A user defined file name is always extended by the current timestamp.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/attachementfilename
440ce18a5550-0
ConcurrencyControl Concurrency Control This is used to prevent users from overwriting records. If two users have loaded the same record, and both make changes, than the user that saves first, will commit his changes, but the second user will not be able to save after the first user saved. In other words, you will only be able to save a record if noone saved it between you loading it and your save attempt.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/concurrencycontrol
029fc7137259-0
GridRowOrderDragDropParam RowOrder Drag & Drop Parameter If an app config is used as a sub data source, the values will be filled in automatically. If u want to set the parameter manually, the values must match the needed information for a SQL-Update statement. See the example below. In addition the relevant table/tables must be prepared to be capable to read and write the ordering data. See the list provided for Manual ordering of rows in a grid { "targetTable": "exampleTableName", "targetKeyField":"exampleId", "targetRowOrderField":"exampleRowOrder" } - e.g: Those parameters will lead to an update statement like this UPDATE exampleTableName SET exampleRowOrder = @newRowOrderPosition WHERE exampleId = @id; {% embed url="https://youtu.be/i5rwxNfoKJM" %}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridroworderdragdropparam
ea890c1eae3d-0
EditDefineUnit You can specify the unit character here ($, € ans so on)
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/editdefineunit
74c467e68e9e-0
chartData ChartData Thsi is a simple form to configure the chart. Just list the Columns of the sub datasource you want as lines (or bars, depending on your chart type). The lines will be rendered with default behavior and random colors.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartdata-1
ec2ba26dea9d-0
ComboboxMultiselect Combobox Multiselect Set if you want your users to select multiple values.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/comboboxmultiselect
a59f144eab56-0
ChartDataJson ChartDataJson This is a more complex method to configure the chart than chartData but offers a lot more possibilities. See a List of properties, you can set per line, or bar: json [{ "data": "OverallPrice", //the column to take for the line values from the sub dataset "color": "red", //line color "fill": "false" //do not fill the gap to the bottom line }, { "data": "OwnPrice", //the column to take for the line values from the sub dataset "color": "blue", "backgroundColor": "yellow", //background color for the gap or the bar, in case of a bar chart "fill": "0" //means you fill the gab to the first (0) line. }]
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/chartdatajson
fa8d93d9870e-0
DefaultValue This value is set when the app is opened or a new record is created. In the background, the brixxApi function setFieldValue is called with this value. Example 1 ``` 1 ``` Example 2 ``` "Hello World" ``` Example 3 ``` await app.sqlReadValue("readAddressName", { id: 1 } ) ```
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/defaultvalue
20fbc8798a9d-0
GridPageSizeVisibility GridPageSizeVisibility Set if the page size should be choose able for users
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridpagesizevisibility
344529dac434-0
GridAutoRefreshIntervals GridAutoRefreshIntervals You can provide a comma separated list of values for seconds. For each value the user will have the option to select it as an auto refresh value for reloading the grid content. Values above 59 seconds will be rounded and shown as minutes. e.g. A list like "30, 60, 900" will generate a drop down menu with options like "30 seconds, 1 minute, 15 minutes".
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridautorefreshintervals
aed34a94bb83-0
GridSelectMode GridSelectMode Choose the select mode
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridselectmode
f78ea9900661-0
blockInputDuringEventExecution BlockInputDuringEventExecution if set, the brixxbox will block all user actions until the event has finished
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/blockinputduringeventexecution
dee67aea0d1d-0
ButtonStyleClass Icon Size Icons inherit the font-size of their parent container which allow them to match any text you might use with them. With the settings, we can increase or decrease the size of icons relative to that inherited font-size.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/buttonstyleclass
17922d3375b7-0
hideSelectCheckboxColumn hideSelectCheckboxColumn Set this if you want the select checkbox column to disappear.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/hideselectcheckboxcolumn
54a0b266533a-0
AppAltViewName Alternative View Name All Apps with an underlying master table will create a view bbv_{AppName} if you want an additional view with a special name, you can specify that here. The bbv_* view will be created in all cases.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appaltviewname
8e0d74fbab2c-0
GridNoHyperLink This allows you to set a list of combobox columns, that will not have a hyperlink, like the usual combobox column would have
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridnohyperlink
2de7b079996b-0
AppConfigToStartName AppConfigToStartName Place the id of an app config here to embed
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/appconfigtostartname
ad0cfe5c23b0-0
GridInlineEdit GridInlineEdit Grid inline editing is not available at the moment
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridinlineedit
cf3680b8190c-0
GridSortingMode GridSortingMode Set if sorting by the user should be allowed If you want to allow the user to manually sort rows in the grid, options for "Allow Drag & Drop" are available. To use this extended option the underlying sub data source must be able to handle the manual sorting information. If an app config is used as a sub data source please check Manual ordering of rows in a grid before activating the setting. The app config only needs to be enabled for handling the necessary data. If you want to use a SQL-Statement as your sub data source the relevant table/tables must be prepared to be capable to read and write the ordering data. {% embed url="https://youtu.be/i5rwxNfoKJM" %}
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/gridsortingmode
393340a3be3e-0
ServerSidePagingIndexColumns Server Side Paging Indexed Columns When using serverside paging, most of the time it is not usefull to search in all columns as that means the grid is as slow as if it was not paged on server at all. We need to configure the columns that are indexed and can be used for ordering and searching. The other columns will not get a order option and will be ignored for searching. In case of a combobox (cordAddressId) the _value column will be searched as well. no need to configure that. adrName, adrFirstName, adrCompanyId
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/serversidepagingindexcolumns
f7c23582c07a-0
Label This is the Label, that is displayed for this control. The Label is translated automatically but you can set your manual translation in the translation Tab. All Labels must be in the Workspace Default Language (english if not set differently in the workspace settings)
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/label
a48830ab0a48-0
htmlTableDisablePagination Disable Pagination If checked, there will be no pagination for the HTML table. Be careful with the amount of data!
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/htmltabledisablepagination
067923385b8a-0
ServerSidePaging Server Side Paging Reads only the actual page from the server instead of all table data at once. Use this for large tables to improve performance. The subdata requests must NOT have ORDER BY
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/serversidepaging
1521f7824a4b-0
wysiwygHtmlFragment When checked. brixxbox will save the html content as a fragment, exactly as you see it in the editors code view. If unchecked, brixxbox will wrap the content in a valid html document with header tag and \\. If you would like to print the text in telerik reporting, you should check this, to keep the whitespaces.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/wysiwyghtmlfragment
06975c626604-0
NoSpinButton Check this option, if you do not want up/down arrows next to the number input.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/nospinbutton
a68401468b26-0
InputTag InputTag if set, the user is allowed to add new tags
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/inputtag
a58aabd3c8ba-0
TagValue TagValue The value that should be displayed
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/tagvalue
8ba19e90832c-0
ValidateInputBeforeExecution ValidateInputBeforeExecution If set, the brixxbox will check the validation before executing the event sourcecode
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/validateinputbeforeexecution
449a96e7dace-0
RecordObservation Record Observation When 2 ore more users open the same record, only the first will be able to edit it. Other users will have to option to request the edit mode.
https://brixxbox.gitbook.io/brixxbox-documentation/configuration/app-editor/app-editor-properties/recordobservation

No dataset card yet

New: Create and edit this dataset card directly on the website!

Contribute a Dataset Card
Downloads last month
4
Add dataset card