BzCtrl. Guidance document

Explaining features page by page.

Introduction

Welcome to BzCtrl (pronounced “Bizz Control”)—your partner in managing and controlling business processes while keeping compliance in check. To make it truly work, every implementation needs an Owner—someone committed to using BzCtrl. consistently and keeping things on track. With that focus, the tool will streamline workflows, boost efficiency, and help your team get things done.


Let's go!

BzCtrl.

Use cases

This Chapter provides some use cases on which basis the functionality of BzCtrl. is explained.
Use cases

Engaging Business Partners in Compliance Procedures

Instead of receiving documentation from business partners via email for manual review and archiving, streamline and control the process using a SnapForm.

Start by defining which documents are required per order. Then include control questions that allow your business partner to confirm upfront the checks you would normally perform upon receipt of the documentation. For example: 


editor_17_5_8e6bab8f-67d8-4536-90fd-1062763b3813_rte_image_539.png

Once the setup is completed, publish it as a SnapForm.

editor_17_5_e05cce5a-d5b6-4c1d-b3c8-a472b4cfb1ef_rte_image_543.png


editor_17_5_efb2cc38-25e3-4d07-97d4-1bd36606a38e_rte_image_549.png

The SnapForm is now available under the DMR Trading Workspace.

editor_17_5_bdab1b0c-dc45-48f6-87b8-774292195e56_rte_image_566.png

Here you can generate the QR code or URL for the SnapForm.

editor_17_5_69afee6a-de53-4de4-8f66-0a4103a9d916_rte_image_576.png


editor_17_5_cccb014d-b4ab-47e4-83d3-e63596f36dd7_rte_image_157.png

Jason from DMR Trading will see the Form as an External User, without requiring access to the BzCtrl. environment itself.

editor_17_5_12d0b855-7693-4ed5-afb3-6045140df90d_rte_image_589.png

The company retains full access to all Forms, allowing it to monitor status and verify completeness and accuracy of the submitted information.

editor_17_5_ff46b967-8e3a-4cfd-8099-acedde8c5fe4_rte_image_603.png

That’s it! Everything is automatically and properly archived, including all relevant attachments.

Note that if it is already known that Jason or a specific group of users will be using the SnapForm, this can also be configured directly in advance.


editor_17_5_a7fce336-35b9-4711-9db7-ee13bb618d5f_rte_image_619.png

This avoids the need to include full details each time the SnapForm is used; instead, usage can simply be confirmed.

editor_17_5_abb3ce41-299d-4236-b56a-cf754a43f58a_rte_image_637.png











Navigation and Settings

Understanding the general setup and how things are organized within BzCtrl. 
Navigation and Settings

Navigation

BzCtrl. is organized around Domains and Workspaces, which you can select from the Navigation Tree in the top-right corner of the tool. Understanding this structure is key to using BzCtrl. efficiently.


editor_17_5_4b8d2522-74ce-4dbe-b21e-b0694fc082b4_rte_image_18.png


Domains

Workspaces

Pages


editor_17_5_78255d22-1923-4570-a40e-b26eb74fa02d_rte_image_55.png

Quick Overview

  1. Navigation Tree (top-right): Select Domains or Workspaces.

  2. Domains: Structure your Workspaces, group and share data, assign roles, and create hierarchy.

  3. Workspaces: Record and manage your To-do’s.

  4. Pages (left): View the data related to the currently selected Domain or Workspace.

Navigation and Settings

User Settings

In the top-right corner of BzCtrl., you will find your Avatar. Clicking on it gives access to general settings where you can configure your profile, preferences, calendar integration, security, and the look-and-feel of the application.


editor_17_5_00f771e0-2e3a-4158-8cdc-c85496a03a42_rte_image_70.png


Profile & Calendar Integration

Security

Theme & Customization

These settings allow you to tailor BzCtrl. to your personal workflow and company requirements, helping you stay organized, secure, and efficient.

Navigation and Settings

Options and Filters Pane

Description
Navigation and Settings

Internal and External Users

Description

Pages

This Chapter described the features on a Page by Page basis explaining the features the Page offers.
Pages

