# BzCtrl. Guidance document

<div>Explaining features page by page.</div>

# Introduction

<span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">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 **O**</span>**wner**<span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">—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.</span>

<div id="bkmrk-"><span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">  
</span></div><div id="bkmrk-let%27s-go%21"><span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">Let's go!</span></div><div id="bkmrk--1"><span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">  
</span></div><div id="bkmrk--2" style="cursor: auto; text-align: center;">![BzCtrl.](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_2b041677-1af5-49d8-a082-cc494597509e_BzCtrl..png)</div>

# Use cases

<div>This Chapter provides some use cases on which basis the functionality of BzCtrl. is explained.</div>

# Engaging Business Partners in Compliance Procedures

<div id="bkmrk-instead-of-receiving">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:

</div><div id="bkmrk--1">  
</div><div id="bkmrk--2">![editor_17_5_8e6bab8f-67d8-4536-90fd-1062763b3813_rte_image_539.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_8e6bab8f-67d8-4536-90fd-1062763b3813_rte_image_539.png)</div><div id="bkmrk--3">  
</div><div id="bkmrk-once-completed%2C-make">Once the setup is completed, publish it as a SnapForm.</div><div id="bkmrk-">  
</div><div id="bkmrk--4">![editor_17_5_e05cce5a-d5b6-4c1d-b3c8-a472b4cfb1ef_rte_image_543.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_e05cce5a-d5b6-4c1d-b3c8-a472b4cfb1ef_rte_image_543.png)</div><div id="bkmrk--5">  
</div><div id="bkmrk-and%C2%A0link-it-to-the-r">Link the SnapForm to the relevant Workspace, in this case the Workspace for **DMR Trading**.  
</div><div id="bkmrk--7"><span>  
</span></div><div id="bkmrk--8" style="cursor: auto; text-align: center;">![editor_17_5_efb2cc38-25e3-4d07-97d4-1bd36606a38e_rte_image_549.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_efb2cc38-25e3-4d07-97d4-1bd36606a38e_rte_image_549.png)</div><div id="bkmrk--9" style="cursor: auto;"></div><div id="bkmrk--10" style="cursor: auto;">  
</div><div id="bkmrk-now-it-is-available-" style="cursor: auto;"><div class="qMYqUG_convSearchResultHighlightRoot"><div class="" data-is-intersecting="true" data-turn-id-container="request-6983b721-729c-8325-8e01-1fdf8cecb96b-26"><section class="text-token-text-primary w-full focus:outline-none has-data-writing-block:pointer-events-none [&:has([data-writing-block])>*]:pointer-events-auto R6Vx5W_threadScrollVars scroll-mb-[calc(var(--scroll-root-safe-area-inset-bottom,0px)+var(--thread-response-height))] scroll-mt-[calc(var(--header-height)+min(200px,max(70px,20svh)))]" data-scroll-anchor="false" data-testid="conversation-turn-68" data-turn="assistant" data-turn-id="request-6983b721-729c-8325-8e01-1fdf8cecb96b-26" data-turn-id-container="request-6983b721-729c-8325-8e01-1fdf8cecb96b-26" dir="auto"><div class="text-base my-auto mx-auto pb-10 [--thread-content-margin:var(--thread-content-margin-xs,calc(var(--spacing)*4))] @w-sm/main:[--thread-content-margin:var(--thread-content-margin-sm,calc(var(--spacing)*6))] @w-lg/main:[--thread-content-margin:var(--thread-content-margin-lg,calc(var(--spacing)*16))] px-(--thread-content-margin)"><div class="[--thread-content-max-width:40rem] @w-lg/main:[--thread-content-max-width:48rem] mx-auto max-w-(--thread-content-max-width) flex-1 group/turn-messages focus-visible:outline-hidden relative flex w-full min-w-0 flex-col agent-turn"><div class="flex max-w-full flex-col gap-4 grow"><div class="min-h-8 text-message relative flex w-full flex-col items-end gap-2 text-start break-words whitespace-normal outline-none keyboard-focused:focus-ring [.text-message+&]:mt-1" data-message-author-role="assistant" data-message-id="856db547-f4a1-421d-b4b0-4d449544b15e" data-message-model-slug="gpt-5-5" data-turn-start-message="true" dir="auto" tabindex="0"><div class="flex w-full flex-col gap-1 empty:hidden"><div class="markdown prose dark:prose-invert wrap-break-word w-full light markdown-new-styling">The SnapForm is now available under the **DMR Trading** Workspace.

</div></div></div></div></div></div></section></div></div></div><div id="bkmrk-here-you-can-generat" style="cursor: auto;">![editor_17_5_bdab1b0c-dc45-48f6-87b8-774292195e56_rte_image_566.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_bdab1b0c-dc45-48f6-87b8-774292195e56_rte_image_566.png)   
   
Here you can generate the QR code or URL for the SnapForm.  
</div><div id="bkmrk--12" style="cursor: auto;">  
</div><div id="bkmrk--13" style="cursor: auto; text-align: center;">![editor_17_5_69afee6a-de53-4de4-8f66-0a4103a9d916_rte_image_576.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_69afee6a-de53-4de4-8f66-0a4103a9d916_rte_image_576.png)</div><div id="bkmrk--14" style="cursor: auto; text-align: center;">  
</div><div id="bkmrk-share-this-link-with">Share this URL or QR code with your business partner, in this case your contact at DMR Trading.

