home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / wrapicsf.zip / README.TXT < prev   
Text File  |  1999-01-28  |  5KB  |  105 lines
  1. **************************************************************************
  2.  
  3.               WRAPI CORRECTIVE SERVICE INSTRUCTIONS FILE
  4.  
  5. **************************************************************************
  6.  
  7.   This package was generated to provide the current service for the IPFAF
  8.   Workstation APIs (WRAPI) associated with the IODM Annotation PTF -
  9.   PQ21304, PQ21305, PQ21306.
  10.  
  11.   The IODM Annotation support also includes the IODM Dynamic TCPIP support.
  12.   Hence the Dynamic TCPIP fix should NOT be applied after over this fix,
  13.   or you will lose Annotation support.
  14.  
  15.   Following are the instructions for applying the code:
  16.  
  17. **************************************************************************
  18.  
  19.   To install this package:
  20.  
  21.        1) IPFAF and IODM must be at the Version 3.1 Level with Annotation
  22.           Support fix installed on IODM.
  23.  
  24.        2) This fix is simply a replacement of the WRAPI files which are
  25.           ON OS/2
  26.           -------
  27.           EYP.H        (Header file in INCLUDE path)
  28.           EYPAPI.INI   (Customization file in EYPINIFILE setting)
  29.           EYPOAPI.LIB  (Library file in LIB path)
  30.           EYPOAPI.DLL  (Executeable in LIBPATH)
  31.  
  32.           ON WINDOWS
  33.           ----------
  34.           EYP.H        (Header file in INCLUDE path)
  35.           EYPAPI.INI   (Customization file in EYPINIFILE setting)
  36.           EYPWAPI.LIB  (Library file in LIB path)
  37.           EYPWAPI.DLL  (Executeable in LIBPATH)
  38.  
  39.        3) Download the package from the bulletin board or FTP site into a
  40.           temporary directory
  41.  
  42.        4) PKUNZIP the package  by issuing:
  43.  
  44.           PKUNZIP2 EYPOAPI.ZIP  (on OS/2)
  45.           PKUNZIP  EYPWAPI.ZIP  (on WINDOWS)
  46.  
  47.        5) Replace the original WRAPI files with the new ones by simply copying
  48.           the new files into the directories where the old files were stored.
  49.  
  50.        6) Recompile any programs which were written to the old WRAPI.  NOTE
  51.           you will need to change the FafSessionConnect() call to include
  52.           the additional IODM connection information parameters.  Also the
  53.           FAFCONNECTPARMS structure has changed and appropriate changes must
  54.           be made when referencing it.
  55.  
  56.        7) If desired, instead of replacing the EYPAPI.INI file, simply
  57.           add the new INI parameter(s) to the old EYPAPI.INI file currently
  58.           installed.  The new INI parameters are -
  59.  
  60.           RequireIPFAF = 1        (if IPFAF connection not required)
  61.           IodmLOCK     = LOCK,01  (IODM CICS Tran name for Lock)
  62.           IodmSTOROBJU = STOU,01  (IODM CICS Tran name for StorObjU)
  63.  
  64.  
  65.   New or Changed WRAPI functions (see EYP.H)
  66.        FafSessionConnect  --  changed
  67.           Now has IODM termid, userid, password, and newpassword fields for
  68.           dynamic TCPIP connectivity.
  69.        FafCreateFEAKey()  --  new
  70.           Used to create a FEA Key which is needed to call the new functions
  71.           FafLockDocAnnotation(), FafUpdateDocAnnotation(), and
  72.           FafUpdateItemLock().  The input required is --
  73.                   Folder Token
  74.                   Document ID
  75.                   Document Version
  76.           The output is written into a FEAKEY structure whose address is
  77.           provided by the user.
  78.        FafGetDocument()  --  changed
  79.           The COPYTYPE parameter now allows you to use COPY_ANNOTATION_INDEX
  80.           to receive the document annotation index.
  81.        FafGetDocAndOverlays()  --  changed
  82.           The DOCOVERSTRG structure has been changed to allow you to receive
  83.           the annotation index and object.
  84.        FafLockDocAnnotation()  --  new
  85.           Allows the user to lock a document.  This is required to update or
  86.           create an annotation.
  87.        FafStoreDefinedDoc()  --  changed
  88.           The LOCCNTL structure has been changed to allow the user to also
  89.           store an annotation object with the document.
  90.        FafUpdateDocAnnotation()  --  new
  91.           Allows the user to change or create an annotation.
  92.        FafUpdateItemLock()  --  new
  93.           Allows the user to change the lock state of a document.
  94.  
  95.   New WRAPI error codes --
  96.        FAF_RC_ANNOTATION_MISSING           2026
  97.        FAF_RC_INVALID_ANNOTATION_INDEX     2027
  98.        FAF_RC_IPFAF_NOT_AVAILABLE          3010
  99.        FAF_RC_INVALID_ODM_USERID           3011
  100.        FAF_RC_INVALID_ODM_PASSWORD         3012
  101.        FAF_RC_INVALID_ODM_TERMID           3013
  102.  
  103. **************************************************************************
  104.  
  105.