Name conventions
This section describes the name convention used for different items in the TotalAgility and Transformation designers.
Transformation Designer
-
The names of classes, folders, training folders, fields, formatters, locators, locator subfields, Document Review scripted rules and validation rule can only contain the following characters:
-
ABCDEFGHIJKLMNOPQRSTUVWXYZ
-
0123456789_
Note A name cannot have numbers as the first character. -
abcdefghijklmnopqrstuvwxyz
-
áàâóòôúùûéèêíìî
-
äöüÄÖÜß
-
ÁÀÂÓÒÔÚÙÛÉÈÊÍÌÎ
-
-
The names of any items such as classes, folders, or training folders cannot contain the following characters:
-
\ / : * ? < > |
-
space
-
TotalAgility Designer
This section describes the name conventions for the items in TotalAgility Designer.
Name of a form
-
A form name cannot contain the following characters.
\\ ? / : * " < > | % # & ( ) + $ £ € ^ - { } [ ] @ ~ _ , ! ¬ ` -
A form name cannot contain the following keywords, as these keywords are reserved for the Windows operating system.
AUX COM1 COM2 COM3 COM4 COM5 COM6 COM7 COM8 COM9 CON CLOCK$ LPT1 LPT2 LPT3 LPT4 LPT5 LPT6 LPT7 LPT8 LPT9
Name of a document type
The name of a document type cannot be more than 80 characters when the document form is being dynamically generated at runtime. If you want a document type name with more than 80 characters, you must manually create the document form in TotalAgility Designer and then assign it to the extraction group.
ID of a folder and document type field
A folder field must conform to the following conventions.
-
Cannot be empty.
-
Should be unique.
-
Cannot start with a number.
-
The maximum length is 30.
-
The ID cannot contain the following special characters.
| \\ | ? | / | : | * | " | < | > | | | % |
| # | & | ( | ) | + | $ | £ | € | ^ | - |
| { | } | [ | ] | @ | ~ | . | , | ! | ' |
Display name of a folder and document type field
A display name must conform to the following conventions:
-
Cannot be empty.
-
Allows duplicate names.
-
Can start with a number.
-
The maximum length is 50 characters.
-
The display name can contain the following special characters.
\\ ? / : * " < > | % # & ( ) + $ £ € ^ - { } [ ] @ ~ . , ! '
ID of a process or server variable
A process or server variable must conform to the following conventions:
-
Cannot be empty.
-
A process variable ID cannot be the same as a system variable ID.
-
The maximum length is 30.
-
The ID cannot contain the following special characters.
\\ ? / : * " < > | % # & ( ) + $ £ € ^ - { } [ ] @ ~ . , ! '
Display name of a process or server variable
A process or server variable must conform to the following conventions:
-
Cannot be empty.
-
The display name of a process variable cannot be the same as that of a system variable.
-
The maximum length is 50 characters.
-
The display name can contain the following special characters.
\\ ? / : * " < > | % # & ( ) + $ £ € ^ - { } [ ] @ ~ . , ! '
Display name of a form variable
A form variable must conform to the following conventions.
-
Cannot be empty.
-
Allows alphabets, numbers and underscore.
-
There is no limit to maximum length.
Note A form variable does not have an ID.
User name and display name of a resource
A resource name must conform to the following conventions:
-
The user name of a resource cannot be more than 56 characters.
-
The display name of a resource cannot be more than 40 characters.