Each time the QR code or URL is used, a new Form instance is automatically created in the **DMR Trading** Workspace. DMR Trading will only have access to the submitted Forms, while your organization can manage and review them directly within the BzCtrl. environment.

</div><div id="bkmrk--16"><span>  
</span></div><div id="bkmrk--17" style="cursor: auto;">![editor_17_5_cccb014d-b4ab-47e4-83d3-e63596f36dd7_rte_image_157.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_cccb014d-b4ab-47e4-83d3-e63596f36dd7_rte_image_157.png)</div><div id="bkmrk--18" style="cursor: auto;">  
</div><div id="bkmrk-jason-from-dmr-tradi" style="cursor: auto;">Jason from DMR Trading will see the Form as an External User, without requiring access to the BzCtrl. environment itself.  
</div><div id="bkmrk--19" style="cursor: auto;">  
</div><div id="bkmrk--20" style="cursor: auto;">![editor_17_5_12d0b855-7693-4ed5-afb3-6045140df90d_rte_image_589.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_12d0b855-7693-4ed5-afb3-6045140df90d_rte_image_589.png)</div><div id="bkmrk--21" style="cursor: auto;">   
</div><div id="bkmrk-the-company-can-acce" style="cursor: auto;">The company retains full access to all Forms, allowing it to monitor status and verify completeness and accuracy of the submitted information.  
</div><div id="bkmrk--22" style="cursor: auto;">  
</div><div id="bkmrk--23" style="cursor: auto;">![editor_17_5_ff46b967-8e3a-4cfd-8099-acedde8c5fe4_rte_image_603.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_ff46b967-8e3a-4cfd-8099-acedde8c5fe4_rte_image_603.png)</div><div id="bkmrk--24" style="cursor: auto;">   
</div><div id="bkmrk-that%27s-it%21-all-nicel" style="cursor: auto;">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.

</div><div id="bkmrk--26" style="cursor: auto;">  
</div><div id="bkmrk--27" style="cursor: auto;">![editor_17_5_a7fce336-35b9-4711-9db7-ee13bb618d5f_rte_image_619.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_a7fce336-35b9-4711-9db7-ee13bb618d5f_rte_image_619.png)</div><div id="bkmrk--28" style="cursor: auto;">   
</div><div id="bkmrk-that-way-no-need-to-" style="cursor: auto;">This avoids the need to include full details each time the SnapForm is used; instead, usage can simply be confirmed.  
</div><div id="bkmrk--29" style="cursor: auto;">  
</div><div id="bkmrk--30" style="cursor: auto;">![editor_17_5_abb3ce41-299d-4236-b56a-cf754a43f58a_rte_image_637.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_abb3ce41-299d-4236-b56a-cf754a43f58a_rte_image_637.png)</div><div id="bkmrk--31" style="cursor: auto;">  
  
  
   
  
</div><div id="bkmrk--32" style="cursor: auto;"><span>  
</span></div><div id="bkmrk--33"><span>  
</span></div><div id="bkmrk--34"><span>  
</span></div><div id="bkmrk--35"><span>  
</span></div><div id="bkmrk--36">   
</div><div id="bkmrk--37">   
</div>

# Navigation and Settings

<div>Understanding the general setup and how things are organized within BzCtrl. </div>

# 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.

<div id="bkmrk-">  
</div><div id="bkmrk--1" style="cursor: auto;">![editor_17_5_4b8d2522-74ce-4dbe-b21e-b0694fc082b4_rte_image_18.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_4b8d2522-74ce-4dbe-b21e-b0694fc082b4_rte_image_18.png)</div>####   


#### Domains

- **Purpose:** Domains are used to structure and organize Workspaces. They help you **group** related areas of your business **and control how data is shared.**
- **Hierarchy:** Domains can contain **sub-Domains** and **Workspaces**. If a parent Domain contains multiple sub-Domains, all data from the sub-Domains and their Workspaces is visible at the parent level. This creates a clear hierarchical structure.
- **Role Management:** Domains are also used to assign user roles, controlling who can access and modify data.

#### Workspaces

- **Purpose:** Workspaces are where the actual **To-do’s** are recorded and managed.
- **Relation to Domains:** Each Workspace belongs to a Domain, and data can be shared across Workspaces belonging to the same Domain.

#### Pages

- Located on the **left-hand side** of the interface, Pages display data based on your current selection in the Navigation Tree. Selecting a Domain or Workspace in the tree determines which data is visible.

<div id="bkmrk--4" style="cursor: auto;">![editor_17_5_78255d22-1923-4570-a40e-b26eb74fa02d_rte_image_55.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_78255d22-1923-4570-a40e-b26eb74fa02d_rte_image_55.png)</div><div id="bkmrk--5" style="cursor: auto;">  
</div><div id="bkmrk--6">
</div>#### 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.

# 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.

