Versions Compared

Key

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

...

In case i18n is enabled in your app, then in these frontend resource locations you can use custom i18n URIs like $uri:i18:<app>/<context>/<key> so they will be automatically replaced by the translated text depending on currently selected locale.

App Config

You can translate:

  • The title of the app

  • The description of the app

...

Code Block
languagejson
{
  "title": "$uri:i18n:com.acme.myapp/title",
  "description": "$uri:i18n:com.acme.myapp/description",
  "i18n": true
}

Form Schema

You can translate:

  • The title of a field

  • The description of a field

...

Code Block
languagejson
{
	"type": "object",
	"properties": {
		"firstName": {
			"type": "string",
			"title": "$uri:i18n:com.acme.myapp/firstName",
			"description": "$uri:i18n:com.acme.myapp/firstNameDesc",
			"maxLength": 1000
		},
		...
	}
}

Form Config

You can translate:

  • The title of the form

  • The description of the form

  • Validation Messages

...

Code Block
{
  "title": "$uri:i18n:com.acme.myapp/form/title",
  "description": "$uri:i18n:com.acme.myapp/form/description",  
  ...
  "layout": {
    "items": [
      {
        "field": "firstName", 
        "validation":[
          { 
            "type":"js", 
            "rule":"!!val", 
            "message": "$uri:i18n:com.acme.myapp/validation/required" 
          },
          { 
            "type":"js", 
            "rule":"val.length > 2", 
            "message": "$uri:i18n:com.acme.myapp/validation/must_longer_than_2" 
          }
        ]
      },
      ...
    ]
  }
}

List Config

You can translate:

  • The title of the list

  • The description of the list

...

Code Block
languagejson
{
  "title": "$uri:i18n:com.acme.myapp/list/title",
  "description": "$uri:i18n:com.acme.myapp/list/description",
  ...
}

Workflow

...

and Task Names

You can translate:

  • The display name of the workflow

  • The display name of a task

Task Name

In order to translate the name of a workflow task, you have to specify the i18n URI in the first line of the description of the task as this example shows:

...

Everywhere in the UI where this task is displayed (for example in the task list), the translation for the task name is shown depending on the currently active locale.

Workflow Name

If you want to translate the name of a workflow, you have to create a i18n messages property of type application/json using this path:

Code Block
global/app/<appName>/i18n/<commonWfName>-<locale>

Replace <appName> by the name where the workflow property resides in.

Replace <commonWfName> by the name of the workflow, which is currently shown in UI and you would like to provide a translation for.

Replace <locale> by the locale key (for example en or de) of the translation you would like to provide.

For example:

Code Block
global/app/io.pipeforce.myapp/i18n/myworkflow-en

Place the i18n messages JSON inside this property having the field processDefinitionName:

Code Block
{
	"processDefinitionName": "English Name of Workflow"
}

Common i18n messages (Portal)

...