ReportCaster API Subroutine Messages

In this section:

A ReportCaster API subroutine called by a procedure provides a return code that indicates whether or not a subroutine completed successfully.

The last argument passed to a ReportCaster API subroutine is always the format of the return code ('I4'). The value of the return code is supplied by the subroutine upon execution, and returned to the calling procedure so that the user may perform error handling. A return code of zero (0) means that the subroutine completed successfully.

ReportCaster supplies three procedures that translate return codes into messages. Each procedure is associated with a specific ReportCaster API subroutine. The procedures provide the user with a helpful message. For example, the return code -3 is translated into the following message: The password is not valid.

On Windows, the following translation procedures are located in EDAHOME\catalog:

Messages can be written to a log file using a FILEDEF command to establish a permanent file location. For more information about the FILEDEF command, see the Developing Reporting Applications manual.


Top of page

x
DSTRUNER (DSTRUN Return Codes)

The following is the translation procedure DSTRUNER, which includes all return codes and messages for the DSTRUN subroutine.

-SET &ERRMSG=DECODE &SUBERR(
- 1     '1 - This is not a valid host'
- 2     '2 - The userid is not valid'
- 3     '3 - The password is not valid'
- 4     '4 - VXLOAD error'
- 5     '5 - TCPH CRT error'
- 6     '6 - HTTP CRT error'
- 7     '7 - HTTP open error'
- 8     '8 - HTTP post error'
- 9     '9 - HTTP read error'
- 10   '10 - Argument Error'
- 11   '11 - Servlet Execution Error'
- 101 '101 - Failed to connect to the Distribution Server.'
- 102 '102 - No WebFOCUS user logged on.'
- 103 '103 - The schedule ID is missing.'
- 104 '104 - A Priority has not been specified.'
- 105 '105 - Configuration error.'
- 106 '106 - Unknown action.'
- 107 '107 - Necessary field(s) not defined.'
- 108 '108 - The Distribution Server is unavailable.'
- 109 '109 - Unable to connect to the database.'
- 110 '110 - There are no pending Job(s).'
- 111 '111 - System error.'
- 112 '112 - Specify EITHER Job Description or Schedule Id - NOT both.'
- 113 '113 - IBIB priority must be a number between 1-5.'
- 114 '114 - Error sending run immediate request to scheduler.'
- 116 '116 - Job scheduled for execution.'
- 117 '117 - Unable to queue job for execution.'
- 118 '118 - You must log in to the remote console.'
- 119 '119 - The schedule ID is not in the Queue.'
- 120 '120 - The schedule ID must be entered.'
- 121 '121 - The schedule priority must be entered.'
- 122 '122 - Priority is not correct. Select a number between 1 and 5.'
- 123 '123 - The requested action is unrecognized.'
- 124 '124 - No output from remote console. Is Dist.Server active?'
- 125 '125 - The field has an error.'
- 126 '126 - Internal Error.'
- 127 '127 - No Query Parameter.'
- 128 '128 - User not authorized for query. No cookie information.'
- 129 '129 - Distribution list not specified.'
- 130 '130 - Value is missing.'
- 131 '131 - IBI_user is missing.'
- 132 '132 - Destination is missing.'
- 133 '133 - Function undefined.'
- 134 '134 - Sql method error.'
- 135 '135 - Userid undefined.'
- 136 '136 - Unable to update the database.'
- 137 '137 - Insufficient privileges.'
- 138 '138 - Address already exists in the target list.'
- 139 '139 - Address does not exist in the target list.'
- 140 '140 - Distribution list owner not defined.'
- 141 '141 - Distribution list not specified.'
- 142 '142 - Distribution method undefined.'
- 143 '143 - Function not specified.'
- 144 '144 - Access (public/private) not defined.'
- 145 '145 - List of recipients not provided.'
- 146 '146 - Enter either file or recipient information (not both)'
- 147 '147 - File does not exist or the data is incorrect.'
- 148 '148 - Distribution data error.'
- 149 '149 - No data in the file.'
- 150 '150 - The distribution list is not in the database.'
- 151 '151 - Sql method error.'
- 152 '152 - Userid undefined.'
- 153 '153 - IBIB_user must be specified.'
- 154 '154 - Failed to read the config file ibidir.wfs from WebFOCUS.'
- 155 '155 - Failed to read host name of Dist. Server from WebFOCUS.'
- 156 '156 - Failed to read port number of Dist. Server from WebFOCUS.'
- 157 '157 - Failed to test JDBC and WebFOCUS Server connections.'
- 158 '158 - Failed to read the resource files from WebFOCUS.'
- 159 '159 - Failed during Job Description verification.'
- 160 '160 - Unable to save schedule. Job Description already exists.'
- 161 '161 - Unable to update schedule. Another user has deleted it.'
- 162 '162 - Unable to update address book.Another user has deleted it.'
- 163 '163 - User specified is not in the database.'
- 164 '164 - Unable to update log report. Another user has deleted it.'
- 165 '165 - Unable to delete schedule. Another user has deleted it.'
- 166 '166 - Unable to delete address book.Another user has deleted it.'
- 167 '167 - Unable to delete user. The user is not in the database.'
- 168 '168 - Unable to delete log report. Another user has deleted it.'
- 169 '169 - Unable to save schedule. Another user has created it.'
- 170 '170 - Unable to save address book. Another user has created it.'
- 171 '171 - The user already exists in the database.'
- 172 '172 - Unable to save log report. Another user has created it.'
- 173 '173 - Unable to open schedule. Another user has deleted it.'
- 174 '174 - Unable to open address book. Another user has deleted it.'
- 175 '175 - Unable to open user. Another user has deleted it.'
- 176 '176 - Unable to open log report. Another user has deleted it.'
- 177 '177 - Field limits and character limits are violated.'
- 178 '178 - Invalid Start Date.'
- 179 '179 - Invalid Start Time.'
- 180 '180 - Invalid End Date.'
- 181 '181 - Invalid End Time.'
- 182 '182 - Schedule ID must be entered.'
- 183 '183 - The schedule does not exist for the specified user.'
- 184 '184 - Unable to connect to ReportCaster Repository Server.'
- 185 '185 - Unable to connect to WebFOCUS Reporting Server.'
- 186 '186 - Record has already been added.'
- 187 '187 - Record has already been deleted.'
- 188 '188 - Record has already been updated. Resubmit transaction.'
- ELSE '  ');

Top of page

x
DSTMEMER (DSTMEM Return Codes)

The translation procedure DSTMEMER includes all return codes and messages for the DSTMEM subroutine. These return codes are exactly the same as for DSTRUN, except that the codes are in the 200 range instead of 100. For example,

The following is a return code for DSTRUN:

- 137 '137 - Insufficient privileges.'

The following is a return code for DSTMEM:

- 237 '237 - Insufficient privileges.'

Top of page

x
DSTBLKER (DSTBULK Return Codes)

The translation procedure DSTBLKER includes all return codes and messages for the DSTBULK subroutine. These return codes are exactly the same as for DSTRUN, except that the codes are in the 300 range instead of 100. For example,

The following is a return code for DSTRUN:

- 137 '137 - Insufficient privileges.'

The following is a return code for DSTBULK:

- 337 '337 - Insufficient privileges.'

WebFOCUS