QA Rule (Object)

A JSON object that represents a QA rule.

PROPERTIES

A JSON object:

enabled

The rule is enabled or not.

boolean

type

Type of rule.

string

name

Rule name.

string

severity

Severity of the rule.

string

category

Category of the rule.

string

scope

Scope of the rule.

string

priority

The priority. Determine the execution order of rules.

int

failBookmark

Set this bookmark if error with this rule.

string?

failStatus

Set this status if error with this rule.

string?

parameters

???

userNote

Set this not

projectOnly

???

boolean

skipGreenStatus

Determine if the rule is applicable or not on segment with a status green.

boolean

ui

description	The rule description.	string
helphtml	A help description of the rule.	string
controls	internal.	-

EXAMPLES

{
				"enabled": true,
				"type": "ConsistentTranslation",
				"name": "◀Translations - Consistency▶",
				"severity": "Warning",
				"category": "TranslationMeaning",
				"scope": "Text",
				"priority": 0,
				"failBookmark": null,
				"failStatus": "Problem",
				"successBookmark": null,
				"successStatus": null,
				"parameters": [{
						"key": "contextSensitive",
						"value": false,
						"text": null
					}
				],
				"userNote": null,
				"projectOnly": false,
				"skipGreenStatus": false,
				"ui": {
					"description": "◀This rule verifies whether all identical source texts are translated the same way within a document. It helps making translations consistent throughout a text.▶",
					"helphtml": "◧The system starts by finding all identical source texts (repetitions). It then compares the respective translations to see if these are all identical or not.\r\n\t\t\t\t\t\t<p>For example, if the same phrase shows up twice but is translated in two different ways, the system will consider/flag the second translation invalid.</p>\r\n\t\t\t\t\t\t◨",
					"controls": [{
							"title": "◀In-context matching:▶",
							"helphtml": "◧If ticked then two source texts are considered identical if and only if the respective preceding and succeeding source texts \r\n\t\t\t\t\t\t\t\tmatch up as well. This means that differences in translation are accepted if the context in the text is not the same.◨",
							"key": "contextSensitive",
							"width": "400px",
							"control": {
								"type": "checkbox",
								"label": "◀Compare translations only if source texts are in context▶"
							}
						}
					]
				}
			}