Customizing your CoolCalc

Static HTML for the downloadable MJ8 report is hosted on your local server so you can customize the look and feel of the report. You can add OEM, distributor or contractor logos and branding as is appropriate for your installation.

From your web root, the typical URL to the static HTML for the downloadable MJ8 report is:

• Bootstrap version, staging and current:
  • /ui/mj8/v-bootstrap/staging/mj8-report.html
  • /ui/mj8/v-bootstrap/current/mj8-report.html
• Unkuna version, staging and current:
  • /ui/mj8/v-unkuna/staging/mj8-report.html
  • /ui/mj8/v-unkuna/current/mj8-report.html

In most cases customizing this HTML will require nothing more than adding a branded header and/or footer. If you want to do more extensive customization keep in mind that certain attributes like HTML ids, data-khipu-role and data-coolcalc-role attributes are required for the correct rendering of the JSON data. If you have any doubts as to specific changes in the HTML please contact our development team.

Static HTML for the downloadable MJ8 report is hosted by the client to allow for custom branding of the MJ8 reports. HTML to PDF conversion for MJ8 reports must be implemented on the client side but the boilerplate CoolCalc libraries includes sample code that can be easily adapted to most installations.

Overview of MJ8 report to PDF implementation:

1. The CoolCalc JavaScript library automatically assigns a click handler to the "Download PDF" button in the user interface. This click handler invokes the function returned by myFunFactory.PDFHandler in the local JavaScript library.
2. In it's default implementation, the anonymous function returned by myFunFactory.PDFHandler makes an HTTP POST request to an endpoint on your server identified in attribute myFunFactory.PDFURL.
3. The payload of the POST request contains a JSON string with the HTML URL of the MJ8 report. Your local endpoint only needs to convert the HTML to PDF.
4. In its default implementation the anonymous function returned by myFunFactory.PDFHandler expects the response from your local endpoint to be a JSON payload with a first level attribute "FileUrl" which indicates the URL of the created PDF. The anonymous handler then opens the PDF at the given URL.

Like PDF conversion, code to email/share the MJ8 report must be implemented on the client side but the boilerplate CoolCalc libraries includes sample code that can be easily adapted to most installations.

Overview of MJ8 report email/share functionality:

1. The CoolCalc JavaScript library automatically assigns a click handler to the email "Send" button in the user interface. This click handler invokes the function returned by myFunFactory.emailHandler in the local JavaScript library.
2. In it's default implementation, the anonymous function returned by myFunFactory.emailHandler makes an HTTP POST request to an endpoint on your server identified in attribute myFunFactory.emailURL.
3. The payload of the POST request contains a JSON string with the HTML URL of the MJ8 report and the "email to" address. Your local endpoint only needs to convert the HTML to PDF, then email the PDF to the given email address.

If you want to make the CoolCalc applications available to unauthenticated users there are a few additional considerations.

In CoolCalc all projects must be assigned to an account nr (customer identification) which is unique in the scope of your application and cannot be empty. To the CoolCalc API it does not matter if this customer is known to you or not. If the user is not authenticated (you do not know who they are) you must generate a unique “John or Jane Doe” id for the duration of the session. Your application provides the “John or Jane Doe” id to the CoolCalc API the same way as you provide a known user's identification.

If the unauthenticated user at some point becomes known (logs in or creates an account) your application can make a special PUT request to the CoolCalc API to update the work that was done by the user while unauthenticated to the known users account nr.

If your web server implements CSRF protection it's typically necessary to inject a CSRF hander function to the CoolCalc JavaScript library. The CoolCalc JavaScript library accepts an anonymous function with input param "xhr" as CSRF handler. You can implement the internal details as appropriate for the CSRF protection implemented on your server. The CoolCalc JavaScript library will automatically invoke the injected handler prior to any XHR (ajax) request.

If required, your local server-side library can inject custom REST resources in the application flow above and beyond the REST resources provided by the CoolCalc API. In order to inject custom REST resources the following steps are required:

• Implement a local endpoint on your server that provides the static HTML for your custom resources. The static HTML is provided as a JSON object with the key => value pairs representing the custom resource name and the corresponding static HTML.
• Implement the JSON output for the custom resource in your local server-side library.
• Optionally implement a custom "render" handler in the local JavaScript library if rendering the custom resource requires any specifics on the script side.

The JSON output of your custom resource should follow the following format:

{ "myResourceName": {  // Some interesting data here  },
    "navTrail": [],
    "links": [
        { "rel": "self", "href": "" }
    ]
}