************************************************************************** WRAPI CORRECTIVE SERVICE INSTRUCTIONS FILE ************************************************************************** This package was generated to provide the current service for the IPFAF Workstation APIs (WRAPI) associated with the IODM Annotation PTF - PQ21304, PQ21305, PQ21306. The IODM Annotation support also includes the IODM Dynamic TCPIP support. Hence the Dynamic TCPIP fix should NOT be applied after over this fix, or you will lose Annotation support. Following are the instructions for applying the code: ************************************************************************** To install this package: 1) IPFAF and IODM must be at the Version 3.1 Level with Annotation Support fix installed on IODM. 2) This fix is simply a replacement of the WRAPI files which are ON OS/2 ------- EYP.H (Header file in INCLUDE path) EYPAPI.INI (Customization file in EYPINIFILE setting) EYPOAPI.LIB (Library file in LIB path) EYPOAPI.DLL (Executeable in LIBPATH) ON WINDOWS ---------- EYP.H (Header file in INCLUDE path) EYPAPI.INI (Customization file in EYPINIFILE setting) EYPWAPI.LIB (Library file in LIB path) EYPWAPI.DLL (Executeable in LIBPATH) 3) Download the package from the bulletin board or FTP site into a temporary directory 4) PKUNZIP the package by issuing: PKUNZIP2 EYPOAPI.ZIP (on OS/2) PKUNZIP EYPWAPI.ZIP (on WINDOWS) 5) Replace the original WRAPI files with the new ones by simply copying the new files into the directories where the old files were stored. 6) Recompile any programs which were written to the old WRAPI. NOTE you will need to change the FafSessionConnect() call to include the additional IODM connection information parameters. Also the FAFCONNECTPARMS structure has changed and appropriate changes must be made when referencing it. 7) If desired, instead of replacing the EYPAPI.INI file, simply add the new INI parameter(s) to the old EYPAPI.INI file currently installed. The new INI parameters are - RequireIPFAF = 1 (if IPFAF connection not required) IodmLOCK = LOCK,01 (IODM CICS Tran name for Lock) IodmSTOROBJU = STOU,01 (IODM CICS Tran name for StorObjU) New or Changed WRAPI functions (see EYP.H) FafSessionConnect -- changed Now has IODM termid, userid, password, and newpassword fields for dynamic TCPIP connectivity. FafCreateFEAKey() -- new Used to create a FEA Key which is needed to call the new functions FafLockDocAnnotation(), FafUpdateDocAnnotation(), and FafUpdateItemLock(). The input required is -- Folder Token Document ID Document Version The output is written into a FEAKEY structure whose address is provided by the user. FafGetDocument() -- changed The COPYTYPE parameter now allows you to use COPY_ANNOTATION_INDEX to receive the document annotation index. FafGetDocAndOverlays() -- changed The DOCOVERSTRG structure has been changed to allow you to receive the annotation index and object. FafLockDocAnnotation() -- new Allows the user to lock a document. This is required to update or create an annotation. FafStoreDefinedDoc() -- changed The LOCCNTL structure has been changed to allow the user to also store an annotation object with the document. FafUpdateDocAnnotation() -- new Allows the user to change or create an annotation. FafUpdateItemLock() -- new Allows the user to change the lock state of a document. New WRAPI error codes -- FAF_RC_ANNOTATION_MISSING 2026 FAF_RC_INVALID_ANNOTATION_INDEX 2027 FAF_RC_IPFAF_NOT_AVAILABLE 3010 FAF_RC_INVALID_ODM_USERID 3011 FAF_RC_INVALID_ODM_PASSWORD 3012 FAF_RC_INVALID_ODM_TERMID 3013 **************************************************************************