Die hier gezeigten Screenshots enthalten unser internes CI. Selbstverständlich können Sie unsere White-Label-, und Style-Funktionen nutzen, um die Optik Ihren Bedürfnissen anzupassen.

Parameters

1. controlId - The id of the calendar control

Example Usages

    brixxApi.cancelCalendarChanges("myCalendar");

Parameters

1. configName - the name of the config

2. id - the record id you want to delete

Example Usages

   brixxApi.deleteConfigRecordById("address", 123);

Parameters

1. options - json object

   • id - the record id. Optional. By default, this is the current record id. (The current record id can be accessed here: brixxApi.actualRecordId)

   • noConfirmMessage - Optional. By default, this is false. If set to true, you will not get a confirm MessageBox. the record will be deleted.

Example Usages

1. Simple

2. Simple - No Confirmation

3. Without displaying the record

Brixxapi allows user to set a claim value. This claim Value gets added when user gets logged in. It is used to identify users claim. For example, to check whether a user is someone who he claims to be or not. By using this function, we can get userClaim and make useful comparisons in our apps.

Parameters

1. claimName - This is the only paramter this function takes. It is the claiName which should be in the form of string.. Brixxapi allows user to add claim name with or with out "claim_" prefix.

Example

Let suppose we have a claimName parameter "EFitDealer" then Brixxapi will consider both "EFitDealer" and "claim_EFitDealer" as same.

Example Usages

We can use "getUserClaim" function to get user's claim, a way to check user identity. As a parameter, we need to provide the claimName to this function. We can provide only the claimName or the claimName plus "claim_" as prefix. Lets see both of them in action. We have a claimName "EfitDealerNumber", now we want to get userClaim:

Lets first do it without prefix "claim_".

   let dealerNumber = brixxApi.getUserClaim("EfitDealerNumber");
   console.log("The dealer Number is: " + dealerNumber);

It is ame as the previous example but now we use prefix.

   let dealerNumber = brixxApi.getUserClaim("claim_EfitDealerNumber");
   console.log("The dealer Number is: " + dealerNumber);

An important thing to notice here is that it is required by Brixxbox that for using SQL Parameters for claims must have to start with the "claim_" prefix.

For example, Userclaims can also be used as SQL parameters:

   select @claim_EfitDealerNumber

This functions is used to trigger global search of the whole workspace. It only takes one parameter which is a search keyword. This function is directly used in the each Brixxbox workspace. User can find it in top right corner of each workspace page. It is a textbox accompanied by search button. User needs to enter a string in the global search field at the top of the screen and it will trigger the search function. It can be useful if you want to search for a scan result or anything within your workspace in seconds.

Parameters

1. searchTerm - It is of type string.

Example Usages

User can find this button on top right corner. It looks like this.

User can enter any keyword and it with return thespecific results. User can also use this function in their apps. For this user need to provide a search keyword and can use it to retreive data from the global workspace. If user want to search "address" the code will look like this

   brixxApi.globalSearch("address"); //triggers a search for "address" in global address space.

Loads a record from brixxbox server and returns a promise. This is a async function. You have to await the result, if you want to use it. This function will not display the record, it will just load and return it. To display the record, use the function result with displayRecord.

Parameters

The first parameter is a record id

Example Usages

Simple (pay attention to the await keyword)

   let myRecordId = 123;
   let myRecord = await brixxApi.loadRecordById(myRecordId);

Egal welche Anwendung erstellen wollen, Sie profitieren stets von unseren integrierten Feautures (Auszug):

• Modernes Design

• cloudbasierte Webanwendung (responsive)

• Integrierte MS-SQL Datenbank

• Rollen und Rechtkonzept bis auf Feldebene

• Mandanten und Währungsfähigkeit

• Multi-Language (automatische Übersetzung)

• Integrierte KI

• Umfassende Schnittstellen-Technologie

• Integriertes Archiv

Viele unserer free-Trial User interessieren sich auch für folgende Themengebiete:

• Technische Übersicht

• Praxisbeispiele

Schnittstellen

Über verschiedene Schnittstellen wie Rest- oder Third-Party-APIs können Ihre Anwendungen mit anderen Systemen kommunizieren.

Infrastruktur

Im Standard hosten wir die Applikationen und Daten in unserer Microsoft-Azure-Cloud. Je nach Setup und konkreten Kundenwunsch sind auch individuelle Konzepte möglich, die je nach Einzelfall geklärt werden müssen. Als Datenbank wird nur der Microsoft SQL-Server unterstützt.

brixxbox unterstützt 2 Setups, die sich primär hinsichtlich der zu Grunde liegenden Datenhaltungsstrategie unterscheiden:

Hinweis: In Ausnahmefällen können wir auch eine komplette on-premise (Daten & Web-Service) Installation durchführen.

KI (künstliche Intelligenz) ist in vielen Bereichen der Software-Entwicklung von großer Bedeutung und der Low Code-Anwendungsbereich ist keine Ausnahme. Low Code-Software bietet visuelle Drag-and-Drop-Tools, die es Benutzern ermöglichen, benutzerdefinierte Anwendungen ohne tiefgreifende Programmierkenntnisse zu erstellen und zu verwalten. KI kann in diesen Prozess eingebunden werden, um die Entwicklung von Anwendungen noch schneller und einfacher zu gestalten.

Eines der Hauptanwendungsgebiete von KI in Low Code ist die Automatisierung von Workflows. Mit Hilfe von KI-Technologien wie maschinellem Lernen und natürlicher Sprachverarbeitung können Low Code-Anwendungen automatisiert werden, um Daten einzugeben, Prozesse auszuführen und Benachrichtigungen zu senden. Dies kann die Effizienz von Unternehmen erheblich verbessern und den Bedarf an manueller Arbeit reduzieren.

KI kann auch in der Analyse von Daten eingesetzt werden, um Unternehmen dabei zu helfen, bessere Entscheidungen zu treffen. Low Code-Anwendungen können mit KI-Algorithmen ausgestattet werden, die große Mengen von Daten analysieren und wichtige Insights bereitstellen, die für die Geschäftsführung von großer Bedeutung sein können.

Insgesamt bietet der Einsatz von KI in Low Code-Anwendungen viele Vorteile für Unternehmen. Es kann die Effizienz erhöhen, den Bedarf an manueller Arbeit reduzieren und wichtige Insights liefern, die bei der Entscheidungsfindung helfen. Wenn Sie mehr über die Möglichkeiten von KI in Low Code-Anwendungen erfahren möchten, empfehlen wir Ihnen, sich mit uns in Verbindung zu setzen. Wir stehen Ihnen gerne zur Verfügung, um Ihnen bei der Entwicklung von Low Code-Anwendungen mit KI-Unterstützung zu helfen.

Unser brixxbot ist nur ein Beispiel, wie KI Sie innerhalb der brixxbox unterstützen kann:

Dank automatischer Übersetzung sind Ihre brixxbox-Anwendungen direkt multilingual! Natürlich steht aber auch einem manuellen Feinschliff der Übersetzungen nichts im Weg.

Hinweis:

Wir empfehlen die Konfiguration in englisch vorzunehmen, um die besten Ergebnisse im Hinblick auf die Übersetzung zu erhalten.

Sie können die Übersetzung innerhalb des App-Designers oder im globalen Bereich steuern, siehe Screenshot:

Ein IT-System, das mandanten- und währungsfähig ist, bietet viele Vorteile für Unternehmen, die in verschiedenen Ländern oder Märkten tätig sind.

Ein mandantenfähiges IT-System ermöglicht es, mehrere rechtlich selbstständige Einheiten innerhalb eines Systems zu verwalten, ohne dass Daten oder Prozesse vermischt werden. Dies erleichtert die Konsolidierung, das Reporting und die Compliance.

Ein währungsfähiges IT-System ermöglicht es, Transaktionen in verschiedenen Währungen durchzuführen, zu bewerten und abzurechnen, ohne dass manuelle Umrechnungen oder Anpassungen erforderlich sind.

Dies erhöht die Genauigkeit, die Effizienz und die Transparenz. Ein IT-System, das sowohl mandanten- als auch währungsfähig ist, kann also die Flexibilität, die Skalierbarkeit und die Wettbewerbsfähigkeit eines Unternehmens verbessern.

Sofern Ihr Einsatz-Szenario es erfordert können Sie mit brixxbox Mehr-Mandantensysteme erstellen, sowie Systeme die mit mehreren Währungen agieren müssen.

Grundsätzlich bedeutet die Anwendungsentwicklung mit brixxbox, dass Sie sich unabhängig von Standard-Software machen.

Anpassungswünsche erfüllen Sie mit brixxbox direkt und ohne Kompromisse. Schließlich können Sie Prozesse und Funktionen genau so abbilden, wie Sie sie brauchen – ohne den überflüssigen Ballast, den standardisierte Software zwangsläufig mitbringt.

Das bedeutet aber nicht, dass Ihre Anwendung isoliert ist: Verschiedene Schnittstellen ermöglichen den gegenseitigen Austausch von Daten zwischen Ihrer brixxbox-Anwendung und anderer Software.