<div id="bkmrk-">  
</div><div id="bkmrk--1" style="cursor: auto;">![editor_17_5_00f771e0-2e3a-4158-8cdc-c85496a03a42_rte_image_70.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_00f771e0-2e3a-4158-8cdc-c85496a03a42_rte_image_70.png)</div><div id="bkmrk--2">  
</div><div id="bkmrk--3" style="cursor: auto;">  
</div>#### Profile &amp; Calendar Integration

- **Profile Details:** Update your personal information such as name, email, and contact details.
- **Calendar Linking:** Connect BzCtrl. with **Google** or **Outlook** calendars. Once linked, your To-do’s with due dates will appear directly in your calendar. Each item can be accessed via a direct URL from your calendar.

- **Notifications:** Choose which notifications you want to receive.
- **Landing Page:** Set your preferred page to open when you log in.
- **Table Rows:** Adjust the number of rows displayed in tables on Pages.
- **Reminders:** Control the frequency of reminders for tasks.

#### Security

- **Two-Factor Authentication (2FA):** Enable an extra layer of security.
- **Password Policies:** Optionally enforce password resets every 3 months.

#### Theme &amp; Customization

- **Theme Selection:** Choose between **light** or **dark** mode.
- **Colors:** Select your preferred interface colors.
- **Company Branding:** Customize BzCtrl. to match your company’s standards with logos, colors, and other branding elements.

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

# Options and Filters Pane

<div id="bkmrk-description"><span>Description</span>  
</div>

# Internal and External Users

<div id="bkmrk-description"><span>Description</span>  
</div>

# Pages

<div>This Chapter described the features on a Page by Page basis explaining the features the Page offers.</div>

# To do

#### ![](https://bs.bzctrl.com/uploads/images/gallery/2026-03/scaled-1680-/azQembedded-image-aqad2yjt-png.png)

####   


#### <span>Types of To-do’s</span>

<div id="bkmrk--2">  
</div>BzCtrl. supports<span> </span>**four types of To-do’s**:

<div id="bkmrk--3">  
</div>1. **Tasks**<span> </span>– Regular action items.
2. **Incidents**<span> </span>– Issues that need attention or resolution.
3. **Forms**<span> </span>– Structured inputs or reports.
4. **Documents**<span> </span>– File-based tasks or references (entry via Files Page only).

####   


#### Creating a To-do

<div id="bkmrk--5">  
</div>- **Workspace Selected:**  
    When a Workspace is selected in the Navigation Tree (top-right), BzCtrl. knows where to store the To-do. A **Quick Entry** section appears at the top of the page:
    
    
    1. Select the type of To-do.
    2. Enter a title.
    3. Press **Enter**.  
        The To-do is immediately created in the selected Workspace.

<div id="bkmrk--6">  
</div><div id="bkmrk--7">![editor_16_5_3fcc6acb-547e-4f2b-a828-96090f035972_rte_image_219.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_16_5_3fcc6acb-547e-4f2b-a828-96090f035972_rte_image_219.png)</div><div id="bkmrk--8"></div><div id="bkmrk--9">  
</div><div id="bkmrk--10">  
</div>- **Domain Selected:**  
    When a Domain (instead of a Workspace) is selected, the Quick Entry section is not available, because the system cannot determine where to store the To-do.
    
    
    - In this case, create a To-do via the **Plus (+) button** in the top-right corner.
    - Specify the details, including which Workspace the To-do belongs to.

<div id="bkmrk--11">  
</div><div id="bkmrk--12">![editor_16_5_e07e7653-0f86-4396-8ff5-744b4fa79ef6_rte_image_234.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_16_5_e07e7653-0f86-4396-8ff5-744b4fa79ef6_rte_image_234.png)</div><div id="bkmrk--13">  
</div><div id="bkmrk-filters-%26-optionsthe">### Filters &amp; Options

<div>  
</div>The **Filters &amp; 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.

<div>  
</div><div style="cursor: auto;">![editor_311_5_f78afff5-1b72-4349-a7c6-8a31ee74536a_rte_image_249.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_f78afff5-1b72-4349-a7c6-8a31ee74536a_rte_image_249.png)</div>####   


#### Filters

- Apply filters to **narrow down the To-do’s** or data shown on the current Page.
- Filters can be **saved** for future use, so you don’t need to reapply them every time.

####   


#### Options

- **Export to Excel:** Download the currently displayed data in Excel format for reporting or further analysis.
- **Guide Tour:** Launch an on-screen walkthrough where buttons and features are explained, helping new users understand the tool quickly.
- **Save Filter:** Save the current filter settings for quick access later.

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.

</div><div id="bkmrk--16">  
</div><div id="bkmrk-viewsbzctrl.-offers-">#### Views

<div>  
</div>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.

