Page 3 - Toolkit; Version
IBM FileNet Image Services Toolkit Developer Reference Manual Version 4.1.1 GC31-5560-00
Page 5 - TABLE OF CONTENTS
+++ IMAGE SERVICES TOOLKIT (ISTK) DEVELOPER REFERENCE MANUAL +++ TABLE OF CONTENTS 0. REVISION HISTORY ................................................... 1 1. INTRODUCTION ....................................................... 2 2. CONFIGURATION NOTES .................................................
Page 17 - By default ISTK is installed into the following directory path:
+++ IMAGE SERVICES TOOLKIT (ISTK) DEVELOPER REFERENCE MANUAL +++ tms 32768/tcp cor 32769/tcp nch 32770/udp (If you are installing on a system already running the FileNet(R) IMS, these entries should already exist.) Any host running the FileNet IMS that the ISTK applications will communicate with sho...
Page 22 - System event/error logs
+++ IMAGE SERVICES TOOLKIT (ISTK) DEVELOPER REFERENCE MANUAL +++ wal_ipc -A Be careful not to use the lower-case 'a' option, as this will not give the desired results. System event/error logs When any of the ISTK libraries encounter an error, they generate what is known as a sys_log entry (system lo...
Page 23 - Output to stderr can be turned off by creating the file:
+++ IMAGE SERVICES TOOLKIT (ISTK) DEVELOPER REFERENCE MANUAL +++ UNIX: WAL_ROOT/tmp/syslog.txt Example: /fnsw/client/tmp/syslog.txt Note: Writing to the ISTK sys_log file can be tested by running the wal_ipc tool. When this tool is executed, it automatically creates an "information-only" mes...
Page 24 - Windows Shared Memory Conflicts
+++ IMAGE SERVICES TOOLKIT (ISTK) DEVELOPER REFERENCE MANUAL +++ /walproduct/shobj Next the platform's shared library lookup variable must be set. On HPUX this is SHLIB_PATH while on Solaris this is LD_LIBRARY_PATH. NOTE: Remember, this option is only available to HPUX and Solaris platforms. setenv ...
Page 37 - /* The following declarations identify types of batches according
+++ BES - Batch Entry Services +++ 6. BES DECLARATIONS /*************************************************************************** * * BES.intf.hdr * ****************************************************************************/ /* * Batch Entry Services provides its clients with batch-oriented * do...
Page 103 - CKS abstract interface
+++ CKS - Checksum Services +++ 8. CKS DECLARATIONS /********************************************************************* CKS abstract interface *********************************************************************/ #ifndef CKS_defs #define CKS_defs #ifndef AS_externals_h #include <AS_externals....
Page 105 - CSM DECLARATIONS
+++ CSM - Cache Service Manager +++ 10. CSM DECLARATIONS /* This is the interface description for the cache services manager abstract (CSM). This abstract supplies transparently remotable calls used to create, open, close, delete, read, write, enumerate, copy, move and retrieve or update attributes ...
Page 119 - no error will be returned.
+++ CSM - Cache Service Manager +++ no error will be returned. ERRORS: CSM_no_permission CSM_already_exists CSM_object_busy CSM_invalid_checksum CSM_invalid_object_desc */ 11.8. CSM_create_object error_typ CSM_create_object(handle, attr_p, object_p, oh_p) ASE_session_number_typ handle; /* IN: cache ...
Page 120 - Operations on cache objects
+++ CSM - Cache Service Manager +++ The object is visible prior to the close and can be found with CSM_get_object_attributes or CSM_find_objects, and will cause a CSM_already_exists or CSM_refcnt_incremented error on a CSM_create_object call which attempts to create a duplicate. CSM_open_object call...
Page 121 - Caller must have logged on to the cache with DELETE access.
+++ CSM - Cache Service Manager +++ /* Performs a delete operation on the object(s) indicated. This action will delete an object from a non-reference count cache, and will decrement the reference count by 1 for a reference count cache. The object will only be physically removed from a reference coun...
Page 132 - DOC DECLARATIONS
+++ DOC - Document Services +++ 12. DOC DECLARATIONS /* This is the implementation for Document Services (DOC). Document Services provides for the management of documents, in particular their storage on and migration from optical disk. Documents are dealt with as whole entities or as collections of ...
Page 135 - typedef struct
+++ DOC - Document Services +++ /* The description of an optical disk surface. */ typedef struct { ASE_surface_id_typ surface_id; (pg481.42) /* Its ID */ INX_fam_id_typ family_id; (pg240.25) /* The ID of the family to which this surface belongs; family ID number 1 is the transaction logging family *...
Page 154 - This subroutine is not supported for archive databases or PDBs.
+++ DOC - Document Services +++ DOC_free_queue with this name). A maximum of 32 different queues are available. ERRORS: DOC_err_no_more_queues */ 13.2. DOC_allocate_ids error_typ DOC_allocate_ids(number, number_of_ids, first_id_p) ASE_session_number_typ number; /* IN: session number */ (pg479.14) un...
Page 155 - No migrate is outstanding upon completion of this routine if:
+++ DOC - Document Services +++ CSM_LOCKED_DURATION CSM_PREFETCH_DURATION CSM_MIGRATE_DURATION CSM_REFRESH_DURATION If cache is non-ageable, object will be locked in cache and the duration is ignored. */ unsigned short num_docs; /* IN: #docs to migrate, max is DOC_MAX_ASYNC_MIGRATES */ DOC_async_xmi...
Page 169 - This subroutine is not supported for PDBs or archive databases.
+++ DOC - Document Services +++ 13.24. DOC_find_surfaces error_typ DOC_find_surfaces(number, ssn, surf_id, rel_op, max_matches, actual_matches_p, surface_descs_p, last_match_p) ASE_session_number_typ number; /* IN: session number */ (pg479.14) ASE_ssn_typ ssn; /* IN: starting ssn */ (pg479.37) ASE_s...
Page 182 - cleanup_p has the following description:
+++ DOC - Document Services +++ cleanup_p will only be called if DOC_prefetch_from_optical_disk gets an error AND *iter_p has been called at least once during the current prefetch call. cleanup_p has the following description: error_typ cleanup (data) any_ptr data; *cleanup_p's parameters are: data ...
Page 188 - The following mask conversions occur on NT.
+++ DTI - Date Time Interface +++ ,./?:;\'`"()<>[]{}-_=+|*&^%$#@! The original components can be any of the following: dd - day of month (01..31) ddd - three digit day of year (1..365) mm - month (01..12) mon - abbreviated month name month - unabbreviated month name yy - two digit year...
Page 216 - void
+++ FFI - FileNet Formats Interface +++ DOC_annotation_desc_typ record. */ unsigned short len; /* IN: "annot_len" field from the DOC_annotation_desc_typ record, which is the number of bytes in "data_p". */ unsigned short* num_opts_p; /* OUT: number of elements in the opts_p_p array *...
Page 219 - /* Compresses a bitmap and generates a FileNet page of type image.
+++ FFI - FileNet Formats Interface +++ as the buffer size, bitmap_p->buf_p is input as a pointer to the bitmap data, bitmap_p->data_size is output as the number of bytes used in the bitmap, and the bitmap data is output in bitmap_p->buf_p */ /* Decompresses a page of a document which is of...
Page 243 - INX DECLARATIONS
+++ INX - Index Services +++ 22. INX DECLARATIONS /*============================================================================== INX - Index Services ================================================================================ This interface allows an application to access the information cont...
Page 245 - /* The retention offset is the number of months when added to the base
+++ INX - Index Services +++ */ typedef ASE_session_number_typ INX_session_handle_typ; (pg479.14) typedef ASE_service_name_typ INX_dict_id_typ; /* May carry which db later */ (pg481.23) typedef unsigned short INX_relational_op_typ; /* same as filter op */ /* Types of documents. */ typedef byte INX_d...
Page 281 - Copying a folder to its own descendent is not allowed.
+++ INX - Index Services +++ INX_open_connection. */ 23.4. INX_close_folder error_typ INX_close_folder(ims_session, folder_id, cap_p) INX_session_handle_typ ims_session; /* IN: session number */ (pg231.3) ASE_folder_id_typ folder_id; /* IN: folder id */ (pg480.3) INX_capability_typ* cap_p; /* IN: ca...
Page 296 - The client is expected to treat this area as read-only (not modified
+++ INX - Index Services +++ /* INX_get_index_desc finds the description of a particular index and returns a pointer to it. The client is expected to treat this area as read-only (do not modify or return). ERRORS: INX_err_no_index INX_err_no_dict_param */ 23.36. INX_get_key_desc error_typ INX_get_ke...
Page 341 - PRS DECLARATIONS
+++ PRS - Parser +++ 26. PRS DECLARATIONS /* ===================== errors ========================================== */ #ifndef PC #define err_PRS err_INX #else #ifndef PCWS_h #include "pcws.h" #endif #endif #define PRS_err(_z) err_encode(err_PRS,0,_z) #define PRS_znomem 1000 #define PRS_err...
Page 356 - Object Level Configuration
+++ SEC - Security Services +++ o password special characters o password minimum lengths o password days until change required o password grace period for password change o password failed attempts until account is suspended o password time in which failed attempts may occur to cause suspension Each...
Page 362 - automatic relogon feature.
+++ SEC - Security Services +++ automatic relogon feature. 5.1.1 Time usage restrictions A user may be restricted based upon the time of day and/or the day of the week. The time of day may be specified by providing staring and ending times which are a combination of the hour and minutes. The day of ...
Page 366 - Device Controls
+++ SEC - Security Services +++ The system administrator may set all user's passwords to time-out if not changed after a configured period of time. The administrator will set the time until password renewal is required (eg. 30 days) from the time of last change, and the administrator will set a grac...
Page 367 - Terminal time usage restrictions
+++ SEC - Security Services +++ override attribute set, then terminal security will be implemented. For example, the system wide terminal security attribute is turned "off", and the group "accounting" has the system override attribute and the terminal security attribute turned "o...
Page 370 - Administrative Attributes
+++ SEC - Security Services +++ etc. (ANYONE) may also be used as a user's primary group. This will effectively have no effect upon the user object, except in the instance in which application software sets the access restrictions to a user's primary group. 5.4.6 ServiceProcess ServiceProcess is a r...
Page 372 - Reporting Controls
+++ SEC - Security Services +++ If no primary group is specified for these objects, then the primary group will default to (NONE). 5.5.4 Group attribute An administrator with the group attribute set may: o add members to groups o delete members from groups o add members to functions o delete members...
Page 373 - Function Controls
+++ SEC - Security Services +++ A logon may fail for a variety of reasons. The set of errors which may occur consist of: a bad password, a non-existent user, an expired user/primary group/terminal object, an invalid logon time, too many user sessions, or too many concurrent sessions. 5.6.2 Successfu...
Page 376 - SEC data base initialization
+++ SEC - Security Services +++ copied in an ascii, human readable format. The export file may then be used to replicate the security service across multiple domains through the use of the import command. The import command allows a customer to import an "exported" security database. The imp...
Page 378 - the use of Xapex and go directly to the desired application.
+++ SEC - Security Services +++ the use of Xapex and go directly to the desired application. In addition, many FileNet tools require that an fnlogon be performed in order to execute. These tools may generally be identified through the "XXX_tool" naming convention. 7. Appendix B: Glossary of ...
Page 418 - exist in order for this call to be successful.
+++ SEC - Security Services +++ exist in order for this call to be successful. member_id is the object which will be made a member of the specified group. Members may be either user, groups or devices. The member specified must exist in the object table in order for this call to be successful. ERROR...
Page 434 - session_nbr represents a logon instance.
+++ SEC - Security Services +++ session_nbr represents a logon instance. SEC_id_to_name() as well as SEC_name_to_id() will also cache error objects; that is, objects for which a corresponding name or id could not be found in the data base. Calls to these entry points will first search the error obje...
Page 444 - The object_id is the key value of the object to be changed.
+++ SEC - Security Services +++ * SEC_err_no_logon * SEC_err_duplicate_logon * SEC_err_too_many_term_ids * SEC_err_invalid_device_name * SEC_err_object_not_found * SEC_err_not_user * SEC_err_user_expired * SEC_err_device_expired * SEC_err_group_expired * SEC_err_invalid_password * SEC_err_password_e...
Page 462 - also set to the expression's return code.
+++ SQI - SQL Services +++ also set to the expression's return code. ERRORS: SQI_ERR_END_OF_FETCH SQI_ERR_CANCELLED SQI_ERR_BIND_RESULT_MISSING SQI_ERR_FETCH_WITHOUT_EXECUTION SQI_ERR_NOT_A_SELECT_QUERY SQI_ERR_INVALID_BIND_RESULT SQI_ERR_VALUE_OUT_OF_RANGE */ 31.11. SQI_full_use_logon error_typ SQI...
Page 465 - WQS DECLARATIONS
+++ WQS - WorkFlo Queue Services +++ 32. WQS DECLARATIONS /**************************************************************** ** ** ** WorkFlo Queue Services (WQS) ** ** ** ****************************************************************/ /* This is the implementation for Queue Services (WQS). Queue S...
Page 471 - typedef struct WQS_COUNTER
+++ WQS - WorkFlo Queue Services +++ WQS_status_spec_typ status_spec; /* Entry busy status (see above)*/ (pg456.25) bool even_delayed; /* Fetch entry even if (pg486.13) current time < sf_delay_time */ WQS_incomplete_spec_typ incomplete_spec;/* Incomplete status(see above*/ (pg456.30) bool check_u...
Page 491 - and content access specified for the queue.
+++ WQS - WorkFlo Queue Services +++ and content access specified for the queue. ERRORS: WQS_err_invalid_queue_handle WQS_err_field_desc_change WQS_err_queue_in_use WQS_err_security_violation */ 33.30. WQS_update_selected error_typ WQS_update_selected( q_handle, filter_p, entry_id, q_entry_p) WQS_qu...
Page 493 - MISC DECLARATIONS
+++ Miscellaneous Declarations +++ 34. MISC DECLARATIONS /* Include file common to all clients * of Application Services */ #ifndef AS_externals_h #define AS_externals_h /* Prefix for names is ASE (Application Services Externals) */ typedef unsigned long ASE_session_number_typ; #define ASE_INVALID_S...
Page 579 - NOTICES
+++ Notices +++ NOTICES This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently ava...