edoc automate Guide
Breadcrumbs

Edit the system configuration of edoc automate (WebDAV)

Incorrect or faulty adjustments to the system configuration can lead to data loss.

You can define certain edoc automate parameters in a configuration file. You can call up the file in WebDAV and edit it directly in the browser.

To edit the system configuration, your user account must be a member of the admin role.

Here's how

  1. Open the WebDAV front end in the browser: https://<server-base-address>/apps/remote

  2. Authenticate yourself with your access data.

  3. Change to the automate system config folder.

  4. Edit the local.php file by clicking on the edit icon (pencil).

  5. Insert the corresponding values or adjust existing values.

  6. Save the changes with Save and Close or Save.

Things to know about syntax

You must specify all parameters in a multidimensional array. The ranges are separated by a dot when queried. Example: cookies.same_site

PHP
<?php

return [
"server" => [
  ],
  "cookies" => [
    "same_site" => "None"
  ],
  'tasks' => [
    'exec_timeout' => 1200, // matches parameter tasks.exec_timeout
  ],
  'temp' => [
    'auto_delete' => true, // matches parameter temp.auto_delete
    'max_age' => 3600, // matches parameter temp.max_age
  ]
];


Overview of existing configuration parameters in edoc automate

An overview of all configuration parameters can be found in the administration area at https://<server-Base-address>/admin/config.

Understanding relevant parameters

  • apps.version.commit_on_save: If you set this parameter to true, a commit is made to the app's Git repository each time the app is saved via the app editor. Thus, you can easily jump back to previous versions of the app. Default value: false.

  • cookie.same_site: Usually, cookies are delivered in such a way that they do not contain SameSite attribute. If, for example, you want to call up a view in an IFrame from another domain, you must set the parameter to None in some browsers. Thus, access from another domain is possible.

  • datasource.mssql.format_decimals: If you set this parameter to true, all numerical values from the mssql data source are returned with a leading zero (e.g.: 0.00, 0.10). If you set the value to false, numerical values without a leading zero (e.g.: .00, .10) are returned. Default value: true.

  • server.document.rest.timeout: You can use this parameter to configure the timeout for communication with edoc documents. Default value: 10 (seconds)

  • dvelopaddons.base_uri: You can use this parameter to define the base URL of d.velop documents. In edoc automate, it is thus automatically recognized whether you are using edoc automate in d.velop documents with d.ecs http gateway. In addition, widgets are automatically registered in the d.velop dashboard app.

  • studio.editor.components.favorites: You can use this parameter to specify the list of favorited components in the edoc automate editor. You must specify an array with the name (class name) of the component as the value for the parameter. For plug-ins, you must use the prefix plugins\\. Example: ["Text", "Input", "Button", "plugins\\DropDownButton"]

  • actions.smtp.timeout: You can use this parameter to set the timeout for sending the e-mail. Default value: 20 (seconds)

  • actions.setclass.legacy: You can use this parameter to specify that the SetClass action does not set the class via a callback, but only to the element with the ID of the component. Default value: false

  • server.workflow.settings.variable_matching: You can use this parameter to specify how the values of the workflow variable are automatically assigned to the input fields in views. You can specify whether case sensitivity and case insensitivity should be applied. Default value: casesensitive

Special features of the "tasks" parameters in the system configuration

You can define timeouts in tasks parameters for various situations: Timeout when executing tasks (tasks.exec_timeout) or when waiting for the response of a task (tasks.php-fpm.read_timeout).

You can also define the entries in the log for the task history.

Effects on system stability when adjusting the values

Only adjust the values for the timeouts if it is absolutely necessary and you have an overview of the corresponding effects in terms of system stability.

  • tasks.exec_timeout: You can use this parameter to specify the value for the maximum execution time of tasks. This value may also be exceeded for queries to third-party systems. Default value: 3,600 seconds.

  • tasks.php-fpm.read_timeout: You can use this parameter to specify the value for how long to wait for a response from the task. This value must be greater than the value in exec_timeout. Default value: 3,720,000 milliseconds.

  • tasks.history_entry_count: You can use this parameter to define the number of saved log entries for the history of a task in the backend. The parameter does not affect the number of entries displayed in the editor. Default value: 100 entries.

See also