To enable restart of a prematurely completed request, the system provides a restart token in the answer area. The restart token can be either 8 or 16 bytes long. The standard restart token (RESTOKEN) is 8 bytes long and is returned in the CAARESTOKEN field of the answer area. The extended restart token (EXTRESTOKEN) is 16 bytes long and is returned in the CAAEXTRESTOKEN field of the answer area. Requestors that specify IXLCONN ALLOWAUTO=YES must use the extended restart token. Requestors that specify or default to ALLOWAUTO=NO must use the standard restart token.

On the first invocation of any IXLCACHE request, you can optionally specify a RESTOKEN or EXTRESTOKEN of all zeros to indicate that the request is invoked for the first time. If the request completes prematurely, it returns a restart value to the CAARESTOKEN or CAAEXTRESTOKEN field in the answer area of the request. To restart processing, you must specify RESTOKEN or EXTRESTOKEN on the next invocation of the request and reset either RESTOKEN or EXTRESTOKEN with the value returned in the answer area from the previous request. To ensure that you do not alter the intent of the request that completed prematurely, the restarted request needs to specify the same keywords and values as those of the original request (with the exception of RESTOKEN or EXTRESTOKEN which is now the value returned in CAARESTOKEN or CAAEXTRESTOKEN from the original request). The system restarts the request from the point at which it completed prematurely on the original request.

Be sure to process the information from this request before reissuing the request.

When using an extended restart token, users should be particularly aware of the structure instance being processed. For example, if a structure has undergone a system-managed rebuild and the user then specifies the extended restart token returned from processing the original structure, the system returns the reason code IXLRSNCODEBADEXTRESTOKEN. An appropriate action to take when this situation occurs would be to start the process again with an EXTRESTOKEN of zero.