To do


Types of To-do’s


BzCtrl. supports four types of To-do’s:


  1. Tasks – Regular action items.

  2. Incidents – Issues that need attention or resolution.

  3. Forms – Structured inputs or reports.

  4. Documents – File-based tasks or references (entry via Files Page only).


Creating a To-do



editor_16_5_3fcc6acb-547e-4f2b-a828-96090f035972_rte_image_219.png



editor_16_5_e07e7653-0f86-4396-8ff5-744b4fa79ef6_rte_image_234.png

Filters & Options


The Filters & Options button, located in the top-right corner of BzCtrl., gives users control over how data is displayed and provides additional functionalities to make work more efficient.


editor_311_5_f78afff5-1b72-4349-a7c6-8a31ee74536a_rte_image_249.png


Filters


Options

Filters and Options allow you to customize your View and access helpful tools that make managing to-do's, data, and processes simpler and more efficient.


Views


BzCtrl. offers five different Views to display your To-do’s, each designed to support different ways of working and tracking progress. You can switch between Views to find the perspective that best suits your task or project.


ViewIcon / ScreenshotPurposeBest Use Case
List Vieweditor_311_5_eb421e6a-7e20-4cb3-a6f9-a6c112984cb0_rte_image_314.png Shows extensive details and filtersData-heavy work requiring full information
Cards View (Kanban)editor_311_5_e1368022-620f-4ea0-a076-a1e243517c14_rte_image_322.png Visualizes workflow in columns: To-do / In Progress / Done / ExpiredTeam meetings and collaborative task tracking
Gantt View[Insert screenshot/icon]Plots To-do’s on a timeline; highlights status and risks with colorsMonitoring projects, control plans, or time-sensitive tasks
Tile Vieweditor_311_5_4de5818a-a5b9-421a-88b0-fe2b76985218_rte_image_333.png Displays To-do’s as Tiles; click to view details alongside overviewTasks needing context and relationships between items
Calendar Vieweditor_311_5_a59ee46d-a565-4d02-a3c9-11194d1d914f_rte_image_363.pngShows To-do’s by Due Date; Week and Month viewsPlanning workloads and tracking deadlines



1. List View



2. Cards View (Kanban)



3. Gantt View



4. Tile View



5. Calendar View




Pages

Configure Workspace

Include description
Pages

Files

Description
Pages

Organise

Description
Pages

Dashboards

Description
Pages

Risk Register

The Risk Register Page in BzCtrl. allows users to identify, document, and manage risks, including the actions taken to mitigate them. It provides a centralized overview of all risks and supports linking them to relevant activities and assets within the system.

Registering a Risk

Users can create and maintain risks by:


Risk Overview (Table View)

The main table provides a clear overview of all registered risks, including:


Include image

Selecting the Risk Key opens the detailed view of that specific risk.


Risk Details Page

The Details Page provides a complete overview of the selected risk and allows users to:


Include image

This ensures that all activities, documentation, and controls related to the risk are consolidated in one place.


Risk Matrix

In addition to the table view, a Risk Matrix subpage is currently under development.


Include image

Risk Matrix score calculation

The calculation of the scores is based on all To do's (i.e. Incidents and Forms) associated with the specific Risk.

editor_17_5_2259fd5e-e58d-45f1-a4c9-8d689c879702_rte_image_45.png


Pages

HandBookR

HandBookR is an embedded documentation feature within BzCtrl., designed to structure, manage, and share knowledge in a clear and accessible way. It enables users to create and maintain structured documentation that is directly linked to business processes and controls.

Structured Documentation

HandBookR organizes information in a logical, hierarchical structure:

This structure ensures clarity and makes documentation easy to navigate and maintain.

Content Creation & Editing

Search & Navigation

Version Control

Diagrams & Process Flows

HandBookR allows users to easily include diagrams and process flows within documentation.

This functionality is powered by the same Canvas capability available elsewhere in BzCtrl., enabling users to combine written documentation with visual process design in one place.

Access Control

Integration within BzCtrl.

