Error codes have the form XXX-YYYYY where the prefix XXX specifies the component or category of the error and YYYYY specifies an error code number with leading zeros.
Error codes with corresponding error situations for the web service methods are also documented in the Web service reference [WS IS].
Typical error scenarios, that have been observed in customized environments, are summarized in chapter Troubleshooting and FAQ.
The following table lists the available prefixes which can occur in error codes:
|
Prefix |
Exception |
Referring to |
|---|---|---|
|
AC |
ArchiveConfigurationException |
configuration of storage archives |
|
ADM |
SystemAdministrationException |
configuration of the system |
|
ARC |
ArchiveException |
access of storage archives |
|
ARM |
ARMException |
Archive Recovery Management |
|
AT |
AuditTrailException |
audit trails |
|
ATO |
AutoRecoverException |
auto recovery feature of ARM |
|
BAT |
BatchException |
batch handling (e.g. in FIS) |
|
CFG |
ConfigurationException |
configuration |
|
CON |
ConditionException |
conditions on retention plans |
|
DOC |
DocumentException |
handling of documents and revisions |
|
DTY |
DocumentTypeException |
handling of document types and attributes |
|
DUP |
DuplicationException |
duplication service used in migration scenarios |
|
FLD |
FolderException |
document folders |
|
FSP |
SearchProviderException |
full-text search |
|
IE |
InternalException |
unexpected or invalid states of the system |
|
INS |
InstallerException |
system setup |
|
JOB |
JobException |
asynchronous job system |
|
LIC |
LicenseViolationException |
license violations |
|
LS |
LicenseException |
reading and parsing the license file |
|
|
MailException |
mail subsystem for sending notifications |
|
PCC |
PasswordCheckerConfigException |
password checker |
|
PERM |
PermissionDeniedException |
missing rights and permissions |
|
PR |
PropagationException |
propagation of retention protection to third-party storage |
|
PWC |
PasswordComplexityException |
password requirements |
|
PWM |
PasswordManagerException |
password manager |
|
QL |
QueryException |
query language errors (in RAQL) |
|
QRY |
RuntimeQueryException |
query language errors detected at runtime, such as type errors |
|
RDBMS |
RDBMSException |
database (Relational Database Management System) |
|
REN |
RenditionException |
rendition of documents in the client |
|
REST |
RestException |
REST web services |
|
RPC |
RpcException |
remote procedure calls |
|
RRM |
RightsException |
rights and roles |
|
RTN |
RetentionException |
retention management operations |
|
SC |
SearchException |
document search |
|
SCRIPT |
ScriptingException |
execution of internal scripts |
|
SIG |
SignatureException |
Signature Service |
|
TEN |
TenancyException |
multi-tenancy |
|
TIM |
DateTimeException |
invalid or wrong date and time formats |
|
USR |
UserlibException |
user management |
|
VAL |
ValidationException |
internal validations |
|
WF |
WorkflowException |
Business Process Management |
|
WS |
WebServiceException |
web service errors |
The following errors are independent of the specific Web service operation and are therefore not mentioned in the specification of the individual operations:
|
Code |
Name |
Reason |
|---|---|---|
|
DOC-00039 |
PLAN_EXECUTION_ERROR |
Execution of a retention plan failed. Operations that create, modify or delete documents or revisions may cause the execution of a retention plan. If the execution fails, this error is returned. |
|
IE-00001 |
ILLEGAL_STATE |
Unexpected system state is observed. |
|
IE-00002 |
ILLEGAL_ARGUMENT |
Method call with unexpected or invalid arguments is detected. |
|
IE-00003 |
NOT_IMPLEMENTED |
The method is not implemented. |
|
IE-00004 |
NOT_SUPPORTED |
The method is not supported. |
|
IE-00005 |
INTERNAL_ERROR |
An internal error occured. |
|
LIC-08001 |
LICENSE_VIOLATED |
The license does not allow the operation. |
|
PERM-08000 |
PERMISSION_DENIED |
The current role does not have enough permissions to carry out the operation or read the specified object. |
|
REST-00006 |
UNKNOWN_ROLE |
The REST operation was called with an unknown role in the header. |
|
REST-00007 |
NO_ROLES |
The REST operation was called without specifying a role in the header. |
|
REST-00026 |
UNKNOWN_USERGROUP |
The REST operation was called with an unknown group in the header. |
|
RRM-00012 |
ROLE_UNKNOWN |
The SOAP operation was called with an unknown role in the header. |
|
RRM-00013 |
GROUP_UNKNOWN |
The SOAP operation was called with an unknown group in the header. |
|
RRM-00021 |
EMPTY_ROLE_GROUP_HEADER |
The SOAP operation was called without specifying a role or group in the header. |
|
TEN-01000 |
UNKNOWN_TENANT |
The operation was called with a tenant header referencing an unknown tenant. |
|
TEN-00999 |
DISABLED_TENANT |
The operation was called with a tenant header referencing a disabled tenant. |
|
WS-00009 |
DUPLICATE_BATCH_ID |
The batchId header was present multiple times. |
|
WS-00015 |
ATTACHMENT_NOT_FOUND |
An expected SOAP attachment with binary data was not found. |
|
WS-08002 |
INVALID_ID |
A UUID was specified with invalid syntax. |
The following table lists error codes that are common among multiple prefixes. They will be replaced by the specified individual error types in the future:
|
Code |
Name |
Use |
|---|---|---|
|
IE-09000 |
InternalException |
Invalid system state or unexpected arguments to a method call are observed. |
|
LIC-08001 |
LicenseViolationException |
The license does not allow the operation. |
|
PERM-08000 |
PermissionDeniedException |
Rights to carry out the operation are missing. |
These error codes only give an overview of some common codes. For comprehensive overview see [Error DB].