Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning

Comments with /*COMMENT HERE*/ are not allowed in config.json

Parameters

"autoRefreshInterval": 50000

This parameter is used to determine 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 one task or instance is completed by another user. The minimum value for the auto-refresh is 30 seconds.

Info

Value is in milliseconds.

"filterDateFields": ["FormIndex1","FormIndex2"]

This parameter is used to activate a datepicker filter on instances and task lists for specific index fields.

...

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.

Code Block
{
    "autoRefreshInterval": 300000,
    "filterDateFields": [],
    "showHome": true,
    "features": {
        "documents": true,
        "notes": true,
        "efforts": true,
        "processModel": true,
        "cpm": true,
        "workflowdesign": 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 main screen

Info

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:

Code Block
{
  "showHome": false
}

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

Code Block
"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.

Code Block
"

...

filterDateFields"

...

This parameter determines if the home icon on the left-hand side of the screen should be disabled. The default value is true. If it is set to false, it disables the home icon on the product and users cannot access it.

"features":{}

Code Block
 : ["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.

Code Block
{
  "features": {
		"documents": truefalse,
		"notes": true,
		"efforts": true,
		"processModel": true,
		"cpm": true
  }

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.

...

Image Removed

"tasks":{}

Code Block
"tasks": {
	"showAdhoc
}


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.

Code Block
{
  "features": {
		"documents": false,
		"notes": false,
		"efforts": true,
		"processModel": true,
		"showQuerycpm": true
  }

These parameters determines if buttons for adhoc task and query should be disabled. If parameters are set to false, buttons will be disabled.

...

"loginPage":{}

Code Block
"loginPage
}


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.

Code Block
{
  "features": {
		"tenantsdocuments": [false,
			{"labelnotes": false,
		"PME-Mandant"efforts": false,
		"valueprocessModel": "pme"}true,
			{"labelcpm": true
"Test-Mandant", "value": "test"}
		]  }
}


The “efforts” tab is hidden successfully

...


Hide Process model Tab

Scenario 4: To hide the “processModel" 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 "processModel" tab is no longer visible.

Code Block
{
  "features": {
		"documents": false,
		"notes": false,
		"additionalHtmlefforts": "\n\t\t\t<div><b>Service-Nummern</b></div>\n\t\t\t\n\t\t\t<div>\n\t\t\t\tHurz, ABC\t\n\t\t\t</div>"
	}
}

These parameters allow displaying tenants information with a drop box to choose the tenant while logging in.

Additional information can be written with additionalHtml parameter.

...

"preCacheformData":{}

Code Block
"preCacheformData": {
    "allUsers": false,
    "allGroups": false,
    "csvPreloading": []
}

preCacheformData is a performance optimization for the Form Designer. It allows to pre-load the CSV information, so waiting time can be reduced.

  • The parameter allUsers creates a cache for all users.

  • The parameter allGroups creates a cache for all groups.

  • The parameter csvPreloading creates a cache for CSV data if it is a complete CSV file.

Info

The cache contains a key, data and expiration time.

"documents":{}

Code Block
"documents": {
    "countDocumentsRecursive": true
}

This parameter allows recursive count of all the documents that are on one instance.

Info

For example, there can be another folder in a folder, so it can be counted recursively.

"tsdConfig":{}

Code Block
"tsdConfig": {
    "enableLogging": false,
    "clearConsoleBeforeLog": false
}

enableLogging will enable the TSD pipeline logging if it is set to true, meaning in the output console of your web browser it will log out certain information on the form.

clearCosoleBeforeLog clears the console of the web browser before logging out for any logs related to TSD.

Info

This property can only be used if the enableLogging is true and thereby logging is enabled.

Full document for config.json:

Code Block
"autoRefreshInterval": 3000,
"filterDateFields": ["FormIndex1","FormIndex2"],
"showHome": true,
"features": {
	"documents": true,
	"notes": true,
	"efforts": true,
	"processModel": true,
	"cpm": true
},
"tasks": {
	"showAdhoc": true,
	"showQuery": true
},
"loginPage": {
		"tenants": [
false,
		"processModel": false,
		"cpm": true
  }
}


The “processModel” 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" button is no longer visible.

Code Block
{
  "features": {
		"documents": false,
		"notes": false,
		"efforts": false,
		"processModel": false,
		"cpm": false
  }
}


The “cpm” tab is hidden successfully.

...


Task properties

Hiding Ad-hoc button from task properties

Scenario 1: To hide the “Ad-hock" 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.

Code Block
{ 
  "tasks": {
		"showAdhoc": false,
		"showQuery": true
  }
}


Ad-hoc button is hidden successfully

...



Hiding 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.

Code Block
{ 
  "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.

Info

If the config.json file is uploaded on super tenant, the dropdown box is activated for every tenant.

Code Block
{
	"loginPage": {
		"tenants": [
            {"label": "actionhandler", "value": "actionhandler"},
			{"label": "admin", "value": "X124"},
			{"label": "PME-Mandantassignment", "value": "pmeassignment"},
			{"label": "Test-Mandantbasic", "value": "testbasic"}
		],
		"additionalHtml": "\n\t\t\t<div><b>Service-Nummern<t<div><b>config.json Test</b></div>\n\t\t\t\n\t\t\t<div>\n\t\t\t\tHurz, ABCtAT349_loginSiteNeedsToBeConfigurable\t\n\t\t\t</div>"
	}
},
"preCacheformData": {
    "allUsers": false,
    "allGroups": false,
    "csvPreloading": []
},
"documents": {
    "countDocumentsRecursive": true
},
"tsdConfig": {
    "enableLogging": false,
    "clearConsoleBeforeLog": false
}


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.

Info

Value is in milliseconds.