HandBookR can be linked to other elements in BzCtrl., such as:

This ensures that documentation is directly connected to operational activities and compliance processes.


Pages

Canvas

Canvas in BzCtrl. is a visual diagramming feature that allows users to design, document, and share processes, workflows, and structures in a clear graphical format. It is used to complement written documentation (for example in HandBookR) by translating complex information into easy-to-understand visuals.


Core Functionality

Canvas provides a flexible diagramming workspace where users can:


Typical Use Cases

Canvas is commonly used for:


Key Features


Role within BzCtrl.

Canvas is fully integrated into BzCtrl. and can be used directly from documentation (such as HandBookR) or other functional areas. This allows users to combine textual documentation and visual process design in a single environment, ensuring better understanding and alignment across teams.

Pages

Forms

Description

Customisations

An overview of customisations currently implemented
Customisations

VAT reporting

Description
Customisations

Incidents interface

Description
Customisations

Belgian excise reporting

Description
Customisations

Taric Service

Description

Features in BzCtrl.

These features can be used across multiple Pages and Workspaces to simplify daily operations and improve efficiency.

Features such as ApiForm and SnapForm also enable integration with external users and systems, allowing data to be exchanged and processes to connect seamlessly across platforms.

Additional information and feature updates can also be found on the official website: BzCtrl.

Features in BzCtrl.

External System Integration - ApiForms

BzCtrl. provides the ability to call predefined Forms through API communication using the ApiForms feature. This allows external systems to create and link Form instances directly from within their own operational processes.

The main value of ApiForms is that a user can launch a specific Form directly from the source system, while the created Form instance remains permanently accessible through a stored URL within that source system.


How ApiForms Work

Each ApiForm provides a unique API endpoint that allows an external system to create a new Form instance in BzCtrl.

The request includes:


Once the Form instance is created, BzCtrl. returns a response containing the direct URL to the Form instance. This URL can then be stored in the source system, allowing users to always reopen the corresponding Form directly from their operational process.


User actions

Step 1 - From the Forms Page the User can create an ApiForm via the Action Button for a specific Form;

editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png

Step 2 - Select the Workspace where the Form Instances should be created and stored;


editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png

Step 3 - From the Configure page the Form is now available as ApiForm. Please make sure the correct Workspace is selected (right top). From the ApiForms Table select the ApiForm Key Button to get the details to share with your developers.

editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png

Input to Developers External system

Step 1 - Authentication

Before an ApiForm can be called, the external application must authenticate with BzCtrl. Authentication is performed by sending a POST request to the appropriate authentication endpoint using credentials provided for API communication.

Endpoints

Acceptance Environment (ACC)
https://acc.bzctrl.com/bzctrl-core-api/oauth/token

Production Environment (PROD)
https://bzctrl.com/bzctrl-core-api/oauth/token

Request Method

POST

Request Body (x-www-form-urlencoded)

grant_type=password
username=example@example.com
password=Ex@mpl3!

Sample Response

{
"access_token": "xxxxxxxxxx",
"refresh_token": "xxxxxxxxxx",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "*",
"jti": "xxxxxxxxxx"
}

Result

Upon successful authentication, BzCtrl. returns an access token that must be included in subsequent API requests. The token serves as proof of authentication and authorizes communication with the BzCtrl. API. The token remains valid for the period specified in the expires_in field.


Step 2 - Api Form Key

Here you see the API Endpoint url to share with your developers, which use will result in the creation of a Form Instance of the respective Form on your selected Workspace. In the Body of the message Tags can be included, which is usually used for adding Order ID's to be recorded in the Form Instance.

editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png

After creation the Response message includes a Tasklink that can be stored to allow the user access to the Form Instance from the External system at any stage. 




Features in BzCtrl.

External System Integration - Incidents & Tasks

BzCtrl. provides a feature that allows external systems to create Incidents and Tasks directly through REST API communication. This enables operational systems to register issues or actions directly within their own workflows while ensuring follow-up and tracking take place in BzCtrl.

The main value of this feature is that it allows Incidents and Tasks to be created directly from specific screens or processes within an external operational system, without requiring users to manually enter data into BzCtrl.


