1 of 9

Functions

loadConfigRecordById

Server Function to load a config record and return the record object.

Parameters

mode - Config name
id - Record Id

Example Usages

loads a record and stores it in a variable

   let record = await brixxServerApi.loadConfigRecordById("address", req.body.parameters.addressId);

See also client side api loadConfigRecordById

saveConfigRecordById

Saves or creates a config record and returns the new record object.

Parameters

mode - Config name
id - Record Id

Example Usages

Create a new Record with 2 fields

   let newRecord = await brixxServerApi.saveConfigRecordById({
       adrName: "John",
       adrLastName: "Doe",
   });

See also client side api saveConfigRecordById

sqlWrite

Executes a write sql statement and returns the number of rows affected

Parameters

statementName - The name of the statement
additionalParameters - all controls in the current config are set as paramters automatically. If you need to add additional parameters, you can use this json object to set them
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

Update a record with parameters

   let rowsChanged = await brixxServerApi.sqlWrite("updateAddres", {
       newName: "John",
       addressId: 45,
   });

sqlRead

Executes a write sql statement and returns the number of rows affected

Parameters

statementName - The name of the statement
additionalParameters - all controls in the current config are set as paramters automatically. If you need to add additional parameters, you can use this json object to set them
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

Read all data without parameters

   let rowsChanged = await brixxServerApi.sqlRead("getAddresses", {}, {timeout: 90});

Read all data with parameters

   let rowsChanged = await brixxServerApi.sqlRead("getAddresses", { adrType: 1});

sendEmail

This server side api function does support the same parameters (Attachements and so on) as ComposeEmail from the client side api. Emails are sent automatically, as there is no UI.

Example 1

   await brixxServerApi.sendEmail({
            to: ["john.doe@acme.com"],
            text: "Hello World",
            subject: "Demo Email",
        });

createReportPdfBlob

This server side api function does support the same parameters as createReportPdfBlob from the client side api.

Example 1

    await brixxServerApi.createReportPdfBlob({
            reportName: "myDemoReport",
            configName: "address",
            archive: true,
            parameters:{
                id: 45
            },
        });

cloudPrint

This server side api function does support the same parameters as cloudPrint from the client side api.

Api Version > 0.1.30

Example 1

Send a blob object to the cloud print api

    let resultObj = await brixxServerApi.cloudPrint({
            blob: myBlob,
            printerName: "HP LaserJet",
        });
    console.log(resultObj.status);

Example 2

We create a blob with create report and send it to the cloudPrint api

        let pdfBlob = await brixxApi.createReportPdfBlob({
            reportName: "demo1",
            configName: "address",
            archive: true,
            parameters:{
                id: 45
            },
        });
        let resultObj  = await brixxApi.cloudPrint({
            blob: pdfBlob,
            printerName: "HP LaserJet",
        });
        console.log(resultObj.status);

Example 3

Send a base64 file content to the cloudPrint api.

        let resultObj = await brixxApi.cloudPrint({
            documentBase64Content: myBase64PdfContent,
            printerName: "HP LaserJet",
        });
        console.log(resultObj.status);

businessBrixx

This server side api function does support the same parameters as businessBrixx from the client side api.

let result = await brixxApi.businessBrixx({
            functionName:"CurrencyConverter",
            methodName: "Convert",
            fromCurrencySymbol: "EUR",
            toCurrencySymbol: "USD"
        });
console.log(result);

cloudPrint

This server side api function does support the same parameters as cloudPrint from the client side api.

Api Version > 0.1.30

Example 1

Send a blob object to the cloud print api

    let resultObj = await brixxServerApi.cloudPrint({
            blob: myBlob,
            printerName: "HP LaserJet",
        });
    console.log(resultObj.status);

Example 2

We create a blob with create report and send it to the cloudPrint api

        let pdfBlob = await brixxApi.createReportPdfBlob({
            reportName: "demo1",
            configName: "address",
            archive: true,
            parameters:{
                id: 45
            },
        });
        let resultObj  = await brixxApi.cloudPrint({
            blob: pdfBlob,
            printerName: "HP LaserJet",
        });
        console.log(resultObj.status);

Example 3

Send a base64 file content to the cloudPrint api.

        let resultObj = await brixxApi.cloudPrint({
            documentBase64Content: myBase64PdfContent,
            printerName: "HP LaserJet",
        });
        console.log(resultObj.status);