<div>  
</div><div><table class="e-rte-table"><thead><tr><th>**View**</th><th>**Icon / Screenshot**</th><th>**Purpose**</th><th>**Best Use Case**</th></tr></thead><tbody><tr><td>**List View**</td><td class="" style="cursor: auto;">![editor_311_5_eb421e6a-7e20-4cb3-a6f9-a6c112984cb0_rte_image_314.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_eb421e6a-7e20-4cb3-a6f9-a6c112984cb0_rte_image_314.png) </td><td>Shows extensive details and filters</td><td>Data-heavy work requiring full information</td></tr><tr><td class="">**Cards View (Kanban)**</td><td class="" style="cursor: auto;">![editor_311_5_e1368022-620f-4ea0-a076-a1e243517c14_rte_image_322.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_e1368022-620f-4ea0-a076-a1e243517c14_rte_image_322.png) </td><td>Visualizes workflow in columns: To-do / In Progress / Done / Expired</td><td>Team meetings and collaborative task tracking</td></tr><tr><td>**Gantt View**</td><td>\[Insert screenshot/icon\]</td><td>Plots To-do’s on a timeline; highlights status and risks with colors</td><td>Monitoring projects, control plans, or time-sensitive tasks</td></tr><tr><td class="">**Tile View**</td><td class="" style="cursor: auto;">![editor_311_5_4de5818a-a5b9-421a-88b0-fe2b76985218_rte_image_333.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_4de5818a-a5b9-421a-88b0-fe2b76985218_rte_image_333.png) </td><td>Displays To-do’s as Tiles; click to view details alongside overview</td><td>Tasks needing context and relationships between items</td></tr><tr><td>**Calendar View**</td><td class="" style="cursor: auto;">![editor_311_5_a59ee46d-a565-4d02-a3c9-11194d1d914f_rte_image_363.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_311_5_a59ee46d-a565-4d02-a3c9-11194d1d914f_rte_image_363.png)</td><td>Shows To-do’s by Due Date; Week and Month views</td><td>Planning workloads and tracking deadlines</td></tr></tbody></table>

</div><div>  
</div>#### 1. List View

<div>  
</div>- **Purpose:** Provides the most detailed view of your To-do’s.
- **Strength:** Highly effective for seeing extensive details, filters, and statuses.
- **Look &amp; Feel:** Simple and functional, less visually appealing, but very practical for data-heavy work.

####   


#### 2. Cards View (Kanban)

<div>  
</div>- **Purpose:** Visualize your workflow in a **Kanban-style board**.
- **Strength:** Ideal for team meetings—shows **To-do, In Progress, Done, and Expired** at a glance.
- **Use Case:** Tracking task status and collaboration across a team.

####   


#### 3. Gantt View

<div>  
</div>- **Purpose:** Plot To-do’s on a **timeline**, showing deadlines, progress, and risks.
- **Strength:** Advanced coloring system highlights status and risk levels.
- **Use Case:** Perfect for monitoring **control plans, projects, or time-sensitive tasks**.

####   


#### 4. Tile View

<div>  
</div>- **Purpose:** Offers **context-rich, easy-to-read Tiles** for your To-do’s.
- **Strength:** Clicking a Tile shows its details alongside the overview, maintaining context while exploring individual items.
- **Use Case:** Ideal when you want both detail and an overview of relationships between To-do’s.

####   


#### 5. Calendar View

<div>  
</div>- **Purpose:** Display To-do’s by their **Due Date**.
- **Strength:** Offers **Week** and **Month** views for scheduling and planning.
- **Use Case:** Planning workloads or tracking deadlines over time.

<div>  
</div></div><div id="bkmrk--21">  
</div>

# Configure Workspace

<div id="bkmrk-include-description">Include description</div>

# Files

<div id="bkmrk-description">Description</div>

# Organise

<div id="bkmrk-description"><span>Description</span>  
</div>

# Dashboards

<div id="bkmrk-description"><span>Description</span>  
</div>

# Risk Register

<div id="bkmrk-description"><span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">The </span>**Risk Register Page**<span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;"> 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.</span>

### Registering a Risk

Users can create and maintain risks by:

- Defining a **Risk Key** (unique reference)
- Providing a **Title** and **Description** of the risk
- Describing **Mitigating Actions**
- Assigning a **Priority** and **Status**

####   


### Risk Overview (Table View)

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

- Risk Key
- Title
- Description
- Priority
- Status

<div>  
</div><div><span style="color: rgb(255, 0, 0); text-decoration: inherit;">Include image</span></div><div>  
</div>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:

- View and update the **risk description**
- Define and maintain **mitigating actions**
- Link **To-do categories** (Tasks and Incidents) so that related To-do’s are automatically associated with the risk
- Connect relevant **assets** within BzCtrl., such as: 
    - HandBookR’s
    - Canvases
    - Forms

<div>  
</div><div><span style="color: rgb(255, 0, 0); text-decoration: inherit;"><span>Include image</span></span>  
</div><div>  
</div>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.

- The Risk Matrix visualizes risks in a **graph based on Impact and Likelihood**.
- Each risk is plotted according to its assessed impact and the likelihood derived from related Incidents and Forms.
- This view helps users quickly identify **high-risk areas** and prioritize mitigating actions.

<div><span style="color: rgb(255, 0, 0); text-decoration: inherit;">  
</span></div><div><span style="color: rgb(255, 0, 0); text-decoration: inherit;"><span>Include image</span></span></div>#### Risk Matrix score calculation

<div>The calculation of the scores is based on all To do's (i.e. Incidents and Forms) associated with the specific Risk.</div><div>  
</div><div>![editor_17_5_2259fd5e-e58d-45f1-a4c9-8d689c879702_rte_image_45.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_2259fd5e-e58d-45f1-a4c9-8d689c879702_rte_image_45.png)</div><div><span style="color: rgb(255, 0, 0); text-decoration: inherit;"><span>  
</span></span>  
</div></div>