Integration Flow

The integration process consists of the following steps:

The request contains the information required to create the Incident (or Task) in BzCtrl.


Step 1 - Authentication

Before an ApiForm can be called, the external application must authenticate with BzCtrl. Authentication is performed by sending a POST request to the appropriate authentication endpoint using credentials provided for API communication.

Endpoints

Acceptance Environment (ACC)
https://acc.bzctrl.com/bzctrl-core-api/oauth/token

Production Environment (PROD)
https://bzctrl.com/bzctrl-core-api/oauth/token

Request Method

POST

Request Body (x-www-form-urlencoded)

grant_type=password
username=example@example.com
password=Ex@mpl3!

Sample Response

{
"access_token": "xxxxxxxxxx",
"refresh_token": "xxxxxxxxxx",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "*",
"jti": "xxxxxxxxxx"
}

Result

Upon successful authentication, BzCtrl. returns an access token that must be included in subsequent API requests. The token serves as proof of authentication and authorizes communication with the BzCtrl. API. The token remains valid for the period specified in the expires_in field.


Step 2 - Create Incident (or Task)

After receiving the access token from the OAuth API, use the Add Task API to create a new Task or Incident.

EndPoint

ACC: https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-task

PROD: https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-task 


Note: The access token received from the OAuth Token API must be included in the Authorization header using the Bearer scheme.

Request MethodPOST

Required Headers

Content-Type: application/json
Authorization: Bearer {access_token}

Sample Request Body

{
  "todoType":"INCIDENT",
  "domainWorkSpace":"EXA-CON-BUS-WOR",
  "title":"Potential Customs claim",
  "description":"Operation started without proper approvals",
  "financialImpact":"123577",
  "impact":"HIGH",
  "likelihood":"MEDIUM",
  "status":"IN PROGRESS",
  "priority":"HIGH",
  "assignee":"Example@example.com",
  "reporter":"Example@example.com",
  "category":["Customs"],
  "subCategory":["IT"],
  "lrn":"725462",
  "orderID":"ORDER 777",
  "reminderDate":"2024-09-27"
}

Sample Response

{
  "title":"Potential Customs claim",
  "taskType":"INCIDENT",
  "description":"Operation started without proper approvals",
  "taskLink":"https://www.bzctrl.com/app/#/todo/EXA-CON-BUS-WOR-03",
  "tags":["ORDER 777"]
}

This URL can be stored in the external system for direct access and traceability. Or you can open this URL in the browser by the JavaScript function(window.open("URL") ).

From a UI/UX perspective the following should be considered (* Mandatory, Italic - User input, CAPITOL - System generated Values)

Todo TypeFieldsInputComments
incident, tasktodoType*INCIDENTCustomer - option to change to Task (or in case only used for Incidents default value)
incident, taskdomain*EXA-CON-BUS-WORDefault value to include by Customer, relates to the Domain
incident, taskworkspace*WORDefault value to include by Customer, relates to the Workspace under the Domain
incident, tasktitle*Free text fieldCustomer, allow user to provide Title/Subject
incident, taskdescription*Free text fieldCustomer, allow user to provide Description
taskresultFree text fieldCustomer, allow user to provide Results  (optional)
incidentfinancialImpactNumbers fieldCustomer - For User  it should be clear this is a EUR amount. Only Number is provided. BzCtrl. - This should be included in the Field "Potential financial impact of the incident" set as EUR.
incidentimpactHigh, Medium, LowCustomer, allow user to select out of these three options (optional)
incidentlikelihoodHigh, Medium, LowCustomer, allow user to select out of these three options (optional)
incident, taskstatus*In ProgressOptions BzCtrl. are To do, In Progress, Done and Expired. Customer - default when sending on In Progress, with option to change by User to Done. BzCrtrl. - If status - Done, set due date to date transaction.
incident, taskpriorityHigh, Medium, LowCustomer, allow user to select out of these three options (optional)
incident, taskassignee*User@example.comCustomer, Same as Reporter. E-mail address of the User.
incident, taskreporter*User@example.comCustomer, E-mail address of the User.
incident, taskcategory n/a
incident, taskorderID*ServiceOrder NumberCustomer - BzCrtrl. - Set as Tag
incident, taskLRNLRNCustomer - BzCrtrl. - Set as Tag (if available handy reference)
incident, taskreminderDateCalendar selectionn/a



