Form configuration - files



File and directory structure



Excluding the files and directories necessary to operate the system (i.e. css, fonts, js, service-worker.js), the main application directory contains several elements that are of interest to us:

/FORMS directory

In this folder we will define and style all our forms.

/styles directory

files that allow you to configure the appearance of the form (changing colors, styling views, control buttons, etc.).

/templates directory

configuration files of each form

config.json file

list of active forms

SystemConfig.json file

Main system configuration, here you set communication with OTRS, default language and many more [[[more in the Main configuration file - global settings]]].

manifest.json file

This file is responsible for PWA settings (for more advanced users), if you are not an advanced user - leave it as it is.

index.html file

In this file you can change the title of the form page, you can change it by changing the text in the <title></title> attribute.Main configuration file - global settings

This topic refers to the file static/SystemConfig.json.

Example configuration file:

{

 "SystemUrl": "XSYSTEM_URLX", 

 "Alias": "XSYSTEM_ALIASX",

 "SystemUrl_DEV": "www.example.com/system"

 "ShowLangButton": true, 

 "LangButtonColor": "#333333", 

 "GlobalLang": "pl",

 "RedirectButtons": [

 {

 "color": "#333333",

 "label": "Moje zgłoszenia", 

 "redirectURL": "https://yahoo.pl" 

 },

 {

 "color": "#333333",

 "label": "Nowe zgłoszenie",

 "redirectURL": "https://google.pl"

 }

 ]

}

Description of individual values:

OtrsUrl/SystemUrl - Address of the OTRS/OTOBO module that will accept the requestAlias - Alias under which the forms will appearShowLangButton - Should the language change button be visible (if we have only one language, we can hide it)LangButtonColor - Color of the language change buttonGlobalLang - Default form language (loaded by default, unless otherwise specified by OTRS configuration)RedirectButtons - Optional forwarding buttons

Company Site is an additional redirection button

RedirectButtons parameters - this parameter counts an array with objects containing parametersshow - should the button be visiblecolor - color of the redirection buttonlabel - button captionredirectURL - forwarding addressFile activating the form and setting the order in HUB

This topic refers to the file static/FORMS/config.json.

[

 "ExampleForm1.json",

 "ExampleForm2.json",

]

This file is responsible for form activation and the order of forms in the HUB.

Every form you want to see in the menu must be entered here (even if it is hidden in the HUB).

The order of the forms on the list corresponds to the order in the HUB.