# HandBookR

<div id="bkmrk-description">**HandBookR**<span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;"> 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.</span>

#### Structured Documentation

HandBookR organizes information in a logical, hierarchical structure:

- **Books** – High-level topics or areas
- **Chapters** – Subsections within a Book
- **Pages** – Individual content items

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

#### Content Creation &amp; Editing

- Create and edit content using a **user-friendly editor**
- Apply **rich text formatting**, including images, links, and structured layouts
- Maintain documentation collaboratively with other users

#### Search &amp; Navigation

- Quickly find information using **search functionality**
- Navigate easily through Books, Chapters, and Pages
- Link content across pages for better context and connectivity

#### Version Control

- Automatic **tracking of content changes**
- View and restore **previous versions**
- Maintain full visibility over updates

#### Diagrams &amp; Process Flows

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

- Create visual representations such as **flowcharts, process diagrams, and system overviews**
- Use drag-and-drop elements, shapes, and connectors to build clear visual structures
- Diagrams can be edited directly within HandBookR

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

- Manage who can **view, create, or edit** content
- Align permissions with roles defined in BzCtrl.

#### Integration within BzCtrl.

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

- Risks (as part of mitigating actions)
- To-do’s (Tasks, Incidents, Forms, Documents)

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

  
</div>

# Canvas

<div id="bkmrk-description">**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.

<div>  
</div>#### Core Functionality

Canvas provides a flexible diagramming workspace where users can:

- Create **process flows, flowcharts, and diagrams**
- Drag and drop **shapes, connectors, and elements** onto a visual workspace
- Connect elements to represent **relationships, sequences, and dependencies**
- Structure complex processes in a **clear, visual format**
- Edit diagrams directly within the tool with instant updates

####   


#### Typical Use Cases

Canvas is commonly used for:

- Process mapping (end-to-end workflows)
- Control frameworks and compliance flows
- Organizational structures
- System and data flow diagrams
- Visual explanations of procedures or risks

####   


#### Key Features

- **Drag-and-drop editor:** Easily build diagrams without technical skills
- **Predefined shapes:** Standard flowchart and diagram elements available
- **Connectors:** Link elements to show logic, flow, or dependencies
- **Layering and grouping:** Structure complex diagrams clearly
- **Scalability:** From simple flows to highly detailed process maps
- **Export &amp; reuse:** Diagrams can be reused in documentation or shared across BzCtrl.

<div>  
</div><div>#### 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.

</div></div>

# Forms

<div id="bkmrk-description"><span>Description</span>  
</div>

# Customisations

<div>An overview of customisations currently implemented</div>

# VAT reporting

<div id="bkmrk-description"><span>Description</span>  
</div>

# Incidents interface

<div id="bkmrk-description"><span>Description</span>  
</div>

# Belgian excise reporting

<div id="bkmrk-description"><span>Description</span>  
</div>

# Taric Service

<div id="bkmrk-description"><span>Description</span>  
</div>

# Features in BzCtrl.

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

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

<span>Additional information and feature updates can also be found on the official website:<span> </span></span><span>[BzCtrl.](https://www.bzctrl.com/?utm_source=chatgpt.com)</span>

</div></div>

# External System Integration - ApiForms

<div id="bkmrk-bzctrl.-provides-the">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:

- Predefined Form reference (via API Endpoint)
- Tags and identifiers (for example an Order Number, Shipment Number, or Case ID).

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

<div>**Step 1** - From the Forms Page the User can create an ApiForm via the Action Button for a specific Form;</div><div>  
</div><div>![editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png)</div><div></div><div>  
</div><div>**Step 2** - Select the Workspace where the Form Instances should be created and stored;</div><div>   
</div><div>   
</div><div>![editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png)</div><div></div><div>  
**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.</div><div>  
</div><div>![editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png)</div><div></div><div>  
</div>### Input to Developers External system

<div>**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)**  
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>https://acc.bzctrl.com/bzctrl-core-api/oauth/token</span></span></span>

**Production Environment (PROD)**  
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>https://bzctrl.com/bzctrl-core-api/oauth/token</span></span></span>

**Request Method**

<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>POST</span></span></span>

**Request Body (x-www-form-urlencoded)**

<div>```
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>grant_type=password</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>username=example@example.com</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>password=Ex@mpl3!</span></span></span></span>
```

</div><div style="margin-left: 20px;">  
</div>**Sample Response**

<div>```
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>{</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "access_token": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>,</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "refresh_token": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>,</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "token_type": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼk">"Bearer"</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>,</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "expires_in": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼj">3600</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>,</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "scope": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼk">"*"</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>,</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>  "jti": </span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><br></br></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span>}</span></span></span></span>
```

</div><div style="margin-left: 20px;">  
</div>**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 <span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>expires\_in</span></span></span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> </span>field.

</div><div><div>  
</div><div>**Step 2 - Api Form Key**</div></div><div>  
</div><div>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.</div><div>   
</div><div style="cursor: auto;">![editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png)</div><div style="text-align: inherit;">   
<span style="background-color: unset; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; font-size: 1em; letter-spacing: 0.0178571em; text-align: inherit;">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. </span></div><div>  
</div><div>   
  
