Skip to content

Commit 246807d

Browse files
authored
7.0.x doc updates (#80)
* Update docusaurus.config.js * Update docusaurus.config.js * Update pages.yml * Update Forms.md * ng broken links * Fixing broken file content * Fix broken links * Fixig more broken links * 7.0.x updates * fixed tag issues * 7.0.x changes
1 parent d1bcf10 commit 246807d

31 files changed

+485
-206
lines changed

new-doc/versioned_docs/version-7.0.0/Features/BPMN Email.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,29 @@ slug: /email-connector
99

1010
### Send an Email from a Flow
1111

12-
The following steps explain how to configure and use the email connector (via `mail-send`) in a BPMN flow.
12+
The following steps explain how to configure and use the email connector (via `mail-send` connector) in a BPMN flow.
1313

1414
1. #### Flow
15-
Launch your BPMN Modeler and open the flow where you want to send an email. Insert or select a **Service Task** in the workflow where the email should be sent.
15+
Launch your BPMN Modeler and open the flow where you want to send an email. Insert or select a `Service Task` in the flow where the email should be sent.
1616

1717
2. #### Set the Service Task to Use a Connector
1818
Select the Service Task and open the Properties/Details panel. Under **Implementation**:
1919
- Choose **Type** as `Connector`.
2020
- Set the **Connector ID** to `mail-send` (or your engine-specific ID).
21+
22+
Select the `Service Task` and open the `Properties panel` :
23+
- Goto `Implementation > Type` and set the value to `Connector`
24+
- Set `Connector Id` as `mail-send`
2125

2226
*Reference Screenshot:*
2327

2428
![Image](/img/7.0.0/bpm/email.png)
2529

2630
3. #### Configure Connector Inputs
27-
Under **Connector inputs**, define parameters for the email connector. Common inputs include **to**, **subject**, and **html** or **text**. You can also configure additional parameters like **cc**, **bcc**, **attachments**, and so on.
31+
Under `Connector inputs`, define parameters for the email connector. Common inputs include `to`, `subject`, and `html` or `text`. You can also configure additional parameters like `cc`, `bcc`, `attachments`, and so on.
2832

2933
4. #### Save and Deploy
30-
When all required inputs are set, ensure your BPMN model shows **0 Errors, 0 Warnings**. Save and deploy the process to your BPM engine.
34+
When all required inputs are set, ensure your BPMN model shows **0 Errors, 0 Warnings**, save and publish.
3135

3236
5. #### Test the Flow
3337
Run the process. When the flow reaches the **Send Email** Service Task, the engine will invoke the `mail-send` connector with your specified parameters. Verify the recipient’s inbox to confirm success.

new-doc/versioned_docs/version-7.0.0/Features/BPMN Listeners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ slug: /bpmn-listeners
1111

1212
Listeners provide a powerful mechanism to execute external Java code or evaluate expressions in response to specific events during process execution. They are frequently used during process development to implement custom behavior at key stages of the process.
1313

14-
Depending on their configuration, listeners can be triggered at various points, such as the start or end of an activity, gateway, process instance, or specific events. This flexibility makes them a versatile tool for extending and customizing process logic.
14+
Depending on their configuration, listeners can be triggered at various points, such as the `start` or `end` of an _activity, gateway, process instance, or specific events_. This flexibility makes them a versatile tool for extending and customizing process logic.
1515

1616
## Predefined Listeners
1717

new-doc/versioned_docs/version-7.0.0/Features/BPMN Variables.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: /variables
77

88
---
99

10-
BPMN variables are the form fields added to the layout. These fields, if selected, are passed to BPMN during form submission, allowing BPMN to access their values. The selected variables will also be available to be displayed in the task list under Review > Tasks.
10+
Flow variables are the form fields added to the flow. These fields, if selected, are passed to flow during form submission, allowing flow to access their values. The selected variables will also be available to be displayed in the task list under `Review > Tasks`.
1111

1212
1. Create a new form or Edit an already created form
1313

@@ -29,4 +29,6 @@ BPMN variables are the form fields added to the layout. These fields, if selecte
2929

3030
![Image](/img/7.0.0/Screenshot-2024-11-26-165614.png)
3131

32-
5. Once the form is submitted you will have access to the variables you have selected in the previous step in the Review > Tasks. You can click on "Create New Filter" button at the top, or edit a filter that has been created before. In the side popup you can click on "Task attributes" and select which varibles to show.
32+
5. Once the form is submitted you will have access to the variables you have selected in the previous step in the Review > Tasks. You can click on "Create New Filter" button at the top, or edit a filter that has been created before. In the side popup you can click on "Task attributes" and select which varibles to show.
33+
`
34+
5. After the form is submitted, the selected variables from the previous step become available under `Review > Tasks`. You can either click `Create New Filter` at the top or edit an existing filter. In the side panel that appears, click `Task attributes` and choose which variables you want to display.

new-doc/versioned_docs/version-7.0.0/Features/Custom Theme.md

Lines changed: 69 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,81 @@ slug: /theme
77

88
---
99

10-
### Introduction
10+
## Introduction
1111

12-
This guide explains how to customize themes in your application by modifying various CSS variables. These changes allow you to adjust the visual appearance of navigation menus, buttons, headers, fonts, and more, creating a tailored experience for your users.
12+
This page describes how to customize the application’s visual theme by updating CSS variables. You can modify the appearance of navigation menus, buttons, headers, fonts, and other interface elements to align with your organization's design standards.
1313

14-
### Customizable CSS Variables
14+
## Customizable CSS Variables
1515

1616
The following table outlines the available CSS variables and their effects:
1717

18+
### Navbar
19+
20+
| Variable | Default Value | Effect |
21+
|----------|---------------|--------|
22+
| `--navbar-bg-color` | #013366 | Changes the background color of the navbar and header. |
23+
| `--navbar-active-submenu-bg-color` | #1E5189 | Changes the background color of the submenu in the navbar when clicked. |
24+
| `--navbar-active-submenu-font-color` | white | Changes the font color of the submenu in the navbar when clicked. |
25+
| `--navbar-active-submenu-font-weight` | 500 | No description provided. |
26+
| `--navbar-active-submenu-font-size` | 1rem | No description provided. |
27+
| `--navbar-main-menu-active-bg-color` | #1E5198 | Changes the background color of the main menu in the navbar when clicked. |
28+
| `--navbar-main-menu-active-font-color` | #FFFFFF | Changes the font color of the main menu in the navbar and other header elements. |
29+
| `--navbar-menu-hover-bg-color` | #1E5198 | Changes the background color of the main menu and submenu in the navbar when hovered. |
30+
| `--navbar-hover-submenu-bg-color` | #1E5198 | No description provided. |
31+
| `--navbar-hover-submenu-font-color` | white | No description provided. |
32+
| `--navbar-hover-submenu-font-weight` | 500 | No description provided. |
33+
| `--navbar-hover-submenu-font-size` | 1rem | No description provided. |
34+
35+
---
36+
37+
### Buttons
38+
39+
| Variable | Default Value | Effect |
40+
|----------|---------------|--------|
41+
| `--primary-btn-font-color` | white | Changes the font color of primary buttons, such as "Submit," "Create New Role," etc. |
42+
| `--primary-btn-bg-color` | #013366 | Changes the background color of primary buttons. |
43+
| `--primary-btn-hover-bg-color` | #1E5189 | Changes the background color of primary buttons when hovered. |
44+
| `--secondary-btn-font-color` | #474543 | Changes the font color of secondary buttons, such as "Edit," "History," and "Undo." |
45+
| `--secondary-btn-bg-color` | #FFFFFF | Changes the background color of secondary buttons. |
46+
| `--secondary-btn-hover-bg-color` | #EDEBE9 | Changes the background color of secondary buttons when hovered. |
47+
| `--link-btn-border-radius` | 4px | No description provided. |
48+
| `--sm-btn-border-radius` | 4px | No description provided. |
49+
| `--md-btn-border-radius` | 4px | No description provided. |
50+
| `--lg-btn-border-radius` | 6px | No description provided. |
51+
52+
---
53+
54+
### Typography & Fonts
55+
1856
| Variable | Default Value | Effect |
1957
|----------|---------------|--------|
20-
| `--custom-logo-path` | | Fully qualified logo URL to replace the app logo. |
21-
| `--navbar-active-submenu-bg-color` | #145a32 | Changes the background color of the submenu in the navbar when clicked. |
22-
| `--navbar-active-submenu-font-color` | #ba4a00 | Changes the font color of the submenu in the navbar when clicked. |
23-
| `--navbar-menu-hover-bg-color` | #bb8fce | Changes the background color of the main menu and submenu in the navbar when hovered. |
24-
| `--navbar-main-menu-active-bg-color` | #fad7a0 | Changes the background color of the main menu in the navbar when clicked. |
25-
| `--navbar-main-menu-active-font-color` | #641e16 | Changes the font color of the main menu in the navbar and other header elements. |
26-
| `--navbar-bg-color` | #b7950b | Changes the background color of the navbar and header. |
27-
| `--custom-title` | "SampleWebsite.in" | Updates the header title. |
28-
| `--primary-btn-font-color` | #e59866 | Changes the font color of primary buttons, such as "Submit," "Create New Role," etc. |
29-
| `--primary-btn-bg-color` | #0b5345 | Changes the background color of primary buttons. |
30-
| `--primary-btn-hover-bg-color` | #a9dfbf | Changes the background color of primary buttons when hovered. |
31-
| `--secondary-btn-font-color` | #d6dbdf | Changes the font color of secondary buttons, such as "Edit," "History," and "Undo." |
32-
| `--secondary-btn-bg-color` | #5d6d7e | Changes the background color of secondary buttons. |
33-
| `--secondary-btn-hover-bg-color` | #aeb6bf | Changes the background color of secondary buttons when hovered. |
34-
| `--default-font-color` | #7d3c98 | Changes the default font color for various components, including forms, task headings, and metrics. |
35-
| `--default-font-size` | 2rem | Sets the default font size for elements like navbar submenus and button labels. |
36-
| `--ff-primary` | #c32047 | Sets the primary theme color for borders, active tabs, and other key elements. |
37-
| `--ff-secondary` | #cae85a | Sets the secondary theme color for additional highlights and accents. |
38-
39-
### Applying the Theme
40-
41-
1. Identify the CSS variables you want to customize based on the table above.
42-
2. Update the values in your theme JSON.
43-
3. Host the JSON file to file storage and configure the deployment to use this theme file.
58+
| `--default-font-color` | #2D2D2D | Changes the default font color for various components, including forms, task headings, and metrics. |
59+
| `--default-font-size` | 1rem | Sets the default font size for elements like navbar submenus and button labels. |
60+
| `--default-font-family` | BC Sans, sans-serif | No description provided. |
61+
| `--default-font-family-url` | https://raw.githubusercontent.com/bcgov/bc-sans/refs/heads/master/css/BC_Sans.css?family=BC+Sans | No description provided. |
62+
| `--default-link-color` | #255A90 | No description provided. |
63+
64+
---
65+
66+
### Branding & General
67+
68+
| Variable | Default Value | Effect |
69+
|----------|---------------|--------|
70+
| `--custom-logo-path` | https://raw.githubusercontent.com/jimin-aot/mcfd-reporting-assets/main/images/BC_CFD_H_RGB_rev.png | Fully qualified logo URL to replace the app logo. |
71+
| `--custom-logo-horizontal-align` | left | No description provided. |
72+
| `--custom-logo-height` | 3rem | No description provided. |
73+
| `--custom-title` | MCFD Reporting | Updates the header title. |
74+
| `--ff-primary` | #013366 | Sets the primary theme color for borders, active tabs, and other key elements. |
75+
| `--ff-secondary` | #EDEBE9 | Sets the secondary theme color for additional highlights and accents. |
76+
| `--hide-formsflow-logo` | true | No description provided. |
77+
| `--default-danger-color` | #CE3E39 | No description provided. |
78+
79+
80+
## Applying the Theme
81+
82+
1. Review the table above and identify the CSS variables you want to customize.
83+
1. Define your custom values in a JSON theme file.
84+
2. Upload the JSON file to a publicly accessible location.
85+
3. Update your deployment configuration to reference this file by setting the `CUSTOM_THEME_URL` environment variable in the `forms-flow-web` service.
4486

4587
**Tip**: _Test your changes in different browsers and screen sizes to ensure consistency across the application._

new-doc/versioned_docs/version-7.0.0/Features/Forms-anonymous.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,26 @@ slug: /anonymous-form
77

88
---
99

10-
An anonymous form allows users to submit form entries anonymously. Users can access the form using the form URL without login to the application.
10+
Anonymous (public) forms allow users to submit entries without logging into the application. These forms can be accessed directly through a shared URL.
1111

12-
Below steps describes how you can design a form anonymous.
12+
Follow the steps below to enable anonymous submission for a form:
1313

14-
1. Create a new form or edit an already created form under Design > Forms.
14+
## Steps to Enable Anonymous Access
1515

16-
2. After you are satified with the layout and the flow, click on the **Settings** button in the top bar.
16+
1. Create a new form or edit an existing one by navigating to `Design > Forms`.
1717

18-
3. In the Settings popup scroll down to **Who Can Create Submissions**.
18+
2. After finalizing the form layout and flow, click the **Settings** button in the top bar.
19+
20+
3. In the Settings popup, scroll down to the **Who Can Create Submissions** section.
1921

2022
![Image](/img/7.0.0/Screenshot-2024-11-25-170245.png)
2123

22-
4. Check or make sure **Anonymous users** checkbox is selected
24+
4. Ensure the **Anonymous users** checkbox is selected.
2325

24-
**Do not forget to click "Save Changes"**
26+
> **Important**: Click **Save Changes** to apply the setting.
2527
26-
**Note**: _Forms will not be available to anonymous users if they are not published._
28+
> **Note**: The form must be published for anonymous users to access it.
2729
28-
5. Then you can share the URL to allow other users to submit anonymous forms by scrolling down and copying the form's **URL Path**
30+
5. To share the form, scroll down and copy the **URL Path**. Share this link with users to allow anonymous submissions.
2931

3032
![Image](/img/7.0.0/Screenshot-2024-11-25-170535.png)

new-doc/versioned_docs/version-7.0.0/Features/Forms-custom-components.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,49 @@ slug: /custome-components
77

88
---
99

10-
One of the more powerful features of the formsflow.ai platform is the ability to create your own custom form components. The process of creating a custom component involves extending a base class of the component that is "closest" to the implementation you desire, and then override methods or introduce new methods that will implement your custom logic. All of the existing components within the platform also use this same method, so you can see the multitude of examples by inspecting how the base components for the Forms-flow renderer are implemented.
10+
One of the powerful features of the formsflow.ai platform is the ability to create custom form components. This is done by extending a base component class that closely matches the functionality you want to build. You can override existing methods or introduce new ones to implement your specific logic.
1111

12-
In order to create the best components, it is important to understand the critical methods used to define a new component. They are as follows.
12+
All default components in the platform are implemented this way, so you can refer to them as examples by reviewing the source code of the Formsflow renderer.
1313

1414
## Extending Components
1515

16-
Every custom component will derive from a base class, whose behaviour is closest to the behaviour of the component you wish to create. It is possible to extend any other component within the Form.io renderer and a list of all of these components and their classes can be found [here](https://github.com/formio/formio.js/tree/master/src/components).
16+
Every custom component must inherit from a base class that aligns closely with the behavior and data model of your intended component. You can extend any existing component available in the [Form.io renderer](https://github.com/formio/formio.js/tree/master/src/components).
1717

18-
Because of this, the first task in building a custom component is to determine which component most closely resembles the behaviour and data model of the component you are looking to achieve. For example, if you wish to build a multi-button select component, it may be best to start with a radio component since this is the component that most closely resembles the behaviour of the component you wish to create.
18+
### Choosing a Base Component
1919

20-
If you are unsure, then it is also fine to derive from the "core" components which serve as the base for all other components within the renderer. These core components are as follows.
20+
Start by identifying which existing component most closely matches the functionality you want. For example, to build a multi-button selection component, it is recommended to extend the `RadioComponent` because it has similar selection behavior.
2121

22-
| Class | Extends | Description |
23-
|-------|---------|-------------|
24-
| Component | Element | Base component class |
25-
| Field | Component | Component that derives from Component class that implements a "field" render template |
26-
| Multivalue | Field | A component that is able to implement the "multiple" configuration allowing for multiple inputs for this field type. |
27-
| Input | Multivalue | A component type that implements an HTML value input. |
22+
If no existing component aligns closely enough, you can derive from one of the core classes. These core classes form the foundation of all components in the Form.io renderer:
2823

29-
Each of the components can be extended by first referencing them from the Components.components object, and then extending them as follows.
24+
| Class | Extends | Description |
25+
|-------------|-------------|-----------------------------------------------------------------------------|
26+
| `Component` | `Element` | Base class for all components. |
27+
| `Field` | `Component` | Adds rendering logic for form fields. |
28+
| `Multivalue`| `Field` | Supports multiple values for a single component. |
29+
| `Input` | `Multivalue`| Implements HTML input behavior for user interaction. |
30+
31+
### How to Extend
32+
33+
To extend a component, reference it from the `Components.components` object and define your custom class as follows:
3034

3135
```javascript
3236
const Input = Formio.Components.components.input;
37+
3338
class MyInput extends Input {
34-
// Custom logic here
39+
// Override or define your methods here
3540
}
3641
```
42+
You can now register this custom component and use it in your form schema.
3743

38-
For the most generic components, it is fine to derive from "Component", but in most value components, you may wish to derive from the Input component.
44+
For generic use cases, you can derive your custom component from the `Component` base class. However, if your component is expected to handle user input or form values, it is recommended to extend the `Input` class, which provides built-in support for value management and input behavior.
3945

4046
## Component Methods
41-
Once you derive from a base component, the next step is to define methods that either override base behaviour or introduce new behaviour into the component class. It is recommended to look at the source code of your "base" component and the classes that it extends to understand what methods you have available to you, but the majority of all behaviour can be achieved by implementing some of the following methods.
47+
48+
After extending a base component, the next step is to define methods that either override default behavior or add new functionality to your custom component.
49+
50+
To understand which methods are available, review the source code of the base component you are extending, along with its parent classes. This will give you insight into what functionality is inherited and what can be customized.
51+
52+
Most component behavior can be controlled or modified by implementing the following commonly used methods:
4253

4354
```javascript
4455
const Input = Formio.Components.components.input;

0 commit comments

Comments
 (0)