IWPM Environment Variables

Janet BoltonIBM, Software Group

Janet Bolton is a member of the IBM Content Manager/400 and IWP Development and Support team.

Summary: ImagePlus Workstation Program users will find this list of operating system environment variables a convenient way to customize their workstation operating environments.

Tag this!

Date: 01 Feb 2002
Level: Intermediate
Activity: 309 views

Occasionally, the IWPM Development organization will create a new environment variable to address a particular program requirement that was not anticipated when the product was originally released. In some cases, users may find it necessary to change default ImagePlus® Workstation Program operations to suit specific needs, and they would use Windows operating system environment variables to accomplish that. 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/NT, IWPM/95 or IWPM for Windows® 2000.

Environment Variable	Purpose	Notes
EVN_ALWAYS_ENHANCE	Use this option to select the View with the enhance option always enabled. This will enhance every page in the display working set.	The value should be YES to make it always enhanced. This is the same as using Ctrl + E for every page. Selecting this option will slow down the time it takes 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.	The value should be xxx, where xxx can be between 4 and 255, inclusively.
EVN_BATCHSTOREEXIT	This option 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.	The value should be YES. This exit may be used as an alternative to the CommandSent communications exit to determine when documents are stored, or it may be used to monitor host workstation interaction (as a logging tool, for example).
EVN_CATCHDOC EVN_CATCHDOC=1.	Use to "catch" the results of working with forms, annotations, and documents. Note: This option is 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 whereas 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."	The 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	Use this option to impact the focus after a display to the IWPM image window.	A value of YES is the default which issues an instruction to go back to IWP; NO sends an instruction to go back to the 5250 session.
EVN_EMID	This is 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	This option identifies a specific 5250 session to which the Workstation Program returns focus. Users with multiple WAF hosts should use this environment variable.	Value would be set 5250PLU1,A, or 5250PLU2,B, for example.
EVN_FAX_QUIET	This choice 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_IDLE	The 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.	The value is xxx, where the default is 100 ms. No parsing is done for this variable.
EVN_LISTENER_IP_ADDR	Allows VPN (Virtual Private Networking) to have dynamically assigned IP addresses.	The value should be "ALL" if you want IWP to listen in 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	By selecting this option, 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	Selecting this environmental will add zoom capabilities to the view menu bar of the mini window, and there can be a maximum of 12 mini-windows.	The value can be anything. (See also EVN_MINI_WITH_DOCDESC.)
EVN_MINI_WITH_DOCDESC	The use of this environmental will add the document description to the title bar of the mini-window.	The value can be anything. (See also EVN_MINI_USE_USERZOOM.)
EVN_NO_LOGO	Invoking this environmental will suppress the IWPM splash screen that displays when IWPM is started.	The value can be anything.
EVN_NO_PRINT_ACCEL	Selecting this variable will create the "Print Page" and "Print Document" menu items without accelerator keys. This option was created because the use of F7 and F8 in 3270 sessions opens up the possibility of accidentally printing documents when the user intended only to page between screens.	Print Page accelerator = F7 and Print Doc accelerator = F8.
EVN_NOAUTOSCAN	Choosing this environmental will initiate the scanning process 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	This environmental 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	This selection 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 addresses the EVNA7A0B error caused by this environment.	The presence of this variable forces IWP to use the display logic that was used before annotation support was added.
EVN_PRINTWS	This 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, and should be English text only.
EVN_VERIFYID_BEFORESCAN	This option may be applied 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.	The value should be YES to enable this feature.
EVN_WAF_AUTOSCAN	With this option, 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.	The 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.
FIW_EURO	This will correctly display and print the EURO symbol embedded in a PTOCA document.	The value can be anything. The presence of this variable provides EURO symbol support.
FIW_FLIPFIX	This option applies to scanning in duplex mode and discarding blank pages. This relates to APAR IR34736 -- "unable to end batch when last page is blank."	The 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	This environmental 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_VERTSCREEN	This environmental 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	Invoking this option 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	This option always traces to files ERROR001.LOG and TRACE001.LOG. This variable is helpful when it isnecessary 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	Employing this variable disables hardware scale-to-gray function and uses IWP's scale-to-gray function. Scale-to-gray capability enhances the appearance of images.	The value can be anything. This option is useful in determining if a problem is in the video driver or IWP. For example: analyzing a forms overlay flashing problem that may occur during display on some monitors.
FIWTCOURIERHEIGHT	This variable can be set to decrease the height of courier fonts.	The 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.
SIM_JPEG_COMP_TYPE	Applying, and setting, the value of this variable determines the type of JPEG compression scanned images will be. For example: -C0 (default) - NHC baseline -C9 = NAC extended -CA = NAC progressive
SIM_SCAN_YCBCR	This option enables support for color scanners that provide JPEG compressed images in 'YCBCR' format rather than the default 'RGB'.	The 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 NT:

First, 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 your selection to the system environment variables.

To add an environment variable to Windows 95:

Add a "SET" statement to your AUTOEXEC.BAT, such as:

SET EVN_ALWAYS_ENHANCE=Y

Resources

IBM Content Manager portfolio
IBM Content Manager products
IBM Content Manager OnDemand Support
Content Manager OnDemand for iSeries
Content Manager for OS/390®
ImagePlus Workstation Program
DB2DD OnDemand article: Choosing a Model for IBM Content Manager OnDemand System Administration
DB2DD OnDemand article: Customizing the IBM Content Manager OnDemand Administrative Client
DB2DD OnDemand article: OnDemand: Designing a Solution for Performance and User Satisfaction

About the author

Janet Bolton is a member of the IBM Content Manager/400 and IWP Development and Support team.

Comments (Undergoing maintenance)

Trademarks | My developerWorks terms and conditions

Close [x]

Help: Update or add to My dW interests

What's this?

This little timesaver lets you update your My developerWorks profile with just one click! The general subject of this content (AIX and UNIX, Information Management, Lotus, Rational, Tivoli, WebSphere, Java, Linux, Open source, SOA and Web services, Web development, or XML) will be added to the interests section of your profile, if it's not there already. You only need to be logged in to My developerWorks.

And what's the point of adding your interests to your profile? That's how you find other users with the same interests as yours, and see what they're reading and contributing to the community. Your interests also help us recommend relevant developerWorks content to you.

View your My developerWorks profile

Return from help

Close [x]

Help: Remove from My dW interests

What's this?

Removing this interest does not alter your profile, but rather removes this piece of content from a list of all content for which you've indicated interest. In a future enhancement to My developerWorks, you'll be able to see a record of that content.

View your My developerWorks profile

Return from help

static.content.url=http://www.ibm.com/developerworks/js/artrating/

SITE_ID=1

Zone=Information Management

ArticleID=13185

ArticleTitle=IWPM Environment Variables

publish-date=02012002

author1-email=

author1-email-cc=