Return codes

Use the return codes that are issued by Collector Server to understand the result of an operation.

The codes are listed in numerical order. Therefore, note the number in parentheses when you receive a return code message.

CS_RC_OK (0)
The operation was completed successfully.
CS_RC_CLOSE_SOCKET (-1)
The corresponding socket is closed. This return code does not mean, however, that an error occurred.
CS_RC_CHILDINIT_FAILED (-3)
The initialization of a Content Collector for SAP child process failed. This return code indicates a start problem of a child process.
CS_RC_CHECKARCHIVE_FAILED (-5)
An agent could not be started because the startup check of the corresponding repository failed.
CS_RC_VERSION_ERROR (-6)
Collector Server does not start because it detected a child process that was created by the wrong version of a program. Replace the program with the correct version.
CS_RC_SHUTDOWN (-99)
Collector Server was shut down by a shutdown request from the archstop program.
CS_RC_SHUTDOWN_NOW (-100)
Collector Server was shut down by an immediate shutdown request from the archstop program.
CS_RC_NOMEM (-110)
A Content Collector for SAP process is running out of memory.
CS_RC_NOTFOUND (-115)
The requested data was not found. See the Collector Server trace file for further details.
CS_RC_ERRDELETE (-116)
The archived document or component cannot be deleted. This error code can also occur when data is appended to a component or when a component is updated.
CS_RC_NOTSUPPORTED (-118)
Content Collector for SAP is unable to carry out the requested operation. Such an operation can be, for example, an index transfer request that was sent to a TSM agent or an invalid action for an update operation.
CS_RC_NOTTEXTSEARCHABLE(-120)
The IBM® Content Manager attribute or item type is not enabled for text search.
CS_RC_VIEWFILTER_USAGEERROR (-125)
A filter that was used to archive only specific documents in an IBM Content Manager item-type subset was used incorrectly. Before Collector Server archives a document, it checks whether the attributes meet the filter criteria that are set in the item-type subset. This check is a logical check. If the criteria are not met, this return code is shown.
CS_RC_FILENOTFOUND (-200)
Content Collector for SAP cannot find a file or a document.
CS_RC_UNKNOWNDOC (-201)
The requested document cannot be found in the repository.
CS_RC_QUERYNOTFOUND (-202)
The document cannot be found in the repository. The query was unsuccessful.
CS_RC_ACCESSDENIED (-203)
You do not have the correct access rights to process the archived document in this way.
CS_RC_DOCEXISTS (-204)
The document cannot be archived because the same document exists in the repository.
CS_RC_ERRCERT (-205)
Content Collector for SAP failed when it tried to use a certificate.
CS_RC_COMPNOTFOUND (-206)
The component to which you want to append data cannot be found in the repository. It probably does not exist.
CS_RC_CONTREP_NOTFOUND (-207)
The logical archive that you specified cannot be found in the server configuration profile.
CS_RC_INVALIDOFFSET (-208)
The offset that is specified for the partial retrieval exceeds the end of the document.
CS_RC_FREESEARCH_NOTFOUND (-210)
The specified pattern cannot be found in a free-search request.
CS_RC_ATTRSEARCH_NOTFOUND (-211)
The specified pattern cannot be found in an attributed-search request.
CS_RC_OK_VERSION1 (-213)
A document was found that was archived with CommonStore for SAP Version 1.
CS_RC_READONLY (-214)
The document cannot be modified in the repository because it was archived with CommonStore for SAP Version 1.
CS_RC_LOGSYS_NOTFOUND (-215)
The DESTINATION section in the server configuration profile does not contain the specified logical system, or it does not contain any logical system at all.
CS_RC_NO_ATTR_ARCHIVED (-216)
The document was archived successfully, but all attributes that are provided in the attribute list were dropped because the repository cannot store them. This message is typically issued by the TSM agent when an archiving request was processed that included additional attributes that were created by Content Collector for SAP.
CS_RC_NOCOPYGROUP (-217)
Content Collector for SAP cannot use the specified Tivoli® Storage Manager management class because of a problem with the copy group.
CS_RC_TRANSFORM_FAILED (-219)
The invocation of the TRANSFORM command failed.
CS_RC_NO_AGENT (-220)
Collector Server received a request for an agent that is not specified in the instance configuration. This request was immediately canceled.
CS_RC_QUEUE_ERROR (-221)
Collector Server cannot queue an asynchronous job on a disk. The job was immediately canceled. The Collector Server instance shuts down because a normal (safe) operation is not possible any more. Check the queue directory before you restart the Collector Server instance.
CS_RC_JOB_NOT_ACCEPTED (-225)
Collector Server is not yet fully initialized and therefore is not ready to process jobs.
CS_RC_SAP_ATTR_NOTALLOWED (-240)
An archiving operation failed because the attribute list in the archiving request contains one of the reserved SAP attributes. Content Collector for SAP creates these attributes automatically. They must not be specified a second time.
CS_RC_SAP_ATTR_MISSING (-241)
Depending on your repository, this return code has one of the following meanings:
  • IBM Content Manager Not all attributes that are required by Content Collector for SAP are defined for the item type.
  • Content Manager OnDemand Not all database fields that are required by Content Collector for SAP are defined for the application group.
  • FileNet P8 Not all properties that are required by Content Collector for SAP are defined for the document class.
