Appendix E: Client Exit Codes
When the Databridge Client terminates with an error, an exit code appears
in the last_run_status column of the DATASOURCES Client control table.
The value 9999 indicates that the last run status is no longer available
(typically when dbutility is running). These status messages apply to only the process and clone commands.
The Client exit codes are listed with the associated error recovery retries.
-
Service Retries: In response to the noted exit codes, the service's error recovery retries a process command
max_retriestimes, as specified in the data source section ofdbcontrol.cfg. The default is 3 times with a 5-second delay between retries.A
foreverrecovery retries indefinitely. -
dbutility Retries: A limited number of exit codes cause the command line client (dbutility) to retry a process command rather than exit. The default is 3 times.
Note
- 8-bit exit code: On UNIX, exit statuses are restricted to 8 bits (a range of 0 to 255). The Client uses the exit status specified in the 8-bit Exit Code column instead of the actual code, which is longer than 8 bits. This affects only shell scripts that test the exit status.
| Exit Code | 8-bit Exit Code | Description | Service Retries | dbutility Retries |
|---|---|---|---|---|
| 0000 | Successful | |||
| 0001 | General error | |||
| 0002 | Database reorganized | |||
| 0009 | DBEngine encountered an unexpected end-of-file error while reading the audit file given by afn. | max_retries | 3 | |
| 0011 | An accessory tried to select a data set but gave an invalid audit location. For details, see the Databridge Error and Messages Guide. | max_retries | 3 | |
| 0033 | The DMSII database may have rolled back. If so, roll back the client database as well. For details, see the Databridge Error and Messages Guide. | 3 | ||
| 0092 | The audit trail was discontinued or corrupted. For details, see the Databridge Error and Messages Guide. | max_retries | 3 | |
| 0093 | DBServer STOP TASK encountered. | |||
| 0094 | DBServer STOP TIME limit. | |||
| 1015 | Operator terminated the worker. | |||
| 1135 | Operator terminated DBEnterpris.e | |||
| 1167 | Indicates a problem sending messages on the network. For details, see the Databridge Error and Messages Guide. | max_retries | ||
| 1179 | The value in the audit block size field exceeds the maximum size declared in the DASDL. For details, see the Databridge Error and Messages Guide. | max_retries | 3 | |
| 1180 | DBEnterprise found the ABSN internal check did not match. For details, see the Databridge Error and Messages Guide. | max_retries | 3 | |
| 2001 | 150 | Indicates an error in the command line when invoking the Client. | ||
| 2002 | 151 | The control table check failed Either the Client control tables do not exist or they are not the right version. If the latter, the Client issues a control table version mismatch error; run the dbfixup program. |
||
| 2003 | 152 | The data source is locked, indicating that a Client is currently running If you try to run a process or clone command while a DBClient process command is running, the run returns this exit code.The -u option does not work in this case; you must wait for the run to finish. If the run hangs, terminate the run to release the data source lock. |
max_retries | |
| 2004 | 153 | An error occurred while loading the control tables | ||
| 2005 | 154 | The data source specified on the command line does not exist in the DATASOURCES table | ||
| 2006 | 155 | The process or clone command failed because the DS_Needs_Redefining(8) bit in the status_bits column was set for an active data setThis status indicates that normal operations can be resumed only after a redefine command is executed. |
||
| 2007 | 156 | The Client could not connect to the Databridge Server or to Databridge Enterprise Server either during initialization or data transmission | forever | |
| 2008 | 157 | The clone command failed because one of the data set names specified on the command line is invalid |
||
| 2009 | 158 | A data set has an invalid value in the ds_mode column of DATASETSAny other value causes the Client to abend with this exit code. |
||
| 2010 | 159 | An error occurred while creating or cleaning up a data table at the start of the data extraction phase of a process or clone command | ||
| 2011 | 160 | An error occurred while dropping the index of a data table at the start of the data extraction phase of a process or clone command | ||
| 2012 | 161 | A bad structure index was received | ||
| 2013 | 162 | A system error occurred while attempting to allocate memory | ||
| 2014 | 163 | No active structures were found at the start of a process or clone command |
||
| 2015 | 164 | No active structures remain after a structure was deselected during a process or clone command | ||
| 2016 | 165 | The Client is stopping at the start of the fixup phase because errors occurred during data extraction | ||
| 2017 | 166 | The Client is stopping at the start of the fixup phase because errors occurred during data extraction and index creation | ||
| 2018 | 167 | The Client is stopping at the start of the fixup phase because errors occurred during index creation | ||
| 2019 | 168 | The Client is stopping at the start of the fixup phase because of the defer_fixup_phase parameter setting (or -c option) |
||
| 2020 | 169 | Client operations are being inhibited by the stop_time settingsTo override this situation, specify the -o option on the command line. The applies to only the command line Client (dbutility). |
||
| 2021 | 170 | The console operator issued a QUIT command, which stops the Client at the next quiet pointIf you stop the Client using a DBServer AX QUIT command for the worker or an Enterprise Server Quit command, a different exit code results (1015 for DBServer) and (1135 for Enterprise Server). |
||
| 2022 | 171 | The Client encountered a SQL error while updating the control tables NOTE: Some SQL errors generate an exit code of 2099. |
||
| 2023 | 172 | An error occurred while executing a COMMIT TRANSACTION for the relational database | ||
| 2024 | 173 | An error occurred while executing a ROLLBACK TRANSACTION for the relational database | ||
| 2025 | 174 | The Client is stopping because it finished processing the audit file specified in the stop_afn column of the DATASOURCES tablesDo one of the following:
|
||
| 2026 | 175 | An error occurred in the EBCDIC to ASCII translation | ||
| 2027 | 176 | The command terminated because the Client encountered improperly linked virtual data sets while loading the control tables This status applies only when the configuration file parameter automate_virtuals is set to True. |
||
| 2028 | 177 | The clone command terminated because the operator tried to reclone a data set that is the primary source for the virtual data set without recloning the data set that is the secondary source for the virtual data set This status only applies when the configuration file parameter automate_virtuals is set to True.For example, if the data sets SV-HISTORY (primary source) and SAVINGS (secondary source) provide input to the virtual data set SV-HISTORY-REMAP, you must reclone SAVINGS when you reclone SV-HISTORY. |
||
| 2029 | 178 | The Client discarded records during audit processing Any other fatal error or reorganization indication overrides this exit code. |
||
| 2030 | 179 | The Client was unable to sign on to the relational database To find the cause, locate the corresponding OCI Error in the log file or the log output. |
forever | |
| 2031 | 180 | The process or clone command failed because some records were not loaded during the data extraction phaseWhen the verify_bulk_load parameter is set to 2, the Client compares the number of records loaded to the actual count of records in the table. If these do not match, the program fails with this exit code. If the verify_bulk_load parameter is set to 1, the program doesn't fail and errors are reflected in the final exit code, unless a more serious error occurs and overrides this exit code. |
||
| 2032 | 181 | The process or clone command failed because the DS_Needs_Generating(4) bit in the status_bits column was set for an active data setIndicates that normal operations can only be resumed after a generate command is executed. This exit code can occur from a redefine command when a generate command is required to create scripts for tables in the relational database that were affected by a DMSII reorganization. |
||
| 2033 | 182 | You need to run a reorg command before resuming normal processing You will get this exit code from a redefine command when a reorg command is needed to alter tables in the relational database affected by a DMSII reorganization. Note that a reorg command implicitly does a generate command. |
||
| 2034 | 183 | The Client stopped because a DMSII garbage collection reorganization that affects one or more datasets was encountered during audit file processing and the configuration parameter stop_after_gc_reorg was set to True. |
||
| 2035 | 184 | A clone was aborted by Enterprise Server and the operation was never restarted. This is a special case of a failed clone. |
||
| 2036 | 185 | Client stopped Indicates that the operator issued a dbutility QUIT NOW command or an abort command from the Administrative Console, which stopped the Client by closing the TCP connection to the server. |
||
| 2037 | 186 | A relational database deadlock was detected This error causes the Client to exit. When using dbutility, the program tries to restart the process command 3 times before exiting. When using DBClient, the service automatically retries the process command, as specified by the Error Recovery parameters set for the data source in the service configuration file. |
max_retries | 3 |
| 2038 | 187 | The Client is stopping at the end of the fixup phase because of the stop_after_fixup parameter settingTo resume processing, issue another process command when you are ready. |
||
| 2039 | 188 | The Client is unable to continue because the global working directory specified in the Windows registry or in the UNIX file /etc/Micro Focus/DATABridge/globalprofile.ini cannot be found Even if you do not use the service, before you can run the Client, the working directory (which includes the locks subdirectory) must be created. |
||
| 2040 | 189 | Client encountered an error when trying to open the lock file for the data source Look at the log file or the log output to determine the nature of the error, which might be security related. You must always run the Client using the same user. Failure to do so can result in this error. |
||
| 2041 | 190 | Databridge Client for Microsoft SQL Server is unable to continue because the install directory specified in the Windows registry cannot be found Reinstall the Client using the installer so that the Client can access this directory (and the bcp_auditor program) without having to use the full path. Copying the files from the DVD will result in this exit code. |
||
| 2042 | 191 | The Client command failed because the DS_Needs_Mapping(1) or the DS_Needs_Remapping(4) bit in the status_bits column was set for an active data setIndicates that normal operations can only be resumed after a redefine command is executed. This status typically occurs when you try to run a process or generate command after an error occurs when using the Client Configurator. To fix the problem, rerun the Client Configurator. |
||
| 2043 | 192 | File IO error caused the Client to terminate | ||
| 2044 | 193 | DMSII link improperly set up in the control tables | ||
| 2045 | 194 | Reorg command script in error |
||
| 2046 | 195 | Attempt to refresh stored procedure failed | ||
| 2047 | 196 | The Client abended because of one or more bulk loader errors. | ||
| 2048 | 197 | Client did not find a binary configuration file The DBClient and DBClntCfgServer programs get this exit status when the configuration file is not binary. |
||
| 2049 | 198 | An I/O error occurred while reading the configuration file For details, see error messages in the log. |
||
| 2050 | 199 | Computed checksum does not match the value in the binary configuration fileThis error occurs if you try to patch the file using a hex editor. Use the export command, edit the exported configuration file, and then import it. | ||
| 2051 | 200 | Errors found while processing a text configuration file See the log file for details. |
||
| 2052 | 201 | User_scripts directory not contained within the Client’s working directory when security is enabled Databridge security prevents users scripts from residing outside the Working Directory, as we have no control over such a directory and could therefore be vulnerable to unauthorized users modifying user scripts, which could have rather dire consequences. |
||
| 2053 | 202 | Client encountered an I/O error while trying to write to a discard file This exit status indicates that either the discard file is too large or the machine is running out of disk space. You should periodically clean up the working directory for the Client along with the discards and logs folders. |
||
| 2054 | 203 | Total discards threshold has been reached See the max_discards parameter in Appendix C for details. |
||
| 2055 | 204 | Client encountered an error while trying to update a user table The audit file original for Databridge Enterprise changed. Setting the configuration parameter stop_on_dbe_mode_chg to true causes the Client to stop when the audit file origin changes. |
||
| 2056 | 205 | DBEnterprise audit file origin changed The audit file original for Databridge Enterprise changed. Setting the configuration parameter stop_on_dbe_mode_chg to true causes the Client to stop when the audit file origin changes. |
||
| 2057 | 206 | Client control table version mismatch The Client control tables need to be upgraded before you can resume Client operations. This happens automatically when using the service. However, if you are using the command line Client dbutility, you must manually run dbfixup for a data source in each relational database. |
||
| 2058 | 207 | SQL update took longer than the maximum allowable time specified by the sql_exec_timeout parameterSee Appendix C for details. |
max_retries | |
| 2059 | 208 | Errors found while processing a text configuration file Server connection timed out on max_srv_idle_time setting. |
max_retries | |
| 2060 | 209 | Effective CHECKPOINT FREQUENCY parameters for the Databridge Engine are all 0 The COMMIT parameters are likely set to 0 in the Client configuration file. Rather than attempting to process audit with this setting, the Client stops and gives you a chance to rectify the situation. |
||
| 2061 | 210 | Error in loading a DLL or finding its entry points | ||
| 2062 | 211 | Error in updating control table | ||
| 2063 | 212 | Error creating control table | ||
| 2064 | 213 | Error dropping control table | ||
| 2065 | 214 | Malformed unload file The reload command encountered a malformed unload file and could not complete the operation. |
||
| 2066 | 215 | Error dropping user table | ||
| 2067 | 216 | Control tables are incompatible with DBConfig Run dbscriptfixup to fix this situation. |
||
| 2068 | 217 | Unable to create directory | ||
| 2069 | 218 | Unable to allocate a STMT Try reducing the value of aux_stmts |
||
| 2070 | 219 | Client got an error while attempting to create a file | ||
| 2071 | 220 | User script in error | ||
| 2072 | 221 | Bad DMSII database timestamp This exit status indicates that the DMSII database timestamp does not match the one the Client is using. This is taken to mean that the Client is not using the same DMSII database as it was earlier. |
||
| 2073 | 222 | History table error | ||
| 2074 | 223 | Data source already defined This exit status indicates that the Client is attempting to define a data source that is already defined. |
||
| 2075 | 224 | Index for user table has too many columns | ||
| 2076 | 225 | Mismatched AFNs in control tables The redefine command requires that all active data sets point to the same audit file. |
||
| 2077 | 226 | Protocol Error | ||
| 2078 | 227 | File does not exist | ||
| 2079 | 228 | IO error reading filter file | ||
| 2080 | 229 | Malformed binary filter file | ||
| 2081 | 230 | Bad checksum in binary filter file | ||
| 2082 | 231 | Syntax error in filter source file | ||
| 2083 | 232 | Filter generation failed | ||
| 2084 | 233 | Unsupported table encountered in filter source file | ||
| 2085 | 234 | Data source already exists in relational database | ||
| 2086 | 235 | Running a redefine command after customizing a data source is not recommended | ||
| 2087-2088 | Not currently used | |||
| 2089 | 238 | Client lost connection to database This usually means that the database was taken down without stopping the Client first. The service/daemon recognizes this error and enters its error recovery, which keeps trying to connect every so often, until the database comes back up again. |
forever | |
| 2090 | 239 | Reserved | ||
| 2091 | 240 | Client lost connection to Client Manager service This usually means that the service crashed. |
||
| 2092 | 241 | Connection to the Databridge Server closed by the host or Enterprise Server system The Client is forced to exit. This indicates that the server closed the connection because of an operator command. This exit code indicates that the connection was closed in an orderly manner. |
||
| 2093 | 242 | Connection to the Databridge Server reset by the host or Enterprise Server system The Client is forced to exit. This exit code indicates that the server was forcibly terminated or that it crashed. |
||
| 2094 | 243 | Transport error for connection to server | max_retries | |
| 2095 | 244 | RPC timeout | ||
| 2096 | 245 | Initialization error | ||
| 2097 | 246 | Error processing RPC data | ||
| 2098 | 247 | Communications or protocol error | ||
| 2099 | 248 | Internal error This code is used for all errors that cause the dbread and dbwait callback routine to terminate prematurely. |
||
| 2100 | Abnormal termination - see log for details. | |||
| 9701 | 245 | Encryption DLL not found | ||
| 9702 | 245 | SSL/TLS handshake failed | ||
| 9703 | 245 | Invalid user certificate | ||
| 9704 | 245 | SSL/TLS client failed to find user credentials | ||
| 9705 | 245 | Connection lost due to corrupted message | ||
| 9706 | 245 | Missing a DLL for SSPI | ||
| 9707 | 245 | Missing a DLL for CryptoAPI | ||
| 9708 | 245 | Security.dll not found | ||
| 9709 | 245 | Did not finish encryption handshake with host | ||
| 9710 | 245 | Local SSPI does not support crypto key length | ||
| 9711 | 245 | IP or hostname from server cert does not match connection | ||
| 9712 | 245 | Wrong client OS; no Security Support |
Note
For more detailed information on how exit codes are used in custom programs to automate control of Databridge operations, see dbutility Exit Status Values.