Question & Answer
Question
How can I obtain a list of the IWPM environment variables?
Cause
Occasionally, the IWPM Development organization will create a new environment variable to address a particular program requirement that was not thought of when the product was originally released. Also, in some cases, users might find it necessary to change default ImagePlus Workstation Program operations specifically to suit their needs, and you would use Windows operating system environment variables to accomplish that..
Answer
Listed below, in alphabetical order, are the documented and undocumented IWPM environment variables that may be used for this purpose. These variables may be used with IWPM/XP as well as IWPM on Windows Vista or Windows 7.
Note: For the absolute, up-to-date version of this document, please visit our web site:
ftp://ftp.software.ibm.com/ps/products/imageplus/fixes/IWPMv2.3fp2/
and reference the environment_variables.doc document.
| Environment Variable | Purpose | Notes |
| EVN_ALWAYS_ENHANCE | To make the View, Enhance option always enabled. This will enhance every page in the display working set. | Value should be YES to make it always enhanced. This is the same as using Ctrl + E for every page. This will slow down the time to display a document. |
| EVN_ASCII_PAGEWIDTH | This variable allows an ASCII document to be displayed with a page width different from the default of 85 characters. | Value should be xxx, where xxx can be between 4 and 255, inclusively. |
| EVN_BATCHSTOREEXIT | Activates the BatchStore user exit. This exit is called during batch scanning when a document is about to be stored. When this exit is called, the document is still visible in the display working set. | Value should be YES. This exit can be used as an alternative to the CommandSent communications exit to determine when documents are stored, or it could be used to monitor host workstation interaction (perhaps as a logging tool, for example). |
| EVN_CATCHDOC | EVN_CATCHDOC=1. To "catch" the results of working with forms, annotations, and documents. Note: Only for MVS; not AS/400. When this variable is set, the document is not displayed. This is useful for capturing problem documents; for example, damaged images. | When this variable is set, each document displayed in IWP is written to a file named EVNCATCH.DOC (ODM 2.2) or EVNCATCH.001 (ODM 3.1+). The old format produced one file and the new format produces multiple files. |
| EVN_CONVERSATION_DELAY_LIMIT | This variable is used to determine the number of seconds the Workstation Program waits for an APPC timeout before it issues a message such as "IWPM is not receiving." | Value is xxx, where xxx can be between 0 and 600, inclusively. A value of 0 causes the Workstation Program to bypass the limit check. |
| EVN_DISPLAYFOCUS | To impact the focus after a display to the IWPM image window. | Value of YES is the default and tells it to go back to IWP; NO tells it to go back to the 5250 session. |
| EVN_EMID | Used to specify the host emulation session, if it is other than G. | Value=b, where b is the short session ID for a host emulation session. The default is G. |
| EVN_EMULATOR | Identifies a specific 5250 session to which the Workstation Program returns focus. Users with multiple WAF hosts should use this environment variable. | Value is 5250PLU1,A, or 5250PLU2,B, for example. |
| EVN_FAX_QUIET | Redirects EVNW7FCE messages to the information line. This is useful when the Workstation Program is running as a server with no user to respond to messages presented in dialog boxes. | Value should be YES. |
| EVN_FIXEDPORT_IN_TERMINAL | Forces IWPM to use a fixed port address to an IP/390 host even when IWPM detects that Citrix or Terminal Services is installed in the environment, which would ordinarily make the IP address be dynamically generated. | Value should be TRUE. |
| EVN_IDLE | Value of this variable is the number of milliseconds the RTS polling will wait before it tries again. This variable affects operations of the IdleC command that is used when connecting to applications that use the long running conversation mode. | Value is xxx, where the default is 100 ms. No parsing is done for this variable. |
| EVN_LEAVE_AS_TIFF | Value of this variable determines if, upon adding or removing a page(s) from a TIFF document, it is saved back as MODCA (default) or TIFF. | If it is desired that the modified document be saved back as TIFF, the value must be TRUE. Otherwise, it will be stored back as MODCA. Annotated documents will always be stored back as MODCA. |
| EVN_IGNORE_VERIFYING_PRINTERNAME | Use if “Printer name not valid” error appears when trying to add a new printer to IWPM because the Windows API called to enumerate printers failed | Value is TRUE. |
| EVN_KEEPDOCS_AFTERSTORINGANNOS | Prevents IWPM from discarding a document from the working set after storing annotations into IP/390. | Value is TRUE. |
| EVN_LEAVE_AS_TIFF | Value of this variable determines if, upon adding or removing a page(s) from a TIFF document, it is saved back as MODCA (default) or TIFF. | If it is desired that the modified document be saved back as TIFF, the value must be TRUE. Otherwise, it will be stored back as MODCA. Annotated documents will always be stored back as MODCA. |
| EVN_LISTENER_IP_ADDR | To allow VPN (Virtual Private Networking) dynamically-assigned IP addresses. | Value should be "ALL" if it is desired that IWP listen on all TCP/IP addresses. |
| EVN_LOCAL_PATH | This variable allows the user to store a document to a user-specified directory rather than one specified by the host. This directory must already exist or an error will occur. | For example, setting EVN_LOCAL_PATH=D:\TEMP stores documents to the D:\TEMP directory, rather than the directory supplied by the host. The file name is the same as what the host provides. |
| EVN_MERGE_DOCS | Content Manager for AS/400 (VI/400) users are able to scan multiple pages into IWPM, append them either to the end or the beginning of the existing document and then store the newly-merged document back to the AS/400. | Value should be YES. This feature only works when you have exactly two documents in the IWP working set. See section 14.1 of the Read.me file in the 20000207 fixpack for more details. |
| EVN_MINI_USE_USERZOOM | Presence of this environmental will add the zoom capabilities to the view menu bar of the mini window, and there can be a maximum of 12 mini-windows. | Value can be anything. (See also EVN_MINI_WITH_DOCDESC). |
| EVN_MINI_WITH_DOCDESC | Presence of this environmental will add the document description to the title bar of the mini-window. | Value can be anything. (See also EVN_MINI_USE_USERZOOM). |
| EVN_NO_LOGO | Presence of this environmental will suppress the IWPM splash screen that displays when IWPM is started. | Value can be anything. |
| EVN_NO_PRINT_ACCEL | Presence of this variable will create the "Print Page" and "Print Document" menu items without accelerator keys. Created because the use of F7 and F8 in 3270 sessions opens up the possibility of accidentally printing documents when paging between screens was intended. | Print Page accelerator = F7 Print Doc accelerator = F8 |
| EVN_NOAUTOSCAN | Presence of this environmental will start the scan but not automatically start scanning. | Setting EVN_NOAUTOSCAN to YES causes no page scanning until the SCAN button is pushed. To have the page automatically scanned, you must remove this variable from the environment list. |
| EVN_OLD_ANNO | Provides backward compatibility and should be used only when the host is ODM 2.2 or earlier and the workstation is at fixpack build level 03/08/99 or greater. This variable allows you to store documents with annotations to ODM V2R2 systems. | The presence of this variable forces IWP to send a document with annotations as one blob (document and annotations within one MO:DCA document instead of separating them out). |
| EVN_OLD_DISPLAY | Provides backward compatibility and should be used only when the host is ODM 2.2 or earlier and the workstation is at fixpack build level 03/08/99 or greater. Addresses the EVNA7A0B error caused by this environment. | The presence of this variable forces IWP to use the display logic used before annotation support was added. |
| EVN_PRINTWS | Provides another pull-down menu option called "Print workingset" to print the entire IWP working set rather than just a specific page or document. | The value must be YES. This variable is undocumented. It is not case sensitive. English text only. |
| EVN_VERIFYID_BEFORESCAN | When doing a "New Scan", a dialog will appear before the scan window shows, prompting for a tempid. It will verify the ID before allowing you to scan. | Value should be YES to enable this feature. |
| EVN_WAF_AUTOSCAN | Content Manager for AS/400 (VI/400) users are able to have IWPM automatically press the Scan button instead of having to manually press the button every time IWPM receives a "Scan" command from the host. | Value should be YES. This environment variable will override the EVN_NOAUTOSCAN environment variable. See section 14.2 of the Read.me file in the 20000207 fixpack for more details. |
| FISS_VERIFY_ZERO_DELAY | To address scanning performance degradation with some scanner models, after loading FIWSS.DLL provided in APAR IO04968. | Value is TRUE. If the Value is FALSE or not set, there is approx. 400 millisecond delay between scan start and scan end. |
| FIW_AUTOLAUNCH | Automatically launches a non-image program that is enabled by the display user exit, rather than making the user double click on the icon for this non-image program. | Value can be anything. If the environment variable exists, then the defined non-image program will automatically be launched. |
| FIW_EURO | Causes the EURO symbol imbedded in a PTOCA document to display and print correctly. | Value can be anything. The presence of this variable provides EURO symbol support. |
| FIW_FLIPFIX | This applies to scanning in duplex mode and discarding blank pages. This relates to APAR IR34736 -- unable to end batch when last page is blank. | Value should be YES. The alternative to using this environment variable is to make sure that there is data on the last rear page of the batch. |
| FIW_HORZSCREEN | Sets the value to the number of inches of your screen horizontally, so that the zoom factor will be correct. | e.g., SET FIW_HORZSCREEN=15.5 |
| FIW_MOUSE_WHEEL_SCROLL | Allows for the use of the mouse scroll wheel. The value in the setting specifies "how many lines to scroll when the wheel is spun once". Note that the scroll wheel works only if the document window has the focus. Clicking once inside the document window should bring it to focus | Suggested value to true somewhere between3 and 5. If you set this variable to 0, then no action will occur when the wheel is rotated. |
| FIW_VERTSCREEN | Sets the value to the number of inches of your screen vertically, so that the zoom factor will be correct. | e.g., SET FIW_VERTSCREEN=12 |
| FIWSRASALWAYSDUMP | Always writes the ERROR001.LOG and TRACE001.LOG files to the hard drive rather than memory. This variable is helpful when it's necessary to capture an error up to and including the point that IWP starts up. | Value = 1. Setting this variable to 1 will cause performance degradation and consume a lot of disk storage. This variable should be set only during problem determination. |
| FIWSRASTRC2FILE | Always traces to files ERROR001.LOG and TRACE001.LOG. This variable is helpful when it's necessary to capture an error up to and including the point that IWP starts up. | Value = 1. This variable is often used in conjunction with the FIWSRASALWAYSDUMP. |
| FIWTDISABLESCALETOGRAY | Presence of this variable disables hardware scale-to-gray function and uses IWP's scale-to-gray function. Scale-to-grey capability enhances the appearance of images. | Value can be anything. Useful in determining if problem is in the video driver or IWP. Example: forms overlay flashing problem during display on some monitors. |
| FIWTCOURIERHEIGHT | This variable can be set to decrease the height of courier fonts. | Value is xxx, where 318 is the default height. Specifying a smaller number decreases the height of courier fonts. Note that the height decreases in very small increments. The minimum value that can be specified is 118. |
| FIWT_COMPRESSED_BUFFERSIZE | May be needed when scanning or displaying a multi-page bi-color TIFF image with G4 compression. | Call IBM Support before using this. |
| FIWT_FIX_GREYIMAGE_SAMPLING_BYTE | May be needed to address an FIW2203A internal error that occurs when trying to display some grey-scale JPEGs with a sampling factor of 0x22. | Value is TRUE. |
| FIWT_FORCEPREPAREPAGEFULL | This setting is sometimes needed in an IP/390 environment to allow all the text on the page to be displayed. It may also be needed to display WAF form overlays if the FIWT_USEPIXEL_SCALETOGRAY envvar is set to TRUE. | Value is TRUE. |
| FIWT_IOCA_YCBCR | Allows for storing IOCA images with the YCbCr color space (rather than IWPM/s normal YCrCb setting) so that they can be viewed correctly in other JPEG viewers. | Value is TRUE. |
| FIWT_PIXELRENDERTIFF_SCALELENGTH | Only used when some TIFF images become distorted when Pixel Scale-to-gray envvars are used and the image’s height is truncated. | Value is TRUE. |
| FIWT_SAVEAS_LARGER_MODCA | Allows you to save a MODCA document in a size larger than allowed by the architecture. | Value is TRUE. |
| FIWT_SCALETOGRAY_DWROP_ZERO | Allows underlined text to be viewed as underlines at the ‘Fit to window” zoom level when Pixel scale-to-gray is enabled. | Value is FALSE. |
| FIWT_USEPIXEL_RENDERTIFF | When Pixel scale-to-gray is enabled, user may see FIW2201A when trying to display some TIFF images. | Value is TRUE. |
| FIWT_USEPIXEL_SCALETOGRAY | Allows more resolute display of images when a Cornerstone ImageAccel card is not being used. | Value is TRUE. This environment variable only works when added automatically through the installation of APAR fix IR53715. |
| SIM_JPEG_COMP_TYPE | Value of this variable = type of JPEG compression scanned images will be: -C0 (default) - NHC baseline -C9 = NAC extended -CA = NAC progressive | |
| SIM_SCAN_YCBCR | Allows support for color scanners that provide JPEG compressed images in 'YCBCR' format rather than the default 'RGB'. | Value should be YES if attaching a color scanner that provides JPEG compressed images in the 'YCBCR' format. |
To add an environment variable to Windows XP:
Go into Control Panel, then System. Click on the Environment tab, System variables. At the bottom, there is a place to type in a variable. Add a variable in all caps, add the value in all caps, and then click on SET. This adds it to the system environment variables.
To add an environment variable to Windows 7:
Go into Control Panel, then System and Security, and then System. Click on "Advanced system settings" on the left. The "Environment Variables" button is at the bottom of the "Advanced" tab, At the bottom, under "System variables", click on New to add a variable in all caps, add the value in all caps, and then click on OK. This adds it to the system environment variables.
[{"Product":{"code":"SSAVJ5","label":"ImagePlus Workstation Program"},"Business Unit":{"code":"BU053","label":"Cloud \u0026 Data Platform"},"Component":"Other","Platform":[{"code":"PF033","label":"Windows"}],"Version":"2.3","Edition":"All Editions","Line of Business":{"code":"","label":""}}]
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg21009756