CS_RC_FILEOPEN_ERROR (-250)
An error occurred when Collector Server tried to open a file or to request its status.
CS_RC_FILEREAD_ERROR (-251)
An error occurred when Collector Server tried to read data from a file.
CS_RC_FILEWRITE_ERROR (-252)
An error occurred when Collector Server tried to write data to a file.
CS_RC_ADSM_ERROR (-260)
An error occurred in the TSM agent, but the related API call did not fail.
Content Manager OnDemand CS_RC_OD_ERROR (-262)
An error occurred in the OD agent. Check the Collector Server error log file for a description of the error.
CS_RC_ATTR_TOOLONG (-263)
Depending on your repository, this return code has one of the following meanings:
  • IBM Content Manager The value of an attribute too long to be stored in the repository.
  • Content Manager OnDemand The value of a database field too long to be stored in the repository.
CS_RC_ATTR_USAGEERROR (-264)
Depending on your repository, this return code has one of the following meanings:
  • IBM Content Manager An attribute is not used correctly.
  • Content Manager OnDemand A database field is not used correctly.
  • FileNet P8 A property is not used correctly.
CS_RC_ATTR_NOTFOUND (-265)
Depending on your repository, this return code has one of the following meanings:
  • IBM Content Manager An attribute could not be found in the repository.
  • Content Manager OnDemand A database field could not be found in the repository.
  • FileNet P8 A property could not be found in the repository.
CS_RC_CONNECTION_FAILED (-267)
An error occurred when Collector Server tried to log on to the repository.
FileNet P8 CS_RC_P8_ERROR (-268)
An error occurred in the P8 agent. Check the Collector Server error log file for a description of the error.
CS_RC_UNKNOWN_RESOURCE (-270)
The requested resource was not found.
CS_RC_RESOURCE_EXISTS (-271)
The resource exists.
CS_RC_UNKNOWN_COLLECTION (-272)
The requested collection was not found.
CS_RC_UNKNOWN_PARENTCOLLECTION (-273)
The parent collection of the requested resource was not found.
CS_RC_COLLECTION_EXISTS (-274)
The collection exists.
CS_RC_TOO_MANY_HITS (-275)
Too many matching resources were found in the repository. Only one match is expected.
CS_RC_CONFLICT (-277)
An attempt was made to modify or delete a protected resource.
CS_RC_HTTP_REQUEST_WRONG_VERSION (-500)
The HTTP request that was sent to the web dispatcher contained a newer version. This request is not yet supported by the current web dispatcher.
CS_RC_HTTP_REQUEST_WRONG_METHOD (-501)
The HTTP request that was sent to the web dispatcher contained a wrong HTTP method.
CS_RC_HTTP_REQUEST_MISSING_PARAMETER (-502)
The HTTP request that was sent to the web dispatcher did not contain all mandatory parameters or these parameters were empty.
CS_RC_HTTP_REQUEST_MISSING_ENTITY (-503)
The HTTP request that was sent to the web dispatcher did not contain a body.
CS_DO_WRONG_SEARCHATTR (-1003)
The search attribute pattern is incorrect.
CS_DO_ARCHIVELIST_EMPTY (-1004)
A search operation failed because the list of archive IDs is empty.
CS_DO_FOLDER_ISEMPTY (-1006)
The folder operation cannot be completed because the folder is empty.
CS_BC_RFC_ERROR_TABLE (-7096)
The creation of the Open Barcode table failed. Content Collector for SAP was unable to send the bar codes to SAP.
CS_BC_RFC_ERROR_INSERT (-7097)
The bar codes could not be sent to SAP because the remote function call ARCHIV_BARCODE_INSERT_RFC or BAPI_BARCODE_SENDLIST failed.
CS_BC_RFC_ERROR_CONNECTION (-7098)
Collector Server could not establish a connection with SAP. The remote function call ARCHIV_BARCODE_INSERT_RFC or BAPI_BARCODE_SENDLIST could not be carried out. No bar codes were sent to SAP.
CS_BC_RFC_NO_DATA_TO_SEND (-7099)
The Open Barcode table is empty. Thus, the bar codes cannot be sent to SAP.
CS_RC_BC_ARCHIVE_FAILED (-7100)
The request to archive and send bar codes failed because the archiving operation failed. No bar codes were sent to SAP.
CS_RC_CWI_R3_CONNECTION_ERROR (-7201)
The request to create a work item failed because Collector Server could not connect to SAP.
CS_RC_CWI_R3_FAILED (-7202)
SAP returned an error when it received the request to create a work item.
CS_RC_CWI_ARCHIVE_FAILED (-7203)
A work item could not be created because the archiving operation failed. The request to create a work item was not sent to SAP.
CS_RC_SOCKET_PROBLEM (-10000)
A problem occurred with the socket communication in Content Collector for SAP. See the Collector Server trace file for further details.
CS_RC_NO_HANDLER (-10001)
A Content Collector for SAP process received a request for which a message handler was not installed.
CS_RC_INTERNAL_ERROR (-10002)
An internal error occurred in Content Collector for SAP or in the socket communication. See the Collector Server trace file for further details.
CS_RC_WRONG_TYPE (-10003)
The parser detected a wrong data type when it received a message over a socket.