</div><div>  
</div></div>

# External System Integration - Incidents & Tasks

<div id="bkmrk-external-system-inte"><span>BzCtrl. provides a feature that allows external systems to create<span> </span></span>**Incidents**<span><span> </span>and<span> </span></span>**Tasks**<span><span> </span>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.</span>

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.

<div>####   


#### Integration Flow

The integration process consists of the following steps:

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

</div><div><div>  
</div>**Step 1 - Authentication**

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

**Endpoints**

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

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

**Request Method**

<span><span><span>POST</span></span></span>

**Request Body (x-www-form-urlencoded)**

<div>```
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>grant_type=password</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>username=example@example.com</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>password=Ex@mpl3!</span></span></span></span></span></span>
```

</div><div style="margin-left: 20px;">  
</div>**Sample Response**

<div>```
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>{</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "access_token": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "refresh_token": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "token_type": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼk">"Bearer"</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "expires_in": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼj">3600</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "scope": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼk">"*"</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>  "jti": </span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span></span><span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span><span><span><span>}</span></span></span></span></span></span>
```

</div><div style="margin-left: 20px;">  
</div>**Result**

Upon successful authentication, BzCtrl. returns an<span> </span>**access token**<span> </span>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<span> </span><span><span><span>expires\_in</span></span></span><span><span> </span></span>field.

<div>  
</div></div>**Step 2 - Create Incident (or Task)**

<div style="text-align: inherit;"><span style="background-color: unset; font-size: 1em; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;">After receiving the access token from the OAuth API, use the Add Task API to create a new Task or Incident.</span></div><div>  
</div><div style="margin-left: 20px;">**EndPoint**</div><div><div><span style="background-color: rgb(242, 242, 242);">  
</span></div><span style="background-color: rgb(242, 242, 242);">ACC: </span><span style="background-color: rgb(242, 242, 242);">[https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-task ](https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-task "https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-task")</span>

<span style="background-color: rgb(242, 242, 242);">PROD: </span><span style="background-color: rgb(242, 242, 242);">[https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-task](https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-task "https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-task")</span>

<div>  
</div></div><p class="callout info callout info">*****Note: The access token received from the OAuth Token API must be included in the Authorization header using the Bearer scheme.*****</p>

<span style="font-size: 10pt;"><span>Request Method<span style="background-color: transparent;">: </span></span></span><span style="background-color: rgb(242, 242, 242); font-size: 10pt; font-weight: 400; text-align: inherit; font-family: Roboto, "Segoe UI", GeezaPro, "DejaVu Serif", "sans-serif", -apple-system, BlinkMacSystemFont; letter-spacing: 0.0178571em;"><span style="color: rgb(68, 114, 196); text-decoration: inherit; font-size: 10pt;">POST</span></span>

 <span style="font-size: 10pt;"><span>Required Headers</span></span>

 <span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">Content-Type: application/json</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> Authorization: Bearer {access\_token}</span></span>

 <span style="font-size: 10pt;"><span>Sample Request Body</span></span>

 <span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">{</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "todoType":"INCIDENT",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "domainWorkSpace":"EXA-CON-BUS-WOR",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "title":"</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>Potential Customs claim</span></span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "description":"</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>Operation started without proper approvals</span></span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "financialImpact":"123577",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "impact":"HIGH",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "likelihood":"MEDIUM",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "status":"IN PROGRESS",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "priority":"HIGH",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "assignee":"Example@example.com",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "reporter":"Example@example.com",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "category":\["Customs"\],</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "subCategory":\["IT"\],</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "lrn":"725462",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "orderID":"ORDER 777",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "reminderDate":"2024-09-27"</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> }</span></span>

 <span style="font-size: 10pt;"><span>Sample Response</span></span>

 <span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">{</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "title":"Potential Customs claim",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "taskType":"INCIDENT",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "description":"Operation started without proper approvals",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "taskLink":"https://www.bzctrl.com/app/#/todo/</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"><span>EXA-CON-BUS-WOR</span></span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">-03",</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> "tags":\["ORDER 777"\]</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;">  
</span><span style="color: rgb(68, 114, 196); text-decoration: inherit;"> }</span></span>