Nachfolgender Übersicht können Sie darüber hinaus die Unterschiede zur Individualentwicklung bzw. Standardsoftware entnehmen.

Das brixxbox Rollen- und Rechteskonzept kann bis auf Feldebene definiert werden, um die Zugriffsrechte von verschiedenen Benutzern oder Gruppen auf bestimmte Daten oder Funktionen zu steuern. Die Vorteile eines solchen Konzepts sind:

• Es erhöht die Sicherheit, indem es verhindert, dass unbefugte Personen sensible oder vertrauliche Informationen einsehen oder manipulieren können.

• Es verbessert die Effizienz, indem es den Benutzern nur die Daten oder Funktionen anzeigt, die sie für ihre Aufgaben benötigen, und so die Komplexität und den Aufwand reduziert.

• Es fördert die Zusammenarbeit, indem es den Informationsaustausch und die Kommunikation zwischen verschiedenen Abteilungen oder Bereichen erleichtert, die gemeinsame Ziele verfolgen.

• Es erleichtert die Verwaltung, indem es eine klare und konsistente Struktur für die Zuweisung und Überprüfung der Zugriffsrechte bietet, und so die Nachvollziehbarkeit und die Einhaltung von Richtlinien gewährleistet.

Sie können jede erstellte Applikation mit nur einem Click erweitern und eine Archiv-Funktion aktivieren.

Die Daten können manuell oder über einen definierten Workflow zugefügt werden.

Der nachfolgende Screenshot zeigt ein Beispiel im Bereich der Adressdaten:

Mit brixxbox erstellte Anwendungen sind responsive, das heißt sie passen sich automatisch an die Bildschirmgröße an.

brixxbox setzt dabei auf die Bootstrap- Methodik.

Bootstrap enthält ein reaktionsfähiges, für Mobilgeräte geeignetes, flüssiges Rastersystem, das mit zunehmender Größe des Geräts oder des Ansichtsfensters auf bis zu 12 Spalten skaliert.

Parameters

1. eventParameter - this is the special parameter you get in OnRowCreated

2. columnId - the name (id) of the column

3. className - the classnaem to set

Example Usages

Example inside OnRowCreated

   brixxApi.addClassToGridRowCell(eventArgs, "cordlnShippedQuantity", "success");

BrixxPageFooterSum

Sums elements in a table up to this footer

Demo

//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)

How to print on a local Printer in your LAN

This video explains how to print in a local network, when using the brixxbox cloud service.

Parameters

 functionName - the name of the businessBrixx module
 methodName - some businessBrixx functions provide several operations
 silentMode - if you set this to true, the brixxbox will not show a message if something goes wrong. You will still get the errorMessage, to handle the error case in your event code.

Example Usages

   let result = await brixxApi.businessBrixx({
      //Common Parameters for all functions
      functionName:"DhlShiping",
      methodName: "GetLabel",
      silentMode: true,  //false is default. If set to true, the brixxbox will not show an error message box. it is up to you to inform the user.
  
      //Individual paremeters for each business case. DHL Label as an example here.
      shipmentNumber: app.getFieldValue("cordShipmentNumber") //We saved this number before and stored it to our Order
   });
   window.open(result.labelUrl, "_blank");

Business Brixx

• DhlShiping

  • CreateShipment → Creates a DHL Shipping Label.

  • GetLabel → Shows the shipment Label again.

• DPD Shipping

  • CreateShipment → Create a DPD Shipping Label.

• UPS Shipping

  • CreateShipment → Create a UPS Shipping Label.

  • CancelShipment → Removes existing Shipment

  • GetLabel → Shows the shipment Label again.

• InventoryManagement → Does Inventory Movements within an ERP Setup

  • Move

• CurrencyConverter

  • Convert → Converts a currency to annother currency.

• Datev Export

  • DatevExport → This function exports a Datev CSV file for a given timeframe.

    • sqlDataRead Example

    • sqlMainData Example

    • sqlGetCounter Example

• GS1 Code Splitter

  • Split → Splits a barcode (or 2d code) into its GS1 AIs an Values.

• Diamant

  • DiamantBusinessBrixx

• SEPA Export

For accessing the DPD-Shipping brixxbox interface the DPD services need the following setup values (configuration -> settings).

• DPDUserCredentialsCloudUserID

• DPDUserCredentialsToken

• DPDPartnerCredentialsName

• DPDPartnerCredentialsToken

If no settings are available, a sample label will be generated.

Incomming Information

To create labels three groups of information are available:

• 1. OrderSettings with the following fields (If the group is not present default values will be assumed)

  • language: Values „de_DE“ or „en_EN“ are allowed. If nothing is set „de_DE“ will be assumed.

  • ShipDate: if not available will be set to „today“

  • LabelSize: „PDF_A4“ or „PDF_A6“. If nothing is set „PDF_A4“ will be assumed.

  • LabelStartPosition: “UpperLeft“, „UpperRight“, „LowerLeft“, „LowerRigh“

• 2. ShipAddress:

  • Company

  • Gender

  • Salutation

  • FirstName

  • LastName

  • Name

  • Street

  • HouseNo

  • ZipCode

  • City

  • Country

  • State

  • Phone

  • Mail

• 3. ParcelData:

  • YourInternalID: should be set to your own reference (e.g. order no). if no value is provided a timestamp will be set.

  • Content

  • Weight: in kg

  • Reference1

  • Reference2

  • ShipService: set to a valid DPD-Service. If nothing is set “Classic” will be assumed.

Detailed informationen for field usage can be found at https://esolutions.dpd.com/dokumente/DPD_Cloud_Service_Webservice_Dokumentation_DE.pdf

Returning Information

• In case of success (status 200) the following fields are returned

  • ParcelNo: The DPD generated ID. This will be used for further references to this shipment.

  • YourInternalID: The same ID that was provided for the request

  • TimeStamp: an informational time stamp when the request was processed

  • LabelData: this is a blob response. It contains the actual label in PDF format and can directly be used for further processing. E.g. “brixxApi.printBlob(LabelPDF);”

• In case of error (status 400) the following fields are returned:

  • TimeStamp: an informational time stamp when the request was processed

  • ErrorDataList: an array with detailed information what went wrong. Every error will show the following fields

    • ErrorID: an internal error no

    • ErrorCode: an internal error code

    • ErrorMsgShort: Error information short version

    • ErrorMsgLong: Error information long version

Example Usages

/*----------------------------------------------------------------------------------------------
/This example is minimalistic and will create a sample label. 
/You need to check which fields are relevant for your process and assign the values accordingly.
/----------------------------------------------------------------------------------------------*/

var result = await brixxApi.businessBrixx({
      functionName:"DPDShipping",
      methodName: "CreateShipment",
	  ShipAddress : {
		Company: 'Mustermann AG',
		Name: 'Max Mustermann',
		Street: 'Wailandtstr.',
		HouseNo: '1',
		ZipCode: '63741',
		City: 'Aschaffenburg',
		Country: 'DEU'
	  },
	  ParcelData : {
		Reference1: 'Customer email',
		Content: 'Order number',
		Weight: '13.5'
      }
      });
console.log("Parcel Number: " + result.ParcelNo)
brixxApi.printBlob(result.LabelData);


/*----------------------------------------------------------------------------------------------
/This example uses all fields
/You need to check which fields are relevant for your process and assign the values accordingly.
/----------------------------------------------------------------------------------------------*/
var result = await brixxApi.businessBrixx({
      functionName:"DPDShipping",
      methodName: "CreateShipment",
			OrderSettings : {
				language: 'de_DE',
				LabelSize : 'PDF_A4',
				LabelStartPosition : 'UpperLeft',
				ShipDate : app.getFieldValue("SomeFieldValue")
			  },
			ShipAddress : {
				Company: app.getFieldValue("SomeFieldValue"),
				Gender: app.getFieldValue("SomeFieldValue"),
				Salutation: app.getFieldValue("SomeFieldValue"),
				FirstName: app.getFieldValue("SomeFieldValue"),
				LastName: app.getFieldValue("SomeFieldValue"),
				Name: app.getFieldValue("SomeFieldValue"),
				Street: app.getFieldValue("SomeFieldValue"),
				HouseNo: app.getFieldValue("SomeFieldValue"),
				ZipCode: app.getFieldValue("SomeFieldValue"),
				City: app.getFieldValue("SomeFieldValue"),
				Country: app.getFieldValue("SomeFieldValue"),
				State: '',
				Phone: app.getFieldValue("SomeFieldValue"),
				Mail: app.getFieldValue("SomeFieldValue")			  
			  },
			ParcelData : {
				Reference1: app.getFieldValue("SomeFieldValue"),
				Reference2: app.getFieldValue("SomeFieldValue"),
				Content: app.getFieldValue("SomeFieldValue"),
				Weight: app.getFieldValue("SomeFieldValue"),
				YourInternalID: app.getFieldValue("SomeFieldValue"),
				ShipService: app.getFieldValue("SomeFieldValue")			  
			  }
      });
console.log("Parcel Number: " + result.ParcelNo)
brixxApi.printBlob(result.LabelData);

As this function calls customized SQL scripts, it will add SQL parameters from the function call to the SQL calls.

