Page tree

Versions Compared

Key

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

Provides access to config of the application

URL:

/editor/config

/[ID]

Available Methods:

GET

(currently)

,PUT

Specialities:

Only available for users with role admin.

 

List or modify configuration based on user roles 


All translate5 configuration are grouped in 6 different groups called levels. More info about the levels you can find in the table bellow.

Level nameLevel configuration valueDescriptionAvailable for user role
system1

This is system configuration level. The values of those configs are defined in the database, and can only be changed there.


/
instance2

The instance level configuration can be overwritten via the translate5 interface or api, and the value defined there, is a 

base value for all other upper levels.

admin,api
customer4

Customer level configuration can be overwritten via the translate5 interface (for each customer separate value can be defined)

or api, and the value defined there is a base value for task-import and task configuration.

admin,api
task-import8

Task import level configuration can be overwritten via the translate5 interface (after task is created in the task creation wizard) or api. 

admin,api
task16Task level configuration can be overwritten via the translate5 interface (in the task properties panel there is task configuration subtub) or apiadmin,api
user32

All existing user configurations are handled by the state provider. You can not explicit define user level value, but you can define base value

for the user level configs in the 

admin,api,editor,pm


Resource Layout

Name

Type

Info

id

int

 


name

string

Name used in application to retrieve the config.

confirmed

boolean

future feature.

module

string

PHP Module where the config is used.

category

string

A string to categorize the config entry.

value

string

The config value as string representation.

default

string

The default config value delivered by translate5.

defaultsstringfuture feature, should contain the available values for radio box like configs when used in a GUI.
typestringcontains the type to which value is casted in PHP.
descriptionstringA textual description of the config.
levelintegerConfiguration level. This defines where this configuration can be overwritten and who can see it.
guiNamestringSimple configuration description.
guiGroupstringConfiguration group
commentstring
originstringWhere the config overwrite comes from. (db/system, instance, customer, taskImport,task)


Put request example for overwriting task specific config

{

data:{

         "value":"0",

         "taskGuid":"{1d842b86-c0a1-4f6d-bd23-5c1577172224}",

        "name":"runtimeOptions.editor.showReferenceFilesPopup"

       }

}

In the example above, the config value for runtimeOptions.editor.showReferenceFilesPopup will be set to 0 for the task with taskGuid {1d842b86-c0a1-4f6d-bd23-5c1577172224}.

Depending on the second parameter (in the example above taskGuid), translate5 will decide for what kind of config overwrite the current request is. For example if instead of providing the taskGuid,

customerId is provided, this config value will be saved as customer specific overwrite and it will be default value for all tasks of this customer.