index.json

Every formdefinition folder can have an index.json file. It is used to mimic server settings during development.

Note

Changes to the file are only applied after restart of the FormDev.

example index.json

{
    "title": "Example",
    "culture": "en-US",
    "attachments": [],
    "flags": {
        "FormDev.PDFDebug": false,
        "Form.New": true,
        "Form.Delete": true,
        "Form.Copy": true,
        "Form.ReturnToGroup": true,
        "Form.CopySubmitted": false,
        "Form.View": true,
        "Feature.Picture": true,
        "Feature.Sketch": true,
        "Feature.CustomSketchTemplate": true,
        "Feature.Audio": true,
        "Feature.Map": true,
        "Feature.Document": true,
        "Form.LazyLoading": false,
        "Feature.showDetail": true,
        "PDF": true,
        "PDF.Picture": true,
        "PDF.Sketch": true,
        "PDF.Audio": true,
        "PDF.Map": true,
        "PDF.Document": true,
        "PDF.PageCounter": true,
        "Picture.ReadOnly": false,
        "Sketch.ReadOnly": false,
        "Audio.ReadOnly": false,
        "Map.ReadOnly": false,
        "Document.ReadOnly": false,
        "Listpage.SortGroupFilter": false,
        "Form.ListPageFavorites": true,
        "Form.ScanSearch": false
    },
    "catalogs": {
        "useProxy": true,
        "useOdataProxy": true,
        "host": "example.hybridforms.net"
    }
}

Property	How to use	Description
title	"title": "Example"	The displayed form title in the app.
culture	"culture": "en-US"	Set the form culture.
attachments	"attachments": ['testfile.html']	Specify all used files for the formdefinition. If property is not set or an empty array all files are used.
flags	"flags": { "FormDev.PDFDebug": true }	Set form flags for PDF debugging. Read more.
catalogs	"catalogs": { "host": "example.hybridforms.net" }	Configure catalogs proxy. Read more.

Flags

Property	Description
FormDev.PDFDebug	Start a headful chromium instance after form PDF is rendered to debug CSS stylings.
Form.New	Allow users to create new forms in the HybridForms app.
Form.Delete	Allow users to delete forms in the HybridForms app.
Form.Copy	Allow form copying in the HybridForms app. A new form is created and populated with the data. If several stages are defined, the new form is created in Stage 1.
Form.ReturnToGroup	Enable ""Back to group"" function for forms in the HybridForms app.
Form.CopySubmitted	Allow copies of approved forms in the HybridForms app. A new form is created and populated with the data. If several stages are defined, the new form is created in Stage 1.
Form.View	Enabling form preview in the HybridForms app. The preview shows how the form will look like in the PDF version. Note: This is a developer feature and should be disabled in the production environment.
Feature.Picture	Enable the Picture feature in the HybridForms app.
Feature.Sketch	Enable the Sketch feature in the HybridForms app.
Feature.CustomSketchTemplate	Enable the option to use images from the Picture and Maps feature as sketch templates.
Feature.Audio	Enable the Audio feature in the HybridForms app.
Feature.Map	Enable the Maps feature in the HybridForms app.
Feature.Document	Enable the Document feature in the HybridForms app.
Feature.showDetail	After creating or uploading an image/sketch/audio/map/file element in the HybridForms app, the detail information page opens. If not active, e.g. several photos can be taken one after the other without a detail dialog.
PDF	Enable PDF creation.
PDF.Picture	Images with the detailed information are attached to the form pages in the PDF by default.
PDF.Sketch	Sketches with the detailed information are attached to the form pages in the PDF by default.
PDF.Audio	Audio detail information is appended to the form pages in the PDF by default.
PDF.Map	Maps with the detailed information are attached to the form pages in the PDF by default.
PDF.Document	Document detail information is appended to the form pages in the PDF by default.
PDF.PageCounter	Activate page numbering in the PDF file.
Picture.ReadOnly	Disable the camera/upload and editing features in the Picture feature.
Sketch.ReadOnly	Disabling the ability to draw and edit in the Sketch feature.
Audio.ReadOnly	Disabling the recording and uploading option in the Audio Feature.
Map.ReadOnly	Disabling the ability to create and edit in the Maps feature.
Document.ReadOnly	Disabling the upload option in the Document feature.
Listpage.SortGroupFilter	Enabling form sorting feature, grouping feature, filtering feature and action submenu on form listing page in HybridForms app.
Form.LazyLoading	Show form as soon as first page is available.
Form.ListPageFavorites	Creation of favorites for the presentation of the objects on the form listing page of the HybridForms App.
Form.ScanSearch	Enable use of barcode scans for search function on form listing page.

Catalogs

Property	How to use	Description
host	"host": "example.hybridforms.net"	Set the host server for the reverse proxy server from which catalgs are fetched. more details
useProxy	"useProxy": true	Enable/disable catalogs from proxy for ComboBox and DropDownList with url property set. Default value is false.
useOdataProxy	"useOdataProxy": false	Enable/disable catalogs from proxy for ComboBox and DropDownList with OData source. Default value is true.