Naming Policy

Kofax RPA imposes the following naming policy, which applies to project names, schedule names, folder names (paths), and folder items including robots, types, snippets, and resources uploaded through the API.

  • Illegal system characters are allowed, but they generate a warning message.

  • Empty names are not allowed, and they generate an error message.

  • Folder names must be unique.

  • Names that exceed 243 characters are not allowed, and they generate an error message.

  • Names with special HTML formatting are allowed, but they generate a warning. The HTML formatting is removed.

  • Do not use system reserved words, because you cannot save a file with a system reserved name to a disk. For system reserved words check your operating system documentation.

  • Name local is a reserved name and cannot be used in Desktop Automation.

  • Do not use the following reserved keywords in type and variable names to avoid database and other errors. Check your database documentation for a full list of reserved keywords.

    • integer

    • int

    • bigint

    • varchar

    • float

    • null

The use of period "." in file names

You cannot use or create files and folders that start with period "." in Kofax RPA including robots, snippets, types, texts, database (under cluster), and database mapping files.

Table 1. Name Conversion Algorithm
Typed name Result

'<t> aaa </tag>'

Note ' ' denotes the start and end of the string.

'aaa'

Note The HTML tags <t> and </tag> are removed. The space before and after the actual folder/project/schedule name is also removed.

'< t> hello   '

'< t> hello'

Note The tag < t> is kept because it is not a valid HTML tag. The space after the actual name is removed.

'com1 /*** /&#38; &#64;'

'com1/***/& @'

Note Because "com1" is a reserved word for some operating systems, it generates a warning; however, it is a valid name for a folder, project, or schedule. An asterisk "*" is an illegal character. Kofax RPA accepts it as a valid name but generates a warning. Note that entering a name with reserved words and illegal characters can result in errors when other users download the project to local computers where the operating system does not support the names as valid file names.

HTML entity numbers such as &#38; are converted to actual characters.