Product Documentation
Abstract
This page provides information on the new filters and a new command added in the CSM_tool.
Content
- lock - list all locked objects
- temp - list temporary locked objects where page=65535
- notemp - list locked objects where page = 0 – 1000 and exclude temporary objects
Listobjects
[<object range>] [FOR <count>] [lock] [temp] [notemp] [desc]
Examples of the commands
To list all locked page cache objects not including temporary object, use the following command. The page_cache id=1.
<CSM_tool>l 1 lock notemp
| cache_id | ssn | object_id | page | max_length |
| -------- | -------- | -------- | -------- | -------- |
| 1 | 93947170 | 2000434212 | 0 | 472 |
| 1 | 93947170 | 2000434212 | 1 | 620888 |
| 1 | 93947170 | 2000458647 | 0 | 168 |
| 1 | 93947170 | 2000458647 | 1 | 1277217 |
| 1 | 93947170 | 4160000000 | 1 | 116736 |
To list all temporary page cache objects use the following command. The page_cache id=1.
<CSM_tool> l 1 temp
| cache_id | ssn | object_id | page | max_length |
| -------- | -------- | -------- | -------- | -------- |
| 1 | 93947170 | 2000458652 | 65535 | 620888 |
| 1 | 93947170 | 2000458654 | 65535 | 620888 |
To list all locked page cache objects including temp, non-temp (valid document ID page 0-1000) locked and FBC, use the following command. The page_cache id=1.
<CSM_tool> l 1 lock
| cache_id | ssn | object_id | page | max_length |
| -------- | -------- | -------- | -------- | -------- |
| 1 | 93947170 | 2000434212 | 0 | 472 |
| 1 | 93947170 | 2000434212 | 1 | 620888 |
| 1 | 93947170 | 2000458647 | 0 | 168 |
| 1 | 93947170 | 2000458647 | 1 | 1277217 |
| 1 | 93947170 | 2000458652 | 65535 | 620888 |
| 1 | 93947170 | 2000458654 | 65535 | 620888 |
| 1 | 93947170 | 4160000000 | 65535 | 116736 |
Using the DELETEobject command with lock, temp, and notemp filters
- The allowupdates must be invoked prior to the delete command
- List the temporary object to a file
- Delete the objects
Specify the page cache ID. In case of a combine server system, page_cache_id is equal to 1.
After entering the delete command, a prompt appears:
“'y' / 'CR' = yes, 'a' = yes to all, 'x' / 'q' = exit, all others = no”
Enter “a” to delete all temporary objects:
<CSM_tool>allowupdates
Password?
Updates now allowed
<CSM_tool>ha /tmp/list_delete_temp_obj
Outputting to file '/tmp/list_delete_temp_obj' and the terminal
<CSM_tool>pag
Paging is now OFF.
<CSM_tool>delete 1 temp
Delete object 1:93947170:2100001257:65535 ?
'y' / 'CR' = yes, 'a' = yes to all, 'x' / 'q' = exit, all others = no a
| cache_id | ssn | object_id | page | max_length | |
| -------- | -------- | -------- | -------- | -------- | |
| 1 | 93947170 | 2100001257 | 65535 | 620888 | deleted |
| 1 | 93947170 | 2100001258 | 65535 | 110628 | deleted |
| 1 | 93947170 | 2100001259 | 65535 | 1075946 | deleted |
| 1 | 93947170 | 2100001260 | 65535 | 37226 | deleted |
| 1 | 93947170 | 2100001261 | 65535 | 105542 | deleted |
| 1 | 93947170 | 2100001262 | 65535 | 83794 | deleted |
| 1 | 93947170 | 2100001263 | 65535 | 29419 | deleted |
| 1 | 93947170 | 2100001264 | 65535 | 366698 | deleted |
| 1 | 93947170 | 2100001265 | 65535 | 71185 | deleted |
| 1 | 93947170 | 2100001266 | 65535 | 581744 | deleted |
Number of cache objects deleted 10 temp, skipped objects=0
<CSM_tool>q
Using page0
<CSM_tool>page0
cache_id [1]:
ssn [93947170]:
doc_id:2000434212
Doc hdr length: 472
check_word....0xad0cde5c format.................1
num_pages..............1 total_sectors..........0
doc_id..........2000434212 system_id.......93947170
doc_location...........0 alt_surf_ssn...........0
annot_base_doc.........0 alt_doc_loc............0
annot_page_num.........0 alt_surf_id............0
doc_type............0x00 key_info_len.........344
class_name_len.........9 sec_rd_nm_len..........9
sec_wrt_nm_len.........9 sec_exe_nm_len.........9
contig_sectors.........0 back_contig............0
checksums..............1 character_set.........11
deleted................0
cluster_id................0x0000000000000000
class_name................'ecs_ebr3'
sec_rd_name.....'(ANYONE)'
sec_wrt_name....'(ANYONE)'
sec_exe_name....'(ANYONE)'
Key type=2(str) Key name='F_DOCFORMAT' len=11
Key value='image/jpeg;name="Tulips.jpg"' len=28
Key type=2(str) Key name='F_DOCLOCATION' len=13
Key value='sample data' len=11
Key type=1(FN #) Key name='number4' len=7
Key value='9999 (8041270f 0 0 0)' len=16
Pg...1 Sector#........0 Byte_offset....0 #Bytes..620888
Pg...0 Checksum..0x00000000 Pg...1 Checksum..0x9fa27497
Help statements in CMS_tool
Listobjects
[<object range>] [FOR <count>] [lock] [temp] [notemp] [desc]'
- Lists the specified objects, or for a specified number of objects
from the specified object, or from the first object of the object
range, in ascending or descending order.
<object range> is [<cache_id> [<ssn> [<object_id> [<page>]]]]
or <cache_id> '-' [<cache_id>]
or <cache_id> <ssn> '-' [<ssn>]
or <cache_id> <ssn> <object_id> '-' [<object_id>]
or <cache_id> <ssn> <object_id> <page> '-' [<page>].
specified range level (that is, cache id, ssn, object id, or page level)
is assumed.
The values for the range can be in ascending or descending order.
If both object range and FOR phrase are specified, the FOR count
supersedes the object range in determining the number of objects.
If object range is not specified, listing starts from the first or
last object for ascending or descending order, respectively.
- lock filter option only list locked cache objects
- temp filter option only list temp cache objects page=65535
- notemp filter option only list none temp cache objects page=0-1000
- temp and lock or notemp and lock can be used together
- temp and notemp cannot be used together
Additional information about cache objects
- The first type of cache object is a permanently locked object in cache because “no migrate” is set in Document Class (DCL) or there may be other reasons such as Mode 1 document being used with NLS storage. Another reason is that the write_request may have been removed and Image Services is recycled before the document has been stored to storage.
- The second type of locked cache objects is temporary cache objects. These are objects created by the client with page number=65535 and the client normally attempts to assemble 1 to 1000 temporary image pages into a single document. Once that is done successfully the page numbers of cache objects change from 65535 to a valid page number (1 to 1,000).
If these temporary objects are created and the client is interrupted prior to committal completion, or if there is an error during committal and the client does not clean up the temporary object(s) then they will be locked indefinitely.
An example seen at various customer sites is when a client attempts to create a document of over 1000 pages. An error is returned from the Image Services document committal API, and if the client does not clean up the 1000 plus pages, these temporary cache objects containing images stay in cache indefinitely.
These temporary objects are not associated with an Image Services document. There are no entries in the DOCS or DOCTABA table and there is no meta-data stored in the system (no page 0 in cache). It is possible to dump these temporary objects to files with the “OB” CSM_tool command.
- The third type is the new document type and these are locked objects waiting to be migrated to storage (that is, MSAR or ISDS Centera). Once written to configured storage, the cache objects will become ageable. There is a request stored in Transient MKF write_request table that is associated with this locked object so that if Image Services is recycled the write request will be resubmitted in shared memory. The write request entry is also deleted once the document has been migrated to storage.
- The fourth type of cache object is the Fast Batch Committal (FBC) object and it has not been written to storage, once migrated to storage the FBC object and write_request entry will be deleted.
Document Location
Worldwide
Was this topic helpful?
Document Information
Modified date:
17 June 2019
UID
ibm10875780