System Tools Reference Manual for Filenet Image Services
Total Page:16
File Type:pdf, Size:1020Kb
IBM FileNet Image Services Version 4.2 System Tools Reference Manual SC19-3326-00 IBM FileNet Image Services Version 4.2 System Tools Reference Manual SC19-3326-00 Note Before using this information and the product it supports, read the information in “Notices” on page 1439. This edition applies to version 4.2 of IBM FileNet Image Services (product number 5724-R95) and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 1984, 2019. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this manual 17 Manual Organization 18 Document revision history 18 What to Read First 19 Related Documents 19 Accessing IBM FileNet Documentation 20 IBM FileNet Education 20 Feedback 20 Documentation feedback 20 Product consumability feedback 21 Introduction 22 Tools Overview 22 Subsection Descriptions 35 Description 35 Use 35 Syntax 35 Flags and Options 35 Commands 35 Examples or Sample Output 36 Checklist 36 Procedure 36 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 5 Contents Related Topics 36 Running Image Services Tools Remotely 37 How an Image Services Server can hang 37 Best Practices 37 Why an intermediate server works 38 Cross Reference 39 Backup Preparation and Analysis 39 Batches 39 Cache 40 Configuration 41 Core Files 41 Databases 42 Data Dictionary 43 Document Committal 43 Document Deletion 43 Document Services 44 Document Retrieval 44 Enterprise Backup/Restore (EBR) tools 45 Event Log 45 File Manipulation 46 FileNet Software 46 Index Database 47 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 6 Contents Integral Single Document Storage (SDS) 48 Lightweight Directory Access Protocol (LDAP) 49 Logging 50 Memory 50 Messages 50 Microsoft SQL Server Databases 51 MKF Databases 51 MSAR Tools 52 National Language Translation 53 NCH 53 NCH Database 54 Oracle Databases 54 Performance 55 Permanent Database 56 Printing 57 Quick Logging 57 Remote Communications 58 Request Handlers 58 Storage Media 59 Security 60 Security Database 60 Space Use 61 Storage Library Server 61 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 7 Contents System Information 62 Tape and Tape Drives 62 Transient Database 63 Troubleshooting Tools 64 Unified Logon Tools 65 WorkFlo Database 66 Tool Descriptions 67 911 67 add_osvr 126 bes_check 131 bes_clean 138 bes_debug 148 bes_setid 151 check_page 154 checkwrt 158 compressdir 160 cordebug 163 cormon 166 CPT_test 177 cranuser 188 CSM_exim 192 CSM_tool 206 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 8 Contents cstat 248 cti 251 dbp 254 dbverify 257 dclview 264 ddexim 268 deldocs 284 del_osvr 290 dialout 297 docchk 305 doccnt 312 DOC_dumpfb 316 docfetch 326 doctaba_retent_update 335 DOC_tool 339 EBR_clean 392 EBR_genscript 392 EBR_orreset 393 EBR_tdir 393 EBR_ulmk 393 eladisp 394 endbackup 414 enlarge_ncol 416 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 9 Contents export_cdb 423 FileNet System Manager 428 flat 431 fn_edit 461 fn_ldif_xfer 462 fn_msg 478 fn_perm 480 fn_pso_driver 481 fn_pso_podf_admin 483 fn_pso_switch 487 fn_setup 491 fn_util 491 fnddcfg 492 fndev 493 FNL_disp 494 fnlogon 502 gaddr 506 gcp 511 GDBcheckdb 516 GDBdebug 518 GDB_exim 524 get_rdbms 532 getreports 536 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 10 Contents getstamps 545 getstamps32 555 getstatus 567 glogin 586 gls 589 gsh 591 HAnetcheck 593 ident 597 import_cdb 601 initbackup 604 initfnsw 608 INX_cfs_recovery 618 INXdebug 622 INX_export 624 INX_tool 629 ipc_tool 641 ixdb_stat 682 kermit 689 killfnsw 695 ldap_exp 701 LDAP_import 710 LDAP_password 729 less 731 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 11 Contents log_create 735 log_dir 738 log_extract 741 manifest 745 migrate_cdb_changes 748 MKF_ddl 751 MKF_debug 760 MKF_dump 777 MKF_export 795 MKF_fixup 803 MKF_import 809 MKF_order 819 MKF_rename 824 MKF_shutdown 829 MKF_startup 832 MKF_stats 834 MKF_tool 840 MKF_verify 855 MKF_zeroaij 859 MKF_zerobij 862 move_disk 865 msar_io_test 868 msar_sync_test 870 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 12 Contents nch_check 871 nch_flush 884 nch_tool 886 NLT_build_maps 914 ntdm_exp 923 oddump 928 odrecover 974 oraloglist 982 osschk 984 perf_mon 996 perf_report 1010 ppm_log 1070 PPMOI 1072 PRI_tool 1110 QLG_dump 1129 QLG_flush 1132 QLG_start 1134 remove_docs_ref 1139 remove_surf 1150 rollcall 1155 RSEC_imp 1158 SC_convert 1171 sds_convert_nls 1175 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 13 Contents sds_copy 1178 sds_copy_to_surf 1182 sds_hold 1185 sds_import 1188 sds_migr 1191 sds_update_retention 1194 SEC_debug 1198 SEC_imp 1207 SEC_init 1220 SEC_logon_cleanup 1224 SEC_map 1226 SEC_map_ext_auth 1235 SEC_rm_config 1241 SEC_tool 1249 sgs 1269 SNT_update 1280 spacerpt 1286 sqlplus 1299 ssn 1316 st_msar_convert 1317 stamp 1319 stampro 1321 stdoccpy 1324 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 14 Contents stdocimp 1335 stmigrate 1344 stsurfupdate 1349 sync_write_test 1354 sys_log 1362 tapeser 1364 TAP_tool 1368 test_raw_partition 1372 TLIB_tool 1381 uncompressdir 1382 vl 1385 WALSEC_debug 1388 whatsup 1397 WQMpack 1403 WQS_move_q 1409 WQS_tool 1413 WRT_clean 1429 XPR_print 1434 Notices 1439 Trademarks 1443 U.S. Patents Disclosure 1443 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 15 Contents Index 1444 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 16 About this manual The FileNet Image Services System Tools Reference Manual describes system tools you use to diagnose and manage your IBM® FileNet® Image Services (IS) software. Some tools are used only by support personnel whereas many others are used by system administrators to analyze, diagnose, update, and repair Image Services components. This section describes the following: • “Manual Organization” on page 18 • “Document revision history” on page 18 • “What to Read First” on page 19 • “Related Documents” on page 19 • “Accessing IBM FileNet Documentation” on page 20 • “IBM FileNet Education” on page 20 • “Feedback” on page 20 May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 17 About This Manual Manual Organization Manual Organization This manual is divided into the following main sections: • “Introduction” on page 22 lists and briefly describes all the tools in this manual. Tools are listed in alphabetical order. In addition, this section describes the format of the individual tool subsections and the syntax conventions used throughout the manual. • “Cross Reference” on page 39 provides a list of topics and pro- cedures cross referenced by tools. • “Tool Descriptions” on page 67 describes each tool in detail. Tool names appear in alphabetical order. A general tool description is followed by information on when to use the tool, its syntax, sam- ple output and examples, important precautions, and references to related tools and manuals. Document revision history IS version Date Changes 2.0 July 2019 Updated Tool Descriptions > dbverify section 1.0 May 2011 Original version published May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 18 About This Manual What to Read First What to Read First We suggest that you read “About this Manual” (this section) followed by “Introduction” on page 22.” When you have isolated a problem and want to know which tool to use to continue your analysis or problem resolution, refer to “Cross Refer- ence” on page 39. When you have identified the tools you want to use, read the detailed information in “Tool Descriptions” on page 67 Related Documents You might also refer to the following documents as you use the tools to analyze and diagnose your system. Use the information above for ac- cessing the IBM FileNet documentation to find the following docu- ments: System Administrator’s Handbook System Administrator’s Companion for UNIX System Administrator’s Companion for Windows Server System Configuration Overview System Messages Manual Enterprise Backup/Restore User’s Guide Index and WorkFlo Database Contents Manual MSAR Procedures and Guidelines Reference materials provided by your RDBMS vendor (for example, Oracle, IBM DB2®, or Microsoft® SQL Server). May 2011 FileNet Image Services System Tools Reference Manual, Version 4.2 19 About This Manual Accessing IBM FileNet Documentation Accessing IBM FileNet Documentation To access documentation for IBM FileNet Image Services products: 1 On the www.ibm.com web site, enter “Image Services Documenta- tion” in the search box on the menu bar. 2 Select IBM - Product Documentation for FileNet Image Services from the list of search results. IBM FileNet Education IBM FileNet provides various forms of education. Please visit Global Learning Services on IBM’s Web site at (www-306.ibm.com/soft- ware/sw-training/). Feedback We value your opinion, experience, and use of our products. Please help us improve our products by providing feedback or by completing a consumability survey. Documentation feedback Send comments on this publication or other IBM FileNet Image Ser- vices documentation by e-mail to [email protected]. Be sure to include the name of the product, the version number of the product, and the name and part number of the book (if applicable). If you are commenting on specific