Translate workflows

You can translate workflows in any of the supported languages by adding custom strings for those languages and leveraging the workflows Java API translation bean.

To use custom strings, you must prepare your workflow for translations:

Item Workflow Designer Eclipse plug-in** Custom string example
Task name*
  • Field: Name
  • Value: A string that identifies the task name
  • Example: user.task1.name
 user.task1.name=The translated name of the task
Task description*
  • Field: Documentation
  • Value: A string that identifies the task description
  • Example: user.task1.description
 user.task1.description=The translated description of the task
Form fields
  • Field: Form component fields in the General section, such as:
    • Label
    • Label tooltip
    • Default value
    • Description
  • Value: The expression {{translation.getMessage('translation.key')}}
  • Example: {{translation.getMessage('text.area.label')}}
  • Field: Form property parameters, such as:
    • Name
    • Default
    • The form value helpText
  • Value: The expression ${translation.getMessage('translation.key')}
  • Example: ${translation.getMessage('text.area.name')}
 text.area.label=The translated label of the field
Form buttons
  • Field: Form outcome Label
  • Value: The expression {{translation.getMessage('translation.key')}}
  • Example: {{translation.getMessage('button.name')}}
  • Field: Form property Name for form property types such as:
    • button
    • taskButton
    • activityButton
  • Value: The expression ${translation.getMessage('translation.key')}
  • Example: ${translation.getMessage('button.name')}
 button.name=The translated name of the button
Email task
  • Field: Email properties, such as:
    • Subject
    • Body
  • Value: The expression ${translation.getMessage('translation.key')}
  • Example: ${translation.getMessage('email.body')}
  • Field: Main config properties, such as:
    • Subject
    • Non html
  • Value: The expression ${translation.getMessage('translation.key')}
  • Example: ${translation.getMessage('email.body')}
 email.body=The translated body of the email
Custom error message
  • Field: Script task
  • Value: translation.getMessage('translation.key')
  • Example:
    import com.collibra.dgc.workflow.api.exception.WorkflowException

def customError = new WorkflowException("translation.getMessage('error.description')")
customError.setTitleMessage("translation.getMessage('error.title')")
throw customError;
 error.description=The translated description of the error

* Start forms display the process name instead of the task name and description. You cannot translate the process name.

** There are multiple known issues for Eclipse plug-in translations:
  • You cannot translate the form property options, such as check-box options.
  • The boolean form property type retains the English "True" and "False" options.
  • The calendars for the datetime form property type retain the English "Cancel" and "Apply" buttons.