Custom Code

Custom Code is a workflow step that allows you to specify your own code snippets according to which the strings should be filtered further in the workflow. The Custom Code has one input and two outputs (true and false), so you can split strings into two workflow threads according to some specific conditions written using JavaScript.

Use Cases

You can use the custom code workflow step in the numerous scenarios. Here are a few examples:

  • To send one part of the strings to in-house translators and another part to a translation agency.
  • To send one part of the strings to machine translation and another part to crowdsourcing.
  • To send one part of the strings to in-house proofreaders and another part to proofreading by a translation agency.

Adding Custom Code Step to Your Workflow

Custom Code could be added to the workflow of your project in the workflow editor or the Workflow template editor.

Custom Code in the Workflow Editor

Code Snippet Parameters

After you added the Custom Code step to your workflow, it’s necessary to specify the code snippet in the Custom Code field according to which the strings will be directed to either of two outputs.

Code Snippet is JavaScript-based. It Includes a crowdin object and several properties. To create the code snippet, use this object template for code input:

object crowdin {
 object file {
   string name,
   string fullName,
   string branch,
   string type
 }
 object context {
   string context
   ?int maxLength
 },
 string contentType,
 string source
}

Find the example of a custom code snippet in Crowdin Script Editor. Use the link to see the structure of code snippet, edit it with your data and verify your code is correct.

Code Snippet Request

The code snippet request includes the keys listed below:

  1. file.name – source file name
  2. file.fullName – full path to the source file in the project (excluding branch if any)
  3. file.branch – branch name the source file is stored in
  4. file.type – source file type
  5. source – source text
  6. context.maxLength – maximum length of the string
  7. context.context – context of the string that enters the input of the Custom Code step
  8. contentType – string can include one of three types:

    • text/plain
    • application/vnd.crowdin.text+plural
    • application/vnd.crowdin.text+icu

Check out the example of a code snippet request:

{
   "file": {
     "name": "strings.json",
     "fullName": "backend/strings.json",
     "branch": "master",
     "type": "json"
   }
   "context": {
     "context": "backend.string.example.plain",
     "maxLength": 10
   },
   "contentType": 'application/vnd.crowdin.text+plural',
   "source": '{"one":"Password", "other":"Passwords"}',
}

Code Snippet Response

After running the code snippet, it should return the response whether the specified conditions are met or not:

  • The response object should contain boolean success property indicating whether the specified conditions are met. For instance:
{
  "success": true
}
  • In case the specified conditions are not met, the string will be directed to the false output of the Custom Code step. For example:
{
  "success": false
}

Was this article helpful?