• @company

• @dateFrom

• @dateUntil

Those parameters can be used within the SQL statements.

Needed output columns from SQL scripts

• sqlDataRead script

  • Auftragsnummer

  • Artikelnummer

  • ArtikelRecordId

  • Paragraph13b

  • NettoWert

  • BruttoWert

  • Debitorenkonto

  • Kreditorenkonto

  • Sachkonto

  • SteuerID

  • Buchungsschluessel

  • Buchungstext

  • Rechnungsdatum

  • Rechnungsnummer

  • Leistungsdatum

  • AttachementId

  • BuchungszaehlerTabelle (nvarchar that defines the tabel, where the booking counter is stored)

  • BuchungszaehlerSpalte (nvarchar that devines the column for the booking counter)

  • IstAutomatikKonto

  • IstInnerbetrieblich

• sqlMainData script

  • Kundennummer

  • Konto

  • Firmenname

  • Nachname

  • Vorname

  • Anrede

  • Adresstyp

  • Strasse

  • Hausnummer

  • PLZ

  • Stadt

  • Zusatzinformation

• sqlGetCounter script

  • This script needs to return the actual booking counter as number.

SQL script examples

• sqlDataRead Example

• sqlMainData Example

• sqlGetCounter Example

Example Usages

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:

// 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
   }
}

Parameters

1. controlId - The id of the calendar control

2. eventSource - the Event source object

Example Usages

   app.addCalendarEventSource("myCal", {
      events: [
         {
            title: 'Sammple Event 1',
            start: '2020-12-08',
         },
         {
            title: 'Sammple Event 2',
            start: '2020-12-10',
         },
      ],
      id: 1,
      color: 'yellow',   // an option!
      textColor: 'black' // an option!
   });

Parameters

1. Events

2. Control Id (optional)

   • If the event is control specific (e.g. click on a buttton), this has to be the control id of that button

3. Function

   • The code that should be executed in case of this event

   • The first parameter is the brixxApi

Example Usages

   brixxApi.addEventListener("onRecordSaved", function (brixxApi, eventArgs) {
      alert("Record saved in " + brixxApi.appName);
   });

   brixxApi.addEventListener("onClick", "myButton", function (/*event parameters are optional*/) {
      alert("Button clicked");
   });

Mandatory fields: imItemId, imQuantity

Example Usages

   await brixxApi.businessBrixx({
        functionName:"InventoryMovement",
        movementTable:"inventoryMovement",
        movements:[
    {
                imQuantity: app.getFieldValue("quantityToShip") * -1,
                imAddressId: app.getFieldValue("companyId"),
                imItemId: app.getFieldValue("itemId"),
        imImei: app.getFieldValue("imei"),
        },
        {
                imQuantity: app.getFieldValue("quantityToShip"),
                imAddressId: app.getFieldValue("customerId"),
                imCustomerUserId: app.getFieldValue("customerUserId"),
                imItemId: app.getFieldValue("itemId"),
        imCustomerOrderLineId: app.getFieldValue("orderLineId"),
        imImei: app.getFieldValue("imei"),
        },
        ]
    });

Contents

• 1 Business Brixx UPS Shipping

• 2 Business Brixx UPS Shipping -> CreateShipment

  • 2.1 Incomming Information

  • 2.2 Returning Information

  • 2.3 Example Usages

• 3 CancelShipment

• 4 GetLabel

Business Brixx UPS Shipping

For accessing the UPS-Shipping brixxbox interface the UPS services need the following setup values (configuration -> settings).

• UPSCustomerID Your customer number with UPS

• UPSUsername A valid User for accessing the services

• UPSPassword The corresponding password

• UPSAccessLicenseNumber A license/access key provided by UPS on this page https://www.ups.com/upsdeveloperkit

If no settings are available, a sample label will be generated.

Business Brixx UPS Shipping -> CreateShipment

Creates a UPS shipping label

Incomming Information

To create labels four groups of information are available:

• 1. Settings with the following fields (If the group/field is not present default values will be assumed)

  • ServiceCode: default value "11" UPS Standard. Valid values according to UPS service codes.

  • MetricMeasurements: "1" sets to true. This is the default. Measurements will be metric e.g. kg, cm or nonmetric for lbs, inch

  • Language: Language code according to UPS. e.g. deu, eng, spa. this field will be set to user language by default. If the user language is not available for UPS, "eng" will be used.

• 2. Shipper:

  • Name

  • Street

  • HouseNo

  • ZipCode

  • City

  • CountryCode

  • StateProvinceCode

  • AttentionName

  • Phone

  • EMail

  • FaxNumber

  • TaxIdentificationNumber

• 3. ShipAddress:

  • Name

  • Street

  • HouseNo

  • ZipCode

  • City

  • CountryCode

  • StateProvinceCode

  • AttentionName

  • Phone

  • EMail

  • FaxNumber

  • TaxIdentificationNumber

• 4. ParcelData:

  • Description

  • PackageType: Package type according to UPS. If no value is given, the default will be set to: "02" Customer Supplied Package

  • Weight

  • Height

  • Length

  • Width

Returning Information

• In case of success (status 200) the following fields are returned

  • TrackingNumber: The UPS generated ID. This will be used for further references to this shipment.

  • LabelData: this is a blob response. It contains the actual label in GIF format and can directly be used for further processing. E.g. “brixxApi.printBlob(LabelData);”

• In case of error (status 400) the following fields are returned:

  • error: a text showing the first error. E.g. “console.log(result.error);”

Example Usages

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "CreateShipment",
			Settings : {
				Language: 'deu',
				MetricMeasurements: 1,
				ServiceCode: "11"
			  },
			Shipper : {
				Name: 'Brixxbox GmbH',
				Street: 'Husarenstraße',
				HouseNo: '34a',
				ZipCode: '41836',
				City: 'Hückelhoven',
				CountryCode: 'DE'
			  },
			ShipAddress : {
				Name: 'Brixxbox GmbH',
				Street: 'Husarenstraße',
				HouseNo: '34b',
				ZipCode: '41836',
				City: 'Hückelhoven',
				CountryCode: 'DE',
				Phone: '+49 1234 5678-9',
				Mail: 'm.mustermann@mustermann.com'			  
			  },
			ParcelData : {
				Description: 'Product name',
				Height : 10,
				Length : 20,
				Width  : 15,
				Weight: '4.5',
				ServiceCode: '9'			  
			  }
      });
	  
console.log("Tracking Number: " + result.TrackingNumber);
brixxApi.printBlob(result.LabelData);

CancelShipment

To cancel an existing shipment only the TrackingNumber is needed.

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "CancelShipment",
	 TrackingNumber: app.getFieldValue("ExistingTrackingNumber")
      });

GetLabel

