Common keywords
Keyword |
Stands for |
Used to |
---|---|---|
TO |
Target Object |
|
Attr |
Attribute |
Specify attribute name for the property lists. Applicable for all rule types except the validation rule. |
RT |
Rule Type |
Specify the configured rule type. If rule type is not specified, then the default value considered for the rule type is specified area (SA) |
The following tables provide information about keywords that are specific to certain rule types:
ValidationRule (VL)
This rule is used to define valid offset values that are used for validating the PDF template before processing.
Keyword |
Stands for |
Used to |
---|---|---|
OSX |
Offset X co-ordinate |
Specify the offset X co-ordinate for the annotated area or text. For example: RT=VL|OSX=10|OSY=10 |
OSY |
Offset Y co-ordinate |
Specify the offset Y co-ordinate for the annotated area or text. For example: RT=VL|OSX=10|OSY=10 |
Trim |
Trim text |
Remove all the spaces extracted as part of the rule defined. |
SpecifiedArea (SA)
Keyword |
Stands for |
Used to |
---|---|---|
Multi |
Multiple Instance |
Check and extract multiple instances of the pattern from the annotated content. For example: RT=SA|TO=TD|Attr=Name|Multi=False|Trim=True|IsCommon=False |
Trim |
Trim Text |
Remove all the spaces from the extracted text. For example: RT=SA|TO=TD|Attr=Name|Multi=False|Trim=True|IsCommon=False |
IsCommon |
Common Attribute |
Apply the attribute to all the matched target objects. For example: RT=SA|TO=TD|Attr=Name|Multi=False|Trim=True|IsCommon=False |
DNS (Document Naming System) is valid only when the target object is set to Titleblock.
ScatteredText (ST)
Keyword |
Stands for |
Used to |
---|---|---|
Multi |
Multiple Instance |
Check and extract multiple instances of the pattern from the annotated content. For example: RT=ST|TO=TD|Attr=Name|Multi=True|Trim=True|Sep=- |
Trim |
Trim Text |
Remove all the spaces from the extracted text. For example: RT=ST|TO=TD|Attr=Name|Multi=True|Trim=True|Sep=- |
Sep |
Separator |
Specify a separator to join the text in mutilple lines. For example: RT=ST|TO=TD|Attr=Name|Multi=True|Trim=True|Sep=- |
DNS (Document Naming System) is valid only when the target object is set to Titleblock.
TagConstant (TC)
Keyword |
Stands for |
Used to |
---|---|---|
TNS |
Tag Naming System |
Specify a valid Tag Naming System display name. For example: RT=TC|TNS=Area|Value=A1 |
Value |
TNS Constant |
Specify a Tag Naming System value. For example: RT=TC|TNS=Area|Value=A1 |
By default, tag is considered as the target object in this rule type.
DocumentConstant (DC)
Keyword |
Stands for |
Used to |
---|---|---|
DNS |
Document Naming System |
Specify a valid Document Naming System display name. For example: RT=DC|DNS=Unit|Value=U1 |
Value |
DNS Constant |
Specify a DNS value. For example: RT=DC|DNS=Unit|Value=U1 |
By default, tag is considered as the target object in this rule type.
TableRule (TR)
Keyword |
Stands for |
Used to |
---|---|---|
RepTab |
Repeat Table |
Apply this table rule to another table at the same co-ordinates. For example: RT=TR|TO=TD|MultiPage=True|NoOfPages=2|Trim=True|RepTab=True |
Trim |
Trim text |
Remove all the spaces from the text extracted from the table. For example: RT=TR|TO=TD|MultiPage=True|NoOfPages=2|Trim=True |
MultiPage |
Table is in multiple pages |
Apply the rule to the table continued in multiple pages. If Multipage is set to True, then specify NoOfpages in which the table is continued. For example: RT=TR|TO=TD|MultiPage=True|NoOfPages=2|Trim=True |
TCol |
Table Column |
Define a rule to extract data from the selected columns in a table. |
CheckBoxRule (CB)
Keyword |
Stands for |
Used to |
---|---|---|
IsRightToChkBox |
Is right to check box |
Extract the content on the right-hand side to the check box. For example: RT=CB|TO=TD|Attr=Property_Name|ISRightToChkBox=True|IsCommon=True|Trim=True |
IsCommon |
Common Attribute |
Apply the attribute to all the matched target objects. For example: RT=CB|TO=TD|Attr=Property_Name|ISRightToChkBox=True|IsCommon=True|Trim=True |