<div style="margin-left: 20px;">**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") ).** </div><div style="margin-left: 20px;"><span>From a UI/UX perspective the following should be considered (</span>* Mandatory, *Italic -* User input, CAPITOL - System generated Values)</div><div style="margin-left: 20px;">  
</div><div style="margin-left: 20px;"><table border="0" cellpadding="0" cellspacing="0" class="e-rte-table-border e-rte-table" width="1137"><tbody><tr height="21"><td class="" height="21" width="125">**Todo Type**</td><td class="" width="124">**Fields**</td><td class="" width="235">**Input**</td><td class="" width="653">**Comments**</td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">todoType\*</td><td class="">INCIDENT</td><td class="" width="653"><span>**Customer**<span> </span>-<span> </span></span><span>option to change to Task</span><span><span> </span>(or in case only used for Incidents default value)</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">domain\*</td><td class=""><span>EXA-CON-BUS-WOR</span></td><td class="" width="653">Default value to include by<span> </span><span>**Customer**,</span><span><span> </span>relates to the Domain</span></td></tr><tr height="43"><td class="" height="43">incident, task</td><td class="">workspace\*</td><td class=""><span>WOR</span></td><td class="" width="653">Default value to include by<span> </span>**Customer**, relates to the Workspace under the Domain</td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">title\*</td><td class="">*Free text field*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to provide Title/Subject</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">description\*</td><td class="">*Free text field*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to provide Description</span></td></tr><tr height="21"><td class="" height="21">task</td><td class="">result</td><td class="">*Free text field*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to provide Results</span><span><span> <span> </span></span>(optional)</span></td></tr><tr height="43"><td class="" height="43">incident</td><td class="">financialImpact</td><td class="">*Numbers field*</td><td class="" width="653"><span>**Customer**<span> </span></span><span>- For User<span> <span> </span></span>it should be clear this is a EUR amount. Only Number is provided.<span> </span></span><span>BzCtrl</span><span>. - This should be included in the Field "Potential financial impact of the incident" set as EUR.</span></td></tr><tr height="21"><td class="" height="21">incident</td><td class="">impact</td><td class="">*High, Medium, Low*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to select out of these three options (optional)</span></td></tr><tr height="21"><td class="" height="21">incident</td><td class="">likelihood</td><td class="">*High, Medium, Low*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to select out of these three options (optional)</span></td></tr><tr height="43"><td class="" height="43">incident, task</td><td class="">status\*</td><td class="">*In Progress*</td><td class="" width="653">Options BzCtrl. are To do, In Progress, Done and Expired.<span> </span>**Customer**<span><span> </span>- default when sending on In Progress, with option to change by User to Done.<span> </span></span><span>BzCrtrl</span><span>. - If status - Done, set due date to date transaction.</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">priority</td><td class="">*High, Medium, Low*</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>allow user to select out of these three options (optional)</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">assignee\*</td><td class="">[User@example.com](mailto:User@impala.com)</td><td class="" width="653"><span>**Customer**,</span><span><span> </span>Same as Reporter. E-mail address of the User.</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">reporter\*</td><td class="">[User@example.com](mailto:User@impala.com)</td><td class="" width="653"><span>**Customer**,<span> </span></span><span>E-mail address of the User.</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">category</td><td class=""> </td><td class="" width="653">n/a</td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">orderID\*</td><td class="">ServiceOrder Number</td><td class="" width="653"><span>**Customer**<span> </span></span><span>-<span> </span></span><span>BzCrtrl.</span><span><span> </span>- Set as Tag</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">LRN</td><td class="">LRN</td><td class="" width="653">**Customer**<span><span> </span>-<span> </span></span><span>BzCrtrl.</span><span><span> </span>- Set as Tag (if available handy reference)</span></td></tr><tr height="21"><td class="" height="21">incident, task</td><td class="">reminderDate</td><td class="">Calendar selection</td><td class="" width="653">n/a</td></tr></tbody></table>

</div></div><div id="bkmrk--1">  
</div>

# ApiForm instruction - VTTI specific

<div id="bkmrk-bzctrl.-provides-the">BzCtrl. provides the ability to call predefined Forms through API communication using the<span> </span>**ApiForms**<span> </span>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:

- Predefined Form reference (via API Endpoint)
- Tags and identifiers (for example an Order Number, Shipment Number, or Case ID).

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

<div>**Step 1**<span> </span>- From the Forms Page the User can create an ApiForm via the Action Button for a specific Form;</div><div>  
</div><div>![editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_00acf516-37ef-4f65-98ff-3e1591224e49_rte_image_358.png)</div><div>  
</div><div>**Step 2**<span> </span>- Select the Workspace where the Form Instances should be created and stored;</div><div>  
</div><div>  
</div><div>![editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_29047aa9-ed3e-416b-8369-964c69a784a2_rte_image_362.png)</div><div>  
**Step 3**<span> </span>- 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.</div><div>  
</div><div>![editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_3a0f34f8-f304-4354-a93d-a666fbac5e6b_rte_image_368.png)</div><div>  
</div>### Input to Developers External system

<div>**Step 1 - Authentication**

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

**Endpoints**

**Acceptance Environment (ACC)**  
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span>https://acc.bzctrl.com/bzctrl-core-api/oauth/token</span></span></span></span></span>

**Production Environment (PROD)**  
<span style="background-color: rgb(242, 242, 242);"><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span>https://bzctrl.com/bzctrl-core-api/oauth/token</span></span></span></span></span>

**Request Method**

<span><span><span>POST</span></span></span>

**Request Body (x-www-form-urlencoded)**

<div>```
<span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>grant_type=password</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>username=<span>cms@api.com</span></span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>password=Nologicincustoms#24</span></span></span></span></span>
```

</div><div>  
</div>**Sample Response**

<div>```
<span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>{</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "access_token": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "refresh_token": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "token_type": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼk">"Bearer"</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "expires_in": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼj">3600</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "scope": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼk">"*"</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>,</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>  "jti": </span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span class="ͼk">"xxxxxxxxxx"</span></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><br></br></span></span></span></span><span style="color: rgb(47, 84, 150); text-decoration: inherit;"><span><span><span><span>}</span></span></span></span></span>
```