Features in BzCtrl.

ApiForm instruction - VTTI specific

BzCtrl. provides the ability to call predefined Forms through API communication using the ApiForms feature. This allows external systems to create and link Form instances directly from within their own operational processes.

The main value of ApiForms is that a user can launch a specific Form directly from the source system, while the created Form instance remains permanently accessible through a stored URL within that source system.


How ApiForms Work

Each ApiForm provides a unique API endpoint that allows an external system to create a new Form instance in BzCtrl.

The request includes:


Once the Form instance is created, BzCtrl. returns a response containing the direct URL to the Form instance. This URL can then be stored in the source system, allowing users to always reopen the corresponding Form directly from their operational process.


User actions

Step 1 - From the Forms Page the User can create an ApiForm via the Action Button for a specific Form;

editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png

Step 2 - Select the Workspace where the Form Instances should be created and stored;


editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png

Step 3 - From the Configure page the Form is now available as ApiForm. Please make sure the correct Workspace is selected (right top). From the ApiForms Table select the ApiForm Key Button to get the details to share with your developers.

editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png

Input to Developers External system

Step 1 - Authentication

Before an ApiForm can be called, the external application must authenticate with BzCtrl. Authentication is performed by sending a POST request to the appropriate authentication endpoint using credentials provided for API communication.

Endpoints

Acceptance Environment (ACC)
https://acc.bzctrl.com/bzctrl-core-api/oauth/token

Production Environment (PROD)
https://bzctrl.com/bzctrl-core-api/oauth/token

Request Method

POST

Request Body (x-www-form-urlencoded)

grant_type=password
username=cms@api.com
password=Nologicincustoms#24

Sample Response

{
"access_token": "xxxxxxxxxx",
"refresh_token": "xxxxxxxxxx",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "*",
"jti": "xxxxxxxxxx"
}

Result

Upon successful authentication, BzCtrl. returns an access token that must be included in subsequent API requests. The token serves as proof of authentication and authorizes communication with the BzCtrl. API. The token remains valid for the period specified in the expires_in field.


Step 2 - Api Form Key

Here you see the API Endpoint url to share with your developers, which use will result in the creation of a Form Instance of the respective Form on your selected Workspace. In the Body of the message Tags can be included, which is usually used for adding Order ID's to be recorded in the Form Instance.


ApiForm Key - Acceptance Environment (ACC)
https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjUwMywiY29tcGFueUlkIjozMzEsImNvbnRyb2xJZCI6MTQxNSwiZW5jb2RlVXJsIjoiZDMzOGExNmYtZGIzMS00OTQzLTliMzUtMzQ4YmYzMzc1ZTE1IiwiY3JlYXRvcklkIjo2NjMsIndvcmtTcGFjZU5hbWUiOiJDdXN0b21zIiwicmVwb3J0ZXJVc2VySWQiOjY2MywicmVwb3J0ZXJVc2VyTmFtZSI6IlJlbXkgR2VlcnRzIn0=

ApiForm Key - Production Environment (PROD)
https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjI4MywiY29tcGFueUlkIjoxOTksImNvbnRyb2xJZCI6MTQ1NSwiZW5jb2RlVXJsIjoiNWJhM2QxMGYtNTgzMy00N2VjLWE5NzktMDk5NTM5MTNjNTM3IiwiY3JlYXRvcklkIjoxMywid29ya1NwYWNlTmFtZSI6IkN1c3RvbXMiLCJyZXBvcnRlclVzZXJJZCI6MTMsInJlcG9ydGVyVXNlck5hbWUiOiJSZW15IEdlZXJ0cyJ9


editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png

After creation the Response message includes a Tasklink that can be stored to allow the user access to the Form Instance from the External system at any stage.