In case the label is needed again it can be retrieved with an existing TrackingNumber. The result will show LabelData (see CreateShipment results #Returning_Information for details)

var result = await brixxApi.businessBrixx({
      functionName:"UPSShipping",
      methodName: "GetLabel",
	 TrackingNumber: app.getFieldValue("ExistingTrackingNumber")
      });

brixxApi Functions

The brixxApi provides a set of functions for each brixxbox. These functions can be used inside brixxbox events, to interact with the brixxbox and modify the behaviour of the application.

Common Functions

• inviteUser(string email)

App Functions

• setToolbarButtonMode(string toolbarButtonId, string mode)

• addToolbarButton(toolbarButtonOptions)

• readOnlyMode(bool readOnly, options)

• excludeFromReadonly([])

• startScanner(string controlId, scanOptions)

• isUserInRole(string role)

• globalSearch(string searchTerm)

• getDate(Date date)

• getUserClaim(string claimName)

• getSessionToken()

• getBrowserToken()

• logAdd()

• enableNotifications()

• setToolbarButtonMode(string toolbarButtonId, string mode)

• addToolbarButton(toolbarButtonOptions)

• readOnlyMode(bool readOnly, options)

• excludeFromReadonly([])

• startScanner(string controlId, scanOptions)

• isUserInRole(string role)

• globalSearch(string searchTerm)

• getDate(Date date)

• getUserClaim(string claimName)

• getSessionToken()

• getBrowserToken()

• logAdd()

• enableNotifications()

Field Manipulation

• setFieldValue(string controlId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• getFieldValue(string controlId)

• setLabelText(string controlId, string labelText)

• initAllControls()

• initControl()

• setControlUnmodifiedValue(string controlId, string valueToCompare) // Value can be of any javascript value type i.e. string, integer, Date etc.

• getControlUnmodifiedValue(string controlId[[[[markAllControlsAsUnModified|markAllControlsAsUnModified()]]]]

• getHtmlElement(string controlId)

• setVisibility(string controlId, bool visible, string subControl) // visible(default True) and subControlare optional parameters.

• setEnable(string controlId, bool visible, string subControl) // visible(default True) and subControl are optional parameters.

• triggerEvent(string eventName, string controlId)

• refresh(string controlId) // If used without parameter, refreshes all controls.

• refreshBadges()

• showTabPage(string controlId)setGridGrouping(string controlId, groupConfiguration) // groupConfiguration can either null, undefined or columnId.

• setGridAutoRefresh(string controlId, Number autoRefreshSeconds ) // inputDate can be of Date type or a controlId of date/datetime control.

• getCalcDateTime(inputDate, accuracy) // inputDate can be of Date type or a controlId of date/datetime control and accuracy can be seconds(default), minutes, or hours.

• enableValidator(string controlId, string validatorName, bool enable) // enable can be true(default)/false.

• reInitValidation()

• setFieldUnit(string controlId, string unitName) // If no value is given for unitName then unit will be removed.

• setDecimalDigits(string controlId, Number value)

• addClassToGridRowCell(eventParameter, columnId, className)

• showRowDetailButton(Row, bool show)

• showRowDetailPanel(Row, bool show)

• clearGridSelection(string controlId)

• selectGridRows(string controlId, string columnId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• unselectGridRows(string controlId, string columnId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• toggleGridSelection(string controlId)

• isRowSelected(string controlId, line)

• switchTagControl(string controlId, bool editMode) // editMode is optional parameter.

• setFocus(string controlId, bool select)

• setTextColor(string controlId, string colorName) // colorName can be "default", "primary", "secondary", "success", "danger", or "warning".

• setFontWeight(string controlId, string fontWeight) // fontWeight can be normal or bold.

• setFontStyle(string controlId, string fontStyle) // fontStyle can be italic or normal.

• setBackgroundColor(string controlId, string colorName) // colorName can be "default", "primary", "secondary", "success", "danger", or "warning".

• disableGridHyperLinks(string controlId, bool disable)

• getSignatureImageBlob(string controlId, string type) // Type can be of png(default) or svg.

• cancelCalendarChanges(string controlId)

• addCalendarEventSource(string controlId, eventSource) //eventSource is a JSON Object.

• setFieldValue(string controlId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• getFieldValue(string controlId)

• setLabelText(string controlId, string labelText)

• initAllControls()

• initControl()

• setControlUnmodifiedValue(string controlId, string valueToCompare) // Value can be of any javascript value type i.e. string, integer, Date etc.

• getControlUnmodifiedValue(string controlId[[[[markAllControlsAsUnModified|markAllControlsAsUnModified()]]]]

• getHtmlElement(string controlId)

• setVisibility(string controlId, bool visible, string subControl) // visible(default True) and subControlare optional parameters.

• setEnable(string controlId, bool visible, string subControl) // visible(default True) and subControl are optional parameters.

• triggerEvent(string eventName, string controlId)

• refresh(string controlId) // If used without parameter, refreshes all controls.

• refreshBadges()

• showTabPage(string controlId)

• setGridGrouping(string controlId, groupConfiguration) // groupConfiguration can either null, undefined or columnId.

• setGridAutoRefresh(string controlId, Number autoRefreshSeconds ) // inputDate can be of Date type or a controlId of date/datetime control.

• getCalcDateTime(inputDate, accuracy) // inputDate can be of Date type or a controlId of date/datetime control and accuracy can be seconds(default), minutes, or hours.

• enableValidator(string controlId, string validatorName, bool enable) // enable can be true(default)/false.

• reInitValidation()

• setFieldUnit(string controlId, string unitName) // If no value is given for unitName then unit will be removed.

• setDecimalDigits(string controlId, Number value)

• addClassToGridRowCell(eventParameter, columnId, className)

• showRowDetailButton(Row, bool show)

• showRowDetailPanel(Row, bool show)

• clearGridSelection(string controlId)

• selectGridRows(string controlId, string columnId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• unselectGridRows(string controlId, string columnId, value) // Value can be of any javascript value type i.e. string, integer, Date etc.

• toggleGridSelection(string controlId)

• isRowSelected(string controlId, line)

• switchTagControl(string controlId, bool editMode) // editMode is optional parameter.

• setFocus(string controlId, bool select)

• setTextColor(string controlId, string colorName) // colorName can be "default", "primary", "secondary", "success", "danger", or "warning".

• setFontWeight(string controlId, string fontWeight) // fontWeight can be normal or bold.

• setFontStyle(string controlId, string fontStyle) // fontStyle can be italic or normal.

• setBackgroundColor(string controlId, string colorName) // colorName can be "default", "primary", "secondary", "success", "danger", or "warning".

• disableGridHyperLinks(string controlId, bool disable)

• getSignatureImageBlob(string controlId, string type) // Type can be of png(default) or svg.

• cancelCalendarChanges(string controlId)

• addCalendarEventSource(string controlId, eventSource) //eventSource is a JSON Object.

Printing and Documents

• print(string controlId) // Id of report control which is to be printed.

• printBlob(printDoc) // printDoc is a document which is to be printed.

• showBlob(string controlId, blobData)

• createReport(reportControlId, createOptions) // CreateOptions is a JSON object. It contains options like print, archive, saveFile etc. for report creation.

Data Storage

• loadRecord(string controlId)

• loadRecordById(Number recordId)

• loadConfigRecordById(string configName, Number recordId)

• deleteConfigRecordById(string configName, Number recordId)

• copyConfigRecordById(string configName, Number recordId, additionalValues) // additionalValues is a JSON object, it contains values need to be modified in target record.

• loadAndDisplayRecord(Number keyFieldId)

• loadAndDisplayRecordById(Number recordId)

• displayRecord(myRecord,string myKeyControlId)

• deleteRecord(options) // options is a JSON object which include properties id, noConfirmationMessage.

• validateInput()

• saveCurrentRecord(string configName, record) // record is a JSON like object.

• saveCurrentRecordWithoutEvents()

• saveConfigRecord(string configName, Number recordId)

• newRecord()

• newGridEntry(string gridControlId)

• executeStoredProcedure(string procedureName, procedureParameters, queryOptions) // procedureParameters and queryOptions are JSON objects.

• queryStoredProcedure(string procedureName, procedureParameters, queryOptions) // procedureParameters and queryOptions are JSON objects.

• refreshDataSource(string controlId) // Refreshes controlId. If used without parameters, it refreshes all controls with datasources.

• localValue(string keyName, string keyValue)

• sqlRead(string statementName, additionalParameters, queryOptions) // additionalParameters and queryOptions are JSON objects.

• sqlWrite(string statementName, additionalParameters, queryOptions) // additionalParameters and queryOptions are JSON objects.

• sqlReadValue(string statementName, additionalParameters, string columnName queryOptions)

Build in Tools

• composeEmail(emailOptions) // emailOptions is a JSON object, it contains options like to, cc, bcc, text, and subject etc which can be used to send an email.

• getGeoLocation()

• showWikiPage(string pageName, bool global) // If global is true, global wiki page is shown. Otherwise workspace wiki page is shown.

• showDiscussion(bool show) // Default show value is is true.

• showAttachments(bool show) // Default show value is is true.

• showMessage(messageOptions) // messageOptions is a JSON object.

• showMessageBox(messageBoxOptions) // messageBoxOptions is a JSON object.

• messageBox(messageBoxOptions) // messageBoxOptions is a JSON object.

• refreshAttachments()

• getAttachmentById(Number id)

• getAttachmentByFileName(string fileName)

• getAttachmentsForCurrentRecord()

• getAttachmentId(string fileName)

• getConfigRecordAttachmentIdByFileName(string appName, Number recordId, string fileName)

• downloadAttachments(downloadOptions) //downloadOptions is a JSON object. It iscludes resquestedIds list and file name for downloaded file.

• uploadAttachment(blob data,Number documentTypeId, string fileName) // documentTypeId and fileName are optional parameters.

• deleteAttachment(Number attachmentId)

• replaceText(string text, additionalReplacement) // additionalReplacement is a JSON object with key value pairs.

• callWebHook(string url, string message)

• getCustomMessage(string messageName, params, string targetLanguage) // params is a JSON object.

• getCustomSetting(string settingName)

• serverFunction(string funcName, funcParams, options) // funcParams and options are JSON objects and optional parameters.

Business Brixx

• DhlShiping

  • CreateShipment → Creates a DHL Shipping Label.

  • GetLabel → Shows the shipment Label again.

• DPDShipping

  • DPD Shipping

Starting brixxboxes

• startBrixxbox(startOptions) // startOptions is a JSON object with start parameters.

• addEventListener(string eventName, string controlId,function func) // ControlId is optional parameter.

• closeModal()

• isModal()

• createPublicAppUrl(options) //options is a JSON object.

• closePublicAppUrl(options) //options is a JSON object.

• logout()

Date and Time

• The moment.js Library

Variables

• userId

• recordId

• record

• isLoadingRecord

• isInitializing

Controls

• NumBox

• TextBox

• Button

• CheckBox

• ComboBox

• Grid

• TabControl

• TabPage

• Accordion

• Badge

• FullCalendar

• Camera

• Chart

• DateTimeBox

• DateBox

• DocViewer

• AppConfig

• FileImport

• FormGroup

• FormGroupRow

• GridConfig

• GroupBox

• HorizontalLine

• HtmlTable

• HtmlTemplate

• Image

• Label

• LinkLabel

• MultilineTextBox

• Report

• Row

• Scanner

• SignaturePad

• Tag

• TemplateGrid

• TemplateGridElement

• TimeBox

• Unit

• WedgeScanner

• Widget

• WidgetContainer

• WysiwygText

==

• Common Functions →

• App Functions →

• Field Manipulation → Functions which manipulate properties, values or behaviors of a control.

• Printing and Documents →

• Data Storage →

• Build in Tools →

• Business Brixx →

• Starting brixxboxes →

• Date and Time →

• Variables →

brixxApi Events

The brixxApi Events are used to react on certain events. This way you can customize the behaviour of the brixxbox to your own purpose. Some events will be raised befor the brixxbox executes their own logic for this event. In that case, you can return 'true' to avoid the brixxbox build in event. Otherwise the brixxbox will do its own logic after your event.

• onClick → When a control is clicked.

• onRowClick → When a grid row is clicked.

• onCellClick → When a grid cell is clicked.

• onChange → When a control content is changed.

• onRecordLoad → Before a Record is loaded.

• onRecordLoaded → After a Record is loaded.

• onRecordSave → Before a Record is saved.

• onRecordSaved → After a Record is saved.

• onRowSelectionChanged → After a the selected row of a grid has changed.

• onRowCreated → Modify a grid row. Apply a color for the row based on its values for example.

• onRecordNew → After initializing the Form. The new Record is not saved yet but can be modified with initial values.

• onRecordDelete → Before a record is deleted.

• onRecordDeleted → After a record was deleted.

• onChange → After a control value has changed.

• onKeyPress → When a key is pressed

• onKeyUp → When a key goes up

• onKeyDown → When a key goes down

• onModalClose → When a modal brixxbox app closes.

• onAppStart → When the app is started but befor it is initialized.

• onAppInitialized → When the app is initialized onAppStart has happend).

• onScan → When a code is scanned.

• onAttachmentsShow → Just before attachments panel opens.

• onFileImport → When a file is uploaded for import.

• onReturnFromModal → When a modal child app is closed, the parent will get this event

• onAttachmentsShow → When the sidebar for attachments opens

• onMailHistoryShow → When the sidebar for the mail history opens

• onSubDataRequest → When the subdatasource of a control is requested

• onChildAppClosed → When a childapp of your app closes.

• onTabShown → Fires when a tab page is changing to visible.

• onAttachmentDeleted → Triggers when the user deletes an attachment in the sidebar.

• onAttachmentsHide → This event occurs when the attachment sidebar gets closed.

• onDataTransform → The event can be used to transform a datasource line to a calender event.

• onEventClick → The event occurs the user clicks on one of the events.

• onEventChange → The event occurs the user moves or modifies an event.

• onTimeSelected → The event triggers when the users selects a time period in the calendar.

Custorm Grid-Spalte Datumsformat

Create Resport REST

Telerik Extension Functions

Printing in LAN

OpenAI API Key must

Parameter

gptOptions - Json object with parameters.

• system - to set the stage. A promt to tell the model, how to behave

• user - User input, examples and a query. This is the user promt

Example Usages

let response = app.brixxGPT({
    system: "Reply in a HTML snipped Text, that will be inserted in an existing div",
    user: "How to create a for loop in JS?"
});

// "output" is a brixxbox htmlTemplate control     
$(app.getHtmlElement("output")).html(response);

         

If shipService is omitted the default value ""V01PAK" will be set.

Example Usages

   let result = await brixxApi.businessBrixx({
      functionName:"DhlShiping",
      methodName: "CreateShipment",
      weightInKG: "4",
      lengthInCM: "20",
      heightInCM: "20",
      widthInCM: "10",
      shipService: "V01PAK",
      recipientEmailAddress: "info@acme.com",
         senderAddress:{
         name1: app.getFieldValue("cordCompanyId.cusName"),
         streetName: app.getFieldValue("cordCompanyId.cusStreet"),
         streetNumber: app.getFieldValue("cordCompanyId.cusStreetNumber"),
         zip: app.getFieldValue("cordCompanyId.cusZip"),
         city: app.getFieldValue("cordCompanyId.cusCity"),
         countryCode: "DE",        
         },
         receiverAddress:{
         name1: app.getFieldValue("cordCustomerId.cusName"),
         streetName: app.getFieldValue("cordCustomerId.cusStreet"),
         streetNumber: app.getFieldValue("cordCustomerId.cusStreetNumber"),
         zip: app.getFieldValue("cordCustomerId.cusZip"),
         city:app.getFieldValue("cordCustomerId.cusCity"),
         countryCode: "DE",
         },
      });
   console.log("Shipment Number: " + result.shipmentNumber)
   window.open(result.labelUrl, "_blank");

Example Usages

   let result = await brixxApi.businessBrixx({
      functionName:"DhlShiping",
      methodName: "GetLabel",
      shipmentNumber: app.getFieldValue("cordShipmentNumber")
   });
   window.open(result.labelUrl, "_blank");

DPDCreateShipment -> Creates a DPD Shipping Label

This is the main script, which is responible for collection all the data, which needs to be exported.

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

 SELECT 
    head.id AS Auftragsnummer,
    ol.cordlnItemId AS Artikelnummer,
    ol.id AS ArtikelRecordId,
    ol.cordlnParagraph13b AS Paragraph13b,
    ol.cordlnNetOrderValue AS NettoWert,
    ol.cordlnGrossOrderValue AS BruttoWert,
    adr.adrDebitor AS Debitorenkonto,
    0 AS Kreditorenkonto,
    cordlnSalesAccount AS Sachkonto,
    adr.adrTaxId AS SteuerID,
    cordlnTaxKey as Buchungsschluessel,
    '' AS Buchungstext,
    head.cordInvoiceDate AS Rechnungsdatum,
    head.cordInvoiceNumber AS Rechnungsnummer,
    head.cordShippingDate AS Leistungsdatum,
    atta.id AS AttachementId,
    'customerOrder' AS BuchungszaehlerTabelle,
    'cordDatevExportId' AS BuchungszaehlerSpalte,
    CASE WHEN fiac.finaccIsAccountSplitting = 1 THEN fiacsplit.facsIsAutomaticAccount ELSE fiac.finaccIsAutomaticAccount END AS IstAutomatikKonto,
    head.cordInterCompanyOrder as IstInnerbetrieblich
 
 FROM dbo.bbv_customerOrderLine AS ol
 LEFT JOIN [dbo].[customerOrder] AS head ON head.id = ol.cordlnOrderId
 LEFT JOIN address AS adr ON adr.id = head.cordAddressId
 LEFT JOIN brixx_Attachments AS atta ON atta.id in (select AttachmentId from brixx_AttachmentLinks where RecordId = head.id AND TableName = 'customerOrder' ) AND atta.DocumentTypeId = 2
 LEFT JOIN financialAccount AS fiac ON fiac.finaccAccountNumber = cordlnSalesAccount
 LEFT JOIN financialAccountSplitting AS fiacsplit ON fiacsplit.facsAccountId = fiac.id AND fiacsplit.facsSplitAccount = fiac.finaccAccountNumber
 WHERE ol.cordlnOrderId IN 
 (
    SELECT id FROM [dbo].[customerOrder] 
    WHERE cordShippingDate >= @dateFrom AND cordShippingDate <= @dateUntil
    AND cordCompanyId = @company
 )
 AND ol.cordlnNetOrderValue > 0
 AND head.cordStatusId >= 4
 
 UNION
 
 SELECT 
    head.id AS Auftragsnummer,
    ol.sordlnItemId AS Artikelnummer,
    ol.id AS ArtikelRecordId,
    ol.sordlnParagraph13b AS Paragraph13b,
    ol.sordlnNetOrderValue AS NettoWert,
    ol.sordlnGrossOrderValue AS BruttoWert,
    0 AS Debitorenkonto,
    adr.adrKreditor AS Kreditorenkonto,
    sordlnitmProcurementAccount AS Sachkonto,
    adr.adrTaxId AS SteuerID,
    sordlnTaxKey AS Buchungsschluessel,
    '' AS Buchungstext,
    head.sordGoodsReceiptDate AS Rechnungsdatum,
    head.sordInvoiceNumber AS Rechnungsnummer,
    head.sordGoodsReceiptDate AS Leistungsdatum,
    atta.id AS AttachementId,
    'supplierOrder' AS BuchungszaehlerTabelle,
    'sordDatevExportId' AS BuchungszaehlerSpalte,
    CASE WHEN fiac.finaccIsAccountSplitting = 1 THEN fiacsplit.facsIsAutomaticAccount ELSE fiac.finaccIsAutomaticAccount END AS IstAutomatikKonto,
    head.sordInterCompanyOrder as IstInnerbetrieblich
 
 FROM dbo.bbv_supplierOrderLine AS ol
 LEFT JOIN [dbo].[supplierOrder] AS head ON head.id = ol.sordlnOrderId
 LEFT JOIN address AS adr ON adr.id = head.sordAddressId
 LEFT JOIN item AS itm on itm.id = ol.sordlnItemId 
 LEFT JOIN brixx_Attachments AS atta ON atta.id in (select AttachmentId from brixx_AttachmentLinks where RecordId = head.id AND TableName = 'supplierOrder' )
 LEFT JOIN financialAccount AS fiac ON fiac.finaccAccountNumber = ol.sordlnitmProcurementAccount
 LEFT JOIN financialAccountSplitting AS fiacsplit ON fiacsplit.facsAccountId = fiac.id AND fiacsplit.facsSplitAccount = fiac.finaccAccountNumber
 WHERE ol.sordlnOrderId IN 
 (
    SELECT id FROM [dbo].[supplierOrder] 
    WHERE head.sordGoodsReceiptDate >= @dateFrom AND head.sordGoodsReceiptDate <= @dateUntil
    AND sordCompanyId = @company
 )
 AND ol.sordlnNetOrderValue > 0
 AND head.sordStatusId = 5

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

 SELECT MAX(DatevExportId) FROM
 (
    SELECT ISNULL(MAX(cordDatevExportId), 0) AS DatevExportId FROM customerOrder WHERE cordCompanyId = @company
    UNION ALL
    SELECT ISNULL(MAX(sordDatevExportId), 0) AS DatevExportId FROM supplierOrder  WHERE sordCompanyId = @company
 ) AS sub

This is usually used in the onScan event where you use the plain scan result as the input. The fnc1Char parameter is optional and only used, if the scanner sends an different (visible) character instead of the default fnc1 (CHAR29).

Mandatory fields: gs1Code

Example Usages

 let result = await brixxApi.businessBrixx({
     functionName:"Gs1Splitter",
     methodName: "Split",
     gs1Code: "011234567890123417210521109988"
 });
 console.log(result)

Example Usages with Split Char (FNC1)

Especially with keyboard wedge scanners, it is often usefull to use a visible character as the FNC1 char.

 let result = await brixxApi.businessBrixx({
     functionName:"Gs1Splitter",
     methodName: "Split",
     gs1Code: "011234567890123417210521109988X211234",
     fnc1Char: 'X'
 });
 console.log(result.applicationIdentifiers['10'])

The result variable in this case:

{
   "applicationIdentifiers":{
      "10":"9988",
      "17":"210521",
      "21":"1234",
      "01":"12345678901234",
      "01.packind":"1",
      "01.iln":"2345678",
      "17.date":"20210521"
   }
}

Wählen Sie ein Themengebiet aus und starten Sie die Slide-Show.

As we have already discussed in documentation of SetToolbarButtonMode. These are several buttons that are provided by Brixxbox for each app like adding new record, saving new record etc. These buttons provides general functionality needed by most of the apps but in case your app needs extra functionality, Brixxbox also allows this. It is provided by brixxApi function addToolbarButton. It takes a JSON object as a parameter. This JSON contains all the properties that defines this custom button as well as the functionality provided by it. The properties include name, id, and function to execute on clicking this button etc. Adds a custom button to the app toolbar.

Example

   brixxApi.addToolbarButton({
            title: "Print Invoice",
            icon: "print",
            id: "printInvoiceToolbarButton",
            onclick: async function () {
                brixxApi.triggerEvent("click", "printInvoiceBtn");
            }
        });

Parameters

1. toolbarButtonOptions - It is a JSON Object. In JSON object we passes parameters in the form of key value arguments.It include properties like name, id, function, etc.

Example Usages

As we have already seen a minimal custom print button in above example. Lets now add extra properties like group, css class, and shortcut for our print button. Now we also want this button to be added in our app toolbar on initialization. For this purpose goto current app properties and add onAppInitialized event. Now we need to add following code as a custom code to this event.

   brixxApi.addToolbarButton({
            title: "Print Invoice",
            icon: "print",
            text: "Rechnung drucken",
            group: "invoice",
            id: "printInvoiceToolbarButton",
            cssClass: "btn-success",
            onclick: async function () {
                brixxApi.triggerEvent("click", "printInvoiceBtn");
            },
            shortcut: "Ctrl-Alt-P"
        });

Now when our app is initialized, we can see our custom button on the app toolbar and it should look like this.

We can also add different custom buttons to our app depending upon our own requirements.

• CreateShipment → Creates a DHL Shipping Label.

• GetLabel → Shows the shipment Label again.

Parameters

1. downloadOptions - JSON object

   • requestedIds - list of ids to download

   • fileName - (optional) name of the downloaded file

Example Usages

   brixxApi.downloadAttachments({
      requestedIds:[196, 197, 200]
   });

   brixxApi.downloadAttachments({
      requestedIds:[196, 197, 200],
      fileName: "myDownload.zip"
   });

Parameters

1. settingName - the key for the setting

Example Usages

   let settingValue = brixxApi.getCustomSetting("groupOne.setting1");
   console.log(settingValue);

This function queries the database to find the latest attachment associated with a specific record ID. If the documentTypeId is 0, the document type filter is ignored.

Parameters

• tableName: string

  • The name of the table where the record is stored.

• recordId: number

  • The ID of the record for which the attachment is being retrieved.

• documentTypeId: number

  • The ID of the document type to filter by. If 0 or null, this filter is ignored.

Returns

• Promise<Blob>

  • A promise that resolves to a blob containing the attachment, or null if no attachment is found.

Example

  try {
    // Retrieve the last attachment for a record with ID 123 in the 'Orders' table, ignoring document type filter
    const blob = app.getLastAttachmentByRecordId('Orders', 123, 0);
    if (blob) {
      app.printBlob(blob);
    } else {
      console.log('No attachment found for the given record ID.');
    }
  } catch (error) {
    console.error('Error retrieving attachment:', error);
  }

Parameters

1. appName - the name of the config with the attachment

2. recordId - the id of the record with the attachment

3. fileName - the name of the requested attachment

Example Usages

   brixxApi.getConfigRecordAttachmentIdByFileName("customerOrder", 1234, "invoice.pdf");

Parameters

1. controlId => Id of the control

2. helpText => the new text, you want to set or empty to remove an existing text

Example Usages

   brixxApi.changeHelpText("myControl", "Hello World");

Get Method

The Method Retrieves the data specified with dataType (like Address, CostCenter and so on). The searchParams and fieldMatch JSON properties are valid for all methods, but the fields mentioned in it are depending on the datatype used. For example: postcode is a valid searchParam for addresses, but not for cost centers.

The Get method will return the data it fetched from Diamant, so you get an array of JSON objects. The fieldMatch prameter will tell the brixxbox to change field names, so that it is more useful in an brixxbox environment.

Example Usages Get

This will retrieve all addresses from diamant. Field names are the original diamand field names

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "Get",
     company: "9018",
     dataType: "Address",
 });
 console.log(result)

This will retrieve all addresses with Postcode 61118 from diamant and return the result. Only the fields "key" and "Name1" will be returned.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "Get",
     dataType: "Address",
     searchParams:{
         postcode: "61118"
     },  
     usedFields:["key", "Name1"]

 });
 console.log(result)

Write to Diamant

This code will write an address to Diamant

let result = brixxApi.businessBrixx({
   functionName: "Diamant",
   methodName: "Save",
   dataType: "Address",
   fields: {
      key: "12345",
      addresstype: "F",
      name1: "John Doe",
      street: "Elmstreet 123",
      postcode: "12345",
      town: "Berlin",
   },
});

ImportTable Method

This method allows you to retrieve the data and insert it into the database. Query parameters work the same and are optional but you must user fieldMatch to assign diamant names to brixxbox field names

Example Usages Import Insert

This will retrieve all addresses from diamant and insert it into the table address the table will be wiped right before the import.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "ImportTable",
     dataType: "Address",
     tableName: "address",
     wipeTable: true,
     fieldMatch:{
         postcode: "adrZip",
         name1: "adrName"
     }, 
 });
 console.log(result)

Example Usages Import Upsert

This will retrieve all addresses from diamant and update the records with the same id as in fieldMatch.

 let result = await brixxApi.businessBrixx({
     functionName:"Diamant",
     methodName: "ImportTable",
     dataType: "Address",
     tableName: "address",
     upsert: true,
     wipeTable: true,
     fieldMatch:{
         key: "adrKey,id",
         postcode: "adrZip",
         name1: "adrName"
     }, 
 });
 console.log(result)

Supported dataTypes

More types can be added at request.

Request Data

• Address (Adressen)

• CostCenter (Kostenstellen)

• GenLedgAccount (Sachkonten)

• CostObject (Kostenträger)

• PrimCostElement (Primärkostenarten)

• Project (Projekte)

• Company (Mandanten)

• Customer(Konten)

• Vendor (Vendor)

• Posting (Buchungen)

Transctions

• OpenStack

• Transaction

• CloseStack

Example Usages Get

 let result = await app.businessBrixx({
    functionName:"Diamant",
    methodName: "CloseStack",
    stackNumber: app.getFieldValue("myBookungStackNumber")
});

Mandatory fields: fromCurrencySymbol, toCurrencySymbol

Example Usages

 let rate = await brixxApi.businessBrixx({
     functionName:"CurrencyConverter",
     methodName: "Convert",
     fromCurrencySymbol: "EUR",
     toCurrencySymbol: "USD",
     date: moment().subtract(7, 'days') // optional, else current date
 });
 console.log(rate)

Available Parameters

1. @company - If you work with multiple companies, you have to export each company by it's own.

2. @dateFrom - Start date for the export

3. @dateUntil - End date for the export

Example Usages

 SELECT adr.id AS Kundennummer,
       CASE WHEN adrIsCustomer = 1 THEN adr.adrDebitor ELSE adr.adrKreditor END AS Konto,
       adr.adrName AS Firmenname,
       adr.adrLastName as Nachname,
       adr.adrFirstName as Vorname,
       '' AS Anrede,
       'STR' AS Adresstyp,
       adrLoc.alocStreet AS Strasse,
       adrLoc.alocStreetNumber AS Hausnummer,
       adrLoc.alocZip AS PLZ,
       adrLoc.alocCity AS Stadt,
       adrLoc.alocAdditionalInfo AS Zusatzinformation
  FROM [dbo].[address] AS adr
  LEFT JOIN addressLocation AS adrLoc ON adrLoc.id = adr.adrDefaultInvoiceAddress
  LEFT JOIN country AS country ON country.id = adrLoc.alocCountryId
 WHERE adr.adrIsCustomer = 1 OR adr.adrIsSupplier = 1

Example Usages Get

 let result = await app.businessBrixx({
    functionName:"Diamant",
    methodName: "OpenStack",
});
app.setFieldValue("myBookungStackNumber", result.data); //result.data is the stackNumber

Note: Usually it is not necessary to get the Html element itself. Make sure there is no better way to do the things you want to do by using the brixxApi functions!

Example Usages

   let myField = brixxApi.getHtmlElement("myFieldId");
   myField.disabled = true; // just for demonstration. Please use brixxApi.setFieldEnable("myFieldId", false) instead

Parameters

1. reportControlId - the id of the reportControl in your app. This can be invisible, if you don't need a preview.

2. createOptions - JSON Object with options

   • print - (bool, default = false) if set to true, this will trigger the print dialog after the report is create.

   • archive - (bool, default = false) if set to true, the report is saved as an attachment to the current record,

   • saveFile - if set. the report will be downloaded with a generic file name (brixxbox-print.pdf), except, if saveFileName is set.#

   • saveFileName - if set. the report will be downloaded with that file name.

   • reportId - (optional) if defined, this will overruled the reportId given for the control in the config editor. This is not the controlId, but the id (name) of the report definition

   • cloudPrinter - (optional) the created report will be send to the cloud printer right after creation.

Like a on a dataRequest, all controls of the current app will bo automatically send as report parameters, plus the recordId of the current record as "id", even if you dont have a control "id" in your app.

Example Usages

   brixxApi.createReport("invoiceReport", {print: true}); //will create the invoiceReport as a pdf and prints it on the client side

   brixxApi.createReport("invoiceReport", {
      print: true,
      archive: true,
      documentTypeId: 1,
      saveFileName: "myPrint.pdf"
   }); 
   //will create the invoiceReport as a pdf and prints it on the client side, it will also save the pdf as an attachment to the current record.

   brixxApi.createReport("invoiceReport", {
      print: true,
      reportId: "invoiceReportSimple"
   }); 
   //In this case, we choose a different reportId

Create a report and send it to a cloud printer

   brixxApi.createReport("invoiceReport", {
      cloudPrinter: "HP LaserJet",
   });

Requests Data from a CloudGateway Enpoint

Parameters

{
    AppName: "MyCloudGateway", //The Name in the ApiKey List
    Endpoint: "LocalFirebird", // Configured Endpoint
    SqlStatementId: "fbGetAddress", //Optional statemnt id, depending on the Plugin
    Parameters: { //Optional Parameters
      "id": 1  
    },
    
}

Example Usages

Query an address from a firebird database

   brixxApi.cloudQuery({
    AppName: "MyCloudGateway",
    Endpoint: "LocalFirebird",
    SqlStatementId: "fbGetAddress",
    Parameters: {
      "id": 1  
    },
    
})

Parameters

1. emailOptions - (optional) Json object with email parameters.

   • to - array of email addresses

   • cc - array of email addresses

   • bcc - array of email addresses

   • text - message text

   • subject - subject

   • from - single string with an email address

   • replyTo - single email, that will be used as to reply to

   • autoSend - if set to true, the mail will be send automatically. You will not see a dialog at all. (Default is false)

   • hideToEmail - if set to true. The recipients email address is hidden in the email dialog

   • attachmentIds - an array of attachment ids that will be sent as an attachment,

   • attachmentBlobs - an array of blobs objects that will be sent as an attachment, {name: myFileName, blob: myBlob}

   • recordId - RecordId if you would like to attach the email to an record. If empty, this is the current record Id (available from 18.11.2021)

   • appName - AppName if you would like to attach the email to an record. If empty, this is the current App Name (available from 18.11.2021)

Example Usages

Example 1

Shows the dialog without any predefined values

Shows the dialog text and to addresses

   composeEmail({
      text: `This is the messsage text and this is a link: <a href='http://www.brixxbox.net' target='_blank'>www.brixxbox.net</a>`, 
      to:["john.doe@acme.com", "jane.doe@acme.com"], 
      subject: "This is the mail subject",
      from: "noreply@acme.com"
   });

Example 2

Sends the email without a dialog

   composeEmail({
      text: "This is the messsage text", 
      to:["john.doe@acme.com", "jane.doe@acme.com"], 
      subject: "This is the mail subject",
      from: "noreply@acme.com",
      replyTo: "reply@acmy.com", 
      autoSend: true //Set this to avoid the dialog
   });

Example 3 - attachment blobs

   composeEmail({
      text: "This is the messsage text", 
      to:["john.doe@acme.com", "jane.doe@acme.com"], 
      subject: "This is the mail subject",
      from: "noreply@acme.com",
      autoSend: true,
      attachmentBlobs: [
         {
            name: "Test1.pdf", 
            blob: app.createReport("report")
         },
         {
            name: "Test2.pdf", 
            blob: app.getAttachmentById(2)
         }
      ],
   });

Example 4 - attachment ids

   composeEmail({
      text: "This is the messsage text", 
      to:["john.doe@acme.com", "jane.doe@acme.com"], 
      subject: "This is the mail subject",
      from: "noreply@acme.com",
      autoSend: true,
      attachmentIds: [1, 2, 3]
   });

Example Usage

The data is passed to the interface as a JSON array. All fields available in the documentation can be inserted here! Please not that several data sety can be transferred at the same time.

let result = await app.businessBrixx({
    functionName: "Diamant",
    methodName: "Transaction",
    company: 1,
    transactions: [{
        transactionType: 'AR',
        stacknumberSpecified: false,
        ///...,

        accountAssignmentTab: [{
            accountNo: '12345',
            taxCode: 19,

            //...,

            cAccDataTab: [{
                costCenter: '123a',
                //...
            },
            {
                costCenter: '123b',
                //...
            }],

            oIDataTab: [{
                accountNo: '123456',
                amount: 100.00,
                amountFieldSpecified: true,
                //...
            },
            {
                accountNo: '333456',
                amount: 150.00,
                amountFieldSpecified: true,
                //...
            }]
        },
        {
            transactionType: 'AR',
            stacknumberSpecified: false,
            ///...,

            accountAssignmentTab: [{
                accountNo: '44345',
                taxCode: 19,

                //...,

                cAccDataTab: [{
                    costCenter: '123a',
                    //...
                },
                {
                    costCenter: '123b',
                    //...
                }],

                oIDataTab: [{
                    accountNo: '123456',
                    amount: 100.00,
                    amountFieldSpecified: true,
                    //...
                },
                {
                    accountNo: '333456',
                    amount: 150.00,
                    amountFieldSpecified: true,
                    //...
                }]
            }]
        }]
    }]
});
console.log(result);

Example Usages

   brixxApi.closeModal();

Parameters

• attachmentId - the id of the attachment you want to delete

Example Usages

   brixxApi.deleteAttachment(42);

Parameters

1. controlId - id of the grid control

Example Usages

   brixxApi.clearGridSelection(myGrid);

Creates a deep copy from a config record. Typical example is to create a copy of an "order" record, with a copy of all the "orderLines" from that source "order". brixxbox will use the "Cascade Copy" flag of a grid control, to decide if which referenced records will be copied.

Parameters

1. configName

2. recordId - the id of the source record

3. additionalValues - json object of values in the target record that should be modified. e.g. an "orderDate" field. Can be null, in this case you get a 1:1 copy except the record id.

Example Usages

Exact copy:

   let newOrder = brixxApi.copyConfigRecordById("customerOrder", 1376);

Copy with new date for header data and manipulating two columns of line item data:

   let newOrder = brixxApi.copyConfigRecordById("customerOrder", 1376, {
      cordOrderDate: new Date(),
      cordlnOrderQuantity: "1",
      cordlnDeliveredQuantity: null
   });

Displays a record in an brixxbox app. To get a record, you could use e.g. loadRecord

Parameters

1. the record.

2. the current control. This control is excluded from the discard changes check, that occurs before the record is displayed

Example Usages

Simple (pay attention to the await keyword)

   await brixxApi.displayRecord(myRecord, "myKeyControlId");

Introduction

This documentation provides a complete overview of the xRechnung object used in the createPdf endpoint for generating ZUGFeRD-compliant invoices. The xRechnung object contains key information required to create a legally compliant electronic invoice, following the specifications of the XRechnung format.

Payload Structure

The xRechnung object is part of the main payload sent to the createPdf endpoint. Below is the structure and detailed explanation of all properties within the xRechnung object.

Main Payload Structure

{
  "report": "string",
  "reportName": "string",
  "configName": "string",
  "archive": true,
  "documentTypeId": 0,
  "culture": "string",
  "parameters": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "mainHostUrl": "string",
  "xRechnung": {
    "invoiceMain": { ... },
    "additionalReferencedDocuments": [ ... ],
    "despatchAdviceReferencedDocument": { ... },
    "profile": 1,
    "tradeLineItems": [ ... ],
    "taxes": [ ... ],
    "serviceCharges": [ ... ],
    "receivableSpecifiedTradeAccountingAccounts": [ ... ]
  }
}

xRechnung Object Details

1. invoiceMain

This object contains the main details of the invoice, including invoice number, dates, buyer, seller, and payment terms.

• Type: object

• Properties:

  • invoiceNo (string): The unique identifier of the invoice.

  • invoiceDate (DateTime): The date the invoice was issued.

  • paymentReference (string): Reference used for payments.

  • orderNo (string): The related order number.

  • orderDate (DateTime): The date of the related order.

  • currency (enum): The currency of the invoice. See currency enum.

  • buyer (object): Information about the buyer.

  • seller (object): Information about the seller.

  • notes (array): Notes related to the invoice.

  • paymentTerms (object): The terms of payment.

  • grandTotalAmount (decimal): The total amount of the invoice.

  • duePayableAmount (decimal): The amount due for payment.

  • Other related invoice properties.

2. additionalReferencedDocuments

This array contains documents that reference the invoice, such as orders or contracts.

• Type: array

• Properties:

  • id (string): Identifier of the referenced document.

  • issueDateTime (DateTime): Date and time the document was issued.

  • referenceTypeCode (enum): Reference type code. See referenceTypeCode enum.

  • attachmentBinaryObject (string): Base64 encoded binary object of the attachment.

  • filename (string): Filename of the attachment.

  • typeCode (enum): Type code for the document. See typeCode enum.

3. tradeLineItems

This array contains items or services billed in the invoice.

• Type: array

• Properties:

  • globalID (object): Global ID of the item or service.

  • sellerAssignedID (string): ID assigned by the seller.

  • name (string): Name of the item or service.

  • billedQuantity (decimal): Quantity billed.

  • lineTotalAmount (decimal): Total amount for the line item.

  • taxCategoryCode (enum): Tax category code. See taxCategoryCode enum.

  • netUnitPrice (decimal): Net unit price of the item.

  • unitCode (enum): Unit code for the item. See unitCode enum.

  • Other related line item properties.

4. taxes

This array contains detailed tax information applied to the invoice.

• Type: array

• Properties:

  • basisAmount (decimal): Amount on which the tax is calculated.

  • percent (decimal): Tax percentage.

  • typeCode (enum): Type of tax. See taxType enum.

  • categoryCode (enum): Tax category code. See taxCategoryCode enum.

  • exemptionReasonCode (enum): Reason for tax exemption. See exemptionReasonCode enum.

5. serviceCharges

This array contains additional charges applied to the invoice.

• Type: array

• Properties:

  • tax (object): Tax information related to the service charge (similar to taxes object).

  • amount (decimal): Amount of the service charge.

  • description (string): Description of the service charge.

6. receivableSpecifiedTradeAccountingAccounts

This array contains accounting accounts related to the trade, either receivable or payable.

• Type: array

• Properties:

  • tradeAccountID (string): ID of the trade account.

  • tradeAccountTypeCode (enum): Type of trade account. See tradeAccountTypeCode enum.

Enumerations

1. currency

Represents currency codes.

2. schemeID

Identification schemes for IDs.

3. country

Country codes.

4. subjectCode

Subject codes for notes.

5. contentCode

Content codes for notes.

6. profile

Invoice profiles.

7. type

Invoice types.

8. referenceTypeCode

Reference type codes for documents.

9. taxCategoryCode

Tax category codes.

10. taxType

Tax types.

11. electronicAddressSchemeID

Electronic address schemes.

12. typeCode

Document type codes.

13. unitCode

Unit codes for line items.

14. paymentMeansTypeCode

Payment means type codes.

15. tradeAccountTypeCode

Trade account type codes.

This documentation provides a complete and structured overview of the xRechnung object, including all properties and enumerations used in the payload.

It is very important to be cautious because different date formats can lead into worng results when in comparison.

Parameters

1. param - (optional). If empty it will return todays date. User is also allowed to provide a date or moment object of javascript.

Example Usages

Following examples shows all three usages of getDate function. Lets suppose we want to know the new order placement date which is today then we can use 1st or second example. We also suppose that our order delivery date is after one month then we can use the third example and use this date as a delivery date.

   brixxApi.getDate();
   brixxApi.getDate(new Date());
   brixxApi.getDate(new moment().add(1, "month"));

Parameters

1. options - Json object with the same properties as [createPublicAppUrl](/globalDoc/function_createPublicAppUrl) options, plus:

   • publicUser - the user email address of the brixxbox user, that will be used for the public app .

Example Usages

   await brixxApi.createPublicAppUrl({appName: "survey", publicUser: "surveyuser@acme.com", id:1});

Sends a PDF to a printer, that is connected by the BrixxboxCloudGateway. You can sent a document to a cloudprinter by using createReport as well

Parameters

A json object

Example Usages

Print an existing attachment

   brixxApi.cloudPrint({
      printerName: "HP LaserJet", //Printer NAme
      attachmentId: "1", //Attachment id
   });

Print an existing attachment with multiple copies

   brixxApi.cloudPrint({
      printerName: "HP LaserJet", 
      attachmentId: "1", 
      copies: 5 // 1 copy is the default. Needs "cloudPrint Gateway" installer Version 1.0.1 or newer
   });

Print a new created report without archiving

   let myReport = await brixxApi.createReport("myReport");
   brixxApi.cloudPrint({
      printerName: "HP LaserJet", //Printer NAme
      blob: myReport, //The report blob object
   });

Example Usages

   let unmodifiedCompareValue = brixxApi.getControlUnmodifiedValue("myControlId");

Parameters

1. dateTime value or controlId

2. accuracy - "seconds" (default), "minutes" or "hours"

Example Usages

   brixxApi.getCalcDateTime(myDateTimeControl);
   brixxApi.getCalcDateTime(myDateTimeControl, "minutes");
   brixxApi.getCalcDateTime(myDateTimeControl, "hours");

Example 2 calculation

   let durationInSeconds = brixxApi.getCalcDateTime(myDateTimeEnd) - brixxApi.getCalcDateTime(myDateTimeStart);
   let durationInMinutes = brixxApi.getCalcDateTime(myDateTimeEnd, "minutes") - brixxApi.getCalcDateTime(myDateTimeStart, "minutes");
   let durationInHours = brixxApi.getCalcDateTime(myDateTimeEnd, "hours") - brixxApi.getCalcDateTime(myDateTimeStart, "hours");

Gets a GUID Token, that identifies the browser. This token will NOT be different, when you close all browser tabs and start the brixxbox again. But it will be different, when you delete the local storage for that url. You could use this to identify a shopping cart, for example.

Example Usages

   let myToken = brixxApi.getBrowserToken();

brixxApi.getSessionToken

GUID stands for Global Unique Identifier. A GUID is a 128-bit integer (16 bytes) that you can use for authentication purposes. There are many types of GUID tokens, one of them is browser token. We can use this token to identify a user for same browser because his token will NOT be different, when you close all browser tabs and start the Brixxbox again. But it will be different, when you delete the local storage for that url. This function can be used to get GUID for browser. It can then be used to keep user session open. Another usecase is that it could be used to identify a shopping cart. An important aspect here to note is that when when you close all browser tabs and start the Brixxbox again, this token will not be different.

Example Usages

An example user is that user can get access tokens using this getBrowserToken functions from two apps and compare them to confirm user identity i.e after login this can be used as authenticate the user between different browser sessions.

Parameters

1. controlId - The control id of the field

2. validatorName - the name of the validator

3. enable - enable (true=default) or disable (false) the validator

Example Usages

   brixxApi.enableValidator("firstName", "notEmpty", false); //disables the validation of notEmpty for the control firstName

Example Usages

   let msg = brixxApi.getCustomMessage("messageName", {"param1": "text1", "param2": "text2"}, "en-Us");
   brixxApi.setFieldValue("controlId", msg);

Parameters

1. procedureName - The name of the stored procedure

2. procedure parameters - If you need to add parameters, you can use this json object to set them

3. queryOptions - (optional) a json object with options for the request

   • timeout - (optional) timeout for the SQL Request. Default is 30 seconds

   • connectionKey - (optional) a key to a custom settings entry with the connection string to an external MSSQL database

Example Usages

1. Simple (pay attention to the await keyword)

   await brixxApi.executeStoredProcedure("procedureName");