</div><div>  
</div>**Result**

Upon successful authentication, BzCtrl. returns an<span> </span>**access token**<span> </span>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<span> </span><span><span><span>expires\_in</span></span></span><span><span> </span></span>field.

</div><div><div>  
</div><div>**Step 2<span> </span>- Api Form Key**</div></div><div>  
</div><div>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.</div><div>  
</div><div style="margin-left: 20px;">  
</div><div style="margin-left: 20px;">**ApiForm Key - Acceptance Environment (ACC)**  
</div><div style="margin-left: 20px;"><span style="background-color: rgb(242, 242, 242);">[<span style="color: rgb(47, 84, 150); text-decoration: inherit;">https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjUwMywiY29tcGFueUlkIjozMzEsImNvbnRyb2xJZCI6MTQxNSwiZW5jb2RlVXJsIjoiZDMzOGExNmYtZGIzMS00OTQzLTliMzUtMzQ4YmYzMzc1ZTE1IiwiY3JlYXRvcklkIjo2NjMsIndvcmtTcGFjZU5hbWUiOiJDdXN0b21zIiwicmVwb3J0ZXJVc2VySWQiOjY2MywicmVwb3J0ZXJVc2VyTmFtZSI6IlJlbXkgR2VlcnRzIn0=</span>](https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjUwMywiY29tcGFueUlkIjozMzEsImNvbnRyb2xJZCI6MTQxNSwiZW5jb2RlVXJsIjoiZDMzOGExNmYtZGIzMS00OTQzLTliMzUtMzQ4YmYzMzc1ZTE1IiwiY3JlYXRvcklkIjo2NjMsIndvcmtTcGFjZU5hbWUiOiJDdXN0b21zIiwicmVwb3J0ZXJVc2VySWQiOjY2MywicmVwb3J0ZXJVc2VyTmFtZSI6IlJlbXkgR2VlcnRzIn0= "https://acc.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjUwMywiY29tcGFueUlkIjozMzEsImNvbnRyb2xJZCI6MTQxNSwiZW5jb2RlVXJsIjoiZDMzOGExNmYtZGIzMS00OTQzLTliMzUtMzQ4YmYzMzc1ZTE1IiwiY3JlYXRvcklkIjo2NjMsIndvcmtTcGFjZU5hbWUiOiJDdXN0b21zIiwicmVwb3J0ZXJVc2VySWQiOjY2MywicmVwb3J0ZXJVc2VyTmFtZSI6IlJlbXkgR2VlcnRzIn0=")</span></div><div style="margin-left: 20px;"><span style="background-color: rgb(242, 242, 242);">  
 </span>****ApiForm Key -<span> </span>**Production Environment (PROD)**  
</div><div style="margin-left: 20px;"><span style="background-color: rgb(242, 242, 242);">[<span style="color: rgb(47, 84, 150); text-decoration: inherit;">https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjI4MywiY29tcGFueUlkIjoxOTksImNvbnRyb2xJZCI6MTQ1NSwiZW5jb2RlVXJsIjoiNWJhM2QxMGYtNTgzMy00N2VjLWE5NzktMDk5NTM5MTNjNTM3IiwiY3JlYXRvcklkIjoxMywid29ya1NwYWNlTmFtZSI6IkN1c3RvbXMiLCJyZXBvcnRlclVzZXJJZCI6MTMsInJlcG9ydGVyVXNlck5hbWUiOiJSZW15IEdlZXJ0cyJ9</span> ](https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjI4MywiY29tcGFueUlkIjoxOTksImNvbnRyb2xJZCI6MTQ1NSwiZW5jb2RlVXJsIjoiNWJhM2QxMGYtNTgzMy00N2VjLWE5NzktMDk5NTM5MTNjNTM3IiwiY3JlYXRvcklkIjoxMywid29ya1NwYWNlTmFtZSI6IkN1c3RvbXMiLCJyZXBvcnRlclVzZXJJZCI6MTMsInJlcG9ydGVyVXNlck5hbWUiOiJSZW15IEdlZXJ0cyJ9 "https://www.bzctrl.com/bzctrl-core-api/api/v1/task/add-exposed-task/eyJwcm9qZWN0SWQiOjI4MywiY29tcGFueUlkIjoxOTksImNvbnRyb2xJZCI6MTQ1NSwiZW5jb2RlVXJsIjoiNWJhM2QxMGYtNTgzMy00N2VjLWE5NzktMDk5NTM5MTNjNTM3IiwiY3JlYXRvcklkIjoxMywid29ya1NwYWNlTmFtZSI6IkN1c3RvbXMiLCJyZXBvcnRlclVzZXJJZCI6MTMsInJlcG9ydGVyVXNlck5hbWUiOiJSZW15IEdlZXJ0cyJ9")</span><span style="background-color: rgb(242, 242, 242);"> </span>  
</div><div>  
</div><div>  
</div><div>![editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png](https://www.bzctrl.com/bzctrl-core-api/api/v1/download/editor_17_5_e0e245de-7fca-47e8-8aaf-f2ddf6eb5184_rte_image_81.png)</div><div>  
<span>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. </span></div><div>  
</div><div>  
  
</div><div>  
</div></div>