KB-1107 How to find descriptions for APNX error codes in Appian

This article includes instructions on how to find a description message for Appian APNX error codes.

There are ErrorCode properties files which exist out-of-the-box in Appian that contains all the various APNX error codes, and the description messages for these error codes. There are multiple ErrorCode properties files that exist for multiple languages, such as French, Japanese, and more.

These various ErrorCode properties files are located in <APPIAN_HOME>/ear/suite.ear/resources/text/java/com/appiancorp/suiteapi/common/exceptions.

In this location, open up one of the ErrorCode properties files with the language you prefer to see the various APNX codes and their descriptions. Once the properties file is opened, using a simple Find operation (CTRL+F in Windows) with your APNX code should take you to the line that contains both the error code and the description.

For example, opening up ErrorCode_en_US.properties, one can see the APNX error codes and descriptions in English (United States). Some descriptions have escaped unicode characters such as:

APNX-1-4198-018=Invalid chart color \u201C{0}\u201D. A chart color must be one of the following values\: {1}

\u201C and \u201D are escaped values that denote a particular unicode character. Using a unicode translator, which can be found with a simple internet search engine, one will find that \u201C and \u201D correspond to left quotation and right quotation marks respectively.

Therefore, the full description after translation would be:

APNX-1-4198-018=Invalid chart color "{0}". A chart color must be one of the following values\: {1}

Referring to this ErrorCode properties file when an Appian error code is encountered may be helpful to get context into what the code is referring to, and perhaps why an error is being presented in the first place.

Affected Versions

This article applies to all versions of on-premise installations of Appian. Cloud installations should contact Appian Technical Support for additional details on error codes.

Last Reviewed: February 2017

Related
Recommended