How to configure a grid page - kwantu/platformconfiguration GitHub Wiki

Grids can be configured for profile listings, sub profile listings and new instance listing. Each follow the same config pattern.

Tag Explanation Parameters
addRemoveFavourite Does star to add a favourite show true or false
currentStep Does current workflow step show true or false
validDate Does the valid date show true or false
searchLabel The label for the search tab string
mayEdit Does the edit button show true or false
assignee Does the workflow assignee show true or false
mayDelete Does the delete button show true or false
workflowStatus Does the workflow status show true or false
dateAdded Does the date added show true or false
offlineStatus Does the offline status show true or false
markCancelOfflineSync Does the offline sync icon show true or false
favouriteStatus Does the favourite status show true or false
recentsLabel The label for the recents tab string
offlineLabel The label for the offline tab string
mayAdd Does the button to add an item show true or false
description Not currently used string
maskLabel The label for the text box shown when adding an instance string
showAllLabel The multi language text shown for the show all. string
filterQuery The multi language text shown for the filter query. string
gridShow The multi language text shown for the grid show. string
gridActions The multi language text shown for the grid actions. string
gridAssignee The multi language text shown for the grid assignee. string
gridStatus The multi language text shown for the grid status. string
onlinePaginationSearch The multi language text shown for the online pagination search. The text is written within (b) tag display in bold size. _VAR is replaced by total records in the system. string
onlinePaginationRecents The multi language text shown for the online pagination recents. The text is written within (b) tag display in bold size. _VAR is replaced by total records in the system. string
offlinePaginationSearch The multi language text shown for the offline pagination search. The text is written within (b) tag display in bold size. _VAR is replaced by total records in the system. string
offlinePaginationRecents The multi language text shown for the offline pagination recents. The text is written within (b) tag display in bold size. _VAR is replaced by total records in the system. string
zeroRecords The multi language text shown for the zero records. string
profileCreationLabel The label for the button to add a new item string
recentTabText The text shown below the recents tab string
searchTabText The text shown below the search tab string
offlineTabText The text shown below the offline string
createProfile Does the button to add a profile show true or false
defaultLoad The tab on load. In cases where there are no recents, it will always default to search recent or search
clickableField The field in the grid that is clickable element id
style Is the add item button shown in prominent style prominent or normal
defaultTitle Does the text box show when you add a new item or does the form open directly true or false
title The title for the grid string
okLabel The confirmation label when adding a new item string
uiView The ui view of the set id that renders the grid ui view id
goView The ui view of the set id that renders the grid on Kwantu Go ui view id
cancelLabel The confirmation label when cancelling adding a new item string
setId The set ID for the data object that renders the grid set id 
"profile": {
            "display": {
                "addRemoveFavourite": true,
                "currentStep": false,
                "validDate": false,
                "searchLabel": {
                    "i18n": {
                        "en": "Search for units",
                        "fr": "Rechercher des unités",
                        "ny": "Kufunafuna Chigawo",
                        "ne": "ईकाइ खोजी"
                    }
                },
                "mayEdit": true,
                "assignee": true,
                "mayDelete": true,
                "workflowStatus": true,
                "dateAdded": false,
                "offlineStatus": true,
                "markCancelOfflineSync": true,
                "favouriteStatus": true,
                "recentsLabel": {
                    "i18n": {
                        "en": "Recent units",
                        "fr": "Unités récentes",
                        "ny": "Zigawo zaTsopano",
                        "ne": "पछिल्लो ईकाइ "
                    }
                },
                "mayAdd": true,
                "description": {
                    "i18n": {
                        "en": "Following are a list of units.",
                        "fr": "Voici une liste d'unités.",
                        "ny": "Izi ndi zigawo zonse",
                        "ne": "ईकाइ सूची तल दिइएको छ "
                    }
                },
                "showAllLabel": {
                    "i18n": {
                        "en": "Show all",
                        "fr": "Show all",
                        "ny": "Show all",
                        "ne": "सबै देखाऊ"
                    }
                },
                "filterQuery": {
                    "i18n": {
                        "en": "Filter query",
                        "fr": "Filter query",
                        "ny": "Filter query",
                        "ne": "फिल्टर "
                    }
                },
                "gridShow": {
                    "en": "Show",
                    "fr": "Show",
                    "ny": "Show",
                    "ne": "देखाउनु"
                },
                "gridActions": {
                    "en": "Actions",
                    "fr": "Filter query",
                    "ny": "Filter query",
                    "ne": "कार्यहरु"
                },
                "gridAssignee": {
                    "en": "Assignee",
                    "fr": "Assignee",
                    "ny": "Assignee",
                    "ne": "जिम्मेवार"
                },
                "gridStatus": {
                    "en": "Status",
                    "fr": "Status",
                    "ny": "Status",
                    "ne": "स्थिति"
                },
                "onlinePaginationSearch": {
                    "en": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total entries <b>_VAR</b>)",
                    "fr": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total entries <b>_VAR</b>)",
                    "ny": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total entries <b>_VAR</b>)",
                    "ne": "<b> _TOTAL_ </b> को <b> _START_ </b> बाट <b> _END_ </b> (कुल प्रविष्टि <b> _VAR </b>) देखाउँदैि <b> _VAR </b>)"
                },
                "onlinePaginationRecents": {
                    "en": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total entries <b>_VAR</b>)",
                    "fr": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total entries <b>_VAR</b>)",
                    "ny": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total entries <b>_VAR</b>)",
                    "ne": "भर्खरै देखीएको <b> _TOTAL_ </b> को <b> _START_ </b> लाई <b> _END_ </b> देखाउन फिल्टर गरीएको (कुल प्रविष्टि <b> _VAR </b>)"
                },
                "offlinePaginationSearch": {
                    "en": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total <b>_VAR</b> profiles synchronised on your local device in offline mode.)",
                    "fr": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total <b>_VAR</b> profiles synchronised on your local device in offline mode.)",
                    "ny": "Showing <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> entries (Total <b>_VAR</b> profiles synchronised on your local device in offline mode.)",
                    "ne": "<b> _TOTAL_ </b> प्रविष्टिहरु को <b> _START_ </b> देखि <b> _END_ </b> (कुल <b> _VAR </b> प्रोफाईलहरु तपाइँको स्थानीय यन्त्रमा अफलाइन मोडमा सिnch्क्रोनाइज हुँदैछ।)"
                },
                "offlinePaginationRecents": {
                    "en": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total <b>_VAR</b> recents synchronised on your local device in offline mode.)",
                    "fr": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total <b>_VAR</b> recents synchronised on your local device in offline mode.)",
                    "ny": "Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries (Total <b>_VAR</b> recents synchronised on your local device in offline mode.)",
                    "ne": "भर्खरै देखीएको <b> _TOTAL_ </b> को <b> _START_ </b> <b> _END_ </b> लाई <b> _VAR </b> देखाउन फिल्टर गरीएको छ (कुल <b> _VAR </b> भर्खरै अफलाइनमा तपाइँको स्थानीय उपकरणमा सिnch्क्रोनाइज्ड मोड।)"
                },
                "zeroRecords": {
                    "en": "Showing 0 to 0 of 0 entries",
                    "fr": "Showing 0 to 0 of 0 entries",
                    "ny": "Showing 0 to 0 of 0 entries",
                    "ne": "0 प्रविष्टिहरु मध्ये 0 देखि 0 देखाईरहेको छ"
                }
            },
            "maskLabel": {
                "en": "Enter unit name",
                "fr": "Entrez le nom de l'unité",
                "ny": "Lowesani dzina la chigawo",
                "ne": " ईकाइको नाम प्रविष्टी गर्नुहोस् "
            },
            "profileCreationLabel": {
                "en": "Add unit",
                "fr": "Ajouter une unité",
                "ny": "Kuwonjezera chigawo",
                "ne": " ईकाइ थप गर्नुहोस् "
            },
            "clickableField": "element",
            "defaultLoad": "search",
            "createProfile": true,
            "style": "prominent",
            "defaultTitle": true,
            "title": "Unit",
            "okLabel": {
                "en": "OK",
                "fr": "D'accord",
                "ny": "Chabwino",
                "ne": " ठिक छ "
            },
            "uiView": "grid",
            "cancelLabel": {
                "en": "Cancel",
                "fr": "Annuler",
                "ny": "kuchotsa",
                "ne": " रद् गर्नुहोस् "
            },
            "setId": "CAREfacilityDetails"
        },

NOTE:
While adding the pagination text there are few replacements that needs to be taken care of. 
For example

ex. Filtered to show <b>_START_</b> to <b>_END_</b> of <b>_TOTAL_</b> recently viewed entries 
(Total <b>_VAR</b> recents synchronised on your local device in offline mode.)

START (underscored as prefix and suffix - might be replaced by markdown)
END (underscored as prefix and suffix - might be replaced by markdown)
TOTAL (underscored as prefix and suffix - might be replaced by markdown)
The above three are replaced by the record number and total records loaded...

_VAR is replaced by total records in the system.
⚠️ **GitHub.com Fallback** ⚠️