Integrator Guide

The integrator guide covers the process of extending Corteza to cover your business needs. An integration can be as simple as the modification of the login screen to include your brand graphics, or as complex as the implementation of a completely custom Low Code application.

This guide briefly goes over some administration aspects. For a complete insight into system administration (roles and RBAC permissions) refer to the Administrator Guide

If you haven’t yet setup your Corteza instance, refer to the DevOps guide.

The security model

For authentication, Corteza implements the OAuth2 protocol, where Corteza can act both as an OAuth2 client or as a server. Refer to the authentication section for details.

For access control, Corteza implements a RBAC facility which allows you to fine tune access permissions to your needs. Refer to the Access control section for details.

Personalize the design

The login screen can be completely personalized to match your brand and give your users a piece of mind when entering their credentials. Refer to the personalization  authentication section for details.

It is a good idea to include your brand graphics where your Corteza instance will be accessed by external users.

To personalize other Corteza web applications, you need to do so in the source code and rebuild your custom web application manually.

DevNote: add some documentations about this.

Access Corteza via the API

Corteza is API-centric, meaning that everything can be done via an API endpoint. Refer to the accessing Corteza sections for details regarding authentication, API endpoints, data format, and the query language.

If you wish to connect an external application with Corteza in order to exchange data, you can use our Node.js API clients.

Create a custom Low Code app

To create your own Low Code app is as easy as telling Corteza what data you wish to store, how the data is related, and how it should be displayed.

Refer to the Low Code configuration to get the basic understanding of the different components, what they do and how they are configured.

Refer to the Low Code configuration  module field types sub section for an overview of the supported field types and their configuration options.

Refer to the Low Code configuration  field expressions sub section to learn how you can define value expressions (formula fields), custom value sanitizers and validators.

Automate your process

Corteza provides a powerful automation facility that allows you to implement nearly anything! Automation is defined either via workflows (automation  workflow) or automation scripts (automation  automation script).

A workflow is a simplified BPMN diagram, allowing you to describe the automation in a human-friendly manner. A workflow is the recommended way to implement an automation as they are easier to read and maintain.

An automation script is a piece of JavaScript code that performs the desired operation.

If the automation requires multiple complex operations that are not natively supported by the workflow engine, an automation script may be a better choice.

Create custom documents

To enable PDF document rendering, you will need to run the gotenberg Docker container.

DevNote: add instructions on how to setup.

Corteza defines a flexible template facility, allowing you to define custom documents (such as marketing emails and PDF quotes) that you will send to your contacts. The template facility currently supports PDF, HTML, and plain text formats.

Refer to the templates section to overview the process of defining a template and rendering a document.

You can request document rendering from external applications via the REST API.

DevNote: add a reference to the endpoint.

Do you need help or have suggestions?

Get in touch with us on our forum. Feedback, questions, and suggestions are always welcome!