App Manifest Keys
Where to set the app manifest?
- Go to the Home tab from the left menu on App builder.
- Click on the App Setting tab.
- Long press the Edit button for 5 secs.
- App Manifest section will be visible, please refer to the below screenshot-
5. Set the manifest and click on Save.
Below are the App manifest keys-
| Sr# | Keys | Web | Android | iOS | Is Property/ Widget/ Step added? | Possible values | Example | Description |
| 1 | disable_offline_access | No | Yes | No | No | true/false | Visibility for “make offline” button in settings. | |
| 2 | user_email_field_id | Yes | Yes | Yes | No | email field identifier | { “user_email_field_id”: “Email” } | Email field identifier from user form. |
| 3 | user_form_id | Yes | Yes | Yes | No | user form id | { “user_form_id”:12345 } | To identify user form in the app. Can be only one |
| 4 | master_lists | Yes | Yes | No | form ids | { “master_lists”:[ 1234, 4567, 8902 ] } | Prevent deletion of form data on publish and clear data. | |
| 5 | hidden_forms | No | Yes | No | form ids | { “hidden_forms”:[ 1234, 4567, 8902 ] } | To hide the forms from mobile and web app in Fill Forms sections. | |
| 6 | role_id_to_assign_ referrel_task | Yes | Yes | Yes | No | role id | To assign the referral follow up task to a particular role of the user. Used in a custom script | |
| 7 | show_calendar | Yes | Yes | No | Yes | true/false | { “show_calendar”:true } | It will get added automatically once you add the calendar behavior in the form. Visibility of calendar tab on phone. |
| 8 | Disable data sync(disable_data_sync) | No | Yes | No | Yes | true/false | If true: Disables data sync for the app. | |
| 9 | Delete data after sync (data_delete_on_sync) | No | Yes | No | Yes | true/false | Data will be deleted after the submission. | |
| 10 | “all_report_form_ sequence” | – | – | – | No | [form_id1, form_id2…] | { “all_report_form_sequence”:[1234, 4567, 6789] } | In “All data export”, all forms will be in the given sequence. |
| 11 | “exclude_media_ in_export” | – | – | – | No | true/false | { “exclude_media_in_export”: true } | To exclude media files from the “All data export”. |
| 12 | “form_sequence” | No | Yes | No | No | form ids | “form_sequence”:[ 224421, 224442, ] | To sequence the forms in the app. |
| 13 | “position” “max_item_list” | No | Yes | No | No | For Position “1 to 4”, and for max_item_list “1 to 15”. | “home_container”: [ { “position”: “1”, “max_item_list”: “5”, “type”: “Action List” } | To change the position of the sections (Actions List, My Tasks, Drafts) under the Home tab on the mobile app. Position: To change the position of sections of the Home tab. Max_item_list: To show the maximum number of items to be listed in a particular section (set no’s from 1 to 15). |
| 14 | “icon_sequence”: [ { “position”: “4” } ] | No | Yes | No | No | For Positions “1 to 9” | “icon_sequence”: [ { “position”: “4”, “type”: “Drafts” } | To change the position of the icons from the menu at the bottom of the mobile app. Position: To change the position of icons (set no’s from 1 to 9) |
| 15 | “enable_data_validity” | Yes | No | No | No | true/false | { “enable_data_validity”: true } | If this key is true, then it will show a toggle of “Valid/Invalid“ in front of the records in the data and task tab. When the toggle of Asset data is set as invalid, then actions/tasks related to this asset will be disabled and will not be included in export. When the toggle of action/task data is set as invalid, then only invalid action/task will be disabled and will not be included in export. |
| 16 | “use_x2_webform” | Yes | No | No | No | true/false | { “use_x2_webform”: true/false } | If this key is true, then after clicking on X1 Fill form user will redirect to X2 fill form page. |
| 17 | “hide_edit_btn” | Yes | NA | NA | No | true/false | To hide/show Edit button in builder and container ui in data list in web | |
| 18 | generate_report_on_submit | NA | Yes | No | No | true/false | To show the PDF report button in mobile app to generate PDF report for drafted/submitted formobject | |
| 19 | report_template | NA | Yes | No | No | AxTemplate db record ID | “1234” | The template to be used for generating the PDF report in mobile app if generate_report_on_submit flag is checked for the form |
| 20 | app_activation_date | Yes | No | mm-dd-yyyy | “1-31-2024” | Can be used for filters as “from date”, when “Before or equal to” date filter is selected |
0 Comments