The config.json is an internal configuration file in the product, an example file can be seen at the end of this page and modified at will. To update the config.json, a user needs to upload it to the resource folder (Administration > Resources) of either the tenant or in general to the whole application via the super/admin. Only the changed and updated features to the resource folder will be overwritten in the product according to the new configuration.
→ If the document is uploaded to a super/admin, the changed config.json will be applied to all tenants of the environment.
→ If the document is uploaded only to a specific tenant, the changed config.json will only be applied to that tenant and will not affect the other tenants or the super/admin environment.
→ If the document is uploaded to both super/admin and a tenant, the tenant version of the document is considered.
For example, the config.json file uploaded to the super/admin has the showHome property set to false and the config.json file uploaded to one tenant under this super/admin has showHome property set to true. In this case, the home icon will be shown for that specific tenant, and it won’t be shown for the super/admin and other tenants under this super/admin.
Some properties might only take effect or make sense when the config.json is uploaded via the super/admin, like:
loginPage > tenants
loginPage > additionalHtml
Comments with /*COMMENT HERE*/ are not allowed in config.json
Overview of configuration file - config.json
We can do configurations in the product via config.json. The full overview of the file is as follows.
{
"autoRefreshInterval": 300000,
"filterDateFields": [],
"showHome": true,
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
},
"tasks": {
"showAdhoc": true,
"showQuery": true
},
"loginPage": {
"tenants": [],
"additionalHtml": ""
},
"registerPage": {
"additionalHtml": ""
},
"preCacheSmartformData": {
"allUsers": false,
"allGroups": false,
"csvPreloading": []
},
"documents": {
"countDocumentsRecursive": true
},
"tsdConfig": {
"allowPasswordFields": false,
"enableLogging": false,
"clearConsoleBeforeLog": false
},
"table": {
"bulkActions": {
"useNew": true
},
"filter": {
"useNew": true
}
}
}
Home menu - How to hide home from the main screen
We can easily configure our config.json to hide the “Home” icon from the main screen that can be uploaded under “Administration → Resources”
The file should be configured as follows:
{
"showHome": false
}
The home icon is hidden successfully. Users will automatically be redirected to “my open tasks” list.
DatePicker activation
Scenario 1: to activate the datepicker for specific index columns, update the config.json file by updating it to [smartFormIndex1]. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "datepicker" is now visible on the index1 field
"filterDateFields" : ["smartFormIndex1"]
The Datepicker is activated successfully
Scenario 2: to activate more than one datepicker, values can be written comma-separated if more than one index column will be filtered.
"filterDateFields" : ["smartFormIndex1","smartFormIndex2"]
The datepickers are activated successfully.
Hiding tabs
These parameters determine the features document, notes, efforts, process model for the tasks and CPM info for the instances should be disabled. If parameters are set to false, features will be disabled.
Hide “Documents” Tab
Scenario 1: To hide the "Documents" tab in the product interface, update the config.json file by setting the status of the "documents" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Documents" tab is no longer visible.
{
"features": {
"documents": false,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Documents” tab is hidden successfully
Hide “Notes” Tab
Scenario 2: To hide the "Notes" tab in the product interface, update the config.json file by setting the status of the "notes" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Notes" tab is no longer visible.
{
"features": {
"documents": true,
"notes": false,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Notes” tab is hidden successfully
Hide “Efforts” Tab
Scenario 3: To hide the “Efforts" tab in the product interface, update the config.json file by setting the status of the "efforts" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Efforts" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": false,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Efforts” tab is hidden successfully
Hide “Process model” Tab
Scenario 4: To hide the “Process model" tab in the product interface, update the config.json file by setting the status of the "processModel" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Process model" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": false,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Process model” tab is hidden successfully.
Hide “CPM” Tab
Scenario 5: To hide the “CPM" tab in the product interface, update the config.json file by setting the status of the "cpm" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "CPM" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": false,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “CPM” tab is hidden successfully.
Hide “Gantt” Tab
Scenario 6: To hide the “Gantt" tab in the product interface, update the config.json file by setting the status of the "gantt" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Gantt" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": false,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Gantt” tab is hidden successfully.
Hide “Activities” Tab
Scenario 7: To hide the “Activities" tab in the product interface, update the config.json file by setting the status of the "activities" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Activities" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": false,
"swimlanes": true,
"assignmenthistory": true,
"templates": true
}
}
The “Activities” tab is hidden successfully.
Hide “Swimlanes” Tab
Scenario 8: To hide the “Swimlanes" tab in the product interface, update the config.json file by setting the status of the "swimlanes" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Swimlanes" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": false,
"assignmenthistory": true,
"templates": true
}
}
The “Swimlanes” tab is hidden successfully.
Hide “Assignment history” Tab
Scenario 9: To hide the “Assignment history" tab in the product interface, update the config.json file by setting the status of the "assignmenthistory" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Assignment history" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": false,
"templates": true
}
}
The “Assignment history” tab is hidden successfully.
Hide “Templates” Tab
Scenario 10: To hide the “Templates" tab in the product interface, update the config.json file by setting the status of the "templates" to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Templates" tab is no longer visible.
{
"features": {
"documents": true,
"notes": true,
"efforts": true,
"processModel": true,
"cpm": true,
"gantt": true,
"activities": true,
"swimlanes": true,
"assignmenthistory": true,
"templates": false
}
}
The “Templates” tab is hidden successfully.
Task properties
Hiding the ”Ad-hoc” button from task properties
Scenario 1: To hide the “Ad-hoc" button from task properties, update the config.json file by setting the status of the "showAdhoc” to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Ad-hoc" button is no longer visible.
{
"tasks": {
"showAdhoc": false,
"showQuery": true
}
}
Ad-hoc button is hidden successfully
Hiding the “Show Query” button from task properties
Scenario 2: To hide the “Show Query" button from task properties, update the config.json file by setting the status of the "showQuery” to false. Once updated, upload the modified file to the "Resources" section. This action will ensure that the "Show Query" button is no longer visible.
{
"tasks": {
"showAdhoc": true,
"showQuery": false
}
}
Show Query button is hidden successfully
Login Page dropdown
To activate the “dropdown" button box on login page, update the config.json file by setting the status of the "loginPage” according to the configuration file displayed below. You can specify a different label that will be shown for a specific tenant name. E.g. tenant name is “X124” but “admin” should be shown.
Once updated, upload the modified file to the "Resources" section. This action will ensure that the "dropdown box" button is displayed.
If the config.json file is uploaded on super tenant, the dropdown box is activated for every tenant.
{
"loginPage": {
"tenants": [
{"label": "actionhandler", "value": "actionhandler"},
{"label": "admin", "value": "X124"},
{"label": "assignment", "value": "assignment"},
{"label": "basic", "value": "basic"}
],
"additionalHtml": "\n\t\t\t<div><b>config.json Test</b></div>\n\t\t\t\n\t\t\t<div>\n\t\t\t\tAT349_loginSiteNeedsToBeConfigurable\t\n\t\t\t</div>"
}
}
The dropdown box button is displayed successfully on the login page
Auto Refresh Interval
"autoRefreshInterval": 50000
This parameter determines the auto-refresh interval for the tasks and instance lists. It will reload the list every 5 minutes in case multiple users are working on the same instances and if another user completes one task or instance. The minimum value for the auto-refresh is 30 seconds.
Value is in milliseconds.